DataTablesWrapper::addColumn() - Code Metrics - Inspection of "Add addColumn() and removeColumn() methods" - webeweb/jquery-datatables-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3eca47...f1e1aa )

by WEBEWEB

created 2018-03-19 16:18 UTC

DataTablesWrapper::addColumn() A

↳ Parent: DataTablesWrapper

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	1

<?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\API\Wrapper;

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

/**
 * DataTables wrapper.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Bundle\JQuery\DatatablesBundle\API\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;

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

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

        $this->setColumns([]);
        $this->setMethod($method);
        $this->setOrder([]);
        $this->setProcessing(true);
        $this->setRoute($route);
        $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;
        $this->columns[$column->getName()]->getMapping()->setPrefix($this->mapping->getPrefix());
        return $this;
    }

    /**
     * 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 reoute.
     */
    public function getRoute() {
        return $this->route;
    }

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

    /**
     * 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 ($processing) {
            case false :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
            case true :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
                $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 server side.
     *
     * @param boolean $serverSide The server side.
     * @return DataTablesWrapper Returns the DataTables wrapper.
     */
    public function setServerSide($serverSide) {
        switch ($serverSide) {
            case false :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
            case true :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
                $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\API\Wrapper;
13
14			use WBW\Bundle\JQuery\DatatablesBundle\API\Column\DataTablesColumn;
15			use WBW\Bundle\JQuery\DatatablesBundle\API\Mapping\DataTablesMapping;
16			use WBW\Bundle\JQuery\DatatablesBundle\API\Request\DataTablesRequest;
17			use WBW\Bundle\JQuery\DatatablesBundle\API\Response\DataTablesResponse;
18			use WBW\Library\Core\HTTP\HTTPMethodInterface;
19
20			/**
21			* DataTables wrapper.
22			*
23			* @author webeweb <https://github.com/webeweb/>
24			* @package WBW\Bundle\JQuery\DatatablesBundle\API\Wrapper
25			* @final
26			*/
27			final class DataTablesWrapper implements HTTPMethodInterface {
28
29			/**
30			* Columns.
31			*
32			* @var DataTablesColumn[]
33			*/
34			private $columns;
35
36			/**
37			* Mapping.
38			*
39			* @var DataTablesMapping
40			*/
41			private $mapping;
42
43			/**
44			* Method.
45			*
46			* @var string
47			*/
48			private $method;
49
50			/**
51			* Order.
52			*
53			* @var array
54			*/
55			private $order;
56
57			/**
58			* Processing.
59			*
60			* @var boolean
61			*/
62			private $processing;
63
64			/**
65			* Request.
66			*
67			* @var DataTablesRequest
68			*/
69			private $request;
70
71			/**
72			* Response.
73			*
74			* @var DataTablesResponse
75			*/
76			private $response;
77
78			/**
79			* Route.
80			*
81			* @var string
82			*/
83			private $route;
84
85			/**
86			* Server side.
87			*
88			* @var boolean
89			*/
90			private $serverSide;
91
92			/**
93			* Constructor.
94			*
95			* @param string $method The method.
96			* @param string $route The route.
97			* @param string $prefix The prefix.
98			*/
99			public function __construct($method, $route, $prefix) {
100			$this->mapping = new DataTablesMapping();
101			$this->mapping->setPrefix($prefix);
102
103			$this->setColumns([]);
104			$this->setMethod($method);
105			$this->setOrder([]);
106			$this->setProcessing(true);
107			$this->setRoute($route);
108			$this->setServerSide(true);
109			}
110
111			/**
112			* Add a column.
113			*
114			* @param DataTablesColumn $column The column.
115			* @return DataTablesWrapper Returns the DataTables wrapper.
116			*/
117			public function addColumn(DataTablesColumn $column) {
118			$this->columns[$column->getName()] = $column;
119			$this->columns[$column->getName()]->getMapping()->setPrefix($this->mapping->getPrefix());
120			return $this;
121			}
122
123			/**
124			* Get the columns.
125			*
126			* @return DataTablesColumn[] Returns the columns.
127			*/
128			public function getColumns() {
129			return $this->columns;
130			}
131
132			/**
133			* Get the mapping.
134			*
135			* @return DataTablesMapping The mapping.
136			*/
137			public function getMapping() {
138			return $this->mapping;
139			}
140
141			/**
142			* Get the method.
143			*
144			* @return string Returns the method.
145			*/
146			public function getMethod() {
147			return $this->method;
148			}
149
150			/**
151			* Get the order.
152			*
153			* @return array Returns the order.
154			*/
155			public function getOrder() {
156			return $this->order;
157			}
158
159			/**
160			* Get the processing.
161			*
162			* @return boolean Returns the processing.
163			*/
164			public function getProcessing() {
165			return $this->processing;
166			}
167
168			/**
169			* Get the request.
170			*
171			* @return DataTablesRequest The request.
172			*/
173			public function getRequest() {
174			return $this->request;
175			}
176
177			/**
178			* Get the response.
179			*
180			* @return DataTablesResponse Returns the response.
181			*/
182			public function getResponse() {
183			return $this->response;
184			}
185
186			/**
187			* Get the route.
188			*
189			* @return string Returns the reoute.
190			*/
191			public function getRoute() {
192			return $this->route;
193			}
194
195			/**
196			* Get the server side.
197			*
198			* @return boolean Returns the server side.
199			*/
200			public function getServerSide() {
201			return $this->serverSide;
202			}
203
204			/**
205			* Remove a column.
206			*
207			* @param DataTablesColumn $column The column.
208			* @return DataTablesWrapper Returns the DataTables wrapper.
209			*/
210			public function removeColumn(DataTablesColumn $column) {
211			if (true === array_key_exists($column->getName(), $this->columns)) {
212			$this->columns[$column->getName()]->getMapping()->setPrefix(null);
213			unset($this->columns[$column->getName()]);
214			}
215			return $this;
216			}
217
218			/**
219			* Set the columns.
220			*
221			* @param DataTablesColumn[] $columns The columns.
222			* @return DataTablesWrapper Returns the DataTables wrapper.
223			*/
224			private function setColumns(array $columns) {
225			$this->columns = $columns;
226			return $this;
227			}
228
229			/**
230			* Set the method.
231			*
232			* @param string $method The method.
233			* @return DataTablesWrapper Returns the DataTables wrapper.
234			*/
235			public function setMethod($method) {
236			switch ($method) {
237			case self::METHOD_GET:
238			case self::METHOD_POST:
239			$this->method = $method;
240			break;
241			default:
242			$this->method = self::METHOD_GET;
243			}
244			return $this;
245			}
246
247			/**
248			* Set the order.
249			*
250			* @param array $order The order.
251			* @return DataTablesWrapper Returns the DataTables wrapper.
252			*/
253			public function setOrder(array $order) {
254			$this->order = $order;
255			return $this;
256			}
257
258			/**
259			* Set the processing.
260			*
261			* @param boolean $processing The processing.
262			* @return DataTablesWrapper Returns the DataTables wrapper.
263			*/
264			public function setProcessing($processing) {
265			switch ($processing) {
266			case false :
			0 ignored issues – show Coding Style introduced 2018-03-19 14:38 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
267			case true :
			0 ignored issues – show Coding Style introduced 2018-03-19 14:38 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
268			$this->processing = $processing;
269			break;
270			default:
271			$this->processing = true;
272			break;
273			}
274			return $this;
275			}
276
277			/**
278			* Set the route.
279			*
280			* @param string $route The route.
281			* @return DataTablesWrapper Returns the DataTables wrapper.
282			*/
283			public function setRoute($route) {
284			$this->route = $route;
285			return $this;
286			}
287
288			/**
289			* Set the server side.
290			*
291			* @param boolean $serverSide The server side.
292			* @return DataTablesWrapper Returns the DataTables wrapper.
293			*/
294			public function setServerSide($serverSide) {
295			switch ($serverSide) {
296			case false :
			0 ignored issues – show Coding Style introduced 2018-03-19 14:38 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
297			case true :
			0 ignored issues – show Coding Style introduced 2018-03-19 14:38 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
298			$this->serverSide = $serverSide;
299			break;
300			default:
301			$this->serverSide = true;
302			break;
303			}
304			return $this;
305			}
306
307			}
308

webeweb / jquery-datatables-bundle

Push — master ( 3eca47...f1e1aa )

DataTablesWrapper::addColumn() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like