SleepingOwl\Admin\Display\Extension\Columns

Complexity

Total Complexity

19

Size/Duplication

Total Lines	186
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	1
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	setControlColumn()	0	6	1
A	getControlColumn()	0	4	1
A	isControlActive()	0	4	1
A	enableControls()	0	6	1
A	disableControls()	0	14	2
A	all()	0	4	1
A	set()	0	12	3
A	push()	0	6	1
A	isInitialize()	0	4	1
A	toArray()	0	7	1
A	initialize()	0	12	2
A	render()	0	16	3

<?php

namespace SleepingOwl\Admin\Display\Extension;

use Illuminate\Support\Collection;
use Illuminate\Contracts\Support\Renderable;
use SleepingOwl\Admin\Display\Column\Control;
use SleepingOwl\Admin\Contracts\Initializable;
use SleepingOwl\Admin\Contracts\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;

$controlColumn is of type object<SleepingOwl\Admin\Contracts\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?

        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\ColumnInterface[]
     */
    public function all()
    {
        return $this->columns;
    }

    /**
     * @param $columns
     *
     * @return \SleepingOwl\Admin\Contracts\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(),

It seems like you code against a concrete implementation and not the interface SleepingOwl\Admin\Contracts\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.

        ];
    }

    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();

It seems like you code against a concrete implementation and not the interface SleepingOwl\Admin\Contracts\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.

        $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();
    }
}