FormActionControllerTrait::actionForException() - Code Metrics - Inspection of "[BUGFIX] Make sure the cached configuration is a v..." - romm/formz - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — wip/steps ( 0b172f...7d87c6 )

by Nathan

created 2019-03-21 14:48 UTC

FormActionControllerTrait::actionForException() A

↳ Parent: FormActionControllerTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

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

use Romm\Formz\Controller\Processor\ControllerProcessor;
use Romm\Formz\Middleware\Scope\MainScope;
use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;

/**
 * @mixin ActionController
 */
trait FormActionControllerTrait
{
    /**
     * @todo
     *
     * @var string
     */
    protected $formScope = MainScope::class;

    /**
     * In case an exception (any exception type) is thrown during the
     * middlewares execution, it can be automatically caught by FormZ, and the
     * request will be forwarded to an action of the controller.
     *
     * You can use it for instance to log your exception in some log service; to
     * render a view that contains a message explaining to the user that
     * something went wrong.
     *
     * Just override this method to return the name of an existing action of the
     * controller. The method will have a single parameter which is the
     * exception.
     *
     * @return string|null
     */
    protected function actionForException(): ?string
    {
        return null;
    }

    /**
     * IMPORTANT: if you need to override this method in your own controller, do
     * not forget to call `parent::initializeAction()`!
     */
    private function initializeFormz()
    {
        $settings = is_array($this->settings)
class MyClass { }

$x = new MyClass();
$x->foo = true;
            ? $this->settings
            : [];

        $processor = ControllerProcessor::prepare($this->request, $this->arguments, $this->formScope, $settings);
class MyClass { }

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

        if (null !== $this->actionForException()) {
            $vendorName = $this->request->getControllerVendorName();
            $extensionName = $this->request->getControllerExtensionName();
            $controllerName = $this->request->getControllerName();

            $processor->setExceptionCallback(function ($exception) use ($vendorName, $controllerName, $extensionName) {
                $this->request->setControllerVendorName($vendorName);
                $this->forward($this->actionForException(), $controllerName, $extensionName, ['exception' => $exception]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            });
        }

        $processor->dispatch();
    }
}


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\Controller;
15
16			use Romm\Formz\Controller\Processor\ControllerProcessor;
17			use Romm\Formz\Middleware\Scope\MainScope;
18			use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
19
20			/**
21			* @mixin ActionController
22			*/
23			trait FormActionControllerTrait
24			{
25			/**
26			* @todo
27			*
28			* @var string
29			*/
30			protected $formScope = MainScope::class;
31
32			/**
33			* In case an exception (any exception type) is thrown during the
34			* middlewares execution, it can be automatically caught by FormZ, and the
35			* request will be forwarded to an action of the controller.
36			*
37			* You can use it for instance to log your exception in some log service; to
38			* render a view that contains a message explaining to the user that
39			* something went wrong.
40			*
41			* Just override this method to return the name of an existing action of the
42			* controller. The method will have a single parameter which is the
43			* exception.
44			*
45			* @return string\|null
46			*/
47			protected function actionForException(): ?string
48			{
49			return null;
50			}
51
52			/**
53			* IMPORTANT: if you need to override this method in your own controller, do
54			* not forget to call `parent::initializeAction()`!
55			*/
56			private function initializeFormz()
57			{
58			$settings = is_array($this->settings)
			0 ignored issues – show Bug introduced 2018-11-15 09:51 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...
59			? $this->settings
60			: [];
61
62			$processor = ControllerProcessor::prepare($this->request, $this->arguments, $this->formScope, $settings);
			0 ignored issues – show Bug introduced 2018-11-15 09:51 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... Bug introduced 2018-11-15 09:51 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...
63
64			if (null !== $this->actionForException()) {
65			$vendorName = $this->request->getControllerVendorName();
66			$extensionName = $this->request->getControllerExtensionName();
67			$controllerName = $this->request->getControllerName();
68
69			$processor->setExceptionCallback(function ($exception) use ($vendorName, $controllerName, $extensionName) {
70			$this->request->setControllerVendorName($vendorName);
71			$this->forward($this->actionForException(), $controllerName, $extensionName, ['exception' => $exception]);
			0 ignored issues – show Bug introduced 2018-11-15 09:51 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...
72			});
73			}
74
75			$processor->dispatch();
76			}
77			}
78

romm / formz

Push — wip/steps ( 0b172f...7d87c6 )

FormActionControllerTrait::actionForException() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like