Romm\Formz\Form\FormObject\FormObjectStatic

Complexity

Total Complexity

11

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getClassName()	0	4	1
A	getProperties()	0	4	1
A	hasProperty()	0	4	1
A	addProperty()	0	9	2
A	getConfiguration()	0	7	1
A	getConfigurationValidationResult()	0	4	1
A	getObjectHash()	0	8	2
A	calculateObjectHash()	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;

use Romm\Formz\Configuration\Form\Form;
use Romm\Formz\Core\Core;
use Romm\Formz\Form\Service\FormObjectConfiguration;
use Romm\Formz\Service\HashService;
use TYPO3\CMS\Extbase\Error\Result;

/**
 * @todo
 */
class FormObjectStatic
{
    /**
     * @var string
     */
    protected $className;

    /**
     * The properties of the form.
     *
     * @var array
     */
    protected $properties = [];

    /**
     * @var FormObjectConfiguration
     */
    protected $configuration;

    /**
     * @var string
     */
    protected $objectHash;

    /**
     * @param string $className
     * @param array  $formConfiguration
     */
    public function __construct($className, array $formConfiguration)
    {
        $this->className = $className;
        $this->configuration = Core::instantiate(FormObjectConfiguration::class, $this, $formConfiguration);
    }

    /**
     * @return string
     */
    public function getClassName()
    {
        return $this->className;
    }

    /**
     * @return array
     */
    public function getProperties()
    {
        return $this->properties;
    }

    /**
     * @param string $name
     * @return bool
     */
    public function hasProperty($name)
    {
        return in_array($name, $this->properties);
    }

    /**
     * Registers a new property for this form.
     *
     * @param string $name
     * @return $this
     */
    public function addProperty($name)
    {
        if (false === $this->hasProperty($name)) {
            $this->properties[] = $name;
            $this->objectHash = null;
        }

        return $this;
    }

    /**
     * @return Form
     */
    public function getConfiguration()
    {
        /** @var Form $configuration */
        $configuration = $this->configuration->getConfigurationObject()->getObject(true);

        return $configuration;
    }

    /**
     * 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()
    {
        return $this->configuration->getConfigurationValidationResult();
    }

    /**
     * Returns the hash of the form object, which should be calculated only once
     * for performance concerns.
     *
     * @return string
     */
    public function getObjectHash()
    {
        if (null === $this->objectHash) {
            $this->objectHash = $this->calculateObjectHash();
        }

        return $this->objectHash;
    }

    /**
     * Returns the calculated hash of the form object.
     *
     * @return string
     */
    protected function calculateObjectHash()
    {
        return HashService::get()->getHash(serialize($this));
    }
}