php8.5
Home/ Manual/ apcu / apcuiterator/ APCUIterator::__construct

APCUIterator::__construct

PHP function Edit on GitHub ✎

(PECL apcu >= 5.0.0)

Constructs an APCUIterator iterator object

Description

APCUIterator::__construct(array|string|null $search = null, int $format = APC_ITER_ALL, int $chunk_size = 100, int $list = APC_LIST_ACTIVE)

Constructs an APCUIterator object.

Parameters

search

Either a PCRE regular expression that matches against APCu key names, given as a String. Or an Array of Strings with APCu key names. Or, optionally 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.

Examples

A APCUIterator::__construct() example

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

See Also

Source: reference/apcu/apcuiterator/construct.xml · from the official PHP manual (php/doc-en)