Mage_Core_Model_Layout_Update Class Reference

List of all members.

Public Member Functions
	__construct ()
	getElementClass ()
	resetUpdates ()
	addUpdate ($update)
	asArray ()
	asString ()
	resetHandles ()
	addHandle ($handle)
	removeHandle ($handle)
	getHandles ()
	getCacheId ()
	setCacheId ($cacheId)
	loadCache ()
	saveCache ()
	load ($handles=array())
	asSimplexml ()
	merge ($handle)
	fetchFileLayoutUpdates ()
	fetchPackageLayoutUpdates ($handle)
	fetchDbLayoutUpdates ($handle)
	fetchRecursiveUpdates ($updateXml)
Public Attributes
const	LAYOUT_GENERAL_CACHE_TAG = 'LAYOUT_GENERAL_CACHE_TAG'
Protected Attributes
	$_elementClass
	$_packageLayout
	$_cacheId
	$_cachePrefix
	$_updates = array()
	$_handles = array()
	$_subst = array()

---

Detailed Description

Definition at line 28 of file Update.php.

---

Constructor & Destructor Documentation

__construct

(

)

Definition at line 82 of file Update.php.

    {
        $subst = Mage::getConfig()->getPathVars();
        foreach ($subst as $k=>$v) {
            $this->_subst['from'][] = '{{'.$k.'}}';
            $this->_subst['to'][] = $v;
        }
    }

---

Member Function Documentation

addHandle

(

$

handle

)

Definition at line 127 of file Update.php.

    {
        if (is_array($handle)) {
            foreach ($handle as $h) {
                $this->_handles[$h] = 1;
            }
        } else {
            $this->_handles[$handle] = 1;
        }
        return $this;
    }

addUpdate

(

$

update

)

Definition at line 105 of file Update.php.

    {
        $this->_updates[] = $update;
        return $this;
    }

asArray

(

)

Definition at line 111 of file Update.php.

    {
        return $this->_updates;
    }

asSimplexml

(

)

Definition at line 231 of file Update.php.

    {
        $updates = trim($this->asString());
        $updates = '<'.'?xml version="1.0"?'.'><layout>'.$updates.'</layout>';
        return simplexml_load_string($updates, $this->getElementClass());
    }

asString

(

)

Definition at line 116 of file Update.php.

    {
        return implode('', $this->_updates);
    }

fetchDbLayoutUpdates

(

$

handle

)

Definition at line 334 of file Update.php.

    {
        $_profilerKey = 'layout/db_update: '.$handle;
        Varien_Profiler::start($_profilerKey);

        try {
            $updateStr = Mage::getResourceModel('core/layout')->fetchUpdatesByHandle($handle);
            if (!$updateStr) {
                return false;
            }
            $updateStr = str_replace($this->_subst['from'], $this->_subst['to'], $updateStr);
            $updateXml = simplexml_load_string($updateStr, $this->getElementClass());
            $this->fetchRecursiveUpdates($updateXml);

            $this->addUpdate($update);
        } catch (PDOException $e) {
            throw $e;
        } catch (Exception $e) {

        }

        Varien_Profiler::stop($_profilerKey);
        return true;
    }

fetchFileLayoutUpdates

(

)

Definition at line 253 of file Update.php.

    {
        $elementClass = $this->getElementClass();

        $design = Mage::getSingleton('core/design_package');
        $area = $design->getArea();
        $storeId = Mage::app()->getStore()->getId();
        $cacheKey = 'LAYOUT_'.$area.'_STORE'.$storeId.'_'.$design->getPackageName().'_'.$design->getTheme('layout');
#echo "TEST:".$cacheKey;
        $cacheTags = array('layout');

        if (Mage::app()->useCache('layout') && ($layoutStr = Mage::app()->loadCache($cacheKey))) {
            $this->_packageLayout = simplexml_load_string($layoutStr, $elementClass);
        }

        if (empty($layoutStr)) {
            $updatesRoot = Mage::app()->getConfig()->getNode($area.'/layout/updates');
            Mage::dispatchEvent('core_layout_update_updates_get_after', array('updates' => $updatesRoot));
            $updateFiles = array();
            foreach ($updatesRoot->children() as $updateNode) {
                if ($updateNode->file) {
                    $module = $updateNode->getAttribute('module');
                    if ($module && Mage::getStoreConfigFlag('advanced/modules_disable_output/' . $module)) {
                        continue;
                    }
                    $updateFiles[] = (string)$updateNode->file;
                }
            }

            // custom local layout updates file - load always last
            $updateFiles[] = 'local.xml';

            $layoutStr = '';
            #$layoutXml = new $elementClass('<layouts/>');
            foreach ($updateFiles as $file) {
                $filename = $design->getLayoutFilename($file);
                if (!is_readable($filename)) {
                    continue;
                }
                $fileStr = file_get_contents($filename);
                $fileStr = str_replace($this->_subst['from'], $this->_subst['to'], $fileStr);
                $fileXml = simplexml_load_string($fileStr, $elementClass);
                if (!$fileXml instanceof SimpleXMLElement) {
                    continue;
                }
                $layoutStr .= $fileXml->innerXml();

                #$layoutXml->appendChild($fileXml);
            }
            $layoutXml = simplexml_load_string('<layouts>'.$layoutStr.'</layouts>', $elementClass);

            $this->_packageLayout = $layoutXml;

            if (Mage::app()->useCache('layout')) {
                Mage::app()->saveCache($this->_packageLayout->asXml(), $cacheKey, $cacheTags, null);
            }
        }

        return $this;
    }

fetchPackageLayoutUpdates

(

$

handle

)

Definition at line 314 of file Update.php.

    {
        $_profilerKey = 'layout/package_update: '.$handle;
        Varien_Profiler::start($_profilerKey);

        if (empty($this->_packageLayout)) {
            $this->fetchFileLayoutUpdates();
        }
        foreach ($this->_packageLayout->$handle as $updateXml) {
#echo '<textarea style="width:600px; height:400px;">'.$handle.':'.print_r($updateXml,1).'</textarea>';
            $this->fetchRecursiveUpdates($updateXml);

            $this->addUpdate($updateXml->innerXml());
        }

        Varien_Profiler::stop($_profilerKey);

        return true;
    }

fetchRecursiveUpdates

(

$

updateXml

)

Definition at line 359 of file Update.php.

    {
        foreach ($updateXml->children() as $child) {
            if (strtolower($child->getName())=='update' && isset($child['handle'])) {
                $this->merge((string)$child['handle']);
            }
        }
        return $this;
    }

getCacheId

(

)

Get cache id

Returns:

string

Definition at line 155 of file Update.php.

    {
        if (!$this->_cacheId) {
            $this->_cacheId = Mage::app()->getStore()->getId().'_'.md5(join('__', $this->getHandles()));
        }
        return $this->_cacheId;
    }

getElementClass

(

)

Definition at line 91 of file Update.php.

    {
        if (!$this->_elementClass) {
            $this->_elementClass = Mage::getConfig()->getModelClassName('core/layout_element');
        }
        return $this->_elementClass;
    }

getHandles

(

)

Definition at line 145 of file Update.php.

    {
        return array_keys($this->_handles);
    }

load

(

$

handles = array()

)

Load layout updates by handles

Parameters:

array|string

$handles

Returns:

Mage_Core_Model_Layout_Update

Definition at line 207 of file Update.php.

    {
        if (is_string($handles)) {
            $handles = array($handles);
        } elseif (!is_array($handles)) {
            throw Mage::exception('Mage_Core', Mage::helper('core')->__('Invalid layout update handle'));
        }

        foreach ($handles as $handle) {
            $this->addHandle($handle);
        }

        if ($this->loadCache()) {
            return $this;
        }

        foreach ($this->getHandles() as $handle) {
            $this->merge($handle);
        }

        $this->saveCache();
        return $this;
    }

loadCache

(

)

Definition at line 175 of file Update.php.

    {
        if (!Mage::app()->useCache('layout')) {
            return false;
        }

        if (!$result = Mage::app()->loadCache($this->getCacheId())) {
            return false;
        }

        $this->addUpdate($result);

        return true;
    }

merge

(

$

handle

)

Merge layout update by handle

Parameters:

string

$handle

Returns:

Mage_Core_Model_Layout_Update

Definition at line 244 of file Update.php.

    {
        if (!$this->fetchPackageLayoutUpdates($handle)
            && !$this->fetchDbLayoutUpdates($handle)) {
            #$this->removeHandle($handle);
        }
        return $this;
    }

removeHandle

(

$

handle

)

Definition at line 139 of file Update.php.

    {
        unset($this->_handles[$handle]);
        return $this;
    }

resetHandles

(

)

Definition at line 121 of file Update.php.

    {
        $this->_handles = array();
        return $this;
    }

resetUpdates

(

)

Definition at line 99 of file Update.php.

    {
        $this->_updates = array();
        return $this;
    }

saveCache

(

)

Definition at line 190 of file Update.php.

    {
        if (!Mage::app()->useCache('layout')) {
            return false;
        }
        $str = $this->asString();
        $tags = $this->getHandles();
        $tags[] = self::LAYOUT_GENERAL_CACHE_TAG;
        return Mage::app()->saveCache($str, $this->getCacheId(), $tags, null);
    }

setCacheId

(

$

cacheId

)

Set cache id

Parameters:

string

$cacheId

Returns:

Mage_Core_Model_Layout_Update

Definition at line 169 of file Update.php.

    {
        $this->_cacheId = $cacheId;
        return $this;
    }

---

Member Data Documentation

$_cacheId [protected]

Definition at line 52 of file Update.php.

$_cachePrefix [protected]

Definition at line 59 of file Update.php.

$_elementClass [protected]

Definition at line 40 of file Update.php.

$_handles = array() [protected]

Definition at line 73 of file Update.php.

$_packageLayout [protected]

Definition at line 45 of file Update.php.

$_subst = array() [protected]

Definition at line 80 of file Update.php.

$_updates = array() [protected]

Definition at line 66 of file Update.php.

const LAYOUT_GENERAL_CACHE_TAG = 'LAYOUT_GENERAL_CACHE_TAG'

Additional tag for cleaning layout cache convenience

Definition at line 33 of file Update.php.

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/Core/Model/Layout/Update.php