Columns::enableControls() - Code Metrics - Inspection of "Merge commit '269d3c1f72ae0b74def636fe5d84e4064e63..." - LaravelRUS/SleepingOwlAdmin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b864c9...ed9166 )

by butschster

created 2017-03-11 07:55 UTC

Columns::enableControls() A

↳ Parent: Columns

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	6
ccs	0
cts	5
cp	0
crap	2
rs	9.4285
c	0
b	0
f	0

<?php

namespace SleepingOwl\Admin\Display\Extension;

use Request;
use Illuminate\Support\Collection;
use Illuminate\Contracts\Support\Renderable;
use SleepingOwl\Admin\Display\Column\Control;
use SleepingOwl\Admin\Contracts\Initializable;
use SleepingOwl\Admin\Contracts\Display\ColumnInterface;

class Columns extends Extension implements Initializable, Renderable
{
    use \SleepingOwl\Admin\Traits\Renderable;

    /**
     * @var ColumnInterface[]|Collection
     */
    protected $columns;

    /**
     * @var bool
     */
    protected $controlActive = true;

    /**
     * @var string
     */
    protected $view = 'display.extensions.columns';

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

    /**
     * @var Control
     */
    protected $controlColumn;

    public function __construct()
    {
        $this->columns = new Collection();

        $this->setControlColumn(app('sleeping_owl.table.column')->control());
    }

    /**
     * @param ColumnInterface $controlColumn
     *
     * @return $this
     */
    public function setControlColumn(ColumnInterface $controlColumn)
    {
        $this->controlColumn = $controlColumn;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}

        return $this;
    }

    /**
     * @return Control
     */
    public function getControlColumn()
    {
        return $this->controlColumn;
    }

    /**
     * @return bool
     */
    public function isControlActive()
    {
        return $this->controlActive;
    }

    /**
     * @return $this
     */
    public function enableControls()
    {
        $this->controlActive = true;

        return $this;
    }

    /**
     * @return $this
     */
    public function disableControls()
    {
        $this->controlActive = false;

        if ($this->isInitialize()) {
            $this->columns = $this->columns->filter(function ($column) {
                $class = get_class($this->getControlColumn());

                return ! ($column instanceof $class);
            });
        }

        return $this;
    }

    /**
     * @return Collection|\SleepingOwl\Admin\Contracts\Display\ColumnInterface[]
     */
    public function all()
    {
        return $this->columns;
    }

    /**
     * @param $columns
     *
     * @return \SleepingOwl\Admin\Contracts\Display\DisplayInterface
     */
    public function set($columns)
    {
        if (! is_array($columns)) {
            $columns = func_get_args();
        }

        foreach ($columns as $column) {
            $this->push($column);
        }

        return $this->getDisplay();
    }

    /**
     * @param ColumnInterface $column
     *
     * @return $this
     */
    public function push(ColumnInterface $column)
    {
        $this->columns->push($column);

        return $this;
    }

    /**
     * @return bool
     */
    public function isInitialize()
    {
        return $this->initialize;
    }

    /**
     * Get the instance as an array.
     *
     * @return array
     */
    public function toArray()
    {
        return [
            'columns' => $this->all(),
            'attributes' => $this->getDisplay()->htmlAttributesToString(),
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        ];
    }

    public function initialize()
    {
        $this->all()->each(function (ColumnInterface $column) {
            $column->initialize();
        });

        if ($this->isControlActive()) {
            $this->push($this->getControlColumn());
        }

        $this->initialize = true;
    }

    /**
     * Get the evaluated contents of the object.
     *
     * @return string
     */
    public function render()
    {
        $params = $this->toArray();
        $params['collection'] = $this->getDisplay()->getCollection();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $params['pagination'] = null;

        if ($params['collection'] instanceof \Illuminate\Contracts\Pagination\Paginator) {
            if (class_exists('Illuminate\Pagination\BootstrapThreePresenter')) {
                $params['pagination'] = (new \Illuminate\Pagination\BootstrapThreePresenter($params['collection']))->render();
            } else {
                $params['pagination'] = $params['collection']->render();
            }
        }

        return app('sleeping_owl.template')->view($this->getView(), $params)->render();
    }

    /**
     * @param \Illuminate\Database\Eloquent\Builder $query
     */
    public function modifyQuery(\Illuminate\Database\Eloquent\Builder $query)
    {
        $orders = Request::input('order', []);

        $columns = $this->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);
            }
        }
    }
}


GitHub Access Token became invalid

Push — master ( b864c9...ed9166 )

Columns::enableControls() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

1			<?php
2
3			namespace SleepingOwl\Admin\Display\Extension;
4
5			use Request;
6			use Illuminate\Support\Collection;
7			use Illuminate\Contracts\Support\Renderable;
8			use SleepingOwl\Admin\Display\Column\Control;
9			use SleepingOwl\Admin\Contracts\Initializable;
10			use SleepingOwl\Admin\Contracts\Display\ColumnInterface;
11
12			class Columns extends Extension implements Initializable, Renderable
13			{
14			use \SleepingOwl\Admin\Traits\Renderable;
15
16			/**
17			* @var ColumnInterface[]\|Collection
18			*/
19			protected $columns;
20
21			/**
22			* @var bool
23			*/
24			protected $controlActive = true;
25
26			/**
27			* @var string
28			*/
29			protected $view = 'display.extensions.columns';
30
31			/**
32			* @var bool
33			*/
34			protected $initialize = false;
35
36			/**
37			* @var Control
38			*/
39			protected $controlColumn;
40
41			public function __construct()
42			{
43			$this->columns = new Collection();
44
45			$this->setControlColumn(app('sleeping_owl.table.column')->control());
46			}
47
48			/**
49			* @param ColumnInterface $controlColumn
50			*
51			* @return $this
52			*/
53			public function setControlColumn(ColumnInterface $controlColumn)
54			{
55			$this->controlColumn = $controlColumn;
			0 ignored issues – show Documentation Bug introduced 2017-02-11 08:58 UTC by Report Bug Copy Issue Report `$controlColumn` is of type `object<SleepingOwl\Admin...isplay\ColumnInterface>`, but the property `$controlColumn` was declared to be of type `object<SleepingOwl\Admin\Display\Column\Control>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` 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 given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
56
57			return $this;
58			}
59
60			/**
61			* @return Control
62			*/
63			public function getControlColumn()
64			{
65			return $this->controlColumn;
66			}
67
68			/**
69			* @return bool
70			*/
71			public function isControlActive()
72			{
73			return $this->controlActive;
74			}
75
76			/**
77			* @return $this
78			*/
79			public function enableControls()
80			{
81			$this->controlActive = true;
82
83			return $this;
84			}
85
86			/**
87			* @return $this
88			*/
89			public function disableControls()
90			{
91			$this->controlActive = false;
92
93			if ($this->isInitialize()) {
94			$this->columns = $this->columns->filter(function ($column) {
95			$class = get_class($this->getControlColumn());
96
97			return ! ($column instanceof $class);
98			});
99			}
100
101			return $this;
102			}
103
104			/**
105			* @return Collection\|\SleepingOwl\Admin\Contracts\Display\ColumnInterface[]
106			*/
107			public function all()
108			{
109			return $this->columns;
110			}
111
112			/**
113			* @param $columns
114			*
115			* @return \SleepingOwl\Admin\Contracts\Display\DisplayInterface
116			*/
117			public function set($columns)
118			{
119			if (! is_array($columns)) {
120			$columns = func_get_args();
121			}
122
123			foreach ($columns as $column) {
124			$this->push($column);
125			}
126
127			return $this->getDisplay();
128			}
129
130			/**
131			* @param ColumnInterface $column
132			*
133			* @return $this
134			*/
135			public function push(ColumnInterface $column)
136			{
137			$this->columns->push($column);
138
139			return $this;
140			}
141
142			/**
143			* @return bool
144			*/
145			public function isInitialize()
146			{
147			return $this->initialize;
148			}
149
150			/**
151			* Get the instance as an array.
152			*
153			* @return array
154			*/
155			public function toArray()
156			{
157			return [
158			'columns' => $this->all(),
159			'attributes' => $this->getDisplay()->htmlAttributesToString(),
			0 ignored issues – show Bug introduced 2017-02-11 08:58 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `SleepingOwl\Admin\Contra...isplay\DisplayInterface` as the method `htmlAttributesToString()` does only exist in the following implementations of said interface: `SleepingOwl\Admin\Display\Display`, `SleepingOwl\Admin\Display\DisplayDatatables`, `SleepingOwl\Admin\Display\DisplayDatatablesAsync`, `SleepingOwl\Admin\Display\DisplayTable`, `SleepingOwl\Admin\Display\DisplayTree`, `SleepingOwl\Admin\Form\FormDefault`, `SleepingOwl\Admin\Form\FormPanel`, `SleepingOwl\Admin\Form\FormTabbed`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
160			];
161			}
162
163			public function initialize()
164			{
165			$this->all()->each(function (ColumnInterface $column) {
166			$column->initialize();
167			});
168
169			if ($this->isControlActive()) {
170			$this->push($this->getControlColumn());
171			}
172
173			$this->initialize = true;
174			}
175
176			/**
177			* Get the evaluated contents of the object.
178			*
179			* @return string
180			*/
181			public function render()
182			{
183			$params = $this->toArray();
184			$params['collection'] = $this->getDisplay()->getCollection();
			0 ignored issues – show Bug introduced 2017-02-11 08:58 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `SleepingOwl\Admin\Contra...isplay\DisplayInterface` as the method `getCollection()` does only exist in the following implementations of said interface: `SleepingOwl\Admin\Display\DisplayDatatables`, `SleepingOwl\Admin\Display\DisplayDatatablesAsync`, `SleepingOwl\Admin\Display\DisplayTable`, `SleepingOwl\Admin\Display\DisplayTree`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
185			$params['pagination'] = null;
186
187			if ($params['collection'] instanceof \Illuminate\Contracts\Pagination\Paginator) {
188			if (class_exists('Illuminate\Pagination\BootstrapThreePresenter')) {
189			$params['pagination'] = (new \Illuminate\Pagination\BootstrapThreePresenter($params['collection']))->render();
190			} else {
191			$params['pagination'] = $params['collection']->render();
192			}
193			}
194
195			return app('sleeping_owl.template')->view($this->getView(), $params)->render();
196			}
197
198			/**
199			* @param \Illuminate\Database\Eloquent\Builder $query
200			*/
201			public function modifyQuery(\Illuminate\Database\Eloquent\Builder $query)
202			{
203			$orders = Request::input('order', []);
204
205			$columns = $this->all();
206
207			if (! is_int(key($orders))) {
208			$orders = [$orders];
209			}
210
211			foreach ($orders as $order) {
212			$columnIndex = array_get($order, 'column');
213			$direction = array_get($order, 'dir', 'asc');
214
215			if (! $columnIndex && $columnIndex !== '0') {
216			continue;
217			}
218
219			$column = $columns->get($columnIndex);
220
221			if ($column instanceof ColumnInterface && $column->isOrderable()) {
222			$column->orderBy($query, $direction);
223			}
224			}
225			}
226			}
227

LaravelRUS / SleepingOwlAdmin

GitHub Access Token became invalid

Push — master ( b864c9...ed9166 )

Columns::enableControls() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like