mirror of
https://github.com/phpbb/phpbb.git
synced 2025-06-09 12:58:52 +00:00
106 lines
2.6 KiB
PHP
106 lines
2.6 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
* @package migration
|
|
* @copyright (c) 2012 phpBB Group
|
|
* @license http://opensource.org/licenses/gpl-license.php GNU Public License v2
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* Migration config tool
|
|
*
|
|
* @package db
|
|
*/
|
|
class phpbb_db_migration_tool_config implements phpbb_db_migration_tool_interface
|
|
{
|
|
/** @var phpbb_config */
|
|
protected $config;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param phpbb_config $config
|
|
*/
|
|
public function __construct(phpbb_config $config)
|
|
{
|
|
$this->config = $config;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function get_name()
|
|
{
|
|
return 'config';
|
|
}
|
|
|
|
/**
|
|
* Add a config setting.
|
|
*
|
|
* @param string $config_name The name of the config setting you would like to add
|
|
* @param mixed $config_value The value of the config setting
|
|
* @param bool $is_dynamic True if it is dynamic (changes very often) and should not be stored in the cache, false if not.
|
|
* @return null
|
|
*/
|
|
public function add($config_name, $config_value = '', $is_dynamic = false)
|
|
{
|
|
if (isset($this->config[$config_name]))
|
|
{
|
|
throw new phpbb_db_migration_exception('CONFIG_ALREADY_EXISTS', $config_name);
|
|
}
|
|
|
|
$this->config->set($config_name, $config_value, !$is_dynamic);
|
|
}
|
|
|
|
/**
|
|
* Update an existing config setting.
|
|
*
|
|
* @param string $config_name The name of the config setting you would like to update
|
|
* @param mixed $config_value The value of the config setting
|
|
* @return null
|
|
*/
|
|
public function update($config_name, $config_value = '')
|
|
{
|
|
if (!isset($this->config[$config_name]))
|
|
{
|
|
throw new phpbb_db_migration_exception('CONFIG_NOT_EXIST', $config_name);
|
|
}
|
|
|
|
$this->config->set($config_name, $config_value);
|
|
}
|
|
|
|
/**
|
|
* Update a config setting if the first argument equal to the current config value
|
|
*
|
|
* @param bool $compare If equal to the current config value, will be updated to the new config value, otherwise not
|
|
* @param string $config_name The name of the config setting you would like to update
|
|
* @param mixed $config_value The value of the config setting
|
|
* @return null
|
|
*/
|
|
public function update_if_equals($compare, $config_name, $config_value = '')
|
|
{
|
|
if (!isset($this->config[$config_name]))
|
|
{
|
|
throw new phpbb_db_migration_exception('CONFIG_NOT_EXIST', $config_name);
|
|
}
|
|
|
|
$this->config->set_atomic($config_name, $compare, $config_value);
|
|
}
|
|
|
|
/**
|
|
* Remove an existing config setting.
|
|
*
|
|
* @param string $config_name The name of the config setting you would like to remove
|
|
* @return null
|
|
*/
|
|
public function remove($config_name)
|
|
{
|
|
if (!isset($this->config[$config_name]))
|
|
{
|
|
throw new phpbb_db_migration_exception('CONFIG_NOT_EXIST', $config_name);
|
|
}
|
|
|
|
$this->config->delete($config_name);
|
|
}
|
|
}
|