FormObjectFactory::getStaticInstance() - Code Metrics - Inspection of "[!!!][FEATURE] Improve form object handling" - romm/formz - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/version-2 ( 4aa9b8...6dfc1b )

by Romain

created 2017-04-26 08:38 UTC

FormObjectFactory::getStaticInstance() B

↳ Parent: FormObjectFactory

Complexity

Conditions	5
Paths	5

Size

Total Lines	31
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	31
rs	8.439
c	0
b	0
f	0
cc	5
eloc	17
nc	5
nop	1

<?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\FormObject;

use Romm\ConfigurationObject\ConfigurationObjectInterface;
use Romm\Formz\Configuration\Configuration;
use Romm\Formz\Configuration\ConfigurationFactory;
use Romm\Formz\Core\Core;
use Romm\Formz\Exceptions\ClassNotFoundException;
use Romm\Formz\Exceptions\InvalidArgumentTypeException;
use Romm\Formz\Form\FormInterface;
use Romm\Formz\Form\FormObject\Builder\DefaultFormObjectBuilder;
use Romm\Formz\Form\FormObject\Builder\FormObjectBuilderInterface;
use Romm\Formz\Service\CacheService;
use Romm\Formz\Service\StringService;
use Romm\Formz\Service\Traits\ExtendedSelfInstantiateTrait;
use TYPO3\CMS\Core\SingletonInterface;

/**
 * Factory class that will manage form object instances.
 *
 * You can fetch a new instance by calling one of the following methods:
 * `getInstanceFromFormInstance()` or `getInstanceFromClassName()`
 *
 * @see \Romm\Formz\Form\FormObject\FormObject
 */
class FormObjectFactory implements SingletonInterface
{
    use ExtendedSelfInstantiateTrait;

    /**
     * @var FormObject[]
     */
    protected $instances = [];

    /**
     * @var FormObjectStatic[]
     */
    protected $static = [];

    /**
     * @var FormObjectProxy[]
     */
    protected $proxy = [];

    /**
     * @param FormInterface $form
     * @param string        $name
     * @return FormObject
     */
    public function getInstanceWithFormInstance(FormInterface $form, $name = 'defaultName')
    {
        $hash = $name . '-' . spl_object_hash($form);

        if (false === isset($this->instances[$hash])) {
            $this->instances[$hash] = $this->getInstanceWithClassName(get_class($form), $name);
            $this->instances[$hash]->setForm($form);
        }

        return $this->instances[$hash];
    }

    /**
     * Will create an instance of `FormObject` based on a class that implements
     * the interface `FormInterface`.
     *
     * @param string $className
     * @param string $name
     * @return FormObject
     */
    public function getInstanceWithClassName($className, $name)
    {
        /** @var FormObject $formObject */
        $formObject = Core::instantiate(FormObject::class, $name, $this->getStaticInstance($className));

        return $formObject;
    }

    /**
     * Returns the proxy object for the given form object and form instance.
     *
     * Please use with caution, as this is a very low level function!
     *
     * @param FormInterface $form
     * @return FormObjectProxy
     */
    public function getProxy(FormInterface $form)
    {
        $hash = spl_object_hash($form);

        if (false === isset($this->proxy[$hash])) {
            $this->proxy[$hash] = $this->getNewProxyInstance($form);
        }

        return $this->proxy[$hash];
    }

    /**
     * @param string $className
     * @return FormObjectStatic
     * @throws ClassNotFoundException
     * @throws InvalidArgumentTypeException
     */
    protected function getStaticInstance($className)
    {
        if (false === class_exists($className)) {
            throw ClassNotFoundException::wrongFormClassName($className);
        }

        if (false === in_array(FormInterface::class, class_implements($className))) {
            throw InvalidArgumentTypeException::wrongFormType($className);
        }

        $cacheIdentifier = $this->getCacheIdentifier($className);

        if (false === isset($this->static[$cacheIdentifier])) {
            $cacheInstance = CacheService::get()->getCacheInstance();

            if ($cacheInstance->has($cacheIdentifier)) {
                $static = $cacheInstance->get($cacheIdentifier);
            } else {
                $static = $this->buildStaticInstance($className);
                $static->getObjectHash();

                $cacheInstance->set($cacheIdentifier, $static);
            }

            $this->addToGlobalConfiguration($static);

            $this->static[$cacheIdentifier] = $static;
        }

        return $this->static[$cacheIdentifier];
    }

    /**
     * Adds the given form configuration to the global FormZ configuration
     * object.
     *
     * @param FormObjectStatic $static
     */
    public function addToGlobalConfiguration(FormObjectStatic $static)
    {
        if (false === $this->getGlobalConfiguration()->hasForm($static->getClassName())) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $this->getGlobalConfiguration()->addForm($static);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
    }

    /**
     * @param string $className
     * @return string
     */
    protected function getCacheIdentifier($className)
    {
        $sanitizedClassName = StringService::get()->sanitizeString(str_replace('\\', '-', $className));

        return 'form-object-' . $sanitizedClassName;
    }

    /**
     * Wrapper for unit tests.
     *
     * @param string $className
     * @return FormObjectStatic
     */
    protected function buildStaticInstance($className)
    {
        /** @var FormObjectBuilderInterface $builder */
        $builder = Core::instantiate(DefaultFormObjectBuilder::class);

        return $builder->getStaticInstance($className);
    }

    /**
     * Wrapper for unit tests.
     *
     * @param FormInterface $form
     * @return FormObjectProxy
     */
    protected function getNewProxyInstance(FormInterface $form)
    {
        $formObject = $this->getInstanceWithFormInstance($form);

        /** @var FormObjectProxy $formObjectProxy */
        $formObjectProxy = Core::instantiate(FormObjectProxy::class, $formObject, $form);

        return $formObjectProxy;
    }

    /**
     * @return Configuration|ConfigurationObjectInterface
     */
    protected function getGlobalConfiguration()
    {
        return ConfigurationFactory::get()->getFormzConfiguration()->getObject(true);
    }
}


Push — feature/version-2 ( 4aa9b8...6dfc1b )

FormObjectFactory::getStaticInstance() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

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\FormObject;
15
16			use Romm\ConfigurationObject\ConfigurationObjectInterface;
17			use Romm\Formz\Configuration\Configuration;
18			use Romm\Formz\Configuration\ConfigurationFactory;
19			use Romm\Formz\Core\Core;
20			use Romm\Formz\Exceptions\ClassNotFoundException;
21			use Romm\Formz\Exceptions\InvalidArgumentTypeException;
22			use Romm\Formz\Form\FormInterface;
23			use Romm\Formz\Form\FormObject\Builder\DefaultFormObjectBuilder;
24			use Romm\Formz\Form\FormObject\Builder\FormObjectBuilderInterface;
25			use Romm\Formz\Service\CacheService;
26			use Romm\Formz\Service\StringService;
27			use Romm\Formz\Service\Traits\ExtendedSelfInstantiateTrait;
28			use TYPO3\CMS\Core\SingletonInterface;
29
30			/**
31			* Factory class that will manage form object instances.
32			*
33			* You can fetch a new instance by calling one of the following methods:
34			* `getInstanceFromFormInstance()` or `getInstanceFromClassName()`
35			*
36			* @see \Romm\Formz\Form\FormObject\FormObject
37			*/
38			class FormObjectFactory implements SingletonInterface
39			{
40			use ExtendedSelfInstantiateTrait;
41
42			/**
43			* @var FormObject[]
44			*/
45			protected $instances = [];
46
47			/**
48			* @var FormObjectStatic[]
49			*/
50			protected $static = [];
51
52			/**
53			* @var FormObjectProxy[]
54			*/
55			protected $proxy = [];
56
57			/**
58			* @param FormInterface $form
59			* @param string $name
60			* @return FormObject
61			*/
62			public function getInstanceWithFormInstance(FormInterface $form, $name = 'defaultName')
63			{
64			$hash = $name . '-' . spl_object_hash($form);
65
66			if (false === isset($this->instances[$hash])) {
67			$this->instances[$hash] = $this->getInstanceWithClassName(get_class($form), $name);
68			$this->instances[$hash]->setForm($form);
69			}
70
71			return $this->instances[$hash];
72			}
73
74			/**
75			* Will create an instance of `FormObject` based on a class that implements
76			* the interface `FormInterface`.
77			*
78			* @param string $className
79			* @param string $name
80			* @return FormObject
81			*/
82			public function getInstanceWithClassName($className, $name)
83			{
84			/** @var FormObject $formObject */
85			$formObject = Core::instantiate(FormObject::class, $name, $this->getStaticInstance($className));
86
87			return $formObject;
88			}
89
90			/**
91			* Returns the proxy object for the given form object and form instance.
92			*
93			* Please use with caution, as this is a very low level function!
94			*
95			* @param FormInterface $form
96			* @return FormObjectProxy
97			*/
98			public function getProxy(FormInterface $form)
99			{
100			$hash = spl_object_hash($form);
101
102			if (false === isset($this->proxy[$hash])) {
103			$this->proxy[$hash] = $this->getNewProxyInstance($form);
104			}
105
106			return $this->proxy[$hash];
107			}
108
109			/**
110			* @param string $className
111			* @return FormObjectStatic
112			* @throws ClassNotFoundException
113			* @throws InvalidArgumentTypeException
114			*/
115			protected function getStaticInstance($className)
116			{
117			if (false === class_exists($className)) {
118			throw ClassNotFoundException::wrongFormClassName($className);
119			}
120
121			if (false === in_array(FormInterface::class, class_implements($className))) {
122			throw InvalidArgumentTypeException::wrongFormType($className);
123			}
124
125			$cacheIdentifier = $this->getCacheIdentifier($className);
126
127			if (false === isset($this->static[$cacheIdentifier])) {
128			$cacheInstance = CacheService::get()->getCacheInstance();
129
130			if ($cacheInstance->has($cacheIdentifier)) {
131			$static = $cacheInstance->get($cacheIdentifier);
132			} else {
133			$static = $this->buildStaticInstance($className);
134			$static->getObjectHash();
135
136			$cacheInstance->set($cacheIdentifier, $static);
137			}
138
139			$this->addToGlobalConfiguration($static);
140
141			$this->static[$cacheIdentifier] = $static;
142			}
143
144			return $this->static[$cacheIdentifier];
145			}
146
147			/**
148			* Adds the given form configuration to the global FormZ configuration
149			* object.
150			*
151			* @param FormObjectStatic $static
152			*/
153			public function addToGlobalConfiguration(FormObjectStatic $static)
154			{
155			if (false === $this->getGlobalConfiguration()->hasForm($static->getClassName())) {
			0 ignored issues – show Bug introduced 2017-04-25 08:13 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Romm\ConfigurationObject...gurationObjectInterface` as the method `hasForm()` does only exist in the following implementations of said interface: `Romm\Formz\Configuration\Configuration`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
156			$this->getGlobalConfiguration()->addForm($static);
			0 ignored issues – show Bug introduced 2017-04-25 08:13 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Romm\ConfigurationObject...gurationObjectInterface` as the method `addForm()` does only exist in the following implementations of said interface: `Romm\Formz\Configuration\Configuration`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
157			}
158			}
159
160			/**
161			* @param string $className
162			* @return string
163			*/
164			protected function getCacheIdentifier($className)
165			{
166			$sanitizedClassName = StringService::get()->sanitizeString(str_replace('\\', '-', $className));
167
168			return 'form-object-' . $sanitizedClassName;
169			}
170
171			/**
172			* Wrapper for unit tests.
173			*
174			* @param string $className
175			* @return FormObjectStatic
176			*/
177			protected function buildStaticInstance($className)
178			{
179			/** @var FormObjectBuilderInterface $builder */
180			$builder = Core::instantiate(DefaultFormObjectBuilder::class);
181
182			return $builder->getStaticInstance($className);
183			}
184
185			/**
186			* Wrapper for unit tests.
187			*
188			* @param FormInterface $form
189			* @return FormObjectProxy
190			*/
191			protected function getNewProxyInstance(FormInterface $form)
192			{
193			$formObject = $this->getInstanceWithFormInstance($form);
194
195			/** @var FormObjectProxy $formObjectProxy */
196			$formObjectProxy = Core::instantiate(FormObjectProxy::class, $formObject, $form);
197
198			return $formObjectProxy;
199			}
200
201			/**
202			* @return Configuration\|ConfigurationObjectInterface
203			*/
204			protected function getGlobalConfiguration()
205			{
206			return ConfigurationFactory::get()->getFormzConfiguration()->getObject(true);
207			}
208			}
209

romm / formz

Push — feature/version-2 ( 4aa9b8...6dfc1b )

FormObjectFactory::getStaticInstance() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like