contenido\includes\functions.con.php

Show: PublicProtectedPrivateinherited
    Table of Contents
    Project: Contenido Content Management System

    Description: Defines the 'con' related functions in Contenido

    Requirements:

    Author
    Olaf Niemann, Jan Lengowski  
    Con_php_req
    5.0  
    Copyright
    four for business AG  
    License
    http://www.contenido.org/license/LIZENZ.txt  
    Link
    http://www.4fb.de  
    Link
    http://www.contenido.org  
    Package
    Contenido Backend includes  
    Since
    file available since contenido release <= 4.6 {@internal created unknown modified 2008-11-24, Mario Diaz, function conFlagOnOffline: Set publish date if article goes online modified 2008-06-25, Frederic Schneider, add security fix modified 2008-06-26, Timo.Trautmann, add security fix fix setting article online was not possible modified 2008-08-29, Murat Purc, add new chain execution, and handling og new field con_cat_lang.urlname modified 2008-09-07, Murat Purc, bugfix in conCopyArtLang at chain execution modified 2008-09-12, Oliver Lohkemper, bugfix in function conChangeTemplateForCat, add conGenerateCodeForAllartsInCategory() modified 2009-04-23, Andreas Lindner, also copy alias of article when syncing article to another language modified 2009-05-05, Timo Trautmann - optional use for copy label on copy proccess modified 2009-10-07, Murat Purc, bugfix in conMoveArticles (missing apostrophe) modified 2009-12-01, Dominik Ziegler, bugfix in conFlagOnOffline (article is still offline if enddate in time management is missing) modified 2009-10-27, Murat Purc, fixed/modified CEC_Hook, see [#CON-256] modified 2010-10-13, Dominik Ziegler, No copy label per default when copying articles or categories (CON-352) $Id: functions.con.php 1229 2010-10-13 11:41:23Z dominik.ziegler $: }}  
    Version
    1.0.4  

    Functions

    functionconChangeTemplateForCat(int $idcat, int $idtpl) : void

    Change the template of a category

    Parameters
    NameTypeDescription
    $idcatint

    Category Id

    $idtplint

    Template Id

    Details
    Author
    Jan Lengowski  
    Copyright
    four for business AG  
    functionconCopyArtLang( $srcidart,  $dstidart,  $newtitle,  $bUseCopyLabel = true) : void

    Parameters
    NameTypeDescription
    $srcidart
    $dstidart
    $newtitle
    $bUseCopyLabel
    functionconCopyArticle( $srcidart,  $targetcat = 0,  $newtitle = "",  $bUseCopyLabel = true) : void

    Parameters
    NameTypeDescription
    $srcidart
    $targetcat
    $newtitle
    $bUseCopyLabel
    functionconCopyContainerConf( $srcidtplcfg,  $dstidtplcfg) : void

    Parameters
    NameTypeDescription
    $srcidtplcfg
    $dstidtplcfg
    functionconCopyContent( $srcidartlang,  $dstidartlang) : void

    Parameters
    NameTypeDescription
    $srcidartlang
    $dstidartlang
    functionconCopyTemplateConfiguration( $srcidtplcfg) : void

    Parameters
    NameTypeDescription
    $srcidtplcfg
    functionconCreateLocationString(int $idcat, string $seperator, string $cat_str, boolean $makeLink = false, string $linkClass = "", integer $firstTreeElementToUse = 0,  $uselang = 0,  $final = true,  $usecache = false) : string

    Recursive function to create an location string

    Parameters
    NameTypeDescription
    $idcatint

    ID of the starting category

    $seperatorstring

    Seperation string

    $cat_strstring

    Category location string (by reference)

    $makeLinkboolean

    create location string with links

    $linkClassstring

    stylesheet class for the links

    $firstTreeElementToUseinteger

    first navigation level location string should be printed out (first level = 0!!)

    $uselang
    $final
    $usecache
    Returns
    TypeDescription
    stringlocation string
    Details
    Author
    Jan Lengowski  
    Author
    Marco Jahn  
    Copyright
    four for business AG  
    functionconDeeperCategoriesArray( $idcat_start) : array

    Fetch all deeper categories by a given id

    Parameters
    NameTypeDescription
    $idcat_start
    Returns
    TypeDescription
    arrayArray with all deeper categories
    Details
    Author
    Olaf Niemann Jan Lengowski  
    Copyright
    four for business AG  
    functionconDeleteart(int $idart) : void

    Delete an Article

    Parameters
    NameTypeDescription
    $idartint

    Article Id

    Details
    Author
    Olaf Niemann Jan Lengowski  
    Copyright
    four for business AG  
    functionconEditArt(mixed $idcat,  $idcatnew,  $idart,  $is_start,  $idtpl,  $idartlang,  $idlang,  $title,  $summary,  $artspec,  $created,  $lastmodified,  $author,  $online,  $datestart,  $dateend,  $artsort,  $keyart = 0) : void

    Edit an existing article

    Parameters
    NameTypeDescription
    $idcatmixed

    many

    $idcatnew
    $idart
    $is_start
    $idtpl
    $idartlang
    $idlang
    $title
    $summary
    $artspec
    $created
    $lastmodified
    $author
    $online
    $datestart
    $dateend
    $artsort
    $keyart
    Details
    Author
    Olaf Niemann  
    Copyright
    four for business AG  
    functionconEditFirstTime(mixed $idcat,  $idcatnew,  $idart,  $is_start,  $idtpl,  $idartlang,  $idlang,  $title,  $summary,  $artspec,  $created,  $lastmodified,  $author,  $online,  $datestart,  $dateend,  $artsort,  $keyart = 0) : int

    Create a new Article

    Parameters
    NameTypeDescription
    $idcatmixed

    many

    $idcatnew
    $idart
    $is_start
    $idtpl
    $idartlang
    $idlang
    $title
    $summary
    $artspec
    $created
    $lastmodified
    $author
    $online
    $datestart
    $dateend
    $artsort
    $keyart
    Returns
    TypeDescription
    intId of the new article
    Details
    Author
    Olaf Niemann  
    Copyright
    four for business AG  
    functionconFetchCategoryTree( $client = false,  $lang = false) : void

    Parameters
    NameTypeDescription
    $client
    $lang
    functionconFlagOnOffline() : void

    Set articles on/offline for the time management function

    Details
    Author
    Timo A. Hummel  
    Copyright
    four for business AG 2003  
    functionconGenerateCodeForAllArts() : void

    Create code for all articles

    Details
    Author
    Jan Lengowski  
    Copyright
    four for business AG 2003  
    functionconGenerateCodeForAllArtsInCategory(int $idcat) : void

    Generate code for all articles in a category

    Parameters
    NameTypeDescription
    $idcatint

    Category ID

    Details
    Author
    Jan Lengowski  
    Copyright
    four for business AG 2003  
    functionconGenerateCodeForAllArtsUsingTemplate(int $idtpl) : void

    Generate code for all articles using one template

    Parameters
    NameTypeDescription
    $idtplint

    Template-Id

    Details
    Author
    Jan Lengowski  
    Copyright
    four for business AG 2003  
    functionconGenerateCodeForAllartsUsingLayout(int $idlay) : void

    Create code for all arts using the same layout

    Parameters
    NameTypeDescription
    $idlayint

    Layout-ID

    Details
    Author
    Jan Lengowski  
    Copyright
    four for business AG 2003  
    functionconGenerateCodeForAllartsUsingMod(int $idmod) : void

    Create code for all articles using the same module

    Parameters
    NameTypeDescription
    $idmodint

    Module id

    Details
    Author
    Jan Lengowski  
    Copyright
    four for business AG 2003  
    functionconGenerateCodeForArtInAllCategories(int $idart) : void

    Create code for one article in all categorys

    Parameters
    NameTypeDescription
    $idartint

    Article ID

    Details
    Author
    Jan Lengowski  
    Copyright
    four for business AG 2003  
    functionconGenerateCodeForClient() : void

    Generate code for the active client

    Details
    Author
    Jan Lengowski  
    Copyright
    four for business AG 2003  
    functionconGetCategoryAssignments(\idart $idart, \db $db = false) : array

    Returns all categories in which the given article is in.

    Parameters
    NameTypeDescription
    $idart\idart

    int Article ID

    $db\db

    object Optional; if specified, uses the given db object

    Returns
    TypeDescription
    arrayFlat array which contains all category id's
    functionconGetTopmostCat( $idcat,  $minLevel = 0) : void

    Parameters
    NameTypeDescription
    $idcat
    $minLevel
    functionconLock(int $idart, \ing $lang) : void

    Toggle the lock status of an article

    Parameters
    NameTypeDescription
    $idartint

    Article Id

    $lang\ing

    Language Id

    functionconMakeArticleIndex( $idartlang, integer $idart) : void

    generate index of article content

    added by stese removed from function conSaveContentEntry before Touch the article to update last modified date

    Parameters
    NameTypeDescription
    $idartlang
    $idartinteger
    Details
    See
    \global\conSaveContentEntry  
    functionconMakeCatOnline(int $idcat, int $lang, int $status) : void

    Toggle the online status of a category

    Parameters
    NameTypeDescription
    $idcatint

    id of the category

    $langint

    id of the language

    $statusint

    status of the category

    Details
    Author
    Jan Lengowski  
    Copyright
    four for business AG  
    functionconMakeOnline(int $idart, \ing $lang) : void

    Toggle the online status of an article

    Parameters
    NameTypeDescription
    $idartint

    Article Id

    $lang\ing

    Language Id

    Details
    Author
    Olaf Niemann Jan Lengowski  
    Copyright
    four for business AG  
    functionconMakePublic(int | int $idcat,  $lang,  $public) : void

    Toggle the public status of a category

    Almost the same function as strMakePublic in functions.str.php (conDeeperCategoriesArray instead of strDeeperCategoriesArray)

    Parameters
    NameTypeDescription
    $idcatint | int

    Article Id

    $lang
    $public
    Details
    Author
    Olaf Niemann Jan Lengowski  
    Copyright
    four for business AG  
    functionconMakeStart(int $idcatart,  $is_start) : void

    Set a start-article

    Parameters
    NameTypeDescription
    $idcatartint

    Idcatart of the article

    $is_start
    Details
    Author
    Olaf Niemann Jan Lengowski  
    Copyright
    four for business AG  
    functionconMoveArticles() : void

    Move articles for the time management function

    Details
    Author
    Timo A. Hummel  
    Copyright
    four for business AG 2003  
    functionconSaveContentEntry(integer $idartlang, string $type, integer $typeid, string $value,  $bForce = false) : void

    Save a content element and generate index

    Parameters
    NameTypeDescription
    $idartlanginteger

    idartlang of the article

    $typestring

    Type of content element

    $typeidinteger

    Serial number of the content element

    $valuestring

    Content

    $bForce
    Details
    Author
    Olaf Niemann Jan Lengowski  
    Copyright
    four for business AG  
    functionconSetCodeFlag(int $idcatart) : void

    Set code creation flag to true

    Parameters
    NameTypeDescription
    $idcatartint

    Contenido Category-Article-ID

    Details
    Author
    Jan Lengowski  
    Copyright
    four for business AG 2003  
    functionconSyncArticle( $idart,  $srclang,  $dstlang) : void

    Parameters
    NameTypeDescription
    $idart
    $srclang
    $dstlang
    functionextractNumber(string $string) : void

    Extract a number from a string

    Parameters
    NameTypeDescription
    $stringstring

    String var by reference

    Details
    Author
    Olaf Niemann Jan Lengowski  
    Copyright
    four for business AG  
    functionisStartArticle( $idartlang,  $idcat,  $idlang,  $db = null) : void

    Parameters
    NameTypeDescription
    $idartlang
    $idcat
    $idlang
    $db
    Documentation was generated by phpDocumentor 2.0.0a12.