Class Mage_Core_Model_Store

Description
Description | Vars (details) | Methods (details) Constants (details)

Store model

Located in /Core/Model/Store.php (line 35) 

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Core_Model_Store
Class Constant Summary
Description | Constants (details) Vars (details) | | Methods (details)
ADMIN_CODE = 'admin'
CACHE_TAG = 'store'
COOKIE_NAME = 'store'
DEFAULT_CODE = 'default'
ENTITY = 'core_store'
MEDIA_REWRITE_SCRIPT = 'get.php/'
PRICE_SCOPE_GLOBAL = 0
PRICE_SCOPE_WEBSITE = 1
URL_TYPE_DIRECT_LINK = 'direct_link'
URL_TYPE_JS = 'js'
URL_TYPE_LINK = 'link'
URL_TYPE_MEDIA = 'media'
URL_TYPE_SKIN = 'skin'
URL_TYPE_WEB = 'web'
XML_PATH_PRICE_SCOPE = 'catalog/price/scope'
XML_PATH_SECURE_BASE_LINK_URL = 'web/secure/base_link_url'
XML_PATH_SECURE_BASE_URL = 'web/secure/base_url'
XML_PATH_SECURE_IN_ADMINHTML = 'web/secure/use_in_adminhtml'
XML_PATH_SECURE_IN_FRONTEND = 'web/secure/use_in_frontend'
XML_PATH_STORE_IN_URL = 'web/url/use_store'
XML_PATH_UNSECURE_BASE_LINK_URL = 'web/unsecure/base_link_url'
XML_PATH_UNSECURE_BASE_URL = 'web/unsecure/base_url'
XML_PATH_USE_REWRITES = 'web/seo/use_rewrites'
Variable Summary
Description | Vars (details) | Methods (details) Constants (details)
mixed $_baseUrlCache
mixed $_cacheTag
mixed $_configCache
mixed $_configCacheBaseNodes
mixed $_dirCache
string $_eventObject
string $_eventPrefix
mixed $_frontendName
Mage_Core_Model_Store_Group $_group
mixed $_isAdminSecure
mixed $_isFrontSecure
mixed $_priceFilter
mixed $_session
mixed $_urlCache
Mage_Core_Model_Website $_website
Method Summary
Description | Constants (details) Vars (details) | Methods (details)
double convertPrice (double $price, [boolean $format = false], [boolean $includeContainer = true])
string formatPrice (double $price, [bool $includeContainer = true])
array getAvailableCurrencyCodes ([bool $skipBaseNotAllowed = false])
Mage_Directory_Model_Currency getBaseCurrency ()
string getBaseCurrencyCode ()
void getBaseUrl ([ $type = self::URL_TYPE_LINK], [ $secure = null])
string getCode ()
string|null getConfig (string $path, string $scope)
Mage_Directory_Model_Currency getCurrentCurrency ()
string getCurrentCurrencyCode ()
void getCurrentCurrencyRate ()
string getCurrentUrl ([bool|string $fromStore = true])
void getDefaultBasePath ()
Mage_Directory_Model_Currency getDefaultCurrency ()
string getDefaultCurrencyCode ()
void getDefaultGroupId ()
string getFrontendName ()
Mage_Core_Model_Store_Group getGroup ()
void getGroupId ()
int getId ()
void getIsActive ()
void getName ()
Varien_Filter_Sprintf getPriceFilter ()
int getRootCategoryId ()
bool getStoreInUrl ()
string getUrl ([string $route = ''], [array $params = array()])
Mage_Core_Model_Website getWebsite ()
void getWebsiteId ()
Mage_Core_Model_Config initConfigCache ()
unknown isAdmin ()
void isAdminUrlSecure ()
void isCanDelete ()
void isCurrentlySecure ()
void isFrontUrlSecure ()
bool isReadOnly ([bool $value = null])
Mage_Core_Model_Store load (mixed $id, [string $field = null])
Mage_Core_Model_Store loadConfig (string $code)
string processSubst (string $value)
Mage_Core_Model_Store resetConfig ()
double roundPrice (mixed $price)
Mage_Core_Model_Store setConfig (string $path, mixed $value)
string setCurrentCurrencyCode (string $code)
void setGroup (Mage_Core_Model_Store_Group $group)
void setWebsite (Mage_Core_Model_Website $website)
Mage_Core_Model_Store _afterDelete ()
Mage_Core_Model_Store _afterDeleteCommit ()
Mage_Core_Model_Store _beforeDelete ()
void _construct ()
Mage_Core_Model_Session_Abstract _getSession ()
string _processConfigValue (string $fullPath, string $path, Varien_Simplexml_Element $node)
string _updateMediaPathUseRewrites ([null|boolean $secure = null], [string $type = self::URL_TYPE_MEDIA])
string _updatePathUseRewrites (string $url)
string _updatePathUseStoreView (string $url)
Variables
Description | Vars (details) Constants (details) | Methods (details)
mixed $_baseUrlCache = array() (line 106)
  • access: protected
mixed $_cacheTag = true (line 71)
  • access: protected
Redefinition of:
Mage_Core_Model_Abstract::$_cacheTag
Model cache tag for clear cache in after save and after delete
mixed $_configCache = null (line 99)
  • access: protected
mixed $_configCacheBaseNodes = array() (line 100)
  • access: protected
mixed $_dirCache = array() (line 102)
  • access: protected
string $_eventObject = 'store' (line 81)
  • access: protected
Redefinition of:
Mage_Core_Model_Abstract::$_eventObject
Parameter name in event
string $_eventPrefix = 'store' (line 76)
  • access: protected
Redefinition of:
Mage_Core_Model_Abstract::$_eventPrefix
Prefix of model events names
mixed $_frontendName = null (line 113)
  • access: protected
Mage_Core_Model_Store_Group $_group (line 97)

Group model

  • access: protected
mixed $_isAdminSecure = null (line 110)
  • access: protected
mixed $_isFrontSecure = null (line 111)
  • access: protected
mixed $_priceFilter (line 83)
  • access: protected
mixed $_session (line 108)
  • access: protected
mixed $_urlCache = array() (line 104)
  • access: protected
Mage_Core_Model_Website $_website (line 90)

Website model

  • access: protected

Inherited Variables

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_dataSaveAllowed
 Mage_Core_Model_Abstract::$_isObjectNew
 Mage_Core_Model_Abstract::$_resource
 Mage_Core_Model_Abstract::$_resourceCollectionName
 Mage_Core_Model_Abstract::$_resourceName
Methods
Description | Vars (details) Constants (details) Methods (details)
convertPrice (line 762)

Convert price from default currency to current currency

  • access: public
double convertPrice (double $price, [boolean $format = false], [boolean $includeContainer = true])
  • double $price
  • boolean $format: Format price to currency format
  • boolean $includeContainer: Enclose into <span class="price"><span>
formatPrice (line 794)

Format price with currency filter (taking rate into consideration)

  • access: public
string formatPrice (double $price, [bool $includeContainer = true])
  • double $price
  • bool $includeContainer
getAvailableCurrencyCodes (line 697)

Get allowed store currency codes

If base currency is not allowed in current website config scope, then it can be disabled with $skipBaseNotAllowed

  • access: public
array getAvailableCurrencyCodes ([bool $skipBaseNotAllowed = false])
  • bool $skipBaseNotAllowed
getBaseCurrency (line 607)

Retrieve store base currency

  • access: public
Mage_Directory_Model_Currency getBaseCurrency ()
getBaseCurrencyCode (line 593)

Retrieve store base currency code

  • access: public
string getBaseCurrencyCode ()
getBaseUrl (line 413)
  • access: public
void getBaseUrl ([ $type = self::URL_TYPE_LINK], [ $secure = null])
  • $type
  • $secure
getCode (line 199)

Retrieve Store code

  • access: public
string getCode ()
getConfig (line 211)

Retrieve store configuration data

  • access: public
string|null getConfig (string $path, string $scope)
  • string $path
  • string $scope
getCurrentCurrency (line 730)

Retrieve store current currency

  • access: public
Mage_Directory_Model_Currency getCurrentCurrency ()
getCurrentCurrencyCode (line 668)

Get current store currency code

  • access: public
string getCurrentCurrencyCode ()
getCurrentCurrencyRate (line 749)
  • access: public
void getCurrentCurrencyRate ()
getCurrentUrl (line 893)

Retrieve current url for store

  • access: public
string getCurrentUrl ([bool|string $fromStore = true])
  • bool|string $fromStore
getDefaultBasePath (line 386)
  • access: public
void getDefaultBasePath ()
getDefaultCurrency (line 633)

Retrieve store default currency

  • access: public
Mage_Directory_Model_Currency getDefaultCurrency ()
getDefaultCurrencyCode (line 622)

Get default store currency code

  • access: public
string getDefaultCurrencyCode ()
getDefaultGroupId (line 873)
  • access: public
void getDefaultGroupId ()
getFrontendName (line 1017)

Retrieve storegroup name

  • access: public
string getFrontendName ()
getGroup (line 852)

Retrieve group model

  • access: public
Mage_Core_Model_Store_Group getGroup ()
getGroupId (line 868)
  • access: public
void getGroupId ()
getId (line 524)

Get store identifier

  • access: public
int getId ()
Redefinition of:
Mage_Core_Model_Abstract::getId()
Retrieve model object identifier
getIsActive (line 932)
  • access: public
void getIsActive ()
getName (line 937)
  • access: public
void getName ()
getPriceFilter (line 807)

Get store price filter

  • access: public
Varien_Filter_Sprintf getPriceFilter ()
getRootCategoryId (line 829)

Enter description here...

  • access: public
int getRootCategoryId ()
getStoreInUrl (line 514)

Returns whether url forming scheme prepends url path with store view code

  • access: public
bool getStoreInUrl ()
getUrl (line 401)

Retrieve url using store configuration specific

  • access: public
string getUrl ([string $route = ''], [array $params = array()])
  • string $route
  • array $params
getWebsite (line 302)

Retrieve store website

  • access: public
Mage_Core_Model_Website getWebsite ()
getWebsiteId (line 863)
  • access: public
void getWebsiteId ()
initConfigCache (line 236)

Initialize base store configuration data Method provide cache configuration data without loading store config XML

  • access: public
Mage_Core_Model_Config initConfigCache ()
isAdmin (line 534)

Check if store is admin store

  • access: public
unknown isAdmin ()
isAdminUrlSecure (line 540)
  • access: public
void isAdminUrlSecure ()
isCanDelete (line 878)
  • access: public
void isCanDelete ()
isCurrentlySecure (line 562)
  • access: public
void isCurrentlySecure ()
isFrontUrlSecure (line 551)
  • access: public
void isFrontUrlSecure ()
isReadOnly (line 1004)

Get/Set isReadOnly flag

  • access: public
bool isReadOnly ([bool $value = null])
  • bool $value
load (line 158)

Loading store data

  • access: public
Mage_Core_Model_Store load (mixed $id, [string $field = null])
  • mixed $id
  • string $field
Redefinition of:
Mage_Core_Model_Abstract::load()
Load object data
loadConfig (line 173)

Loading store configuration data

  • access: public
Mage_Core_Model_Store loadConfig (string $code)
  • string $code
processSubst (line 367)

Convert config values for url pathes

  • deprecated: after 1.4.2.0
  • access: public
string processSubst (string $value)
  • string $value
resetConfig (line 987)

Reinit and reset Config Data

  • access: public
Mage_Core_Model_Store resetConfig ()
roundPrice (line 782)

Round price

  • access: public
double roundPrice (mixed $price)
  • mixed $price
setConfig (line 276)

Set config value for CURRENT model This value don't save in config

  • access: public
Mage_Core_Model_Store setConfig (string $path, mixed $value)
  • string $path
  • mixed $value
setCurrentCurrencyCode (line 649)

Set current store currency code

  • access: public
string setCurrentCurrencyCode (string $code)
  • string $code
setGroup (line 842)

Set group model for store

  • access: public
void setGroup (Mage_Core_Model_Store_Group $group)
setWebsite (line 292)

Set website model

  • access: public
void setWebsite (Mage_Core_Model_Website $website)
_afterDelete (line 962)

rewrite in order to clear configuration cache

  • access: protected
Mage_Core_Model_Store _afterDelete ()
Redefinition of:
Mage_Core_Model_Abstract::_afterDelete()
Processing object after delete data
_afterDeleteCommit (line 974)

Init indexing process after store delete commit

  • access: protected
Mage_Core_Model_Store _afterDeleteCommit ()
Redefinition of:
Mage_Core_Model_Abstract::_afterDeleteCommit()
Processing manipulation after main transaction commit
_beforeDelete (line 948)

Protect delete from non admin area Register indexing event before delete store

  • access: protected
Mage_Core_Model_Store _beforeDelete ()
Redefinition of:
Mage_Core_Model_Abstract::_beforeDelete()
Processing object before delete data
_construct (line 120)
  • access: protected
void _construct ()
_getSession (line 142)

Retrieve store session object

  • access: protected
Mage_Core_Model_Session_Abstract _getSession ()
_processConfigValue (line 321)

Enter description here...

  • access: protected
string _processConfigValue (string $fullPath, string $path, Varien_Simplexml_Element $node)
  • string $fullPath
  • string $path
  • Varien_Simplexml_Element $node
_updateMediaPathUseRewrites (line 481)

Gets URL for media catalog.

If we use Database file storage and server doesn't support rewrites (.htaccess in media folder) we have to put name of fetching media script exactly into URL

  • access: protected
string _updateMediaPathUseRewrites ([null|boolean $secure = null], [string $type = self::URL_TYPE_MEDIA])
  • null|boolean $secure
  • string $type
_updatePathUseRewrites (line 462)

Remove script file name from url in case when server rewrites are enabled

  • access: protected
string _updatePathUseRewrites (string $url)
  • string $url
_updatePathUseStoreView (line 501)

Add store code to url in case if it is enabled in configuration

  • access: protected
string _updatePathUseStoreView (string $url)
  • string $url

Inherited Methods

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterCommitCallback()
Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::cleanModelCache()
Mage_Core_Model_Abstract::clearInstance()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCacheIdTags()
Mage_Core_Model_Abstract::getCacheTags()
Mage_Core_Model_Abstract::getCollection()
Mage_Core_Model_Abstract::getEntityId()
Mage_Core_Model_Abstract::getId()
Mage_Core_Model_Abstract::getIdFieldName()
Mage_Core_Model_Abstract::getResource()
Mage_Core_Model_Abstract::getResourceCollection()
Mage_Core_Model_Abstract::getResourceName()
Mage_Core_Model_Abstract::isObjectNew()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterDeleteCommit()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_afterSaveCommit()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeLoad()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_clearData()
Mage_Core_Model_Abstract::_clearReferences()
Mage_Core_Model_Abstract::_getEventData()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_hasModelChanged()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)
ADMIN_CODE = 'admin' (line 60)
CACHE_TAG = 'store' (line 62)
COOKIE_NAME = 'store' (line 64)
DEFAULT_CODE = 'default' (line 59)
ENTITY = 'core_store' (line 37)
MEDIA_REWRITE_SCRIPT = 'get.php/' (line 69)

Script name, which returns all the images

PRICE_SCOPE_GLOBAL = 0 (line 49)
PRICE_SCOPE_WEBSITE = 1 (line 50)
URL_TYPE_DIRECT_LINK = 'direct_link' (line 53)
URL_TYPE_JS = 'js' (line 56)
URL_TYPE_LINK = 'link' (line 52)
URL_TYPE_MEDIA = 'media' (line 57)
URL_TYPE_SKIN = 'skin' (line 55)
URL_TYPE_WEB = 'web' (line 54)
XML_PATH_PRICE_SCOPE = 'catalog/price/scope' (line 48)
XML_PATH_SECURE_BASE_LINK_URL = 'web/secure/base_link_url' (line 45)
XML_PATH_SECURE_BASE_URL = 'web/secure/base_url' (line 42)
XML_PATH_SECURE_IN_ADMINHTML = 'web/secure/use_in_adminhtml' (line 44)
XML_PATH_SECURE_IN_FRONTEND = 'web/secure/use_in_frontend' (line 43)
XML_PATH_STORE_IN_URL = 'web/url/use_store' (line 39)
XML_PATH_UNSECURE_BASE_LINK_URL = 'web/unsecure/base_link_url' (line 46)
XML_PATH_UNSECURE_BASE_URL = 'web/unsecure/base_url' (line 41)
XML_PATH_USE_REWRITES = 'web/seo/use_rewrites' (line 40)

Documentation generated on Fri, 11 Feb 2011 17:13:25 +0200 by phpDocumentor 1.4.3