Docs For Class Mage_Core_Model_Layout

Description

Magento

NOTICE OF LICENSE

This source file is subject to the Open Software License (OSL 3.0) that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://opensource.org/licenses/osl-3.0.php If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

DISCLAIMER

Do not edit or add to this file if you wish to upgrade Magento to newer versions in the future. If you wish to customize Magento for your needs please refer to http://www.magentocommerce.com for more information.

copyright: Copyright (c) 2010 Magento Inc. (http://www.magentocommerce.com)
license: Open Software License (OSL 3.0)

Located in /Core/Model/Layout/Update.php (line 28)

Class Constant Summary

LAYOUT_GENERAL_CACHE_TAG = 'LAYOUT_GENERAL_CACHE_TAG'

Variable Summary

string $_cacheId

string $_cachePrefix

string $_elementClass

array $_handles

Simplexml_Element $_packageLayout

array $_subst

array $_updates

Method Summary

Mage_Core_Model_Layout_Update __construct ()

void addHandle ( $handle)

void addUpdate ( $update)

void asArray ()

void asSimplexml ()

void asString ()

void fetchDbLayoutUpdates ( $handle)

void fetchFileLayoutUpdates ()

void fetchPackageLayoutUpdates ( $handle)

void fetchRecursiveUpdates ( $updateXml)

string getCacheId ()

void getElementClass ()

Mage_Core_Model_Layout_Element getFileLayoutUpdatesXml (string $area, string $package, string $theme, [integer|null $storeId = null])

void getHandles ()

Mage_Core_Model_Layout_Update load ([array|string $handles = array()])

void loadCache ()

Mage_Core_Model_Layout_Update merge (string $handle)

void removeHandle ( $handle)

void resetHandles ()

void resetUpdates ()

void saveCache ()

Mage_Core_Model_Layout_Update setCacheId (string $cacheId)

Variables

string $_cacheId (line 52)

Cache key

access: protected

string $_cachePrefix (line 59)

Cache prefix

access: protected

string $_elementClass (line 40)

Layout Update Simplexml Element Class Name

access: protected

array $_handles = array() (line 73)

Handles used in this update

access: protected

Simplexml_Element $_packageLayout (line 45)

access: protected

array $_subst = array() (line 80)

Substitution values in structure array('from'=>array(), 'to'=>array())

access: protected

array $_updates = array() (line 66)

Cumulative array of update XML strings

access: protected

Methods

Constructor __construct (line 82)

access: public

Mage_Core_Model_Layout_Update __construct ()

addHandle (line 127)

access: public

void addHandle ( $handle)

$handle

addUpdate (line 105)

access: public

void addUpdate ( $update)

$update

asArray (line 111)

access: public

void asArray ()

asSimplexml (line 231)

access: public

void asSimplexml ()

asString (line 116)

access: public

void asString ()

fetchDbLayoutUpdates (line 357)

access: public

void fetchDbLayoutUpdates ( $handle)

$handle

fetchFileLayoutUpdates (line 257)

access: public

void fetchFileLayoutUpdates ()

fetchPackageLayoutUpdates (line 340)

access: public

void fetchPackageLayoutUpdates ( $handle)

$handle

fetchRecursiveUpdates (line 375)

access: public

void fetchRecursiveUpdates ( $updateXml)

$updateXml

getCacheId (line 155)

Get cache id

access: public

string getCacheId ()

getElementClass (line 91)

access: public

void getElementClass ()

getFileLayoutUpdatesXml (line 396)

Collect and merge layout updates from file

access: public

Mage_Core_Model_Layout_Element getFileLayoutUpdatesXml (string $area, string $package, string $theme, [integer|null $storeId = null])

string $area
string $package
string $theme
integer|null $storeId

getHandles (line 145)

access: public

void getHandles ()

load (line 207)

Load layout updates by handles

access: public

Mage_Core_Model_Layout_Update load ([array|string $handles = array()])

array|string $handles

loadCache (line 175)

access: public

void loadCache ()

merge (line 244)

Merge layout update by handle

access: public

Mage_Core_Model_Layout_Update merge (string $handle)

string $handle

removeHandle (line 139)

access: public

void removeHandle ( $handle)

$handle

resetHandles (line 121)

access: public

void resetHandles ()

resetUpdates (line 99)

access: public

void resetUpdates ()

saveCache (line 190)

access: public

void saveCache ()

setCacheId (line 169)

Set cache id

access: public

Mage_Core_Model_Layout_Update setCacheId (string $cacheId)

string $cacheId

Class Constants

LAYOUT_GENERAL_CACHE_TAG = 'LAYOUT_GENERAL_CACHE_TAG' (line 33)

Additional tag for cleaning layout cache convenience

Class Mage_Core_Model_Layout_Update