Romm\Formz\Form\FormObject\Service\FormObjectConfiguration

Complexity

Total Complexity

18

Size/Duplication

Total Lines	184
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getConfigurationObject()	0	8	2
A	getConfigurationValidationResult()	0	8	2
A	getMergedValidationResult()	0	20	2
A	getConfigurationObjectFromCache()	0	20	3
A	sanitizeConfiguration()	0	18	4
A	getConfigurationObjectInstance()	0	4	1
A	getCacheInstance()	0	4	1
A	getGlobalConfigurationValidationResult()	0	4	1
A	__sleep()	0	4	1

<?php
/*
 * 2017 Romain CANON <romain.hydrocanon@gmail.com>
 *
 * This file is part of the TYPO3 FormZ project.
 * It is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, either
 * version 3 of the License, or any later version.
 *
 * For the full copyright and license information, see:
 * http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace Romm\Formz\Form\FormObject\Service;

use Romm\ConfigurationObject\ConfigurationObjectFactory;
use Romm\ConfigurationObject\ConfigurationObjectInstance;
use Romm\Formz\Configuration\ConfigurationFactory;
use Romm\Formz\Configuration\Form\Form;
use Romm\Formz\Form\FormObject\FormObjectStatic;
use Romm\Formz\Service\CacheService;
use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use TYPO3\CMS\Extbase\Error\Result;

class FormObjectConfiguration
{
    /**
     * @var FormObjectStatic
     */
    protected $static;

    /**
     * @var array
     */
    protected $configurationArray = [];

    /**
     * Contains the form configuration object, which was created from the
     * configuration array.
     *
     * @var ConfigurationObjectInstance
     */
    protected $configurationObject;

    /**
     * @var Result
     */
    protected $configurationValidationResult;

    /**
     * Flag to know if the form configuration is valid or not: if the
     * configuration is fetched from cache, then we know the configuration is
     * valid because it is saved in cache only when no error is found.
     *
     * @var bool
     */
    protected $configurationIsValid = false;

    /**
     * @param FormObjectStatic $static
     * @param array            $configurationArray
     */
    public function __construct(FormObjectStatic $static, array $configurationArray)
    {
        $this->static = $static;
        $this->configurationArray = $configurationArray;
    }

    /**
     * Returns an instance of configuration object. Checks if it was previously
     * stored in cache, otherwise it is created from scratch.
     *
     * @return ConfigurationObjectInstance
     */
    public function getConfigurationObject()
    {
        if (null === $this->configurationObject) {
            $this->configurationObject = $this->getConfigurationObjectFromCache();
        }

        return $this->configurationObject;
    }

    /**
     * This function will merge and return the validation results of both the
     * global FormZ configuration object, and this form configuration object.
     *
     * @return Result
     */
    public function getConfigurationValidationResult()
    {
        if (null === $this->configurationValidationResult) {
            $this->configurationValidationResult = $this->getMergedValidationResult();
        }

        return $this->configurationValidationResult;
    }

    /**
     * Resets the validation result and merges it with the global FormZ
     * configuration.
     *
     * @return Result
     */
    protected function getMergedValidationResult()
    {
        $globalConfigurationValidationResult = $this->getGlobalConfigurationValidationResult();

        $result = new Result;
        $result->merge($globalConfigurationValidationResult);

        /*
         * If the form configuration is not valid, we merge the form validation
         * result with the global validation result.
         */
        if (false === $this->configurationIsValid) {
            $propertyName = 'forms.' . $this->static->getClassName();
            $formValidationResult = $this->getConfigurationObject()->getValidationResult();

            $result->forProperty($propertyName)->merge($formValidationResult);
        }

        return $result;
    }

    /**
     * @return ConfigurationObjectInstance
     */
    protected function getConfigurationObjectFromCache()
    {
        $cacheInstance = $this->getCacheInstance();
        $cacheIdentifier = 'configuration-' . $this->static->getObjectHash();

        if ($cacheInstance->has($cacheIdentifier)) {
            $configurationObject = $cacheInstance->get($cacheIdentifier);

            $this->configurationIsValid = true;
        } else {
            $configurationArray = $this->sanitizeConfiguration($this->configurationArray);
            $configurationObject = $this->getConfigurationObjectInstance($configurationArray);

            if (false === $configurationObject->getValidationResult()->hasErrors()) {
                $cacheInstance->set($cacheIdentifier, $configurationObject);
            }
        }

        return $configurationObject;
    }

    /**
     * This function will clean the configuration array by removing useless data
     * and updating needed ones.
     *
     * @param array $configuration
     * @return array
     */
    protected function sanitizeConfiguration(array $configuration)
    {
        // Removing configuration of fields which do not exist for this form.
        $sanitizedFieldsConfiguration = [];
        $fieldsConfiguration = (isset($configuration['fields']))
            ? $configuration['fields']
            : [];

        foreach ($this->static->getProperties() as $property) {
            $sanitizedFieldsConfiguration[$property] = (isset($fieldsConfiguration[$property]))
                ? $fieldsConfiguration[$property]
                : [];
        }

        $configuration['fields'] = $sanitizedFieldsConfiguration;

        return $configuration;
    }

    /**
     * @param array $configuration
     * @return ConfigurationObjectInstance
     */
    protected function getConfigurationObjectInstance(array $configuration)
    {
        return ConfigurationObjectFactory::getInstance()->get(Form::class, $configuration);
    }

    /**
     * @return FrontendInterface
     */
    protected function getCacheInstance()
    {
        return CacheService::get()->getCacheInstance();
    }

    /**
     * @return Result
     */
    protected function getGlobalConfigurationValidationResult()
    {
        return ConfigurationFactory::get()->getFormzConfiguration()->getValidationResult();
    }

    /**
     * @return array
     */
    public function __sleep()
    {
        return ['static', 'configurationArray', 'properties'];
    }
}