DataObjectHelper Class Reference

Public Member Functions
	__construct (ObjectFactory $objectFactory, \Magento\Framework\Reflection\DataObjectProcessor $objectProcessor, \Magento\Framework\Reflection\TypeProcessor $typeProcessor, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, \Magento\Framework\Api\ExtensionAttribute\JoinProcessorInterface $joinProcessor, MethodsMap $methodsMapProcessor)
	populateWithArray ($dataObject, array $data, $interfaceName)
	mergeDataObjects ( $interfaceName, $firstDataObject, $secondDataObject)
	getCustomAttributeValueByType (array $attributeValues, $type)

Protected Member Functions
	_setDataValues ($dataObject, array $data, $interfaceName)
	setComplexValue ( $dataObject, $getterMethodName, $methodName, array $value, $interfaceName)

Protected Attributes
	$objectFactory
	$objectProcessor
	$typeProcessor
	$extensionFactory
	$joinProcessor
	$methodsMapProcessor

Detailed Description

Data object helper.

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 16 of file DataObjectHelper.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ObjectFactory	$objectFactory,
		\Magento\Framework\Reflection\DataObjectProcessor	$objectProcessor,
		\Magento\Framework\Reflection\TypeProcessor	$typeProcessor,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory,
		\Magento\Framework\Api\ExtensionAttribute\JoinProcessorInterface	$joinProcessor,
		MethodsMap	$methodsMapProcessor
	)

Parameters

ObjectFactory	$objectFactory
\Magento\Framework\Reflection\DataObjectProcessor	$objectProcessor
\Magento\Framework\Reflection\TypeProcessor	$typeProcessor
\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory
\Magento\Framework\Api\ExtensionAttribute\JoinProcessorInterface	$joinProcessor
MethodsMap	$methodsMapProcessor

Definition at line 56 of file DataObjectHelper.php.

      {
        $this->objectFactory = $objectFactory;
        $this->objectProcessor = $objectProcessor;
        $this->typeProcessor = $typeProcessor;
        $this->extensionFactory = $extensionFactory;
        $this->joinProcessor = $joinProcessor;
        $this->methodsMapProcessor = $methodsMapProcessor;
    }

Member Function Documentation

_setDataValues()

_setDataValues (   $dataObject, array  $data,   $interfaceName  )

protected

Update Data Object with the data from array

Parameters

mixed	$dataObject
array	$data
string	$interfaceName

Returns

$this @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 98 of file DataObjectHelper.php.

    {
        $dataObjectMethods = get_class_methods(get_class($dataObject));
        foreach ($data as $key => $value) {
            /* First, verify is there any setter for the key on the Service Data Object */
            $camelCaseKey = \Magento\Framework\Api\SimpleDataObjectConverter::snakeCaseToUpperCamelCase($key);
            $possibleMethods = [
                'set' . $camelCaseKey,
                'setIs' . $camelCaseKey,
            ];
            if ($key === CustomAttributesDataInterface::CUSTOM_ATTRIBUTES
                && ($dataObject instanceof ExtensibleDataInterface)
                && is_array($data[$key])
                && !empty($data[$key])
            ) {
                foreach ($data[$key] as $customAttribute) {
                    $dataObject->setCustomAttribute(
                        $customAttribute[AttributeInterface::ATTRIBUTE_CODE],
                        $customAttribute[AttributeInterface::VALUE]
                    );
                }
            } elseif ($methodNames = array_intersect($possibleMethods, $dataObjectMethods)) {
                $methodName = array_values($methodNames)[0];
                if (!is_array($value)) {
                    if ($methodName === 'setExtensionAttributes' && $value === null) {
                        // Cannot pass a null value to a method with a typed parameter
                    } else {
                        $dataObject->$methodName($value);
                    }
                } else {
                    $getterMethodName = 'get' . $camelCaseKey;
                    $this->setComplexValue($dataObject, $getterMethodName, $methodName, $value, $interfaceName);
                }
            } elseif ($dataObject instanceof CustomAttributesDataInterface) {
                $dataObject->setCustomAttribute($key, $value);
            }
        }

        return $this;
    }

getCustomAttributeValueByType()

getCustomAttributeValueByType	(	array	$attributeValues,
			$type
	)

Filter attribute value objects for a provided data interface type from an array of custom attribute value objects

Parameters

	AttributeValue[]	$attributeValues Array of custom attribute
string	$type	Data interface type

Returns

AttributeValue[]

Definition at line 250 of file DataObjectHelper.php.

    {
        $attributeValueArray = [];
        if (empty($attributeValues)) {
            return $attributeValueArray;
        }
        foreach ($attributeValues as $attributeValue) {
            if ($attributeValue->getValue() instanceof $type) {
                $attributeValueArray[] = $attributeValue;
            }
        }
        return $attributeValueArray;
    }

mergeDataObjects()

mergeDataObjects	(		$interfaceName,
			$firstDataObject,
			$secondDataObject
	)

Merges second object onto the first

Parameters

string	$interfaceName
mixed	$firstDataObject
mixed	$secondDataObject

Returns

$this

Exceptions

Definition at line 230 of file DataObjectHelper.php.

      {
        if (!$firstDataObject instanceof $interfaceName || !$secondDataObject instanceof $interfaceName) {
            throw new \LogicException('Wrong prototype object given. It can only be of "' . $interfaceName . '" type.');
        }
        $secondObjectArray = $this->objectProcessor->buildOutputDataArray($secondDataObject, $interfaceName);
        $this->_setDataValues($firstDataObject, $secondObjectArray, $interfaceName);
        return $this;
    }

populateWithArray()

populateWithArray	(		$dataObject,
		array	$data,
			$interfaceName
	)

Populate data object using data in array format.

Parameters

mixed	$dataObject
array	$data
string	$interfaceName

Returns

$this

Definition at line 80 of file DataObjectHelper.php.

    {
        if ($dataObject instanceof ExtensibleDataInterface) {
            $data = $this->joinProcessor->extractExtensionAttributes(get_class($dataObject), $data);
        }
        $this->_setDataValues($dataObject, $data, $interfaceName);
        return $this;
    }

setComplexValue()

setComplexValue (   $dataObject,   $getterMethodName,   $methodName, array  $value,   $interfaceName  )

protected

Parameters

mixed	$dataObject
string	$getterMethodName
string	$methodName
array	$value
string	$interfaceName

Returns

$this @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 148 of file DataObjectHelper.php.

      {
        if ($interfaceName == null) {
            $interfaceName = get_class($dataObject);
        }
        $returnType = $this->methodsMapProcessor->getMethodReturnType($interfaceName, $getterMethodName);
        if ($this->typeProcessor->isTypeSimple($returnType)) {
            $dataObject->$methodName($value);
            return $this;
        }

        if ($this->typeProcessor->isArrayType($returnType)) {
            $type = $this->typeProcessor->getArrayItemType($returnType);
            $objects = [];
            foreach ($value as $arrayElementData) {
                $object = $this->objectFactory->create($type, []);
                $this->populateWithArray($object, $arrayElementData, $type);
                $objects[] = $object;
            }
            $dataObject->$methodName($objects);
            return $this;
        }

        if (is_subclass_of($returnType, \Magento\Framework\Api\ExtensibleDataInterface::class)) {
            $object = $this->objectFactory->create($returnType, []);
            $this->populateWithArray($object, $value, $returnType);
        } elseif (is_subclass_of($returnType, \Magento\Framework\Api\ExtensionAttributesInterface::class)) {
            foreach ($value as $extensionAttributeKey => $extensionAttributeValue) {
                $extensionAttributeGetterMethodName
                    = 'get' . \Magento\Framework\Api\SimpleDataObjectConverter::snakeCaseToUpperCamelCase(
                        $extensionAttributeKey
                    );
                $methodReturnType = $this->methodsMapProcessor->getMethodReturnType(
                    $returnType,
                    $extensionAttributeGetterMethodName
                );
                $extensionAttributeType = $this->typeProcessor->isArrayType($methodReturnType)
                    ? $this->typeProcessor->getArrayItemType($methodReturnType)
                    : $methodReturnType;
                if ($this->typeProcessor->isTypeSimple($extensionAttributeType)) {
                    $value[$extensionAttributeKey] = $extensionAttributeValue;
                } else {
                    if ($this->typeProcessor->isArrayType($methodReturnType)) {
                        foreach ($extensionAttributeValue as $key => $extensionAttributeArrayValue) {
                            $extensionAttribute = $this->objectFactory->create($extensionAttributeType, []);
                            $this->populateWithArray(
                                $extensionAttribute,
                                $extensionAttributeArrayValue,
                                $extensionAttributeType
                            );
                            $value[$extensionAttributeKey][$key] = $extensionAttribute;
                        }
                    } else {
                        $value[$extensionAttributeKey] = $this->objectFactory->create(
                            $extensionAttributeType,
                            ['data' => $extensionAttributeValue]
                        );
                    }
                }
            }
            $object = $this->extensionFactory->create(get_class($dataObject), ['data' => $value]);
        } else {
            $object = $this->objectFactory->create($returnType, $value);
        }
        $dataObject->$methodName($object);
        return $this;
    }

Field Documentation

$extensionFactory

$extensionFactory

protected

Definition at line 36 of file DataObjectHelper.php.

$joinProcessor

$joinProcessor

protected

Definition at line 41 of file DataObjectHelper.php.

$methodsMapProcessor

$methodsMapProcessor

protected

Definition at line 46 of file DataObjectHelper.php.

$objectFactory

$objectFactory

protected

Definition at line 21 of file DataObjectHelper.php.

$objectProcessor

$objectProcessor

protected

Definition at line 26 of file DataObjectHelper.php.

$typeProcessor

$typeProcessor

protected

Definition at line 31 of file DataObjectHelper.php.

---

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

• vendor/magento/framework/Api/DataObjectHelper.php