Documentation

Mage_Adminhtml_Model_Config extends Config
in package

Table of Contents

Properties

$_cache  : Mage_Core_Model_Cache
Cache resource object
$_cacheChecksum  : string|false|null
$_cacheId  : string
$_cacheLifetime  : int
$_cacheSaved  : bool
$_cacheTags  : array<string|int, mixed>
$_config  : Mage_Core_Model_Config_Base
$_elementClass  : string
Class name of simplexml elements for this configuration
$_sections  : Element
$_tabs  : Element
Tabs
$_xml  : Element|null
Configuration xml
$_xpathExtends  : mixed
Xpath describing nodes in configuration that need to be extended

Methods

__construct()  : mixed
Constructor
applyExtends()  : $this
Process configuration xml
extend()  : $this
fetchCacheChecksum()  : bool
getAttributeModule()  : string
Get translate module name
getCache()  : Mage_Core_Model_Cache
getCacheChecksum()  : string|false|null
getCacheChecksumId()  : string
getCacheId()  : string
getCacheLifetime()  : int
getCacheSaved()  : bool
getCacheTags()  : array<string|int, mixed>
getEncryptedNodeEntriesPaths()  : array<string|int, mixed>
Look for encrypted node entries in all system.xml files and return them
getNode()  : Element|false
Returns node found by the $path
getSection()  : Element|void
getSections()  : Element
getSystemConfigNodeLabel()  : string
System configuration section, fieldset or field label getter
getTabs()  : Element
Retrieve tabs
getXmlString()  : string
Return Xml of node as string
getXpath()  : array<string|int, Element>|false
Returns nodes found by xpath expression
hasChildren()  : bool
loadCache()  : bool
loadDom()  : bool
Imports DOM node
loadFile()  : bool
Imports XML file
loadString()  : bool
Imports XML string
processFileData()  : string
Stub method for processing file data right after loading the file text
removeCache()  : $this
saveCache()  : $this|Mage_Adminhtml_Model_Config
setCache()  : self
setCacheChecksum()  : $this
setCacheId()  : $this
setCacheLifetime()  : $this
setCacheSaved()  : $this
setCacheTags()  : $this
setNode()  : $this
Create node by $path and set its value.
setXml()  : $this
Sets xml for this configuration
updateCacheChecksum()  : $this
validateCacheChecksum()  : bool
_initSectionsAndTabs()  : mixed
Init modules configuration
_loadCache()  : bool
_removeCache()  : mixed
_saveCache()  : bool

Properties

$_cacheChecksum

protected string|false|null $_cacheChecksum = false

$_cacheId

protected string $_cacheId = 'mage_adminhtml_config_system_xml'

$_cacheLifetime

protected int $_cacheLifetime = null

$_cacheSaved

protected bool $_cacheSaved = false

$_cacheTags

protected array<string|int, mixed> $_cacheTags = []

$_elementClass

Class name of simplexml elements for this configuration

protected string $_elementClass = \Maho\Simplexml\Element::class

$_xpathExtends

Xpath describing nodes in configuration that need to be extended

protected mixed $_xpathExtends = '//*[@extends]'
Tags
example

Methods

__construct()

Constructor

public __construct() : mixed

Initializes XML for this configuration

applyExtends()

Process configuration xml

public applyExtends() : $this
Return values
$this

extend()

public extend(Config $config[, bool $overwrite = true ]) : $this
Parameters
$config : Config
$overwrite : bool = true
Return values
$this

fetchCacheChecksum()

public fetchCacheChecksum() : bool
Return values
bool

getAttributeModule()

Get translate module name

public getAttributeModule([Element|false|null $sectionNode = null ][, Element|false|null $groupNode = null ][, Element|false|null $fieldNode = null ]) : string
Parameters
$sectionNode : Element|false|null = null
$groupNode : Element|false|null = null
$fieldNode : Element|false|null = null
Return values
string

getCacheChecksum()

public getCacheChecksum() : string|false|null
Return values
string|false|null

getCacheChecksumId()

public getCacheChecksumId() : string
Return values
string

getCacheId()

public getCacheId() : string
Return values
string

getCacheLifetime()

public getCacheLifetime() : int
Return values
int

getCacheSaved()

public getCacheSaved() : bool
Return values
bool

getCacheTags()

public getCacheTags() : array<string|int, mixed>
Return values
array<string|int, mixed>

getEncryptedNodeEntriesPaths()

Look for encrypted node entries in all system.xml files and return them

public getEncryptedNodeEntriesPaths([mixed $explodePathToEntities = false ]) : array<string|int, mixed>
Parameters
$explodePathToEntities : mixed = false
Return values
array<string|int, mixed> —

$paths

getNode()

Returns node found by the $path

public getNode([string $path = null ]) : Element|false
Parameters
$path : string = null
Tags
see
Element::descend
Return values
Element|false

getSection()

public getSection([string $sectionCode = null ][, string $websiteCode = null ][, string $storeCode = null ]) : Element|void
Parameters
$sectionCode : string = null
$websiteCode : string = null
$storeCode : string = null
Return values
Element|void

getSections()

public getSections([string $sectionCode = null ][, string $websiteCode = null ][, string $storeCode = null ]) : Element
Parameters
$sectionCode : string = null
$websiteCode : string = null
$storeCode : string = null
Return values
Element

getSystemConfigNodeLabel()

System configuration section, fieldset or field label getter

public getSystemConfigNodeLabel(string $sectionName[, string $groupName = null ][, string $fieldName = null ]) : string
Parameters
$sectionName : string
$groupName : string = null
$fieldName : string = null
Return values
string

getXmlString()

Return Xml of node as string

public getXmlString() : string
Return values
string

getXpath()

Returns nodes found by xpath expression

public getXpath(string $xpath) : array<string|int, Element>|false
Parameters
$xpath : string
Return values
array<string|int, Element>|false

hasChildren()

public hasChildren(Element $node[, string $websiteCode = null ][, string $storeCode = null ][, bool $isField = false ]) : bool
Parameters
$node : Element
$websiteCode : string = null
$storeCode : string = null
$isField : bool = false
Return values
bool

loadCache()

public loadCache() : bool
Attributes
#[Override]
Return values
bool

loadDom()

Imports DOM node

public loadDom(DOMNode $dom) : bool
Parameters
$dom : DOMNode
Return values
bool

loadFile()

Imports XML file

public loadFile(string $filePath) : bool
Parameters
$filePath : string
Return values
bool

loadString()

Imports XML string

public loadString(string $string) : bool
Parameters
$string : string
Return values
bool

processFileData()

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

public processFileData(string $text) : string
Parameters
$text : string
Return values
string

removeCache()

public removeCache() : $this
Return values
$this

setCacheChecksum()

public setCacheChecksum(string|null $data) : $this
Parameters
$data : string|null
Return values
$this

setCacheId()

public setCacheId(string $id) : $this
Parameters
$id : string
Return values
$this

setCacheLifetime()

public setCacheLifetime(int $lifetime) : $this
Parameters
$lifetime : int
Return values
$this

setCacheSaved()

public setCacheSaved(bool $flag) : $this
Parameters
$flag : bool
Return values
$this

setCacheTags()

public setCacheTags(array<string|int, mixed> $tags) : $this
Parameters
$tags : array<string|int, mixed>
Return values
$this

setNode()

Create node by $path and set its value.

public setNode(string $path, string $value[, bool $overwrite = true ]) : $this
Parameters
$path : string

separated by slashes

$value : string
$overwrite : bool = true
Return values
$this

setXml()

Sets xml for this configuration

public setXml(Element $node) : $this
Parameters
$node : Element
Return values
$this

updateCacheChecksum()

public updateCacheChecksum(string|false $data) : $this
Parameters
$data : string|false
Return values
$this

validateCacheChecksum()

public validateCacheChecksum() : bool
Return values
bool

_initSectionsAndTabs()

Init modules configuration

protected _initSectionsAndTabs() : mixed

_loadCache()

protected _loadCache(string $id) : bool
Parameters
$id : string
Return values
bool

_removeCache()

protected _removeCache(string $id) : mixed
Parameters
$id : string
Tags
todo

check this, as there are no caches that implement remove() method

_saveCache()

protected _saveCache(string $data, string $id[, array<string|int, mixed> $tags = [] ][, int|bool $lifetime = false ]) : bool
Parameters
$data : string
$id : string
$tags : array<string|int, mixed> = []
$lifetime : int|bool = false
Return values
bool
On this page

Search results