Class Mage_Core_Model_Design_Package

Magento

NOTICE OF LICENSE

This source file is subject to the Open Software License (OSL 3.0) that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://opensource.org/licenses/osl-3.0.php If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@magentocommerce.com so we can send you a copy immediately.

DISCLAIMER

Do not edit or add to this file if you wish to upgrade Magento to newer versions in the future. If you wish to customize Magento for your needs please refer to http://www.magentocommerce.com for more information.

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

Methods summary
`public Mage_Core_Model_Design_Package`	# `setStore( string\|integer\|Mage_Core_Model_Store $store )` Set store Set store Parameters `$store` `string\|integer\|Mage_Core_Model_Store` $store Returns `Mage_Core_Model_Design_Package`
`public string\|integer\|Mage_Core_Model_Store`	# `getStore( )` Retrieve store Retrieve store Returns `string\|integer\|Mage_Core_Model_Store`
`public Mage_Core_Model_Design_Package`	# `setArea( string $area )` Set package area Set package area Parameters `$area` `string` $area Returns `Mage_Core_Model_Design_Package`
`public unknown`	# `getArea( )` Retrieve package area Retrieve package area Returns `unknown`
`public Mage_Core_Model_Design_Package`	# `setPackageName( string $name = '' )` Set package name In case of any problem, the default will be set. Set package name In case of any problem, the default will be set. Parameters `$name` `string` $name Returns `Mage_Core_Model_Design_Package`
`public array`	# `setAllGetOld( array $storePackageArea )` Set store/package/area at once, and get respective values, that were before Set store/package/area at once, and get respective values, that were before $storePackageArea must be assoc array. The keys may be: 'store', 'package', 'area' Parameters `$storePackageArea` `array` $storePackageArea Returns `array`
`public string`	# `getPackageName( )` Retrieve package name Retrieve package name Returns `string`
`public`	# `designPackageExists( mixed $packageName, mixed $area = Mage_Core_Model_Design_Package::DEFAULT_AREA )`
`public Mage_Core_Model_Design_Package`	# `setTheme( )` Declare design package theme params Polymorph method: if 1 parameter specified, sets everything to this value if 2 parameters, treats 1st as key and 2nd as value Declare design package theme params Polymorph method: if 1 parameter specified, sets everything to this value if 2 parameters, treats 1st as key and 2nd as value Returns `Mage_Core_Model_Design_Package`
`public`	# `getTheme( mixed $type )`
`public`	# `getDefaultTheme( )`
`public`	# `updateParamDefaults( array & $params )`
`public`	# `getBaseDir( array $params )`
`public`	# `getSkinBaseDir( array $params = array() )`
`public`	# `getLocaleBaseDir( array $params = array() )`
`public`	# `getSkinBaseUrl( array $params = array() )`
`public string\|false`	# `validateFile( string $file, array $params )` Check whether requested file exists in specified theme params Check whether requested file exists in specified theme params Possible params: _type: layout\|template\|skin\|locale _package: design package, if not set = default _theme: if not set = default _file: path relative to theme root Parameters `$file` `string` $file `$params` `array` $params Returns `string\|false` See Mage_Core_Model_Config::getBaseDir
`protected string`	# `_renderFilename( array $file, array $params )` Get filename by specified theme parameters Get filename by specified theme parameters Parameters `$file` `array` $file `$params` `mixed` $params Returns `string`
`protected string`	# `_fallback( string $file, array & $params, array $fallbackScheme = array(array()) )` Check for files existence by specified scheme Check for files existence by specified scheme If fallback enabled, the first found file will be returned. Otherwise the base package / default theme file, regardless of found or not. If disabled, the lookup won't be performed to spare filesystem calls. Parameters `$file` `string` $file `$params` `array` &$params `$fallbackScheme` `array` $fallbackScheme Returns `string`
`public string`	# `getFilename( string $file, array $params )` Use this one to get existing file name with fallback to default Use this one to get existing file name with fallback to default $params['_type'] is required Parameters `$file` `string` $file `$params` `array` $params Returns `string`
`public string`	# `getFallbackTheme( )` Default theme getter Default theme getter Returns `string`
`public`	# `getLayoutFilename( mixed $file, array $params = array() )`
`public`	# `getTemplateFilename( mixed $file, array $params = array() )`
`public`	# `getLocaleFileName( mixed $file, array $params = array() )`
`public string`	# `getSkinUrl( string $file = null, array $params = array() )` Get skin file url Get skin file url Parameters `$file` `string` $file `$params` `array` $params Returns `string`
`public array`	# `getPackageList( )` Design packages list getter Design packages list getter Returns `array`
`public string`	# `getThemeList( string $package = null )` Design package (optional) themes list getter Design package (optional) themes list getter Parameters `$package` `string` $package Returns `string`
`private array`	# `_listDirectories( string $path, string\|boolean $fullPath = false )` Directories lister utility method Directories lister utility method Parameters `$path` `string` $path `$fullPath` `string\|boolean` $fullPath Returns `array`
`protected mixed`	# `_checkUserAgentAgainstRegexps( string $regexpsConfigPath )` Get regex rules from config and check user-agent against them Get regex rules from config and check user-agent against them Rules must be stored in config as a serialized array(['regexp']=>'...', ['value'] => '...') Will return false or found string. Parameters `$regexpsConfigPath` `string` $regexpsConfigPath Returns `mixed`
`public static boolean\|string`	# `getPackageByUserAgent( array $rules, string $regexpsConfigPath = 'path_mock' )` Return package name based on design exception rules Return package name based on design exception rules Parameters `$rules` `array` $rules - design exception rules `$regexpsConfigPath` `string` $regexpsConfigPath Returns `boolean\|string`
`public string`	# `getMergedJsUrl( mixed $files )` Merge specified javascript files and return URL to the merged file on success Merge specified javascript files and return URL to the merged file on success Parameters `$files` `mixed` $files Returns `string`
`public string`	# `getMergedCssUrl( mixed $files )` Merge specified css files and return URL to the merged file on success Merge specified css files and return URL to the merged file on success Parameters `$files` `mixed` $files Returns `string`
`protected boolean\|string`	# `_mergeFiles( array $srcFiles, string\|boolean $targetFile = false, boolean $mustMerge = false, callable $beforeMergeCallback = null, array\|string $extensionsFilter = array() )` Merges files into one and saves it into DB (if DB file storage is on) Merges files into one and saves it into DB (if DB file storage is on) Parameters `$srcFiles` `array` $srcFiles `$targetFile` `string\|boolean` $targetFile - file path to be written `$mustMerge` `boolean` $mustMerge `$beforeMergeCallback` `callable` $beforeMergeCallback `$extensionsFilter` `array\|string` $extensionsFilter Returns `boolean\|string` See `Mage_Core_Helper_Data::mergeFiles()`
`public boolean`	# `cleanMergedJsCss( )` Remove all merged js/css files Remove all merged js/css files Returns `boolean`
`protected boolean`	# `_initMergerDir( string $dirRelativeName, boolean $cleanup = false )` Make sure merger dir exists and writeable Also can clean it up Make sure merger dir exists and writeable Also can clean it up Parameters `$dirRelativeName` `string` $dirRelativeName `$cleanup` `boolean` $cleanup Returns `boolean`
`public string`	# `beforeMergeCss( string $file, string $contents )` Before merge css callback function Before merge css callback function Parameters `$file` `string` $file `$contents` `string` $contents Returns `string`
`protected`	# `_setCallbackFileDir( string $file )` Set file dir for css file Set file dir for css file Parameters `$file` `string` $file
`protected string`	# `_cssMergerImportCallback( array $match )` Callback function replaces relative links for @import matches in css file Callback function replaces relative links for @import matches in css file Parameters `$match` `array` $match Returns `string`
`protected string`	# `_cssMergerUrlCallback( array $match )` Callback function replaces relative links for url() matches in css file Callback function replaces relative links for url() matches in css file Parameters `$match` `array` $match Returns `string`
`protected string`	# `_prepareUrl( string $uri )` Prepare url for css replacement Prepare url for css replacement Parameters `$uri` `string` $uri Returns `string`

Constants summary
`string`	`DEFAULT_AREA`	`'frontend'`	#
`string`	`DEFAULT_PACKAGE`	`'default'`	#
`string`	`DEFAULT_THEME`	`'default'`	#
`string`	`BASE_PACKAGE`	`'base'`	#

Properties summary
`private static array`	`$_regexMatchCache`	`array()`	#
`private static array`	`$_customThemeTypeCache`	`array()`	#
`protected string\|integer\|Mage_Core_Model_Store`	`$_store`	`null`	# Current Store for generation ofr base_dir and base_url Current Store for generation ofr base_dir and base_url
`protected string`	`$_area`		# Package area Package area
`protected string`	`$_name`		# Package name Package name
`protected string`	`$_theme`		# Package theme Package theme
`protected string`	`$_rootDir`		# Package root directory Package root directory
`protected string`	`$_callbackFileDir`		# Directory of the css file Using only to transmit additional parametr in callback functions Directory of the css file Using only to transmit additional parametr in callback functions
`protected mixed`	`$_config`	`null`	#
`protected boolean`	`$_shouldFallback`	`true`	# Whether theme/skin hierarchy should be checked via fallback mechanism Whether theme/skin hierarchy should be checked via fallback mechanism TODO: implement setter for this value

Packages

Classes

Exceptions

Functions

Class Mage_Core_Model_Design_Package

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

See

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

TODO: