PersistedObjectHandler.php

Go to the documentation of this file.

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

use Magento\FunctionalTestingFramework\DataGenerator\Persist\DataPersistenceHandler;
use Magento\FunctionalTestingFramework\Exceptions\TestReferenceException;

class PersistedObjectHandler
{
    const HOOK_SCOPE = "hook";
    const TEST_SCOPE = "test";
    const SUITE_SCOPE = "suite";

    private static $INSTANCE;

    private $hookObjects = [];

    private $testObjects = [];

    private $suiteObjects = [];

    private function __construct()
    {
        // Empty Constructor
    }

    public static function getInstance()
    {
        if (!self::$INSTANCE) {
            self::$INSTANCE = new PersistedObjectHandler();
        }
        return self::$INSTANCE;
    }

    public function createEntity(
        $key,
        $scope,
        $entity,
        $dependentObjectKeys = [],
        $overrideFields = [],
        $storeCode = ""
    ) {
        $retrievedDependentObjects = [];
        foreach ($dependentObjectKeys as $objectKey) {
            $retrievedDependentObjects[] = $this->retrieveEntity($objectKey, $scope);
        }
        
        $retrievedEntity = DataObjectHandler::getInstance()->getObject($entity);
        $persistedObject = new DataPersistenceHandler(
            $retrievedEntity,
            $retrievedDependentObjects,
            $overrideFields
        );
        
        $persistedObject->createEntity($storeCode);

        if ($scope == self::TEST_SCOPE) {
            $this->testObjects[$key] = $persistedObject;
        } elseif ($scope == self::HOOK_SCOPE) {
            $this->hookObjects[$key] = $persistedObject;
        } else {
            $this->suiteObjects[$key] = $persistedObject;
        }
    }

    public function updateEntity($key, $scope, $updateEntity, $dependentObjectKeys = [])
    {
        $retrievedDependentObjects = [];
        foreach ($dependentObjectKeys as $objectKey) {
            $retrievedDependentObjects[] = $this->retrieveEntity($objectKey, $scope);
        }
        
        $originalEntity = $this->retrieveEntity($key, $scope);
        $originalEntity->updateEntity($updateEntity, $retrievedDependentObjects);
    }

    public function deleteEntity($key, $scope)
    {
        $originalEntity = $this->retrieveEntity($key, $scope);
        $originalEntity->deleteEntity();
    }

    public function getEntity($key, $scope, $entity, $dependentObjectKeys = [], $storeCode = "", $index = null)
    {
        $retrievedDependentObjects = [];
        foreach ($dependentObjectKeys as $objectKey) {
            $retrievedDependentObjects[] = $this->retrieveEntity($objectKey, $scope);
        }

        $retrievedEntity = DataObjectHandler::getInstance()->getObject($entity);
        $persistedObject = new DataPersistenceHandler(
            $retrievedEntity,
            $retrievedDependentObjects
        );
        $persistedObject->getEntity($index, $storeCode);

        if ($scope == self::TEST_SCOPE) {
            $this->testObjects[$key] = $persistedObject;
        } elseif ($scope == self::HOOK_SCOPE) {
            $this->hookObjects[$key] = $persistedObject;
        } else {
            $this->suiteObjects[$key] = $persistedObject;
        }
    }

    public function retrieveEntityField($stepKey, $field, $scope)
    {
        return $this->retrieveEntity($stepKey, $scope)->getCreatedDataByName($field);
    }

    private function retrieveEntity($stepKey, $scope)
    {
        // Assume TEST_SCOPE is default
        $entityArrays = [$this->testObjects, $this->hookObjects, $this->suiteObjects];

        if ($scope == self::HOOK_SCOPE) {
            $entityArrays[0] = $this->hookObjects;
            $entityArrays[1] = $this->testObjects;
        }

        foreach ($entityArrays as $entityArray) {
            if (array_key_exists($stepKey, $entityArray)) {
                return $entityArray[$stepKey];
            }
        }

        throw new TestReferenceException("Entity with a CreateDataKey of {$stepKey} could not be found");
    }

    public function clearTestObjects()
    {
        $this->testObjects = [];
    }

    public function clearHookObjects()
    {
        $this->hookObjects = [];
    }

    public function clearSuiteObjects()
    {
        $this->suiteObjects = [];
    }
}