DataObject Class Reference

Public Member Functions
	convertDataToArray ($data)
	toOptionArray (array $items, $idField, $valueField)
	toOptionHash (array $items, $idField, $valueField)

Data Fields
const	CYCLE_DETECTED_MARK = '*** CYCLE DETECTED ***'

Protected Member Functions
	_convertObjectToArray ($obj, &$objects=[])
	_invokeGetter ($item, $field)

Detailed Description

Definition at line 14 of file DataObject.php.

Member Function Documentation

_convertObjectToArray()

_convertObjectToArray (   $obj, &  $objects = []  )

protected

Converts a \Magento\Framework\DataObject into an array, including any children objects

Parameters

mixed	$obj	array or object to convert
array	$objects	array of object hashes used for cycle detection

Returns

array|string Converted object or CYCLE_DETECTED_MARK

Definition at line 46 of file DataObject.php.

    {
        $data = [];
        if (is_object($obj)) {
            $hash = spl_object_hash($obj);
            if (!empty($objects[$hash])) {
                return self::CYCLE_DETECTED_MARK;
            }
            $objects[$hash] = true;
            if ($obj instanceof \Magento\Framework\DataObject) {
                $data = $obj->getData();
            } else {
                $data = (array)$obj;
            }
        } elseif (is_array($obj)) {
            $data = $obj;
        }

        $result = [];
        foreach ($data as $key => $value) {
            if (is_scalar($value)) {
                $result[$key] = $value;
            } elseif (is_array($value)) {
                $result[$key] = $this->_convertObjectToArray($value, $objects);
            } elseif ($value instanceof \Magento\Framework\DataObject) {
                $result[$key] = $this->_convertObjectToArray($value, $objects);
            }
        }
        return $result;
    }

_invokeGetter()

_invokeGetter (   $item,   $field  )

protected

Returns the value of the property represented by $field on the $item object.

When $field is a closure, the $item parameter is passed to the $field method, otherwise the $field is assumed to be a property name, and the associated get method is invoked on the $item instead.

Parameters

mixed	$item
string | callable	$field

Returns

mixed

Definition at line 133 of file DataObject.php.

    {
        if (is_callable($field)) {
            // if $field is a closure, use that on the item
            return $field($item);
        } else {
            // otherwise, turn it into a call to the item's getter method
            $methodName = 'get' . str_replace(' ', '', ucwords(str_replace('_', ' ', $field)));
            return $item->{$methodName}();
        }
    }

convertDataToArray()

convertDataToArray

(

$data

)

Convert input data into an array and return the resulting array. The resulting array should not contain any objects.

Parameters

array

$data

input data

Returns

array Data converted to an array

Definition at line 26 of file DataObject.php.

    {
        $result = [];
        foreach ($data as $key => $value) {
            if (is_object($value) || is_array($value)) {
                $result[$key] = $this->_convertObjectToArray($value);
            } else {
                $result[$key] = $value;
            }
        }
        return $result;
    }

toOptionArray()

toOptionArray	(	array	$items,
			$idField,
			$valueField
	)

Converts the list of objects into an array of the form: [ [ 'label' => <id>, 'value' =>

], ... ].

The <id> and

values are taken from the objects in the list using the $idField and $valueField parameters, which can be either the name of the field to use, or a closure.

Parameters

array	$items
string | callable	$idField
string | callable	$valueField

Returns

array

Definition at line 89 of file DataObject.php.

    {
        $options = [];
        foreach ($items as $item) {
            $options[] = [
                'value' => $this->_invokeGetter($item, $idField),
                'label' => $this->_invokeGetter($item, $valueField),
            ];
        }
        return $options;
    }

toOptionHash()

toOptionHash	(	array	$items,
			$idField,
			$valueField
	)

Converts the list of objects into an array of the form: [ <id> =>

, ... ].

The <id> and

values are taken from the objects in the list using the $idField and $valueField parameters, which can be either the name of the field to use, or a closure.

Parameters

array	$items
string | callable	$idField
string | callable	$valueField

Returns

array

Definition at line 113 of file DataObject.php.

    {
        $options = [];
        foreach ($items as $item) {
            $options[$this->_invokeGetter($item, $idField)] = $this->_invokeGetter($item, $valueField);
        }
        return $options;
    }

Field Documentation

CYCLE_DETECTED_MARK

const CYCLE_DETECTED_MARK = '*** CYCLE DETECTED ***'

Constant used to mark cycles in the input array/objects

Definition at line 17 of file DataObject.php.

---

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

• vendor/magento/framework/Convert/DataObject.php