Tool/Framework/Client/Config.php
Show:
inherited
inherited
Classes
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
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Tool
- Subpackage
- Framework
- Version
- $Id$
\Zend_Tool_Framework_Client_Config
Package: Zend_Tool
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
__config(array $options = array()) : voidParameters
| Name | Type | Description |
|---|---|---|
| $options | array |
__get(string $name) : mixedGet a configuration value
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| mixed |
__isset(string $name) : booleanCheck if a configuration value isset.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| boolean |
__set(string $name, mixed $value) : voidParameters
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | mixed |
__unset(string $name) : voidParameters
| Name | Type | Description |
|---|---|---|
| $name | string |
exists() : boolCheck if the User profile has a configuration.
Returns
| Type | Description |
|---|---|
| bool |
get(string $name, string $defaultValue = null) : mixedGet a configuration value.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $defaultValue | string |
| Type | Description |
|---|---|
| mixed |
getConfigFilepath() : stringReturn the filepath of the configuration.
Returns
| Type | Description |
|---|---|
| string |
getConfigInstance() : \Zend_ConfigReturns
Throws
| Type | Description |
|---|---|
| \Zend_Config |
| Exception | Description |
|---|---|
| \Zend_Tool_Framework_Client_Exception |
getConfigWriter() : \Zend_Config_Writer_FileAbstractGet the config writer that corresponds to the current config file type.
Returns
| Type | Description |
|---|---|
| \Zend_Config_Writer_FileAbstract |
loadConfig(string $configFilepath) : voidLoad the configuration from the given path.
Parameters
| Name | Type | Description |
|---|---|---|
| $configFilepath | string |
save() : boolSave changes to the configuration into persistence.
Returns
| Type | Description |
|---|---|
| bool |
setConfigFilepath(string $configFilepath) : \Zend_Tool_Framework_Client_ConfigParameters
Returns
| Name | Type | Description |
|---|---|---|
| $configFilepath | string |
| Type | Description |
|---|---|
| \Zend_Tool_Framework_Client_Config |
setOptions(array $options) : voidParameters
| Name | Type | Description |
|---|---|---|
| $options | array |