AuraInputInterceptor::getFormProperty() - Code Metrics - Inspection of "Update README.md" - ray-di/Ray.WebFormModule - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 1.x ( 54a263...51200d )

by Akihito

created 2018-05-27 05:03 UTC

AuraInputInterceptor::getFormProperty() A

↳ Parent: AuraInputInterceptor

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3.0987

Importance

Changes

Metric	Value
dl	0
loc	14
ccs	7
cts	9
cp	0.7778
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	9
nc	3
nop	2
crap	3.0987

<?php
/**
 * This file is part of the Ray.WebFormModule package.
 *
 * @license http://opensource.org/licenses/MIT MIT
 */
namespace Ray\WebFormModule;

use Doctrine\Common\Annotations\Reader;
use Ray\Aop\MethodInterceptor;
use Ray\Aop\MethodInvocation;
use Ray\WebFormModule\Annotation\AbstractValidation;
use Ray\WebFormModule\Annotation\FormValidation;
use Ray\WebFormModule\Exception\InvalidArgumentException;
use Ray\WebFormModule\Exception\InvalidFormPropertyException;

class AuraInputInterceptor implements MethodInterceptor
{
    /**
     * @var Reader
     */
    protected $reader;

    /**
     * @var FailureHandlerInterface
     */
    protected $failureHandler;

    /**
     * @param Reader                  $reader
     * @param FailureHandlerInterface $handler
     */
    public function __construct(Reader $reader, FailureHandlerInterface $handler)
    {
        $this->reader = $reader;
        $this->failureHandler = $handler;
    }

    /**
     * {@inheritdoc}
     *
     * @throws InvalidArgumentException
     */
    public function invoke(MethodInvocation $invocation)
    {
        $object = $invocation->getThis();
        /* @var $formValidation FormValidation */
        $formValidation = $this->reader->getMethodAnnotation($invocation->getMethod(), AbstractValidation::class);
        $form = $this->getFormProperty($formValidation, $object);
        $data = $form instanceof SubmitInterface ? $form->submit() : $this->getNamedArguments($invocation);
        $isValid = $this->isValid($data, $form);
        if ($isValid === true) {
            // validation   success
            return $invocation->proceed();
        }

        return $this->failureHandler->handle($formValidation, $invocation, $form);
    }

    /**
     * @param array        $submit
     * @param AbstractForm $form
     *
     * @throws Exception\CsrfViolationException
     *
     * @return bool
     */
    public function isValid(array $submit, AbstractForm $form)
    {
        $isValid = $form->apply($submit);

        return $isValid;
    }

    /**
     * Return arguments as named arguments.
     *
     * @param MethodInvocation $invocation
     *
     * @return array
     */
    private function getNamedArguments(MethodInvocation $invocation)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $submit = [];
        $params = $invocation->getMethod()->getParameters();
        $args = $invocation->getArguments()->getArrayCopy();
        foreach ($params as $param) {
            $arg = array_shift($args);
            $submit[$param->getName()] = $arg;
        }
        // has token ?
        if (isset($_POST[AntiCsrf::TOKEN_KEY])) {
            $submit[AntiCsrf::TOKEN_KEY] = $_POST[AntiCsrf::TOKEN_KEY];
        }

        return $submit;
    }

    /**
     * Return form property
     *
     * @param AbstractValidation $formValidation
     * @param object             $object
     *
     * @return mixed
     */
    private function getFormProperty(AbstractValidation $formValidation, $object)
    {
        if (! property_exists($object, $formValidation->form)) {
            throw new InvalidFormPropertyException($formValidation->form);
        }
        $prop = (new \ReflectionClass($object))->getProperty($formValidation->form);
        $prop->setAccessible(true);
        $form = $prop->getValue($object);
        if (! $form instanceof AbstractForm) {
            throw new InvalidFormPropertyException($formValidation->form);
        }

        return $form;
    }
}


1		<?php
2		/**
3		* This file is part of the Ray.WebFormModule package.
4		*
5		* @license http://opensource.org/licenses/MIT MIT
6		*/
7		namespace Ray\WebFormModule;
8
9		use Doctrine\Common\Annotations\Reader;
10		use Ray\Aop\MethodInterceptor;
11		use Ray\Aop\MethodInvocation;
12		use Ray\WebFormModule\Annotation\AbstractValidation;
13		use Ray\WebFormModule\Annotation\FormValidation;
14		use Ray\WebFormModule\Exception\InvalidArgumentException;
15		use Ray\WebFormModule\Exception\InvalidFormPropertyException;
16
17		class AuraInputInterceptor implements MethodInterceptor
18		{
19		/**
20		* @var Reader
21		*/
22		protected $reader;
23
24		/**
25		* @var FailureHandlerInterface
26		*/
27		protected $failureHandler;
28
29		/**
30		* @param Reader $reader
31		* @param FailureHandlerInterface $handler
32		*/
33	5	public function __construct(Reader $reader, FailureHandlerInterface $handler)
34		{
35	5	$this->reader = $reader;
36	5	$this->failureHandler = $handler;
37	5	}
38
39		/**
40		* {@inheritdoc}
41		*
42		* @throws InvalidArgumentException
43		*/
44	4	public function invoke(MethodInvocation $invocation)
45		{
46	4	$object = $invocation->getThis();
47		/* @var $formValidation FormValidation */
48	4	$formValidation = $this->reader->getMethodAnnotation($invocation->getMethod(), AbstractValidation::class);
49	4	$form = $this->getFormProperty($formValidation, $object);
50	4	$data = $form instanceof SubmitInterface ? $form->submit() : $this->getNamedArguments($invocation);
51	4	$isValid = $this->isValid($data, $form);
52	4	if ($isValid === true) {
53		// validation success
54		return $invocation->proceed();
55		}
56
57	4	return $this->failureHandler->handle($formValidation, $invocation, $form);
58		}
59
60		/**
61		* @param array $submit
62		* @param AbstractForm $form
63		*
64		* @throws Exception\CsrfViolationException
65		*
66		* @return bool
67		*/
68	4	public function isValid(array $submit, AbstractForm $form)
69		{
70	4	$isValid = $form->apply($submit);
71
72	4	return $isValid;
73		}
74
75		/**
76		* Return arguments as named arguments.
77		*
78		* @param MethodInvocation $invocation
79		*
80		* @return array
81		*/
82	4	private function getNamedArguments(MethodInvocation $invocation)
		0 ignored issues – show Coding Style introduced 2017-12-08 05:49 UTC by Report Bug Copy Issue Report `getNamedArguments` uses the super-global variable `$_POST` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
83		{
84	4	$submit = [];
85	4	$params = $invocation->getMethod()->getParameters();
86	4	$args = $invocation->getArguments()->getArrayCopy();
87	4	foreach ($params as $param) {
88	4	$arg = array_shift($args);
89	4	$submit[$param->getName()] = $arg;
90		}
91		// has token ?
92	4	if (isset($_POST[AntiCsrf::TOKEN_KEY])) {
93		$submit[AntiCsrf::TOKEN_KEY] = $_POST[AntiCsrf::TOKEN_KEY];
94		}
95
96	4	return $submit;
97		}
98
99		/**
100		* Return form property
101		*
102		* @param AbstractValidation $formValidation
103		* @param object $object
104		*
105		* @return mixed
106		*/
107	4	private function getFormProperty(AbstractValidation $formValidation, $object)
108		{
109	4	if (! property_exists($object, $formValidation->form)) {
110		throw new InvalidFormPropertyException($formValidation->form);
111		}
112	4	$prop = (new \ReflectionClass($object))->getProperty($formValidation->form);
113	4	$prop->setAccessible(true);
114	4	$form = $prop->getValue($object);
115	4	if (! $form instanceof AbstractForm) {
116		throw new InvalidFormPropertyException($formValidation->form);
117		}
118
119	4	return $form;
120		}
121		}
122

ray-di / Ray.WebFormModule

Push — 1.x ( 54a263...51200d )

AuraInputInterceptor::getFormProperty() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like