Terranet\Administrator\Field\Generic

Complexity

Total Complexity

45

Size/Duplication

Total Lines	425
Duplicated Lines	0 %

Importance

Changes

0

28 Methods

Rating	Name	Duplication	Size	Complexity
A	getDescription()	0	3	1
A	sortable()	0	8	1
A	descriptionKey()	0	9	2
A	id()	0	3	1
A	setDescription()	0	5	1
A	hideLabel()	0	5	1
A	setPagesVisibility()	0	9	2
A	name()	0	16	2
A	getModel()	0	3	1
A	disableSorting()	0	5	1
A	setId()	0	5	1
A	value()	0	7	2
A	render()	0	25	5
A	setTitle()	0	5	1
A	setAttribute()	0	14	4
A	translationKey()	0	9	2
A	setModel()	0	5	1
A	__construct()	0	18	5
A	template()	0	6	1
A	isVisibleOnPage()	0	3	1
A	isHiddenLabel()	0	3	1
A	showOnPages()	0	3	1
A	title()	0	3	1
A	makeFrom()	0	3	1
A	setValue()	0	5	1
A	make()	0	9	2
A	hideOnPages()	0	3	1
A	switchTo()	0	3	1

<?php

namespace Terranet\Administrator\Field;

use Coduo\PHPHumanizer\StringHumanizer;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\View;
use Terranet\Administrator\Contracts\Sortable;
use Terranet\Administrator\Field\Traits\AcceptsCustomFormat;
use Terranet\Administrator\Field\Traits\AppliesSorting;
use Terranet\Administrator\Scaffolding;
use Terranet\Administrator\Contracts\AutoTranslatable;
use Terranet\Administrator\Traits\AutoTranslatesInstances;

abstract class Generic implements Sortable, AutoTranslatable
{
    use AcceptsCustomFormat, AppliesSorting, AutoTranslatesInstances;

    /** @var string */
    protected $id;

    /** @var string */
    protected $title;

    /** @var string */
    protected $description;

    /** @var Model */
    protected $model;

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

    /** @var array */
    protected $visibility = [
        Scaffolding::PAGE_INDEX => true,
        Scaffolding::PAGE_EDIT => true,
        Scaffolding::PAGE_VIEW => true,
    ];

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

    /**
     * Generic constructor.
     *
     * @param string $title
     * @param null|string $id
     */
    private function __construct(string $title, string $id = null)
    {
        $this->setId(
            snake_case($id ?: $title)
        );

        if ($this->translator()->has($key = $this->translationKey())) {
            $this->setTitle($this->translator()->trans($key));

It seems like $this->translator()->trans($key) can also be of type null and array; however, parameter $title of Terranet\Administrator\Field\Generic::setTitle() does only seem to accept string, maybe add an additional type check?

        } else {
            $this->setTitle(
                'id' === $this->id
                    ? 'ID'
                    : StringHumanizer::humanize(str_replace(['_id', '-', '_'], ['', ' ', ' '], $this->id))
            );
        }

        if ($this->translator()->has($key = $this->descriptionKey())) {
            $this->setDescription($this->translator()->trans($key));

It seems like $this->translator()->trans($key) can also be of type null and array; however, parameter $description of Terranet\Administrator\Field\Generic::setDescription() does only seem to accept string, maybe add an additional type check?

        }
    }

    /**
     * @param $title
     * @param null $id

Are you sure the doc-type for parameter $id is correct as it would always require null to be passed?

     * @param \Closure $callback
     *
     * @return static
     */
    public static function make($title, $id = null, \Closure $callback = null): self
    {
        $instance = new static($title, $id);

        if (null !== $callback) {
            $callback->call($instance, $instance);
        }

        return $instance;
    }

    /**
     * Create new element from another.
     *
     * @param Generic $element
     * @return Generic
     */
    public static function makeFrom(Generic $element)
    {
        return static::make($element->title(), $element->id());
    }

    /**
     * Switch to a new element type.
     *
     * @param string $className
     * @return mixed
     */
    public function switchTo(string $className)
    {
        return forward_static_call_array([$className, "make"], [$this->title(), $this->id()]);
    }

    /**
     * @param Model $model
     *
     * @return self
     */
    public function setModel(Model $model): self
    {
        $this->model = $model;

        return $this;
    }

    /**
     * @return Model
     */
    public function getModel()
    {
        return $this->model;
    }

    /**
     * Render Element.
     *
     * @param string $page
     *
     * @return mixed
     */
    final public function render(string $page = 'index')
    {
        if ($this->format) {
            // Each Field can define its own data for custom formatter.
            $withData = method_exists($this, 'renderWith')
                ? $this->renderWith()
                : [$this->value(), $this->model];

            return $this->callFormatter($withData);
        }

        $data = [
            'field' => $this,
            'model' => $this->model,
        ];

        if (method_exists($this, $dataGetter = 'on'.title_case($page))) {
            $data += call_user_func([$this, $dataGetter]);
        }

        if (View::exists($view = $this->template($page))) {
            return View::make($view, $data);
        }

        return View::make($this->template($page, 'Key'), $data);
    }

    /**
     * Return Element ID.
     *
     * @return string
     */
    public function id(): string
    {
        return $this->id;
    }

    /**
     * Form name.
     *
     * @return string
     */
    public function name()
    {
        $parts = explode('.', $this->id());

        if (count($parts) > 1) {
            $first = array_first($parts);
            $other = array_slice($parts, 1);

            $other = array_map(function ($part) {
                return "[$part]";
            }, $other);

            return implode('', array_merge([$first], $other));
        }

        return $this->id();
    }

    /**
     * @param string $id
     *
     * @return self
     */
    public function setId(string $id): self
    {
        $this->id = $id;

        return $this;
    }

    /**
     * Return Element title.
     *
     * @return string
     */
    public function title(): string
    {
        return $this->title;
    }

    /**
     * @return string
     */
    public function getDescription(): ?string
    {
        return $this->description;
    }

    /**
     * @param string $title
     *
     * @return self
     */
    public function setTitle(string $title): self
    {
        $this->title = $title;

        return $this;
    }

    /**
     * @param string $description
     *
     * @return self
     */
    public function setDescription(string $description): self
    {
        $this->description = $description;

        return $this;
    }

    /**
     * @param bool $showLabel
     *
     * @return self
     */
    public function hideLabel(bool $hideLabel): self
    {
        $this->showLabel = !$hideLabel;

        return $this;
    }

    /**
     * @return bool
     */
    public function isHiddenLabel(): bool
    {
        return !$this->showLabel;
    }

    /**
     * string $page.
     *
     * @return bool
     */
    public function isVisibleOnPage(string $page): bool
    {
        return (bool) $this->visibility[$page] ?? false;
    }

    /**
     * @param array|string $pages
     *
     * @return self
     */
    public function hideOnPages($pages): self
    {
        return $this->setPagesVisibility((array) $pages, false);
    }

    /**
     * @param array|string $pages
     *
     * @return self
     */
    public function showOnPages($pages): self
    {
        return $this->setPagesVisibility((array) $pages, true);
    }

    /**
     * Make column sortable.
     *
     * @param null|\Closure $callback
     *
     * @return self
     */
    public function sortable(\Closure $callback = null): self
    {
        app('scaffold.module')->addSortable(

The method addSortable() does not exist on Illuminate\Foundation\Application.

            $this->id(),
            $callback
        );

        return $this;
    }

    /**
     * Remove column from Sortable collection.
     *
     * @return self
     */
    public function disableSorting(): self
    {
        app('scaffold.module')->removeSortable($this->id());

The method removeSortable() does not exist on Illuminate\Foundation\Application.

        return $this;
    }

    /**
     * Set value.
     *
     * @param $value
     *
     * @return Generic
     */
    public function setValue($value): self
    {
        $this->value = $value;

The property value does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $this;
    }

    /**
     * Extract Element value.
     *
     * @return mixed
     */
    public function value()
    {
        if (!$this->model) {
            return null;
        }

        return $this->model->getAttribute($this->id);
    }

    /**
     * @param $key
     * @param null $value

Are you sure the doc-type for parameter $value is correct as it would always require null to be passed?

     * @param mixed $attribute
     *
     * @return self
     */
    public function setAttribute($attribute, $value = null): self
    {
        if (is_array($attribute)) {
            foreach ($attribute as $key => $value) {
                $this->setAttribute($key, $value);
            }
        } else {
            if (!array_key_exists($key, $this->attributes)) {

The variable $key seems to be never defined.

                throw new Exception("Unknown attribute {$key}");

The type Terranet\Administrator\Field\Exception was not found. Did you mean Exception? If so, make sure to prefix the type with \.

            }
            $this->attributes[$key] = $value;
        }

        return $this;
    }

    /**
     * @param mixed $pages
     * @param bool $visibility
     *
     * @return $this
     */
    protected function setPagesVisibility($pages, bool $visibility): self
    {
        $pages = array_intersect($pages, array_keys($this->visibility));

        foreach ($pages as $page) {
            $this->visibility[$page] = $visibility;
        }

        return $this;
    }

    /**
     * @param string $page
     * @param string $field
     *
     * @return string
     */
    protected function template(string $page, string $field = null): string
    {
        return sprintf(
            'administrator::fields.%s.%s',
            snake_case($field ?? class_basename($this)),
            $page
        );
    }

    /**
     * @return string
     */
    public function translationKey()
    {
        $key = sprintf('administrator::columns.%s.%s', $this->translatableModule()->url(), $this->id);

The method url() does not exist on Illuminate\Foundation\Application.

        if (!$this->translator()->has($key)) {
            $key = sprintf('administrator::columns.%s.%s', 'global', $this->id);
        }

        return $key;
    }

    /**
     * @return string
     */
    public function descriptionKey()
    {
        $key = sprintf('administrator::hints.%s.%s', $this->translatableModule()->url(), $this->id);

        if (!$this->translator()->has($key)) {
            $key = sprintf('administrator::hints.%s.%s', 'global', $this->id);
        }

        return $key;
    }
}