DataPersistenceHandler.php

Go to the documentation of this file.

<?php
namespace Magento\FunctionalTestingFramework\DataGenerator\Persist;

use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;

class DataPersistenceHandler
{
    private $entityObject;

    private $createdObject;

    private $dependentObjects;

    private $storeCode;

    public function __construct($entityObject, $dependentObjects = [], $customFields = [])
    {
        // merge any custom fields into a new EntityDataObject for the persistence handler
        if (!empty($customFields)) {
            $this->entityObject = new EntityDataObject(
                $entityObject->getName(),
                $entityObject->getType(),
                array_merge($entityObject->getAllData(), $customFields),
                $entityObject->getLinkedEntities(),
                $this->stripCustomFieldsFromUniquenessData($entityObject->getUniquenessData(), $customFields),
                $entityObject->getVarReferences()
            );
        } else {
            $this->entityObject = clone $entityObject;
        }
        $this->storeCode = null;

        foreach ($dependentObjects as $dependentObject) {
            $this->dependentObjects[] = $dependentObject->getCreatedObject();
        }
    }

    public function createEntity($storeCode = null)
    {
        if (!empty($storeCode)) {
            $this->storeCode = $storeCode;
        }
        $curlHandler = new CurlHandler('create', $this->entityObject, $this->storeCode);
        $result = $curlHandler->executeRequest($this->dependentObjects);
        $this->setCreatedObject(
            $result,
            null,
            $curlHandler->getRequestDataArray(),
            $curlHandler->isContentTypeJson()
        );
    }

    public function updateEntity($updateDataName, $updateDependentObjects = [])
    {
        foreach ($updateDependentObjects as $dependentObject) {
            $this->dependentObjects[] = $dependentObject->getCreatedObject();
        }
        $updateEntityObject = DataObjectHandler::getInstance()->getObject($updateDataName);
        $curlHandler = new CurlHandler('update', $updateEntityObject, $this->storeCode);
        $result = $curlHandler->executeRequest(array_merge($this->dependentObjects, [$this->createdObject]));
        $this->setCreatedObject(
            $result,
            null,
            $curlHandler->getRequestDataArray(),
            $curlHandler->isContentTypeJson()
        );
    }

    public function getEntity($index = null, $storeCode = null)
    {
        if (!empty($storeCode)) {
            $this->storeCode = $storeCode;
        }
        $curlHandler = new CurlHandler('get', $this->entityObject, $this->storeCode);
        $result = $curlHandler->executeRequest($this->dependentObjects);
        $this->setCreatedObject(
            $result,
            $index,
            $curlHandler->getRequestDataArray(),
            $curlHandler->isContentTypeJson()
        );
    }

    public function deleteEntity()
    {
        $curlHandler = new CurlHandler('delete', $this->createdObject, $this->storeCode);
        $curlHandler->executeRequest($this->dependentObjects);
    }

    public function getCreatedObject()
    {
        return $this->createdObject;
    }

    public function getCreatedDataByName($dataName)
    {
        return $this->createdObject->getDataByName($dataName, EntityDataObject::NO_UNIQUE_PROCESS);
    }

    private function setCreatedObject($response, $index, $requestDataArray, $isJson)
    {
        if ($isJson) {
            $responseData = json_decode($response, true);
            if (is_array($responseData) && (null !== $index)) {
                $responseData = $responseData[$index];
            }
            if (is_array($responseData)) {
                $persistedData = $this->convertToFlatArray(array_merge(
                    $requestDataArray,
                    $this->convertCustomAttributesArray($responseData)
                ));
            } else {
                $persistedData = $this->convertToFlatArray(array_merge($requestDataArray, ['return' => $responseData]));
            }
        } else {
            $persistedData = array_merge($this->convertToFlatArray($requestDataArray), ['return' => $response]);
        }

        $this->createdObject = new EntityDataObject(
            $this->entityObject->getName(),
            $this->entityObject->getType(),
            $persistedData,
            null,
            null
        );
    }

    private function convertToFlatArray($arrayIn, $rootKey = '')
    {
        $arrayOut = [];
        foreach ($arrayIn as $key => $value) {
            if (is_array($value)) {
                if (!empty($rootKey)) {
                    $newRootKey = $rootKey . '[' . $key . ']';
                } else {
                    $newRootKey = $key;
                }
                $arrayOut = array_merge($arrayOut, $this->convertToFlatArray($value, $newRootKey));
            } elseif (!empty($rootKey)) {
                $arrayOut[$rootKey . '[' . $key . ']'] = $value;
            } else {
                $arrayOut[$key] = $value;
            }
        }
        return $arrayOut;
    }

    private function convertCustomAttributesArray($arrayIn)
    {
        $keys = ['custom_attributes'];
        foreach ($keys as $key) {
            if (!array_key_exists($key, $arrayIn)) {
                continue;
            }
            $arrayCopy = $arrayIn[$key];
            foreach ($arrayCopy as $index => $attributes) {
                $arrayIn[$key][$attributes['attribute_code']] = $attributes['value'];
            }
        }
        return $arrayIn;
    }

    private function stripCustomFieldsFromUniquenessData($uniquenessData, $customFields)
    {
        $newUniquenessArray = $uniquenessData;
        $intersectingKeys = array_intersect_key($uniquenessData, $customFields);
        foreach ($intersectingKeys as $customFieldKey => $customFieldValue) {
            unset($newUniquenessArray[$customFieldKey]);
        }

        return $newUniquenessArray;
    }
}