Arcanedev\LaravelHtml\Traits\FormAccessible

Complexity

Total Complexity

8

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

96%

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getFormValue()	0	19	4
	getAttributeFromArray()	0	1	?
	getDates()	0	1	?
	asDateTime()	0	1	?
A	hasFormMutator()	0	12	1
A	mutateFormAttribute()	0	4	1
A	getReflection()	0	8	2

<?php namespace Arcanedev\LaravelHtml\Traits;

use ReflectionClass;
use ReflectionMethod;

/**
 * Class     FormAccessible
 *
 * @package  Arcanedev\LaravelHtml\Traits
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
trait FormAccessible
{
    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * A cached ReflectionClass instance for $this
     *
     * @var ReflectionClass
     */
    protected $reflection;

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * @param string $key
     *
     * @return mixed
     */
    public function getFormValue($key)
    {
        $value = $this->getAttributeFromArray($key);

        // If the attribute is listed as a date, we will convert it to a DateTime
        // instance on retrieval, which makes it quite convenient to work with
        // date fields without having to create a mutator for each property.
        if (in_array($key, $this->getDates())) {
            if ( ! is_null($value)) {
                $value = $this->asDateTime($value);
            }
        }

        if ($this->hasFormMutator($key)) {
            return $this->mutateFormAttribute($key, $value);
        }

        return $value;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Eloquent Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get an attribute from the $attributes array.
     *
     * @param  string  $key
     *
     * @return mixed
     */
    abstract protected function getAttributeFromArray($key);

    /**
     * Get the attributes that should be converted to dates.
     *
     * @return array
     */
    abstract public function getDates();

    /**
     * Return a timestamp as DateTime object.
     *
     * @param  mixed  $value
     *
     * @return \Carbon\Carbon
     */
    abstract protected function asDateTime($value);

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Check if has a form mutator.
     *
     * @param  string  $key
     *
     * @return bool
     */
    protected function hasFormMutator($key)
    {
        $methods = $this->getReflection()
            ->getMethods(ReflectionMethod::IS_PUBLIC);

        $mutator = collect($methods)
            ->first(function ($index, ReflectionMethod $method) use ($key) {
                return $method->name === 'form' . str_studly($key) . 'Attribute';
            });

        return (bool) $mutator;
    }

    /**
     * Mutate the form attribute.
     *
     * @param  string  $key
     * @param  mixed   $value
     *
     * @return mixed
     */
    private function mutateFormAttribute($key, $value)
    {
        return $this->{'form' . str_studly($key) . 'Attribute'}($value);
    }

    /**
     * Get a ReflectionClass Instance
     *
     * @return ReflectionClass
     */
    protected function getReflection()
    {
        if ( ! $this->reflection) {
            $this->reflection = new ReflectionClass($this);
        }

        return $this->reflection;
    }
}