Zend_Config_Writer_Yaml Class Reference

Inheritance diagram for Zend_Config_Writer_Yaml:

Public Member Functions
	getYamlEncoder ()
	setYamlEncoder ($yamlEncoder)
	render ()
Public Member Functions inherited from Zend_Config_Writer_FileAbstract
	setFilename ($filename)
	setExclusiveLock ($exclusiveLock)
	write ($filename=null, Zend_Config $config=null, $exclusiveLock=null)
	render ()
Public Member Functions inherited from Zend_Config_Writer
	__construct (array $options=null)
	setConfig (Zend_Config $config)
	setOptions (array $options)
	write ()

Static Public Member Functions
static	encode ($data)

Static Protected Member Functions
static	_encodeYaml ($indent, $data)

Protected Attributes
	$_yamlEncoder = array('Zend_Config_Writer_Yaml', 'encode')
Protected Attributes inherited from Zend_Config_Writer_FileAbstract
	$_filename = null
	$_exclusiveLock = false
Protected Attributes inherited from Zend_Config_Writer
	$_skipOptions
	$_config = null

Detailed Description

Definition at line 38 of file Yaml.php.

Member Function Documentation

_encodeYaml()

static _encodeYaml (   $indent,   $data  )

staticprotected

Service function for encoding YAML

Parameters

int	$indent	Current indent level
array	$data	Data to encode

Returns

string

Definition at line 128 of file Yaml.php.

    {
        reset($data);
        $result = "";
        $numeric = is_numeric(key($data));

        foreach($data as $key => $value) {
            if(is_array($value)) {
                $encoded = "\n".self::_encodeYaml($indent+1, $value);
            } else {
                $encoded = (string)$value."\n";
            }
            $result .= str_repeat("  ", $indent).($numeric?"- ":"$key: ").$encoded;
        }
        return $result;
    }

encode()

static encode (   $data )

static

Very dumb YAML encoder

Until we have Zend_Yaml...

Parameters

array

$data

YAML data

Returns

string

Definition at line 116 of file Yaml.php.

    {
        return self::_encodeYaml(0, $data);
    }

getYamlEncoder()

getYamlEncoder

(

)

Get callback for decoding YAML

Returns

callable

Definition at line 52 of file Yaml.php.

    {
        return $this->_yamlEncoder;
    }

render()

render

(

)

Render a Zend_Config into a YAML config string.

Since

1.10

Returns

string

Definition at line 80 of file Yaml.php.

    {
        $data        = $this->_config->toArray();
        $sectionName = $this->_config->getSectionName();
        $extends     = $this->_config->getExtends();

        if (is_string($sectionName)) {
            $data = array($sectionName => $data);
        }

        foreach ($extends as $section => $parentSection) {
            $data[$section][Zend_Config_Yaml::EXTENDS_NAME] = $parentSection;
        }

        // Ensure that each "extends" section actually exists
        foreach ($data as $section => $sectionData) {
            if (is_array($sectionData) && isset($sectionData[Zend_Config_Yaml::EXTENDS_NAME])) {
                $sectionExtends = $sectionData[Zend_Config_Yaml::EXTENDS_NAME];
                if (!isset($data[$sectionExtends])) {
                    // Remove "extends" declaration if section does not exist
                    unset($data[$section][Zend_Config_Yaml::EXTENDS_NAME]);
                }
            }
        }

        return call_user_func($this->getYamlEncoder(), $data);
    }

setYamlEncoder()

setYamlEncoder

(

$yamlEncoder

)

Set callback for decoding YAML

Parameters

callable

$yamlEncoder

the decoder to set

Returns

Zend_Config_Yaml

Definition at line 63 of file Yaml.php.

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

        $this->_yamlEncoder = $yamlEncoder;
        return $this;
    }

Field Documentation

$_yamlEncoder

$_yamlEncoder = array('Zend_Config_Writer_Yaml', 'encode')

protected

Definition at line 45 of file Yaml.php.

---

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

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