Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
83.33% covered (warning)
83.33%
10 / 12
 CRAP
92.00% covered (success)
92.00%
23 / 25
config
0.00% covered (danger)
0.00%
0 / 1
83.33% covered (warning)
83.33%
10 / 12
 18.17
92.00% covered (success)
92.00%
23 / 25
 __construct
100.00% covered (success)
100.00%
1 / 1
 1
100.00% covered (success)
100.00%
2 / 2
 getIterator
100.00% covered (success)
100.00%
1 / 1
 1
100.00% covered (success)
100.00%
1 / 1
 offsetExists
100.00% covered (success)
100.00%
1 / 1
 1
100.00% covered (success)
100.00%
1 / 1
 offsetGet
100.00% covered (success)
100.00%
1 / 1
 2
100.00% covered (success)
100.00%
1 / 1
 offsetSet
100.00% covered (success)
100.00%
1 / 1
 1
100.00% covered (success)
100.00%
2 / 2
 offsetUnset
0.00% covered (danger)
0.00%
0 / 1
 1.12
50.00% covered (danger)
50.00%
1 / 2
 count
100.00% covered (success)
100.00%
1 / 1
 1
100.00% covered (success)
100.00%
1 / 1
 delete
100.00% covered (success)
100.00%
1 / 1
 1
100.00% covered (success)
100.00%
2 / 2
 set
100.00% covered (success)
100.00%
1 / 1
 1
100.00% covered (success)
100.00%
2 / 2
 set_atomic
100.00% covered (success)
100.00%
1 / 1
 3
100.00% covered (success)
100.00%
4 / 4
 ensure_lock
0.00% covered (danger)
0.00%
0 / 1
 3.33
66.67% covered (warning)
66.67%
2 / 3
 increment
100.00% covered (success)
100.00%
1 / 1
 2
100.00% covered (success)
100.00%
4 / 4
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\config;
/**
* Configuration container class
*/
class config implements \ArrayAccess, \IteratorAggregate, \Countable
{
    /**
    * The configuration data
    * @var array<string,string>
    */
    protected $config;
    /**
    * Creates a configuration container with a default set of values
    *
    * @param array<string,string> $config The configuration data.
    */
    public function __construct(array $config)
    {
        $this->config = $config;
    }
    /**
    * Retrieves an ArrayIterator over the configuration values.
    *
    * @return \ArrayIterator An iterator over all config data
    */
    public function getIterator()
    {
        return new \ArrayIterator($this->config);
    }
    /**
    * Checks if the specified config value exists.
    *
    * @param  string $key The configuration option's name.
    * @return bool        Whether the configuration option exists.
    */
    #[\ReturnTypeWillChange]
    public function offsetExists($key)
    {
        return isset($this->config[$key]);
    }
    /**
    * Retrieves a configuration value.
    *
    * @param  string $key The configuration option's name.
    * @return string      The configuration value
    */
    #[\ReturnTypeWillChange]
    public function offsetGet($key)
    {
        return (isset($this->config[$key])) ? $this->config[$key] : '';
    }
    /**
    * 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.
    */
    #[\ReturnTypeWillChange]
    public function offsetSet($key, $value)
    {
        $this->config[$key] = $value;
    }
    /**
    * Called when deleting a configuration value directly, triggers an error.
    *
    * @param string $key The configuration option's name.
    */
    #[\ReturnTypeWillChange]
    public function offsetUnset($key)
    {
        trigger_error('Config values have to be deleted explicitly with the \phpbb\config\config::delete($key) method.', E_USER_ERROR);
    }
    /**
    * Retrieves the number of configuration options currently set.
    *
    * @return int Number of config options
    */
    public function count()
    {
        return count($this->config);
    }
    /**
    * 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
    *                           changes too frequently to be efficiently cached
    * @return null
    */
    public function delete($key, $use_cache = true)
    {
        unset($this->config[$key]);
    }
    /**
    * 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
    *                          changes too frequently to be efficiently cached.
    */
    public function set($key, $value, $use_cache = true)
    {
        $this->config[$key] = $value;
    }
    /**
    * 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
    *                           changes too frequently to be efficiently cached.
    * @return bool              True if the value was changed, false otherwise.
    */
    public function set_atomic($key, $old_value, $new_value, $use_cache = true)
    {
        if (!isset($this->config[$key]) || $this->config[$key] == $old_value)
        {
            $this->config[$key] = $new_value;
            return true;
        }
        return false;
    }
    /**
    * 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
    * @throws \phpbb\exception\http_exception when config value is set and not equal to new_value.
    * @return bool              True if the value was changed, false otherwise.
    */
    public function ensure_lock($key, $new_value)
    {
        if (isset($this->config[$key]) && $this->config[$key] == $new_value)
        {
            return true;
        }
        throw new \phpbb\exception\http_exception(500, 'Failure while aqcuiring locks.');
    }
    /**
    * 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
    *                          changes too frequently to be efficiently cached.
    */
    function increment($key, $increment, $use_cache = true)
    {
        if (!isset($this->config[$key]))
        {
            $this->config[$key] = 0;
        }
        $this->config[$key] += $increment;
    }
}