Zend_Cache_Manager Class Reference

Public Member Functions
	setCache ($name, Zend_Cache_Core $cache)
	hasCache ($name)
	getCache ($name)
	getCaches ()
	setCacheTemplate ($name, $options)
	hasCacheTemplate ($name)
	getCacheTemplate ($name)
	setTemplateOptions ($name, $options)

Data Fields
const	PAGECACHE = 'page'
const	PAGETAGCACHE = 'pagetag'

Protected Member Functions
	_mergeOptions (array $current, array $options)

Protected Attributes
	$_caches = array()
	$_optionTemplates

Detailed Description

Definition at line 34 of file Manager.php.

Member Function Documentation

_mergeOptions()

_mergeOptions ( array  $current, array  $options  )

protected

Simple method to merge two configuration arrays

Parameters

array	$current
array	$options

Returns

array

Definition at line 279 of file Manager.php.

    {
        if (isset($options['frontend']['name'])) {
            $current['frontend']['name'] = $options['frontend']['name'];
        }
        if (isset($options['backend']['name'])) {
            $current['backend']['name'] = $options['backend']['name'];
        }
        if (isset($options['frontend']['options'])) {
            foreach ($options['frontend']['options'] as $key => $value) {
                $current['frontend']['options'][$key] = $value;
            }
        }
        if (isset($options['backend']['options'])) {
            foreach ($options['backend']['options'] as $key => $value) {
                $current['backend']['options'][$key] = $value;
            }
        }
        if (isset($options['frontend']['customFrontendNaming'])) {
            $current['frontend']['customFrontendNaming'] = $options['frontend']['customFrontendNaming'];
        }
        if (isset($options['backend']['customBackendNaming'])) {
            $current['backend']['customBackendNaming'] = $options['backend']['customBackendNaming'];
        }
        if (isset($options['frontendBackendAutoload'])) {
            $current['frontendBackendAutoload'] = $options['frontendBackendAutoload'];
        }
        return $current;
    }

getCache()

getCache

(

$name

)

Fetch the named cache object, or instantiate and return a cache object using a named configuration template

Parameters

string

$name

Returns

Zend_Cache_Core

Definition at line 151 of file Manager.php.

    {
        if (isset($this->_caches[$name])) {
            return $this->_caches[$name];
        }
        if (isset($this->_optionTemplates[$name])) {
            if ($name == self::PAGECACHE
                && (!isset($this->_optionTemplates[$name]['backend']['options']['tag_cache'])
                || !$this->_optionTemplates[$name]['backend']['options']['tag_cache'] instanceof Zend_Cache_Core)
            ) {
                $this->_optionTemplates[$name]['backend']['options']['tag_cache']
                    = $this->getCache(self::PAGETAGCACHE);
            }

            $this->_caches[$name] = Zend_Cache::factory(
                $this->_optionTemplates[$name]['frontend']['name'],
                $this->_optionTemplates[$name]['backend']['name'],
                isset($this->_optionTemplates[$name]['frontend']['options']) ? $this->_optionTemplates[$name]['frontend']['options'] : array(),
                isset($this->_optionTemplates[$name]['backend']['options']) ? $this->_optionTemplates[$name]['backend']['options'] : array(),
                isset($this->_optionTemplates[$name]['frontend']['customFrontendNaming']) ? $this->_optionTemplates[$name]['frontend']['customFrontendNaming'] : false,
                isset($this->_optionTemplates[$name]['backend']['customBackendNaming']) ? $this->_optionTemplates[$name]['backend']['customBackendNaming'] : false,
                isset($this->_optionTemplates[$name]['frontendBackendAutoload']) ? $this->_optionTemplates[$name]['frontendBackendAutoload'] : false
            );

            return $this->_caches[$name];
        }
    }

getCaches()

getCaches

(

)

Fetch all available caches

Returns

array An array of all available caches with it's names as key

Definition at line 184 of file Manager.php.

    {
        $caches = $this->_caches;
        foreach ($this->_optionTemplates as $name => $tmp) {
            if (!isset($caches[$name])) {
                $caches[$name] = $this->getCache($name);
            }
        }
        return $caches;
    }

getCacheTemplate()

getCacheTemplate

(

$name

)

Get the named configuration template

Parameters

string

$name

Returns

array

Definition at line 237 of file Manager.php.

    {
        if (isset($this->_optionTemplates[$name])) {
            return $this->_optionTemplates[$name];
        }
    }

hasCache()

hasCache

(

$name

)

Check if the Cache Manager contains the named cache object, or a named configuration template to lazy load the cache object

Parameters

string

$name

Returns

bool

Definition at line 134 of file Manager.php.

    {
        if (isset($this->_caches[$name])
            || $this->hasCacheTemplate($name)
        ) {
            return true;
        }
        return false;
    }

hasCacheTemplate()

hasCacheTemplate

(

$name

)

Check if the named configuration template

Parameters

string

$name

Returns

bool

Definition at line 223 of file Manager.php.

    {
        if (isset($this->_optionTemplates[$name])) {
            return true;
        }
        return false;
    }

setCache()

setCache	(		$name,
		Zend_Cache_Core	$cache
	)

Set a new cache for the Cache Manager to contain

Parameters

string	$name
Zend_Cache_Core	$cache

Returns

Zend_Cache_Manager

Definition at line 121 of file Manager.php.

    {
        $this->_caches[$name] = $cache;
        return $this;
    }

setCacheTemplate()

setCacheTemplate	(		$name,
			$options
	)

Set a named configuration template from which a cache object can later be lazy loaded

Parameters

string	$name
array	$options

Returns

Zend_Cache_Manager

Exceptions

Zend_Cache_Exception

Definition at line 204 of file Manager.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } elseif (!is_array($options)) {
            #require_once 'Zend/Cache/Exception.php';
            throw new Zend_Cache_Exception('Options passed must be in'
                . ' an associative array or instance of Zend_Config');
        }
        $this->_optionTemplates[$name] = $options;
        return $this;
    }

setTemplateOptions()

setTemplateOptions	(		$name,
			$options
	)

Pass an array containing changes to be applied to a named configuration template

Parameters

string	$name
array	$options

Returns

Zend_Cache_Manager

Exceptions

Zend_Cache_Exception

for invalid options format or if option templates do not have $name

Definition at line 254 of file Manager.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } elseif (!is_array($options)) {
            #require_once 'Zend/Cache/Exception.php';
            throw new Zend_Cache_Exception('Options passed must be in'
                . ' an associative array or instance of Zend_Config');
        }
        if (!isset($this->_optionTemplates[$name])) {
            throw new Zend_Cache_Exception('A cache configuration template'
                . 'does not exist with the name "' . $name . '"');
        }
        $this->_optionTemplates[$name]
            = $this->_mergeOptions($this->_optionTemplates[$name], $options);
        return $this;
    }

Field Documentation

$_caches

$_caches = array()

protected

Definition at line 51 of file Manager.php.

$_optionTemplates

$_optionTemplates

protected

Definition at line 59 of file Manager.php.

PAGECACHE

const PAGECACHE = 'page'

Constant holding reserved name for default Page Cache

Definition at line 39 of file Manager.php.

PAGETAGCACHE

const PAGETAGCACHE = 'pagetag'

Constant holding reserved name for default Page Tag Cache

Definition at line 44 of file Manager.php.

---

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

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