Docs For Class Varien_Simplexml

Class Varien_Simplexml_Config

Description

Base class for simplexml based configurations

author: Magento Core Team <core@magentocommerce.com>

Located in /Simplexml/Config.php (line 35)

Variable Summary

Varien_Simplexml_Config_Cache_Abstract $_cache

unknown_type $_cacheChecksum

string $_cacheId

int $_cacheLifetime

boolean $_cacheSaved

array $_cacheTags

string $_elementClass

Varien_Simplexml_Element $_xml

mixed $_xpathExtends

Method Summary

Varien_Simplexml_Config __construct ([string|Varien_Simplexml_Element $sourceData = null], string $sourceType)

Varien_Simplexml_Config applyExtends ()

Varien_Simplexml_Config extend (Varien_Simplexml_Config $config, [boolean $overwrite = true])

boolean fetchCacheChecksum ()

Varien_Simplexml_Config_Cache_Abstract getCache ()

string getCacheChecksum ()

string getCacheChecksumId ()

string getCacheId ()

int getCacheLifetime ()

boolean getCacheSaved ()

array getCacheTags ()

Varien_Simplexml_Element getNode ([string $path = null])

string getXmlString ()

array getXpath (string $xpath)

boolean loadCache ()

Varien_Simplexml_Element loadDom (DOMNode $dom)

boolean loadFile (string $filePath)

boolean loadString (string $string)

string processFileData (string $text)

Varien_Simplexml_Config removeCache ()

Varien_Simplexml_Config saveCache ([array $tags = null])

Varien_Simplexml_Config setCache (Varien_Simplexml_Config_Cache_Abstract $cache)

Varien_Simplexml_Config setCacheChecksum (string $data)

Varien_Simplexml_Config setCacheId (string $id)

Varien_Simplexml_Config setCacheLifetime (int $lifetime)

Varien_Simplexml_Config setCacheSaved (boolean $flag)

Varien_Simplexml_Config setCacheTags (array $tags)

Varien_Simplexml_Config setNode (string $path, string $value, [boolean $overwrite = true])

Varien_Simplexml_Config setXml (Varien_Simplexml_Element $node, Varien_Simplexml_Element $sourceData)

Varien_Simplexml_Config updateCacheChecksum (string $data)

boolean validateCacheChecksum ()

boolean _loadCache (string $id)

unknown _removeCache (string $id)

boolean _saveCache (string $data, string $id, [array $tags = array()], [int|boolean $lifetime = false])

Variables

Varien_Simplexml_Config_Cache_Abstract $_cache = null (line 85)

Cache resource object

access: protected

unknown_type $_cacheChecksum = false (line 71)

Enter description here...

access: protected

string $_cacheId = null (line 50)

Enter description here...

access: protected

int $_cacheLifetime = null (line 64)

Enter description here...

access: protected

boolean $_cacheSaved = false (line 78)

Enter description here...

access: protected

array $_cacheTags = array() (line 57)

Enter description here...

access: protected

string $_elementClass = 'Varien_Simplexml_Element' (line 92)

Class name of simplexml elements for this configuration

access: protected

Varien_Simplexml_Element $_xml = null (line 43)

Configuration xml

access: protected

mixed $_xpathExtends = "//*[@extends]" (line 99)

Xpath describing nodes in configuration that need to be extended

access: protected
example: example not found

Methods

Constructor __construct (line 110)

Constructor

Initializes XML for this configuration

see: self::setXml
access: public

Varien_Simplexml_Config __construct ([string|Varien_Simplexml_Element $sourceData = null], string $sourceType)

string|Varien_Simplexml_Element $sourceData
string $sourceType

applyExtends (line 559)

Process configuration xml

access: public

Varien_Simplexml_Config applyExtends ()

extend (line 598)

Enter description here...

access: public

Varien_Simplexml_Config extend (Varien_Simplexml_Config $config, [boolean $overwrite = true])

Varien_Simplexml_Config $config
boolean $overwrite

fetchCacheChecksum (line 348)

Enter description here...

access: public

boolean fetchCacheChecksum ()

getCache (line 193)

Enter description here...

access: public

Varien_Simplexml_Config_Cache_Abstract getCache ()

getCacheChecksum (line 328)

Enter description here...

access: public

string getCacheChecksum ()

getCacheChecksumId (line 338)

Enter description here...

access: public

string getCacheChecksumId ()

getCacheId (line 237)

Enter description here...

access: public

string getCacheId ()

getCacheLifetime (line 281)

Enter description here...

access: public

int getCacheLifetime ()

getCacheSaved (line 215)

Enter description here...

access: public

boolean getCacheSaved ()

getCacheTags (line 259)

Enter description here...

access: public

array getCacheTags ()

getNode (line 146)

Returns node found by the $path

see: Varien_Simplexml_Element::descend
access: public

Varien_Simplexml_Element getNode ([string $path = null])

string $path

getXmlString (line 429)

Return Xml of node as string

access: public

string getXmlString ()

getXpath (line 163)

Returns nodes found by xpath expression

access: public

array getXpath (string $xpath)

string $xpath

loadCache (line 376)

Enter description here...

access: public

boolean loadCache ()

loadDom (line 528)

Imports DOM node

access: public

Varien_Simplexml_Element loadDom (DOMNode $dom)

DOMNode $dom

loadFile (line 489)

Imports XML file

access: public

boolean loadFile (string $filePath)

string $filePath

loadString (line 507)

Imports XML string

access: public

boolean loadString (string $string)

string $string

processFileData (line 586)

Stub method for processing file data right after loading the file text

access: public

string processFileData (string $text)

string $text

removeCache (line 439)

Enter description here...

access: public

Varien_Simplexml_Config removeCache ()

saveCache (line 399)

Enter description here...

access: public

Varien_Simplexml_Config saveCache ([array $tags = null])

array $tags

setCache (line 182)

Enter description here...

access: public

Varien_Simplexml_Config setCache (Varien_Simplexml_Config_Cache_Abstract $cache)

Varien_Simplexml_Config_Cache_Abstract $cache

setCacheChecksum (line 292)

Enter description here...

access: public

Varien_Simplexml_Config setCacheChecksum (string $data)

string $data

setCacheId (line 226)

Enter description here...

access: public

Varien_Simplexml_Config setCacheId (string $id)

string $id

setCacheLifetime (line 270)

Enter description here...

access: public

Varien_Simplexml_Config setCacheLifetime (int $lifetime)

int $lifetime

setCacheSaved (line 204)

Enter description here...

access: public

Varien_Simplexml_Config setCacheSaved (boolean $flag)

boolean $flag

setCacheTags (line 248)

Enter description here...

access: public

Varien_Simplexml_Config setCacheTags (array $tags)

array $tags

setNode (line 548)

Create node by $path and set its value.

access: public

Varien_Simplexml_Config setNode (string $path, string $value, [boolean $overwrite = true])

string $path: separated by slashes
string $value
boolean $overwrite

setXml (line 133)

Sets xml for this configuration

access: public

Varien_Simplexml_Config setXml (Varien_Simplexml_Element $node, Varien_Simplexml_Element $sourceData)

Varien_Simplexml_Element $sourceData
Varien_Simplexml_Element $node

updateCacheChecksum (line 310)

Enter description here...

access: public

Varien_Simplexml_Config updateCacheChecksum (string $data)

string $data

validateCacheChecksum (line 358)

Enter description here...

access: public

boolean validateCacheChecksum ()

_loadCache (line 452)

Enter description here...

access: protected

boolean _loadCache (string $id)

string $id

_removeCache (line 478)

Enter description here...

todo: check this, as there are no caches that implement remove() method
access: protected

unknown _removeCache (string $id)

string $id

_saveCache (line 466)

Enter description here...

access: protected

boolean _saveCache (string $data, string $id, [array $tags = array()], [int|boolean $lifetime = false])

string $data
string $id
array $tags
int|boolean $lifetime

Documentation generated on Fri, 11 Feb 2011 16:53:15 +0200 by phpDocumentor 1.4.3