WBW\Bundle\JQuery\DataTablesBundle\API\DataTablesRequest

Complexity

Total Complexity

31

Size/Duplication

Total Lines	347
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	dtParameters()	0	10	1
A	getColumn()	0	8	3
A	getColumns()	0	3	1
A	getDraw()	0	3	1
A	getLength()	0	3	1
A	getOrder()	0	3	1
A	getQuery()	0	3	1
A	getRequest()	0	3	1
A	getSearch()	0	3	1
A	getStart()	0	3	1
A	getWrapper()	0	3	1
A	parse()	0	33	5
A	recopy()	0	8	3
A	setColumns()	0	4	1
A	setDraw()	0	4	1
A	setLength()	0	4	1
A	setOrder()	0	4	1
A	setQuery()	0	4	1
A	setRequest()	0	4	1
A	setSearch()	0	4	1
A	setStart()	0	4	1
A	setWrapper()	0	4	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;

use Symfony\Component\HttpFoundation\ParameterBag;
use Symfony\Component\HttpFoundation\Request;
use WBW\Library\Core\IO\HTTPInterface;

/**
 * DataTables request.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Bundle\JQuery\DataTablesBundle\API
 */
class DataTablesRequest implements DataTablesRequestInterface, HTTPInterface {

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

    /**
     * Draw.
     *
     * @var integer
     */
    private $draw;

    /**
     * Length.
     *
     * @var integer
     */
    private $length;

    /**
     * Order.
     *
     * @var DataTablesOrder[]
     */
    private $order;

    /**
     * Query.
     *
     * @var ParameterBag
     */
    private $query;

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

    /**
     * Search.
     *
     * @var DataTablesSearch
     */
    private $search;

    /**
     * Start.
     *
     * @var integer
     */
    private $start;

    /**
     * Wrapper.
     *
     * @var DataTablesWrapper
     */
    private $wrapper;

    /**
     * Constructor.
     */
    protected function __construct() {
        $this->setColumns([]);
        $this->setDraw(0);
        $this->setLength(10);
        $this->setOrder([]);
        $this->setQuery(new ParameterBag());
        $this->setRequest(new ParameterBag());
        $this->setStart(0);
    }

    /**
     * DataTables parameters.
     *
     * @return array Returns the DataTables parameters.
     */
    public static function dtParameters() {
        return [
            self::DATATABLES_PARAMETER_COLUMNS,
            self::DATATABLES_PARAMETER_DRAW,
            self::DATATABLES_PARAMETER_LENGTH,
            self::DATATABLES_PARAMETER_ORDER,
            self::DATATABLES_PARAMETER_SEARCH,
            self::DATATABLES_PARAMETER_START,
        ];
    }

    /**
     * Get a column.
     *
     * @param string $data The column data.
     * @return array Returns the column in case of success, null otherwise.
     */
    public function getColumn($data) {
        foreach ($this->columns as $current) {
            if ($data === $current->getData()) {
                return $current;
            }
        }
        return null;
    }

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

    /**
     * Get the draw.
     *
     * @return integer Returns the draw.
     */
    public function getDraw() {
        return $this->draw;
    }

    /**
     * Get the length.
     *
     * @return integer Returns the length.
     */
    public function getLength() {
        return $this->length;
    }

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

    /**
     * Get the query.
     *
     * @return ParameterBag Returns the query.
     */
    public function getQuery() {
        return $this->query;
    }

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

    /**
     * Get the search.
     *
     * @return DatTablesSearch Returns the search.
     */
    public function getSearch() {
        return $this->search;
    }

    /**
     * Get the start.
     *
     * @return integer Returns the start.
     */
    public function getStart() {
        return $this->start;
    }

    /**
     * Get the wrapper.
     *
     * @return DataTablesWrapper Returns the wrapper.
     */
    public function getWrapper() {
        return $this->wrapper;
    }

    /**
     * Parse a request.
     *
     * @param DataTablesWrapper $wrapper The wrapper.
     * @param Request $request The request.
     * @return DataTablesRequest Returns the DataTables request.
     */
    public static function parse(DataTablesWrapper $wrapper, Request $request) {

        // Initialize a DataTables request.
        $dtRequest = new DataTablesRequest();

        // Recopy the parameter bags.
        self::recopy($request->query, $dtRequest->getQuery());
        self::recopy($request->request, $dtRequest->getRequest());

        // Get the parameter bag.
        if (self::HTTP_METHOD_GET === $request->getMethod()) {
            $parameterBag = $request->query;
        } else {
            $parameterBag = $request->request;
        }

        // Get the request parameters.
        $columns = null !== $parameterBag->get(self::DATATABLES_PARAMETER_COLUMNS) ? $parameterBag->get(self::DATATABLES_PARAMETER_COLUMNS) : [];
        $orders  = null !== $parameterBag->get(self::DATATABLES_PARAMETER_ORDER) ? $parameterBag->get(self::DATATABLES_PARAMETER_ORDER) : [];
        $search  = null !== $parameterBag->get(self::DATATABLES_PARAMETER_SEARCH) ? $parameterBag->get(self::DATATABLES_PARAMETER_SEARCH) : [];

        // Set the DataTables request.
        $dtRequest->setColumns(DataTablesColumn::parse($columns, $wrapper));
        $dtRequest->setDraw($parameterBag->getInt(self::DATATABLES_PARAMETER_DRAW));
        $dtRequest->setLength($parameterBag->getInt(self::DATATABLES_PARAMETER_LENGTH));
        $dtRequest->setOrder(DataTablesOrder::parse($orders));
        $dtRequest->setSearch(DataTablesSearch::parse($search));
        $dtRequest->setStart($parameterBag->getInt(self::DATATABLES_PARAMETER_START));
        $dtRequest->setWrapper($wrapper);

        // Return the DataTables request.
        return $dtRequest;
    }

    /**
     * Recopy.
     *
     * @param ParameterBag $request The request.
     * @param ParameterBag $bag The bag.
     * @return void
     */
    protected static function recopy(ParameterBag $request, ParameterBag $bag) {
        foreach ($request->keys() as $current) {
            if (true === in_array($current, self::dtParameters())) {
                continue;
            }
            $bag->set($current, $request->get($current));
        }
    }

    /**
     * Set the columns.
     *
     * @param DataTablesColumn[] $columns The columns.
     * @return DataTablesRequest Returns this DataTables request.
     */
    protected function setColumns($columns) {
        $this->columns = $columns;
        return $this;
    }

    /**
     * Set the draw.
     *
     * @param integer $draw The draw.
     * @return DataTablesRequest Returns this DataTables request.
     */
    protected function setDraw($draw) {
        $this->draw = $draw;
        return $this;
    }

    /**
     * Set the length.
     *
     * @param integer $length The length.
     * @return DataTablesRequest Returns this DataTables request.
     */
    protected function setLength($length) {
        $this->length = $length;
        return $this;
    }

    /**
     * Set the order.
     *
     * @param DataTablesOrder[] $order The order.
     * @return DataTablesRequest Returns this DataTables request.
     */
    protected function setOrder($order) {
        $this->order = $order;
        return $this;
    }

    /**
     * Set the request.
     *
     * @param ParameterBag $query The query.
     * @return DataTablesRequest Returns this DataTables request.
     */
    protected function setQuery(ParameterBag $query) {
        $this->query = $query;
        return $this;
    }

    /**
     * Set the request.
     *
     * @param ParameterBag $request The request.
     * @return DataTablesRequest Returns this DataTables request.
     */
    protected function setRequest(ParameterBag $request) {
        $this->request = $request;
        return $this;
    }

    /**
     * Set the search.
     *
     * @param DataTablesSearch $search The search.
     * @return DataTablesRequest Returns this DataTables request.
     */
    protected function setSearch(DataTablesSearch $search) {
        $this->search = $search;
        return $this;
    }

    /**
     * Set the start.
     *
     * @param integer $start The start.
     * @return DataTablesRequest Returns this DataTables request.
     */
    protected function setStart($start) {
        $this->start = $start;
        return $this;
    }

    /**
     * Set the wrapper.
     *
     * @param DataTablesWrapper $wrapper The wrapper.
     * @return DataTablesRequest Returns this DataTables request.
     */
    protected function setWrapper(DataTablesWrapper $wrapper) {
        $this->wrapper = $wrapper;
        return $this;
    }

}