The APCUIterator class

(PECL apcu >= 5.0.0)

Introduction

The APCUIterator class makes it easier to iterate over large APCu caches. This is helpful as it allows iterating over large caches in steps, while grabbing a defined number of entries per lock instance, so it frees the cache locks for other activities rather than hold up the entire cache to grab 100 (the default) entries. Also, using regular expression matching is more efficient as it's been moved to the C level.

Class synopsis

class APCUIterator implements Iterator {

/* Methods */

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

public function current(): mixed

public function getTotalCount(): int

public function getTotalHits(): int

public function getTotalSize(): int

public function key(): string

public function next(): bool

public function rewind(): void

public function valid(): bool

}

APCUIterator::__construct — Constructs an APCUIterator iterator object
APCUIterator::current — Get current item
APCUIterator::getTotalCount — Get total count
APCUIterator::getTotalHits — Get total cache hits
APCUIterator::getTotalSize — Get total cache size
APCUIterator::key — Get iterator key
APCUIterator::next — Move pointer to next item
APCUIterator::rewind — Rewinds iterator
APCUIterator::valid — Checks if current position is valid

The APCUIterator class

Introduction

Class synopsis

Table of Contents