Class Mage

Main Mage hub class

Final
Package: Mage\Core
Copyright: Copyright (c) 2008 Irubin Consulting Inc. DBA Varien (http://www.varien.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at Mage.php

Methods summary
`public static string`	# `getVersion( )` Gets the current Magento version string Gets the current Magento version string Returns `string` Link http://www.magentocommerce.com/blog/new-community-edition-release-process/
`public static array`	# `getVersionInfo( )` Gets the detailed Magento version information Gets the detailed Magento version information Returns `array` Link http://www.magentocommerce.com/blog/new-community-edition-release-process/
`public static string`	# `getEdition( )` Get current Magento edition Get current Magento edition Returns `string`
`public static`	# `reset( )` Set all my static data to defaults Set all my static data to defaults
`public static`	# `register( string $key, mixed $value, boolean $graceful = false )` Register a new variable Register a new variable Parameters `$key` `string` $key `$value` `mixed` $value `$graceful` `boolean` $graceful Throws `Mage_Core_Exception`
`public static`	# `unregister( string $key )` Unregister a variable from register by key Unregister a variable from register by key Parameters `$key` `string` $key
`public static mixed`	# `registry( string $key )` Retrieve a value from registry by a key Retrieve a value from registry by a key Parameters `$key` `string` $key Returns `mixed`
`public static`	# `setRoot( string $appRoot = '' )` Set application root absolute path Set application root absolute path Parameters `$appRoot` `string` $appRoot Throws `Mage_Core_Exception`
`public static string`	# `getRoot( )` Retrieve application root absolute path Retrieve application root absolute path Returns `string`
`public static Varien_Event_Collection`	# `getEvents( )` Retrieve Events Collection Retrieve Events Collection Returns `Varien_Event_Collection` $collection
`public static Varien_Object_Cache`	# `objects( string $key = null )` Varien Objects Cache Varien Objects Cache Parameters `$key` `string` $key optional, if specified will load this key Returns `Varien_Object_Cache`
`public static string`	# `getBaseDir( string $type = 'base' )` Retrieve application root absolute path Retrieve application root absolute path Parameters `$type` `string` $type Returns `string`
`public static string`	# `getModuleDir( string $type, string $moduleName )` Retrieve module absolute path by directory type Retrieve module absolute path by directory type Parameters `$type` `string` $type `$moduleName` `string` $moduleName Returns `string`
`public static mixed`	# `getStoreConfig( string $path, mixed $store = null )` Retrieve config value for store by path Retrieve config value for store by path Parameters `$path` `string` $path `$store` `mixed` $store Returns `mixed`
`public static boolean`	# `getStoreConfigFlag( string $path, mixed $store = null )` Retrieve config flag for store by path Retrieve config flag for store by path Parameters `$path` `string` $path `$store` `mixed` $store Returns `boolean`
`public static string`	# `getBaseUrl( string $type = Mage_Core_Model_Store::URL_TYPE_LINK, null\|boolean $secure = null )` Get base URL path by type Get base URL path by type Parameters `$type` `string` $type `$secure` `null\|boolean` $secure Returns `string`
`public static string`	# `getUrl( string $route = '', array $params = array() )` Generate url by route and parameters Generate url by route and parameters Parameters `$route` `string` $route `$params` `array` $params Returns `string`
`public static Mage_Core_Model_Design_Package`	# `getDesign( )` Get design package singleton Get design package singleton Returns `Mage_Core_Model_Design_Package`
`public static Mage_Core_Model_Config`	# `getConfig( )` Retrieve a config instance Retrieve a config instance Returns `Mage_Core_Model_Config`
`public static`	# `addObserver( string $eventName, callable $callback, array $data = array(), string $observerName = '', mixed $observerClass = '' )` Add observer to even object Add observer to even object Parameters `$eventName` `string` $eventName `$callback` `callable` $callback `$data` `array` $arguments `$observerName` `string` $observerName `$observerClass`
`public static Mage_Core_Model_App`	# `dispatchEvent( string $name, array $data = array() )` Dispatch event Dispatch event Calls all observer callbacks registered for this event and multiple observers matching event name pattern Parameters `$name` `string` $name `$data` `array` $data Returns `Mage_Core_Model_App`
`public static Mage_Core_Model_Abstract\|false`	# `getModel( string $modelClass = '', array\|object $arguments = array() )` Retrieve model object Retrieve model object Parameters `$modelClass` `string` $modelClass `$arguments` `array\|object` $arguments Returns `Mage_Core_Model_Abstract\|false` Link Mage_Core_Model_Config::getModelInstance
`public static Mage_Core_Model_Abstract`	# `getSingleton( string $modelClass = '', array $arguments = array() )` Retrieve model object singleton Retrieve model object singleton Parameters `$modelClass` `string` $modelClass `$arguments` `array` $arguments Returns `Mage_Core_Model_Abstract`
`public static Object`	# `getResourceModel( string $modelClass, array $arguments = array() )` Retrieve object of resource model Retrieve object of resource model Parameters `$modelClass` `string` $modelClass `$arguments` `array` $arguments Returns `Object`
`public static Mage_Core_Controller_Front_Action`	# `getControllerInstance( string $class, Mage_Core_Controller_Request_Http $request, Mage_Core_Controller_Response_Http $response, array $invokeArgs = array() )` Retrieve Controller instance by ClassName Retrieve Controller instance by ClassName Parameters `$class` `string` $class `$request` `Mage_Core_Controller_Request_Http` $request `$response` `Mage_Core_Controller_Response_Http` $response `$invokeArgs` `array` $invokeArgs Returns `Mage_Core_Controller_Front_Action`
`public static object`	# `getResourceSingleton( string $modelClass = '', array $arguments = array() )` Retrieve resource vodel object singleton Retrieve resource vodel object singleton Parameters `$modelClass` `string` $modelClass `$arguments` `array` $arguments Returns `object`
`public static object`	# `getBlockSingleton( string $type )` Deprecated, use self::helper() Deprecated, use self::helper() Parameters `$type` `string` $type Returns `object`
`public static Mage_Core_Helper_Abstract`	# `helper( string $name )` Retrieve helper object Retrieve helper object Parameters `$name` `string` $name the helper name Returns `Mage_Core_Helper_Abstract`
`public static Mage_Core_Model_Resource_Helper_Abstract`	# `getResourceHelper( string $moduleName )` Retrieve resource helper object Retrieve resource helper object Parameters `$moduleName` `string` $moduleName Returns `Mage_Core_Model_Resource_Helper_Abstract`
`public static Mage_Core_Exception`	# `exception( string $module = 'Mage_Core', string $message = '', integer $code = 0 )` Return new exception by module to be thrown Return new exception by module to be thrown Parameters `$module` `string` $module `$message` `string` $message `$code` `integer` $code Returns `Mage_Core_Exception`
`public static`	# `throwException( string $message, string $messageStorage = null )` Throw Exception Throw Exception Parameters `$message` `string` $message `$messageStorage` `string` $messageStorage Throws `Mage_Core_Exception`
`public static Mage_Core_Model_App`	# `app( string $code = '', string $type = 'store', string\|array $options = array() )` Get initialized application object. Get initialized application object. Parameters `$code` `string` $code `$type` `string` $type `$options` `string\|array` $options Returns `Mage_Core_Model_App`
`public static`	# `init( string $code = '', string $type = 'store', array $options = array(), string\|array $modules = array() )` Parameters `$code` `string` $code `$type` `string` $type `$options` `array` $options `$modules` `string\|array` $modules
`public static`	# `run( string $code = '', string $type = 'store', string\|array $options = array() )` Front end main entry point Front end main entry point Parameters `$code` `string` $code `$type` `string` $type `$options` `string\|array` $options
`protected static`	# `_setIsInstalled( array $options = array() )` Set application isInstalled flag based on given options Set application isInstalled flag based on given options Parameters `$options` `array` $options
`protected static`	# `_setConfigModel( array $options = array() )` Set application Config model Set application Config model Parameters `$options` `array` $options
`public static boolean`	# `isInstalled( string\|array $options = array() )` Retrieve application installation flag Retrieve application installation flag Parameters `$options` `string\|array` $options Returns `boolean`
`public static`	# `log( string $message, integer $level = null, string $file = '', boolean $forceLog = false )` log facility (??) log facility (??) Parameters `$message` `string` $message `$level` `integer` $level `$file` `string` $file `$forceLog` `boolean` $forceLog
`public static`	# `logException( Exception $e )` Write exception to log Write exception to log Parameters `$e` `Exception` $e
`public static boolean`	# `setIsDeveloperMode( boolean $mode )` Set enabled developer mode Set enabled developer mode Parameters `$mode` `boolean` $mode Returns `boolean`
`public static boolean`	# `getIsDeveloperMode( )` Retrieve enabled developer mode Retrieve enabled developer mode Returns `boolean`
`public static`	# `printException( Exception $e, mixed $extra = '' )` Display exception Display exception Parameters `$e` `Exception` $e `$extra`
`public static string`	# `getScriptSystemUrl( string $folder, boolean $exitIfNot = false )` Define system folder directory url by virtue of running script directory name Try to find requested folder by shifting to domain root directory Define system folder directory url by virtue of running script directory name Try to find requested folder by shifting to domain root directory Parameters `$folder` `string` $folder `$exitIfNot` `boolean` $exitIfNot Returns `string`
`public static`	# `setIsDownloader( boolean $flag = true )` Set is downloader flag Set is downloader flag Parameters `$flag` `boolean` $flag

Constants summary
`string`	`EDITION_COMMUNITY`	`'Community'`	# Magento edition constants Magento edition constants
`string`	`EDITION_ENTERPRISE`	`'Enterprise'`	#
`string`	`EDITION_PROFESSIONAL`	`'Professional'`	#
`string`	`EDITION_GO`	`'Go'`	#

Properties summary
`private static array`	`$_registry`	`array()`	# Registry collection Registry collection
`private static string`	`$_appRoot`		# Application root absolute path Application root absolute path
`private static Mage_Core_Model_App`	`$_app`		# Application model Application model
`private static Mage_Core_Model_Config`	`$_config`		# Config Model Config Model
`private static Varien_Event_Collection`	`$_events`		# Event Collection Object Event Collection Object
`private static Varien_Object_Cache`	`$_objects`		# Object cache instance Object cache instance
`private static boolean`	`$_isDownloader`	`false`	# Is downloader flag Is downloader flag
`private static boolean`	`$_isDeveloperMode`	`false`	# Is developer mode flag Is developer mode flag
`public static boolean`	`$headersSentThrowsException`	`true`	# Is allow throw Exception about headers already sent Is allow throw Exception about headers already sent
`private static boolean`	`$_isInstalled`		# Is installed flag Is installed flag
`private static string`	`$_currentEdition`	`Mage::EDITION_COMMUNITY`	# Current Magento edition. Current Magento edition.

Packages

Classes

Exceptions

Functions

Class Mage

Returns

Link

Returns

Link

Returns

Parameters

Throws

Parameters

Parameters

Returns

Parameters

Throws

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Parameters

Returns

Parameters

Returns

Link

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Throws

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Returns

Parameters

Parameters

Returns

Parameters