Overview

Packages

  • currencysymbol
  • MAbout
  • Mage
    • Admin
    • Adminhtml
    • AdminNotification
    • Api
    • Api2
    • Authorizenet
    • Backup
    • Bundle
    • Captcha
    • Catalog
    • CatalogIndex
    • CatalogInventory
    • CatalogRule
    • CatalogSearch
    • Centinel
    • Checkout
    • Cms
    • Compiler
    • Connect
    • Contacts
    • Core
    • Cron
    • CurrencySymbol
    • Customer
    • Dataflow
    • Directory
    • DirtectPost
    • Downloadable
    • Eav
    • GiftMessage
    • GoogleAnalytics
    • GoogleBase
    • GoogleCheckout
    • ImportExport
    • Index
    • Install
    • Log
    • Media
    • Newsletter
    • Oauth
    • Page
    • PageCache
    • Paygate
    • Payment
    • Paypal
    • PaypalUk
    • Persistent
    • Poll
    • ProductAlert
    • Rating
    • Reports
    • Review
    • Rss
    • Rule
    • Sales
    • SalesRule
    • Sedfriend
    • Sendfriend
    • Shipping
    • Sitemap
    • Tag
    • Tax
    • Usa
    • Weee
    • Widget
    • Wishlist
    • XmlConnect
  • None
  • Phoenix
    • Moneybookers
  • PHP
  • Zend
    • Date
    • Mime
    • XmlRpc

Classes

  • Mage
  • Mage_Adminhtml_Block_Html_Date
  • Mage_Adminhtml_Block_Html_Select
  • Mage_Api_Model_Wsdl_Config_Element
  • Mage_Captcha_Adminhtml_RefreshController
  • Mage_Captcha_RefreshController
  • Mage_Core_AjaxController
  • Mage_Core_Block_Abstract
  • Mage_Core_Block_Flush
  • Mage_Core_Block_Html_Calendar
  • Mage_Core_Block_Html_Date
  • Mage_Core_Block_Html_Link
  • Mage_Core_Block_Html_Select
  • Mage_Core_Block_Messages
  • Mage_Core_Block_Profiler
  • Mage_Core_Block_Store_Switcher
  • Mage_Core_Block_Template
  • Mage_Core_Block_Template_Facade
  • Mage_Core_Block_Template_Smarty
  • Mage_Core_Block_Template_Zend
  • Mage_Core_Block_Text
  • Mage_Core_Block_Text_List
  • Mage_Core_Block_Text_List_Item
  • Mage_Core_Block_Text_List_Link
  • Mage_Core_Block_Text_Tag
  • Mage_Core_Block_Text_Tag_Css
  • Mage_Core_Block_Text_Tag_Css_Admin
  • Mage_Core_Block_Text_Tag_Debug
  • Mage_Core_Block_Text_Tag_Js
  • Mage_Core_Block_Text_Tag_Meta
  • Mage_Core_Controller_Front_Action
  • Mage_Core_Controller_Front_Router
  • Mage_Core_Controller_Request_Http
  • Mage_Core_Controller_Response_Http
  • Mage_Core_Controller_Varien_Action
  • Mage_Core_Controller_Varien_Front
  • Mage_Core_Controller_Varien_Router_Abstract
  • Mage_Core_Controller_Varien_Router_Admin
  • Mage_Core_Controller_Varien_Router_Default
  • Mage_Core_Controller_Varien_Router_Standard
  • Mage_Core_Helper_Abstract
  • Mage_Core_Helper_Cookie
  • Mage_Core_Helper_Data
  • Mage_Core_Helper_File_Storage
  • Mage_Core_Helper_File_Storage_Database
  • Mage_Core_Helper_Hint
  • Mage_Core_Helper_Http
  • Mage_Core_Helper_Js
  • Mage_Core_Helper_String
  • Mage_Core_Helper_Translate
  • Mage_Core_Helper_Url
  • Mage_Core_Helper_Url_Rewrite
  • Mage_Core_IndexController
  • Mage_Core_Model_Abstract
  • Mage_Core_Model_App
  • Mage_Core_Model_App_Area
  • Mage_Core_Model_App_Emulation
  • Mage_Core_Model_Cache
  • Mage_Core_Model_Calculator
  • Mage_Core_Model_Config
  • Mage_Core_Model_Config_Base
  • Mage_Core_Model_Config_Data
  • Mage_Core_Model_Config_Element
  • Mage_Core_Model_Config_Options
  • Mage_Core_Model_Config_System
  • Mage_Core_Model_Cookie
  • Mage_Core_Model_Date
  • Mage_Core_Model_Design
  • Mage_Core_Model_Design_Package
  • Mage_Core_Model_Design_Source_Design
  • Mage_Core_Model_Email
  • Mage_Core_Model_Email_Info
  • Mage_Core_Model_Email_Template
  • Mage_Core_Model_Email_Template_Filter
  • Mage_Core_Model_Email_Template_Mailer
  • Mage_Core_Model_Email_Transport
  • Mage_Core_Model_Encryption
  • Mage_Core_Model_File_Storage
  • Mage_Core_Model_File_Storage_Abstract
  • Mage_Core_Model_File_Storage_Database
  • Mage_Core_Model_File_Storage_Database_Abstract
  • Mage_Core_Model_File_Storage_Directory_Database
  • Mage_Core_Model_File_Storage_File
  • Mage_Core_Model_File_Storage_Flag
  • Mage_Core_Model_File_Uploader
  • Mage_Core_Model_File_Validator_AvailablePath
  • Mage_Core_Model_File_Validator_NotProtectedExtension
  • Mage_Core_Model_Flag
  • Mage_Core_Model_Input_Filter
  • Mage_Core_Model_Input_Filter_MaliciousCode
  • Mage_Core_Model_Language
  • Mage_Core_Model_Layout
  • Mage_Core_Model_Layout_Data
  • Mage_Core_Model_Layout_Element
  • Mage_Core_Model_Layout_Update
  • Mage_Core_Model_Locale
  • Mage_Core_Model_Locale_Config
  • Mage_Core_Model_Log_Adapter
  • Mage_Core_Model_Magento_Api
  • Mage_Core_Model_Magento_Api_V2
  • Mage_Core_Model_Message
  • Mage_Core_Model_Message_Abstract
  • Mage_Core_Model_Message_Collection
  • Mage_Core_Model_Message_Error
  • Mage_Core_Model_Message_Notice
  • Mage_Core_Model_Message_Success
  • Mage_Core_Model_Message_Warning
  • Mage_Core_Model_Mysql4_Abstract
  • Mage_Core_Model_Mysql4_Cache
  • Mage_Core_Model_Mysql4_Collection_Abstract
  • Mage_Core_Model_Mysql4_Config
  • Mage_Core_Model_Mysql4_Config_Data
  • Mage_Core_Model_Mysql4_Config_Data_Collection
  • Mage_Core_Model_Mysql4_Design
  • Mage_Core_Model_Mysql4_Design_Collection
  • Mage_Core_Model_Mysql4_Design_Package_Collection
  • Mage_Core_Model_Mysql4_Design_Theme
  • Mage_Core_Model_Mysql4_Email_Template
  • Mage_Core_Model_Mysql4_Email_Template_Collection
  • Mage_Core_Model_Mysql4_File_Storage_Abstract
  • Mage_Core_Model_Mysql4_File_Storage_Database
  • Mage_Core_Model_Mysql4_File_Storage_Directory_Database
  • Mage_Core_Model_Mysql4_File_Storage_File
  • Mage_Core_Model_Mysql4_Flag
  • Mage_Core_Model_Mysql4_Language
  • Mage_Core_Model_Mysql4_Language_Collection
  • Mage_Core_Model_Mysql4_Layout
  • Mage_Core_Model_Mysql4_Resource
  • Mage_Core_Model_Mysql4_Session
  • Mage_Core_Model_Mysql4_Store
  • Mage_Core_Model_Mysql4_Store_Collection
  • Mage_Core_Model_Mysql4_Store_Group
  • Mage_Core_Model_Mysql4_Store_Group_Collection
  • Mage_Core_Model_Mysql4_Translate
  • Mage_Core_Model_Mysql4_Translate_String
  • Mage_Core_Model_Mysql4_Url_Rewrite
  • Mage_Core_Model_Mysql4_Url_Rewrite_Collection
  • Mage_Core_Model_Mysql4_Variable
  • Mage_Core_Model_Mysql4_Variable_Collection
  • Mage_Core_Model_Mysql4_Website
  • Mage_Core_Model_Mysql4_Website_Collection
  • Mage_Core_Model_Observer
  • Mage_Core_Model_Resource
  • Mage_Core_Model_Resource_Abstract
  • Mage_Core_Model_Resource_Cache
  • Mage_Core_Model_Resource_Config
  • Mage_Core_Model_Resource_Config_Data
  • Mage_Core_Model_Resource_Config_Data_Collection
  • Mage_Core_Model_Resource_Db_Abstract
  • Mage_Core_Model_Resource_Db_Collection_Abstract
  • Mage_Core_Model_Resource_Design
  • Mage_Core_Model_Resource_Design_Collection
  • Mage_Core_Model_Resource_Design_Package_Collection
  • Mage_Core_Model_Resource_Email_Template
  • Mage_Core_Model_Resource_Email_Template_Collection
  • Mage_Core_Model_Resource_Entity_Abstract
  • Mage_Core_Model_Resource_Entity_Table
  • Mage_Core_Model_Resource_File_Storage_Abstract
  • Mage_Core_Model_Resource_File_Storage_Database
  • Mage_Core_Model_Resource_File_Storage_Directory_Database
  • Mage_Core_Model_Resource_File_Storage_File
  • Mage_Core_Model_Resource_Flag
  • Mage_Core_Model_Resource_Helper_Abstract
  • Mage_Core_Model_Resource_Helper_Mysql4
  • Mage_Core_Model_Resource_Iterator
  • Mage_Core_Model_Resource_Language
  • Mage_Core_Model_Resource_Language_Collection
  • Mage_Core_Model_Resource_Layout
  • Mage_Core_Model_Resource_Resource
  • Mage_Core_Model_Resource_Session
  • Mage_Core_Model_Resource_Setup
  • Mage_Core_Model_Resource_Setup_Query_Modifier
  • Mage_Core_Model_Resource_Store
  • Mage_Core_Model_Resource_Store_Collection
  • Mage_Core_Model_Resource_Store_Group
  • Mage_Core_Model_Resource_Store_Group_Collection
  • Mage_Core_Model_Resource_Transaction
  • Mage_Core_Model_Resource_Translate
  • Mage_Core_Model_Resource_Translate_String
  • Mage_Core_Model_Resource_Type_Abstract
  • Mage_Core_Model_Resource_Type_Db
  • Mage_Core_Model_Resource_Type_Db_Mysqli
  • Mage_Core_Model_Resource_Type_Db_Mysqli_Setup
  • Mage_Core_Model_Resource_Type_Db_Pdo_Mysql
  • Mage_Core_Model_Resource_Url_Rewrite
  • Mage_Core_Model_Resource_Url_Rewrite_Collection
  • Mage_Core_Model_Resource_Variable
  • Mage_Core_Model_Resource_Variable_Collection
  • Mage_Core_Model_Resource_Website
  • Mage_Core_Model_Resource_Website_Collection
  • Mage_Core_Model_Session
  • Mage_Core_Model_Session_Abstract
  • Mage_Core_Model_Session_Abstract_Varien
  • Mage_Core_Model_Session_Abstract_Zend
  • Mage_Core_Model_Source_Email_Variables
  • Mage_Core_Model_Store
  • Mage_Core_Model_Store_Api
  • Mage_Core_Model_Store_Api_V2
  • Mage_Core_Model_Store_Group
  • Mage_Core_Model_Template
  • Mage_Core_Model_Translate
  • Mage_Core_Model_Translate_Expr
  • Mage_Core_Model_Translate_Inline
  • Mage_Core_Model_Translate_String
  • Mage_Core_Model_Url
  • Mage_Core_Model_Url_Rewrite
  • Mage_Core_Model_Url_Validator
  • Mage_Core_Model_Variable
  • Mage_Core_Model_Variable_Config
  • Mage_Core_Model_Variable_Observer
  • Mage_Core_Model_Website
  • Mage_Page_Block_Switch
  • Mage_Page_Block_Template_Container
  • Mage_Page_Block_Template_Links
  • Mage_Page_Block_Template_Links_Block
  • Mage_Sales_Model_Quote_Address_Total_Collector

Exceptions

  • Mage_Core_Controller_Varien_Exception
  • Mage_Core_Exception
  • Mage_Core_Model_Session_Exception
  • Mage_Core_Model_Store_Exception

Functions

  • destruct
  • is_dir_writeable
  • is_empty_date
  • mageCoreErrorHandler
  • mageDebugBacktrace
  • mageDelTree
  • mageFindClassFile
  • mageParseCsv
  • mageSendErrorFooter
  • mageSendErrorHeader
  • mageUndoMagicQuotes
  • now
  • sys_get_temp_dir
  • uc_words
  • Overview
  • Package
  • Class
  • Tree

Class Mage_Core_Model_Cache

System cache model support id and tags preffix support,

Package: Mage\Core
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Located at code/core/Mage/Core/Model/Cache.php
Methods summary
public
# __construct( array $options = array() )

Class constructor. Initialize cache instance based on options

Class constructor. Initialize cache instance based on options

Parameters

$options
array
$options
protected array
# _getBackendOptions( array $cacheOptions )

Get cache backend options. Result array contain backend type ('type' key) and backend options ('options')

Get cache backend options. Result array contain backend type ('type' key) and backend options ('options')

Parameters

$cacheOptions
array
$cacheOptions

Returns

array
protected array
# getDbAdapterOptions( )

Get options for database backend type

Get options for database backend type

Returns

array
protected array
# _getTwoLevelsBackendOptions( array $fastOptions, array $cacheOptions )

Initialize two levels backend model options

Initialize two levels backend model options

Parameters

$fastOptions
array
$fastOptions fast level backend type and options
$cacheOptions
array
$cacheOptions all cache options

Returns

array
protected array
# _getFrontendOptions( array $cacheOptions )

Get options of cache frontend (options of Zend_Cache_Core)

Get options of cache frontend (options of Zend_Cache_Core)

Parameters

$cacheOptions
array
$cacheOptions

Returns

array
protected string
# _id( string $id )

Prepare unified valid identifier with preffix

Prepare unified valid identifier with preffix

Parameters

$id
string
$id

Returns

string
protected array
# _tags( array $tags = array() )

Prepare cache tags.

Prepare cache tags.

Parameters

$tags
array
$tags

Returns

array
public Zend_Cache_Core
# getFrontend( )

Get cache frontend API object

Get cache frontend API object

Returns

Zend_Cache_Core
public string
# load( string $id )

Load data from cache by id

Load data from cache by id

Parameters

$id
string
$id

Returns

string
public boolean
# save( string $data, string $id, array $tags = array(), integer $lifeTime = null )

Save data

Save data

Parameters

$data
string
$data
$id
string
$id
$tags
array
$tags
$lifeTime
integer
$lifeTime

Returns

boolean
public boolean
# remove( string $id )

Remove cached data by identifier

Remove cached data by identifier

Parameters

$id
string
$id

Returns

boolean
public boolean
# clean( array $tags = array() )

Clean cached data by specific tag

Clean cached data by specific tag

Parameters

$tags
array
$tags

Returns

boolean
public boolean
# flush( )

Clean cached data by specific tag

Clean cached data by specific tag

Returns

boolean
public Zend_Db_Adapter_Abstract
# getDbAdapter( )

Get adapter for database cache backend model

Get adapter for database cache backend model

Returns

Zend_Db_Adapter_Abstract
protected Mage_Core_Model_Mysql4_Cache
# _getResource( )

Get cache resource model

Get cache resource model

Returns

Mage_Core_Model_Mysql4_Cache
protected Mage_Core_Model_Cache
# _initOptions( )

Initialize cache types options

Initialize cache types options

Returns

Mage_Core_Model_Cache
public Mage_Core_Model_Cache
# saveOptions( array $options )

Save cache usage options

Save cache usage options

Parameters

$options
array
$options

Returns

Mage_Core_Model_Cache
public boolean
# canUse( string $typeCode )

Check if cache can be used for specific data type

Check if cache can be used for specific data type

Parameters

$typeCode
string
$typeCode

Returns

boolean
public Mage_Core_Model_Cache
# banUse( string $typeCode )

Disable cache usage for specific data type

Disable cache usage for specific data type

Parameters

$typeCode
string
$typeCode

Returns

Mage_Core_Model_Cache
public array
# getTagsByType( string $type )

Get cache tags by cache type from configuration

Get cache tags by cache type from configuration

Parameters

$type
string
$type

Returns

array
public array
# getTypes( )

Get information about all declared cache types

Get information about all declared cache types

Returns

array
protected array
# _getInvalidatedTypes( )

Get invalidate types codes

Get invalidate types codes

Returns

array
protected Mage_Core_Model_Cache
# _saveInvalidatedTypes( array $types )

Save invalidated cache types

Save invalidated cache types

Parameters

$types
array
$types

Returns

Mage_Core_Model_Cache
public array
# getInvalidatedTypes( )

Get array of all invalidated cache types

Get array of all invalidated cache types

Returns

array
public Mage_Core_Model_Cache
# invalidateType( string|array $typeCode )

Mark specific cache type(s) as invalidated

Mark specific cache type(s) as invalidated

Parameters

$typeCode
string|array
$typeCode

Returns

Mage_Core_Model_Cache
public Mage_Core_Model_Cache
# cleanType( string $typeCode )

Clean cached data for specific cache type

Clean cached data for specific cache type

Parameters

$typeCode
string
$typeCode

Returns

Mage_Core_Model_Cache
public boolean
# processRequest( )

Try to get response body from cache storage with predefined processors

Try to get response body from cache storage with predefined processors

Returns

boolean
protected
# _getProcessor( mixed $processor )

Get request processor object

Get request processor object

Constants summary
integer DEFAULT_LIFETIME 7200
#
string OPTIONS_CACHE_ID 'core_cache_options'
#
string INVALIDATED_TYPES 'core_cache_invalidate'
#
string XML_PATH_TYPES 'global/cache/types'
#
Properties summary
protected string $_idPrefix ''
#
protected Zend_Cache_Core $_frontend null
#

Cache frontend API

Cache frontend API

protected array $_shmBackends array( 'apc', 'memcached', 'xcache', 'zendserver_shmem', 'zendserver_disk', 'varien_eaccelerator', )
#

Shared memory backend models list (required TwoLevels backend model)

Shared memory backend models list (required TwoLevels backend model)

protected string $_defaultBackend 'File'
#

Fefault cache backend type

Fefault cache backend type

protected array $_defaultBackendOptions array( 'hashed_directory_level' => 1, 'hashed_directory_umask' => 0777, 'file_name_prefix' => 'mage', )
#

Default iotions for default backend

Default iotions for default backend

protected array $_requestProcessors array()
#

List of available request processors

List of available request processors

protected boolean $_disallowSave false
#

Disallow cache saving

Disallow cache saving

protected array $_allowedCacheOptions null
#

List of allowed cache options

List of allowed cache options

Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0