DataComponent::_storeInSession() - Code Metrics - Inspection of "Travis setup: PHPUnit" - hamburgscleanest/data-tables - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (a2d832)

by Timo

created 2017-04-09 19:20 UTC

DataComponent::_storeInSession() A

↳ Parent: DataComponent

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	1
nc	1
nop	0
crap	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)

    {
        $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;
}

1		<?php
2
3		namespace hamburgscleanest\DataTables\Models;
4
5		use hamburgscleanest\DataTables\Helpers\SessionHelper;
6		use Illuminate\Database\Eloquent\Builder;
7		use Illuminate\Http\Request;
8
9		/**
10		* Class DataComponent
11		* @package hamburgscleanest\DataTables\Models
12		*/
13		abstract class DataComponent {
14
15		/** @var Builder */
16		protected $_queryBuilder;
17
18		/** @var Request */
19		protected $_request;
20
21		/** @var bool */
22		protected $_rememberState = false;
23
24		/** @var string */
25		protected $_rememberKey = 'global';
26
27		/**
28		* Everything that needs to be read when the state is remembered.
29		* Is called before _afterInit(), so that session values can be overriden.
30		*/
31		protected function _readFromSession()
32		{
33
34		}
35
36		/**
37		* Use this function to save your state in the session.
38		* This is called just before rendering, so all dynamically added stuff etc. is considered.
39		*/
40		protected function _storeInSession()
41		{
42
43		}
44
45		/**
46		* Initalize fields after the query builder instance and the request is set.
47		*
48		* TODO: Refactor..
49		*/
50		protected function _afterInit()
51		{
52
53		}
54
55		/**
56		* You cannot count the data when ordering.
57		* Disables ordering temporary.
58		*
59		* @return int
60		*/
61	2	public function getQueryCount(): int
62		{
63		/** @var \Illuminate\Database\Query\Builder $query */
64	2	$query = $this->_queryBuilder->getQuery();
65
66	2	$oldOrders = $query->orders;
67	2	$oldLimit = $query->limit;
68	2	$oldOffset = $query->offset;
69
70	2	$query->orders = null;
71	2	$query->limit = null;
72	2	$query->offset = null;
73
74	2	$dataCount = $query->count();
75
76	2	$query->orders = $oldOrders;
77	2	$query->limit = $oldLimit;
78	2	$query->offset = $oldOffset;
79
80	2	return $dataCount;
81		}
82
83		/**
84		* @param Builder $queryBuilder
85		* @param Request $request
86		*/
87	4	public function init(Builder $queryBuilder, Request $request)
		1 ignored issue – show Bug introduced 2017-04-09 14:44 UTC by Report Bug Copy Issue Report 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()`. Loading history...
88		{
89	4	$this->_request = $request;
90	4	$this->_queryBuilder = $queryBuilder;
91
92	4	if ($this->_rememberState)
93		{
94		$this->_readFromSession();
95		}
96	4	$this->_afterInit();
97	4	}
98
99		/**
100		* Remember the state of the data component.
101		*
102		* @return $this
103		*/
104		public function remember()
105		{
106		$this->_rememberState = true;
107
108		return $this;
109		}
110
111		/**
112		* Forget the state of the data component.
113		*
114		* @return $this
115		*/
116		public function forget()
117		{
118		$this->_rememberState = false;
119		if ($this->_request !== null)
120		{
121		SessionHelper::removeState($this->_request, $this->_rememberKey);
122		}
123
124		return $this;
125		}
126
127	3	public function transformData()
128		{
129	3	if ($this->_rememberState)
130		{
131		$this->_storeInSession();
132		}
133	3	$this->shapeData();
134	3	}
135
136		/**
137		* @return Builder
138		*/
139		abstract public function shapeData(): Builder;
140
141		/**
142		* @return string
143		*/
144		abstract public function render(): string;
145		}

hamburgscleanest / data-tables

Branch — master (a2d832)

DataComponent::_storeInSession() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like