[ Index ]

PHP Cross Reference of phpBB-3.3.2-deutsch

title

Body

[close]

/phpbb/config/ -> config.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 186 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

config:: (12 methods):
  __construct()
  getIterator()
  offsetExists()
  offsetGet()
  offsetSet()
  offsetUnset()
  count()
  delete()
  set()
  set_atomic()
  ensure_lock()
  increment()


Class: config  - X-Ref

Configuration container class

__construct(array $config)   X-Ref
Creates a configuration container with a default set of values

param: array<string,string> $config The configuration data.

getIterator()   X-Ref
Retrieves an ArrayIterator over the configuration values.

return: \ArrayIterator An iterator over all config data

offsetExists($key)   X-Ref
Checks if the specified config value exists.

param: string $key The configuration option's name.
return: bool        Whether the configuration option exists.

offsetGet($key)   X-Ref
Retrieves a configuration value.

param: string $key The configuration option's name.
return: string      The configuration value

offsetSet($key, $value)   X-Ref
Temporarily overwrites the value of a configuration variable.

The configuration change will not persist. It will be lost
after the request.

param: string $key   The configuration option's name.
param: string $value The temporary value.

offsetUnset($key)   X-Ref
Called when deleting a configuration value directly, triggers an error.

param: string $key The configuration option's name.

count()   X-Ref
Retrieves the number of configuration options currently set.

return: int Number of config options

delete($key, $use_cache = true)   X-Ref
Removes a configuration option

param: String $key       The configuration option's name
param: bool   $use_cache Whether this variable should be cached or if it
return: null

set($key, $value, $use_cache = true)   X-Ref
Sets a configuration option's value

param: string $key       The configuration option's name
param: string $value     New configuration value
param: bool   $use_cache Whether this variable should be cached or if it

set_atomic($key, $old_value, $new_value, $use_cache = true)   X-Ref
Sets a configuration option's value only if the old_value matches the
current configuration value or the configuration value does not exist yet.

param: string $key       The configuration option's name
param: string $old_value Current configuration value
param: string $new_value New configuration value
param: bool   $use_cache Whether this variable should be cached or if it
return: bool              True if the value was changed, false otherwise.

ensure_lock($key, $new_value)   X-Ref
Checks configuration option's value only if the new_value matches the
current configuration value and the configuration value does exist.Called
only after set_atomic has been called.

param: string $key       The configuration option's name
param: string $new_value New configuration value
return: bool              True if the value was changed, false otherwise.

increment($key, $increment, $use_cache = true)   X-Ref
Increments an integer configuration value.

param: string $key       The configuration option's name
param: int    $increment Amount to increment by
param: bool   $use_cache Whether this variable should be cached or if it



Generated: Wed Nov 11 20:28:18 2020 Cross-referenced by PHPXref 0.7.1