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 / apache_note — DevDocs

apache_note

(PHP 4, PHP 5, PHP 7, PHP 8)

apache_note Get and set apache request notes

Description

apache_note(string $note_name, ?string $note_value = null): string|false

This function is a wrapper for Apache's table_get and table_set . It edits the table of notes that exists during a request. The table's purpose is to allow Apache modules to communicate.

The main use for apache_note() is to pass information from one module to another within the same request.

Parameters

note_name

The name of the note.

note_value

The value of the note.

Return Values

If note_value is omitted or null , it returns the current value of note note_name . Otherwise, it sets the value of note note_name to note_value and returns the previous value of note note_name . If the note cannot be retrieved, false is returned.

Changelog

Version Description
8.0.0 note_value is nullable now.

Examples

Example #1 Passing information between PHP and Perl

<?php

apache_note('name', 'Fredrik Ekengren');

// Call perl script
virtual("/perl/some_script.pl");

$result = apache_note("resultdata");
?>
# Get Apache request object
my $r = Apache->request()->main();

# Get passed data
my $name = $r->notes('name');

# some processing

# Pass result back to PHP
$r->notes('resultdata', $result);

Example #2 Logging values in access.log

<?php

apache_note('sessionID', session_id());

?>
# "%{sessionID}n" can be used in the LogFormat directive

See Also

  • virtual() - Perform an Apache sub-request

PHP / apcu_clear_cache — DevDocs

apcu_clear_cache

(PECL apcu >= 4.0.0)

apcu_clear_cache Clears the APCu cache

Description

apcu_clear_cache(): bool

Clears the cache.

Parameters

This function has no parameters.

Return Values

Returns true always

See Also

  • apcu_cache_info() - Retrieves cached information from APCu's data store
Read article

PHP / apcu_dec — DevDocs

apcu_dec

(PECL apcu >= 4.0.0)

apcu_dec Decrease a stored number

Description

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

Decreases a stored integer value.

Parameters

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

Return Values

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

Examples

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

The above example will output something similar to:

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

bool(false)
bool(false)

See Also

  • apcu_inc() - Increase a stored number
Read article

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.

Read article

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