DataTablesWrapper::getRouteArguments() - Code Metrics - Inspection of "Update Abstract DataTables test" - webeweb/jquery-datatables-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 043997...8de9a3 )

by WEBEWEB

created 2018-04-09 20:38 UTC

DataTablesWrapper::getRouteArguments() A

↳ Parent: DataTablesWrapper

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

/**
 * This file is part of the jquery-datatables-bundle package.
 *
 * (c) 2018 WEBEWEB
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WBW\Bundle\JQuery\DatatablesBundle\Wrapper;

use Symfony\Component\HttpFoundation\Request;
use WBW\Bundle\JQuery\DatatablesBundle\Column\DataTablesColumn;
use WBW\Bundle\JQuery\DatatablesBundle\Mapping\DataTablesMapping;
use WBW\Bundle\JQuery\DatatablesBundle\Request\DataTablesRequest;
use WBW\Bundle\JQuery\DatatablesBundle\Response\DataTablesResponse;
use WBW\Library\Core\HTTP\HTTPMethodInterface;

/**
 * DataTables wrapper.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Bundle\JQuery\DatatablesBundle\Wrapper
 * @final
 */
final class DataTablesWrapper implements HTTPMethodInterface {

    /**
     * Columns.
     *
     * @var DataTablesColumn[]
     */
    private $columns;

    /**
     * Mapping.
     *
     * @var DataTablesMapping
     */
    private $mapping;

    /**
     * Method.
     *
     * @var string
     */
    private $method;

    /**
     * Order.
     *
     * @var array
     */
    private $order;

    /**
     * Processing.
     *
     * @var boolean
     */
    private $processing;

    /**
     * Request.
     *
     * @var DataTablesRequest
     */
    private $request;

    /**
     * Response.
     *
     * @var DataTablesResponse
     */
    private $response;

    /**
     * Route.
     *
     * @var string
     */
    private $route;

    /**
     * Route arguments.
     *
     * @var array
     */
    private $routeArguments;

    /**
     * Server side.
     *
     * @var boolean
     */
    private $serverSide;

    /**
     * Constructor.
     *
     * @param string $prefix The prefix.
     * @param string $method The method.
     * @param string $route The route.
     * @param array $routeArguments The route arguments.
     */
    public function __construct($prefix, $method, $route, array $routeArguments = []) {
        $this->mapping = new DataTablesMapping();
        $this->mapping->setPrefix($prefix);

        $this->setColumns([]);
        $this->setMethod($method);
        $this->setOrder([]);
        $this->setProcessing(true);
        $this->setRoute($route);
        $this->setRouteArguments($routeArguments);
        $this->setServerSide(true);
    }

    /**
     * Add a column.
     *
     * @param DataTablesColumn $column The column.
     * @return DataTablesWrapper Returns the DataTables wrapper.
     */
    public function addColumn(DataTablesColumn $column) {
        $this->columns[$column->getName()] = $column;
        if (null === $column->getMapping()->getPrefix()) {
            $this->columns[$column->getName()]->getMapping()->setPrefix($this->mapping->getPrefix());
        }
        return $this;
    }

    /**
     * Get a column.
     *
     * @param string $name The column name.
     * @return DataTablesColumn Returns the DataTables column in case of success, null otherwise.
     */
    public function getColumn($name) {
        if (true === array_key_exists($name, $this->columns)) {
            return $this->columns[$name];
        }
        return null;
    }

    /**
     * Get the columns.
     *
     * @return DataTablesColumn[] Returns the columns.
     */
    public function getColumns() {
        return $this->columns;
    }

    /**
     * Get the mapping.
     *
     * @return DataTablesMapping The mapping.
     */
    public function getMapping() {
        return $this->mapping;
    }

    /**
     * Get the method.
     *
     * @return string Returns the method.
     */
    public function getMethod() {
        return $this->method;
    }

    /**
     * Get the order.
     *
     * @return array Returns the order.
     */
    public function getOrder() {
        return $this->order;
    }

    /**
     * Get the processing.
     *
     * @return boolean Returns the processing.
     */
    public function getProcessing() {
        return $this->processing;
    }

    /**
     * Get the request.
     *
     * @return DataTablesRequest The request.
     */
    public function getRequest() {
        return $this->request;
    }

    /**
     * Get the response.
     *
     * @return DataTablesResponse Returns the response.
     */
    public function getResponse() {
        return $this->response;
    }

    /**
     * Get the route.
     *
     * @return string Returns the route.
     */
    public function getRoute() {
        return $this->route;
    }

    /**
     * Get the route arguments.
     *
     * @return array Returns the route arguments.
     */
    public function getRouteArguments() {
        return $this->routeArguments;
    }

    /**
     * Get the server side.
     *
     * @return boolean Returns the server side.
     */
    public function getServerSide() {
        return $this->serverSide;
    }

    /**
     * Parse a request.
     *
     * @param Request $request The request.
     */
    public function parse(Request $request) {
        $this->request  = new DataTablesRequest($this, $request);
        $this->response = new DataTablesResponse($this->request);
    }

    /**
     * Remove a column.
     *
     * @param DataTablesColumn $column The column.
     * @return DataTablesWrapper Returns the DataTables wrapper.
     */
    public function removeColumn(DataTablesColumn $column) {
        if (true === array_key_exists($column->getName(), $this->columns)) {
            $this->columns[$column->getName()]->getMapping()->setPrefix(null);
            unset($this->columns[$column->getName()]);
        }
        return $this;
    }

    /**
     * Set the columns.
     *
     * @param DataTablesColumn[] $columns The columns.
     * @return DataTablesWrapper Returns the DataTables wrapper.
     */
    private function setColumns(array $columns) {
        $this->columns = $columns;
        return $this;
    }

    /**
     * Set the method.
     *
     * @param string $method The method.
     * @return DataTablesWrapper Returns the DataTables wrapper.
     */
    public function setMethod($method) {
        switch ($method) {
            case self::METHOD_GET:
            case self::METHOD_POST:
                $this->method = $method;
                break;
            default:
                $this->method = self::METHOD_GET;
        }
        return $this;
    }

    /**
     * Set the order.
     *
     * @param array $order The order.
     * @return DataTablesWrapper Returns the DataTables wrapper.
     */
    public function setOrder(array $order) {
        $this->order = $order;
        return $this;
    }

    /**
     * Set the processing.
     *
     * @param boolean $processing The processing.
     * @return DataTablesWrapper Returns the DataTables wrapper.
     */
    public function setProcessing($processing) {
        switch (true) {
            case (false === $processing):
            case (true === $processing):
                $this->processing = $processing;
                break;
            default:
                $this->processing = true;
                break;
        }
        return $this;
    }

    /**
     * Set the route.
     *
     * @param string $route The route.
     * @return DataTablesWrapper Returns the DataTables wrapper.
     */
    public function setRoute($route) {
        $this->route = $route;
        return $this;
    }

    /**
     * Set the route arguments.
     *
     * @param array $routeArguments The route arguments.
     * @return DataTablesWrapper Returns the DatTables wrapper.
     */
    public function setRouteArguments(array $routeArguments) {
        $this->routeArguments = $routeArguments;
        return $this;
    }

    /**
     * Set the server side.
     *
     * @param boolean $serverSide The server side.
     * @return DataTablesWrapper Returns the DataTables wrapper.
     */
    public function setServerSide($serverSide) {
        switch (true) {
            case (false === $serverSide):
            case (true === $serverSide):
                $this->serverSide = $serverSide;
                break;
            default:
                $this->serverSide = true;
                break;
        }
        return $this;
    }

}


1			<?php
2
3			/**
4			* This file is part of the jquery-datatables-bundle package.
5			*
6			* (c) 2018 WEBEWEB
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace WBW\Bundle\JQuery\DatatablesBundle\Wrapper;
13
14			use Symfony\Component\HttpFoundation\Request;
15			use WBW\Bundle\JQuery\DatatablesBundle\Column\DataTablesColumn;
16			use WBW\Bundle\JQuery\DatatablesBundle\Mapping\DataTablesMapping;
17			use WBW\Bundle\JQuery\DatatablesBundle\Request\DataTablesRequest;
18			use WBW\Bundle\JQuery\DatatablesBundle\Response\DataTablesResponse;
19			use WBW\Library\Core\HTTP\HTTPMethodInterface;
20
21			/**
22			* DataTables wrapper.
23			*
24			* @author webeweb <https://github.com/webeweb/>
25			* @package WBW\Bundle\JQuery\DatatablesBundle\Wrapper
26			* @final
27			*/
28			final class DataTablesWrapper implements HTTPMethodInterface {
29
30			/**
31			* Columns.
32			*
33			* @var DataTablesColumn[]
34			*/
35			private $columns;
36
37			/**
38			* Mapping.
39			*
40			* @var DataTablesMapping
41			*/
42			private $mapping;
43
44			/**
45			* Method.
46			*
47			* @var string
48			*/
49			private $method;
50
51			/**
52			* Order.
53			*
54			* @var array
55			*/
56			private $order;
57
58			/**
59			* Processing.
60			*
61			* @var boolean
62			*/
63			private $processing;
64
65			/**
66			* Request.
67			*
68			* @var DataTablesRequest
69			*/
70			private $request;
71
72			/**
73			* Response.
74			*
75			* @var DataTablesResponse
76			*/
77			private $response;
78
79			/**
80			* Route.
81			*
82			* @var string
83			*/
84			private $route;
85
86			/**
87			* Route arguments.
88			*
89			* @var array
90			*/
91			private $routeArguments;
92
93			/**
94			* Server side.
95			*
96			* @var boolean
97			*/
98			private $serverSide;
99
100			/**
101			* Constructor.
102			*
103			* @param string $prefix The prefix.
104			* @param string $method The method.
105			* @param string $route The route.
106			* @param array $routeArguments The route arguments.
107			*/
108			public function __construct($prefix, $method, $route, array $routeArguments = []) {
109			$this->mapping = new DataTablesMapping();
110			$this->mapping->setPrefix($prefix);
111
112			$this->setColumns([]);
113			$this->setMethod($method);
114			$this->setOrder([]);
115			$this->setProcessing(true);
116			$this->setRoute($route);
117			$this->setRouteArguments($routeArguments);
118			$this->setServerSide(true);
119			}
120
121			/**
122			* Add a column.
123			*
124			* @param DataTablesColumn $column The column.
125			* @return DataTablesWrapper Returns the DataTables wrapper.
126			*/
127			public function addColumn(DataTablesColumn $column) {
128			$this->columns[$column->getName()] = $column;
129			if (null === $column->getMapping()->getPrefix()) {
130			$this->columns[$column->getName()]->getMapping()->setPrefix($this->mapping->getPrefix());
131			}
132			return $this;
133			}
134
135			/**
136			* Get a column.
137			*
138			* @param string $name The column name.
139			* @return DataTablesColumn Returns the DataTables column in case of success, null otherwise.
140			*/
141			public function getColumn($name) {
142			if (true === array_key_exists($name, $this->columns)) {
143			return $this->columns[$name];
144			}
145			return null;
146			}
147
148			/**
149			* Get the columns.
150			*
151			* @return DataTablesColumn[] Returns the columns.
152			*/
153			public function getColumns() {
154			return $this->columns;
155			}
156
157			/**
158			* Get the mapping.
159			*
160			* @return DataTablesMapping The mapping.
161			*/
162			public function getMapping() {
163			return $this->mapping;
164			}
165
166			/**
167			* Get the method.
168			*
169			* @return string Returns the method.
170			*/
171			public function getMethod() {
172			return $this->method;
173			}
174
175			/**
176			* Get the order.
177			*
178			* @return array Returns the order.
179			*/
180			public function getOrder() {
181			return $this->order;
182			}
183
184			/**
185			* Get the processing.
186			*
187			* @return boolean Returns the processing.
188			*/
189			public function getProcessing() {
190			return $this->processing;
191			}
192
193			/**
194			* Get the request.
195			*
196			* @return DataTablesRequest The request.
197			*/
198			public function getRequest() {
199			return $this->request;
200			}
201
202			/**
203			* Get the response.
204			*
205			* @return DataTablesResponse Returns the response.
206			*/
207			public function getResponse() {
208			return $this->response;
209			}
210
211			/**
212			* Get the route.
213			*
214			* @return string Returns the route.
215			*/
216			public function getRoute() {
217			return $this->route;
218			}
219
220			/**
221			* Get the route arguments.
222			*
223			* @return array Returns the route arguments.
224			*/
225			public function getRouteArguments() {
226			return $this->routeArguments;
227			}
228
229			/**
230			* Get the server side.
231			*
232			* @return boolean Returns the server side.
233			*/
234			public function getServerSide() {
235			return $this->serverSide;
236			}
237
238			/**
239			* Parse a request.
240			*
241			* @param Request $request The request.
242			*/
243			public function parse(Request $request) {
244			$this->request = new DataTablesRequest($this, $request);
245			$this->response = new DataTablesResponse($this->request);
246			}
247
248			/**
249			* Remove a column.
250			*
251			* @param DataTablesColumn $column The column.
252			* @return DataTablesWrapper Returns the DataTables wrapper.
253			*/
254			public function removeColumn(DataTablesColumn $column) {
255			if (true === array_key_exists($column->getName(), $this->columns)) {
256			$this->columns[$column->getName()]->getMapping()->setPrefix(null);
257			unset($this->columns[$column->getName()]);
258			}
259			return $this;
260			}
261
262			/**
263			* Set the columns.
264			*
265			* @param DataTablesColumn[] $columns The columns.
266			* @return DataTablesWrapper Returns the DataTables wrapper.
267			*/
268			private function setColumns(array $columns) {
269			$this->columns = $columns;
270			return $this;
271			}
272
273			/**
274			* Set the method.
275			*
276			* @param string $method The method.
277			* @return DataTablesWrapper Returns the DataTables wrapper.
278			*/
279			public function setMethod($method) {
280			switch ($method) {
281			case self::METHOD_GET:
282			case self::METHOD_POST:
283			$this->method = $method;
284			break;
285			default:
286			$this->method = self::METHOD_GET;
287			}
288			return $this;
289			}
290
291			/**
292			* Set the order.
293			*
294			* @param array $order The order.
295			* @return DataTablesWrapper Returns the DataTables wrapper.
296			*/
297			public function setOrder(array $order) {
298			$this->order = $order;
299			return $this;
300			}
301
302			/**
303			* Set the processing.
304			*
305			* @param boolean $processing The processing.
306			* @return DataTablesWrapper Returns the DataTables wrapper.
307			*/
308			public function setProcessing($processing) {
309			switch (true) {
310			case (false === $processing):
311			case (true === $processing):
312			$this->processing = $processing;
313			break;
314			default:
315			$this->processing = true;
316			break;
317			}
318			return $this;
319			}
320
321			/**
322			* Set the route.
323			*
324			* @param string $route The route.
325			* @return DataTablesWrapper Returns the DataTables wrapper.
326			*/
327			public function setRoute($route) {
328			$this->route = $route;
329			return $this;
330			}
331
332			/**
333			* Set the route arguments.
334			*
335			* @param array $routeArguments The route arguments.
336			* @return DataTablesWrapper Returns the DatTables wrapper.
337			*/
338			public function setRouteArguments(array $routeArguments) {
339			$this->routeArguments = $routeArguments;
340			return $this;
341			}
342
343			/**
344			* Set the server side.
345			*
346			* @param boolean $serverSide The server side.
347			* @return DataTablesWrapper Returns the DataTables wrapper.
348			*/
349			public function setServerSide($serverSide) {
350			switch (true) {
351			case (false === $serverSide):
352			case (true === $serverSide):
353			$this->serverSide = $serverSide;
354			break;
355			default:
356			$this->serverSide = true;
357			break;
358			}
359			return $this;
360			}
361
362			}
363

webeweb / jquery-datatables-bundle

Push — master ( 043997...8de9a3 )

DataTablesWrapper::getRouteArguments() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like