contenido\includes\functions.tpl.php

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

    Description: Define the Template related functions

    Requirements:

    Author
    Olaf Niemann  
    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 2003-01-21 modified 2008-06-26, Frederic Schneider, add security fix modified 2008-06-30 timo.trautmann added fix module settings were also copied in function tplDuplicateTemplate modified 2009-01-08, Timo Trautmann fixed bug: Changes in Head Containers in visualedit were not stored $Id: functions.tpl.php 1199 2010-08-24 14:31:44Z timo.trautmann $: }}  
    Version
    1.0.1  

    Functions

    functiontplAutoFillModules( $idtpl) : void

    Parameters
    NameTypeDescription
    $idtpl
    functiontplBrowseLayoutForContainers( $idlay) : string

    Browse a specific layout for containers

    Parameters
    NameTypeDescription
    $idlay
    Returns
    TypeDescription
    string&-seperated String of all containers
    Details
    Author
    Jan Lengowski  
    Copyright
    four for business AG  
    functiontplDeleteTemplate(int $idtpl) : \$new_idtpl

    Delete a template

    Parameters
    NameTypeDescription
    $idtplint

    ID of the template to duplicate

    Returns
    TypeDescription
    \$new_idtplID of the duplicated template
    Details
    Author
    Olaf Niemann  
    Author
    Jan Lengowski  
    Copyright
    four for business AG  
    functiontplDuplicateTemplate(int $idtpl) : \$new_idtpl

    Duplicate a template

    Parameters
    NameTypeDescription
    $idtplint

    ID of the template to duplicate

    Returns
    TypeDescription
    \$new_idtplID of the duplicated template
    Details
    Author
    Jan Lengowski  
    Copyright
    four for business AG  
    functiontplEditTemplate( $changelayout,  $idtpl,  $name,  $description,  $idlay,  $c,  $default) : void

    Edit or create a new Template

    Parameters
    NameTypeDescription
    $changelayout
    $idtpl
    $name
    $description
    $idlay
    $c
    $default
    Details
    Author
    Olaf Niemann  
    Author
    Jan Lengowski  
    Copyright
    four for business AG  
    functiontplGetContainerDefault( $idlay, int $container) : array

    Retrieve the default module

    Parameters
    NameTypeDescription
    $idlay
    $containerint

    Container number

    Returns
    TypeDescription
    arrayAllowed container types
    functiontplGetContainerMode( $idlay, int $container) : string

    Retrieve the container mode

    Parameters
    NameTypeDescription
    $idlay
    $containerint

    Container number

    Returns
    TypeDescription
    stringContainer name
    functiontplGetContainerName( $idlay, int $container) : string

    Retrieve the container name

    Parameters
    NameTypeDescription
    $idlay
    $containerint

    Container number

    Returns
    TypeDescription
    stringContainer name
    functiontplGetContainerTypes( $idlay, int $container) : array

    Retrieve the allowed container types

    Parameters
    NameTypeDescription
    $idlay
    $containerint

    Container number

    Returns
    TypeDescription
    arrayAllowed container types
    functiontplGetInUsedData(int $idtpl) : array

    Get used datas if a template is in use

    Parameters
    NameTypeDescription
    $idtplint

    Template ID

    Returns
    TypeDescription
    array- category name, article name
    Details
    Author
    Munkh-Ulzii Balidar  
    Copyright
    four for business AG  
    functiontplIsTemplateInUse(int $idtpl) : bool

    Checks if a template is in use

    Parameters
    NameTypeDescription
    $idtplint

    Template ID

    Returns
    TypeDescription
    boolis template in use
    Details
    Author
    Jan Lengowski  
    Copyright
    four for business AG modified Munkh-Ulzii Balidar, improved the sql query without while loop  
    functiontplPreparseLayout( $idlay) : \none

    Preparse the layout for caching purposes

    Parameters
    NameTypeDescription
    $idlay
    Returns
    TypeDescription
    \none
    functiontplcfgDuplicate(int $idtplcfg) : int

    Copies a complete template configuration

    Parameters
    NameTypeDescription
    $idtplcfgint

    Template Configuration ID

    Returns
    TypeDescription
    intnew template configuration ID
    Documentation was generated by phpDocumentor 2.0.0a12.