PHP Class DebugKit\Cache\Engine\DebugEngine

Used by the CachePanel to wrap and track metrics related to caching.
Inheritance: extends Cake\Cache\CacheEngine
Datei anzeigen Open project: cakephp/debug_kit Class Usage Examples

Protected Properties

Property Type Description
$_config mixed Proxied cache engine config.
$_engine mixed Proxied engine
$_metrics mixed Hit/miss metrics.

Public Methods

Method Description
__construct ( mixed $config ) Constructor
__toString ( ) : string Magic __toString() method to get the CacheEngine's name
clear ( $check ) {@inheritDoc}
clearGroup ( $group ) {@inheritDoc}
config ( string $key = null, mixed $value = null, boolean $merge = true ) : mixed Return the proxied configuration data.
decrement ( $key, $offset = 1 ) {@inheritDoc}
delete ( $key ) {@inheritDoc}
deleteMany ( $data ) {@inheritDoc}
engine ( ) : Cake\Cache\CacheEngine Get the internal engine
groups ( ) {@inheritDoc}
increment ( $key, $offset = 1 ) {@inheritDoc}
init ( array $config = [] ) : boolean Initialize the proxied Cache Engine
metrics ( ) : array Get the metrics for this object.
read ( $key ) {@inheritDoc}
readMany ( $data ) {@inheritDoc}
write ( $key, $value ) {@inheritDoc}
writeMany ( $data ) {@inheritDoc}

Protected Methods

Method Description
_track ( string $metric ) : void Track a metric.

Method Details

__construct() public method

Constructor
public __construct ( mixed $config )
$config mixed Config data or the proxied adapter.

__toString() public method

Magic __toString() method to get the CacheEngine's name
public __toString ( ) : string
return string Returns the CacheEngine's name

_track() protected method

Track a metric.
protected _track ( string $metric ) : void
$metric string The metric to increment.
return void

clear() public method

{@inheritDoc}
public clear ( $check )

clearGroup() public method

{@inheritDoc}
public clearGroup ( $group )

config() public method

This method uses func_get_args() as not doing so confuses the proxied class.
public config ( string $key = null, mixed $value = null, boolean $merge = true ) : mixed
$key string The key to set/read.
$value mixed The value to set.
$merge boolean Whether or not configuration should be merged.
return mixed

decrement() public method

{@inheritDoc}
public decrement ( $key, $offset = 1 )

delete() public method

{@inheritDoc}
public delete ( $key )

deleteMany() public method

{@inheritDoc}
public deleteMany ( $data )

engine() public method

Get the internal engine
public engine ( ) : Cake\Cache\CacheEngine
return Cake\Cache\CacheEngine

groups() public method

{@inheritDoc}
public groups ( )

increment() public method

{@inheritDoc}
public increment ( $key, $offset = 1 )

init() public method

Initialize the proxied Cache Engine
public init ( array $config = [] ) : boolean
$config array Array of setting for the engine.
return boolean True, this engine cannot fail to initialize.

metrics() public method

Get the metrics for this object.
public metrics ( ) : array
return array

read() public method

{@inheritDoc}
public read ( $key )

readMany() public method

{@inheritDoc}
public readMany ( $data )

write() public method

{@inheritDoc}
public write ( $key, $value )

writeMany() public method

{@inheritDoc}
public writeMany ( $data )

Property Details

$_config protected_oe property

Proxied cache engine config.
protected mixed $_config
return mixed

$_engine protected_oe property

Proxied engine
protected mixed $_engine
return mixed

$_metrics protected_oe property

Hit/miss metrics.
protected mixed $_metrics
return mixed