Copy Class Reference

Public Member Functions
	__construct (\Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Framework\DataObject\Copy\Config $fieldsetConfig, \Magento\Framework\Api\ExtensionAttributesFactory $extensionAttributesFactory)
	copyFieldsetToTarget ($fieldset, $aspect, $source, $target, $root='global')
	getDataFromFieldset ($fieldset, $aspect, $source, $root='global')

Protected Member Functions
	dispatchCopyFieldSetEvent ($fieldset, $aspect, $source, $target, $root, $targetIsArray)
	_isFieldsetInputValid ($source, $target)
	_getFieldsetFieldValue ($source, $code)
	_setFieldsetFieldValue ($target, $targetCode, $value)
	getAttributeValueFromExtensibleDataObject ($source, $code)
	setAttributeValueFromExtensibleDataObject ($target, $code, $value)

Protected Attributes
	$fieldsetConfig
	$eventManager = null
	$extensionAttributesFactory

Detailed Description

Definition at line 12 of file Copy.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Framework\DataObject\Copy\Config	$fieldsetConfig,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionAttributesFactory
	)

Parameters

\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Framework\DataObject\Copy\Config	$fieldsetConfig
\Magento\Framework\Api\ExtensionAttributesFactory	$extensionAttributesFactory

Definition at line 36 of file Copy.php.

      {
        $this->eventManager = $eventManager;
        $this->fieldsetConfig = $fieldsetConfig;
        $this->extensionAttributesFactory = $extensionAttributesFactory;
    }

Member Function Documentation

_getFieldsetFieldValue()

_getFieldsetFieldValue (   $source,   $code  )

protected

Get value of source by code

Parameters

mixed	$source
string	$code

Returns

mixed

Exceptions

Definition at line 182 of file Copy.php.

    {
        if (is_array($source)) {
            $value = isset($source[$code]) ? $source[$code] : null;
        } elseif ($source instanceof \Magento\Framework\DataObject) {
            $value = $source->getDataUsingMethod($code);
        } elseif ($source instanceof \Magento\Framework\Api\ExtensibleDataInterface) {
            $value = $this->getAttributeValueFromExtensibleDataObject($source, $code);
        } elseif ($source instanceof \Magento\Framework\Api\AbstractSimpleObject) {
            $sourceArray = $source->__toArray();
            $value = isset($sourceArray[$code]) ? $sourceArray[$code] : null;
        } else {
            throw new \InvalidArgumentException(
                'Source should be array, Magento Object, ExtensibleDataInterface, or AbstractSimpleObject'
            );
        }
        return $value;
    }

_isFieldsetInputValid()

_isFieldsetInputValid (   $source,   $target  )

protected

Check if source and target are valid input for converting using fieldset

Parameters

array | \Magento\Framework\DataObject	$source
array | \Magento\Framework\DataObject	$target

Returns

bool

Definition at line 163 of file Copy.php.

    {
        return (is_array($source) || $source instanceof \Magento\Framework\DataObject ||
            $source instanceof \Magento\Framework\Api\ExtensibleDataInterface ||
            $source instanceof \Magento\Framework\Api\AbstractSimpleObject) && (
            is_array($target) || $target instanceof \Magento\Framework\DataObject ||
            $target instanceof \Magento\Framework\Api\ExtensibleDataInterface ||
            $target instanceof \Magento\Framework\Api\AbstractSimpleObject);
    }

_setFieldsetFieldValue()

_setFieldsetFieldValue (   $target,   $targetCode,   $value  )

protected

Set value of target by code

Parameters

mixed	$target
string	$targetCode
mixed	$value

Returns

mixed

Exceptions

Definition at line 211 of file Copy.php.

    {
        $targetIsArray = is_array($target);

        if ($targetIsArray) {
            $target[$targetCode] = $value;
        } elseif ($target instanceof \Magento\Framework\DataObject) {
            $target->setDataUsingMethod($targetCode, $value);
        } elseif ($target instanceof \Magento\Framework\Api\ExtensibleDataInterface) {
            $this->setAttributeValueFromExtensibleDataObject($target, $targetCode, $value);
        } elseif ($target instanceof \Magento\Framework\Api\AbstractSimpleObject) {
            $target->setData($targetCode, $value);
        } else {
            throw new \InvalidArgumentException(
                'Source should be array, Magento Object, ExtensibleDataInterface, or AbstractSimpleObject'
            );
        }

        return $target;
    }

copyFieldsetToTarget()

copyFieldsetToTarget	(		$fieldset,
			$aspect,
			$source,
			$target,
			$root = 'global'
	)

Copy data from object|array to object|array containing fields from fieldset matching an aspect.

Contents of $aspect are a field name in target object or array. If targetField attribute is not provided - will be used the same name as in the source object or array.

Parameters

string	$fieldset
string	$aspect
array | \Magento\Framework\DataObject	$source
array | \Magento\Framework\DataObject	$target
string	$root

Returns

array|\Magento\Framework\DataObject|null the value of $target

Exceptions

Definition at line 62 of file Copy.php.

    {
        if (!$this->_isFieldsetInputValid($source, $target)) {
            return null;
        }
        $fields = $this->fieldsetConfig->getFieldset($fieldset, $root);
        if ($fields === null) {
            return $target;
        }
        $targetIsArray = is_array($target);

        foreach ($fields as $code => $node) {
            if (empty($node[$aspect])) {
                continue;
            }

            $value = $this->_getFieldsetFieldValue($source, $code);

            $targetCode = (string)$node[$aspect];
            $targetCode = $targetCode == '*' ? $code : $targetCode;

            $target = $this->_setFieldsetFieldValue($target, $targetCode, $value);
        }

        $target = $this->dispatchCopyFieldSetEvent($fieldset, $aspect, $source, $target, $root, $targetIsArray);

        return $target;
    }

dispatchCopyFieldSetEvent()

dispatchCopyFieldSetEvent (   $fieldset,   $aspect,   $source,   $target,   $root,   $targetIsArray  )

protected

Dispatch copy fieldset event

Parameters

string	$fieldset
string	$aspect
array | \Magento\Framework\DataObject	$source
array | \Magento\Framework\DataObject	$target
string	$root
bool	$targetIsArray

Returns

\Magento\Framework\DataObject|mixed

Definition at line 102 of file Copy.php.

    {
        $eventName = sprintf('core_copy_fieldset_%s_%s', $fieldset, $aspect);
        if ($targetIsArray) {
            $target = new \Magento\Framework\DataObject($target);
        }
        $this->eventManager->dispatch(
            $eventName,
            ['target' => $target, 'source' => $source, 'root' => $root]
        );
        if ($targetIsArray) {
            $target = $target->getData();
        }
        return $target;
    }

getAttributeValueFromExtensibleDataObject()

getAttributeValueFromExtensibleDataObject (   $source,   $code  )

protected

Access the extension get method

Parameters

\Magento\Framework\Api\ExtensibleDataInterface	$object
string	$code

Returns

mixed

Exceptions

Definition at line 241 of file Copy.php.

    {
        $method = 'get' . str_replace(' ', '', ucwords(str_replace('_', ' ', $code)));

        $methodExists = method_exists($source, $method);
        if ($methodExists == true) {
            $value = $source->{$method}();
        } else {
            // If we couldn't find the method, check if we can get it from the extension attributes
            $extensionAttributes = $source->getExtensionAttributes();
            if ($extensionAttributes == null) {
                throw new \InvalidArgumentException('Method in extension does not exist.');
            } else {
                $extensionMethodExists = method_exists($extensionAttributes, $method);
                if ($extensionMethodExists == true) {
                    $value = $extensionAttributes->{$method}();
                } else {
                    throw new \InvalidArgumentException('Attribute in object does not exist.');
                }
            }
        }
        return $value;
    }

getDataFromFieldset()

getDataFromFieldset	(		$fieldset,
			$aspect,
			$source,
			$root = 'global'
	)

Get data from object|array to object|array containing fields from fieldset matching an aspect.

Parameters

string	$fieldset
string	$aspect	a field name
array | \Magento\Framework\DataObject	$source
string	$root

Returns

array $data

@api

Definition at line 130 of file Copy.php.

    {
        if (!(is_array($source) || $source instanceof \Magento\Framework\DataObject)) {
            return null;
        }
        $fields = $this->fieldsetConfig->getFieldset($fieldset, $root);
        if ($fields === null) {
            return null;
        }

        $data = [];
        foreach ($fields as $code => $node) {
            if (empty($node[$aspect])) {
                continue;
            }

            $value = $this->_getFieldsetFieldValue($source, $code);

            $targetCode = (string)$node[$aspect];
            $targetCode = $targetCode == '*' ? $code : $targetCode;
            $data[$targetCode] = $value;
        }

        return $data;
    }

setAttributeValueFromExtensibleDataObject()

setAttributeValueFromExtensibleDataObject (   $target,   $code,   $value  )

protected

Access the extension set method

Parameters

\Magento\Framework\Api\ExtensibleDataInterface	$object
string	$code
mixed	$value

Returns

null

Exceptions

Definition at line 275 of file Copy.php.

    {
        $method = 'set' . str_replace(' ', '', ucwords(str_replace('_', ' ', $code)));

        $methodExists = method_exists($target, $method);
        if ($methodExists == true) {
            $target->{$method}($value);
        } else {
            // If we couldn't find the method, check if we can set it from the extension attributes
            $extensionAttributes = $target->getExtensionAttributes();
            if ($extensionAttributes == null) {
                $extensionAttributes = $this->extensionAttributesFactory->create(get_class($target));
            }
            $extensionMethodExists = method_exists($extensionAttributes, $method);
            if ($extensionMethodExists == true) {
                $extensionAttributes->{$method}($value);
                $target->setExtensionAttributes($extensionAttributes);
            } else {
                throw new \InvalidArgumentException('Attribute in object does not exist.');
            }
        }

        return null;
    }

Field Documentation

$eventManager

$eventManager = null

protected

Definition at line 24 of file Copy.php.

$extensionAttributesFactory

$extensionAttributesFactory

protected

Definition at line 29 of file Copy.php.

$fieldsetConfig

$fieldsetConfig

protected

Definition at line 17 of file Copy.php.

---

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

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