×

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_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
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
PHP / APCUIterator::__construct — DevDocs

APCUIterator::__construct

(PECL apcu >= 5.0.0)

APCUIterator::__construct Constructs an APCUIterator iterator object

Description

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

Constructs an APCUIterator object .

Parameters

search

Either a PCRE regular expression that matches against APCu key names, given as a string . Or an array of string s with APCu key names. Or, optionally null to skip the search.

format

The desired format, as configured with one or more of the APC_ITER_* constants.

chunk_size

The chunk size. Must be a value greater than 0. The default value is 100.

list

The type to list. Either pass in APC_LIST_ACTIVE or APC_LIST_DELETED .

Examples

Example #1 A APCUIterator::__construct() example

<?php
foreach (new APCUIterator('/^counter\./') as $counter) {
    echo "$counter[key]: $counter[value]\n";
    apc_dec($counter['key'], $counter['value']);
}
?>

See Also

  • apcu_exists() - Checks if entry exists
  • apcu_cache_info() - Retrieves cached information from APCu's data store
Read article
PHP / APCUIterator::current — DevDocs

APCUIterator::current

(PECL apcu >= 5.0.0)

APCUIterator::current Get current item

Description

public APCUIterator::current(): mixed

Gets the current item from the APCUIterator stack.

Parameters

This function has no parameters.

Return Values

Returns the current item on success, or false if no more items or exist, or on failure.

See Also

  • APCUIterator::next() - Move pointer to next item
  • Iterator::current() - Return the current element
Read article
PHP / APCUIterator::getTotalCount — DevDocs

APCUIterator::getTotalCount

(PECL apcu >= 5.0.0)

APCUIterator::getTotalCount Get total count

Description

public APCUIterator::getTotalCount(): int

Get the total count.

Warning

This function is currently not documented; only its argument list is available.

Parameters

This function has no parameters.

Return Values

The total count.

See Also

  • APCUIterator::getTotalHits() - Get total cache hits
  • APCUIterator::getTotalSize() - Get total cache size
  • apcu_cache_info() - Retrieves cached information from APCu's data store
Read article
PHP / APCUIterator::getTotalHits — DevDocs

APCUIterator::getTotalHits

(PECL apcu >= 5.0.0)

APCUIterator::getTotalHits Get total cache hits

Description

public APCUIterator::getTotalHits(): int

Gets the total number of cache hits.

Warning

This function is currently not documented; only its argument list is available.

Parameters

This function has no parameters.

Return Values

The number of hits on success, or false on failure.

See Also

  • APCUIterator::getTotalCount() - Get total count
  • APCUIterator::getTotalSize() - Get total cache size
  • apcu_cache_info() - Retrieves cached information from APCu's data store
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!