PHP

PHP / virtual — DevDocs

virtual

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

virtual — Perform an Apache sub-request

Description

virtual(string $uri): bool

virtual() is an Apache-specific function which is similar to  in mod_include . It performs an Apache sub-request. It is useful for including CGI scripts or .shtml files, or anything else that you would parse through Apache. Note that for a CGI script, the script must generate valid CGI headers. At the minimum that means it must generate a Content-Type header.

To run the sub-request, all buffers are terminated and flushed to the browser, pending headers are sent too.

This function is supported when PHP is installed as an Apache module webserver.

Parameters

uri: The file that the virtual command will be performed on.

Return Values

Performs the virtual command on success, or returns false on failure.

Examples

See apache_note() for an example.

Notes

Warning

The query string can be passed to the included file but $_GET is copied from the parent script and only $_SERVER['QUERY_STRING'] is filled with the passed query string. The query string may only be passed when using Apache 2. The requested file will not be listed in the Apache access log.

Note :

Environment variables set in the requested file are not visible to the calling script.

Note :

This function may be used on PHP files. However, it is typically better to use include or require for PHP files.

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

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)

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

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

Welcome to Knowledge Base!

KB at your finger tips

PHP

PHP / virtual — DevDocs

virtual

Description

Parameters

Return Values

Examples

Notes

See Also

PHP / apcu_clear_cache — DevDocs

apcu_clear_cache

Description

Parameters

Return Values

See Also

PHP / apcu_dec — DevDocs

apcu_dec

Description

Parameters

Return Values

Examples

See Also

PHP / apcu_enabled — DevDocs

apcu_enabled

Description

Parameters

Return Values

PHP / apcu_entry — DevDocs

apcu_entry

Description

Parameters

Return Values

Examples

See Also

PHP / apcu_exists — DevDocs

apcu_exists

Description

Parameters

Return Values

Examples

See Also