Yaro\Jarboe\Table\Fields\AbstractField

Complexity

Total Complexity

65

Size/Duplication

Total Lines	351
Duplicated Lines	0 %

Coupling/Cohesion

Components	6
Dependencies	3

Test Coverage

Coverage

52.03%

Importance

Changes

0

47 Methods

Rating	Name	Duplication	Size	Complexity
A	make()	0	12	2
A	setModel()	0	4	1
A	getModel()	0	4	1
A	value()	0	9	3
A	col()	0	6	1
A	getCol()	0	4	1
A	filter()	0	12	2
A	tab()	0	6	1
A	getTab()	0	4	1
A	title()	0	10	2
A	name()	0	10	2
A	readonly()	0	6	1
A	isReadonly()	0	4	1
A	default()	0	6	1
A	getDefault()	0	4	1
A	old()	0	8	2
A	hasOld()	0	4	1
A	oldOrDefault()	0	13	3
A	oldOrAttribute()	0	16	6
A	getAttribute()	0	8	3
A	width()	0	6	1
A	getWidth()	0	4	1
A	hide()	0	10	1
A	hideList()	0	6	1
A	hideEdit()	0	6	1
A	hideCreate()	0	6	1
A	hidden()	0	8	2
A	afterStore()	0	4	1
A	afterUpdate()	0	4	1
A	isInline()	0	4	1
A	isRelationField()	0	4	1
A	isMultiple()	0	4	1
A	isEncode()	0	4	1
A	isMarkupRow()	0	4	1
A	isOrderable()	0	4	1
A	isAjax()	0	4	1
A	isNullable()	0	4	1
A	hasTooltip()	0	4	1
A	hasClipboardButton()	0	4	1
A	isTranslatable()	0	4	1
A	isMaskable()	0	4	1
A	getPlaceholder()	0	4	1
	getListValue()	0	1	?
	getEditFormValue()	0	1	?
	getCreateFormValue()	0	1	?
A	prepare()	0	21	5
A	shouldSkip()	0	4	1

<?php

namespace Yaro\Jarboe\Table\Fields;

use Illuminate\Http\Request;
use Yaro\Jarboe\Table\CRUD;
use Yaro\Jarboe\Table\Fields\Interfaces\FieldPropsInterface;
use Yaro\Jarboe\Table\Filters\AbstractFilter;

abstract class AbstractField implements FieldPropsInterface
{
    const DEFAULT_TAB_IDENT = '[extra]';

    protected $model = '';
    protected $title = '';
    protected $name  = '';
    protected $readonly = false;
    protected $default = null;
    protected $hidden = [
        'list'   => false,
        'edit'   => false,
        'create' => false,
    ];
    protected $width;
    protected $filter = null;
    protected $tab = self::DEFAULT_TAB_IDENT;
    protected $col = 12;

    public static function make($name = '', $title = '')
    {
        $field = new static;

        if (!$title) {
            $title = preg_replace('~_~', ' ', ucfirst($name));
        }
        $field->title($title);
        $field->name($name);

        return $field;
    }

    public function setModel($model)
    {
        $this->model = $model;
    }

    public function getModel()
    {
        return $this->model;
    }

    public function value(Request $request)
    {
        $value = $request->get($this->name());
        if (!$value && $this->isNullable()) {
            return null;
        }

        return $value;
    }

    public function shouldSkip(Request $request)
    {
        return false;
    }

    public function col(int $col)
    {
        $this->col = $col;

        return $this;
    }

    public function getCol()
    {
        return $this->col;
    }

    public function filter(AbstractFilter $filter = null)

The return type could not be reliably inferred; please add a @return annotation.

    {
        if (is_null($filter)) {
            return $this->filter;
        }

        $filter->field($this);

        $this->filter = $filter;

        return $this;
    }

    public function tab(string $tab)
    {
        $this->tab = $tab;

        return $this;
    }

    public function getTab()
    {
        return $this->tab;
    }

    public function title(string $title = null)
    {
        if (is_null($title)) {
            return $this->title;
        }

        $this->title = $title;

        return $this;
    }

    public function name(string $name = null)
    {
        if (is_null($name)) {
            return $this->name;
        }

        $this->name = $name;

        return $this;
    }

    public function readonly(bool $isReadonly = true)
    {
        $this->readonly = $isReadonly;

        return $this;
    }

    public function isReadonly()
    {
        return $this->readonly;
    }

    public function default($value)
    {
        $this->default = $value;

        return $this;
    }

    public function getDefault()
    {
        return $this->default;
    }

    public function old($name = null)

The return type could not be reliably inferred; please add a @return annotation.

    {
        if (is_null($name)) {
            $name = $this->name();
        }
        
        return old($name);
    }

    public function hasOld($name = null)
    {
        return !is_null($this->old($name));
    }

    public function oldOrDefault($locale = null)

The return type could not be reliably inferred; please add a @return annotation.

    {
        $name = $this->name();
        if ($locale) {
            $name .= '.'. $locale;
        }

        if ($this->hasOld($name)) {
            return $this->old($name);
        }

        return $this->getDefault();
    }

    public function oldOrAttribute($model, $default = null, $locale = null)

The return type could not be reliably inferred; please add a @return annotation.

    {
        $name = $this->name();
        if ($locale) {
            $name .= '.'. $locale;
        }

        if ($this->hasOld($name)) {
            return $this->old($name);
        }

        if ($this->isTranslatable()) {
            return $model->getTranslation($this->name(), $locale) ?: $default;
        }
        return $model->{$this->name()} ?: $default;
    }

    public function getAttribute($model, $locale = null)

The return type could not be reliably inferred; please add a @return annotation.

    {
        if ($locale && $this->isTranslatable()) {
            return $model->getTranslation($this->name(), $locale);
        }

        return $model->{$this->name()};
    }

    public function width(int $width)
    {
        $this->width = $width;

        return $this;
    }

    public function getWidth()
    {
        return $this->width;
    }

    public function hide(bool $edit = false, bool $create = false, bool $list = false)
    {
        $this->hidden = [
            'list'   => $list,
            'edit'   => $edit,
            'create' => $create,
        ];

        return $this;
    }

    public function hideList(bool $hide = false)
    {
        $this->hidden['list'] = $hide;

        return $this;
    }

    public function hideEdit(bool $hide = false)
    {
        $this->hidden['edit'] = $hide;

        return $this;
    }

    public function hideCreate(bool $hide = false)
    {
        $this->hidden['create'] = $hide;

        return $this;
    }

    public function hidden(string $type)

The return type could not be reliably inferred; please add a @return annotation.

    {
        if (!array_key_exists($type, $this->hidden)) {
            throw new \RuntimeException(sprintf("Wrong type [%s] for field's hidden attribute", $type));
        }

        return $this->hidden[$type];
    }

    public function afterStore($model, Request $request)
    {
        // dummy
    }

    public function afterUpdate($model, Request $request)
    {
        // dummy
    }

    public function isInline()
    {
        return false;
    }

    public function isRelationField()
    {
        return false;
    }

    public function isMultiple()
    {
        return false;
    }

    public function isEncode()
    {
        return false;
    }

    public function isMarkupRow()
    {
        return false;
    }

    public function isOrderable()
    {
        return false;
    }

    public function isAjax()
    {
        return false;
    }

    public function isNullable()
    {
        return false;
    }

    public function hasTooltip()
    {
        return false;
    }

    public function hasClipboardButton()
    {
        return false;
    }

    public function isTranslatable()
    {
        return false;
    }

    public function isMaskable()
    {
        return false;
    }

    public function getPlaceholder()
    {
        return '';
    }

    abstract public function getListValue($model);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    abstract public function getEditFormValue($model);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    abstract public function getCreateFormValue();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    // TODO: interface type-hinting
    public function prepare(CRUD $crud)
    {
        if ($this->filter()) {
            $this->filter()->value(
                $this->filter()->getValue($crud->tableIdentifier())
            );
        }

        $this->setModel($crud->getModel());

        if (method_exists($this, 'setRelationSearchUrl')) {
            $this->setRelationSearchUrl($crud->relationSearchUrl());

It seems like you code against a specific sub-type and not the parent class Yaro\Jarboe\Table\Fields\AbstractField as the method setRelationSearchUrl() does only exist in the following sub-classes of Yaro\Jarboe\Table\Fields\AbstractField: Yaro\Jarboe\Table\Fields\Radio, Yaro\Jarboe\Table\Fields\Select. Maybe you want to instanceof check for one of these explicitly?

        }
        if (method_exists($this, 'setInlineUrl')) {
            $this->setInlineUrl($crud->inlineUrl());

It seems like you code against a specific sub-type and not the parent class Yaro\Jarboe\Table\Fields\AbstractField as the method setInlineUrl() does only exist in the following sub-classes of Yaro\Jarboe\Table\Fields\AbstractField: Yaro\Jarboe\Table\Fields\Date, Yaro\Jarboe\Table\Fields\Number, Yaro\Jarboe\Table\Fields\Text, Yaro\Jarboe\Table\Fields\Textarea. Maybe you want to instanceof check for one of these explicitly?

        }
        if ($this->isTranslatable()) {
            $this->locales($crud->getLocales());

It seems like you code against a specific sub-type and not the parent class Yaro\Jarboe\Table\Fields\AbstractField as the method locales() does only exist in the following sub-classes of Yaro\Jarboe\Table\Fields\AbstractField: Yaro\Jarboe\Table\Fields\Text, Yaro\Jarboe\Table\Fields\Textarea, Yaro\Jarboe\Table\Fields\Wysiwyg. Maybe you want to instanceof check for one of these explicitly?

            $this->setCurrentLocale($crud->getCurrentLocale());

It seems like you code against a specific sub-type and not the parent class Yaro\Jarboe\Table\Fields\AbstractField as the method setCurrentLocale() does only exist in the following sub-classes of Yaro\Jarboe\Table\Fields\AbstractField: Yaro\Jarboe\Table\Fields\Text, Yaro\Jarboe\Table\Fields\Textarea, Yaro\Jarboe\Table\Fields\Wysiwyg. Maybe you want to instanceof check for one of these explicitly?

        }
    }
}