RequestBuilder::getClassName() - Code Metrics - Inspection of "Added ability to parse array of objects" - mcustiel/php-simple-request - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#5)

by Mariano

created 2016-07-23 17:01 UTC

RequestBuilder::getClassName() A

↳ Parent: RequestBuilder

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	2
eloc	2
nc	2
nop	2
crap	2

<?php
/**
 * This file is part of php-simple-request.
 *
 * php-simple-request is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * php-simple-request is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with php-simple-request.  If not, see <http://www.gnu.org/licenses/>.
 */
namespace Mcustiel\SimpleRequest;

use Mcustiel\SimpleRequest\Exception\InvalidRequestException;
use Psr\Cache\CacheItemPoolInterface as PsrCache;

/**
 * Builds a request by parsing all the resulting object's annotations and running
 * obtained filters and validators against the request.
 *
 * @author mcustiel
 */
class RequestBuilder
{
    const RETURN_ALL_ERRORS_IN_EXCEPTION = '\Mcustiel\SimpleRequest\AllErrorsRequestParser';
    const THROW_EXCEPTION_ON_FIRST_ERROR = '\Mcustiel\SimpleRequest\FirstErrorRequestParser';

    /**
     * @var \Psr\Cache\CacheItemPoolInterface
     */
    private $cache;
    /**
     * @var ParserGenerator
     */
    private $parserGenerator;


    /**
     * @param \Psr\Cache\CacheItemPoolInterface       $cache
     * @param \Mcustiel\SimpleRequest\ParserGenerator $parserGenerator
     */
    public function __construct(
        PsrCache $cache,
        ParserGenerator $parserGenerator
    ) {
        $this->cache = $cache;
        $this->parserGenerator = $parserGenerator;
    }

    /**
     * Main method of this class. Used to convert a request to an object of a given class by
     * using a requestParser.
     *
     * @param array|\stdClass $request   The request to convert to an object.
     * @param string|array    $className The class of the object to which the request must be converted.
     * @param string          $behavior  The behaviour of the parser.
     */
    public function parseRequest(
        $request,
        $className,
        $behavior = self::THROW_EXCEPTION_ON_FIRST_ERROR
    ) {
        $isArray = is_array($className);
        $className = $this->getClassName($className, $isArray);
        $parserObject = $this->generateRequestParserObject($className, new $behavior);

        return $this->executeParsing(
            $this->sanitizeRequestOrThrowExceptionIfInvalid($request),
            $parserObject,
            $isArray
        );
    }

    /**
     * @param array         $request
     * @param RequestParser $parserObject
     * @param bool          $isArray
     *
     * @return object|object[]
     */
    private function executeParsing(array $request, RequestParser $parserObject, $isArray)
    {
        if ($isArray) {
            return $this->parseArray($request, $parserObject);
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
        return $parserObject->parse($request);
    }

    /**
     * @param array         $request
     * @param RequestParser $parserObject
     */
    private function parseArray(array $request, RequestParser $parserObject)
    {
        $return = [];
        foreach ($request as $requestItem) {
            $return[] = $parserObject->parse($requestItem);
        }
        return $return;
    }

    /**
     * @param string|array $className
     * @param bool         $isArray
     *
     * @return string
     */
    private function getClassName($className, $isArray)
    {
        return '' . $isArray ? $className[0] : $className;
    }

    /**
     * @param string        $className
     * @param RequestParser $parser
     *
     * @return \Mcustiel\SimpleRequest\RequestParser|mixed
     */
    private function generateRequestParserObject($className, RequestParser $parser)
    {
        $cacheKey = str_replace('\\', '', $className . get_class($parser));
        $cacheItem = $this->cache->getItem($cacheKey);
        $return = $cacheItem->get();
        if ($return === null) {
            $return = $this->parserGenerator->populateRequestParser($className, $parser, $this);
            $cacheItem->set($return);
            $this->cache->save($cacheItem);
        }

        return $return;
    }

    /**
     * @param mixed $request
     *
     * @throws \Mcustiel\SimpleRequest\Exception\InvalidRequestException
     *
     * @return \stdClass|mixed
     */
    private function sanitizeRequestOrThrowExceptionIfInvalid($request)
    {
        $isObject = ($request instanceof \stdClass);
        if (!is_array($request) && !$isObject) {
            throw new InvalidRequestException(
                'Request builder is intended to be used with arrays or instances of \\stdClass'
            );
        }
        return $isObject ? json_decode(json_encode($request), true) : $request;
    }
}


1		<?php
2		/**
3		* This file is part of php-simple-request.
4		*
5		* php-simple-request is free software: you can redistribute it and/or modify
6		* it under the terms of the GNU Lesser General Public License as published by
7		* the Free Software Foundation, either version 3 of the License, or
8		* (at your option) any later version.
9		*
10		* php-simple-request is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13		* GNU General Public License for more details.
14		*
15		* You should have received a copy of the GNU General Public License
16		* along with php-simple-request. If not, see <http://www.gnu.org/licenses/>.
17		*/
18		namespace Mcustiel\SimpleRequest;
19
20		use Mcustiel\SimpleRequest\Exception\InvalidRequestException;
21		use Psr\Cache\CacheItemPoolInterface as PsrCache;
22
23		/**
24		* Builds a request by parsing all the resulting object's annotations and running
25		* obtained filters and validators against the request.
26		*
27		* @author mcustiel
28		*/
29		class RequestBuilder
30		{
31		const RETURN_ALL_ERRORS_IN_EXCEPTION = '\Mcustiel\SimpleRequest\AllErrorsRequestParser';
32		const THROW_EXCEPTION_ON_FIRST_ERROR = '\Mcustiel\SimpleRequest\FirstErrorRequestParser';
33
34		/**
35		* @var \Psr\Cache\CacheItemPoolInterface
36		*/
37		private $cache;
38		/**
39		* @var ParserGenerator
40		*/
41		private $parserGenerator;
42
43
44		/**
45		* @param \Psr\Cache\CacheItemPoolInterface $cache
46		* @param \Mcustiel\SimpleRequest\ParserGenerator $parserGenerator
47		*/
48	99	public function __construct(
49		PsrCache $cache,
50		ParserGenerator $parserGenerator
51		) {
52	99	$this->cache = $cache;
53	99	$this->parserGenerator = $parserGenerator;
54	99	}
55
56		/**
57		* Main method of this class. Used to convert a request to an object of a given class by
58		* using a requestParser.
59		*
60		* @param array\|\stdClass $request The request to convert to an object.
61		* @param string\|array $className The class of the object to which the request must be converted.
62		* @param string $behavior The behaviour of the parser.
63		*/
64	97	public function parseRequest(
65		$request,
66		$className,
67		$behavior = self::THROW_EXCEPTION_ON_FIRST_ERROR
68		) {
69	97	$isArray = is_array($className);
70	97	$className = $this->getClassName($className, $isArray);
71	97	$parserObject = $this->generateRequestParserObject($className, new $behavior);
72
73	97	return $this->executeParsing(
74	97	$this->sanitizeRequestOrThrowExceptionIfInvalid($request),
75	95	$parserObject,
76		$isArray
77	95	);
78		}
79
80		/**
81		* @param array $request
82		* @param RequestParser $parserObject
83		* @param bool $isArray
84		*
85		* @return object\|object[]
86		*/
87	95	private function executeParsing(array $request, RequestParser $parserObject, $isArray)
88		{
89	95	if ($isArray) {
90	1	return $this->parseArray($request, $parserObject);
		0 ignored issues – show Bug Best Practice introduced 2016-07-23 17:06 UTC by Report Bug Copy Issue Report The return type of `return $this->parseArray...equest, $parserObject);` (`array`) is incompatible with the return type documented by `Mcustiel\SimpleRequest\R...Builder::executeParsing` of type `object\|object[]`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
91		}
92	94	return $parserObject->parse($request);
93		}
94
95		/**
96		* @param array $request
97		* @param RequestParser $parserObject
98		*/
99	1	private function parseArray(array $request, RequestParser $parserObject)
100		{
101	1	$return = [];
102	1	foreach ($request as $requestItem) {
103	1	$return[] = $parserObject->parse($requestItem);
104	1	}
105	1	return $return;
106		}
107
108		/**
109		* @param string\|array $className
110		* @param bool $isArray
111		*
112		* @return string
113		*/
114	97	private function getClassName($className, $isArray)
115		{
116	97	return '' . $isArray ? $className[0] : $className;
117		}
118
119		/**
120		* @param string $className
121		* @param RequestParser $parser
122		*
123		* @return \Mcustiel\SimpleRequest\RequestParser\|mixed
124		*/
125	97	private function generateRequestParserObject($className, RequestParser $parser)
126		{
127	97	$cacheKey = str_replace('\\', '', $className . get_class($parser));
128	97	$cacheItem = $this->cache->getItem($cacheKey);
129	97	$return = $cacheItem->get();
130	97	if ($return === null) {
131	95	$return = $this->parserGenerator->populateRequestParser($className, $parser, $this);
132	95	$cacheItem->set($return);
133	95	$this->cache->save($cacheItem);
134	95	}
135
136	97	return $return;
137		}
138
139		/**
140		* @param mixed $request
141		*
142		* @throws \Mcustiel\SimpleRequest\Exception\InvalidRequestException
143		*
144		* @return \stdClass\|mixed
145		*/
146	97	private function sanitizeRequestOrThrowExceptionIfInvalid($request)
147		{
148	97	$isObject = ($request instanceof \stdClass);
149	97	if (!is_array($request) && !$isObject) {
150	2	throw new InvalidRequestException(
151		'Request builder is intended to be used with arrays or instances of \\stdClass'
152	2	);
153		}
154	95	return $isObject ? json_decode(json_encode($request), true) : $request;
155		}
156		}
157

mcustiel / php-simple-request

Pull Request — master (#5)

RequestBuilder::getClassName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like