HasCast::fromCommaSeparated() - Code Metrics - Inspection of "form element use cast value" - ScoLib/admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2b7730...10405b )

by wen

created 2018-01-29 10:08 UTC

HasCast::fromCommaSeparated() A

↳ Parent: HasCast

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?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(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    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);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            case 'datetime':
                return $this->asDateTime($value);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            case 'timestamp':
                return $this->asTimestamp($value);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            default:
                return $value;
        }
    }
}


1			<?php
2
3			namespace Sco\Admin\Form\Elements\Concerns;
4
5			use Illuminate\Support\Collection;
6
7			/**
8			* Trait hasCast
9			*
10			* @package Sco\Admin\Form\Elements\Concerns
11			*/
12			trait HasCast
13			{
14			/**
15			* @var string
16			*/
17			protected $cast;
18
19			/**
20			* @return string
21			*/
22			public function getCast()
23			{
24			return $this->cast;
25			}
26
27			/**
28			* @param string $cast
29			* @return $this
30			*/
31			public function setCast(string $cast)
32			{
33			$this->cast = $cast;
34
35			return $this;
36			}
37
38			/**
39			* @return bool
40			*/
41			protected function isCastable()
42			{
43			return ! is_null($this->getCast());
44			}
45
46			/**
47			* Determine whether a value is Date / DateTime castable for inbound manipulation.
48			*
49			* @return bool
50			*/
51			protected function isDateCastable()
52			{
53			return in_array($this->getCast(), ['date', 'datetime']);
54			}
55
56			/**
57			* @return bool
58			*/
59			protected function isJsonCastable()
60			{
61			return in_array($this->getCast(), ['array', 'json', 'object', 'collection']);
62			}
63
64			/**
65			* @return bool
66			*/
67			protected function isCommaCastable()
68			{
69			return $this->getCast() === 'comma';
70			}
71
72			/**
73			* Cast the given value to JSON.
74			*
75			* @param mixed $value
76			* @return string
77			*/
78			protected function castValueAsJson($value)
79			{
80			$value = $this->asJson($value);
81
82			if ($value === false) {
83			throw new \RuntimeException(
84			sprintf(
85			"Unable to encode value [%s] for element [%s] to JSON: %s.",
86			$this->getName(),
			0 ignored issues – show Bug introduced 2018-01-29 10:19 UTC by Report Bug Copy Issue Report It seems like `getName()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
87			get_class($this),
88			json_last_error_msg()
89			)
90			);
91			}
92
93			return $value;
94			}
95
96			/**
97			* Encode the given value as JSON.
98			*
99			* @param $value
100			* @return string
101			*/
102			protected function asJson($value)
103			{
104			return json_encode($value);
105			}
106
107			/**
108			* Decode the given JSON back into an array or object.
109			*
110			* @param string $value
111			* @param bool $asObject
112			* @return mixed
113			*/
114			protected function fromJson($value, $asObject = false)
115			{
116			return json_decode($value, ! $asObject);
117			}
118
119			/**
120			* Cast the given value to string with comma.
121			*
122			* @param mixed $value
123			* @return string
124			*/
125			protected function castValueAsCommaSeparated($value)
126			{
127			if (! is_array($value)) {
128			$value = (array) $value;
129			}
130
131			return $this->asCommaSeparated($value);
132			}
133
134			/**
135			* Join the given value with a comma
136			*
137			* @param array $value
138			* @return string
139			*/
140			protected function asCommaSeparated(array $value)
141			{
142			return implode(',', $value);
143			}
144
145			/**
146			* Split the given value by comma
147			*
148			* @param string $value
149			* @return array
150			*/
151			protected function fromCommaSeparated(string $value)
152			{
153			return explode(',', $value);
154			}
155
156			/**
157			* Cast a value to a native PHP type.
158			*
159			* @param $value
160			* @return array
161			*/
162			protected function castValue($value)
163			{
164			if (is_null($value)) {
165			return $value;
166			}
167
168			switch ($this->getCast()) {
169			case 'int':
170			case 'integer':
171			return (int) $value;
172			case 'real':
173			case 'float':
174			case 'double':
175			return (float) $value;
176			case 'string':
177			return (string) $value;
178			case 'bool':
179			case 'boolean':
180			return (bool) $value;
181			case 'object':
182			return $this->fromJson($value, true);
183			case 'array':
184			case 'json':
185			return $this->fromJson($value);
186			case 'collection':
187			return new Collection($this->fromJson($value));
188			case 'comma':
189			return $this->fromCommaSeparated($value);
190			case 'date':
191			return $this->asDate($value);
			0 ignored issues – show Bug introduced 2018-01-29 10:19 UTC by Report Bug Copy Issue Report It seems like `asDate()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
192			case 'datetime':
193			return $this->asDateTime($value);
			0 ignored issues – show Bug introduced 2018-01-29 10:19 UTC by Report Bug Copy Issue Report It seems like `asDateTime()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
194			case 'timestamp':
195			return $this->asTimestamp($value);
			0 ignored issues – show Bug introduced 2018-01-29 10:19 UTC by Report Bug Copy Issue Report It seems like `asTimestamp()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
196			default:
197			return $value;
198			}
199			}
200			}
201

ScoLib / admin

Push — master ( 2b7730...10405b )

HasCast::fromCommaSeparated() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like