Class Mage_Core_Model_Store

Store model

Varien_Object

Mage_Core_Model_Store

Package: Mage\Core
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Core/Model/Store.php

Methods summary
`protected`	# `_construct( )` Initialize object Initialize object
`protected Mage_Core_Model_Session_Abstract`	# `_getSession( )` Retrieve store session object Retrieve store session object Returns `Mage_Core_Model_Session_Abstract`
`public Mage_Core_Model_Store`	# `load( mixed $id, string $field = null )` Loading store data Loading store data Parameters `$id` `mixed` $id `$field` `string` $field Returns `Mage_Core_Model_Store` Overrides `Mage_Core_Model_Abstract::load()`
`public Mage_Core_Model_Store`	# `loadConfig( string $code )` Loading store configuration data Loading store configuration data Parameters `$code` `string` $code Returns `Mage_Core_Model_Store`
`public string`	# `getCode( )` Retrieve Store code Retrieve Store code Returns `string`
`public string\|null`	# `getConfig( string $path )` Retrieve store configuration data Retrieve store configuration data Parameters `$path` `string` $path Returns `string\|null`
`public Mage_Core_Model_Config`	# `initConfigCache( )` Initialize base store configuration data Initialize base store configuration data Method provide cache configuration data without loading store config XML Returns `Mage_Core_Model_Config`
`public Mage_Core_Model_Store`	# `setConfig( string $path, mixed $value )` Set config value for CURRENT model Set config value for CURRENT model This value don't save in config Parameters `$path` `string` $path `$value` `mixed` $value Returns `Mage_Core_Model_Store`
`public`	# `setWebsite( Mage_Core_Model_Website $website )` Set website model Set website model Parameters `$website` `Mage_Core_Model_Website` $website
`public Mage_Core_Model_Website`	# `getWebsite( )` Retrieve store website Retrieve store website Returns `Mage_Core_Model_Website`
`protected string`	# `_processConfigValue( string $fullPath, string $path, Varien_Simplexml_Element $node )` Process config value Process config value Parameters `$fullPath` `string` $fullPath `$path` `string` $path `$node` `Varien_Simplexml_Element` $node Returns `string`
`public string`	# `getDefaultBasePath( )` Retrieve default base path Retrieve default base path Returns `string`
`public string`	# `getUrl( string $route = '', array $params = array() )` Retrieve url using store configuration specific Retrieve url using store configuration specific Parameters `$route` `string` $route `$params` `array` $params Returns `string`
`public string`	# `getBaseUrl( string $type = Mage_Core_Model_Store::URL_TYPE_LINK, boolean\|null $secure = null )` Retrieve base URL Retrieve base URL Parameters `$type` `string` $type `$secure` `boolean\|null` $secure Returns `string`
`protected string`	# `_updatePathUseRewrites( string $url )` Remove script file name from url in case when server rewrites are enabled Remove script file name from url in case when server rewrites are enabled Parameters `$url` `string` $url Returns `string`
`protected boolean`	# `_isCustomEntryPoint( )` Check if used entry point is custom Check if used entry point is custom Returns `boolean`
`protected string`	# `_updateMediaPathUseRewrites( null\|boolean $secure = null, string $type = Mage_Core_Model_Store::URL_TYPE_MEDIA )` Retrieve URL for media catalog Retrieve 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 Parameters `$secure` `null\|boolean` $secure `$type` `string` $type Returns `string`
`protected string`	# `_updatePathUseStoreView( string $url )` Add store code to url in case if it is enabled in configuration Add store code to url in case if it is enabled in configuration Parameters `$url` `string` $url Returns `string`
`public boolean`	# `getStoreInUrl( )` Returns whether url forming scheme prepends url path with store view code Returns whether url forming scheme prepends url path with store view code Returns `boolean`
`public integer`	# `getId( )` Get store identifier Get store identifier Returns `integer` Overrides `Mage_Core_Model_Abstract::getId()`
`public unknown`	# `isAdmin( )` Check if store is admin store Check if store is admin store Returns `unknown`
`public boolean`	# `isAdminUrlSecure( )` Check if backend URLs should be secure Check if backend URLs should be secure Returns `boolean`
`public boolean`	# `isFrontUrlSecure( )` Check if frontend URLs should be secure Check if frontend URLs should be secure Returns `boolean`
`public boolean`	# `isCurrentlySecure( )` Check if request was secure Check if request was secure Returns `boolean`
`public string`	# `getBaseCurrencyCode( )` Retrieve store base currency code Retrieve store base currency code Returns `string`
`public Mage_Directory_Model_Currency`	# `getBaseCurrency( )` Retrieve store base currency Retrieve store base currency Returns `Mage_Directory_Model_Currency`
`public string`	# `getDefaultCurrencyCode( )` Get default store currency code Get default store currency code Returns `string`
`public Mage_Directory_Model_Currency`	# `getDefaultCurrency( )` Retrieve store default currency Retrieve store default currency Returns `Mage_Directory_Model_Currency`
`public string`	# `setCurrentCurrencyCode( string $code )` Set current store currency code Set current store currency code Parameters `$code` `string` $code Returns `string`
`public string`	# `getCurrentCurrencyCode( )` Get current store currency code Get current store currency code Returns `string`
`public array`	# `getAvailableCurrencyCodes( boolean $skipBaseNotAllowed = false )` Get allowed store currency codes Get allowed store currency codes If base currency is not allowed in current website config scope, then it can be disabled with $skipBaseNotAllowed Parameters `$skipBaseNotAllowed` `boolean` $skipBaseNotAllowed Returns `array`
`public Mage_Directory_Model_Currency`	# `getCurrentCurrency( )` Retrieve store current currency Retrieve store current currency Returns `Mage_Directory_Model_Currency`
`public float`	# `getCurrentCurrencyRate( )` Retrieve current currency rate Retrieve current currency rate Returns `float`
`public float`	# `convertPrice( float $price, boolean $format = false, boolean $includeContainer = true )` Convert price from default currency to current currency Convert price from default currency to current currency Parameters `$price` `float` $price `$format` `boolean` $format Format price to currency format `$includeContainer` `boolean` $includeContainer Enclose into <span class="price"><span> Returns `float`
`public float`	# `roundPrice( mixed $price )` Round price Round price Parameters `$price` `mixed` $price Returns `float`
`public string`	# `formatPrice( float $price, boolean $includeContainer = true )` Format price with currency filter (taking rate into consideration) Format price with currency filter (taking rate into consideration) Parameters `$price` `float` $price `$includeContainer` `boolean` $includeContainer Returns `string`
`public Varien_Filter_Sprintf`	# `getPriceFilter( )` Get store price filter Get store price filter Returns `Varien_Filter_Sprintf`
`public integer`	# `getRootCategoryId( )` Retrieve root category identifier Retrieve root category identifier Returns `integer`
`public`	# `setGroup( Mage_Core_Model_Store_Group $group )` Set group model for store Set group model for store Parameters `$group` `Mage_Core_Model_Store_Group` $group
`public Mage_Core_Model_Store_Group`	# `getGroup( )` Retrieve group model Retrieve group model Returns `Mage_Core_Model_Store_Group`
`public string\|integer\|null`	# `getWebsiteId( )` Retrieve website identifier Retrieve website identifier Returns `string\|integer\|null`
`public string\|integer\|null`	# `getGroupId( )` Retrieve group identifier Retrieve group identifier Returns `string\|integer\|null`
`public string\|integer\|null`	# `getDefaultGroupId( )` Retrieve default group identifier Retrieve default group identifier Returns `string\|integer\|null`
`public boolean`	# `isCanDelete( )` Check if store can be deleted Check if store can be deleted Returns `boolean`
`public string`	# `getCurrentUrl( boolean\|string $fromStore = true )` Retrieve current url for store Retrieve current url for store Parameters `$fromStore` `boolean\|string` $fromStore Returns `string`
`public boolean\|null`	# `getIsActive( )` Check if store is active Check if store is active Returns `boolean\|null`
`public string\|null`	# `getName( )` Retrieve store name Retrieve store name Returns `string\|null`
`protected Mage_Core_Model_Store`	# `_beforeDelete( )` Protect delete from non admin area Protect delete from non admin area Register indexing event before delete store Returns `Mage_Core_Model_Store` Overrides `Mage_Core_Model_Abstract::_beforeDelete()`
`protected Mage_Core_Model_Store`	# `_afterDelete( )` rewrite in order to clear configuration cache rewrite in order to clear configuration cache Returns `Mage_Core_Model_Store` Overrides `Mage_Core_Model_Abstract::_afterDelete()`
`protected Mage_Core_Model_Store`	# `_afterDeleteCommit( )` Init indexing process after store delete commit Init indexing process after store delete commit Returns `Mage_Core_Model_Store` Overrides `Mage_Core_Model_Abstract::_afterDeleteCommit()`
`public Mage_Core_Model_Store`	# `resetConfig( )` Reinit and reset Config Data Reinit and reset Config Data Returns `Mage_Core_Model_Store`
`public boolean`	# `isReadOnly( boolean $value = null )` Get/Set isReadOnly flag Get/Set isReadOnly flag Parameters `$value` `boolean` $value Returns `boolean`
`public string`	# `getFrontendName( )` Retrieve storegroup name Retrieve storegroup name Returns `string`

Methods inherited from Mage_Core_Model_Abstract
`_afterLoad(), _afterSave(), _beforeLoad(), _beforeSave(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), save(), setId()`

Constants summary
`string`	`ENTITY`	`'core_store'`	# Entity name Entity name
`string`	`XML_PATH_STORE_STORE_NAME`	`'general/store_information/name'`	# Configuration pathes Configuration pathes
`string`	`XML_PATH_STORE_STORE_PHONE`	`'general/store_information/phone'`	#
`string`	`XML_PATH_STORE_IN_URL`	`'web/url/use_store'`	#
`string`	`XML_PATH_USE_REWRITES`	`'web/seo/use_rewrites'`	#
`string`	`XML_PATH_UNSECURE_BASE_URL`	`'web/unsecure/base_url'`	#
`string`	`XML_PATH_SECURE_BASE_URL`	`'web/secure/base_url'`	#
`string`	`XML_PATH_SECURE_IN_FRONTEND`	`'web/secure/use_in_frontend'`	#
`string`	`XML_PATH_SECURE_IN_ADMINHTML`	`'web/secure/use_in_adminhtml'`	#
`string`	`XML_PATH_SECURE_BASE_LINK_URL`	`'web/secure/base_link_url'`	#
`string`	`XML_PATH_UNSECURE_BASE_LINK_URL`	`'web/unsecure/base_link_url'`	#
`string`	`XML_PATH_OFFLOADER_HEADER`	`'web/secure/offloader_header'`	#
`string`	`XML_PATH_PRICE_SCOPE`	`'catalog/price/scope'`	#
`integer`	`PRICE_SCOPE_GLOBAL`	`0`	# Price scope constants Price scope constants
`integer`	`PRICE_SCOPE_WEBSITE`	`1`	#
`string`	`URL_TYPE_LINK`	`'link'`	# Possible URL types Possible URL types
`string`	`URL_TYPE_DIRECT_LINK`	`'direct_link'`	#
`string`	`URL_TYPE_WEB`	`'web'`	#
`string`	`URL_TYPE_SKIN`	`'skin'`	#
`string`	`URL_TYPE_JS`	`'js'`	#
`string`	`URL_TYPE_MEDIA`	`'media'`	#
`string`	`DEFAULT_CODE`	`'default'`	# Code constants Code constants
`string`	`ADMIN_CODE`	`'admin'`	#
`string`	`CACHE_TAG`	`'store'`	# Cache tag Cache tag
`string`	`COOKIE_NAME`	`'store'`	# Cookie name Cookie name
`string`	`COOKIE_CURRENCY`	`'currency'`	# Cookie currency key Cookie currency key
`string`	`MEDIA_REWRITE_SCRIPT`	`'get.php/'`	# Script name, which returns all the images Script name, which returns all the images

Properties summary
`protected boolean`	`$_cacheTag`	`true`	# Cache flag Cache flag
`protected string`	`$_eventPrefix`	`'store'`	# Event prefix for model events Event prefix for model events
`protected string`	`$_eventObject`	`'store'`	# Event object name Event object name
`protected Mage_Directory_Model_Currency_Filter`	`$_priceFilter`		# Price filter Price filter
`protected Mage_Core_Model_Website`	`$_website`		# Website model Website model
`protected Mage_Core_Model_Store_Group`	`$_group`		# Group model Group model
`protected array\|null`	`$_configCache`	`null`	# Store configuration cache Store configuration cache
`protected array`	`$_configCacheBaseNodes`	`array()`	# Base nodes of store configuration cache Base nodes of store configuration cache
`protected array`	`$_dirCache`	`array()`	# Directory cache Directory cache
`protected array`	`$_urlCache`	`array()`	# URL cache URL cache
`protected array`	`$_baseUrlCache`	`array()`	# Base URL cache Base URL cache
`protected Mage_Core_Model_Session_Abstract`	`$_session`		# Session entity Session entity
`protected boolean\|null`	`$_isAdminSecure`	`null`	# Flag that shows that backend URLs are secure Flag that shows that backend URLs are secure
`protected boolean\|null`	`$_isFrontSecure`	`null`	# Flag that shows that frontend URLs are secure Flag that shows that frontend URLs are secure
`protected string\|null`	`$_frontendName`	`null`	# Store frontend name Store frontend name
`private boolean`	`$_isReadOnly`	`false`	# Readonly flag Readonly flag

Properties inherited from Mage_Core_Model_Abstract
`$_dataSaveAllowed, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Exceptions

Functions

Class Mage_Core_Model_Store

Returns

Parameters

Returns

Overrides

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Overrides

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Overrides

Returns

Overrides

Returns

Overrides

Returns

Parameters

Returns

Returns