235 lines
6.0 KiB
PHP
235 lines
6.0 KiB
PHP
<?php
|
|
/**
|
|
* Zend Framework
|
|
*
|
|
* LICENSE
|
|
*
|
|
* This source file is subject to the new BSD license that is bundled
|
|
* with this package in the file LICENSE.txt.
|
|
* It is also available through the world-wide-web at this URL:
|
|
* http://framework.zend.com/license/new-bsd
|
|
* If you did not receive a copy of the license and are unable to
|
|
* obtain it through the world-wide-web, please send an email
|
|
* to license@zend.com so we can send you a copy immediately.
|
|
*
|
|
* @category Zend
|
|
* @package Zend_Tool
|
|
* @subpackage Framework
|
|
* @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
|
|
* @license http://framework.zend.com/license/new-bsd New BSD License
|
|
* @version $Id$
|
|
*/
|
|
|
|
/**
|
|
* @category Zend
|
|
* @package Zend_Tool
|
|
* @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
|
|
* @license http://framework.zend.com/license/new-bsd New BSD License
|
|
*/
|
|
class Zend_Tool_Framework_Client_Config
|
|
{
|
|
|
|
protected $_configFilepath = null;
|
|
|
|
/**
|
|
* @var Zend_Config
|
|
*/
|
|
protected $_config = null;
|
|
|
|
/**
|
|
* @param array $options
|
|
*/
|
|
public function __config($options = array())
|
|
{
|
|
if ($options) {
|
|
$this->setOptions($options);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param array $options
|
|
*/
|
|
public function setOptions(Array $options)
|
|
{
|
|
foreach ($options as $optionName => $optionValue) {
|
|
$setMethodName = 'set' . $optionName;
|
|
if (method_exists($this, $setMethodName)) {
|
|
$this->{$setMethodName}($optionValue);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $configFilepath
|
|
* @return Zend_Tool_Framework_Client_Config
|
|
*/
|
|
public function setConfigFilepath($configFilepath)
|
|
{
|
|
if (!file_exists($configFilepath)) {
|
|
throw new Zend_Tool_Framework_Client_Exception('Provided path to config ' . $configFilepath . ' does not exist');
|
|
}
|
|
|
|
$this->_configFilepath = $configFilepath;
|
|
$this->loadConfig($configFilepath);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Load the configuration from the given path.
|
|
*
|
|
* @param string $configFilepath
|
|
*/
|
|
protected function loadConfig($configFilepath)
|
|
{
|
|
$suffix = substr($configFilepath, -4);
|
|
|
|
switch ($suffix) {
|
|
case '.ini':
|
|
$this->_config = new Zend_Config_Ini($configFilepath, null, array('allowModifications' => true));
|
|
break;
|
|
case '.xml':
|
|
$this->_config = new Zend_Config_Xml($configFilepath, null, array('allowModifications' => true));
|
|
break;
|
|
case '.php':
|
|
$this->_config = new Zend_Config(include $configFilepath, true);
|
|
break;
|
|
default:
|
|
throw new Zend_Tool_Framework_Client_Exception('Unknown config file type '
|
|
. $suffix . ' at location ' . $configFilepath
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the filepath of the configuration.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getConfigFilepath()
|
|
{
|
|
return $this->_configFilepath;
|
|
}
|
|
|
|
/**
|
|
* Get a configuration value.
|
|
*
|
|
* @param string $name
|
|
* @param string $defaultValue
|
|
* @return mixed
|
|
*/
|
|
public function get($name, $defaultValue=null)
|
|
{
|
|
return $this->getConfigInstance()->get($name, $defaultValue);
|
|
}
|
|
|
|
/**
|
|
* Get a configuration value
|
|
*
|
|
* @param string $name
|
|
* @return mixed
|
|
*/
|
|
public function __get($name)
|
|
{
|
|
return $this->getConfigInstance()->{$name};
|
|
}
|
|
|
|
/**
|
|
* Check if a configuration value isset.
|
|
*
|
|
* @param string $name
|
|
* @return boolean
|
|
*/
|
|
public function __isset($name)
|
|
{
|
|
if($this->exists() == false) {
|
|
return false;
|
|
}
|
|
return isset($this->getConfigInstance()->{$name});
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
*/
|
|
public function __unset($name)
|
|
{
|
|
unset($this->getConfigInstance()->$name);
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
* @param mixed $value
|
|
*/
|
|
public function __set($name, $value)
|
|
{
|
|
return $this->getConfigInstance()->$name = $value;
|
|
}
|
|
|
|
/**
|
|
* Check if the User profile has a configuration.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function exists()
|
|
{
|
|
return ($this->_config!==null);
|
|
}
|
|
|
|
/**
|
|
* @throws Zend_Tool_Framework_Client_Exception
|
|
* @return Zend_Config
|
|
*/
|
|
public function getConfigInstance()
|
|
{
|
|
if(!$this->exists()) {
|
|
throw new Zend_Tool_Framework_Client_Exception("Client has no persistent configuration.");
|
|
}
|
|
|
|
return $this->_config;
|
|
}
|
|
|
|
/**
|
|
* Save changes to the configuration into persistence.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function save()
|
|
{
|
|
if($this->exists()) {
|
|
$writer = $this->getConfigWriter();
|
|
$writer->write($this->getConfigFilepath(), $this->getConfigInstance(), true);
|
|
$this->loadConfig($this->getConfigFilepath());
|
|
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Get the config writer that corresponds to the current config file type.
|
|
*
|
|
* @return Zend_Config_Writer_FileAbstract
|
|
*/
|
|
protected function getConfigWriter()
|
|
{
|
|
$suffix = substr($this->getConfigFilepath(), -4);
|
|
switch($suffix) {
|
|
case '.ini':
|
|
$writer = new Zend_Config_Writer_Ini();
|
|
$writer->setRenderWithoutSections();
|
|
break;
|
|
case '.xml':
|
|
$writer = new Zend_Config_Writer_Xml();
|
|
break;
|
|
case '.php':
|
|
$writer = new Zend_Config_Writer_Array();
|
|
break;
|
|
default:
|
|
throw new Zend_Tool_Framework_Client_Exception('Unknown config file type '
|
|
. $suffix . ' at location ' . $this->getConfigFilepath()
|
|
);
|
|
}
|
|
return $writer;
|
|
}
|
|
}
|