1
0
mirror of https://github.com/phpbb/phpbb.git synced 2025-03-14 12:40:13 +01:00

[ticket/13700] Add docblock and clean up code

PHPBB3-13700
This commit is contained in:
Marc Alexander 2021-05-03 20:03:53 +02:00
parent 574de287e7
commit 9c8f2007d9
No known key found for this signature in database
GPG Key ID: 50E0D2423696F995

View File

@ -13,20 +13,23 @@
namespace phpbb\config; namespace phpbb\config;
use phpbb\cache\driver\driver_interface as cache_interface;
use phpbb\db\driver\driver_interface as db_interface;
/** /**
* Configuration container class * Configuration container class
*/ */
class db extends \phpbb\config\config class db extends config
{ {
/** /**
* Cache instance * Cache instance
* @var \phpbb\cache\driver\driver_interface * @var cache_interface
*/ */
protected $cache; protected $cache;
/** /**
* Database connection * Database connection
* @var \phpbb\db\driver\driver_interface * @var db_interface
*/ */
protected $db; protected $db;
@ -39,11 +42,11 @@ class db extends \phpbb\config\config
/** /**
* Creates a configuration container with a default set of values * Creates a configuration container with a default set of values
* *
* @param \phpbb\db\driver\driver_interface $db Database connection * @param db_interface $db Database connection
* @param \phpbb\cache\driver\driver_interface $cache Cache instance * @param cache_interface $cache Cache instance
* @param string $table Configuration table name * @param string $table Configuration table name
*/ */
public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\cache\driver\driver_interface $cache, $table) public function __construct(db_interface $db, cache_interface $cache, $table)
{ {
$this->db = $db; $this->db = $db;
$this->cache = $cache; $this->cache = $cache;
@ -54,7 +57,12 @@ class db extends \phpbb\config\config
parent::__construct($this->config); parent::__construct($this->config);
} }
public function initialise(\phpbb\cache\driver\driver_interface $cache) /**
* Initialise config with database and/or cached entries
*
* @param cache_interface $cache
*/
public function initialise(cache_interface $cache)
{ {
if (($config = $cache->get('config')) !== false) if (($config = $cache->get('config')) !== false)
{ {
@ -100,7 +108,7 @@ class db extends \phpbb\config\config
* @param String $key The configuration option's name * @param String $key The configuration option's name
* @param bool $use_cache Whether this variable should be cached or if it * @param bool $use_cache Whether this variable should be cached or if it
* changes too frequently to be efficiently cached * changes too frequently to be efficiently cached
* @return null * @return void
*/ */
public function delete($key, $use_cache = true) public function delete($key, $use_cache = true)
{ {