OperationElementExtractor.php

Go to the documentation of this file.

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

use Magento\FunctionalTestingFramework\DataGenerator\Handlers\OperationDefinitionObjectHandler;
use Magento\FunctionalTestingFramework\DataGenerator\Objects\OperationElement;

class OperationElementExtractor
{
    const OPERATION_OBJECT_KEY = 'key';
    const OPERATION_OBJECT_DATA_TYPE = 'dataType';
    const OPERATION_OBJECT_ARRAY = 'array';
    const OPERATION_OBJECT_ENTRY = 'field';
    const OPERATION_OBJECT_OBJ_NAME = 'object';
    const OPERATION_OBJECT_ARRAY_VALUE = 'value';

    public function __construct()
    {
        // public constructor
    }

    public function extractOperationElement($operationElementArray)
    {
        // extract key
        $operationDefKey = $operationElementArray[OperationElementExtractor::OPERATION_OBJECT_KEY];

        // extract dataType
        $dataType = $operationElementArray[OperationElementExtractor::OPERATION_OBJECT_DATA_TYPE];

        $operationElements = [];
        $nestedOperationElements = [];

        // extract nested entries
        if (array_key_exists(OperationElementExtractor::OPERATION_OBJECT_ENTRY, $operationElementArray)) {
            $this->extractOperationField(
                $operationElements,
                $operationElementArray[OperationElementExtractor::OPERATION_OBJECT_ENTRY]
            );
        }

        // extract nested arrays
        if (array_key_exists(OperationElementExtractor::OPERATION_OBJECT_ARRAY, $operationElementArray)) {
            $this->extractOperationArray(
                $operationElements,
                $operationElementArray[OperationElementExtractor::OPERATION_OBJECT_ARRAY]
            );
        }

        // extract nested
        if (array_key_exists(OperationElementExtractor::OPERATION_OBJECT_OBJ_NAME, $operationElementArray)) {
            foreach ($operationElementArray[OperationElementExtractor::OPERATION_OBJECT_OBJ_NAME] as $operationObject) {
                $nestedOperationElement = $this->extractOperationElement($operationObject);
                $operationElements[] = $nestedOperationElement;
            }
        }

        // a dataObject specified in xml must contain corresponding metadata for the object
        if (empty($operationElements)) {
            throw new \Exception("must specify dataObject metadata if declaration is used");
        }

        return new OperationElement(
            $operationDefKey,
            $dataType,
            OperationElementExtractor::OPERATION_OBJECT_OBJ_NAME,
            $operationElementArray[OperationDefinitionObjectHandler::ENTITY_OPERATION_REQUIRED] ?? null,
            $nestedOperationElements,
            $operationElements
        );
    }

    private function extractOperationField(&$operationElements, $operationFieldArray)
    {
        foreach ($operationFieldArray as $operationFieldType) {
            $operationElements[] = new OperationElement(
                $operationFieldType[OperationDefinitionObjectHandler::ENTITY_OPERATION_ENTRY_KEY],
                $operationFieldType[OperationDefinitionObjectHandler::ENTITY_OPERATION_ENTRY_VALUE],
                OperationDefinitionObjectHandler::ENTITY_OPERATION_ENTRY,
                $operationFieldType[OperationDefinitionObjectHandler::ENTITY_OPERATION_REQUIRED] ?? null
            );
        }
    }

    private function extractOperationArray(&$operationArrayData, $operationArrayArray)
    {
        foreach ($operationArrayArray as $operationFieldType) {
            $operationElementValue =
                $operationFieldType[OperationDefinitionObjectHandler::ENTITY_OPERATION_ARRAY_VALUE][0]
                [OperationElementExtractor::OPERATION_OBJECT_ARRAY_VALUE] ?? null;

            $nestedOperationElements = [];
            if (array_key_exists(OperationElementExtractor::OPERATION_OBJECT_OBJ_NAME, $operationFieldType)) {
                //add the key to reference this object later
                $operationObjectKeyedArray = $operationFieldType
                    [OperationElementExtractor::OPERATION_OBJECT_OBJ_NAME][0];
                $operationObjectKeyedArray[OperationElementExtractor::OPERATION_OBJECT_KEY] =
                    $operationFieldType[OperationDefinitionObjectHandler::ENTITY_OPERATION_ARRAY_KEY];
                $operationElement = $this->extractOperationElement($operationObjectKeyedArray);
                $operationElementValue = $operationElement->getValue();
                $nestedOperationElements[$operationElement->getValue()] = $operationElement;
            }
            $operationArrayData[] = new OperationElement(
                $operationFieldType[OperationDefinitionObjectHandler::ENTITY_OPERATION_ARRAY_KEY],
                $operationElementValue,
                OperationDefinitionObjectHandler::ENTITY_OPERATION_ARRAY,
                $operationFieldType[OperationDefinitionObjectHandler::ENTITY_OPERATION_REQUIRED] ?? null,
                $nestedOperationElements
            );
        }
    }
}