×

Welcome to Knowledge Base!

KB at your finger tips

This is one stop global knowledge base where you can learn about all the products, solutions and support features.

Categories
All
Web-PHP
PHP / apcu_enabled — DevDocs

apcu_enabled

(PECL apcu >= 4.0.3)

apcu_enabled Whether APCu is usable in the current environment

Description

apcu_enabled(): bool

Returns whether APCu is usable in the current environment.

Parameters

This function has no parameters.

Return Values

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

PHP / apcu_entry — DevDocs

apcu_entry

(PECL apcu >= 5.1.0)

apcu_entry Atomically fetch or generate a cache entry

Description

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

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

Parameters

key

Identity of cache entry

generator

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

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

Return Values

Returns the cached value

Examples

Example #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);
?>

The above example will output:

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"
  }
}

See Also

  • apcu_store() - Cache a variable in the data store
  • apcu_fetch() - Fetch a stored variable from the cache
  • apcu_delete() - Removes a stored variable from the cache
Read article
PHP / apcu_exists — DevDocs

apcu_exists

(PECL apcu >= 4.0.0)

apcu_exists Checks if entry exists

Description

apcu_exists(mixed $keys): mixed

Checks if one or more APCu entries exist.

Parameters

keys

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

Return Values

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.

Examples

Example #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);

?>

The above example will output something similar to:

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

See Also

  • apcu_cache_info() - Retrieves cached information from APCu's data store
  • apcu_fetch() - Fetch a stored variable from the cache
Read article
PHP / apcu_fetch — DevDocs

apcu_fetch

(PECL apcu >= 4.0.0)

apcu_fetch Fetch a stored variable from the cache

Description

apcu_fetch(mixed $key, bool &$success = ?): mixed

Fetches an entry from the cache.

Parameters

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.

Return Values

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

Changelog

Version Description
PECL apcu 3.0.17 The success parameter was added.

Examples

Example #1 A apcu_fetch() example

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

The above example will output:

string(3) "BAR"

See Also

  • apcu_store() - Cache a variable in the data store
  • apcu_delete() - Removes a stored variable from the cache
  • APCUIterator
Read article
PHP / apcu_inc — DevDocs

apcu_inc

(PECL apcu >= 4.0.0)

apcu_inc Increase a stored number

Description

apcu_inc(
 string $key,
 int $step = 1,
 bool &$success = ?,
 int $ttl = 0
): int|false

Increases a stored number.

Parameters

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

Return Values

Returns the current value of key 's value on success, or false on failure

Examples

Example #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);
?>

The above example will output something similar to:

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

bool(false)
bool(false)

See Also

  • apcu_dec() - Decrease a stored number
Read article
PHP / apcu_key_info — DevDocs

apcu_key_info

(No version information available, might only be in Git)

apcu_key_info Get detailed information about the cache key

Description

apcu_key_info(string $key): ?array

Get detailed information about the cache key

Parameters

key

Get detailed information about the cache key

Return Values

An array containing the detailed information about the cache key, or null if the key does not exist.

Examples

Example #1 A apcu_key_info() example

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

The above example will output:

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

See Also

  • apcu_store() - Cache a variable in the data store
  • apcu_fetch() - Fetch a stored variable from the cache
  • apcu_delete() - Removes a stored variable from the cache
Read article

Still Thinking?
Give us a try!

We embrace agility in everything we do.
Our onboarding process is both simple and meaningful.
We can't wait to welcome you on AiDOOS!