AbstractFormDefinition - Code Metrics - Inspection of "WIP" - romm/formz - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — middleware-wip ( 5cfd03...f2f782 )

by Romain

created 2017-05-09 09:22 UTC

AbstractFormDefinition A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Importance

Changes

Metric	Value
wmc	15
lcom	2
cbo	5
dl	0
loc	103
rs	10
c	0
b	0
f	0

7 Methods

Rating	Name	Size	Complexity
A	checkDefinitionFreezeState()	6	2
A	isDefinitionFrozen()	5	2
A	getDefinitionState()	10	2
A	attachParents()	7	2
A	attachParent()	6	2
A	throwFrozenStateException()	4	1
A	__call()	18	4

<?php
/*
 * 2017 Romain CANON <[email protected]>
 *
 * 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\Definition;

use Romm\ConfigurationObject\Exceptions\MethodNotFoundException;
use Romm\ConfigurationObject\Service\Items\Parents\ParentsTrait;
use Romm\ConfigurationObject\Traits\ConfigurationObject\MagicMethodsTrait;

class AbstractFormDefinition
{
    use MagicMethodsTrait;
    use ParentsTrait {
        attachParent as private attachParentInternal;
        attachParents as private attachParentsInternal;
    }

    /**
     * @var bool
     */
    private $parentsAttached = false;

    /**
     * @todo
     */
    protected function checkDefinitionFreezeState()
    {
        if ($this->isDefinitionFrozen()) {
            $this->throwFrozenStateException();
        }
    }

    /**
     * @return bool
     */
    protected function isDefinitionFrozen()
    {
        return $this->getDefinitionState()
            && $this->getDefinitionState()->isDefinitionFrozen();
    }

    /**
     * @return FormDefinitionState
     */
    protected function getDefinitionState()
    {
        if ($this instanceof FormDefinition) {
            return $this->getState();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        } else {
            return $this->withFirstParent(FormDefinition::class, function (FormDefinition $formDefinition) {
                return $formDefinition->getState();
            });
        }
    }

    /**
     * @param object[] $parents
     */
    public function attachParents(array $parents)
    {
        if (false === $this->parentsAttached) {
            $this->attachParentsInternal($parents);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            $this->parentsAttached = true;
        }
    }

    /**
     * @param object $parent
     * @param bool   $direct
     */
    public function attachParent($parent, $direct = true)
    {
        if (false === $this->parentsAttached) {
            $this->attachParentInternal($parent, $direct);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        }
    }

    /**
     * @todo
     *
     * @param mixed $name
     * @param array $arguments
     * @return mixed
     * @throws MethodNotFoundException
     */
    public function __call($name, $arguments)
    {
        if ($this->isDefinitionFrozen()) {
            if ('get' !== substr($name, 0, 3)) {
                $this->throwFrozenStateException();
            }

            try {
                $result = $this->handleMagicMethods($name, $arguments);
            } catch (MethodNotFoundException $exception) {
                throw $exception;
            }
        } else {
            $result = $this->handleMagicMethods($name, $arguments);
        }

        return $result;
    }

    /**
     * @todo
     */
    private function throwFrozenStateException()
    {
        throw new \Exception('FROZEN!'); // @todo
    }
}


1			<?php
2			/*
3			* 2017 Romain CANON <[email protected]>
4			*
5			* This file is part of the TYPO3 FormZ project.
6			* It is free software; you can redistribute it and/or modify it
7			* under the terms of the GNU General Public License, either
8			* version 3 of the License, or any later version.
9			*
10			* For the full copyright and license information, see:
11			* http://www.gnu.org/licenses/gpl-3.0.html
12			*/
13
14			namespace Romm\Formz\Form\Definition;
15
16			use Romm\ConfigurationObject\Exceptions\MethodNotFoundException;
17			use Romm\ConfigurationObject\Service\Items\Parents\ParentsTrait;
18			use Romm\ConfigurationObject\Traits\ConfigurationObject\MagicMethodsTrait;
19
20			class AbstractFormDefinition
21			{
22			use MagicMethodsTrait;
23			use ParentsTrait {
24			attachParent as private attachParentInternal;
25			attachParents as private attachParentsInternal;
26			}
27
28			/**
29			* @var bool
30			*/
31			private $parentsAttached = false;
32
33			/**
34			* @todo
35			*/
36			protected function checkDefinitionFreezeState()
37			{
38			if ($this->isDefinitionFrozen()) {
39			$this->throwFrozenStateException();
40			}
41			}
42
43			/**
44			* @return bool
45			*/
46			protected function isDefinitionFrozen()
47			{
48			return $this->getDefinitionState()
49			&& $this->getDefinitionState()->isDefinitionFrozen();
50			}
51
52			/**
53			* @return FormDefinitionState
54			*/
55			protected function getDefinitionState()
56			{
57			if ($this instanceof FormDefinition) {
58			return $this->getState();
			0 ignored issues – show Documentation Bug introduced 2017-05-02 15:56 UTC by Report Bug Copy Issue Report The method `getState` does not exist on `object<Romm\Formz\Form\D...AbstractFormDefinition>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
59			} else {
60			return $this->withFirstParent(FormDefinition::class, function (FormDefinition $formDefinition) {
61			return $formDefinition->getState();
62			});
63			}
64			}
65
66			/**
67			* @param object[] $parents
68			*/
69			public function attachParents(array $parents)
70			{
71			if (false === $this->parentsAttached) {
72			$this->attachParentsInternal($parents);
			0 ignored issues – show Documentation Bug introduced 2017-05-03 15:31 UTC by Report Bug Copy Issue Report The method `attachParentsInternal` does not exist on `object<Romm\Formz\Form\D...AbstractFormDefinition>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
73			$this->parentsAttached = true;
74			}
75			}
76
77			/**
78			* @param object $parent
79			* @param bool $direct
80			*/
81			public function attachParent($parent, $direct = true)
82			{
83			if (false === $this->parentsAttached) {
84			$this->attachParentInternal($parent, $direct);
			0 ignored issues – show Documentation Bug introduced 2017-05-03 15:31 UTC by Report Bug Copy Issue Report The method `attachParentInternal` does not exist on `object<Romm\Formz\Form\D...AbstractFormDefinition>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
85			}
86			}
87
88			/**
89			* @todo
90			*
91			* @param mixed $name
92			* @param array $arguments
93			* @return mixed
94			* @throws MethodNotFoundException
95			*/
96			public function __call($name, $arguments)
97			{
98			if ($this->isDefinitionFrozen()) {
99			if ('get' !== substr($name, 0, 3)) {
100			$this->throwFrozenStateException();
101			}
102
103			try {
104			$result = $this->handleMagicMethods($name, $arguments);
105			} catch (MethodNotFoundException $exception) {
106			throw $exception;
107			}
108			} else {
109			$result = $this->handleMagicMethods($name, $arguments);
110			}
111
112			return $result;
113			}
114
115			/**
116			* @todo
117			*/
118			private function throwFrozenStateException()
119			{
120			throw new \Exception('FROZEN!'); // @todo
121			}
122			}
123

romm / formz

Push — middleware-wip ( 5cfd03...f2f782 )

AbstractFormDefinition A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

Duplication Side-by-Side

Filter issues like