Home/ Manual/ apcu / functions/ apcu_cache_info

apcu_cache_info

PHP function Edit on GitHub ✎

(PECL apcu >= 4.0.0)

Retrieves cached information from APCu's data store

Description

apcu_cache_info(bool $limited = false): array|false

Retrieves cached information and meta-data from APCu's data store.

Parameters

limited: If limited is true, the return value will exclude the individual list of cache entries. This is useful when trying to optimize calls for statistics gathering.

Return Values

Array of cached data (and meta-data)Falseforfailure

Note

apcu_cache_info() will raise a warning if it is unable to retrieve APCu cache data. This typically occurs when APCu is not enabled.

Changelog

Version	Description
PECL apcu 3.0.11	The `limited` parameter was introduced.
PECL apcu 3.0.16	The "`filehits`" option for the `cache_type` parameter was introduced.

Examples

A apcu_cache_info() example

php

<?php
print_r(apcu_cache_info());
?>

The above example will output something similar to:

output

Array
(
    [num_slots] => 2000
    [ttl] => 0
    [num_hits] => 9
    [num_misses] => 3
    [start_time] => 1123958803
    [cache_list] => Array
        (
            [0] => Array
                (
                    [filename] => /path/to/apcu_test.php
                    [device] => 29954
                    [inode] => 1130511
                    [type] => file
                    [num_hits] => 1
                    [mtime] => 1123960686
                    [creation_time] => 1123960696
                    [deletion_time] => 0
                    [access_time] => 1123962864
                    [ref_count] => 1
                    [mem_size] => 677
                )
            [1] => Array (...iterates for each cached file)
)