AbstractMapper::addParam() - Code Metrics - Inspection of "Validator fixes" - bluzphp/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#443)

by Anton

created 2017-10-19 08:08 UTC

AbstractMapper::addParam() A

↳ Parent: AbstractMapper

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
/**
 * Bluz Framework Component
 *
 * @copyright Bluz PHP Team
 * @link      https://github.com/bluzphp/framework
 */

declare(strict_types=1);

namespace Bluz\Controller\Mapper;

use Bluz\Application\Application;
use Bluz\Application\Exception\ForbiddenException;
use Bluz\Application\Exception\NotAcceptableException;
use Bluz\Application\Exception\NotAllowedException;
use Bluz\Application\Exception\NotImplementedException;
use Bluz\Common\Exception\CommonException;
use Bluz\Common\Exception\ComponentException;
use Bluz\Controller\Controller;
use Bluz\Controller\ControllerException;
use Bluz\Crud\AbstractCrud;
use Bluz\Http\RequestMethod;
use Bluz\Proxy\Acl;
use Bluz\Proxy\Request;
use Bluz\Proxy\Router;

/**
 * Mapper for controller
 *
 * @package  Bluz\Rest
 * @author   Anton Shevchuk
 */
abstract class AbstractMapper
{
    /**
     * @var string HTTP Method
     */
    protected $method = RequestMethod::GET;

    /**
     * @var string
     */
    protected $module;

    /**
     * @var string
     */
    protected $controller;

    /**
     * @var array identifier
     */
    protected $primary;

    /**
     * @var string relation list
     */
    protected $relation;

    /**
     * @var string relation Id
     */
    protected $relationId;

    /**
     * @var array params of query
     */
    protected $params = [];

    /**
     * @var array query data
     */
    protected $data = [];

    /**
     * @var AbstractCrud instance of CRUD
     */
    protected $crud;

    /**
     * [
     *     METHOD => Link {
     *         'module' => 'module',
     *         'controller' => 'controller',
     *         'acl' => 'privilege',
     *         'fields' => ['id', ... ]
     *     },
     * ]
     *
     * @var Link[]
     */
    protected $map = [];

    /**
     * Prepare params
     *
     * @return array
     */
    abstract protected function prepareParams(): array;

    /**
     * @param AbstractCrud $crud
     */
    public function __construct(AbstractCrud $crud)
    {
        $this->crud = $crud;
    }

    /**
     * Add mapping data
     *
     * @param string $method
     * @param string $module
     * @param string $controller
     * @return Link
     */
    public function addMap($method, $module, $controller) : Link
    {
        return $this->map[strtoupper($method)] = new Link($module, $controller);
    }

    /**
     * Add param to data, for example - setup foreign keys on fly
     *
     * @return void
     */
    public function addParam($name, $value)
    {
        $this->data[$name] = $value;
    }

    /**
     * Add mapping for HEAD method
     *
     * @param string $module
     * @param string $controller
     * @return Link
     */
    public function head($module, $controller) : Link
    {
        return $this->addMap(RequestMethod::HEAD, $module, $controller);
    }

    /**
     * Add mapping for GET method
     *
     * @param string $module
     * @param string $controller
     * @return Link
     */
    public function get($module, $controller) : Link
    {
        return $this->addMap(RequestMethod::GET, $module, $controller);
    }

    /**
     * Add mapping for POST method
     *
     * @param string $module
     * @param string $controller
     * @return Link
     */
    public function post($module, $controller) : Link
    {
        return $this->addMap(RequestMethod::POST, $module, $controller);
    }

    /**
     * Add mapping for PATCH method
     *
     * @param string $module
     * @param string $controller
     * @return Link
     */
    public function patch($module, $controller) : Link
    {
        return $this->addMap(RequestMethod::PATCH, $module, $controller);
    }

    /**
     * Add mapping for PUT method
     *
     * @param string $module
     * @param string $controller
     * @return Link
     */
    public function put($module, $controller) : Link
    {
        return $this->addMap(RequestMethod::PUT, $module, $controller);
    }

    /**
     * Add mapping for DELETE method
     *
     * @param string $module
     * @param string $controller
     * @return Link
     */
    public function delete($module, $controller) : Link
    {
        return $this->addMap(RequestMethod::DELETE, $module, $controller);
    }

    /**
     * Add mapping for OPTIONS method
     *
     * @param string $module
     * @param string $controller
     * @return Link
     */
    public function options($module, $controller) : Link
    {
        return $this->addMap(RequestMethod::OPTIONS, $module, $controller);
    }

    /**
     * Run
     *
     * @return Controller
     * @throws ControllerException
     * @throws ForbiddenException
     * @throws NotImplementedException
     */
    public function run() : Controller
    {
        $this->prepareRequest();
        return $this->dispatch();
    }

    /**
     * Prepare request for processing
     *
     * @throws \Bluz\Controller\ControllerException
     */
    protected function prepareRequest()
    {
        // HTTP method
        $method = Request::getMethod();
        $this->method = strtoupper($method);

        // get path
        // %module% / %controller% / %id% / %relation% / %id%
        $path = Router::getCleanUri();

        $this->params = explode('/', rtrim($path, '/'));

        // module
        $this->module = array_shift($this->params);

        // controller
        $this->controller = array_shift($this->params);

        $data = Request::getParams();

        unset($data['_method'], $data['_module'], $data['_controller']);

        $this->data = array_merge($data, $this->data);

        $primary = $this->crud->getPrimaryKey();
        $this->primary = array_intersect_key($this->data, array_flip($primary));
    }

    /**
     * Dispatch REST or CRUD controller
     *
     * @return mixed
     * @throws ComponentException
     * @throws CommonException
     * @throws ControllerException
     * @throws ForbiddenException
     * @throws NotAllowedException
     * @throws NotAcceptableException
     * @throws NotImplementedException
     */
    protected function dispatch()
    {
        // check implementation
        if (!isset($this->map[$this->method])) {
            throw new NotImplementedException;
        }

        $link = $this->map[$this->method];

        // check permissions
        if (!Acl::isAllowed($this->module, $link->getAcl())) {
            throw new ForbiddenException;
        }

        $this->crud->setFields($link->getFields());

        // dispatch controller
        $result = Application::getInstance()->dispatch(
            $link->getModule(),
            $link->getController(),
            $this->prepareParams()
        );

        return $result;
    }
}


1		<?php
2		/**
3		* Bluz Framework Component
4		*
5		* @copyright Bluz PHP Team
6		* @link https://github.com/bluzphp/framework
7		*/
8
9		declare(strict_types=1);
10
11		namespace Bluz\Controller\Mapper;
12
13		use Bluz\Application\Application;
14		use Bluz\Application\Exception\ForbiddenException;
15		use Bluz\Application\Exception\NotAcceptableException;
16		use Bluz\Application\Exception\NotAllowedException;
17		use Bluz\Application\Exception\NotImplementedException;
18		use Bluz\Common\Exception\CommonException;
19		use Bluz\Common\Exception\ComponentException;
20		use Bluz\Controller\Controller;
21		use Bluz\Controller\ControllerException;
22		use Bluz\Crud\AbstractCrud;
23		use Bluz\Http\RequestMethod;
24		use Bluz\Proxy\Acl;
25		use Bluz\Proxy\Request;
26		use Bluz\Proxy\Router;
27
28		/**
29		* Mapper for controller
30		*
31		* @package Bluz\Rest
32		* @author Anton Shevchuk
33		*/
34		abstract class AbstractMapper
35		{
36		/**
37		* @var string HTTP Method
38		*/
39		protected $method = RequestMethod::GET;
40
41		/**
42		* @var string
43		*/
44		protected $module;
45
46		/**
47		* @var string
48		*/
49		protected $controller;
50
51		/**
52		* @var array identifier
53		*/
54		protected $primary;
55
56		/**
57		* @var string relation list
58		*/
59		protected $relation;
60
61		/**
62		* @var string relation Id
63		*/
64		protected $relationId;
65
66		/**
67		* @var array params of query
68		*/
69		protected $params = [];
70
71		/**
72		* @var array query data
73		*/
74		protected $data = [];
75
76		/**
77		* @var AbstractCrud instance of CRUD
78		*/
79		protected $crud;
80
81		/**
82		* [
83		* METHOD => Link {
84		* 'module' => 'module',
85		* 'controller' => 'controller',
86		* 'acl' => 'privilege',
87		* 'fields' => ['id', ... ]
88		* },
89		* ]
90		*
91		* @var Link[]
92		*/
93		protected $map = [];
94
95		/**
96		* Prepare params
97		*
98		* @return array
99		*/
100		abstract protected function prepareParams(): array;
101
102		/**
103		* @param AbstractCrud $crud
104		*/
105	16	public function __construct(AbstractCrud $crud)
106		{
107	16	$this->crud = $crud;
108	16	}
109
110		/**
111		* Add mapping data
112		*
113		* @param string $method
114		* @param string $module
115		* @param string $controller
116		* @return Link
117		*/
118	15	public function addMap($method, $module, $controller) : Link
119		{
120	15	return $this->map[strtoupper($method)] = new Link($module, $controller);
121		}
122
123		/**
124		* Add param to data, for example - setup foreign keys on fly
125		*
126		* @return void
127		*/
128		public function addParam($name, $value)
129		{
130		$this->data[$name] = $value;
131		}
132
133		/**
134		* Add mapping for HEAD method
135		*
136		* @param string $module
137		* @param string $controller
138		* @return Link
139		*/
140		public function head($module, $controller) : Link
141		{
142		return $this->addMap(RequestMethod::HEAD, $module, $controller);
143		}
144
145		/**
146		* Add mapping for GET method
147		*
148		* @param string $module
149		* @param string $controller
150		* @return Link
151		*/
152		public function get($module, $controller) : Link
153		{
154		return $this->addMap(RequestMethod::GET, $module, $controller);
155		}
156
157		/**
158		* Add mapping for POST method
159		*
160		* @param string $module
161		* @param string $controller
162		* @return Link
163		*/
164		public function post($module, $controller) : Link
165		{
166		return $this->addMap(RequestMethod::POST, $module, $controller);
167		}
168
169		/**
170		* Add mapping for PATCH method
171		*
172		* @param string $module
173		* @param string $controller
174		* @return Link
175		*/
176		public function patch($module, $controller) : Link
177		{
178		return $this->addMap(RequestMethod::PATCH, $module, $controller);
179		}
180
181		/**
182		* Add mapping for PUT method
183		*
184		* @param string $module
185		* @param string $controller
186		* @return Link
187		*/
188		public function put($module, $controller) : Link
189		{
190		return $this->addMap(RequestMethod::PUT, $module, $controller);
191		}
192
193		/**
194		* Add mapping for DELETE method
195		*
196		* @param string $module
197		* @param string $controller
198		* @return Link
199		*/
200		public function delete($module, $controller) : Link
201		{
202		return $this->addMap(RequestMethod::DELETE, $module, $controller);
203		}
204
205		/**
206		* Add mapping for OPTIONS method
207		*
208		* @param string $module
209		* @param string $controller
210		* @return Link
211		*/
212		public function options($module, $controller) : Link
213		{
214		return $this->addMap(RequestMethod::OPTIONS, $module, $controller);
215		}
216
217		/**
218		* Run
219		*
220		* @return Controller
221		* @throws ControllerException
222		* @throws ForbiddenException
223		* @throws NotImplementedException
224		*/
225	16	public function run() : Controller
226		{
227	16	$this->prepareRequest();
228	16	return $this->dispatch();
229		}
230
231		/**
232		* Prepare request for processing
233		*
234		* @throws \Bluz\Controller\ControllerException
235		*/
236	16	protected function prepareRequest()
237		{
238		// HTTP method
239	16	$method = Request::getMethod();
240	16	$this->method = strtoupper($method);
241
242		// get path
243		// %module% / %controller% / %id% / %relation% / %id%
244	16	$path = Router::getCleanUri();
245
246	16	$this->params = explode('/', rtrim($path, '/'));
247
248		// module
249	16	$this->module = array_shift($this->params);
250
251		// controller
252	16	$this->controller = array_shift($this->params);
253
254	16	$data = Request::getParams();
255
256	16	unset($data['_method'], $data['_module'], $data['_controller']);
257
258	16	$this->data = array_merge($data, $this->data);
259
260	16	$primary = $this->crud->getPrimaryKey();
261	16	$this->primary = array_intersect_key($this->data, array_flip($primary));
262	16	}
263
264		/**
265		* Dispatch REST or CRUD controller
266		*
267		* @return mixed
268		* @throws ComponentException
269		* @throws CommonException
270		* @throws ControllerException
271		* @throws ForbiddenException
272		* @throws NotAllowedException
273		* @throws NotAcceptableException
274		* @throws NotImplementedException
275		*/
276	16	protected function dispatch()
277		{
278		// check implementation
279	16	if (!isset($this->map[$this->method])) {
280	1	throw new NotImplementedException;
281		}
282
283	15	$link = $this->map[$this->method];
284
285		// check permissions
286	15	if (!Acl::isAllowed($this->module, $link->getAcl())) {
287	2	throw new ForbiddenException;
288		}
289
290	13	$this->crud->setFields($link->getFields());
291
292		// dispatch controller
293	13	$result = Application::getInstance()->dispatch(
294	13	$link->getModule(),
295	13	$link->getController(),
296	13	$this->prepareParams()
297		);
298
299	13	return $result;
300		}
301		}
302

bluzphp / framework

Pull Request — master (#443)

AbstractMapper::addParam() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like