FormzActionControllerTrait - Code Metrics - Inspection of "[CLEANUP] Rename class" - romm/formz - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — middleware-wip ( be7c81...ea6aa8 )

by Romain

created 2017-03-22 16:31 UTC

FormzActionControllerTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	3
lcom	1
cbo	0
dl	0
loc	46
rs	10
c	1
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	processRequest()	0	23	2
A	injectState()	0	4	1

<?php
namespace Romm\Formz\Controller;

use TYPO3\CMS\Extbase\Mvc\RequestInterface;
use TYPO3\CMS\Extbase\Mvc\ResponseInterface;
use TYPO3\CMS\Extbase\Mvc\Web\Request;

trait FormzActionControllerTrait
{
    /**
     * @var ControllerState
     */
    protected $state;

    /**
     * This function will dispatch the request to the form controller, which
     * will process the request with FormZ configuration.
     *
     * @param RequestInterface  $request
     * @param ResponseInterface $response
     */
    public function processRequest(RequestInterface $request, ResponseInterface $response)
    {
        if (false === $this->state->isDispatched()) {
            $this->request = $request;
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->actionMethodName = $this->resolveActionMethodName();
class MyClass { }

$x = new MyClass();
$x->foo = true;

            $this->initializeActionMethodArguments();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->initializeActionMethodValidators();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->mvcPropertyMappingConfigurationService->initializePropertyMappingConfigurationFromRequest($request, $this->arguments);
class MyClass { }

$x = new MyClass();
$x->foo = true;

            /** @var Request $request */
            $this->state->setRequest(clone $request);
            $this->state->setArguments($this->arguments);
            $this->state->setSettings($this->settings);
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->state->setVendorName($this->request->getControllerVendorName());
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->request->setControllerVendorName('Romm');
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->forward('processForm', 'Form', 'Formz', $request->getArguments());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } else {
            /** @noinspection PhpUndefinedMethodInspection */
            parent::processRequest($request, $response);
        }
    }

    /**
     * @param ControllerState $state
     */
    public function injectState(ControllerState $state)
    {
        $this->state = $state;
    }
}


Push — middleware-wip ( be7c81...ea6aa8 )

FormzActionControllerTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Available Fixes

Available Fixes

1			<?php
2			namespace Romm\Formz\Controller;
3
4			use TYPO3\CMS\Extbase\Mvc\RequestInterface;
5			use TYPO3\CMS\Extbase\Mvc\ResponseInterface;
6			use TYPO3\CMS\Extbase\Mvc\Web\Request;
7
8			trait FormzActionControllerTrait
9			{
10			/**
11			* @var ControllerState
12			*/
13			protected $state;
14
15			/**
16			* This function will dispatch the request to the form controller, which
17			* will process the request with FormZ configuration.
18			*
19			* @param RequestInterface $request
20			* @param ResponseInterface $response
21			*/
22			public function processRequest(RequestInterface $request, ResponseInterface $response)
23			{
24			if (false === $this->state->isDispatched()) {
25			$this->request = $request;
			0 ignored issues – show Bug introduced 2017-03-06 13:56 UTC by Report Bug Copy Issue Report The property `request` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
26			$this->actionMethodName = $this->resolveActionMethodName();
			0 ignored issues – show Bug introduced 2017-03-06 13:56 UTC by Report Bug Copy Issue Report The property `actionMethodName` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2017-03-06 13:56 UTC by Report Bug Copy Issue Report It seems like `resolveActionMethodName()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
27
28			$this->initializeActionMethodArguments();
			0 ignored issues – show Bug introduced 2017-03-06 13:56 UTC by Report Bug Copy Issue Report It seems like `initializeActionMethodArguments()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
29			$this->initializeActionMethodValidators();
			0 ignored issues – show Bug introduced 2017-03-06 13:56 UTC by Report Bug Copy Issue Report It seems like `initializeActionMethodValidators()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
30			$this->mvcPropertyMappingConfigurationService->initializePropertyMappingConfigurationFromRequest($request, $this->arguments);
			0 ignored issues – show Bug introduced 2017-03-13 16:54 UTC by Report Bug Copy Issue Report The property `mvcPropertyMappingConfigurationService` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2017-03-13 16:54 UTC by Report Bug Copy Issue Report The property `arguments` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
31
32			/** @var Request $request */
33			$this->state->setRequest(clone $request);
34			$this->state->setArguments($this->arguments);
35			$this->state->setSettings($this->settings);
			0 ignored issues – show Bug introduced 2017-03-16 16:55 UTC by Report Bug Copy Issue Report The property `settings` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
36			$this->state->setVendorName($this->request->getControllerVendorName());
			0 ignored issues – show Bug introduced 2017-03-15 09:32 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `TYPO3\CMS\Extbase\Mvc\RequestInterface` as the method `getControllerVendorName()` does only exist in the following implementations of said interface: `TYPO3\CMS\Extbase\Mvc\Request`, `TYPO3\CMS\Extbase\Mvc\Web\ReferringRequest`, `TYPO3\CMS\Extbase\Mvc\Web\Request`, `TYPO3\CMS\Fluid\Core\Widget\WidgetRequest`. 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...
37
38			$this->request->setControllerVendorName('Romm');
			0 ignored issues – show Bug introduced 2017-03-15 09:32 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `TYPO3\CMS\Extbase\Mvc\RequestInterface` as the method `setControllerVendorName()` does only exist in the following implementations of said interface: `TYPO3\CMS\Extbase\Mvc\Request`, `TYPO3\CMS\Extbase\Mvc\Web\ReferringRequest`, `TYPO3\CMS\Extbase\Mvc\Web\Request`, `TYPO3\CMS\Fluid\Core\Widget\WidgetRequest`. 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...
39			$this->forward('processForm', 'Form', 'Formz', $request->getArguments());
			0 ignored issues – show Bug introduced 2017-03-06 13:56 UTC by Report Bug Copy Issue Report It seems like `forward()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
40			} else {
41			/** @noinspection PhpUndefinedMethodInspection */
42			parent::processRequest($request, $response);
43			}
44			}
45
46			/**
47			* @param ControllerState $state
48			*/
49			public function injectState(ControllerState $state)
50			{
51			$this->state = $state;
52			}
53			}
54

romm / formz

Push — middleware-wip ( be7c81...ea6aa8 )

FormzActionControllerTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like