WBW\Bundle\JQuery\DatatablesBundle\API\DataTablesResponse

Complexity

Total Complexity

20

Size/Duplication

Total Lines	267
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	addRow()	0	15	2
A	getData()	0	3	1
A	getDraw()	0	3	1
A	getError()	0	3	1
A	getRecordsFiltered()	0	3	1
A	getRecordsTotal()	0	3	1
A	getWrapper()	0	3	1
A	jsonSerialize()	0	3	1
A	parse()	0	10	1
A	setData()	0	4	1
A	setDraw()	0	4	1
A	setError()	0	4	1
A	setRecordsFiltered()	0	4	1
A	setRecordsTotal()	0	4	1
A	setRow()	0	20	2
A	setWrapper()	0	4	1
A	toArray()	0	13	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 JsonSerializable;

/**
 * DataTables response.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Bundle\JQuery\DatatablesBundle\API
 */
class DataTablesResponse implements DataTablesResponseInterface, JsonSerializable {

    /**
     * Data.
     *
     * @var array
     */
    private $data;

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

    /**
     * Error.
     *
     * @var string
     */
    private $error;

    /**
     * Records filtered.
     *
     * @var integer
     */
    private $recordsFiltered;

    /**
     * Records total.
     *
     * @var integer
     */
    private $recordsTotal;

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

    /**
     * Constructor.
     */
    protected function __construct(DataTablesWrapper $wrapper, DataTablesRequest $request) {

The parameter $wrapper is not used and could be removed.

The parameter $request is not used and could be removed.

        $this->setData([]);
        $this->setRecordsFiltered(0);
        $this->setRecordsTotal(0);
    }

    /**
     * Add a row.
     *
     * @return DataTablesResponse Returns the DataTables response.
     */
    public function addRow() {

        // Add a new row.
        $this->data[] = [];

        // Count the rows.
        $index = count($this->data);

        // Set each column name in the new row.
        foreach ($this->wrapper->getColumns() as $column) {
            $this->data[$index - 1][$column->getName()] = null;
        }

        return $this;
    }

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

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

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

    /**
     * Get the records filtered.
     *
     * @return integer The records filtered.
     */
    public function getRecordsFiltered() {
        return $this->recordsFiltered;
    }

    /**
     * Get the records total.
     *
     * @return integer Returns the records total.
     */
    public function getRecordsTotal() {
        return $this->recordsTotal;
    }

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

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize() {
        return $this->toArray();
    }

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

        // Initialize a DataTables response.
        $dtResponse = new DataTablesResponse($wrapper, $request);
        $dtResponse->setDraw($request->getDraw());
        $dtResponse->setWrapper($wrapper);

        // Return the DataTables response.
        return $dtResponse;
    }

    /**
     * Set the data.
     *
     * @param array $data The data.
     * @return DataTablesResponse Returns this DataTables response.
     */
    protected function setData(array $data) {
        $this->data = $data;
        return $this;
    }

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

    /**
     * Set the error.
     *
     * @param string $error The error.
     * @return DataTablesResponse Returns this DataTables response.
     */
    public function setError($error) {
        $this->error = $error;
        return $this;
    }

    /**
     * Set the records filtered.
     *
     * @param integer $recordsFiltered The records filtered.
     * @return DataTablesResponse Returns this DataTables response.
     */
    public function setRecordsFiltered($recordsFiltered) {
        $this->recordsFiltered = $recordsFiltered;
        return $this;
    }

    /**
     * Set the records total.
     *
     * @param integer $recordsTotal The records total.
     * @return DataTablesResponse Returns this DataTables response.
     */
    public function setRecordsTotal($recordsTotal) {
        $this->recordsTotal = $recordsTotal;
        return $this;
    }

    /**
     * Set a row value.
     *
     * @param string $name The column name.
     * @param string $value The column value.
     * @return DataTablesResponse Returns this DataTables response.
     */
    public function setRow($name, $value) {

        // Count the rows.
        $index = count($this->data);

        // Determines the available column names.
        $names = array_merge(array_keys($this->data[$index - 1]), [
            self::DATATABLES_ROW_ATTR,
            self::DATATABLES_ROW_CLASS,
            self::DATATABLES_ROW_DATA,
            self::DATATABLES_ROW_ID,
        ]);

        // Check the column name.
        if (true === in_array($name, $names)) {
            $this->data[$index - 1][$name] = $value;
        }

        return $this;
    }

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

    /**
     * Convert into an array representing this instance.
     *
     * @return array Returns an array representing this instance.
     */
    public function toArray() {

        // Initialize the output.
        $output = [];

        $output["data"]            = $this->data;
        $output["draw"]            = $this->draw;
        $output["recordsFiltered"] = $this->recordsFiltered;
        $output["recordsTotal"]    = $this->recordsTotal;

        // Return the output.
        return $output;
    }

}