APCUIterator::__construct

From Get docs
Php/docs/latest/apcuiterator.construct


APCUIterator::__construct

(PECL apcu >= 5.0.0)

APCUIterator::__constructConstructs an APCUIterator iterator object


Description

public 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.


Return Values

An APCUIterator object on success, or null on failure.


Examples

Example #1 A APCUIterator::__construct() example

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

See Also


© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/apcuiterator.construct.php