/usr/share/php/Icinga/User/Preferences/PreferencesStore.php is in php-icinga 2.1.0-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | <?php
/* Icinga Web 2 | (c) 2013-2015 Icinga Development Team | GPLv2+ */
namespace Icinga\User\Preferences;
use Icinga\Application\Config;
use Icinga\User;
use Icinga\User\Preferences;
use Icinga\Data\ConfigObject;
use Icinga\Data\ResourceFactory;
use Icinga\Exception\ConfigurationError;
use Icinga\Data\Db\DbConnection;
/**
* Preferences store factory
*
* Usage example:
* <code>
* <?php
*
* use Icinga\Data\ConfigObject;
* use Icinga\User\Preferences;
* use Icinga\User\Preferences\PreferencesStore;
*
* // Create a INI store
* $store = PreferencesStore::create(
* new ConfigObject(
* 'store' => '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 ConfigObject
*/
protected $config;
/**
* Given user
*
* @var User
*/
protected $user;
/**
* Create a new store
*
* @param ConfigObject $config The config for this adapter
* @param User $user The user to which these preferences belong
*/
public function __construct(ConfigObject $config, User $user)
{
$this->config = $config;
$this->user = $user;
$this->init();
}
/**
* Getter for the store config
*
* @return ConfigObject
*/
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 ConfigObject $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(ConfigObject $config, User $user)
{
$type = ucfirst(strtolower($config->get('store', 'ini')));
$storeClass = 'Icinga\\User\\Preferences\\Store\\' . $type . 'Store';
if (!class_exists($storeClass)) {
throw new ConfigurationError(
'Preferences configuration defines an invalid storage type. Storage type %s not found',
$type
);
}
if ($type === 'Ini') {
$config->location = Config::resolvePath('preferences');
} elseif ($type === 'Db') {
$config->connection = new DbConnection(ResourceFactory::getResourceConfig($config->resource));
}
return new $storeClass($config, $user);
}
}
|