PhpWinTools\WmiScripting\Concerns\ComHasAttributes

Complexity

Total Complexity

68

Size/Duplication

Total Lines	290
Duplicated Lines	0 %

Test Coverage

Coverage

40.3%

Importance

Changes	1
Bugs	0	Features	0

25 Methods

Rating	Name	Duplication	Size	Complexity
A	setHidden()	0	9	2
A	replaceAttributeName()	0	7	2
B	getAttribute()	0	26	7
A	isHidden()	0	5	1
A	getAttributeMethods()	0	5	3
A	calculatedAttributes()	0	7	2
A	getCalculatedAttributes()	0	5	1
A	toArray()	0	6	1
A	getAttributeNameFromMethod()	0	3	1
A	getCasts()	0	3	1
B	transformToArray()	0	19	8
A	tryToArrayMethod()	0	18	6
A	hasUnmappedAttribute()	0	3	1
A	iterateAttributes()	0	13	3
A	hasProperty()	0	3	1
A	hasToArrayMethod()	0	11	3
A	setAttributeNameReplacements()	0	5	1
A	getHidden()	0	3	1
A	hasAttributeMethod()	0	5	1
A	objectToArray()	0	16	4
A	hasCast()	0	3	1
C	cast()	0	28	13
A	getAncestorProperty()	0	5	1
A	setCasts()	0	5	2
A	getCast()	0	5	1

<?php

namespace PhpWinTools\WmiScripting\Concerns;

use Exception;
use ReflectionClass;
use PhpWinTools\WmiScripting\Contracts\Arrayable;
use Illuminate\Contracts\Support\Arrayable as IlluminateArrayable;

trait ComHasAttributes
{
    use CanCollect;

    protected $unmapped_attributes = [];

    protected $trait_name_replacements = [];

    protected $trait_hidden_attributes = [
        'trait_hidden_attributes',
        'trait_name_replacements',

        'attribute_name_replacements',
        'unmapped_attributes',

        'hidden_attributes',
        'merge_parent_hidden_attributes',

        'attribute_casting',
        'merge_parent_casting',
    ];

    public function getAttribute($attribute, $default = null)
    {
        if ($this->hasAttributeMethod($attribute)) {
            $method = 'get' . ucfirst($attribute) . 'Attribute';
            if ($this->hasProperty($attribute)) {
                return $this->{$method}($this->{$attribute});
            } elseif ($this->hasUnmappedAttribute($attribute)) {
                return  $this->{$method}($this->unmapped_attributes[$attribute]);
            }

            return $this->{$method}();
        }

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

        if ($key = array_search($attribute, $this->attribute_name_replacements)) {
            return $this->{$key};
        }

        if (array_key_exists($attribute, $this->unmapped_attributes)) {
            return $this->unmapped_attributes[$attribute];
        }

        return $default;
    }

    public function toArray(): array
    {
        return array_merge(
            $this->getCalculatedAttributes(),
            $this->iterateAttributes(get_class_vars(get_called_class())),
            $this->iterateAttributes($this->unmapped_attributes)
        );
    }

    public function setHidden(array $hidden_attributes, bool $merge_hidden = true)
    {
        $hidden_attributes = $merge_hidden
            ? array_merge($this->getAncestorProperty('hidden_attributes'), $hidden_attributes)
            : $hidden_attributes;

        $this->trait_hidden_attributes = array_merge($this->trait_hidden_attributes, $hidden_attributes);

        return $this;
    }

    public function isHidden($key): bool
    {
        $this->trait_hidden_attributes = array_combine($this->trait_hidden_attributes, $this->trait_hidden_attributes);

        return array_key_exists($key, $this->trait_hidden_attributes);

It seems like $this->trait_hidden_attributes can also be of type false; however, parameter $search of array_key_exists() does only seem to accept array, maybe add an additional type check?

    }

    public function getHidden()
    {
        return array_combine($this->trait_hidden_attributes, $this->trait_hidden_attributes);
    }

    protected function getCalculatedAttributes()
    {
        return $this->collect($this->calculatedAttributes())->mapWithKeys(function ($attribute) {
            return [$attribute => $this->{'get' . lcfirst($attribute) . 'Attribute'}()];
        })->toArray();
    }

    protected function calculatedAttributes()
    {
        return $this->collect($this->getAttributeMethods())->map(function ($method) {
            return $this->getAttributeNameFromMethod($method);
        })->filter(function ($attribute) {
            return !$this->hasProperty($attribute) && !$this->hasUnmappedAttribute($attribute);
        })->values()->toArray();
    }

    protected function hasUnmappedAttribute($attribute)
    {
        return array_key_exists($attribute, $this->unmapped_attributes);
    }

    protected function hasAttributeMethod($attribute)
    {
        return $this->collect($this->getAttributeMethods())->filter(function ($method) use ($attribute) {
            return $this->getAttributeNameFromMethod($method) === $attribute;
        })->isNotEmpty();
    }

    protected function getAttributeNameFromMethod($method)
    {
        return lcfirst(substr($method, 3, -9));
    }

    protected function getAttributeMethods()
    {
        return $this->collect(get_class_methods(get_called_class()))->filter(function ($method) {
            return substr($method, 0, 3) === 'get' && substr($method, -9) === 'Attribute' && $method !== 'getAttribute';
        })->values()->toArray();
    }

    protected function setAttributeNameReplacements(array $name_replacements)
    {
        $this->trait_name_replacements = $name_replacements;

        return $this;
    }

    protected function hasProperty($property_name)
    {
        return array_key_exists($property_name, get_class_vars(get_called_class()));
    }

    protected function replaceAttributeName($key)
    {
        if (array_key_exists($key, $this->trait_name_replacements)) {
            return $this->trait_name_replacements[$key];
        }

        return $key;
    }

    protected function objectToArray($value)
    {
        if (!is_object($value)) {
            return $value;
        }

        $array = (array) $value;

        foreach ($array as $key => $value) {

$value is overwriting one of the parameters of this function.

            if (strpos($key, "\x00*\x00") === 0) {
                $array[substr($key, 3)] = $value;
                unset($array[$key]);
            }
        }

        return $array;
    }

    protected function tryToArrayMethod($value)
    {
        if (!is_object($value)) {
            return $value;
        }

        if (is_object($value) && $this->hasToArrayMethod($value)) {
            try {
                $array = $value->toArray();
                if (is_array($array)) {
                    return $array;
                }
            } catch (Exception $exception) {
                return $value;
            }
        }

        return $value;
    }

    protected function hasToArrayMethod($value)
    {
        if (!is_object($value)) {
            return false;
        }

        if (in_array('toArray', get_class_methods($value))) {
            return true;
        }

        return false;
    }

    protected function transformToArray($value)
    {
        if (is_object($value) && ($value instanceof Arrayable || $value instanceof IlluminateArrayable)) {
            return $value->toArray();
        }

        if (is_object($value) && is_array(($array = $this->tryToArrayMethod($value)))) {
            return $array;
        }

        if (is_object($value)) {
            return $this->objectToArray($value);
        }

        if (is_array($value)) {
            return $this->iterateAttributes($value);
        }

        return $value;
    }

    protected function iterateAttributes(array $attributes)
    {
        $results = [];

        foreach ($attributes as $key => $value) {
            if ($this->isHidden($key)) {
                continue;
            }

            $results[$this->replaceAttributeName($key)] = $this->transformToArray($this->getAttribute($key, $value));
        }

        return $results;
    }

    public function getCasts(): array
    {
        return $this->attribute_casting;
    }

    public function getCast($attribute)
    {
        $casts = $this->getCasts();

        return $casts[$attribute] ?? null;
    }

    public function hasCast($attribute): bool
    {
        return array_key_exists($attribute, $this->attribute_casting);
    }

    public function setCasts(array $attribute_casting, bool $merge_casting = true)
    {
        $this->attribute_casting = $merge_casting

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

            ? array_merge($this->getAncestorProperty('attribute_casting'), $attribute_casting)
            : $attribute_casting;
    }

    protected function cast($key, $value)
    {
        $casts = $this->getCasts();

        if (!$this->hasCast($key)) {
            return $value;
        }

        if (is_callable($casts[$key])) {
            return $casts[$key]($value, $key);
        }

        switch ($casts[$key]) {
            case 'array':
                return is_array($value) ? $value : [$value];
            case 'bool':
            case 'boolean':
                return (bool) $value;
            case 'float':
                return (float) $value;
            case 'int':
            case 'integer':
                // Prevent integer overflow
                return $value >= PHP_INT_MAX || $value <= PHP_INT_MIN ? (string) $value : (int) $value;
            case 'string':
                return (string) $value;
            default:
                return $value;
        }
    }

    protected function getAncestorProperty($property_name)
    {
        return $this->collect(class_parents($this))->map(function ($class) use ($property_name) {
            return (new ReflectionClass($class))->getDefaultProperties()[$property_name] ?? [];
        })->values()->collapse()->toArray();
    }
}