APCUIterator::__construct

(PECL apcu >= 5.0.0)

APCUIterator::__constructConstructs an APCUIterator iterator object


Description

public APCUIterator::__construct ([ mixed $search = NULL [, int $format = APC_ITER_ALL [, int $chunk_size = 100 [, int $list = APC_LIST_ACTIVE ]]]] )

Constructs an APCUIterator object.


Parameters

search
A PCRE regular expression that matches against APCu key names, either as a string for a single regular expression, or as an array of regular expressions. Or, optionally pass in NULL to skip the search.
format
The desired format, as configured with one or more of the APC_ITER_* constants.
chunk_size
The chunk size. Must be a value greater than 0. The default value is 100.
list
The type to list. Either pass in APC_LIST_ACTIVE or APC_LIST_DELETED.


Return Values

An APCUIterator object on success, or NULL on failure.


Examples

Example #1 A APCUIterator::__construct() example

<?phpforeach (new APCUIterator('/^counter\./') as $counter) {    echo "$counter[key]: $counter[value]\n";    apc_dec($counter['key'], $counter['value']);}?>

See Also