Class apc

Driver for the Alternative PHP Cache (APC) user-variable cache.

Core\Object implements Core\Chainable

Core\Set implements Core\Accessor

Core\Cache

Core\Cache\Driver\apc

Namespace: Core\Cache\Driver
Package: Core\Cache
Since: 3.1
Requires: PHP 5.3, APC 3.0
Version: 1.0
Located at Cache/Driver/apc.inc.php

Methods summary

`public`	# `__construct( Core\URI $uri )` Parameters `$uri` Driver configuration URI. Since 3.1 Overrides `Core\Cache::__construct`
`public string`	# `apcKey( string $class, string $key )` Formats the APC cache key. Formats the APC cache key. Parameters `$class` Cache of cache entry. `$key` Key of cache entry. Returns string Since 3.1
`public boolean`	# `exists( string $class, string $key )` Tests, whether a cache entry for a class item exists. Tests, whether a cache entry for a class item exists. Parameters `$class` Cache class of item to test for. `$key` The item key to test for. Returns boolean `true`, if a cache entry for the requested item exists, otherwise `false`. Since 3.1
`public string`	# `get( string $class, string $key )` Reads a cache entry and returns all binary data for the entry. Reads a cache entry and returns all binary data for the entry. Parameters `$class` Class of cache item. `$key` The key of the cache item. Returns string Binary data string of cache entry. Since 3.1 Overrides `Core\Cache::get`
`public string`	# `getHash( string $class, string $key )` Returns the hash for the requested cache entry. The hash type depends on the backend in use and defaults to 16-byte binary MD5. Returns the hash for the requested cache entry. The hash type depends on the backend in use and defaults to 16-byte binary MD5. Parameters `$class` Class of cache item. `$key` The key of the cache item. Returns string Binary hash of cache element. Since 3.1 Overrides `Core\Cache::getHash`
`public array`	# `getMeta( string $class, string $key )` Returns an array of meta attributes for the requested cache entry. Returns an array of meta attributes for the requested cache entry. Parameters `$class` Class of cache item. `$key` The key of the cache item. Returns array Associative array of the following cache entry meta attributes: age hash timestamp (since of last modification) Since 3.1 Overrides `Core\Cache::getMeta`
`public Core\Stream`	# `getStream( string $class, string $key )` Returns a reading stream instance for the requested cache entry. Returns a reading stream instance for the requested cache entry. Parameters `$class` Class of cache item. `$key` The key of the cache item. Returns `Core\Stream` Reading Stream instance for the requested cache entry. Since 3.1
`public integer`	# `getTimestamp( string $class, string $key )` Returns a UNIX timestamp of the last cache entry modification. Returns a UNIX timestamp of the last cache entry modification. Parameters `$class` Class of cache item. `$key` The key of the cache item. Returns integer UNIX timestamp of last modification to the named cache entry. Since 3.1
`public`	# `put( string $class, string $key, string $binaryData, integer $ttl = Core\Cache\Driver\null )` Writes binary data to a specified cache entry. Writes binary data to a specified cache entry. Parameters `$class` Class of cache item. `$key` The key of the cache item. `$binaryData` Binary data string to write to the cache entry. `$ttl` Time to live for cache entry (in seconds). Set to `null` if entry does not timeout. Since 3.1 Overrides `Core\Cache::put`
`public Core\Stream`	# `putStream( string $class, string $key, integer $ttl = Core\Cache\Driver\null )` Returns a writing stream instance for the requested cache entry. Returns a writing stream instance for the requested cache entry. Parameters `$class` Class of cache item. `$key` The key of the cache item. `$ttl` Time to live for cache entry (in seconds). Set to `null` if entry does not timeout. Returns `Core\Stream` Writing Stream instance for the requested cache entry. Since 3.1
`public`	# `remove( string $class, string $key )` Deletes a cache key entry. If the entry does not exist, no operation is performed. Deletes a cache key entry. If the entry does not exist, no operation is performed. Parameters `$class` Class of cache item. `$key` The key of the cache item. Since 3.1

Constants summary

`string`	`PrefixParameter` Prefix for APC keys. Default to empty string (global cache classes). Prefix for APC keys. Default to empty string (global cache classes). Since 3.1	# `'prefix'`

Constants inherited from Core\Cache

SharedClass

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

`protected array`	`$_v_parameters` APC cache settings array. APC cache settings array. Since 3.1	#
`protected string`	`$_v_prefix` APC keys prefix (derived from prefix setting). APC keys prefix (derived from prefix setting). Since 3.1	#

Properties inherited from Core\Cache

$_activeInstance, $_v_versionID

Magic properties

`public read-only array`	`$parameters` Configuration array.
`public read-only string`	`$prefix` Calculated prefix string for APC keys.

Magic properties inherited from Core\Cache

$versionID

Magic properties inherited from Core\Object

$hash, $uuid

Namespaces

Classes

Class apc

Methods summary

Parameters

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Since

Overrides

Parameters

Returns

Since

Parameters

Since

Methods inherited from Core\Cache

Methods inherited from Core\Set

Methods inherited from Core\Object

Constants summary

Since

Constants inherited from Core\Cache

Constants inherited from Core\Object

Properties summary

Since

Since

Properties inherited from Core\Cache

Magic properties

Magic properties inherited from Core\Cache

Magic properties inherited from Core\Object