ApcEngine Class Info:

Class Declaration:

class ApcEngine extends CacheEngine

File name:
cake/libs/cache/apc.php
Description:

APC storage engine for cache

Class Inheritance

CacheEngine

Package
cake
Subpackage
cake.cake.libs.cache

Properties:

Show/Hide parent properties

  • settings int

    Settings of current engine instance

Method Summary:

Show/Hide parent methods

clear

top

Delete all keys from the cache

Method defined in:
cake/libs/cache/apc.php on line 120
Return

boolean True if the cache was succesfully cleared, false otherwise

Access

public

decrement

top

Decrements the value of an integer cached key

Parameters:
  • string $key required

    Identifier for the data

  • integer $offset optional 1

    How much to substract

Method defined in:
cake/libs/cache/apc.php on line 99
Return

New decremented value, false otherwise

Access

public

delete

top

Delete a key from the cache

Parameters:
  • string $key required

    Identifier for the data

Method defined in:
cake/libs/cache/apc.php on line 110
Return

boolean True if the value was succesfully deleted, false if it didn't exist or couldn't be removed

Access

public

gc

top

Garbage collection

Permanently remove all expired and deleted data

Method defined in:
cake/libs/cache.php on line 609
Access

public

increment

top

Increments the value of an integer cached key

Parameters:
  • string $key required

    Identifier for the data

  • integer $offset optional 1

    How much to increment

Method defined in:
cake/libs/cache/apc.php on line 86
Return

New incremented value, false otherwise

Access

public

init

top

Initialize the Cache Engine

Called automatically by the cache frontend To reinitialize the settings call Cache::engine('EngineName', [optional] settings = array());

Parameters:
  • $settings optional array ( )

Method defined in:
cake/libs/cache/apc.php on line 41
Return

boolean True if the engine has been successfully initialized, false if not

See

CacheEngine::__defaults

Access

public

key

top

Generates a safe key for use with cache engine storage engines.

Parameters:
  • string $key required

    the key passed over

Method defined in:
cake/libs/cache.php on line 695
Return

mixed string $key or false

Access

public

read

top

Read a key from the cache

Parameters:
  • string $key required

    Identifier for the data

Method defined in:
cake/libs/cache/apc.php on line 68
Return

mixed The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it

Access

public

settings

top

Cache Engine settings

Method defined in:
cake/libs/cache.php on line 684
Return

array settings

Access

public

write

top

Write data for key into cache

Parameters:
  • string $key required

    Identifier for the data

  • mixed $value required

    Data to be cached

  • integer $duration required

    How long to cache the data, in seconds

Method defined in:
cake/libs/cache/apc.php on line 55
Return

boolean True if the data was succesfully cached, false on failure

Access

public