hamburgscleanest\DataTables\Models\DataComponent

Complexity

Total Complexity

11

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

58.97%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
	shapeData()	0	1	?
	render()	0	1	?
A	_readFromSession()	0	4	1
A	_storeInSession()	0	4	1
A	_afterInit()	0	4	1
A	getQueryCount()	0	21	1
A	init()	0	11	2
A	remember()	0	6	1
A	forget()	0	10	2
A	transformData()	0	8	2

<?php

namespace hamburgscleanest\DataTables\Models;

use hamburgscleanest\DataTables\Helpers\SessionHelper;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;

/**
 * Class DataComponent
 * @package hamburgscleanest\DataTables\Models
 */
abstract class DataComponent {

    /** @var Builder */
    protected $_queryBuilder;

    /** @var Request */
    protected $_request;

    /** @var bool */
    protected $_rememberState = false;

    /** @var string */
    protected $_rememberKey = 'global';

    /**
     * Everything that needs to be read when the state is remembered.
     * Is called before _afterInit(), so that session values can be overriden.
     */
    protected function _readFromSession()
    {

    }

    /**
     * Use this function to save your state in the session.
     * This is called just before rendering, so all dynamically added stuff etc. is considered.
     */
    protected function _storeInSession()
    {

    }

    /**
     * Initalize fields after the query builder instance and the request is set.
     *
     * TODO: Refactor..
     */
    protected function _afterInit()
    {

    }

    /**
     * You cannot count the data when ordering.
     * Disables ordering temporary.
     *
     * @return int
     */
    public function getQueryCount(): int
    {
        /** @var \Illuminate\Database\Query\Builder $query */
        $query = $this->_queryBuilder->getQuery();

        $oldOrders = $query->orders;
        $oldLimit = $query->limit;
        $oldOffset = $query->offset;

        $query->orders = null;
        $query->limit = null;
        $query->offset = null;

        $dataCount = $query->count();

        $query->orders = $oldOrders;
        $query->limit = $oldLimit;
        $query->offset = $oldOffset;

        return $dataCount;
    }

    /**
     * @param Builder $queryBuilder
     * @param Request $request
     */
    public function init(Builder $queryBuilder, Request $request)

You have injected the Request via parameter $request. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via getCurrentRequest().

    {
        $this->_request = $request;
        $this->_queryBuilder = $queryBuilder;

        if ($this->_rememberState)
        {
            $this->_readFromSession();
        }
        $this->_afterInit();
    }

    /**
     * Remember the state of the data component.
     *
     * @return $this
     */
    public function remember()
    {
        $this->_rememberState = true;

        return $this;
    }

    /**
     * Forget the state of the data component.
     *
     * @return $this
     */
    public function forget()
    {
        $this->_rememberState = false;
        if ($this->_request !== null)
        {
            SessionHelper::removeState($this->_request, $this->_rememberKey);
        }

        return $this;
    }

    public function transformData()
    {
        if ($this->_rememberState)
        {
            $this->_storeInSession();
        }
        $this->shapeData();
    }

    /**
     * @return Builder
     */
    abstract public function shapeData(): Builder;

    /**
     * @return string
     */
    abstract public function render(): string;
}