Config/Yaml.php

Show:

inherited

Classes
- \Zend_Config_Yaml

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_Config
Version: $Id: Yaml.php 25169 2012-12-22 12:23:11Z rob $

\Zend_Config_Yaml
jump to top

Package: Zend\Config

YAML Adapter for Zend_Config

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

Constants

 
                EXTENDS_NAME
                = "_extends"

Attribute name that indicates what section a config extends from

Properties

boolean $_allowModifications

inherited

Whether in-memory modifications to configuration data are allowed

Inherited from: \Zend_Config::$$_allowModifications

Details

Type: boolean
Inherited_from: \Zend_Config::$$_allowModifications

integer $_count

inherited

Number of elements in configuration data

Inherited from: \Zend_Config::$$_count

Details

Type: integer
Inherited_from: \Zend_Config::$$_count

array $_data

inherited

Contains array of configuration data

Inherited from: \Zend_Config::$$_data

Details

Type: array
Inherited_from: \Zend_Config::$$_data

array $_extends = array()

inherited

This is used to track section inheritance.

Inherited from: \Zend_Config::$$_extends

The keys are names of sections that extend other sections, and the values are the extended sections.

Default valuearray()Details

Type: array
Inherited_from: \Zend_Config::$$_extends

bool $_ignoreConstants = false

static

Whether or not to ignore constants in parsed YAML

Default valuefalseDetails

Type: bool

integer $_index

inherited

Iteration index

Inherited from: \Zend_Config::$$_index

Details

Type: integer
Inherited_from: \Zend_Config::$$_index

string $_loadFileErrorStr = null

inherited

Load file error string.

Inherited from: \Zend_Config::$$_loadFileErrorStr

Is null if there was no error while file loading

Default valuenullDetails

Type: string
Inherited_from: \Zend_Config::$$_loadFileErrorStr

mixed $_loadedSection

inherited

Contains which config file sections were loaded.

Inherited from: \Zend_Config::$$_loadedSection

This is null if all sections were loaded, a string name if one section is loaded and an array of string names if multiple sections were loaded.

Details

Type: mixed
Inherited_from: \Zend_Config::$$_loadedSection

boolean $_skipExtends = false

Whether to skip extends or not

Default valuefalseDetails

Type: boolean

boolean $_skipNextIteration

inherited

Used when unsetting values during iteration to ensure we do not skip the next element

Inherited from: \Zend_Config::$$_skipNextIteration

Details

Type: boolean
Inherited_from: \Zend_Config::$$_skipNextIteration

callable $_yamlDecoder = array(__CLASS__, 'decode')

What to call when we need to decode some YAML?

Default valuearray(__CLASS__, 'decode')Details

Type: callable

Methods

__clone() : void

inherited

Deep clone of this instance to ensure that nested Zend_Configs are also cloned.

Inherited from: \Zend_Config::__clone()

__construct(string $yaml, mixed $section = null, array | boolean $options = false) : void

Loads the section $section from the config file encoded as YAML

Sections are defined as properties of the main object

In order to extend another section, a section defines the "_extends" property having a value of the section name from which the extending section inherits values.

Note that the keys in $section will override any keys of the same name in the sections that have been included via "_extends".

Options may include: - allow_modifications: whether or not the config object is mutable - skip_extends: whether or not to skip processing of parent configuration - yaml_decoder: a callback to use to decode the Yaml source

Parameters

Name	Type	Description
$yaml	string	YAML file to process
$section	mixed	Section to process
$options	array \| boolean

__get(string $name) : mixed

inherited

Magic function so that $obj->value will work.

Inherited from: \Zend_Config::__get()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
mixed

__isset(string $name) : boolean

inherited

Support isset() overloading on PHP 5.1

Inherited from: \Zend_Config::__isset()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
boolean

__set(string $name, mixed $value) : void

inherited

Only allow setting of a property if $allowModifications was set to true on construction.

Inherited from: \Zend_Config::__set()

Otherwise, throw an exception.

Parameters

Name	Type	Description
$name	string
$value	mixed

Throws

Exception	Description
\Zend_Config_Exception

__unset(string $name) : void

inherited

Support unset() overloading on PHP 5.1

Inherited from: \Zend_Config::__unset()

Parameters

Name	Type	Description
$name	string

Throws

Exception	Description
\Zend_Config_Exception

_arrayMergeRecursive(mixed $firstArray, mixed $secondArray) : array

inherited

Merge two arrays recursively, overwriting keys of the same name in $firstArray with the value in $secondArray.

Inherited from: \Zend_Config::_arrayMergeRecursive()

Parameters

Name	Type	Description
$firstArray	mixed	First array
$secondArray	mixed	Second array to merge into first array

Returns

Type	Description
array

_assertValidExtend(string $extendingSection, string $extendedSection) : void

inherited

Throws an exception if $extendingSection may not extend $extendedSection, and tracks the section extension if it is valid.

Inherited from: \Zend_Config::_assertValidExtend()

Parameters

Name	Type	Description
$extendingSection	string
$extendedSection	string

Throws

Exception	Description
\Zend_Config_Exception

_decodeYaml(int $currentIndent, array $lines) : array | string

static

Service function to decode YAML

Parameters

Name	Type	Description
$currentIndent	int	Current indent level
$lines	array	YAML lines

Returns

Type	Description
array \| string

_getConstants() : array

static

Get (reverse) sorted list of defined constant names

Returns

Type	Description
array

_loadFileErrorHandler(integer $errno, string $errstr, string $errfile, integer $errline) : void

inherited

Handle any errors from simplexml_load_file or parse_ini_file

Inherited from: \Zend_Config::_loadFileErrorHandler()

Parameters

Name	Type	Description
$errno	integer
$errstr	string
$errfile	string
$errline	integer

_parseValue(string $value) : string

static

Parse values

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
string

_processExtends(array $data, string $section, array $config = array()) : array

Helper function to process each element in the section and handle the "_extends" inheritance attribute.

Parameters

Name	Type	Description
$data	array	Data array to process
$section	string	Section to process
$config	array	Configuration which was parsed yet

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Config_Exception	When $section cannot be found

_replaceConstants(string $value) : string

static

Replace any constants referenced in a string with their values

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
string

areAllSectionsLoaded() : boolean

inherited

Returns true if all sections were loaded

Inherited from: \Zend_Config::areAllSectionsLoaded()

Returns

Type	Description
boolean

count() : int

inherited

Defined by Countable interface

Inherited from: \Zend_Config::count()

Returns

Type	Description
int

current() : mixed

inherited

Defined by Iterator interface

Inherited from: \Zend_Config::current()

Returns

Type	Description
mixed

decode(string $yaml) : array

static

Very dumb YAML parser

Until we have Zend_Yaml...

Parameters

Name	Type	Description
$yaml	string	YAML source

Returns

Type	Description
array	Decoded data

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

inherited

Retrieve a value and return $default if there is no element set.

Inherited from: \Zend_Config::get()

Parameters

Name	Type	Description
$name	string
$default	mixed

Returns

Type	Description
mixed

getExtends() : array

inherited

Get the current extends

Inherited from: \Zend_Config::getExtends()

Returns

Type	Description
array

getSectionName() : mixed

inherited

Returns the section name(s) loaded.

Inherited from: \Zend_Config::getSectionName()

Returns

Type	Description
mixed

getYamlDecoder() : callable

Get callback for decoding YAML

Returns

Type	Description
callable

ignoreConstants() : bool

static

Whether parser should ignore constants or not

Returns

Type	Description
bool

key() : mixed

inherited

Defined by Iterator interface

Inherited from: \Zend_Config::key()

Returns

Type	Description
mixed

merge(\Zend_Config $merge) : \Zend_Config

inherited

Merge another Zend_Config with this one.

Inherited from: \Zend_Config::merge()

The items in $merge will override the same named items in the current config.

Parameters

Name	Type	Description
$merge	\Zend_Config

Returns

Type	Description
\Zend_Config

next() : void

inherited

Defined by Iterator interface

Inherited from: \Zend_Config::next()

readOnly() : boolean

inherited

Returns if this Zend_Config object is read only or not.

Inherited from: \Zend_Config::readOnly()

Returns

Type	Description
boolean

rewind() : void

inherited

Defined by Iterator interface

Inherited from: \Zend_Config::rewind()

setExtend(string $extendingSection, string $extendedSection = null) : void

inherited

Set an extend for Zend_Config_Writer

Inherited from: \Zend_Config::setExtend()

Parameters

Name	Type	Description
$extendingSection	string
$extendedSection	string

setIgnoreConstants(bool $flag) : void

static

Indicate whether parser should ignore constants or not

Parameters

Name	Type	Description
$flag	bool

setReadOnly() : void

inherited

Prevent any more modifications being made to this instance.

Inherited from: \Zend_Config::setReadOnly()

Useful after merge() has been used to merge multiple Zend_Config objects into one object which should then not be modified again.

setYamlDecoder(callable $yamlDecoder) : \Zend_Config_Yaml

Set callback for decoding YAML

Parameters

Name	Type	Description
$yamlDecoder	callable	the decoder to set

Returns

Type	Description
\Zend_Config_Yaml

toArray() : array

inherited

Return an associative array of the stored data.

Inherited from: \Zend_Config::toArray()

Returns

Type	Description
array

valid() : boolean

inherited

Defined by Iterator interface

Inherited from: \Zend_Config::valid()

Returns

Type	Description
boolean

Config/Yaml.php

\Zend_Config_Yamljump to top

Constants

Properties

Methods

\Zend_Config_Yaml
jump to top