Zend_Config_Yaml Class Reference

Inheritance diagram for Zend_Config_Yaml:

Public Member Functions
	getYamlDecoder ()
	setYamlDecoder ($yamlDecoder)
	__construct ($yaml, $section=null, $options=false)
Public Member Functions inherited from Zend_Config
	__construct (array $array, $allowModifications=false)
	get ($name, $default=null)
	__get ($name)
	__set ($name, $value)
	__clone ()
	toArray ()
	__isset ($name)
	__unset ($name)
	count ()
	current ()
	key ()
	next ()
	rewind ()
	valid ()
	getSectionName ()
	areAllSectionsLoaded ()
	merge (Zend_Config $merge)
	setReadOnly ()
	readOnly ()
	getExtends ()
	setExtend ($extendingSection, $extendedSection=null)
	_loadFileErrorHandler ($errno, $errstr, $errfile, $errline)

Static Public Member Functions
static	setIgnoreConstants ($flag)
static	ignoreConstants ()
static	decode ($yaml)

Data Fields
const	EXTENDS_NAME = "_extends"

Protected Member Functions
	_processExtends (array $data, $section, array $config=array())
Protected Member Functions inherited from Zend_Config
	_assertValidExtend ($extendingSection, $extendedSection)
	_arrayMergeRecursive ($firstArray, $secondArray)

Static Protected Member Functions
static	_decodeYaml ($currentIndent, &$lines)
static	_parseValue ($value)
static	_replaceConstants ($value)
static	_getConstants ()

Protected Attributes
	$_skipExtends = false
	$_yamlDecoder = array(__CLASS__, 'decode')
Protected Attributes inherited from Zend_Config
	$_allowModifications
	$_index
	$_count
	$_data
	$_skipNextIteration
	$_loadedSection
	$_extends = array()
	$_loadFileErrorStr = null

Static Protected Attributes
static	$_ignoreConstants = false

Detailed Description

Definition at line 35 of file Yaml.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$yaml,
			$section = null,
			$options = false
	)

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

string	$yaml	YAML file to process
mixed	$section	Section to process
array | boolean	$options

Definition at line 131 of file Yaml.php.

    {
        if (empty($yaml)) {
            #require_once 'Zend/Config/Exception.php';
            throw new Zend_Config_Exception('Filename is not set');
        }

        $ignoreConstants    = $staticIgnoreConstants = self::ignoreConstants();
        $allowModifications = false;
        if (is_bool($options)) {
            $allowModifications = $options;
        } elseif (is_array($options)) {
            foreach ($options as $key => $value) {
                switch (strtolower($key)) {
                    case 'allow_modifications':
                    case 'allowmodifications':
                        $allowModifications = (bool) $value;
                        break;
                    case 'skip_extends':
                    case 'skipextends':
                        $this->_skipExtends = (bool) $value;
                        break;
                    case 'ignore_constants':
                    case 'ignoreconstants':
                        $ignoreConstants = (bool) $value;
                        break;
                    case 'yaml_decoder':
                    case 'yamldecoder':
                        $this->setYamlDecoder($value);
                        break;
                    default:
                        break;
                }
            }
        }

        // Suppress warnings and errors while loading file
        set_error_handler(array($this, '_loadFileErrorHandler'));
        $yaml = file_get_contents($yaml);
        restore_error_handler();

        // Check if there was a error while loading file
        if ($this->_loadFileErrorStr !== null) {
            #require_once 'Zend/Config/Exception.php';
            throw new Zend_Config_Exception($this->_loadFileErrorStr);
        }

        // Override static value for ignore_constants if provided in $options
        self::setIgnoreConstants($ignoreConstants);

        // Parse YAML
        $config = call_user_func($this->getYamlDecoder(), $yaml);

        // Reset original static state of ignore_constants
        self::setIgnoreConstants($staticIgnoreConstants);

        if (null === $config) {
            // decode failed
            #require_once 'Zend/Config/Exception.php';
            throw new Zend_Config_Exception("Error parsing YAML data");
        }

        if (null === $section) {
            $dataArray = array();
            foreach ($config as $sectionName => $sectionData) {
                $dataArray[$sectionName] = $this->_processExtends($config, $sectionName);
            }
            parent::__construct($dataArray, $allowModifications);
        } elseif (is_array($section)) {
            $dataArray = array();
            foreach ($section as $sectionName) {
                if (!isset($config[$sectionName])) {
                    #require_once 'Zend/Config/Exception.php';
                    throw new Zend_Config_Exception(sprintf(
                        'Section "%s" cannot be found',
                        implode(' ', (array)$section)
                    ));
                }

                $dataArray = array_merge($this->_processExtends($config, $sectionName), $dataArray);
            }
            parent::__construct($dataArray, $allowModifications);
        } else {
            if (!isset($config[$section])) {
                #require_once 'Zend/Config/Exception.php';
                throw new Zend_Config_Exception(sprintf(
                    'Section "%s" cannot be found',
                    implode(' ', (array)$section)
                ));
            }

            $dataArray = $this->_processExtends($config, $section);
            if (!is_array($dataArray)) {
                // Section in the yaml data contains just one top level string
                $dataArray = array($section => $dataArray);
            }
            parent::__construct($dataArray, $allowModifications);
        }

        $this->_loadedSection = $section;
    }

Member Function Documentation

_decodeYaml()

static _decodeYaml (   $currentIndent, &  $lines  )

staticprotected

Service function to decode YAML

Parameters

int	$currentIndent	Current indent level
array	$lines	YAML lines

Returns

array|string

Definition at line 288 of file Yaml.php.

    {
        $config   = array();
        $inIndent = false;
        foreach ($line as $n => $line) {
            $lineno = $n + 1;

            $line = rtrim(preg_replace("/#.*$/", "", $line));
            if (strlen($line) == 0) {
                continue;
            }

            $indent = strspn($line, " ");

            // line without the spaces
            $line = trim($line);
            if (strlen($line) == 0) {
                continue;
            }

            if ($indent < $currentIndent) {
                // this level is done
                prev($lines);
                return $config;
            }

            if (!$inIndent) {
                $currentIndent = $indent;
                $inIndent      = true;
            }

            if (preg_match("/(?!-)([\w\-]+):\s*(.*)/", $line, $m)) {
                // key: value
                if (strlen($m[2])) {
                    // simple key: value
                    $value = preg_replace("/#.*$/", "", $m[2]);
                    $value = self::_parseValue($value);
                } else {
                    // key: and then values on new lines
                    $value = self::_decodeYaml($currentIndent + 1, $lines);
                    if (is_array($value) && !count($value)) {
                        $value = "";
                    }
                }
                $config[$m[1]] = $value;
            } elseif ($line[0] == "-") {
                // item in the list:
                // - FOO
                if (strlen($line) > 2) {
                    $value = substr($line, 2);

                    $config[] = self::_parseValue($value);
                } else {
                    $config[] = self::_decodeYaml($currentIndent + 1, $lines);
                }
            } else {
                #require_once 'Zend/Config/Exception.php';
                throw new Zend_Config_Exception(sprintf(
                    'Error parsing YAML at line %d - unsupported syntax: "%s"',
                    $lineno, $line
                ));
            }
        }
        return $config;
    }

_getConstants()

static _getConstants ( )

staticprotected

Get (reverse) sorted list of defined constant names

Returns

array

Definition at line 409 of file Yaml.php.

    {
        $constants = array_keys(get_defined_constants());
        rsort($constants, SORT_STRING);
        return $constants;
    }

_parseValue()

static _parseValue (   $value )

staticprotected

Parse values

Parameters

string

$value

Returns

string

Definition at line 360 of file Yaml.php.

    {
        $value = trim($value);

        // remove quotes from string.
        if ('"' == substr($value, 0, 1)) {
            if ('"' == substr($value, -1)) {
                $value = substr($value, 1, -1);
            }
        } elseif ('\'' == substr($value, 0, 1) && '\'' == substr($value, -1)) {
            $value = strtr($value, array("''" => "'", "'" => ''));
        }

        // Check for booleans and constants
        if (preg_match('/^(t(rue)?|on|y(es)?)$/i', $value)) {
            $value = true;
        } elseif (preg_match('/^(f(alse)?|off|n(o)?)$/i', $value)) {
            $value = false;
        } elseif (strcasecmp($value, 'null') === 0) {
            $value = null;
        } elseif (!self::$_ignoreConstants) {
            // test for constants
            $value = self::_replaceConstants($value);
        }

        return $value;
    }

_processExtends()

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

protected

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

Parameters

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

Returns

array

Exceptions

Zend_Config_Exception

When $section cannot be found

Definition at line 243 of file Yaml.php.

    {
        if (!isset($data[$section])) {
            #require_once 'Zend/Config/Exception.php';
            throw new Zend_Config_Exception(sprintf('Section "%s" cannot be found', $section));
        }

        $thisSection  = $data[$section];

        if (is_array($thisSection) && isset($thisSection[self::EXTENDS_NAME])) {
            $this->_assertValidExtend($section, $thisSection[self::EXTENDS_NAME]);

            if (!$this->_skipExtends) {
                $config = $this->_processExtends($data, $thisSection[self::EXTENDS_NAME], $config);
            }
            unset($thisSection[self::EXTENDS_NAME]);
        }

        $config = $this->_arrayMergeRecursive($config, $thisSection);

        return $config;
    }

_replaceConstants()

static _replaceConstants (   $value )

staticprotected

Replace any constants referenced in a string with their values

Parameters

string

$value

Returns

string

Definition at line 394 of file Yaml.php.

    {
        foreach (self::_getConstants() as $constant) {
            if (strstr($value, $constant)) {
                $value = str_replace($constant, constant($constant), $value);
            }
        }
        return $value;
    }

decode()

static decode (   $yaml )

static

Very dumb YAML parser

Until we have Zend_Yaml...

Parameters

string

$yaml

YAML source

Returns

array Decoded data

Definition at line 274 of file Yaml.php.

    {
        $lines = explode("\n", $yaml);
        reset($lines);
        return self::_decodeYaml(0, $lines);
    }

getYamlDecoder()

getYamlDecoder

(

)

Get callback for decoding YAML

Returns

callable

Definition at line 88 of file Yaml.php.

    {
        return $this->_yamlDecoder;
    }

ignoreConstants()

static ignoreConstants ( )

static

Whether parser should ignore constants or not

Returns

bool

Definition at line 78 of file Yaml.php.

    {
        return self::$_ignoreConstants;
    }

setIgnoreConstants()

static setIgnoreConstants (   $flag )

static

Indicate whether parser should ignore constants or not

Parameters

bool

$flag

Returns

void

Definition at line 68 of file Yaml.php.

    {
        self::$_ignoreConstants = (bool) $flag;
    }

setYamlDecoder()

setYamlDecoder

(

$yamlDecoder

)

Set callback for decoding YAML

Parameters

callable

$yamlDecoder

the decoder to set

Returns

Zend_Config_Yaml

Definition at line 99 of file Yaml.php.

    {
        if (!is_callable($yamlDecoder)) {
            #require_once 'Zend/Config/Exception.php';
            throw new Zend_Config_Exception('Invalid parameter to setYamlDecoder() - must be callable');
        }

        $this->_yamlDecoder = $yamlDecoder;
        return $this;
    }

Field Documentation

$_ignoreConstants

$_ignoreConstants = false

staticprotected

Definition at line 60 of file Yaml.php.

$_skipExtends

$_skipExtends = false

protected

Definition at line 47 of file Yaml.php.

$_yamlDecoder

$_yamlDecoder = array(__CLASS__, 'decode')

protected

Definition at line 54 of file Yaml.php.

EXTENDS_NAME

const EXTENDS_NAME = "_extends"

Attribute name that indicates what section a config extends from

Definition at line 40 of file Yaml.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Config/Yaml.php