Zend Framework  3.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Apcu Class Reference

Public Member Functions

 __construct ($options=null)
 Constructor.
 
 setOptions ($options)
 Set options.
 
 getOptions ()
 Get options.
 
 getTotalSpace ()
 Get total space in bytes.
 
 getAvailableSpace ()
 Get available space in bytes.
 
 getIterator ()
 Get the storage iterator.
 
 flush ()
 Flush the whole storage.
 
 clearByNamespace ($namespace)
 Remove items by given namespace.
 
 clearByPrefix ($prefix)
 Remove items matching given prefix.
 
- Public Member Functions inherited from AbstractAdapter
 __construct ($options=null)
 Constructor.
 
 __destruct ()
 Destructor.
 
 setOptions ($options)
 Set options.
 
 getOptions ()
 Get options.
 
 setCaching ($flag)
 Enable/Disable caching.
 
 getCaching ()
 Get caching enabled.
 
 getEventManager ()
 Get the event manager.
 
 hasPlugin (Plugin\PluginInterface $plugin)
 Check if a plugin is registered.
 
 addPlugin (Plugin\PluginInterface $plugin, $priority=1)
 Register a plugin.
 
 removePlugin (Plugin\PluginInterface $plugin)
 Unregister an already registered plugin.
 
 getPluginRegistry ()
 Return registry of plugins.
 
 getItem ($key, &$success=null, &$casToken=null)
 Get an item.
 
 getItems (array $keys)
 Get multiple items.
 
 hasItem ($key)
 Test if an item exists.
 
 hasItems (array $keys)
 Test multiple items.
 
 getMetadata ($key)
 Get metadata of an item.
 
 getMetadatas (array $keys)
 Get multiple metadata.
 
 setItem ($key, $value)
 Store an item.
 
 setItems (array $keyValuePairs)
 Store multiple items.
 
 addItem ($key, $value)
 Add an item.
 
 addItems (array $keyValuePairs)
 Add multiple items.
 
 replaceItem ($key, $value)
 Replace an existing item.
 
 replaceItems (array $keyValuePairs)
 Replace multiple existing items.
 
 checkAndSetItem ($token, $key, $value)
 Set an item only if token matches.
 
 touchItem ($key)
 Reset lifetime of an item.
 
 touchItems (array $keys)
 Reset lifetime of multiple items.
 
 removeItem ($key)
 Remove an item.
 
 removeItems (array $keys)
 Remove multiple items.
 
 incrementItem ($key, $value)
 Increment an item.
 
 incrementItems (array $keyValuePairs)
 Increment multiple items.
 
 decrementItem ($key, $value)
 Decrement an item.
 
 decrementItems (array $keyValuePairs)
 Decrement multiple items.
 
 getCapabilities ()
 Get capabilities of this adapter.
 

Protected Member Functions

 internalGetItem (&$normalizedKey, &$success=null, &$casToken=null)
 Internal method to get an item.
 
 internalGetItems (array &$normalizedKeys)
 Internal method to get multiple items.
 
 internalHasItem (&$normalizedKey)
 Internal method to test if an item exists.
 
 internalHasItems (array &$normalizedKeys)
 Internal method to test multiple items.
 
 internalGetMetadata (&$normalizedKey)
 Get metadata of an item.
 
 internalGetMetadatas (array &$normalizedKeys)
 Get metadata of multiple items.
 
 internalSetItem (&$normalizedKey, &$value)
 Internal method to store an item.
 
 internalSetItems (array &$normalizedKeyValuePairs)
 Internal method to store multiple items.
 
 internalAddItem (&$normalizedKey, &$value)
 Add an item.
 
 internalAddItems (array &$normalizedKeyValuePairs)
 Internal method to add multiple items.
 
 internalReplaceItem (&$normalizedKey, &$value)
 Internal method to replace an existing item.
 
 internalCheckAndSetItem (&$token, &$normalizedKey, &$value)
 Internal method to set an item only if token matches.
 
 internalRemoveItem (&$normalizedKey)
 Internal method to remove an item.
 
 internalRemoveItems (array &$normalizedKeys)
 Internal method to remove multiple items.
 
 internalIncrementItem (&$normalizedKey, &$value)
 Internal method to increment an item.
 
 internalDecrementItem (&$normalizedKey, &$value)
 Internal method to decrement an item.
 
 internalGetCapabilities ()
 Internal method to get capabilities of this adapter.
 
 normalizeMetadata (array &$metadata)
 Normalize metadata to work with APC.
 
- Protected Member Functions inherited from AbstractAdapter
 triggerPre ($eventName, ArrayObject $args)
 Trigger a pre event and return the event response collection.
 
 triggerPost ($eventName, ArrayObject $args, &$result)
 Triggers the PostEvent and return the result value.
 
 triggerException ($eventName, ArrayObject $args, &$result,\Exception $exception)
 Trigger an exception event.
 
 internalGetItem (&$normalizedKey, &$success=null, &$casToken=null)
 Internal method to get an item.
 
 internalGetItems (array &$normalizedKeys)
 Internal method to get multiple items.
 
 internalHasItem (&$normalizedKey)
 Internal method to test if an item exists.
 
 internalHasItems (array &$normalizedKeys)
 Internal method to test multiple items.
 
 internalGetMetadata (&$normalizedKey)
 Internal method to get metadata of an item.
 
 internalGetMetadatas (array &$normalizedKeys)
 Internal method to get multiple metadata.
 
 internalSetItem (&$normalizedKey, &$value)
 Internal method to store an item.
 
 internalSetItems (array &$normalizedKeyValuePairs)
 Internal method to store multiple items.
 
 internalAddItem (&$normalizedKey, &$value)
 Internal method to add an item.
 
 internalAddItems (array &$normalizedKeyValuePairs)
 Internal method to add multiple items.
 
 internalReplaceItem (&$normalizedKey, &$value)
 Internal method to replace an existing item.
 
 internalReplaceItems (array &$normalizedKeyValuePairs)
 Internal method to replace multiple existing items.
 
 internalCheckAndSetItem (&$token, &$normalizedKey, &$value)
 Internal method to set an item only if token matches.
 
 internalTouchItem (&$normalizedKey)
 Internal method to reset lifetime of an item.
 
 internalTouchItems (array &$normalizedKeys)
 Internal method to reset lifetime of multiple items.
 
 internalRemoveItem (&$normalizedKey)
 Internal method to remove an item.
 
 internalRemoveItems (array &$normalizedKeys)
 Internal method to remove multiple items.
 
 internalIncrementItem (&$normalizedKey, &$value)
 Internal method to increment an item.
 
 internalIncrementItems (array &$normalizedKeyValuePairs)
 Internal method to increment multiple items.
 
 internalDecrementItem (&$normalizedKey, &$value)
 Internal method to decrement an item.
 
 internalDecrementItems (array &$normalizedKeyValuePairs)
 Internal method to decrement multiple items.
 
 internalGetCapabilities ()
 Internal method to get capabilities of this adapter.
 
 normalizeKey (&$key)
 Validates and normalizes a key.
 
 normalizeKeys (array &$keys)
 Validates and normalizes multiple keys.
 
 normalizeKeyValuePairs (array &$keyValuePairs)
 Validates and normalizes an array of key-value pairs.
 

Protected Attributes

 $totalSpace
 
- Protected Attributes inherited from AbstractAdapter
 $events = null
 
 $eventHandles = []
 
 $pluginRegistry
 
 $capabilities = null
 
 $capabilityMarker
 
 $options
 

Constructor & Destructor Documentation

__construct (   $options = null)

Constructor.

Parameters
null | array | Traversable | ApcuOptions$options
Exceptions
Exception\ExceptionInterface

Member Function Documentation

clearByNamespace (   $namespace)

Remove items by given namespace.

Parameters
string$namespace
Returns
bool

Implements ClearByNamespaceInterface.

clearByPrefix (   $prefix)

Remove items matching given prefix.

Parameters
string$prefix
Returns
bool

Implements ClearByPrefixInterface.

flush ( )

Flush the whole storage.

Returns
bool

Implements FlushableInterface.

getAvailableSpace ( )

Get available space in bytes.

Returns
int|float

Implements AvailableSpaceCapableInterface.

getIterator ( )

Get the storage iterator.

Returns
ApcuIterator
getOptions ( )

Get options.

Returns
ApcuOptions
See Also
setOptions()

Implements StorageInterface.

getTotalSpace ( )

Get total space in bytes.

Returns
int|float

Implements TotalSpaceCapableInterface.

internalAddItem ( $normalizedKey,
$value 
)
protected

Add an item.

Parameters
string$normalizedKey
mixed$value
Returns
bool
Exceptions
Exception\ExceptionInterface
internalAddItems ( array &  $normalizedKeyValuePairs)
protected

Internal method to add multiple items.

Parameters
array$normalizedKeyValuePairs
Returns
array Array of not stored keys
Exceptions
Exception\ExceptionInterface
internalCheckAndSetItem ( $token,
$normalizedKey,
$value 
)
protected

Internal method to set an item only if token matches.

Parameters
mixed$token
string$normalizedKey
mixed$value
Returns
bool
See Also
getItem()
setItem()
internalDecrementItem ( $normalizedKey,
$value 
)
protected

Internal method to decrement an item.

Parameters
string$normalizedKey
int$value
Returns
int|bool The new value on success, false on failure
Exceptions
Exception\ExceptionInterface
internalGetCapabilities ( )
protected

Internal method to get capabilities of this adapter.

Returns
Capabilities
internalGetItem ( $normalizedKey,
$success = null,
$casToken = null 
)
protected

Internal method to get an item.

Parameters
string$normalizedKey
bool$success
mixed$casToken
Returns
mixed Data on success, null on failure
Exceptions
Exception\ExceptionInterface
internalGetItems ( array &  $normalizedKeys)
protected

Internal method to get multiple items.

Parameters
array$normalizedKeys
Returns
array Associative array of keys and values
Exceptions
Exception\ExceptionInterface
internalGetMetadata ( $normalizedKey)
protected

Get metadata of an item.

Parameters
string$normalizedKey
Returns
array|bool Metadata on success, false on failure
Exceptions
Exception\ExceptionInterface
internalGetMetadatas ( array &  $normalizedKeys)
protected

Get metadata of multiple items.

Parameters
array$normalizedKeys
Returns
array Associative array of keys and metadata

getMetadatas.pre(PreEvent) getMetadatas.post(PostEvent) getMetadatas.exception(ExceptionEvent)

internalHasItem ( $normalizedKey)
protected

Internal method to test if an item exists.

Parameters
string$normalizedKey
Returns
bool
Exceptions
Exception\ExceptionInterface
internalHasItems ( array &  $normalizedKeys)
protected

Internal method to test multiple items.

Parameters
array$normalizedKeys
Returns
array Array of found keys
Exceptions
Exception\ExceptionInterface
internalIncrementItem ( $normalizedKey,
$value 
)
protected

Internal method to increment an item.

Parameters
string$normalizedKey
int$value
Returns
int|bool The new value on success, false on failure
Exceptions
Exception\ExceptionInterface
internalRemoveItem ( $normalizedKey)
protected

Internal method to remove an item.

Parameters
string$normalizedKey
Returns
bool
Exceptions
Exception\ExceptionInterface
internalRemoveItems ( array &  $normalizedKeys)
protected

Internal method to remove multiple items.

Parameters
array$normalizedKeys
Returns
array Array of not removed keys
Exceptions
Exception\ExceptionInterface
internalReplaceItem ( $normalizedKey,
$value 
)
protected

Internal method to replace an existing item.

Parameters
string$normalizedKey
mixed$value
Returns
bool
Exceptions
Exception\ExceptionInterface
internalSetItem ( $normalizedKey,
$value 
)
protected

Internal method to store an item.

Parameters
string$normalizedKey
mixed$value
Returns
bool
Exceptions
Exception\ExceptionInterface
internalSetItems ( array &  $normalizedKeyValuePairs)
protected

Internal method to store multiple items.

Parameters
array$normalizedKeyValuePairs
Returns
array Array of not stored keys
Exceptions
Exception\ExceptionInterface
normalizeMetadata ( array &  $metadata)
protected

Normalize metadata to work with APC.

Parameters
array$metadata
Returns
void
setOptions (   $options)

Set options.

Parameters
array | Traversable | ApcuOptions$options
Returns
Apcu
See Also
getOptions()

Implements StorageInterface.

Member Data Documentation

$totalSpace
protected