Как использовать laravel enum, по дополнительным атрибутам и локализации

Для пакета BenSampo вы можете сделать это следующим образом:
Создайте черту:

<?php

namespace App\Traits;

/**
 * Get Enum Description
 */
trait GetEnumDescription
{
    private static $thisClass;

    public static function getCustomEnumDescription($enumValue = 0)
    {
        return __(self::getEnumDescription(intval($enumValue)));
    }

    private static function getEnumDescription($enumValue = 0)
    {
        self::$thisClass = static::class;
        $key = self::$thisClass::getKey($enumValue);
        return ucwords(str_replace('_', ' ', $key));
    }

    public static function getCustomInstances()
    {
        return array_map(
            function ($constantValue) {
                $newStatic = new static($constantValue);
                $newStatic = (array) $newStatic;
                $newStatic['custom_description'] = self::getCustomEnumDescription($constantValue);
                $newStatic = (object) $newStatic;
                return $newStatic;
            },
            static::getConstants(),
        );
    }
}

Создайте Enum (обычно я делаю значения перечисления с числовыми именами и именами переменных в змеином регистре. Вы можете настроить методы по своему усмотрению):

<?php

declare(strict_types=1);

namespace App\Enums;

use App\Traits\GetEnumDescription;
use BenSampo\Enum\Enum;

/**
 * Menu item types
 */
final class MenuItemType extends Enum
{
    use GetEnumDescription;

    const both = 0;
    const only_customer = 1;
    const only_vendor = 2;
    const closed = 3;
}

Убедитесь, что вы используете черту GetEnumDescription. Примеры:

// app()->setLocale('tr');
// dd(MenuItemType::getCustomInstances());
// RESULT:
array:4 [▼
  "both" => {#1156 ▼
    +"value": 0
    +"key": "both"
    +"description": "Both"
    +"custom_description": "Her ikisi de"
  }
  "only_customer" => {#1157 ▼
    +"value": 1
    +"key": "only_customer"
    +"description": "Only customer"
    +"custom_description": "Sadece müşteri"
  }
  "only_vendor" => {#1159 ▼
    +"value": 2
    +"key": "only_vendor"
    +"description": "Only vendor"
    +"custom_description": "Sadece bayi"
  }
  "closed" => {#1158 ▼
    +"value": 3
    +"key": "closed"
    +"description": "Closed"
    +"custom_description": "Closed"
  }
]

Пример:

public static function getCustomInstances()
{
    return array_map(
        function ($constantValue) {
            $newStatic = new static($constantValue);
            $newStatic = (array) $newStatic;
            $newStatic['custom_description'] = self::getCustomEnumDescription($constantValue);
            $newStatic['color'] = 'red';
            $newStatic['is_final'] = true;
            $newStatic = (object) $newStatic;
            return $newStatic;
        },
        static::getConstants(),
    );
}

Результат:

// after attributes added: dd(MenuItemType::getCustomInstances());
array:4 [▼
  "both" => {#1156 ▼
    +"value": 0
    +"key": "both"
    +"description": "Both"
    +"custom_description": "Her ikisi de"
    +"color": "red"
    +"is_final": true
  }
  "only_customer" => {#1157 ▼
    +"value": 1
    +"key": "only_customer"
    +"description": "Only customer"
    +"custom_description": "Sadece müşteri"
    +"color": "red"
    +"is_final": true
  }
  "only_vendor" => {#1158 ▼
    +"value": 2
    +"key": "only_vendor"
    +"description": "Only vendor"
    +"custom_description": "Sadece bayi"
    +"color": "red"
    +"is_final": true
  }
  "closed" => {#1159 ▼
    +"value": 3
    +"key": "closed"
    +"description": "Closed"
    +"custom_description": "Kapalı"
    +"color": "red"
    +"is_final": true
  }
]

Создайте два атрибута, чтобы сделать его в нужной вам структуре:
Color Атрибут:

<?php

declare(strict_types=1);

namespace App\Attributes;

use Attribute;

#[Attribute(Attribute::TARGET_CLASS_CONSTANT | Attribute::TARGET_CLASS)]
class Color
{
    public function __construct(
        public string $color,
    ) {
    }
}

И IsFinal Атрибут:

<?php

declare(strict_types=1);

namespace App\Attributes;

use Attribute;

#[Attribute(Attribute::TARGET_CLASS_CONSTANT | Attribute::TARGET_CLASS)]
class IsFinal
{
    public function __construct(
        public bool $is_final,
    ) {
    }
}

Вот как я создал ваше перечисление:

<?php

declare(strict_types=1);

namespace App\Enums;

use App\Attributes\Color;
use App\Attributes\IsFinal;
use BenSampo\Enum\Attributes\Description;
use BenSampo\Enum\Enum;
use Exception;

/**
 * Menu item types
 */
final class MenuItemType extends Enum
{
    public $color;
    public $isFinal;

    public function __construct(mixed $enumValue)
    {
        $this->color = $this->getCustomAttribute($enumValue, 'color');
        $this->isFinal = $this->getCustomAttribute($enumValue, 'is_final');
        parent::__construct($enumValue);
    }

    protected static function getCustomAttribute(mixed $value, $key)
    {
        $reflection = self::getReflection();
        $constantName = static::getKey($value);
        $constReflection = $reflection->getReflectionConstant($constantName);
        if ($constReflection === false) {
            return null;
        }

        switch ($key) {
            case 'color':
                $customAttributes = $constReflection->getAttributes(Color::class);
                break;
            case 'is_final':
                $customAttributes = $constReflection->getAttributes(IsFinal::class);
                break;
            default:
                break;
        }

        return match (count($customAttributes)) {
            0 => null,
            1 => $customAttributes[0]->newInstance()->$key,
            default => throw new Exception('You cannot use more than 1 custom attribute on ' . class_basename(static::class) . '::' . $constantName),
        };
    }

    const both = 0;
    const only_customer = 1;

    #[Color('blue')]
    #[Description('test')]
    #[IsFinal(true)]
    const only_vendor = 2;

    #[Color('red')]
    #[IsFinal(false)]
    const closed = 3;
}

Сделайте это с помощью dd(MenuItemType::getInstances()); Результат, когда я печатаю экран с помощью:

array:4 [▼ // app\Providers\AppServiceProvider.php:24
  "both" => App\Enums\MenuItemType {#1156 ▼
    +value: 0
    +key: "both"
    +description: "Both"
    +color: null
    +isFinal: null
  }
  "only_customer" => App\Enums\MenuItemType {#1157 ▼
    +value: 1
    +key: "only_customer"
    +description: "Only customer"
    +color: null
    +isFinal: null
  }
  "only_vendor" => App\Enums\MenuItemType {#1158 ▼
    +value: 2
    +key: "only_vendor"
    +description: "test"
    +color: "blue"
    +isFinal: true
  }
  "closed" => App\Enums\MenuItemType {#1160 ▼
    +value: 3
    +key: "closed"
    +description: "Closed"
    +color: "red"
    +isFinal: false
  }
]

Наслаждайся работой.

Пакет BenSampo Laravel Enum отлично подходит для простой настройки перечислений в Laravel. Однако добавление дополнительных настраиваемых атрибутов может быть немного сложным, так как на данный момент он не поддерживается пакетом.

Вот несколько возможных подходов к достижению вашей цели:

1. Расширьте класс Enum с помощью пользовательских методов:

Вы можете расширить базовый класс Enum для поддержки дополнительных атрибутов. Однако для этого требуется изменить сам класс Enum, что может быть не идеально, если вы работаете в команде или планируете обновить пакет в будущем.

    namespace App\Enums;

use BenSampo\Enum\Enum as BaseEnum;

class Enum extends BaseEnum
{
    public static function isFinal($value) {
        // define the logic here
    }
}

А затем используйте этот базовый класс для своих перечислений:

namespace App\Enums;

class Status extends Enum
{
    const DRAFT = 0;
    const FINAL = 1;
    
    public static function getDescription($value): string
    {
        if ($value === self::FINAL) {
            return 'Final';
        }

        return parent::getDescription($value);
    }
}

С помощью описанного выше метода теперь вы можете проверить, является ли значение перечисления окончательным или нет:

Status::isFinal(Status::FINAL); // Should return true

2. Используйте дополнительные классы Enum:

Другой подход может заключаться в создании отдельных Enum для этих особых случаев. Например, у вас может быть класс перечисления FinalStatus для статусов, которые являются окончательными.

namespace App\Enums;

use BenSampo\Enum\Enum;

final class FinalStatus extends Enum
{
    const PUBLISHED = 1;
    // Add more final statuses here
}

Затем вы можете использовать функции локализации Laravel для локализации ваших перечислений. Вы должны создать языковые файлы для каждого языка, который хотите поддерживать, и использовать функцию __() в коде вашего приложения для извлечения локализованной строки.

В любом случае, самым чистым решением было бы наличие в пакете встроенной поддержки дополнительных атрибутов. Вы можете создать проблему или запрос на извлечение в репозитории пакета GitHub, чтобы узнать, будут ли сопровождающие открыты для такой функции.

Я думаю, вы слишком все усложняете. Класс Enum из этого пакета является классом php, как и любой другой, поэтому в вашем случае я бы посоветовал добавить некоторые статические методы в класс Status, которые возвращают соответствующее значение в зависимости от случая ввода.

например это может выглядеть примерно так:

<?php

use BenSampo\Enum\Enum;

final class Status extends Enum
{
    const Initial = 1;
    const Pending = 2;
    const Completed = 3;
    const Canceled = 4;

    public static function getColor(Status $status): string
    {
        return match ($status->value) {
            self::Initial => 'gray',
            self::Pending => 'yellow',
            self::Completed => 'green',
            self::Canceled => 'red',
        };
    }

    public static function isFinal(Status $status): bool
    {
        return in_array($status->value, [self::Completed, self::Canceled]);
    }
 }

Который вы можете использовать следующим образом:

$status = Status::Completed();

Status::getColor($status); // "green"
Status::isFinal($status); // true

PR на упаковке приветствуются и учитываются, если они хорошо продуманы и правильно реализованы. Более динамичная система атрибутов может быть хорошим дополнением.