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.
YAML Adapter for Zend_Config

bool
$_ignoreConstants= 'false'
Whether or not to ignore constants in parsed YAML
false
Details
boolean
$_skipExtends= 'false'
Whether to skip extends or not
false
Details
__clone(
)
:
void
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
Name | Type | Description |
---|---|---|
$yaml | string | YAML file to process |
$section | mixed | Section to process |
$options | array|boolean |

__get(
string $name
)
:
mixed
Magic function so that $obj->value will work.
Inherited from: \Zend_Config::__get()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
mixed |

__isset(
string $name
)
:
boolean
Support isset() overloading on PHP 5.1
Inherited from: \Zend_Config::__isset()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |

__set(
string $name, mixed $value
)
:
void
Only allow setting of a property if $allowModifications was set to true on construction. Otherwise, throw an exception.
Inherited from: \Zend_Config::__set()Name | Type | Description |
---|---|---|
$name | string | |
$value | mixed |
Exception | Description |
---|---|
\Zend_Config_Exception |

__unset(
string $name
)
:
void
Support unset() overloading on PHP 5.1
Inherited from: \Zend_Config::__unset()
_arrayMergeRecursive(
mixed $firstArray, mixed $secondArray
)
:
array
Merge two arrays recursively, overwriting keys of the same name in $firstArray with the value in $secondArray.
Inherited from: \Zend_Config::_arrayMergeRecursive()Name | Type | Description |
---|---|---|
$firstArray | mixed | First array |
$secondArray | mixed | Second array to merge into first array |
Type | Description |
---|---|
array |

_assertValidExtend(
string $extendingSection, string $extendedSection
)
:
void
Throws an exception if $extendingSection may not extend $extendedSection, and tracks the section extension if it is valid.
Inherited from: \Zend_Config::_assertValidExtend()Name | Type | Description |
---|---|---|
$extendingSection | string | |
$extendedSection | string |
Exception | Description |
---|---|
\Zend_Config_Exception |

_decodeYaml(
int $currentIndent, array $lines
)
:
array|string
Service function to decode YAML
Name | Type | Description |
---|---|---|
$currentIndent | int | Current indent level |
$lines | array | YAML lines |
Type | Description |
---|---|
arraystring |

_getConstants(
)
:
array
Get (reverse) sorted list of defined constant names
Type | Description |
---|---|
array |

_loadFileErrorHandler(
integer $errno, string $errstr, string $errfile, integer $errline
)
:
void
Handle any errors from simplexml_load_file or parse_ini_file
Inherited from: \Zend_Config::_loadFileErrorHandler()Name | Type | Description |
---|---|---|
$errno | integer | |
$errstr | string | |
$errfile | string | |
$errline | integer |

_processExtends(
array $data, string $section, array $config
=
array
)
:
array
Helper function to process each element in the section and handle the "_extends" inheritance attribute.
Name | Type | Description |
---|---|---|
$data | array | Data array to process |
$section | string | Section to process |
$config | array | Configuration which was parsed yet |
Type | Description |
---|---|
array |
Exception | Description |
---|---|
\Zend_Config_Exception | When $section cannot be found |

_replaceConstants(
string $value
)
:
string
Replace any constants referenced in a string with their values
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
string |

areAllSectionsLoaded(
)
:
boolean
Returns true if all sections were loaded
Inherited from: \Zend_Config::areAllSectionsLoaded()Type | Description |
---|---|
boolean |

count(
)
:
int
Defined by Countable interface
Inherited from: \Zend_Config::count()Type | Description |
---|---|
int |

current(
)
:
mixed
Defined by Iterator interface
Inherited from: \Zend_Config::current()Type | Description |
---|---|
mixed |

decode(
string $yaml
)
:
array
Very dumb YAML parser
Until we have Zend_Yaml...
Name | Type | Description |
---|---|---|
$yaml | string | YAML source |
Type | Description |
---|---|
array | Decoded data |

get(
string $name, mixed $default
=
null
)
:
mixed
Retrieve a value and return $default if there is no element set.
Inherited from: \Zend_Config::get()Name | Type | Description |
---|---|---|
$name | string | |
$default | mixed |
Type | Description |
---|---|
mixed |

getExtends(
)
:
array
Get the current extends
Inherited from: \Zend_Config::getExtends()Type | Description |
---|---|
array |

getSectionName(
)
:
mixed
Returns the section name(s) loaded.
Inherited from: \Zend_Config::getSectionName()Type | Description |
---|---|
mixed |

ignoreConstants(
)
:
bool
Whether parser should ignore constants or not
Type | Description |
---|---|
bool |

key(
)
:
mixed
Defined by Iterator interface
Inherited from: \Zend_Config::key()Type | Description |
---|---|
mixed |

merge(
\Zend_Config $merge
)
:
\Zend_Config
Merge another Zend_Config with this one. The items in $merge will override the same named items in the current config.
Inherited from: \Zend_Config::merge()Name | Type | Description |
---|---|---|
$merge | \Zend_Config |
Type | Description |
---|---|
\Zend_Config |

readOnly(
)
:
boolean
Returns if this Zend_Config object is read only or not.
Inherited from: \Zend_Config::readOnly()Type | Description |
---|---|
boolean |

setExtend(
string $extendingSection, string $extendedSection
=
null
)
:
void
Set an extend for Zend_Config_Writer
Inherited from: \Zend_Config::setExtend()Name | Type | Description |
---|---|---|
$extendingSection | string | |
$extendedSection | string |

setIgnoreConstants(
bool $flag
)
:
void
Indicate whether parser should ignore constants or not
Name | Type | Description |
---|---|---|
$flag | bool |

setReadOnly(
)
:
void
Prevent any more modifications being made to this instance. Useful after merge() has been used to merge multiple Zend_Config objects into one object which should then not be modified again.
Inherited from: \Zend_Config::setReadOnly()
setYamlDecoder(
\callable $yamlDecoder
)
:
\Zend_Config_Yaml
Set callback for decoding YAML
Name | Type | Description |
---|---|---|
$yamlDecoder | \callable | the decoder to set |
Type | Description |
---|---|
\Zend_Config_Yaml |

toArray(
)
:
array
Return an associative array of the stored data.
Inherited from: \Zend_Config::toArray()Type | Description |
---|---|
array |

valid(
)
:
boolean
Defined by Iterator interface
Inherited from: \Zend_Config::valid()Type | Description |
---|---|
boolean |