diff options
| author | Nathan Guse <nathaniel.guse@gmail.com> | 2013-01-08 22:07:12 -0600 |
|---|---|---|
| committer | Nathan Guse <nathaniel.guse@gmail.com> | 2013-01-09 16:42:47 -0600 |
| commit | 82efb3e446efbb8ef05c6a777e3866901abfd07a (patch) | |
| tree | 52437390f467f5ac84b712787a1dde8ca87c2887 /phpBB/includes/db/migration/tools/config.php | |
| parent | 91a921a96bf26607879de850fca105be78eadf1d (diff) | |
| download | forums-82efb3e446efbb8ef05c6a777e3866901abfd07a.tar forums-82efb3e446efbb8ef05c6a777e3866901abfd07a.tar.gz forums-82efb3e446efbb8ef05c6a777e3866901abfd07a.tar.bz2 forums-82efb3e446efbb8ef05c6a777e3866901abfd07a.tar.xz forums-82efb3e446efbb8ef05c6a777e3866901abfd07a.zip | |
[feature/migrations] Remove references as it is now 3.1 code
PHPBB3-9737
Diffstat (limited to 'phpBB/includes/db/migration/tools/config.php')
| -rw-r--r-- | phpBB/includes/db/migration/tools/config.php | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/phpBB/includes/db/migration/tools/config.php b/phpBB/includes/db/migration/tools/config.php new file mode 100644 index 0000000000..965ba1d136 --- /dev/null +++ b/phpBB/includes/db/migration/tools/config.php @@ -0,0 +1,106 @@ +<?php +/** +* +* @package migration +* @copyright (c) 2012 phpBB Group +* @license http://opensource.org/licenses/gpl-license.php GNU Public License v2 +* +*/ + +class phpbb_db_migration_tools_config extends phpbb_db_migration_tools_base +{ + /** + * Config Exists + * + * This function is to check to see if a config variable exists or if it does not. + * + * @param string $config_name The name of the config setting you wish to check for. + * + * @return bool true/false if config exists + */ + public function exists($config_name) + { + return (bool) $this->config->offsetExists($config_name); + } + + /** + * Config Add + * + * This function allows you to 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. + */ + public function add($config_name, $config_value = '', $is_dynamic = false) + { + if ($this->config_exists($config_name)) + { + throw new phpbb_db_migration_exception('CONFIG_ALREADY_EXISTS', $config_name); + } + + $this->config->set($config_name, $config_value, $is_dynamic); + + return false; + } + + /** + * Config Update + * + * This function allows you to 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 + */ + public function update($config_name, $config_value = '') + { + if (!$this->config_exists($config_name)) + { + throw new phpbb_db_migration_exception('CONFIG_NOT_EXIST', $config_name); + } + + $this->config->set($config_name, $config_value); + + return false; + } + + /** + * Config Update If Equals + * + * This function allows you to 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 + */ + public function update_if_equals($compare, $config_name, $config_value = '') + { + if (!$this->config_exists($config_name)) + { + throw new phpbb_db_migration_exception('CONFIG_NOT_EXIST', $config_name); + } + + $this->config->set_atomic($config_name, $compare, $config_value); + + return false; + } + + /** + * Config Remove + * + * This function allows you to remove an existing config setting. + * + * @param string $config_name The name of the config setting you would like to remove + */ + public function remove($config_name) + { + if (!$this->config_exists($config_name)) + { + throw new phpbb_db_migration_exception('CONFIG_NOT_EXIST', $config_name); + } + + $this->config->delete($config_name); + + return false; + } +}
\ No newline at end of file |