Zend_Cache Class Reference

Static Public Member Functions
static	factory ($frontend, $backend, $frontendOptions=array(), $backendOptions=array(), $customFrontendNaming=false, $customBackendNaming=false, $autoload=false)
static	_makeBackend ($backend, $backendOptions, $customBackendNaming=false, $autoload=false)
static	_makeFrontend ($frontend, $frontendOptions=array(), $customFrontendNaming=false, $autoload=false)
static	throwException ($msg, Exception $e=null)

Data Fields
const	CLEANING_MODE_ALL = 'all'
const	CLEANING_MODE_OLD = 'old'
const	CLEANING_MODE_MATCHING_TAG = 'matchingTag'
const	CLEANING_MODE_NOT_MATCHING_TAG = 'notMatchingTag'
const	CLEANING_MODE_MATCHING_ANY_TAG = 'matchingAnyTag'

Static Public Attributes
static	$standardFrontends = array('Core', 'Output', 'Class', 'File', 'Function', 'Page')
static	$standardBackends
static	$standardExtendedBackends = array('File', 'Apc', 'TwoLevels', 'Memcached', 'Libmemcached', 'Sqlite', 'WinCache')
static	$availableFrontends = array('Core', 'Output', 'Class', 'File', 'Function', 'Page')
static	$availableBackends = array('File', 'Sqlite', 'Memcached', 'Libmemcached', 'Apc', 'ZendPlatform', 'Xcache', 'WinCache', 'TwoLevels')

Static Protected Member Functions
static	_normalizeName ($name)

Detailed Description

Definition at line 28 of file Cache.php.

Member Function Documentation

_makeBackend()

static _makeBackend (   $backend,   $backendOptions,   $customBackendNaming = false,   $autoload = false  )

static

Backend Constructor

Parameters

string	$backend
array	$backendOptions
boolean	$customBackendNaming
boolean	$autoload

Returns

Zend_Cache_Backend

Definition at line 124 of file Cache.php.

    {
        if (!$customBackendNaming) {
            $backend  = self::_normalizeName($backend);
        }
        if (in_array($backend, Zend_Cache::$standardBackends)) {
            // we use a standard backend
            $backendClass = 'Zend_Cache_Backend_' . $backend;
            // security controls are explicit
            #require_once str_replace('_', DIRECTORY_SEPARATOR, $backendClass) . '.php';
        } else {
            // we use a custom backend
            if (!preg_match('~^[\w\\\\]+$~D', $backend)) {
                Zend_Cache::throwException("Invalid backend name [$backend]");
            }
            if (!$customBackendNaming) {
                // we use this boolean to avoid an API break
                $backendClass = 'Zend_Cache_Backend_' . $backend;
            } else {
                $backendClass = $backend;
            }
            if (!$autoload) {
                $file = str_replace('_', DIRECTORY_SEPARATOR, $backendClass) . '.php';
                if (!(self::_isReadable($file))) {
                    self::throwException("file $file not found in include_path");
                }
                #require_once $file;
            }
        }
        return new $backendClass($backendOptions);
    }

_makeFrontend()

static _makeFrontend (   $frontend,   $frontendOptions = array(),   $customFrontendNaming = false,   $autoload = false  )

static

Frontend Constructor

Parameters

string	$frontend
array	$frontendOptions
boolean	$customFrontendNaming
boolean	$autoload

Returns

Zend_Cache_Core|Zend_Cache_Frontend

Definition at line 165 of file Cache.php.

    {
        if (!$customFrontendNaming) {
            $frontend = self::_normalizeName($frontend);
        }
        if (in_array($frontend, self::$standardFrontends)) {
            // we use a standard frontend
            // For perfs reasons, with frontend == 'Core', we can interact with the Core itself
            $frontendClass = 'Zend_Cache_' . ($frontend != 'Core' ? 'Frontend_' : '') . $frontend;
            // security controls are explicit
            #require_once str_replace('_', DIRECTORY_SEPARATOR, $frontendClass) . '.php';
        } else {
            // we use a custom frontend
            if (!preg_match('~^[\w\\\\]+$~D', $frontend)) {
                Zend_Cache::throwException("Invalid frontend name [$frontend]");
            }
            if (!$customFrontendNaming) {
                // we use this boolean to avoid an API break
                $frontendClass = 'Zend_Cache_Frontend_' . $frontend;
            } else {
                $frontendClass = $frontend;
            }
            if (!$autoload) {
                $file = str_replace('_', DIRECTORY_SEPARATOR, $frontendClass) . '.php';
                if (!(self::_isReadable($file))) {
                    self::throwException("file $file not found in include_path");
                }
                #require_once $file;
            }
        }
        return new $frontendClass($frontendOptions);
    }

_normalizeName()

static _normalizeName (   $name )

staticprotected

Normalize frontend and backend names to allow multiple words TitleCased

Parameters

string

$name

Name to normalize

Returns

string

Definition at line 218 of file Cache.php.

    {
        $name = ucfirst(strtolower($name));
        $name = str_replace(array('-', '_', '.'), ' ', $name);
        $name = ucwords($name);
        $name = str_replace(' ', '', $name);
        if (stripos($name, 'ZendServer') === 0) {
            $name = 'ZendServer_' . substr($name, strlen('ZendServer'));
        }

        return $name;
    }

factory()

static factory (   $frontend,   $backend,   $frontendOptions = array(),   $backendOptions = array(),   $customFrontendNaming = false,   $customBackendNaming = false,   $autoload = false  )

static

Factory

Parameters

mixed	$frontend	frontend name (string) or Zend_Cache_Frontend_ object
mixed	$backend	backend name (string) or Zend_Cache_Backend_ object
array	$frontendOptions	associative array of options for the corresponding frontend constructor
array	$backendOptions	associative array of options for the corresponding backend constructor
boolean	$customFrontendNaming	if true, the frontend argument is used as a complete class name ; if false, the frontend argument is used as the end of "Zend_Cache_Frontend_[...]" class name
boolean	$customBackendNaming	if true, the backend argument is used as a complete class name ; if false, the backend argument is used as the end of "Zend_Cache_Backend_[...]" class name
boolean	$autoload	if true, there will no require_once for backend and frontend (useful only for custom backends/frontends)

Exceptions

Zend_Cache_Exception

Returns

Zend_Cache_Core|Zend_Cache_Frontend

Definition at line 91 of file Cache.php.

    {
        if (is_string($backend)) {
            $backendObject = self::_makeBackend($backend, $backendOptions, $customBackendNaming, $autoload);
        } else {
            if ((is_object($backend)) && (in_array('Zend_Cache_Backend_Interface', class_implements($backend)))) {
                $backendObject = $backend;
            } else {
                self::throwException('backend must be a backend name (string) or an object which implements Zend_Cache_Backend_Interface');
            }
        }
        if (is_string($frontend)) {
            $frontendObject = self::_makeFrontend($frontend, $frontendOptions, $customFrontendNaming, $autoload);
        } else {
            if (is_object($frontend)) {
                $frontendObject = $frontend;
            } else {
                self::throwException('frontend must be a frontend name (string) or an object');
            }
        }
        $frontendObject->setBackend($backendObject);
        return $frontendObject;
    }

throwException()

static throwException (   $msg, Exception  $e = null  )

static

Throw an exception

Note : for perf reasons, the "load" of Zend/Cache/Exception is dynamic

Parameters

string

$msg

Message for the exception

Exceptions

Zend_Cache_Exception

Definition at line 205 of file Cache.php.

    {
        // For perfs reasons, we use this dynamic inclusion
        #require_once 'Zend/Cache/Exception.php';
        throw new Zend_Cache_Exception($msg, 0, $e);
    }

Field Documentation

$availableBackends

$availableBackends = array('File', 'Sqlite', 'Memcached', 'Libmemcached', 'Apc', 'ZendPlatform', 'Xcache', 'WinCache', 'TwoLevels')

static

Definition at line 67 of file Cache.php.

$availableFrontends

$availableFrontends = array('Core', 'Output', 'Class', 'File', 'Function', 'Page')

static

Definition at line 59 of file Cache.php.

$standardBackends

$standardBackends

static

Initial value:

= array('File', 'Sqlite', 'Memcached', 'Libmemcached', 'Apc', 'ZendPlatform',
                                            'Xcache', 'TwoLevels', 'WinCache', 'ZendServer_Disk', 'ZendServer_ShMem')

Definition at line 43 of file Cache.php.

$standardExtendedBackends

$standardExtendedBackends = array('File', 'Apc', 'TwoLevels', 'Memcached', 'Libmemcached', 'Sqlite', 'WinCache')

static

Definition at line 51 of file Cache.php.

$standardFrontends

$standardFrontends = array('Core', 'Output', 'Class', 'File', 'Function', 'Page')

static

Definition at line 36 of file Cache.php.

CLEANING_MODE_ALL

const CLEANING_MODE_ALL = 'all'

Consts for clean() method

Definition at line 72 of file Cache.php.

CLEANING_MODE_MATCHING_ANY_TAG

const CLEANING_MODE_MATCHING_ANY_TAG = 'matchingAnyTag'

Definition at line 76 of file Cache.php.

CLEANING_MODE_MATCHING_TAG

const CLEANING_MODE_MATCHING_TAG = 'matchingTag'

Definition at line 74 of file Cache.php.

CLEANING_MODE_NOT_MATCHING_TAG

const CLEANING_MODE_NOT_MATCHING_TAG = 'notMatchingTag'

Definition at line 75 of file Cache.php.

CLEANING_MODE_OLD

const CLEANING_MODE_OLD = 'old'

Definition at line 73 of file Cache.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Cache.php