API Documentation

Tool/Framework/Client/Config.php

Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Tool
subpackage
Framework
version
$Id: Config.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Tool_Framework_Client_Config

Description

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.

Zend_Tool_Framework_Client_Config

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Tool
Properties
$_configFilepath
$_config
Methods
__config
setOptions
setConfigFilepath
loadConfig
getConfigFilepath
get
__get
__isset
__unset
__set
exists
getConfigInstance
save
getConfigWriter

Description

Properties

$_config

Zend_Config $_config = 'null'

Details

$_config
Zend_Config
visibility
protected
default
null
final
false
static
false

$_configFilepath

 $_configFilepath = 'null'

Details

visibility
protected
default
null
final
false
static
false

Methods

__config

__config( array $options = array ) :

Arguments
$options
array
Details
visibility
public
final
false
static
false

__get

__get( string $name ) : mixed

Get a configuration value

Arguments
$name
string
Output
mixed
Details
visibility
public
final
false
static
false

__isset

__isset( string $name ) : boolean

Check if a configuration value isset.

Arguments
$name
string
Output
boolean
Details
visibility
public
final
false
static
false

__set

__set( string $name, mixed $value ) :

Arguments
$name
string
$value
mixed
Details
visibility
public
final
false
static
false

__unset

__unset( string $name ) :

Arguments
$name
string
Details
visibility
public
final
false
static
false

exists

exists( ) : bool

Check if the User profile has a configuration.

Output
bool
Details
visibility
public
final
false
static
false

get

get( string $name, string $defaultValue = null ) : mixed

Get a configuration value.

Arguments
$name
string
$defaultValue
string
Output
mixed
Details
visibility
public
final
false
static
false

getConfigFilepath

getConfigFilepath( ) : string

Return the filepath of the configuration.

Output
string
Details
visibility
public
final
false
static
false

getConfigInstance

getConfigInstance( ) : Zend_Config

Output
Zend_Config
Details
visibility
public
final
false
static
false
throws

getConfigWriter

getConfigWriter( ) : Zend_Config_Writer_FileAbstract

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

Details
visibility
protected
final
false
static
false

loadConfig

loadConfig( string $configFilepath ) :

Load the configuration from the given path.

Arguments
$configFilepath
string
Details
visibility
protected
final
false
static
false

save

save( ) : bool

Save changes to the configuration into persistence.

Output
bool
Details
visibility
public
final
false
static
false

setConfigFilepath

setConfigFilepath( string $configFilepath ) : Zend_Tool_Framework_Client_Config

Arguments
$configFilepath
string
Details
visibility
public
final
false
static
false

setOptions

setOptions( array $options ) :

Arguments
$options
array
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.