Documentation

Mage_Adminhtml_Model_System_Store extends DataObject
in package

Mage

Adminhtml

Properties

$_data : array<string|int, mixed>|null: Object attributes
$_dirty : array<string|int, mixed>
$_groupCollection : array<string|int, mixed>: Group collection groupId => Mage_Core_Model_Store_Group
$_hasDataChanges : bool: Data changes flag (true after setData|unsetData call)
$_idFieldName : string: Name of object id field
$_isDeleted : bool: Object delete flag
$_oldFieldsMap : array<string|int, mixed>: Map short fields names to its full names
$_storeCollection : array<string|int, mixed>: Store collection storeId => Mage_Core_Model_Store
$_syncFieldsMap : mixed: Map of fields to sync to other fields upon changing their data
$_underscoreCache : array<string|int, mixed>: Setter/Getter underscore transformation cache
$_websiteCollection : array<string|int, mixed>: Website collection websiteId => Mage_Core_Model_Website
$_isAdminScopeAllowed : bool

Methods

__call() : mixed: Set/Get attribute wrapper
__construct() : mixed: Init model Load Website, Group and Store collections
__get() : mixed: Attribute getter (deprecated)
__set() : mixed: Attribute setter (deprecated)
__toArray() : array<string|int, mixed>: Convert object attributes to array
addData() : $this: Add data to the object.
debug() : string|array<string|int, mixed>: Present object data as string in debug mode
flagDirty() : $this
getData() : mixed: Object data getter
getDataByKey() : mixed: Get object data by particular key
getDataByPath() : mixed: Get object data by path
getDataSetDefault() : mixed: Fast get data or set default if value is not available
getDataUsingMethod() : mixed: Get object data by key with calling getter method
getGroupCollection() : array<string|int, mixed>: Retrieve Group collection as array
getGroupName() : string|null: Retrieve Group name by Id
getId() : mixed: Retrieve object id
getIdFieldName() : string: Retrieve name of object id field
getStoreCollection() : array<string|int, mixed>: Retrieve Store collection as array
getStoreData() : Mage_Core_Model_Store: Retrieve store name with website and website store
getStoreGroupOptionHash() : array<string|int, mixed>: Get store groups as id => name associative array
getStoreName() : string|null: Retrieve Store name by Id
getStoreNamePath() : string: Retrieve store path with website and website store
getStoreNameWithWebsite() : string: Retrieve store name with website and website store
getStoreOptionHash() : array<string|int, mixed>: Get store views as id => name associative array
getStoresStructure() : array<string|int, mixed>: Retrieve stores structure
getStoreValuesForForm() : array<string|int, mixed>: Retrieve store values for form
getWebsiteCollection() : array<string|int, mixed>: Retrieve Website collection as array
getWebsiteName() : string|null: Retrieve Website name by Id
getWebsiteOptionHash() : array<string|int, mixed>: Get websites as id => name associative array
getWebsiteValuesForForm() : array<string|int, mixed>: Website label/value array getter, compatible with form dropdown options
hasData() : bool: If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.
hasDataChanges() : bool: Get data change status
isDeleted() : bool: Set _isDeleted flag value (if $isDeleted param is defined) and return current flag value
isDirty() : bool
isEmpty() : bool: checks whether the object is empty
jsonSerialize() : array<string|int, mixed>: Implementation of JsonSerializable::jsonSerialize()
offsetExists() : bool: Implementation of ArrayAccess::offsetExists()
offsetGet() : mixed: Implementation of ArrayAccess::offsetGet()
offsetSet() : void: Implementation of ArrayAccess::offsetSet()
offsetUnset() : void: Implementation of ArrayAccess::offsetUnset()
reload() : $this: Load/Reload collection(s) by type Allowed types: website, group, store or null for all
serialize() : string: serialize object attributes
setData() : $this: Overwrite data in the object.
setDataChanges() : $this: Clears data changes status
setDataUsingMethod() : $this: Set object data with calling setter method
setId() : $this: Set object id field value
setIdFieldName() : $this: set name of object id field
setIsAdminScopeAllowed() : $this: Specify whether to show admin-scope options
toArray() : array<string|int, mixed>: Public wrapper for __toArray
toJson() : string: Public wrapper for __toJson
toString() : string: Public wrapper for __toString
toXml() : string: Public wrapper for __toXml
unsetData() : $this: Unset data from the object.
unsetOldData() : $this: Unset old fields data from the object.
__toJson() : string: Convert object attributes to JSON
__toXml() : string: Convert object attributes to XML
_addFullNames() : mixed
_camelize() : string
_construct() : void: Internal constructor not depended on params. Can be used for object initialization
_getData() : mixed: Get value from _data array without parse key
_initOldFieldsMap() : mixed: Inits mapping array of object's previously used fields to new fields.
_loadGroupCollection() : $this: Load/Reload Group collection
_loadStoreCollection() : $this: Load/Reload Store collection
_loadWebsiteCollection() : $this: Load/Reload Website collection
_prepareArray() : array<string|int, mixed>: Set required array elements
_prepareSyncFieldsMap() : $this: Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.
_underscore() : string: Converts field names for setters and getters

$_data

Object attributes


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

$_dirty


        protected
            array<string|int, mixed>
    $_dirty

$_groupCollection

Group collection groupId => Mage_Core_Model_Store_Group


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

$_hasDataChanges

Data changes flag (true after setData|unsetData call)


        protected
            bool
    $_hasDataChanges
     = false

$_idFieldName

Name of object id field


        protected
            string
    $_idFieldName
     = null

$_isDeleted

Object delete flag


        protected
            bool
    $_isDeleted
     = false

$_oldFieldsMap

Map short fields names to its full names


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

$_storeCollection

Store collection storeId => Mage_Core_Model_Store


        protected
            array<string|int, mixed>
    $_storeCollection

$_syncFieldsMap

Map of fields to sync to other fields upon changing their data


        protected
            mixed
    $_syncFieldsMap
     = []

$_underscoreCache

Setter/Getter underscore transformation cache


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

$_websiteCollection

Website collection websiteId => Mage_Core_Model_Website


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

$_isAdminScopeAllowed


        private
            bool
    $_isAdminScopeAllowed
     = \true

__call()

Set/Get attribute wrapper


    public
                    __call(string $method, array<string|int, mixed> $args) : mixed

Parameters

$method : string
$args : array<string|int, mixed>

__construct()

Init model Load Website, Group and Store collections


    public
                    __construct() : mixed

__get()

Attribute getter (deprecated)


    public
                    __get(string $var) : mixed

Parameters

$var : string

__set()

Attribute setter (deprecated)


    public
                    __set(string $var, mixed $value) : mixed

Parameters

$var : string
$value : mixed

__toArray()

Convert object attributes to array


    public
                    __toArray([array<string|int, mixed> $arrAttributes = [] ]) : array<string|int, mixed>

Parameters

$arrAttributes : array<string|int, mixed> = []: array of required attributes

Return values

array<string|int, mixed>

addData()

Add data to the object.


    public
                    addData(array<string|int, mixed> $arr) : $this

Retains previous data in the object.

Parameters

$arr : array<string|int, mixed>

Return values

$this

debug()

Present object data as string in debug mode


    public
                    debug([mixed $data = null ][, array<string|int, mixed> &$objects = [] ]) : string|array<string|int, mixed>

Parameters

$data : mixed = null
$objects : array<string|int, mixed> = []

Return values

string|array<string|int, mixed>

flagDirty()


    public
                    flagDirty(string $field[, bool $flag = true ]) : $this

Parameters

$field : string
$flag : bool = true

Return values

$this

getData()

Object data getter


    public
                    getData([string $key = '' ][, string|int $index = null ]) : mixed

If $key is not defined will return all the data as an array. Otherwise, it will return value of the element specified by $key. It is possible to use keys like a/b/c for access nested array data

If $index is specified it will assume that attribute data is an array and retrieve corresponding member. If data is the string - it will be explode by new line character and converted to array.

Parameters

$key : string = ''
$index : string|int = null

getDataByKey()

Get object data by particular key


    public
                    getDataByKey(string $key) : mixed

Parameters

$key : string

getDataByPath()

Get object data by path


    public
                    getDataByPath(string $path) : mixed

Method consider the path as chain of keys: a/b/c => ['a']['b']['c']

Parameters

$path : string

getDataSetDefault()

Fast get data or set default if value is not available


    public
                    getDataSetDefault(string $key, mixed $default) : mixed

Parameters

$key : string
$default : mixed

getDataUsingMethod()

Get object data by key with calling getter method


    public
                    getDataUsingMethod(string $key[, mixed $args = null ]) : mixed

Parameters

$key : string
$args : mixed = null

getGroupCollection()

Retrieve Group collection as array


    public
                    getGroupCollection() : array<string|int, mixed>

Return values

array<string|int, mixed>

getGroupName()

Retrieve Group name by Id


    public
                    getGroupName(int $groupId) : string|null

Parameters

$groupId : int

Return values

string|null

getId()

Retrieve object id


    public
                    getId() : mixed

getIdFieldName()

Retrieve name of object id field


    public
                    getIdFieldName() : string

Return values

string

getStoreCollection()

Retrieve Store collection as array


    public
                    getStoreCollection() : array<string|int, mixed>

Return values

array<string|int, mixed>

getStoreData()

Retrieve store name with website and website store


    public
                    getStoreData(int $storeId) : Mage_Core_Model_Store

Parameters

$storeId : int

Return values

Mage_Core_Model_Store

getStoreGroupOptionHash()

Get store groups as id => name associative array


    public
                    getStoreGroupOptionHash([string $attribute = 'name' ]) : array<string|int, mixed>

Parameters

$attribute : string = 'name'

Return values

array<string|int, mixed>

getStoreName()

Retrieve Store name by Id


    public
                    getStoreName(int $storeId) : string|null

Parameters

$storeId : int

Return values

string|null

getStoreNamePath()

Retrieve store path with website and website store


    public
                    getStoreNamePath(int $storeId) : string

Parameters

$storeId : int

Return values

string

getStoreNameWithWebsite()

Retrieve store name with website and website store


    public
                    getStoreNameWithWebsite(int $storeId) : string

Parameters

$storeId : int

Return values

string

getStoreOptionHash()

Get store views as id => name associative array


    public
                    getStoreOptionHash([bool $withDefault = false ][, string $attribute = 'name' ]) : array<string|int, mixed>

Parameters

$withDefault : bool = false
$attribute : string = 'name'

Return values

array<string|int, mixed>

getStoresStructure()

Retrieve stores structure


    public
                    getStoresStructure([bool $isAll = false ][, array<string|int, mixed> $storeIds = [] ][, array<string|int, mixed> $groupIds = [] ][, array<string|int, mixed> $websiteIds = [] ]) : array<string|int, mixed>

Parameters

$isAll : bool = false
$storeIds : array<string|int, mixed> = []
$groupIds : array<string|int, mixed> = []
$websiteIds : array<string|int, mixed> = []

Return values

array<string|int, mixed>

getStoreValuesForForm()

Retrieve store values for form


    public
                    getStoreValuesForForm([bool $empty = false ][, bool $all = false ]) : array<string|int, mixed>

Parameters

$empty : bool = false
$all : bool = false

Return values

array<string|int, mixed>

getWebsiteCollection()

Retrieve Website collection as array


    public
                    getWebsiteCollection() : array<string|int, mixed>

Return values

array<string|int, mixed>

getWebsiteName()

Retrieve Website name by Id


    public
                    getWebsiteName(int $websiteId) : string|null

Parameters

$websiteId : int

Return values

string|null

getWebsiteOptionHash()

Get websites as id => name associative array


    public
                    getWebsiteOptionHash([bool $withDefault = false ][, string $attribute = 'name' ]) : array<string|int, mixed>

Parameters

$withDefault : bool = false
$attribute : string = 'name'

Return values

array<string|int, mixed>

getWebsiteValuesForForm()

Website label/value array getter, compatible with form dropdown options


    public
                    getWebsiteValuesForForm([bool $empty = false ][, bool $all = false ]) : array<string|int, mixed>

Parameters

$empty : bool = false
$all : bool = false

Return values

array<string|int, mixed>

hasData()

If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.


    public
                    hasData([string $key = '' ]) : bool

Parameters

$key : string = ''

Return values

bool

hasDataChanges()

Get data change status


    public
                    hasDataChanges() : bool

Return values

bool

isDeleted()

Set _isDeleted flag value (if $isDeleted param is defined) and return current flag value


    public
                    isDeleted([bool $isDeleted = null ]) : bool

Parameters

$isDeleted : bool = null

Return values

bool

isDirty()


    public
                    isDirty([string $field = null ]) : bool

Parameters

$field : string = null

Return values

bool

isEmpty()

checks whether the object is empty


    public
                    isEmpty() : bool

Return values

bool

jsonSerialize()

Implementation of JsonSerializable::jsonSerialize()


    public
                    jsonSerialize() : array<string|int, mixed>

Prepares the object data for JSON serialization. Returns all object data as an array, with special handling for nested DataObject instances:

If a nested DataObject has a custom jsonSerialize() implementation, it's preserved as-is
If a nested DataObject has a custom toJson() method, it's converted to JSON string
If a nested DataObject uses only the base implementations, it's excluded from output

This prevents infinite recursion and circular references when serializing object hierarchies.

#[Override]

Return values

array<string|int, mixed>

offsetExists()

Implementation of ArrayAccess::offsetExists()


    public
                    offsetExists(string $offset) : bool

Parameters

$offset : string

Return values

bool

offsetGet()

Implementation of ArrayAccess::offsetGet()


    public
                    offsetGet(string $offset) : mixed

Parameters

$offset : string

offsetSet()

Implementation of ArrayAccess::offsetSet()


    public
                    offsetSet(string $offset, mixed $value) : void

Parameters

$offset : string
$value : mixed

offsetUnset()

Implementation of ArrayAccess::offsetUnset()


    public
                    offsetUnset(string $offset) : void

Parameters

$offset : string

reload()

Load/Reload collection(s) by type Allowed types: website, group, store or null for all


    public
                    reload([string $type = null ]) : $this

Parameters

$type : string = null

Return values

$this

serialize()

serialize object attributes


    public
                    serialize([array<string|int, mixed> $attributes = [] ][, string $valueSeparator = '=' ][, string $fieldSeparator = ' ' ][, string $quote = '"' ]) : string

Parameters

$attributes : array<string|int, mixed> = []
$valueSeparator : string = '='
$fieldSeparator : string = ' '
$quote : string = '"'

Return values

string

setData()

Overwrite data in the object.


    public
                    setData(string|array<string|int, mixed> $key[, mixed $value = null ]) : $this

$key can be string or array. If $key is string, the attribute value will be overwritten by $value

If $key is an array, it will overwrite all the data in the object.

Parameters

$key : string|array<string|int, mixed>
$value : mixed = null

Return values

$this

setDataChanges()

Clears data changes status


    public
                    setDataChanges(bool $value) : $this

Parameters

$value : bool

Return values

$this

setDataUsingMethod()

Set object data with calling setter method


    public
                    setDataUsingMethod(string $key[, mixed $args = [] ]) : $this

Parameters

$key : string
$args : mixed = []

Return values

$this

setId()

Set object id field value


    public
                    setId(mixed $value) : $this

Parameters

$value : mixed

Return values

$this

setIdFieldName()

set name of object id field


    public
                    setIdFieldName(string $name) : $this

Parameters

$name : string

Return values

$this

setIsAdminScopeAllowed()

Specify whether to show admin-scope options


    public
                    setIsAdminScopeAllowed(bool $value) : $this

Parameters

$value : bool

Return values

$this

toArray()

Public wrapper for __toArray


    public
                    toArray([array<string|int, mixed> $arrAttributes = [] ]) : array<string|int, mixed>

Parameters

$arrAttributes : array<string|int, mixed> = []

Return values

array<string|int, mixed>

toJson()

Public wrapper for __toJson


    public
                    toJson([array<string|int, mixed> $arrAttributes = [] ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []

Return values

string

toString()

Public wrapper for __toString


    public
                    toString([string $format = '' ]) : string

Will use $format as an template and substitute {{key}} for attributes

Parameters

$format : string = ''

Return values

string

toXml()

Public wrapper for __toXml


    public
                    toXml([array<string|int, mixed> $arrAttributes = [] ][, string $rootName = 'item' ][, bool $addOpenTag = false ][, bool $addCdata = true ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []
$rootName : string = 'item'
$addOpenTag : bool = false
$addCdata : bool = true

Return values

string

unsetData()

Unset data from the object.


    public
                    unsetData([string $key = null ]) : $this

$key can be a string only. Array will be ignored.

Parameters

$key : string = null

Return values

$this

unsetOldData()

Unset old fields data from the object.


    public
                    unsetOldData([string $key = null ]) : $this

$key can be a string only. Array will be ignored.

Parameters

$key : string = null

Return values

$this

__toJson()

Convert object attributes to JSON


    protected
                    __toJson([array<string|int, mixed> $arrAttributes = [] ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []: array of required attributes

Return values

string

__toXml()

Convert object attributes to XML


    protected
                    __toXml([array<string|int, mixed> $arrAttributes = [] ][, string $rootName = 'item' ][, bool $addOpenTag = false ][, bool $addCdata = true ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []: array of required attributes
$rootName : string = 'item': name of the root element
$addOpenTag : bool = false
$addCdata : bool = true

Return values

string

_addFullNames()


    protected
                    _addFullNames() : mixed

_camelize()


    protected
                    _camelize(string $name) : string

Parameters

$name : string

Return values

string

_construct()

Internal constructor not depended on params. Can be used for object initialization


    protected
                    _construct() : void

_getData()

Get value from _data array without parse key


    protected
                    _getData(string $key) : mixed

Parameters

$key : string

_initOldFieldsMap()

Inits mapping array of object's previously used fields to new fields.


    protected
                    _initOldFieldsMap() : mixed

Must be overloaded by descendants to set concrete fields map.

_loadGroupCollection()

Load/Reload Group collection


    protected
                    _loadGroupCollection() : $this

Return values

$this

_loadStoreCollection()

Load/Reload Store collection


    protected
                    _loadStoreCollection() : $this

Return values

$this

_loadWebsiteCollection()

Load/Reload Website collection


    protected
                    _loadWebsiteCollection() : $this

Return values

$this

_prepareArray()

Set required array elements


    protected
                    _prepareArray(array<string|int, mixed> &$arr[, array<string|int, mixed> $elements = [] ]) : array<string|int, mixed>

Parameters

$arr : array<string|int, mixed>
$elements : array<string|int, mixed> = []

Return values

array<string|int, mixed>

_prepareSyncFieldsMap()

Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.


    protected
                    _prepareSyncFieldsMap() : $this

Return values

$this

_underscore()

Converts field names for setters and getters


    protected
                    _underscore(string $name) : string

$this->setMyField($value) === $this->setData('my_field', $value) Uses cache to eliminate unnecessary preg_replace

Parameters

$name : string

Return values

string

Mage_Adminhtml_Model_System_Store extends DataObject in package Mage Adminhtml

Table of Contents

Properties

Methods

Properties

$_data

$_dirty

$_groupCollection

$_hasDataChanges

$_idFieldName

$_isDeleted

$_oldFieldsMap

$_storeCollection

$_syncFieldsMap

$_underscoreCache

$_websiteCollection

$_isAdminScopeAllowed

Methods

__call()

Parameters

__construct()

__get()

Parameters

__set()

Parameters

__toArray()

Parameters

Return values

addData()

Parameters

Return values

debug()

Parameters

Return values

flagDirty()

Parameters

Return values

getData()

Parameters

getDataByKey()

Parameters

getDataByPath()

Parameters

getDataSetDefault()

Parameters

getDataUsingMethod()

Parameters

getGroupCollection()

Return values

getGroupName()

Parameters

Return values

getId()

getIdFieldName()

Return values

getStoreCollection()

Return values

getStoreData()

Parameters

Return values

getStoreGroupOptionHash()

Parameters

Return values

getStoreName()

Parameters

Return values

getStoreNamePath()

Parameters

Return values

getStoreNameWithWebsite()

Parameters

Return values

getStoreOptionHash()

Parameters

Return values

getStoresStructure()

Parameters

Return values

getStoreValuesForForm()

Parameters

Mage_Adminhtml_Model_System_Store extends DataObject
in package

Mage

Adminhtml