Documentation

ApcStore extends TaggableStore
in package
implements Store Uses RetrievesMultipleKeys

Interfaces, Classes and Traits

Store

Table of Contents

$apc  : ApcWrapper
The APC wrapper instance.
$prefix  : string
A string that should be prepended to keys.
__construct()  : void
Create a new APC store.
decrement()  : int|bool
Decrement the value of an item in the cache.
flush()  : bool
Remove all items from the cache.
forever()  : void
Store an item in the cache indefinitely.
forget()  : bool
Remove an item from the cache.
get()  : mixed
Retrieve an item from the cache by key.
getPrefix()  : string
Get the cache key prefix.
increment()  : int|bool
Increment the value of an item in the cache.
many()  : array<string|int, mixed>
Retrieve multiple items from the cache by key.
put()  : void
Store an item in the cache for a given number of minutes.
putMany()  : void
Store multiple items in the cache for a given number of minutes.
tags()  : TaggedCache
Begin executing a new tags operation.

Properties

$prefix

A string that should be prepended to keys.

protected string $prefix

Methods

__construct()

Create a new APC store.

public __construct(ApcWrapper $apc[, string $prefix = '' ]) : void
Parameters
$apc : ApcWrapper
$prefix : string = ''
Return values
void —

decrement()

Decrement the value of an item in the cache.

public decrement(string $key[, mixed $value = 1 ]) : int|bool
Parameters
$key : string
$value : mixed = 1
Return values
int|bool —

flush()

Remove all items from the cache.

public flush() : bool
Return values
bool —

forever()

Store an item in the cache indefinitely.

public forever(string $key, mixed $value) : void
Parameters
$key : string
$value : mixed
Return values
void —

forget()

Remove an item from the cache.

public forget(string $key) : bool
Parameters
$key : string
Return values
bool —

get()

Retrieve an item from the cache by key.

public get(string|array<string|int, mixed> $key) : mixed
Parameters
$key : string|array<string|int, mixed>
Return values
mixed —

getPrefix()

Get the cache key prefix.

public getPrefix() : string
Return values
string —

increment()

Increment the value of an item in the cache.

public increment(string $key[, mixed $value = 1 ]) : int|bool
Parameters
$key : string
$value : mixed = 1
Return values
int|bool —

many()

Retrieve multiple items from the cache by key.

public many(array<string|int, mixed> $keys) : array<string|int, mixed>

Items not found in the cache will have a null value.

Parameters
$keys : array<string|int, mixed>
Return values
array<string|int, mixed> —

put()

Store an item in the cache for a given number of minutes.

public put(string $key, mixed $value, float|int $minutes) : void
Parameters
$key : string
$value : mixed
$minutes : float|int
Return values
void —

putMany()

Store multiple items in the cache for a given number of minutes.

public putMany(array<string|int, mixed> $values, float|int $minutes) : void
Parameters
$values : array<string|int, mixed>
$minutes : float|int
Return values
void —

tags()

Begin executing a new tags operation.

public tags(array<string|int, mixed>|mixed $names) : TaggedCache
Parameters
$names : array<string|int, mixed>|mixed
Return values
TaggedCache —

Search results