Scrapbook

SimpleCache
in package
implements CacheInterface

Tags
author

Matthias Mullie [email protected]

copyright

Copyright (c) 2014, Matthias Mullie. All rights reserved

license

LICENSE MIT

Table of Contents

Interfaces

CacheInterface

Methods

__construct()  : mixed
clear()  : bool
Wipes clean the entire cache's keys.
delete()  : bool
Delete an item from the cache by its unique key.
deleteMultiple()  : bool
Deletes multiple cache items in a single operation.
get()  : mixed
Fetches a value from the cache.
getMultiple()  : iterable<string, mixed>
Obtains multiple cache items by their unique keys.
has()  : bool
Determines whether an item is present in the cache.
set()  : bool
Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
setMultiple()  : bool
Persists a set of key => value pairs in the cache, with an optional TTL.

Methods

clear()

Wipes clean the entire cache's keys.

public clear() : bool
Return values
bool

True on success and false on failure.

delete()

Delete an item from the cache by its unique key.

public delete(string $key) : bool
Parameters
$key : string

The unique cache key of the item to delete.

Return values
bool

True if the item was successfully removed. False if there was an error.

deleteMultiple()

Deletes multiple cache items in a single operation.

public deleteMultiple(iterable<string|int, mixed> $keys) : bool
Parameters
$keys : iterable<string|int, mixed>

A list of string-based keys to be deleted.

Return values
bool

True if the items were successfully removed. False if there was an error.

get()

Fetches a value from the cache.

public get(string $key[, mixed $default = null ]) : mixed
Parameters
$key : string

The unique key of this item in the cache.

$default : mixed = null

Default value to return if the key does not exist.

Return values
mixed

The value of the item from the cache, or $default in case of cache miss.

getMultiple()

Obtains multiple cache items by their unique keys.

public getMultiple(iterable<string|int, mixed> $keys[, mixed $default = null ]) : iterable<string, mixed>
Parameters
$keys : iterable<string|int, mixed>

A list of keys that can be obtained in a single operation.

$default : mixed = null

Default value to return for keys that do not exist.

Return values
iterable<string, mixed>

A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.

has()

Determines whether an item is present in the cache.

public has(string $key) : bool

NOTE: It is recommended that has() is only to be used for cache warming type purposes and not to be used within your live applications operations for get/set, as this method is subject to a race condition where your has() will return true and immediately after, another script can remove it making the state of your app out of date.

Parameters
$key : string

The cache item key.

Return values
bool

set()

Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.

public set(string $key, mixed $value[, int|DateInterval|null $ttl = null ]) : bool
Parameters
$key : string

The key of the item to store.

$value : mixed

The value of the item to store, must be serializable.

$ttl : int|DateInterval|null = null

Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that.

Return values
bool

True on success and false on failure.

setMultiple()

Persists a set of key => value pairs in the cache, with an optional TTL.

public setMultiple(iterable<string|int, mixed> $values[, int|DateInterval|null $ttl = null ]) : bool
Parameters
$values : iterable<string|int, mixed>

A list of key => value pairs for a multiple-set operation.

$ttl : int|DateInterval|null = null

Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that.

Return values
bool

True on success and false on failure.


        
On this page

Search results