Rexlabs\Enum\Traits\HasEnum

Complexity

Total Complexity

19

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
B	setAttribute()	0	25	7
A	hasEnumDecodeKey()	0	3	1
A	getEnumEncoding()	0	14	4
A	decodeEnum()	0	11	3
A	getAttribute()	0	9	2
A	getEnumEncodings()	0	3	2

<?php

namespace Rexlabs\Enum\Traits;

use Rexlabs\Enum\Enum;
use Rexlabs\Enum\Exceptions\InvalidKeyException;

trait HasEnum
{
    public function getAttribute($key)
    {
        $value = parent::getAttribute($key);

        if ($this->hasEnumDecodeKey($key)) {
            $value = $this->decodeEnum($key, $value);
        }

        return $value;
    }

    public function setAttribute($key, $value)
    {
        if ($value !== null && $this->hasEnumDecodeKey($key)) {
            if ($this->hasCast($key)) {

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

                $value = $this->castAttribute($key, $value);

The method castAttribute() does not exist on Rexlabs\Enum\Traits\HasEnum. Did you maybe mean setAttribute()?

            }

            $encoding = $this->getEnumEncoding($key);
            
            if ($value instanceof $encoding['class']) {
                $value = $value->key();
            } elseif (gettype($encoding['class']::keys()[0]) != gettype($value)) {
                $value = $encoding['class']::keyForValue($value);
            }

            if ($encoding['column'] != $key) {
                $this->setAttribute($encoding['column'], $value);
            } else {
                $this->attributes[$key] = $value;

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            }

            return $this;
        }

        return parent::setAttribute($key, $value);
    }

    /**
     * Determine whether an attribute should be decode to an enum value.
     *
     * @param  string  $key
     * @return bool
     */
    protected function hasEnumDecodeKey($key): bool
    {
        return array_key_exists($key, $this->getEnumEncodings());
    }

    protected function decodeEnum(string $key, $value)
    {
        $encoding = $this->getEnumEncoding($key);

        $enumClass = $encoding['class'];
        $value = $encoding['column'] == $key ? $value : $this->getAttribute($encoding['column']);

        try {
            return $enumClass::valueForKey($value);
        } catch (InvalidKeyException $ex) {
            return $value;
        }
    }

    protected function getEnumEncodings()
    {
        return property_exists($this, 'decodeEnums') ? $this->decodeEnums : [];
    }

    protected function getEnumEncoding(string $key)
    {
        $encoding = $this->getEnumEncodings()[$key];

        $class = is_string($encoding)
            ? $encoding : $encoding[1];
        $column = is_string($encoding)
            ? $key : $encoding[0];

        if (! is_subclass_of($class, Enum::class)) {
            throw new \ErrorException("{$class} is not Enum");
        }

        return compact('class', 'column');
    }
}