Zend\Cache\Pattern\ObjectCache¶

Overview¶

The ObjectCache pattern is an extension to the CallbackCache pattern. It has the same methods but instead it generates the internally used callback in base of the configured object and the given method name.

Quick Start¶

Instantiating the object cache pattern

use Zend\Cache\PatternFactory;

$object      = new stdClass();
$objectCache = PatternFactory::factory('object', array(
    'object'  => $object,
    'storage' => 'apc'
));

Configuration Options¶

Option	Data Type	Default Value	Description
storage	`string` `array` `Zend\Cache\Storage\StorageInterface`	<none>	The storage to write/read cached data
object	`object`	<none>	The object to cache methods calls of
object_key	`null` `string`	<Class name of object>	A hopefully unique key of the object
cache_output	`boolean`	`true`	Cache output of callback
cache_by_default	`boolean`	`true`	Cache method calls by default
object_cache_methods	`array`	`[]`	List of methods to cache (If `cache_by_default` is disabled)
object_non_cache_methods	`array`	`[]`	List of methods to no-cache (If `cache_by_default` is enabled)
object_cache_magic_properties	`boolean`	`false`	Cache calls of magic object properties

Available Methods¶

call(string $method, array $args = array())

Call the specified method of the configured object.

Tipo de retorno:
	mixed

__call(string $method, array $args)

Call the specified method of the configured object.

Tipo de retorno:
	mixed

__set(string $name, mixed $value)

Set a property of the configured object.

Tipo de retorno:
	void

__get(string $name)

Get a property of the configured object.

Tipo de retorno:
	mixed

__isset(string $name)

Checks if static property of the configured object exists.

Tipo de retorno:
	boolean

__unset(string $name)

Unset a property of the configured object.

Tipo de retorno:
	void

generateKey(string $method, array $args = array())

Generate a unique key in base of a key representing the callback part and a key representing the arguments part.

Tipo de retorno:
	string

setOptions(Zend\Cache\Pattern\PatternOptions $options)

Set pattern options.

Tipo de retorno:
	Zend\Cache\Pattern\ObjectCache

getOptions()

Get all pattern options.

Tipo de retorno:
	Zend\Cache\Pattern\PatternOptions

Examples¶

Caching a filter

$filter       = new Zend\Filter\RealPath();
$cachedFilter = Zend\Cache\PatternFactory::factory('object', array(
    'object'     => $filter,
    'object_key' => 'RealpathFilter',
    'storage'    => 'apc',

    // The realpath filter doesn't output anything
    // so the output don't need to be caught and cached
    'cache_output' => false,
));

$path = $cachedFilter->call("filter", array('/www/var/path/../../mypath'));
// OR
$path = $cachedFilter->filter('/www/var/path/../../mypath');