SleepingOwl\Admin\Display\DisplayTable

Complexity

Total Complexity

25

Size/Duplication

Total Lines	239
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	getParameters()	0	4	1
A	setParameters()	0	6	1
A	setParameter()	0	6	1
A	paginate()	0	7	1
A	disablePagination()	0	6	1
A	usePagination()	0	4	1
A	setNewEntryButtonText()	0	6	1
A	toArray()	0	22	1
A	__construct()	0	7	1
A	initialize()	0	12	2
A	getNewEntryButtonText()	0	8	2
A	getCollection()	0	19	4
C	applyOrders()	0	25	7
A	modifyQuery()	0	6	1

<?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) {

The call to setApply() misses a required argument $...$applies.

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

It seems like trans('sleeping_owl::lang.table.new-entry') can also be of type object<Symfony\Component\Translation\TranslatorInterface>. However, the property $newEntryButtonText is declared as type string|null. Maybe add an additional type check?

        }

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

It seems like $this->usePagination() ? $query->paginate($this->paginate, array('*'), $this->pageName)->appends(request()->except($this->pageName)) : $query->get() can also be of type array<integer,object<Illuminate\Database\Eloquent\Builder>> or object<Illuminate\Contracts\Pagination\LengthAwarePaginator>. However, the property $collection is declared as type object<Illuminate\Support\Collection>. Maybe add an additional type check?

The return type of return $this->collection = $this->usePagination() ? $query->paginate($this->paginate, array('*'), $this->pageName)->appends(request()->except($this->pageName)) : $query->get(); (Illuminate\Database\Eloquent\Collection|Illuminate\Database\Eloquent\Builder[]|Illuminate\Contracts\Pagination\LengthAwarePaginator) is incompatible with the return type documented by SleepingOwl\Admin\Display\DisplayTable::getCollection of type Illuminate\Support\Collection.

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