DisplayTable::applyOrders() - Code Metrics - Inspection of "Merge branch 'development'" - LaravelRUS/SleepingOwlAdmin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 414922...a9bc98 )

by butschster

created 2016-12-21 10:07 UTC

DisplayTable::applyOrders() C

↳ Parent: DisplayTable

Complexity

Conditions	7
Paths	8

Size

Total Lines	25
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	7
eloc	13
nc	8
nop	1
dl	0
loc	25
rs	6.7272
c	0
b	0
f	0

<?php

namespace SleepingOwl\Admin\Display;

use Request;
use Illuminate\Support\Collection;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Support\Renderable;
use SleepingOwl\Admin\Contracts\ColumnInterface;
use SleepingOwl\Admin\Display\Extension\Columns;
use SleepingOwl\Admin\Contracts\ColumnFilterInterface;
use SleepingOwl\Admin\Display\Extension\ColumnFilters;
use SleepingOwl\Admin\Contracts\Display\DisplayExtensionInterface;

/**
 * Class DisplayTable.

 * @method Columns getColumns()
 * @method $this setColumns(ColumnInterface|ColumnInterface[] $column)
 *
 * @method ColumnFilters getColumnFilters()
 * @method $this setColumnFilters(ColumnFilterInterface $filters = null, ...$filters)
 */
class DisplayTable extends Display
{
    /**
     * @var string
     */
    protected $view = 'display.table';

    /**
     * @var array
     */
    protected $parameters = [];

    /**
     * @var int|null
     */
    protected $paginate = 25;

    /**
     * @var string
     */
    protected $pageName = 'page';

    /**
     * @var Collection
     */
    protected $collection;

    /**
     * @var string|null
     */
    protected $newEntryButtonText;

    /**
     * Display constructor.
     */
    public function __construct()
    {
        parent::__construct();

        $this->extend('columns', new Columns());
        $this->extend('column_filters', new ColumnFilters());
    }

    /**
     * Initialize display.
     */
    public function initialize()
    {
        parent::initialize();

        if ($this->getModelConfiguration()->isRestorableModel()) {
            $this->setApply(function ($q) {

                return $q->withTrashed();
            });
        }

        $this->setHtmlAttribute('class', 'table table-striped');
    }

    /**
     * @return null|string
     */
    public function getNewEntryButtonText()
    {
        if (is_null($this->newEntryButtonText)) {
            $this->newEntryButtonText = trans('sleeping_owl::lang.table.new-entry');
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        }

        return $this->newEntryButtonText;
    }

    /**
     * @param string $newEntryButtonText
     *
     * @return $this
     */
    public function setNewEntryButtonText($newEntryButtonText)
    {
        $this->newEntryButtonText = $newEntryButtonText;

        return $this;
    }

    /**
     * @return array
     */
    public function getParameters()
    {
        return $this->parameters;
    }

    /**
     * @param array $parameters
     *
     * @return $this
     */
    public function setParameters($parameters)
    {
        $this->parameters = $parameters;

        return $this;
    }

    /**
     * @param string $key
     * @param mixed  $value
     *
     * @return $this
     */
    public function setParameter($key, $value)
    {
        $this->parameters[$key] = $value;

        return $this;
    }

    /**
     * @param int    $perPage
     * @param string $pageName
     *
     * @return $this
     */
    public function paginate($perPage = 25, $pageName = 'page')
    {
        $this->paginate = (int) $perPage;
        $this->pageName = $pageName;

        return $this;
    }

    /**
     * @return $this
     */
    public function disablePagination()
    {
        $this->paginate = 0;

        return $this;
    }

    /**
     * @return bool
     */
    public function usePagination()
    {
        return $this->paginate > 0;
    }

    /**
     * @return array
     */
    public function toArray()
    {
        $model = $this->getModelConfiguration();

        $params = parent::toArray();

        $params['creatable'] = $model->isCreatable();
        $params['createUrl'] = $model->getCreateUrl($this->getParameters() + Request::all());
        $params['collection'] = $this->getCollection();

        $params['extensions'] = $this->getExtensions()
            ->filter(function (DisplayExtensionInterface $ext) {
                return $ext instanceof Renderable;
            })
            ->sortBy(function (DisplayExtensionInterface $extension) {
                return $extension->getOrder();
            });

        $params['newEntryButtonText'] = $this->getNewEntryButtonText();

        return $params;
    }

    /**
     * @return Collection
     * @throws \Exception
     */
    public function getCollection()
    {
        if (! $this->isInitialized()) {
            throw new \Exception('Display is not initialized');
        }

        if (! is_null($this->collection)) {
            return $this->collection;
        }

        $query = $this->getRepository()->getQuery();

        $this->modifyQuery($query);
        $this->applyOrders($query);

        return $this->collection = $this->usePagination()
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
            ? $query->paginate($this->paginate, ['*'], $this->pageName)->appends(request()->except($this->pageName))
            : $query->get();
    }

    /**
     * Apply orders to the query.
     *
     * @param $query
     */
    protected function applyOrders(Builder $query)
    {
        $orders = Request::input('order', []);

        $columns = $this->getColumns()->all();

        if (! is_int(key($orders))) {
            $orders = [$orders];
        }

        foreach ($orders as $order) {
            $columnIndex = array_get($order, 'column');
            $direction = array_get($order, 'dir', 'asc');

            if (! $columnIndex && $columnIndex !== '0') {
                continue;
            }

            $column = $columns->get($columnIndex);

            if ($column instanceof ColumnInterface && $column->isOrderable()) {
                $column->orderBy($query, $direction);
            }
        }
    }

    /**
     * @param \Illuminate\Database\Eloquent\Builder|Builder $query
     */
    protected function modifyQuery(\Illuminate\Database\Eloquent\Builder $query)
    {
        $this->extensions->each(function (DisplayExtensionInterface $extension) use ($query) {
            $extension->modifyQuery($query);
        });
    }
}


1			<?php
2
3			namespace SleepingOwl\Admin\Display;
4
5			use Request;
6			use Illuminate\Support\Collection;
7			use Illuminate\Database\Eloquent\Builder;
8			use Illuminate\Contracts\Support\Renderable;
9			use SleepingOwl\Admin\Contracts\ColumnInterface;
10			use SleepingOwl\Admin\Display\Extension\Columns;
11			use SleepingOwl\Admin\Contracts\ColumnFilterInterface;
12			use SleepingOwl\Admin\Display\Extension\ColumnFilters;
13			use SleepingOwl\Admin\Contracts\Display\DisplayExtensionInterface;
14
15			/**
16			* Class DisplayTable.
17
18			* @method Columns getColumns()
19			* @method $this setColumns(ColumnInterface\|ColumnInterface[] $column)
20			*
21			* @method ColumnFilters getColumnFilters()
22			* @method $this setColumnFilters(ColumnFilterInterface $filters = null, ...$filters)
23			*/
24			class DisplayTable extends Display
25			{
26			/**
27			* @var string
28			*/
29			protected $view = 'display.table';
30
31			/**
32			* @var array
33			*/
34			protected $parameters = [];
35
36			/**
37			* @var int\|null
38			*/
39			protected $paginate = 25;
40
41			/**
42			* @var string
43			*/
44			protected $pageName = 'page';
45
46			/**
47			* @var Collection
48			*/
49			protected $collection;
50
51			/**
52			* @var string\|null
53			*/
54			protected $newEntryButtonText;
55
56			/**
57			* Display constructor.
58			*/
59			public function __construct()
60			{
61			parent::__construct();
62
63			$this->extend('columns', new Columns());
64			$this->extend('column_filters', new ColumnFilters());
65			}
66
67			/**
68			* Initialize display.
69			*/
70			public function initialize()
71			{
72			parent::initialize();
73
74			if ($this->getModelConfiguration()->isRestorableModel()) {
75			$this->setApply(function ($q) {
			0 ignored issues – show Bug introduced 2016-07-15 12:17 UTC by Report Bug Copy Issue Report The call to `setApply()` misses a required argument `$...$applies`. This check looks for function calls that miss required arguments. Loading history...
76			return $q->withTrashed();
77			});
78			}
79
80			$this->setHtmlAttribute('class', 'table table-striped');
81			}
82
83			/**
84			* @return null\|string
85			*/
86			public function getNewEntryButtonText()
87			{
88			if (is_null($this->newEntryButtonText)) {
89			$this->newEntryButtonText = trans('sleeping_owl::lang.table.new-entry');
			0 ignored issues – show Documentation Bug introduced 2016-08-16 07:35 UTC by Report Bug Copy Issue Report It seems like `trans('sleeping_owl::lang.table.new-entry')` can also be of type `object<Symfony\Component...on\TranslatorInterface>`. However, the property `$newEntryButtonText` is declared as type `string\|null`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
90			}
91
92			return $this->newEntryButtonText;
93			}
94
95			/**
96			* @param string $newEntryButtonText
97			*
98			* @return $this
99			*/
100			public function setNewEntryButtonText($newEntryButtonText)
101			{
102			$this->newEntryButtonText = $newEntryButtonText;
103
104			return $this;
105			}
106
107			/**
108			* @return array
109			*/
110			public function getParameters()
111			{
112			return $this->parameters;
113			}
114
115			/**
116			* @param array $parameters
117			*
118			* @return $this
119			*/
120			public function setParameters($parameters)
121			{
122			$this->parameters = $parameters;
123
124			return $this;
125			}
126
127			/**
128			* @param string $key
129			* @param mixed $value
130			*
131			* @return $this
132			*/
133			public function setParameter($key, $value)
134			{
135			$this->parameters[$key] = $value;
136
137			return $this;
138			}
139
140			/**
141			* @param int $perPage
142			* @param string $pageName
143			*
144			* @return $this
145			*/
146			public function paginate($perPage = 25, $pageName = 'page')
147			{
148			$this->paginate = (int) $perPage;
149			$this->pageName = $pageName;
150
151			return $this;
152			}
153
154			/**
155			* @return $this
156			*/
157			public function disablePagination()
158			{
159			$this->paginate = 0;
160
161			return $this;
162			}
163
164			/**
165			* @return bool
166			*/
167			public function usePagination()
168			{
169			return $this->paginate > 0;
170			}
171
172			/**
173			* @return array
174			*/
175			public function toArray()
176			{
177			$model = $this->getModelConfiguration();
178
179			$params = parent::toArray();
180
181			$params['creatable'] = $model->isCreatable();
182			$params['createUrl'] = $model->getCreateUrl($this->getParameters() + Request::all());
183			$params['collection'] = $this->getCollection();
184
185			$params['extensions'] = $this->getExtensions()
186			->filter(function (DisplayExtensionInterface $ext) {
187			return $ext instanceof Renderable;
188			})
189			->sortBy(function (DisplayExtensionInterface $extension) {
190			return $extension->getOrder();
191			});
192
193			$params['newEntryButtonText'] = $this->getNewEntryButtonText();
194
195			return $params;
196			}
197
198			/**
199			* @return Collection
200			* @throws \Exception
201			*/
202			public function getCollection()
203			{
204			if (! $this->isInitialized()) {
205			throw new \Exception('Display is not initialized');
206			}
207
208			if (! is_null($this->collection)) {
209			return $this->collection;
210			}
211
212			$query = $this->getRepository()->getQuery();
213
214			$this->modifyQuery($query);
215			$this->applyOrders($query);
216
217			return $this->collection = $this->usePagination()
			0 ignored issues – show Documentation Bug introduced 2016-12-21 10:19 UTC by Report Bug Copy Issue Report It seems like `$this->usePagination() ?...eName)) : $query->get()` can also be of type `array<integer,object<Ill...base\Eloquent\Builder>>` or `object<Illuminate\Contra...n\LengthAwarePaginator>`. However, the property `$collection` is declared as type `object<Illuminate\Support\Collection>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id / public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history... Bug Best Practice introduced 2016-12-21 10:19 UTC by Report Bug Copy Issue Report The return type of `return $this->collection...Name)) : $query->get();` (`Illuminate\Database\Eloq...on\LengthAwarePaginator`) is incompatible with the return type documented by `SleepingOwl\Admin\Displa...layTable::getCollection` of type `Illuminate\Support\Collection`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { / ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
218			? $query->paginate($this->paginate, ['*'], $this->pageName)->appends(request()->except($this->pageName))
219			: $query->get();
220			}
221
222			/**
223			* Apply orders to the query.
224			*
225			* @param $query
226			*/
227			protected function applyOrders(Builder $query)
228			{
229			$orders = Request::input('order', []);
230
231			$columns = $this->getColumns()->all();
232
233			if (! is_int(key($orders))) {
234			$orders = [$orders];
235			}
236
237			foreach ($orders as $order) {
238			$columnIndex = array_get($order, 'column');
239			$direction = array_get($order, 'dir', 'asc');
240
241			if (! $columnIndex && $columnIndex !== '0') {
242			continue;
243			}
244
245			$column = $columns->get($columnIndex);
246
247			if ($column instanceof ColumnInterface && $column->isOrderable()) {
248			$column->orderBy($query, $direction);
249			}
250			}
251			}
252
253			/**
254			* @param \Illuminate\Database\Eloquent\Builder\|Builder $query
255			*/
256			protected function modifyQuery(\Illuminate\Database\Eloquent\Builder $query)
257			{
258			$this->extensions->each(function (DisplayExtensionInterface $extension) use ($query) {
259			$extension->modifyQuery($query);
260			});
261			}
262			}
263

LaravelRUS / SleepingOwlAdmin

GitHub Access Token became invalid

Push — master ( 414922...a9bc98 )

DisplayTable::applyOrders() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like