LaravelFlare\Flare\Admin\Attributes\BaseAttribute

Complexity

Total Complexity

28

Size/Duplication

Total Lines	260
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	6
Bugs	0	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	2
A	render()	0	8	2
A	renderAdd()	0	4	1
A	renderEdit()	0	4	1
A	renderClone()	0	8	2
A	renderView()	0	4	1
A	getAttribute()	0	4	1
A	getField()	0	6	1
A	getValue()	0	12	3
A	getOldValue()	0	4	1
B	getFieldOptions()	0	16	7
A	getModel()	0	4	1
A	getModelManager()	0	4	1
A	getAttributeType()	0	4	2
A	getAttributeTitle()	0	4	1
A	viewData()	0	13	1

<?php

namespace LaravelFlare\Flare\Admin\Attributes;

use Illuminate\Support\HtmlString;
use LaravelFlare\Flare\Admin\Models\ModelAdmin;

class BaseAttribute
{
    /**
     * Attribute Type Constant.
     */
    const ATTRIBUTE_TYPE = '';

    /**
     * View Path for this Attribute Type
     *     Defaults to flare::admin.attributes which outputs
     *     a warning callout notifying the user that the field
     *     view does not yet exist.
     *     
     * @var string
     */
    protected $viewpath = 'flare::admin.attributes';

    /**
     * Attribute.
     * 
     * @var string
     */
    protected $attribute;

    /**
     * Field.
     * 
     * @var mixed
     */
    protected $field;

    /**
     * Value.
     * 
     * @var \Illuminate\Database\Eloquent\Model
     */
    protected $value;

    /**
     * Eloquent Model.
     * 
     * @var \Illuminate\Database\Eloquent\Model
     */
    protected $model;

    /**
     * Model Manager.
     * 
     * @var \LaravelFlare\Flare\Admin\Models\ModelAdmin
     */
    protected $modelManager;

    /**
     * __construct.
     * 
     * @param string $attribute
     * @param string $field
     * @param string $modelManager
     */
    public function __construct($attribute, $field, $value, $modelManager = null)
    {
        $this->attribute = $attribute;
        $this->field = $field;
        $this->value = $value;
        $this->modelManager = $modelManager;

It seems like $modelManager can also be of type string. However, the property $modelManager is declared as type object<LaravelFlare\Flare\Admin\Models\ModelAdmin>. Maybe add an additional type check?

        if ($modelManager instanceof ModelAdmin) {
            $this->model = $modelManager->model();
        }
    }

    /**
     * Returns the View to Render as an HTMLString
     * 
     * @param  boolean $view 
     * 
     * @return /Illuminate/Support/String

The doc-type /Illuminate/Support/String could not be parsed: Unknown type name "/Illuminate/Support/String" at position 0. (view supported doc-types)

     */
    public function render($view = false)
    {
        if (method_exists($this, $method = 'render'.ucfirst($view))) {
            return new HtmlString(
                call_user_func_array([$this, $method], [])
            );
        }
    }

    /**
     * Renders the Add (Create) Field View.
     * 
     * @return \Illuminate\View\View
     */
    public function renderAdd()
    {
        return view($this->viewpath.'.add', $this->viewData());

The expression view($this->viewpath . '.add', $this->viewData()); of type Illuminate\View\View|Illuminate\Contracts\View\Factory adds the type Illuminate\Contracts\View\Factory to the return on line 102 which is incompatible with the return type documented by LaravelFlare\Flare\Admin\Attributes\BaseAttribute::renderAdd of type Illuminate\View\View.

    }

    /**
     * Renders the Edit (Update) Field View.
     * 
     * @return \Illuminate\View\View
     */
    public function renderEdit()
    {
        return view($this->viewpath.'.edit', $this->viewData());

The expression view($this->viewpath . '.edit', $this->viewData()); of type Illuminate\View\View|Illuminate\Contracts\View\Factory adds the type Illuminate\Contracts\View\Factory to the return on line 112 which is incompatible with the return type documented by LaravelFlare\Flare\Admin\Attributes\BaseAttribute::renderEdit of type Illuminate\View\View.

    }

    /**
     * Renders the Clone (Update) Field View.
     * 
     * @return \Illuminate\View\View
     */
    public function renderClone()
    {
        if (view()->exists($this->viewpath.'.clone')) {

The method exists does only exist in Illuminate\Contracts\View\Factory, but not in Illuminate\View\View.

            view($this->viewpath.'.clone', $this->viewData());
        }

        return view($this->viewpath.'.edit', $this->viewData());

The expression view($this->viewpath . '.edit', $this->viewData()); of type Illuminate\View\View|Illuminate\Contracts\View\Factory adds the type Illuminate\Contracts\View\Factory to the return on line 126 which is incompatible with the return type documented by LaravelFlare\Flare\Admin\Attributes\BaseAttribute::renderClone of type Illuminate\View\View.

    }

    /**
     * Renders the Viewable Field View.
     * 
     * @return \Illuminate\View\View
     */
    public function renderView()
    {
        return view($this->viewpath.'.view', $this->viewData());

The expression view($this->viewpath . '.view', $this->viewData()); of type Illuminate\View\View|Illuminate\Contracts\View\Factory adds the type Illuminate\Contracts\View\Factory to the return on line 136 which is incompatible with the return type documented by LaravelFlare\Flare\Admin\Attributes\BaseAttribute::renderView of type Illuminate\View\View.

    }

    /**
     * Getter for Attribute.
     * 
     * @return string
     */
    public function getAttribute()
    {
        return $this->attribute;
    }

    /**
     * Getter for Field.
     * 
     * @return mixed
     */
    public function getField()
    {
        $this->getFieldOptions();

        return $this->field;
    }

    /**
     * Returns the current value
     * 
     * @return mixed
     */
    public function getValue()
    {
        if ($this->modelManager) {
            return $this->modelManager->getAttribute($this->attribute);
        }

        if ($this->model) {
            return $this->model->getAttribute($this->attribute);
        }

        return $this->value;
    }

    /**
     * Returns the old or current value
     * 
     * @return mixed
     */
    public function getOldValue()
    {
        return old($this->attribute, $this->getValue());
    }

    /**
     * Gets Field Options if they are defined.
     */
    public function getFieldOptions()
    {
        if (method_exists($this->getModelManager(), $method = camel_case('get_'.$this->getAttribute().'_options'))) {
            // First check for a method of options based on getAttributeNameOptions()
            $this->field['options'] = $this->getModelManager()->$method();
        } elseif (isset($this->field['options']) && is_string($this->field['options']) && method_exists($this->getModelManager(), $method = camel_case('get_'.$this->field['options'].'_options'))) {
            // Check if Options is a string and if so, check for a method
            // of options based on getDefinedOptions()
            $this->field['options'] = $this->getModelManager()->$method();
        } elseif (isset($this->field['options']) && is_string($this->field['options'])) {
            // Otherwise, if the options have been provided as a string
            // we will assume that the available options are comma
            // delimited and explode and return that array.
            $this->field['options'] = explode(',', $this->field['options']);
        }
    }

    /**
     * Accessor for Model.
     * 
     * @var \Illuminate\Database\Eloquent\Model
     */
    public function getModel()
    {
        return $this->model;
    }

    /**
     * Accessor for Model.
     * 
     * @var \LaravelFlare\Flare\Admin\Models\ModelAdmin
     */
    public function getModelManager()
    {
        return $this->modelManager;
    }

    /**
     * Acessor for Attribute Type converted to Title Case.
     * 
     * @return string
     */
    public function getAttributeType()
    {
        return title_case(isset($this->getField()['type']) ? $this->getField()['type'] : self::ATTRIBUTE_TYPE);
    }

    /**
     * Acessor for Attribute Title converted to Title Case with Spaces.
     * 
     * @return string
     */
    public function getAttributeTitle()
    {
        return str_replace('_', ' ', title_case($this->getAttribute()));
    }

    /**
     * Returns all of the accessible data for the Attirbute View
     *
     * @return array
     */
    protected function viewData()
    {
        return [
                'field' => $this->getField(),
                'model' => $this->getModel(),
                'attribute' => $this->getAttribute(),
                'value' => $this->getValue(),
                'oldValue' => $this->getOldValue(),
                'modelManager' => $this->getModelManager(),
                'attributeType' => $this->getAttributeType(),
                'attributeTitle' => $this->getAttributeTitle(),
            ];
    }
}