PHPXRef 0.7.1 : phpBB-3.3.14-deutsch : Detail view of db.php

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:	219 lines (6 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

db:: (6 methods):
  __construct()
  initialise()
  delete()
  set()
  set_atomic()
  increment()

Class: db - X-Ref

Configuration container class

__construct(db_interface $db, cache_interface $cache, $table) X-Ref

Creates a configuration container with a default set of values

param: db_interface $db Database connection
param: cache_interface $cache Cache instance
param: string $table Configuration table name

initialise(cache_interface $cache) X-Ref

Initialise config with database and/or cached entries

param: cache_interface $cache

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: void

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: mixed  $old_value Current configuration value or false to ignore
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

increment($key, $increment, $use_cache = true) X-Ref

Increments an integer config value directly in the database.

Using this method instead of setting the new value directly avoids race
conditions and unlike set_atomic it cannot fail.

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

PHP Cross Reference of phpBB-3.3.14-deutsch

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

Defines 1 class