API Documentation

Zend/Tool/Framework/Client/Config.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Tool  
Subpackage
Framework  
Version
$Id: Config.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Tool_Framework_Client_Config

Package: Zend\Tool

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected\Zend_Config  $_config= 'null'

Default valuenullDetails
Type
\Zend_Config
Propertyprotected  $_configFilepath= 'null'
Default valuenullDetails
Type

Methods

methodpublic__config( array $options = array() ) : void

Parameters
Name Type Description
$options array
methodpublic__get( string $name ) : mixed

Get a configuration value

Parameters
Name Type Description
$name string
Returns
Type Description
mixed
methodpublic__isset( string $name ) : boolean

Check if a configuration value isset.

Parameters
Name Type Description
$name string
Returns
Type Description
boolean
methodpublic__set( string $name, mixed $value ) : void

Parameters
Name Type Description
$name string
$value mixed
methodpublic__unset( string $name ) : void

Parameters
Name Type Description
$name string
methodpublicexists( ) : bool

Check if the User profile has a configuration.

Returns
Type Description
bool
methodpublicget( string $name, string $defaultValue = null ) : mixed

Get a configuration value.

Parameters
Name Type Description
$name string
$defaultValue string
Returns
Type Description
mixed
methodpublicgetConfigFilepath( ) : string

Return the filepath of the configuration.

Returns
Type Description
string
methodpublicgetConfigInstance( ) : \Zend_Config

Returns
Type Description
\Zend_Config
Throws
Exception Description
\Zend_Tool_Framework_Client_Exception
methodprotectedgetConfigWriter( ) : \Zend_Config_Writer_FileAbstract

Get the config writer that corresponds to the current config file type.

Returns
Type Description
\Zend_Config_Writer_FileAbstract
methodprotectedloadConfig( string $configFilepath ) : void

Load the configuration from the given path.

Parameters
Name Type Description
$configFilepath string
methodpublicsave( ) : bool

Save changes to the configuration into persistence.

Returns
Type Description
bool
methodpublicsetConfigFilepath( string $configFilepath ) : \Zend_Tool_Framework_Client_Config

Parameters
Name Type Description
$configFilepath string
Returns
Type Description
\Zend_Tool_Framework_Client_Config
methodpublicsetOptions( array $options ) : void

Parameters
Name Type Description
$options array
Documentation was generated by DocBlox 0.15.1.