APCIterator::__construct

Constructs an APCIterator iterator object

&reftitle.description; public `APCIterator::__construct` `string` `cache` `mixed` `search` null `int` `format` APC_ITER_ALL `int` `chunk_size` 100 `int` `list` APC_LIST_ACTIVE

Constructs an `APCIterator` `object`.

&reftitle.parameters;

`cache`

- The cache type, which will be `user` or `file`.

`search`

- A PCRE regular expression that matches against APC 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`.

&reftitle.returnvalues;

An `APCIterator` `object` on success, or &null; on failure.

&reftitle.examples;

### A `APCIterator::__construct` example

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

&reftitle.seealso;

- `apc_exists`
- `apc_cache_info`