Cache class - Documentation for SproutCMS

Info Page:

Page options:

class Cache

Provides a driver-based interface for finding, creating, and deleting cached
resources. Caches are identified by a unique string. Tagging of caches is
also supported, and caches can be found and deleted by id or tag.

File: /sprout/Helpers/Cache.php
Namespace: Sprout\Helpers

Variables

Name	Visibility	Description
`$config`
`$driver`
`$instances`	(static)
`$loaded`	(static)

Functions

Name	Visibility	Description
__construct	public	Loads the configured driver and validates it.
delete	public	Delete a cache item by id.
deleteAll	public	Delete ALL cache items items.
deleteTag	public	Delete all cache items with a given tag.
find	public	Fetches all of the caches for a given tag. An empty array will be
get	public	Fetches a cache by id. NULL is returned when a cache item is not found.
instance	public (static)	Returns a singleton instance of Cache.
sanitizeId	protected	Replaces troublesome characters with underscores.
set	public	Set a cache item by id. Tags may also be added and a custom lifetime

public __construct

void $Cache->__construct ( [ array|string $config ] );

Loads the configured driver and validates it.

public delete

boolean $Cache->delete ( string $id );

Delete a cache item by id.

public deleteAll

boolean $Cache->deleteAll ( );

Delete ALL cache items items.

public deleteTag

boolean $Cache->deleteTag ( string $tag );

Delete all cache items with a given tag.

public find

array $Cache->find ( string $tag );

Fetches all of the caches for a given tag. An empty array will be
returned when no matching caches are found.

public get

mixed $Cache->get ( string $id );

Fetches a cache by id. NULL is returned when a cache item is not found.

public instance

Cache Cache::instance ( [ string &$config ] );

Returns a singleton instance of Cache.

protected sanitizeId

string $Cache->sanitizeId ( string $id );

Replaces troublesome characters with underscores.

public set

boolean $Cache->set ( string $id , mixed $data [, array|string $tags [, integer $lifetime ]] );

Set a cache item by id. Tags may also be added and a custom lifetime
can be set. Non-string data is automatically serialized.

SproutCMS

Search documentation