LaravelFreelancerNL / laravel-arangodb

src/Eloquent/Casts/AsEnumCollection.php

<?php

declare(strict_types=1);

namespace LaravelFreelancerNL\Aranguent\Eloquent\Casts;

use BackedEnum;

The type BackedEnum was not found. Maybe you did not declare it correctly or list all dependencies?

use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Casts\AsEnumCollection as IlluminateAsEnumCollection;
use Illuminate\Support\Collection;
use LaravelFreelancerNL\Aranguent\Eloquent\Model;

/**
 * @SuppressWarnings("PHPMD.UndefinedVariable")
 * @SuppressWarnings("PHPMD.UnusedFormalParameter")
 * @SuppressWarnings("PHPMD.ShortMethodName")
 */
class AsEnumCollection extends IlluminateAsEnumCollection
{
    /**
     * Get the caster class to use when casting from / to this cast target.
     *
     * @template TEnum of \UnitEnum|\BackedEnum
     *
     * @param  array{class-string<TEnum>}  $arguments

The doc comment array{class-string<TEnum>} at position 2 could not be parsed: Expected ':' at position 2, but found 'class-string'.

     * @return \Illuminate\Contracts\Database\Eloquent\CastsAttributes<\Illuminate\Support\Collection<array-key, TEnum>, iterable<TEnum>>
     */
    public static function castUsing(array $arguments)
    {
        return new class ($arguments) implements CastsAttributes {
            /**
             * @var array<class-string<TEnum>>

The doc comment array<class-string<TEnum>> at position 2 could not be parsed: Unknown type name 'class-string' at position 2 in array<class-string<TEnum>>.

             */
            protected $arguments;

            /**
             * @param array<class-string<TEnum>> $arguments

The doc comment array<class-string<TEnum>> at position 2 could not be parsed: Unknown type name 'class-string' at position 2 in array<class-string<TEnum>>.

             */
            public function __construct(array $arguments)
            {
                $this->arguments = $arguments;
            }

            public function get($model, $key, $value, $attributes)
            {
                if (! isset($attributes[$key])) {
                    return;
                }

                $data = $attributes[$key];
                if (is_object($data)) {
                    $data = (array) $data;
                }

                if (! is_array($data)) {
                    return;
                }

                $enumClass = $this->arguments[0];

                return (new Collection($data))->map(function ($value) use ($enumClass) {

$data of type array is incompatible with the type Illuminate\Contracts\Support\Arrayable expected by parameter $items of Illuminate\Support\Collection::__construct().

The expression return new Illuminate\Support\Collection($data)->map(function(...) { /* ... */ }) returns the type Illuminate\Support\Collection which is incompatible with the return type mandated by Illuminate\Contracts\Database\Eloquent\CastsAttributes::get() of Illuminate\Contracts\Database\Eloquent\TGet|null.

                    return is_subclass_of($enumClass, BackedEnum::class)
                        ? $enumClass::from($value)
                        : constant($enumClass . '::' . $value);
                });
            }

            public function set($model, $key, $value, $attributes)
            {
                $value = $value !== null
                    ? (new Collection($value))->map(function ($enum) {
                        return $this->getStorableEnumValue($enum);
                    })->jsonSerialize()
                    : null;

                return [$key => $value];
            }

            /**
             * @param Model $model
             * @param string $key
             * @param mixed $value
             * @param mixed[] $attributes
             * @return mixed[]
             */
            public function serialize($model, string $key, $value, array $attributes)

The parameter $key is not used and could be removed.

The parameter $attributes is not used and could be removed.

The parameter $model is not used and could be removed.

            {
                return (new Collection($value))->map(function ($enum) {
                    return $this->getStorableEnumValue($enum);
                })->toArray();
            }

            /**
             * @param mixed $enum
             * @return int|string
             */
            protected function getStorableEnumValue($enum)
            {
                if (is_string($enum) || is_int($enum)) {
                    return $enum;
                }

                return $enum instanceof BackedEnum ? $enum->value : $enum->name;
            }
        };
    }

    /**
     * Specify the Enum for the cast.
     *
     * @param  class-string  $class

The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.

     * @return string
     */
    public static function of($class)
    {
        return static::class . ':' . $class;
    }
}