Class Mage_Core_Model_App

Application model

Application should have: areas, store, locale, translator, design package

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/App.php

Methods summary
`public`	# `__construct( )` Constructor Constructor
`public Mage_Core_Model_App`	# `init( string\|array $code, string $type = null, string\|array $options = array() )` Initialize application without request processing Initialize application without request processing Parameters `$code` `string\|array` $code `$type` `string` $type `$options` `string\|array` $options Returns `Mage_Core_Model_App`
`public Mage_Core_Model_App`	# `baseInit( string\|array $options )` Common logic for all run types Common logic for all run types Parameters `$options` `string\|array` $options Returns `Mage_Core_Model_App`
`public Mage_Core_Model_App`	# `initSpecified( string\|array $scopeCode, string $scopeType = null, string\|array $options = array(), string\|array $modules = array() )` Run light version of application with specified modules support Run light version of application with specified modules support Parameters `$scopeCode` `string\|array` $scopeCode `$scopeType` `string` $scopeType `$options` `string\|array` $options `$modules` `string\|array` $modules Returns `Mage_Core_Model_App` See `Mage_Core_Model_App::run()`
`public Mage_Core_Model_App`	# `run( array $params )` Run application. Run process responsible for request processing and sending response. List of supported parameters: scope_code - code of default scope (website/store_group/store code) scope_type - type of default scope (website/group/store) options - configuration options Run application. Run process responsible for request processing and sending response. List of supported parameters: scope_code - code of default scope (website/store_group/store code) scope_type - type of default scope (website/group/store) options - configuration options Parameters `$params` `array` $params application run parameters Returns `Mage_Core_Model_App`
`protected Mage_Core_Model_App`	# `_initEnvironment( )` Initialize PHP environment Initialize PHP environment Returns `Mage_Core_Model_App`
`protected Mage_Core_Model_App`	# `_initBaseConfig( )` Initialize base system configuration (local.xml and config.xml files). Base configuration provide ability initialize DB connection and cache backend Initialize base system configuration (local.xml and config.xml files). Base configuration provide ability initialize DB connection and cache backend Returns `Mage_Core_Model_App`
`protected Mage_Core_Model_App`	# `_initCache( array $cacheInitOptions = array() )` Initialize application cache instance Initialize application cache instance Parameters `$cacheInitOptions` `array` $cacheInitOptions Returns `Mage_Core_Model_App`
`protected Mage_Core_Model_App`	# `_initModules( )` Initialize active modules configuration and data Initialize active modules configuration and data Returns `Mage_Core_Model_App`
`protected boolean`	# `_shouldSkipProcessModulesUpdates( )` Check whether modules updates processing should be skipped Check whether modules updates processing should be skipped Returns `boolean`
`protected Mage_Core_Model_App`	# `_initRequest( )` Init request object Init request object Returns `Mage_Core_Model_App`
`protected unknown_type`	# `_initCurrentStore( string $scopeCode, string $scopeType )` Initialize currently ran store Initialize currently ran store Parameters `$scopeCode` `string` $scopeCode code of default scope (website/store_group/store code) `$scopeType` `string` $scopeType type of default scope (website/group/store) Returns `unknown_type`
`public Mage_Core_Model_Cookie`	# `getCookie( )` Retrieve cookie object Retrieve cookie object Returns `Mage_Core_Model_Cookie`
`protected Mage_Core_Model_App`	# `_checkGetStore( mixed $type )` Check get store Check get store Returns `Mage_Core_Model_App`
`protected Mage_Core_Model_App`	# `_checkCookieStore( string $type )` Check cookie store Check cookie store Parameters `$type` `string` $type Returns `Mage_Core_Model_App`
`public`	# `reinitStores( )`
`protected`	# `_initStores( )` Init store, group and website collections Init store, group and website collections
`public boolean`	# `isSingleStoreMode( )` Is single Store mode (only one store without default) Is single Store mode (only one store without default) Returns `boolean`
`protected string\|null`	# `_getStoreByGroup( integer $group )` Retrieve store code or null by store group Retrieve store code or null by store group Parameters `$group` `integer` $group Returns `string\|null`
`protected string\|null`	# `_getStoreByWebsite( integer\|string $website )` Retrieve store code or null by website Retrieve store code or null by website Parameters `$website` `integer\|string` $website Returns `string\|null`
`public Mage_Core_Model_App`	# `setCurrentStore( string $store )` Set current default store Set current default store Parameters `$store` `string` $store Returns `Mage_Core_Model_App`
`protected Mage_Core_Model_App`	# `_initFrontController( )` Initialize application front controller Initialize application front controller Returns `Mage_Core_Model_App`
`public Mage_Core_Model_App`	# `setErrorHandler( string $handler )` Redeclare custom error handler Redeclare custom error handler Parameters `$handler` `string` $handler Returns `Mage_Core_Model_App`
`public Mage_Core_Model_App`	# `loadArea( string $code )` Loading application area Loading application area Parameters `$code` `string` $code Returns `Mage_Core_Model_App`
`public Mage_Core_Model_App`	# `loadAreaPart( string $area, string $part )` Loding part of area data Loding part of area data Parameters `$area` `string` $area `$part` `string` $part Returns `Mage_Core_Model_App`
`public Mage_Core_Model_App_Area`	# `getArea( string $code )` Retrieve application area Retrieve application area Parameters `$code` `string` $code Returns `Mage_Core_Model_App_Area`
`public Mage_Core_Model_Store`	# `getStore( null\|string\|boolean\|integer\|Mage_Core_Model_Store $id = null )` Retrieve application store object Retrieve application store object Parameters `$id` `null\|string\|boolean\|integer\|Mage_Core_Model_Store` $id Returns `Mage_Core_Model_Store` Throws `Mage_Core_Model_Store_Exception`
`public Mage_Core_Model_Store`	# `getSafeStore( string\|integer\|Mage_Core_Model_Store $id = null )` Retrieve application store object without Store_Exception Retrieve application store object without Store_Exception Parameters `$id` `string\|integer\|Mage_Core_Model_Store` $id Returns `Mage_Core_Model_Store`
`public array`	# `getStores( boolean $withDefault = false, boolean $codeKey = false )` Retrieve stores array Retrieve stores array Parameters `$withDefault` `boolean` $withDefault `$codeKey` `boolean` $codeKey Returns `array`
`protected`	# `_getDefaultStore( )`
`public Mage_Core_Model_Store`	# `getDefaultStoreView( )` Retrieve default store for default group and website Retrieve default store for default group and website Returns `Mage_Core_Model_Store`
`public`	# `getDistroLocaleCode( )`
`public Mage_Core_Model_Website`	# `getWebsite( mixed $id = null )` Retrieve application website object Retrieve application website object Returns `Mage_Core_Model_Website`
`public`	# `getWebsites( mixed $withDefault = false, mixed $codeKey = false )`
`public Mage_Core_Model_Store_Group`	# `getGroup( mixed $id = null )` Retrieve application store group object Retrieve application store group object Returns `Mage_Core_Model_Store_Group`
`public Mage_Core_Model_Locale`	# `getLocale( )` Retrieve application locale object Retrieve application locale object Returns `Mage_Core_Model_Locale`
`public Mage_Core_Model_Layout`	# `getLayout( )` Retrive layout object Retrive layout object Returns `Mage_Core_Model_Layout`
`public Mage_Core_Model_Translate`	# `getTranslator( )` Retrieve translate object Retrieve translate object Returns `Mage_Core_Model_Translate`
`public Mage_Core_Helper_Abstract`	# `getHelper( string $name )` Retrieve helper object Retrieve helper object Parameters `$name` `string` $name Returns `Mage_Core_Helper_Abstract`
`public string`	# `getBaseCurrencyCode( )` Retrieve application base currency code Retrieve application base currency code Returns `string`
`public Mage_Core_Model_Config`	# `getConfig( )` Retrieve configuration object Retrieve configuration object Returns `Mage_Core_Model_Config`
`public Mage_Core_Controller_Varien_Front`	# `getFrontController( )` Retrieve front controller object Retrieve front controller object Returns `Mage_Core_Controller_Varien_Front`
`public Mage_Core_Model_Cache`	# `getCacheInstance( )` Get core cache model Get core cache model Returns `Mage_Core_Model_Cache`
`public Zend_Cache_Core`	# `getCache( )` Retrieve cache object Retrieve cache object Returns `Zend_Cache_Core`
`public mixed`	# `loadCache( string $id )` Loading cache data Loading cache data Parameters `$id` `string` $id Returns `mixed`
`public Mage_Core_Model_App`	# `saveCache( mixed $data, string $id, array $tags = array(), mixed $lifeTime = false )` Saving cache data Saving cache data Parameters `$data` `mixed` $data `$id` `string` $id `$tags` `array` $tags `$lifeTime` Returns `Mage_Core_Model_App`
`public Mage_Core_Model_App`	# `removeCache( string $id )` Remove cache Remove cache Parameters `$id` `string` $id Returns `Mage_Core_Model_App`
`public Mage_Core_Model_App`	# `cleanCache( array $tags = array() )` Cleaning cache Cleaning cache Parameters `$tags` `array` $tags Returns `Mage_Core_Model_App`
`public boolean`	# `useCache( mixed $type = null )` Check whether to use cache for specific component Check whether to use cache for specific component Returns `boolean`
`public Mage_Core_Model_App`	# `saveUseCache( array $data )` Save cache usage settings Save cache usage settings Parameters `$data` `array` $data Returns `Mage_Core_Model_App`
`public`	# `cleanAllSessions( )` Deletes all session files Deletes all session files
`public Mage_Core_Controller_Request_Http`	# `getRequest( )` Retrieve request object Retrieve request object Returns `Mage_Core_Controller_Request_Http`
`public Mage_Core_Model_App`	# `setRequest( Mage_Core_Controller_Request_Http $request )` Request setter Request setter Parameters `$request` `Mage_Core_Controller_Request_Http` $request Returns `Mage_Core_Model_App`
`public Zend_Controller_Response_Http`	# `getResponse( )` Retrieve response object Retrieve response object Returns `Zend_Controller_Response_Http`
`public Mage_Core_Model_App`	# `setResponse( Mage_Core_Controller_Response_Http $response )` Response setter Response setter Parameters `$response` `Mage_Core_Controller_Response_Http` $response Returns `Mage_Core_Model_App`
`public`	# `addEventArea( mixed $area )`
`public`	# `dispatchEvent( mixed $eventName, mixed $args )`
`protected Mage_Core_Model_App`	# `_callObserverMethod( object $object, string $method, Varien_Event_Observer $observer )` Performs non-existent observer method calls protection Performs non-existent observer method calls protection Parameters `$object` `object` $object `$method` `string` $method `$observer` `Varien_Event_Observer` $observer Returns `Mage_Core_Model_App` Throws `Mage_Core_Exception`
`public`	# `setUpdateMode( mixed $value )`
`public`	# `getUpdateMode( )`
`public`	# `throwStoreException( )`
`public Mage_Core_Model_App`	# `setUseSessionVar( boolean $var )` Set use session var instead of SID for URL Set use session var instead of SID for URL Parameters `$var` `boolean` $var Returns `Mage_Core_Model_App`
`public boolean`	# `getUseSessionVar( )` Retrieve use flag session var instead of SID for URL Retrieve use flag session var instead of SID for URL Returns `boolean`
`public Mage_Core_Model_Store`	# `getAnyStoreView( )` Get either default or any store view Get either default or any store view Returns `Mage_Core_Model_Store`
`public Mage_Core_Model_App`	# `setUseSessionInUrl( boolean $flag = true )` Set Use session in URL flag Set Use session in URL flag Parameters `$flag` `boolean` $flag Returns `Mage_Core_Model_App`
`public boolean`	# `getUseSessionInUrl( )` Retrieve use session in URL flag Retrieve use session in URL flag Returns `boolean`
`public Mage_Core_Model_App`	# `setIsSingleStoreModeAllowed( boolean $value )` Allow or disallow single store mode Allow or disallow single store mode Parameters `$value` `boolean` $value Returns `Mage_Core_Model_App`
`public array`	# `getGroups( boolean $withDefault = false, boolean $codeKey = false )` Prepare array of store groups can be filtered to contain default store group or not by $withDefault flag depending on flag $codeKey array keys can be group id or group code Prepare array of store groups can be filtered to contain default store group or not by $withDefault flag depending on flag $codeKey array keys can be group id or group code Parameters `$withDefault` `boolean` $withDefault `$codeKey` `boolean` $codeKey Returns `array`
`public boolean`	# `getIsCacheLocked( )` Get is cache locked Get is cache locked Returns `boolean`
`public`	# `clearWebsiteCache( null\|boolean\|integer\|string\|Mage_Core_Model_Website $id = null )` Unset website by id from app cache Unset website by id from app cache Parameters `$id` `null\|boolean\|integer\|string\|Mage_Core_Model_Website` $id

Constants summary
`string`	`XML_PATH_INSTALL_DATE`	`'global/install/date'`	#
`string`	`XML_PATH_SKIP_PROCESS_MODULES_UPDATES`	`'global/skip_process_modules_updates'`	#
`string`	`XML_PATH_IGNORE_DEV_MODE`	`'global/skip_process_modules_updates_ignore_dev_mode'`	# if this node set to true, we will ignore Developer Mode for applying updates if this node set to true, we will ignore Developer Mode for applying updates
`string`	`DEFAULT_ERROR_HANDLER`	`'mageCoreErrorHandler'`	#
`string`	`DISTRO_LOCALE_CODE`	`'en_US'`	#
`string`	`CACHE_TAG`	`'MAGE'`	# Cache tag for all cache data exclude config cache Cache tag for all cache data exclude config cache
`integer`	`DISTRO_STORE_ID`	`1`	# Default store Id (for install) Default store Id (for install)
`string`	`DISTRO_STORE_CODE`	`'default'`	# Default store code (for install) Default store code (for install)
`integer`	`ADMIN_STORE_ID`	`0`	# Admin store Id Admin store Id

Properties summary
`protected array`	`$_areas`	`array()`	# Application loaded areas array Application loaded areas array
`protected Mage_Core_Model_Store`	`$_store`		# Application store object Application store object
`protected Mage_Core_Model_Website`	`$_website`		# Application website object Application website object
`protected Mage_Core_Model_Locale`	`$_locale`		# Application location object Application location object
`protected Mage_Core_Model_Translate`	`$_translator`		# Application translate object Application translate object
`protected Mage_Core_Model_Design_Package`	`$_design`		# Application design package object Application design package object
`protected Mage_Core_Model_Layout`	`$_layout`		# Application layout object Application layout object
`protected Mage_Core_Model_Config`	`$_config`		# Application configuration object Application configuration object
`protected Mage_Core_Controller_Varien_Front`	`$_frontController`		# Application front controller Application front controller
`protected Zend_Cache_Core`	`$_cache`		# Cache object Cache object
`protected array`	`$_useCache`		# Use Cache Use Cache
`protected array`	`$_websites`	`array()`	# Websites cache Websites cache
`protected array`	`$_groups`	`array()`	# Groups cache Groups cache
`protected array`	`$_stores`	`array()`	# Stores cache Stores cache
`protected boolean`	`$_isSingleStore`		# is a single store mode is a single store mode
`protected boolean`	`$_isSingleStoreAllowed`	`true`	#
`protected string`	`$_currentStore`		# Default store code Default store code
`protected Zend_Controller_Request_Http`	`$_request`		# Request object Request object
`protected Zend_Controller_Response_Http`	`$_response`		# Response object Response object
`protected array`	`$_events`	`array()`	# Events cache Events cache
`protected boolean`	`$_updateMode`	`false`	# Update process run flag Update process run flag
`protected boolean`	`$_useSessionInUrl`	`true`	# Use session in URL flag Use session in URL flag See `Mage_Core_Model_Url`
`protected boolean`	`$_useSessionVar`	`false`	# Use session var instead of SID for session in URL Use session var instead of SID for session in URL
`protected null\|boolean`	`$_isCacheLocked`	`null`	# Cache locked flag Cache locked flag

Packages

Classes

Exceptions

Functions

Class Mage_Core_Model_App

Parameters

Returns

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns