SleepingOwl\Admin\Display\Column\NamedColumn

Complexity

Total Complexity

26

Size/Duplication

Total Lines	213
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Test Coverage

Coverage

62.3%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	2
A	getName()	0	4	1
A	setName()	0	6	1
A	setMetaData()	0	6	1
A	getMetaData()	0	6	2
A	setOrderCallback()	0	6	1
A	setSearchCallback()	0	6	1
A	setFilterCallback()	0	6	1
A	getOrderCallback()	0	4	1
A	getSearchCallback()	0	4	1
A	getFilterCallback()	0	4	1
A	getModelValue()	0	4	1
B	setOrderable()	0	10	5
A	toArray()	0	6	1
B	getValueFromObject()	0	21	6

<?php

namespace SleepingOwl\Admin\Display\Column;

use Closure;
use Illuminate\Database\Eloquent\Model;
use SleepingOwl\Admin\Display\TableColumn;
use Illuminate\Database\Eloquent\Collection;
use SleepingOwl\Admin\Contracts\Display\NamedColumnInterface;
use SleepingOwl\Admin\Contracts\Display\OrderByClauseInterface;

abstract class NamedColumn extends TableColumn implements NamedColumnInterface
{
    /**
     * @var \Closure
     */
    protected $searchCallback = null;

    /**
     * @var \Closure
     */
    protected $orderCallback = null;

    /**
     * @var \Closure
     */
    protected $filterCallback = null;

    /**
     * @var null
     */
    protected $columMetaClass = null;

    /**
     * Column field name.
     * @var string
     */
    protected $name;

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

    /**
     * @param Closure|null|string $name
     * @param null|string $label
     */
    public function __construct($name, $label = null)
    {
        parent::__construct($label);
        $this->setName($name);

It seems like $name defined by parameter $name on line 49 can also be of type null or object<Closure>; however, SleepingOwl\Admin\Display\Column\NamedColumn::setName() does only seem to accept string, maybe add an additional type check?

        $this->setHtmlAttribute('class', 'row-'.strtolower(class_basename(get_called_class())));

        if ($this->orderable) {
            $this->setOrderable();

The method SleepingOwl\Admin\Display\Column\NamedColumn::setOrderable() has been deprecated.

        }
    }

    /**
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

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

        return $this;
    }

    /**
     * @param $columnMetaClass
     * @return $this
     */
    public function setMetaData($columnMetaClass)
    {
        $this->columMetaClass = $columnMetaClass;

        return $this;
    }

    /**
     * @return mixed
     */
    public function getMetaData()
    {
        return $this->columMetaClass
            ? app()->make($this->columMetaClass)
            : false;
    }

    /**
     * @param \Closure $callable
     * @return $this
     */
    public function setOrderCallback(\Closure $callable)
    {
        $this->orderCallback = $callable;

        return $this->setOrderable($callable);

$callable is of type object<Closure>, but the function expects a boolean|object<SleepingOwl\Admin\Contracts\Display\OrderByClauseInterface>.

The method SleepingOwl\Admin\Display\Column\NamedColumn::setOrderable() has been deprecated.

    }

    /**
     * @param \Closure $callable
     * @return $this
     */
    public function setSearchCallback(\Closure $callable)
    {
        $this->searchCallback = $callable;

        return $this;
    }

    /**
     * @param \Closure $callable
     * @return $this
     */
    public function setFilterCallback(\Closure $callable)
    {
        $this->filterCallback = $callable;

        return $this;
    }

    /**
     * @return \Closure
     */
    public function getOrderCallback()
    {
        return $this->orderCallback;
    }

    /**
     * @return \Closure
     */
    public function getSearchCallback()
    {
        return $this->searchCallback;
    }

    /**
     * @return \Closure
     */
    public function getFilterCallback()
    {
        return $this->filterCallback;
    }

    /**
     * @return mixed
     */
    public function getModelValue()
    {
        return $this->getValueFromObject($this->getModel(), $this->getName());
    }

    /**
     * @param OrderByClauseInterface|bool $orderable
     * @deprecated
     * @return $this
     */
    public function setOrderable($orderable = true)
    {
        if ($orderable !== false && ! $orderable instanceof OrderByClauseInterface) {
            if (! is_string($orderable) && ! $orderable instanceof Closure) {
                $orderable = $this->getName();
            }
        }

        return parent::setOrderable($orderable);

The method SleepingOwl\Admin\Display\TableColumn::setOrderable() has been deprecated.

    }

    /**
     * Get the instance as an array.
     *
     * @return array
     */
    public function toArray()
    {
        return parent::toArray() + [
                'name' => $this->getName(),
            ];
    }

    /**
     * Get column value from instance.
     *
     * @param Collection|Model|Closure $instance
     * @param string           $name
     *
     * @return mixed
     */
    protected function getValueFromObject($instance, $name)
    {
        if ($name instanceof Closure) {
            return $name($instance);
        }

        $parts = explode('.', $name);
        $part = array_shift($parts);

        if ($instance instanceof Collection) {
            $instance = $instance->pluck($part);
        } elseif (! is_null($instance)) {
            $instance = $instance->getAttribute($part);

The method getAttribute does only exist in Illuminate\Database\Eloquent\Model, but not in Closure.

        }

        if (! empty($parts) && ! is_null($instance)) {
            return $this->getValueFromObject($instance, implode('.', $parts));
        }

        return $instance;
    }
}