mirror of
https://github.com/Icinga/icingaweb2.git
synced 2025-10-17 21:50:09 +02:00
db3accc704
Class names in namespaces should not be chosen as once we didn't have such. The fact that we already did "use Db\Connection as DbConnection" is the best hint that naming was wrong. So this patch renames Db\Connection to Db\DbConnection and does the same with DbQuery. DbQuery has been adjusted to fit our new SimpleQuery and to handle the new Filter implementation.
143 lines
3.3 KiB
PHP
143 lines
3.3 KiB
PHP
<?php
|
|
// {{{ICINGA_LICENSE_HEADER}}}
|
|
// {{{ICINGA_LICENSE_HEADER}}}
|
|
|
|
namespace Icinga\User\Preferences;
|
|
|
|
use \Zend_Config;
|
|
use Icinga\User;
|
|
use Icinga\User\Preferences;
|
|
use Icinga\Data\ResourceFactory;
|
|
use Icinga\Exception\ConfigurationError;
|
|
use Icinga\Data\Db\DbConnection;
|
|
use Icinga\Application\Config as IcingaConfig;
|
|
|
|
/**
|
|
* Preferences store factory
|
|
*
|
|
* Usage example:
|
|
* <code>
|
|
* <?php
|
|
*
|
|
* use Zend_Config;
|
|
* use Icinga\User\Preferences;
|
|
* use Icinga\User\Preferences\PreferencesStore;
|
|
*
|
|
* // Create a INI store
|
|
* $store = PreferencesStore::create(
|
|
* new Zend_Config(
|
|
* 'type' => 'ini',
|
|
* 'config_path' => '/path/to/preferences'
|
|
* ),
|
|
* $user // Instance of \Icinga\User
|
|
* );
|
|
*
|
|
* $preferences = new Preferences($store->load());
|
|
* $preferences->aPreference = 'value';
|
|
* $store->save($preferences);
|
|
* </code>
|
|
*/
|
|
abstract class PreferencesStore
|
|
{
|
|
/**
|
|
* Store config
|
|
*
|
|
* @var Zend_Config
|
|
*/
|
|
protected $config;
|
|
|
|
/**
|
|
* Given user
|
|
*
|
|
* @var User
|
|
*/
|
|
protected $user;
|
|
|
|
/**
|
|
* Create a new store
|
|
*
|
|
* @param Zend_Config $config The config for this adapter
|
|
* @param User $user The user to which these preferences belong
|
|
*/
|
|
public function __construct(Zend_Config $config, User $user)
|
|
{
|
|
$this->config = $config;
|
|
$this->user = $user;
|
|
$this->init();
|
|
}
|
|
|
|
/**
|
|
* Getter for the store config
|
|
*
|
|
* @return Zend_Config
|
|
*/
|
|
public function getStoreConfig()
|
|
{
|
|
return $this->config;
|
|
}
|
|
|
|
/**
|
|
* Getter for the user
|
|
*
|
|
* @return User
|
|
*/
|
|
public function getUser()
|
|
{
|
|
return $this->user;
|
|
}
|
|
|
|
/**
|
|
* Initialize the store
|
|
*/
|
|
abstract protected function init();
|
|
|
|
/**
|
|
* Load preferences from source
|
|
*
|
|
* @return array
|
|
*/
|
|
abstract public function load();
|
|
|
|
/**
|
|
* Save the given preferences
|
|
*
|
|
* @param Preferences $preferences The preferences to save
|
|
*/
|
|
abstract public function save(Preferences $preferences);
|
|
|
|
/**
|
|
* Create preferences storage adapter from config
|
|
*
|
|
* @param Zend_Config $config The config for the adapter
|
|
* @param User $user The user to which these preferences belong
|
|
*
|
|
* @return self
|
|
*
|
|
* @throws ConfigurationError When the configuration defines an invalid storage type
|
|
*/
|
|
public static function create(Zend_Config $config, User $user)
|
|
{
|
|
if (($type = $config->type) === null) {
|
|
throw new ConfigurationError(
|
|
'Preferences configuration is missing the type directive'
|
|
);
|
|
}
|
|
|
|
$type = ucfirst(strtolower($type));
|
|
$storeClass = 'Icinga\\User\\Preferences\\Store\\' . $type . 'Store';
|
|
if (!class_exists($storeClass)) {
|
|
throw new ConfigurationError(
|
|
'Preferences configuration defines an invalid storage type. Storage type ' . $type . ' not found'
|
|
);
|
|
}
|
|
|
|
if ($type === 'Ini') {
|
|
$config->location = $config->config_path;
|
|
} elseif ($type === 'Db') {
|
|
$config->connection = new DbConnection(ResourceFactory::getResourceConfig($config->resource));
|
|
}
|
|
|
|
return new $storeClass($config, $user);
|
|
}
|
|
}
|