deprecated [2011-11-15] Use cLayoutHandler instead of this class.

 Methods

Construct of the class

__construct($layoutId, $layoutCode, $cfg, $lang, $db) 
deprecated [2011-11-15] Use cLayoutHandler instead of this class.

Parameters

$layoutId

$layoutCode

$cfg

$lang

$db

Removes this layout from the filesystem.

eraseLayout() : boolean
Inherited

Also deletes the version files.

inherited_from \cLayoutHandler::eraseLayout()

Returns

booleantrue on success or false on failure

Look in layout directory if layout [$layoutAlias] directory exists

existLayout(string $layoutAlias, $cfgClient, $client) : \boolen
InheritedStatic
inherited_from \cLayoutHandler::existLayout()

Parameters

$layoutAlias

string

$cfgClient

$client

Returns

\boolenif file exist true

Get the contents of the file

getLayoutCode() : \content
Inherited
inherited_from \cLayoutHandler::getLayoutCode()

Returns

\contentor false

Get the layout name

getLayoutName() : string
Inherited
inherited_from \cLayoutHandler::getLayoutName()

Returns

stringlayoutname

Init all vars for the class

init(int $layoutId, $layoutCode, array $cfg, $lang) 
Inherited
inherited_from \cLayoutHandler::init()

Parameters

$layoutId

int

$layoutCode

$cfg

array

$lang

Init class vars with values, only use for setup or upgrade

initWithDbObject(\cDb $dbObject) 
Inherited
inherited_from \cLayoutHandler::initWithDbObject()

Parameters

$dbObject

\cDb

Can write/create a file

isWritable(string $fileName, string $directory) : \boolean,
Inherited
inherited_from \cLayoutHandler::isWritable()

Parameters

$fileName

string

file name

$directory

string

directory where is the file

Returns

\boolean,success true else false

Rename the Layout directory and layout file

rename(string $old, string $new) 
Inherited
inherited_from \cLayoutHandler::rename()

Parameters

$old

string

$new

string

Save Layout

saveLayout(string $layoutCode) : boolean
Inherited
inherited_from \cLayoutHandler::saveLayout()

Parameters

$layoutCode

string

Returns

booleantrue

Save the layout only if layout doesn't exist in filesystem! Use it for upgrade!

saveLayoutByUpgrade(string $layoutCode) 
Inherited
inherited_from \cLayoutHandler::saveLayoutByUpgrade()

Parameters

$layoutCode

string

Save all layout in file system.

upgrade() : void
Inherited

Use it for upgrade.

inherited_from \cLayoutHandler::upgrade()

Exceptions

\cException if the layout could not be saved

Make all directories for layout.

_makeDirectories() : boolean
Inherited

Main directory and Layout directory

inherited_from \cLayoutHandler::_makeDirectories()

Returns

booleantrue if successfully

Make directory

_makeDirectory(string $directory) : boolean
Inherited
inherited_from \cLayoutHandler::_makeDirectory()

Parameters

$directory

string

Returns

booleantrue if succssesfully

_rec_rmdir()

_rec_rmdir($path) 
Inherited
inherited_from \cLayoutHandler::_rec_rmdir()

Parameters

$path

_save()

_save($layoutCode) 
Inherited
inherited_from \cLayoutHandler::_save()

Parameters

$layoutCode

Save encoding from language.

_setEncoding(int $lang) 
Inherited
inherited_from \cLayoutHandler::_setEncoding()

Parameters

$lang

int

 Properties

 

$_cfg : array
Inherited
inherited_from \cLayoutHandler::$$_cfg
 

$_db 
Inherited
inherited_from \cLayoutHandler::$$_db
 

$_encoding : string
Inherited
inherited_from \cLayoutHandler::$$_encoding
 

$_fileName : string
Inherited
inherited_from \cLayoutHandler::$$_fileName
 

$_layoutCode : string
Inherited
inherited_from \cLayoutHandler::$$_layoutCode
 

$_layoutId : int
Inherited
inherited_from \cLayoutHandler::$$_layoutId
 

$_layoutMainPath : string
Inherited

[layout_path].layouts

inherited_from \cLayoutHandler::$$_layoutMainPath
 

$_layoutName : string
Inherited
inherited_from \cLayoutHandler::$$_layoutName
 

$_layoutPath : string
Inherited
inherited_from \cLayoutHandler::$$_layoutPath