×

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_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
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
PHP / apcu_sma_info — DevDocs

apcu_sma_info

(PECL apcu >= 4.0.0)

apcu_sma_info Retrieves APCu Shared Memory Allocation information

Description

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

Retrieves APCu Shared Memory Allocation information.

Parameters

limited

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

Return Values

Array of Shared Memory Allocation data; false on failure.

Examples

Example #1 A apcu_sma_info() example

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

The above example will output something similar to:

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

                )

        )

)

See Also

  • APCu configuration directives
Read article
PHP / apcu_store — DevDocs

apcu_store

(PECL apcu >= 4.0.0)

apcu_store Cache a variable in the data store

Description

apcu_store(string $key, mixed $var, int $ttl = 0): bool
apcu_store(array $values, mixed $unused = NULL, int $ttl = 0): array

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

Parameters

key

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

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.

Return Values

Returns true on success or false on failure. Second syntax returns array with error keys.

Examples

Example #1 A apcu_store() example

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

The above example will output:

string(3) "BAR"

See Also

  • apcu_add() - Cache a new 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 / APCUIterator (class) — DevDocs

The APCUIterator class

Introduction

(PECL apcu >= 5.0.0)

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 __construct (
array | string | null $search = null ,
int $format = APC_ITER_ALL ,
int $chunk_size = 100 ,
int $list = APC_LIST_ACTIVE
)
public current(): mixed
public getTotalCount(): int
public getTotalHits(): int
public getTotalSize(): int
public key(): string
public next(): bool
public rewind(): void
public valid(): bool
}

Table of Contents

  • 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
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!