Sco\Admin\Form\Elements\Concerns\HasCast

Complexity

Total Complexity

32

Size/Duplication

Total Lines	189
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getCast()	0	4	1
A	setCast()	0	6	1
A	isCastable()	0	4	1
A	isDateCastable()	0	4	1
A	isJsonCastable()	0	4	1
A	isCommaCastable()	0	4	1
A	castValueAsJson()	0	17	2
A	asJson()	0	4	1
A	fromJson()	0	4	1
A	castValueAsCommaSeparated()	0	8	2
A	asCommaSeparated()	0	4	1
A	fromCommaSeparated()	0	4	1
D	castValue()	0	38	18

<?php

namespace Sco\Admin\Form\Elements\Concerns;

use Illuminate\Support\Collection;

/**
 * Trait hasCast
 *
 * @package Sco\Admin\Form\Elements\Concerns
 */
trait HasCast
{
    /**
     * @var string
     */
    protected $cast;

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

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

        return $this;
    }

    /**
     * @return bool
     */
    protected function isCastable()
    {
        return ! is_null($this->getCast());
    }

    /**
     * Determine whether a value is Date / DateTime castable for inbound manipulation.
     *
     * @return bool
     */
    protected function isDateCastable()
    {
        return in_array($this->getCast(), ['date', 'datetime']);
    }

    /**
     * @return bool
     */
    protected function isJsonCastable()
    {
        return in_array($this->getCast(), ['array', 'json', 'object', 'collection']);
    }

    /**
     * @return bool
     */
    protected function isCommaCastable()
    {
        return $this->getCast() === 'comma';
    }

    /**
     * Cast the given value to JSON.
     *
     * @param mixed $value
     * @return string
     */
    protected function castValueAsJson($value)
    {
        $value = $this->asJson($value);

        if ($value === false) {
            throw new \RuntimeException(
                sprintf(
                    "Unable to encode value [%s] for element [%s] to JSON: %s.",
                    $this->getName(),

It seems like getName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    get_class($this),
                    json_last_error_msg()
                )
            );
        }

        return $value;
    }

    /**
     * Encode the given value as JSON.
     *
     * @param $value
     * @return string
     */
    protected function asJson($value)
    {
        return json_encode($value);
    }

    /**
     * Decode the given JSON back into an array or object.
     *
     * @param string $value
     * @param bool $asObject
     * @return mixed
     */
    protected function fromJson($value, $asObject = false)
    {
        return json_decode($value, ! $asObject);
    }

    /**
     * Cast the given value to string with comma.
     *
     * @param mixed $value
     * @return string
     */
    protected function castValueAsCommaSeparated($value)
    {
        if (! is_array($value)) {
            $value = (array) $value;
        }

        return $this->asCommaSeparated($value);
    }

    /**
     * Join the given value with a comma
     *
     * @param array $value
     * @return string
     */
    protected function asCommaSeparated(array $value)
    {
        return implode(',', $value);
    }

    /**
     * Split the given value by comma
     *
     * @param string $value
     * @return array
     */
    protected function fromCommaSeparated(string $value)
    {
        return explode(',', $value);
    }

    /**
     * Cast a value to a native PHP type.
     *
     * @param $value
     * @return array
     */
    protected function castValue($value)
    {
        if (is_null($value)) {
            return $value;
        }

        switch ($this->getCast()) {
            case 'int':
            case 'integer':
                return (int) $value;
            case 'real':
            case 'float':
            case 'double':
                return (float) $value;
            case 'string':
                return (string) $value;
            case 'bool':
            case 'boolean':
                return (bool) $value;
            case 'object':
                return $this->fromJson($value, true);
            case 'array':
            case 'json':
                return $this->fromJson($value);
            case 'collection':
                return new Collection($this->fromJson($value));
            case 'comma':
                return $this->fromCommaSeparated($value);
            case 'date':
                return $this->asDate($value);

It seems like asDate() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            case 'datetime':
                return $this->asDateTime($value);

It seems like asDateTime() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            case 'timestamp':
                return $this->asTimestamp($value);

It seems like asTimestamp() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            default:
                return $value;
        }
    }
}