Ref/apcu-Phpdoc专题

apcu_add

Cache a new variable in the data store

说明

bool apcu_add ( string $key , mixed $var [, int $ttl = 0 ] )

array apcu_add ( array $values [, mixed $unused = NULL [, int $ttl = 0 ]] )

Caches a variable in the data store, only if it's not already stored.

Note: Unlike many other mechanisms in PHP, variables stored using apcu_add will persist between requests (until the value is removed from the cache).

参数

key
Store the variable using this name. keys are cache-unique, so attempting to use apcu_add to store data with a key that already exists will not overwrite the existing data, and will instead return false. (This is the only difference between apcu_add and apcu_store.)

var
The variable to store

ttl
Time To Live; store var in the cache for ttl seconds. After the ttl has passed, the stored variable will be expunged from the cache (on the next request). If no ttl is supplied (or if the ttl is 0), the value will persist until it is removed from the cache manually, or otherwise fails to exist in the cache (clear, restart, etc.).

values
Names in key, variables in value.

返回值

Returns TRUE if something has effectively been added into the cache, FALSE otherwise. Second syntax returns array with error keys.

范例

示例 #1 A apcu_add example

<?php
$bar = 'BAR';
apcu_add('foo', $bar);
var_dump(apcu_fetch('foo'));
echo "\n";
$bar = 'NEVER GETS SET';
apcu_add('foo', $bar);
var_dump(apcu_fetch('foo'));
echo "\n";
?>

以上例程会输出：

string(3) "BAR"
string(3) "BAR"

参见

apcu_store
apcu_fetch
apcu_delete

apcu_cache_info

Retrieves cached information from APCu's data store

说明

arrayfalse apcu_cache_info ([ bool $limited = false ] )

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

参数

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.

返回值

Array of cached data (and meta-data) 或者在失败时返回 false

Note: apcu_cache_info will raise a warning if it is unable to retrieve APC cache data. This typically occurs when APC is not enabled.

更新日志

版本	说明
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.

范例

示例 #1 A apcu_cache_info example

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

以上例程的输出类似于：

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)
)

参见

APCu configuration directives
APCUIterator::getTotalSize
APCUIterator::getTotalHits
APCUIterator::getTotalCount

apcu_cas

Updates an old value with a new value

说明

bool apcu_cas ( string $key , int $old , int $new )

apcu_cas updates an already existing integer value if the old parameter matches the currently stored value with the value of the new parameter.

参数

key
The key of the value being updated.

old
The old value (the value currently stored).

new
The new value to update to.

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 apcu_cas example

<?php
apcu_store('foobar', 2);
echo '$foobar = 2', PHP_EOL;
echo '$foobar == 1 ? 2 : 1 = ', (apcu_cas('foobar', 1, 2) ? 'ok' : 'fail'), PHP_EOL;
echo '$foobar == 2 ? 1 : 2 = ', (apcu_cas('foobar', 2, 1) ? 'ok' : 'fail'), PHP_EOL;

echo '$foobar = ', apcu_fetch('foobar'), PHP_EOL;

echo '$f__bar == 1 ? 2 : 1 = ', (apcu_cas('f__bar', 1, 2) ? 'ok' : 'fail'), PHP_EOL;

apcu_store('perfection', 'xyz');
echo '$perfection == 2 ? 1 : 2 = ', (apcu_cas('perfection', 2, 1) ? 'ok' : 'epic fail'), PHP_EOL;

echo '$foobar = ', apcu_fetch('foobar'), PHP_EOL;
?>

以上例程的输出类似于：

$foobar = 2
$foobar == 1 ? 2 : 1 = fail
$foobar == 2 ? 1 : 2 = ok
$foobar = 1
$f__bar == 1 ? 2 : 1 = fail
$perfection == 2 ? 1 : 2 = epic fail
$foobar = 1

参见

apcu_dec
apcu_store

apcu_clear_cache

Clears the APCu cache

说明

bool apcu_clear_cache ( void )

Clears the cache.

参数

此函数没有参数。

返回值

Returns true always

参见

apcu_cache_info

apcu_dec

Decrease a stored number

说明

intfalse apcu_dec ( string $key [, int $step = 1 [, bool &$success [, int $ttl = 0 ]]] )

Decreases a stored integer value.

参数

key
The key of the value being decreased.

step
The step, or value to decrease.

success
Optionally pass the success or fail boolean value to this referenced variable.

ttl
TTL to use if the operation inserts a new value (rather than decrementing an existing one).

返回值

Returns the current value of key's value on success, 或者在失败时返回 false

更新日志

版本	说明
5.1.12	The `ttl` parameter has been added.

范例

示例 #1 apcu_dec example

<?php
echo "Let's do something with success", PHP_EOL;

apcu_store('anumber', 42);

echo apcu_fetch('anumber'), PHP_EOL;

echo apcu_dec('anumber'), PHP_EOL;
echo apcu_dec('anumber', 10), PHP_EOL;
echo apcu_dec('anumber', 10, $success), PHP_EOL;

var_dump($success);

echo "Now, let's fail", PHP_EOL, PHP_EOL;

apcu_store('astring', 'foo');

$ret = apcu_dec('astring', 1, $fail);

var_dump($ret);
var_dump($fail);
?>

以上例程的输出类似于：

Let's do something with success
42
41
31
21
bool(true)
Now, let's fail

bool(false)
bool(false)

参见

apcu_inc

apcu_delete

Removes a stored variable from the cache

说明

mixed apcu_delete ( mixed $key )

Removes a stored variable from the cache.

参数

key
A key used to store the value as a string for a single key, or as an array of strings for several keys, or as an APCUIterator object.

返回值

If key is an array, an indexed array of the keys is returned. Otherwise true is returned on success, or false on failure.

范例

示例 #1 A apcu_delete example

<?php
$bar = 'BAR';
apcu_store('foo', $bar);
apcu_delete('foo');
// this is obviously useless in this form

// Alternatively delete multiple keys.
apcu_delete(['foo', 'bar', 'baz']);

// Or use an Iterator with a regular expression.
apcu_delete(new APCUIterator('#^myprefix_#'));
?>

参见

apcu_store
apcu_fetch
apcu_clear_cache
APCUIterator

apcu_enabled

Whether APCu is usable in the current environment

说明

bool apcu_enabled ( void )

Returns whether APCu is usable in the current environment.

参数

此函数没有参数。

返回值

Returns true when APCu is usable in the current environment, false otherwise.

apcu_entry

Atomically fetch or generate a cache entry

说明

mixed apcu_entry ( string $key , callable $generator [, int $ttl = 0 ] )

Atomically attempts to find key in the cache, if it cannot be found generator is called, passing key as the only argument. The return value of the call is then cached with the optionally specified ttl, and returned.

Note: When control enters apcu_entry the lock for the cache is acquired exclusively, it is released when control leaves apcu_entry: In effect, this turns the body of generator into a critical section, disallowing two processes from executing the same code paths concurrently. In addition, it prohibits the concurrent execution of any other APCu functions, since they will acquire the same lock.

Warning

The only APCu function that can be called safely by generator is apcu_entry.

参数

key
Identity of cache entry

generator
A callable that accepts key as the only argument and returns the value to cache.

返回值

Returns the cached value

范例

示例 #1 An apcu_entry example

<?php
$config = apcu_entry("config", function($key) {
 return [
   "fruit" => apcu_entry("config.fruit", function($key){
     return [
       "apples",
       "pears"
     ];
   }), 
   "people" => apcu_entry("config.people", function($key){
     return [
      "bob",
      "joe",
      "niki"
     ];
   })
 ];
});

var_dump($config);
?>

以上例程会输出：

array(2) {
  ["fruit"]=>
  array(2) {
    [0]=>
    string(6) "apples"
    [1]=>
    string(5) "pears"
  }
  ["people"]=>
  array(3) {
    [0]=>
    string(3) "bob"
    [1]=>
    string(3) "joe"
    [2]=>
    string(4) "niki"
  }
}

参见

apcu_store
apcu_fetch
apcu_delete

apcu_exists

Checks if entry exists

说明

mixed apcu_exists ( mixed $keys )

Checks if one or more APCu entries exist.

参数

keys
A string, or an array of strings, that contain keys.

返回值

Returns true if the key exists, otherwise false Or if an array was passed to keys, then an array is returned that contains all existing keys, or an empty array if none exist.

范例

示例 #1 apcu_exists example

<?php
$fruit  = 'apple';
$veggie = 'carrot';

apcu_store('foo', $fruit);
apcu_store('bar', $veggie);

if (apcu_exists('foo')) {
    echo "Foo exists: ";
    echo apcu_fetch('foo');
} else {
    echo "Foo does not exist";
}

echo PHP_EOL;
if (apcu_exists('baz')) {
    echo "Baz exists.";
} else {
    echo "Baz does not exist";
}

echo PHP_EOL;

$ret = apcu_exists(array('foo', 'donotexist', 'bar'));
var_dump($ret);

?>

以上例程的输出类似于：

Foo exists: apple
Baz does not exist
array(2) {
  ["foo"]=>
  bool(true)
  ["bar"]=>
  bool(true)
}

参见

apcu_cache_info
apcu_fetch

apcu_fetch

Fetch a stored variable from the cache

说明

mixed apcu_fetch ( mixed $key [, bool &$success ] )

Fetches an entry from the cache.

参数

key
The key used to store the value (with apcu_store). If an array is passed then each element is fetched and returned.

success
Set to true in success and false in failure.

返回值

The stored variable or array of variables on success; false on failure

范例

示例 #1 A apcu_fetch example

<?php
$bar = 'BAR';
apcu_store('foo', $bar);
var_dump(apcu_fetch('foo'));
?>

以上例程会输出：

string(3) "BAR"

更新日志

版本	说明
PECL apcu 3.0.17	The `success` parameter was added.

参见

apcu_store
apcu_delete
APCUIterator

apcu_inc

Increase a stored number

说明

intfalse apcu_inc ( string $key [, int $step = 1 [, bool &$success [, int $ttl = 0 ]]] )

Increases a stored number.

参数

key
The key of the value being increased.

step
The step, or value to increase.

success
Optionally pass the success or fail boolean value to this referenced variable.

ttl
TTL to use if the operation inserts a new value (rather than incrementing an existing one).

返回值

Returns the current value of key's value on success, 或者在失败时返回 false

更新日志

版本	说明
5.1.12	The `ttl` parameter has been added.

范例

示例 #1 apcu_inc example

<?php
echo "Let's do something with success", PHP_EOL;

apcu_store('anumber', 42);

echo apcu_fetch('anumber'), PHP_EOL;

echo apcu_inc('anumber'), PHP_EOL;
echo apcu_inc('anumber', 10), PHP_EOL;
echo apcu_inc('anumber', 10, $success), PHP_EOL;

var_dump($success);

echo "Now, let's fail", PHP_EOL, PHP_EOL;

apcu_store('astring', 'foo');

$ret = apcu_inc('astring', 1, $fail);

var_dump($ret);
var_dump($fail);
?>

以上例程的输出类似于：

Let's do something with success
42
43
53
63
bool(true)
Now, let's fail

bool(false)
bool(false)

参见

apcu_dec

apcu_key_info

Get detailed information about the cache key

说明

array apcu_key_info ( string $key )

Get detailed information about the cache key

参数

key
Get detailed information about the cache key

返回值

null or array info

范例

示例 #1 A apcu_key_info example

<?php
apcu_add('a','b');
var_dump(apcu_key_info('a'));
?>

以上例程会输出：

array(7) {
  ["hits"]=>
  int(0)
  ["access_time"]=>
  int(1606701783)
  ["mtime"]=>
  int(1606701783)
  ["creation_time"]=>
  int(1606701783)
  ["deletion_time"]=>
  int(0)
  ["ttl"]=>
  int(0)
  ["refs"]=>
  int(0)
}

参见

apcu_store
apcu_fetch
apcu_delete

apcu_sma_info

Retrieves APCu Shared Memory Allocation information

说明

array apcu_sma_info ([ bool $limited = false ] )

Retrieves APCu Shared Memory Allocation information.

参数

limited
When set to false (default) apcu_sma_info will return a detailed information about each segment.

返回值

Array of Shared Memory Allocation data; false on failure.

范例

示例 #1 A apcu_sma_info example

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

以上例程的输出类似于：

Array
(
    [num_seg] => 1
    [seg_size] => 31457280
    [avail_mem] => 31448408
    [block_lists] => Array
        (
            [0] => Array
                (
                    [0] => Array
                        (
                            [size] => 31448408
                            [offset] => 8864
                        )

                )

        )

)

参见

APCu configuration directives

apcu_store

Cache a variable in the data store

说明

bool apcu_store ( string $key , mixed $var [, int $ttl = 0 ] )

array apcu_store ( array $values [, mixed $unused = NULL [, int $ttl = 0 ]] )

Cache a variable in the data store.

Note: Unlike many other mechanisms in PHP, variables stored using apcu_store will persist between requests (until the value is removed from the cache).

参数

key
Store the variable using this name. keys are cache-unique, so storing a second value with the same key will overwrite the original value.

var
The variable to store

values
Names in key, variables in value.

返回值

成功时返回 true，或者在失败时返回 false。 Second syntax returns array with error keys.

范例

示例 #1 A apcu_store example

<?php
$bar = 'BAR';
apcu_store('foo', $bar);
var_dump(apcu_fetch('foo'));
?>

以上例程会输出：

string(3) "BAR"

参见

apcu_add
apcu_fetch
apcu_delete

apcu_add — Cache a new variable in the data store
apcu_cache_info — Retrieves cached information from APCu's data store
apcu_cas — Updates an old value with a new value
apcu_clear_cache — Clears the APCu cache
apcu_dec — Decrease a stored number
apcu_delete — Removes a stored variable from the cache
apcu_enabled — Whether APCu is usable in the current environment
apcu_entry — Atomically fetch or generate a cache entry
apcu_exists — Checks if entry exists
apcu_fetch — Fetch a stored variable from the cache
apcu_inc — Increase a stored number
apcu_key_info — Get detailed information about the cache key
apcu_sma_info — Retrieves APCu Shared Memory Allocation information
apcu_store — Cache a variable in the data store