contenido\classes\class.layout.php

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

Description: Class for layout information and management

Requirements:

Author
Timo A. Hummel  
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 classes  
Since
file available since contenido release <= 4.6 {@internal created unknown modified 2008-06-30, Dominik Ziegler, add security fix modified 2008-07-02, Frederic Schneider, change sql-escapes modified 2009-10-27, OliverL, replace toInteger() to escapeString() in function getLayoutID() modified 2010-08-17, Munkh-Ulzii Balidar, - changed the code compatible to php5 - added new property aUsedTemplates and saved the information of used templates - added new method getUsedTemplates $Id: class.layout.php 1199 2010-08-24 14:31:44Z timo.trautmann $: }}  
Version
1.0.2  

\Layout

Package: Default

Properties

>VPropertyprivate$aUsedTemplates = array()
Default valuearray()Details
Type
n/a

Methods

methodpublic__construct() : void

Constructor Function

methodpublicgetAvailableLayouts() : array

getAvailableLayouts() Returns all layouts available in the system

Returns
TypeDescription
arrayArray with id and name entries
methodpublicgetLayoutID( $layout) : int

getLayoutID() Returns the idlayout for a given layout name

Parameters
NameTypeDescription
$layout

String with the Layoutname

Returns
TypeDescription
intInteger with the ID for the layout
methodpublicgetLayoutName( $layout) : string

getLayoutName() Returns the name for a given layoutid

Parameters
NameTypeDescription
$layout
Returns
TypeDescription
stringString with the name for the layout
methodpublicgetUsedTemplates() : array

Get the informations of used templates

Returns
TypeDescription
arraytemplate data
methodpubliclayoutInUse( $layout,  $bSetData = false) : bool

layoutInUse() Checks if the layout is in use

Parameters
NameTypeDescription
$layout
$bSetData
Returns
TypeDescription
boolSpecifies if the layout is in use
Documentation was generated by phpDocumentor 2.0.0a12.