DataObject Class Reference

Inheritance diagram for DataObject:

Data Structures
class	CopyTest

Public Member Functions
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)

Protected Member Functions
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$_data = []

Static Protected Attributes
static	$_underscoreCache = []

Detailed Description

Universal data container with array access implementation

@api @SuppressWarnings(PHPMD.NumberOfChildren)

Since

100.0.2

Definition at line 15 of file DataObject.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$data = []

)

Constructor

By default is looking for first argument as array and assigns it as object attributes This behavior may change in child classes

Parameters

array

$data

Definition at line 39 of file DataObject.php.

    {
        $this->_data = $data;
    }

Member Function Documentation

__call()

__call	(		$method,
			$args
	)

Set/Get attribute wrapper

Parameters

string	$method
array	$args

Returns

mixed

Exceptions

Definition at line 380 of file DataObject.php.

    {
        switch (substr($method, 0, 3)) {
            case 'get':
                $key = $this->_underscore(substr($method, 3));
                $index = isset($args[0]) ? $args[0] : null;
                return $this->getData($key, $index);
            case 'set':
                $key = $this->_underscore(substr($method, 3));
                $value = isset($args[0]) ? $args[0] : null;
                return $this->setData($key, $value);
            case 'uns':
                $key = $this->_underscore(substr($method, 3));
                return $this->unsetData($key);
            case 'has':
                $key = $this->_underscore(substr($method, 3));
                return isset($this->_data[$key]);
        }
        throw new \Magento\Framework\Exception\LocalizedException(
            new \Magento\Framework\Phrase('Invalid method %1::%2', [get_class($this), $method])
        );
    }

_getData()

_getData (   $key )

protected

Get value from _data array without parse key

Parameters

string

$key

Returns

mixed

Definition at line 189 of file DataObject.php.

    {
        if (isset($this->_data[$key])) {
            return $this->_data[$key];
        }
        return null;
    }

_underscore()

_underscore (   $name )

protected

Converts field names for setters and getters

$this->setMyField($value) === $this->setData('my_field', $value) Uses cache to eliminate unnecessary preg_replace

Parameters

string

$name

Returns

string

Definition at line 425 of file DataObject.php.

    {
        if (isset(self::$_underscoreCache[$name])) {
            return self::$_underscoreCache[$name];
        }
        $result = strtolower(trim(preg_replace('/([A-Z]|[0-9]+)/', "_$1", $name), '_'));
        self::$_underscoreCache[$name] = $result;
        return $result;
    }

addData()

addData

(

array

$arr

)

Add data to the object.

Retains previous data in the object.

Parameters

array

$arr

Returns

$this

Definition at line 52 of file DataObject.php.

    {
        foreach ($arr as $index => $value) {
            $this->setData($index, $value);
        }
        return $this;
    }

convertToArray()

convertToArray

(

array

$keys = []

)

The "__" style wrapper for toArray method

Parameters

array

$keys

Returns

array

Definition at line 268 of file DataObject.php.

    {
        return $this->toArray($keys);
    }

convertToJson()

convertToJson

(

array

$keys = []

)

The "__" style wrapper for toJson

Parameters

array

$keys

Returns

bool|string

Exceptions

Definition at line 345 of file DataObject.php.

    {
        return $this->toJson($keys);
    }

convertToXml()

convertToXml	(	array	$arrAttributes = [],
			$rootName = 'item',
			$addOpenTag = false,
			$addCdata = true
	)

The "__" style wrapper for toXml method

Parameters

array	$arrAttributes	array of keys that must be represented
string	$rootName	root node name
bool	$addOpenTag	flag that allow to add initial xml node
bool	$addCdata	flag that require wrap all values in CDATA

Returns

string

Definition at line 316 of file DataObject.php.

      {
        return $this->toXml($arrAttributes, $rootName, $addOpenTag, $addCdata);
    }

debug()

debug	(		$data = null,
		&	$objects = []
	)

Present object data as string in debug mode

Parameters

mixed	$data
array	&$objects

Returns

array

Definition at line 469 of file DataObject.php.

    {
        if ($data === null) {
            $hash = spl_object_hash($this);
            if (!empty($objects[$hash])) {
                return '*** RECURSION ***';
            }
            $objects[$hash] = true;
            $data = $this->getData();
        }
        $debug = [];
        foreach ($data as $key => $value) {
            if (is_scalar($value)) {
                $debug[$key] = $value;
            } elseif (is_array($value)) {
                $debug[$key] = $this->debug($value, $objects);
            } elseif ($value instanceof \Magento\Framework\DataObject) {
                $debug[$key . ' (' . get_class($value) . ')'] = $value->debug(null, $objects);
            }
        }
        return $debug;
    }

getData()

getData	(		$key = '',
			$index = null
	)

Object data getter

If $key is not defined will return all the data as an array. Otherwise it will return value of the element specified by $key. It is possible to use keys like a/b/c for access nested array data

If $index is specified it will assume that attribute data is an array and retrieve corresponding member. If data is the string - it will be explode by new line character and converted to array.

Parameters

string	$key
string | int	$index

Returns

mixed

Definition at line 119 of file DataObject.php.

    {
        if ('' === $key) {
            return $this->_data;
        }

        /* process a/b/c key as ['a']['b']['c'] */
        if (strpos($key, '/') !== false) {
            $data = $this->getDataByPath($key);
        } else {
            $data = $this->_getData($key);
        }

        if ($index !== null) {
            if ($data === (array)$data) {
                $data = isset($data[$index]) ? $data[$index] : null;
            } elseif (is_string($data)) {
                $data = explode(PHP_EOL, $data);
                $data = isset($data[$index]) ? $data[$index] : null;
            } elseif ($data instanceof \Magento\Framework\DataObject) {
                $data = $data->getData($index);
            } else {
                $data = null;
            }
        }
        return $data;
    }

getDataByKey()

getDataByKey

(

$key

)

Get object data by particular key

Parameters

string

$key

Returns

mixed

Definition at line 178 of file DataObject.php.

    {
        return $this->_getData($key);
    }

getDataByPath()

getDataByPath

(

$path

)

Get object data by path

Method consider the path as chain of keys: a/b/c => ['a']['b']['c']

Parameters

string

$path

Returns

mixed

Definition at line 155 of file DataObject.php.

    {
        $keys = explode('/', $path);

        $data = $this->_data;
        foreach ($keys as $key) {
            if ((array)$data === $data && isset($data[$key])) {
                $data = $data[$key];
            } elseif ($data instanceof \Magento\Framework\DataObject) {
                $data = $data->getDataByKey($key);
            } else {
                return null;
            }
        }
        return $data;
    }

getDataUsingMethod()

getDataUsingMethod	(		$key,
			$args = null
	)

Get object data by key with calling getter method

Parameters

string	$key
mixed	$args

Returns

mixed

Definition at line 218 of file DataObject.php.

    {
        $method = 'get' . str_replace(' ', '', ucwords(str_replace('_', ' ', $key)));
        return $this->{$method}($args);
    }

hasData()

hasData

(

$key = ''

)

If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.

Parameters

string

$key

Returns

bool

Definition at line 231 of file DataObject.php.

    {
        if (empty($key) || !is_string($key)) {
            return !empty($this->_data);
        }
        return array_key_exists($key, $this->_data);
    }

isEmpty()

isEmpty

(

)

Checks whether the object is empty

Returns

bool

Definition at line 408 of file DataObject.php.

    {
        if (empty($this->_data)) {
            return true;
        }
        return false;
    }

offsetExists()

offsetExists

(

$offset

)

Implementation of \ArrayAccess::offsetExists()

Parameters

string

$offset

Returns

bool http://www.php.net/manual/en/arrayaccess.offsetexists.php

Definition at line 512 of file DataObject.php.

    {
        return isset($this->_data[$offset]) || array_key_exists($offset, $this->_data);
    }

offsetGet()

offsetGet

(

$offset

)

Implementation of \ArrayAccess::offsetGet()

Parameters

string

$offset

Returns

mixed http://www.php.net/manual/en/arrayaccess.offsetget.php

Definition at line 536 of file DataObject.php.

    {
        if (isset($this->_data[$offset])) {
            return $this->_data[$offset];
        }
        return null;
    }

offsetSet()

offsetSet	(		$offset,
			$value
	)

Implementation of \ArrayAccess::offsetSet()

Parameters

string	$offset
mixed	$value

Returns

void http://www.php.net/manual/en/arrayaccess.offsetset.php

Definition at line 500 of file DataObject.php.

    {
        $this->_data[$offset] = $value;
    }

offsetUnset()

offsetUnset

(

$offset

)

Implementation of \ArrayAccess::offsetUnset()

Parameters

string

$offset

Returns

void http://www.php.net/manual/en/arrayaccess.offsetunset.php

Definition at line 524 of file DataObject.php.

    {
        unset($this->_data[$offset]);
    }

serialize()

serialize	(		$keys = [],
			$valueSeparator = '=',
			$fieldSeparator = ' ',
			$quote = '"'
	)

Convert object data into string with defined keys and values.

Example: key1="value1" key2="value2" ...

Parameters

array	$keys	array of accepted keys
string	$valueSeparator	separator between key and value
string	$fieldSeparator	separator between key/value pairs
string	$quote	quoting sign

Returns

string

Definition at line 446 of file DataObject.php.

    {
        $data = [];
        if (empty($keys)) {
            $keys = array_keys($this->_data);
        }

        foreach ($this->_data as $key => $value) {
            if (in_array($key, $keys)) {
                $data[] = $key . $valueSeparator . $quote . $value . $quote;
            }
        }
        $res = implode($fieldSeparator, $data);
        return $res;
    }

setData()

setData	(		$key,
			$value = null
	)

Overwrite data in the object.

The $key parameter can be string or array. If $key is string, the attribute value will be overwritten by $value

If $key is an array, it will overwrite all the data in the object.

Parameters

string | array	$key
mixed	$value

Returns

$this

Definition at line 72 of file DataObject.php.

    {
        if ($key === (array)$key) {
            $this->_data = $key;
        } else {
            $this->_data[$key] = $value;
        }
        return $this;
    }

setDataUsingMethod()

setDataUsingMethod	(		$key,
			$args = []
	)

Set object data with calling setter method

Parameters

string	$key
mixed	$args

Returns

$this

Definition at line 204 of file DataObject.php.

    {
        $method = 'set' . str_replace(' ', '', ucwords(str_replace('_', ' ', $key)));
        $this->{$method}($args);
        return $this;
    }

toArray()

toArray

(

array

$keys = []

)

Convert array of object data with to array with keys requested in $keys array

Parameters

array

$keys

array of required keys

Returns

array

Definition at line 245 of file DataObject.php.

    {
        if (empty($keys)) {
            return $this->_data;
        }

        $result = [];
        foreach ($keys as $key) {
            if (isset($this->_data[$key])) {
                $result[$key] = $this->_data[$key];
            } else {
                $result[$key] = null;
            }
        }
        return $result;
    }

toJson()

toJson

(

array

$keys = []

)

Convert object data to JSON

Parameters

array

$keys

array of required keys

Returns

bool|string

Exceptions

Definition at line 332 of file DataObject.php.

    {
        $data = $this->toArray($keys);
        return \Magento\Framework\Serialize\JsonConverter::convert($data);
    }

toString()

toString

(

$format = ''

)

Convert object data into string with predefined format

Will use $format as an template and substitute {{key}} for attributes

Parameters

string

$format

Returns

string

Definition at line 358 of file DataObject.php.

    {
        if (empty($format)) {
            $result = implode(', ', $this->getData());
        } else {
            preg_match_all('/\{\{([a-z0-9_]+)\}\}/is', $format, $matches);
            foreach ($matches[1] as $var) {
                $format = str_replace('{{' . $var . '}}', $this->getData($var), $format);
            }
            $result = $format;
        }
        return $result;
    }

toXml()

toXml	(	array	$keys = [],
			$rootName = 'item',
			$addOpenTag = false,
			$addCdata = true
	)

Convert object data into XML string

Parameters

array	$keys	array of keys that must be represented
string	$rootName	root node name
bool	$addOpenTag	flag that allow to add initial xml node
bool	$addCdata	flag that require wrap all values in CDATA

Returns

string

Definition at line 282 of file DataObject.php.

    {
        $xml = '';
        $data = $this->toArray($keys);
        foreach ($data as $fieldName => $fieldValue) {
            if ($addCdata === true) {
                $fieldValue = "<![CDATA[{$fieldValue}]]>";
            } else {
                $fieldValue = str_replace(
                    ['&', '"', "'", '<', '>'],
                    ['&amp;', '&quot;', '&apos;', '&lt;', '&gt;'],
                    $fieldValue
                );
            }
            $xml .= "<{$fieldName}>{$fieldValue}</{$fieldName}>\n";
        }
        if ($rootName) {
            $xml = "<{$rootName}>\n{$xml}</{$rootName}>\n";
        }
        if ($addOpenTag) {
            $xml = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $xml;
        }
        return $xml;
    }

unsetData()

unsetData

(

$key = null

)

Unset data from the object.

Parameters

null | string | array

$key

Returns

$this

Definition at line 88 of file DataObject.php.

    {
        if ($key === null) {
            $this->setData([]);
        } elseif (is_string($key)) {
            if (isset($this->_data[$key]) || array_key_exists($key, $this->_data)) {
                unset($this->_data[$key]);
            }
        } elseif ($key === (array)$key) {
            foreach ($key as $element) {
                $this->unsetData($element);
            }
        }
        return $this;
    }

Field Documentation

$_data

$_data = []

protected

Definition at line 22 of file DataObject.php.

$_underscoreCache

$_underscoreCache = []

staticprotected

Definition at line 29 of file DataObject.php.

---

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

• vendor/magento/framework/DataObject.php