Zend_Config_Json Class Reference

Inheritance diagram for Zend_Config_Json:

Public Member Functions
	__construct ($json, $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)

Data Fields
const	EXTENDS_NAME = "_extends"

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

Protected Attributes
	$_ignoreConstants = false
	$_skipExtends = false
Protected Attributes inherited from Zend_Config
	$_allowModifications
	$_index
	$_count
	$_data
	$_skipNextIteration
	$_loadedSection
	$_extends = array()
	$_loadFileErrorStr = null

Detailed Description

Definition at line 40 of file Json.php.

Constructor & Destructor Documentation

__construct()

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

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

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".

Parameters

string	$json	JSON file or string to process
mixed	$section	Section to process
boolean	$options	Whether modifiacations are allowed at runtime

Exceptions

Zend_Config_Exception	When JSON text is not set or cannot be loaded
Zend_Config_Exception	When section $sectionName cannot be found in $json

Definition at line 82 of file Json.php.

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

        $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':
                        $this->_ignoreConstants = (bool) $value;
                        break;
                    default:
                        break;
                }
            }
        }

        set_error_handler(array($this, '_loadFileErrorHandler')); // Warnings and errors are suppressed
        if ($json[0] != '{') {
            $json = file_get_contents($json);
        }
        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);
        }

        // Replace constants
        if (!$this->_ignoreConstants) {
            $json = $this->_replaceConstants($json);
        }

        // Parse/decode
        try {
            $config = Zend_Json::decode($json);
        } catch (Zend_Json_Exception $e) {
            // decode failed
            #require_once 'Zend/Config/Exception.php';
            throw new Zend_Config_Exception("Error parsing JSON data");
        }

        if ($section === null) {
            $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', $sectionName));
                }

                $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', $section));
            }

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

            parent::__construct($dataArray, $allowModifications);
        }

        $this->_loadedSection = $section;
    }

Member Function Documentation

_getConstants()

_getConstants ( )

protected

Get (reverse) sorted list of defined constant names

Returns

array

Definition at line 236 of file Json.php.

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

_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

Exceptions

Zend_Config_Exception

When $section cannot be found

Returns

array

Definition at line 186 of file Json.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])) {
            if (is_array($thisSection[self::EXTENDS_NAME])) {
                #require_once 'Zend/Config/Exception.php';
                throw new Zend_Config_Exception('Invalid extends clause: must be a string; array received');
            }
            $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()

_replaceConstants (   $value )

protected

Replace any constants referenced in a string with their values

Parameters

string

$value

Returns

string

Definition at line 219 of file Json.php.

    {
        foreach ($this->_getConstants() as $constant) {
            if (strstr($value, $constant)) {
                // handle backslashes that may represent windows path names for instance
                $replacement = str_replace('\\', '\\\\', constant($constant));
                $value = str_replace($constant, $replacement, $value);
            }
        }
        return $value;
    }

Field Documentation

$_ignoreConstants

$_ignoreConstants = false

protected

Definition at line 55 of file Json.php.

$_skipExtends

$_skipExtends = false

protected

Definition at line 62 of file Json.php.

EXTENDS_NAME

const EXTENDS_NAME = "_extends"

Name of object key indicating section current section extends

Definition at line 45 of file Json.php.

---

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

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