PHP code example of iteks / laravel-enum

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

iteks / laravel-enum example snippets

use Iteks\Attributes\Description;
use Iteks\Attributes\Id;
use Iteks\Attributes\Label;
use Iteks\Attributes\Metadata;
use Iteks\Traits\BackedEnum;
use Iteks\Traits\HasAttributes;

enum ExampleBackedEnum: int
{
    use BackedEnum;
    use HasAttributes;

    #[Description('Active status indicating the resource is currently in use')]
    #[Id(101)]
    #[Label('Active')]
    #[Metadata(['status_type' => 'positive', 'display_color' => 'green'])]
    case CurrentlyActive = 1;

    #[Description('Pending status indicating the resource is awaiting processing or approval')]
    #[Id(102)]
    #[Label('Pending')]
    #[Metadata('{"status_type": "neutral", "display_color": "yellow"}')]
    case PendingReview = 2;

    #[Description('Temporarily suspended status indicating the resource is on hold')]
    #[Id(103)]
    #[Label('Suspended (!)')]
    #[Metadata([])]
    case TemporarilySuspended = 3;
}

#[Description('A collection of status codes')] // Class-level description
enum Status: int
{
    #[Description('Operation completed successfully')] // Case-level description
    case Success = 200;
}

enum Status: int
{
    #[Id(1)]
    case Draft = 0;
}

enum Status: int
{
    #[Label('In Progress')]
    case Processing = 1;
}

#[Metadata(['version' => '1.0'])] // Class-level metadata
enum Status: int
{
    #[Metadata(['severity' => 'error'])] // Case-level metadata
    case Error = 500;
}

use Iteks\Support\Facades\Enum;

$selectArray = Enum::asSelectArray(ExampleBackedEnum::class);

$label = Enum::toLabel(ExampleBackedEnum::CurrentlyActive); // 'Currently Active'

$labels = Enum::toLabels(ExampleBackedEnum::class);

use Iteks\Support\Facades\Enum;

$attributes = Enum::attributes(ExampleBackedEnum::CurrentlyActive);

$attributes = Enum::attributes(ExampleBackedEnum::CurrentlyActive, ['id', 'label']);

$attributes = Enum::attributes(ExampleBackedEnum::class);

$attributes = Enum::attributes(ExampleBackedEnum::class, ['description', 'metadata']);

$description = Enum::description(ExampleBackedEnum::CurrentlyActive);

$descriptions = Enum::descriptions(ExampleBackedEnum::class);

$id = Enum::id(ExampleBackedEnum::CurrentlyActive); //101

$ids = Enum::ids(ExampleBackedEnum::class);

$label = Enum::label(ExampleBackedEnum::TemporarilySuspended); // 'Suspended (!)'

$labels = Enum::labels(ExampleBackedEnum::class);

$metadata = Enum::metadata(ExampleBackedEnum::CurrentlyActive);

$metadatum = Enum::metadatum(ExampleBackedEnum::class);

$selectArray = ExampleBackedEnum::asSelectArray();

$enum = ExampleBackedEnum::fromName('CurrentlyActive');

$caseName = ExampleBackedEnum::name(1); // 'CurrentlyActive'

$caseNames = ExampleBackedEnum::names();

$label = ExampleBackedEnum::toLabel(1); // 'Currently Active'

$labels = ExampleBackedEnum::toLabels();

$enum = ExampleBackedEnum::tryFromName('CurrentlyActive');

$simplerValue = ExampleBackedEnum::value('CurrentlyActive'); // 1

$simplerValues = ExampleBackedEnum::values();

$attributes = ExampleBackedEnum::attributes('CurrentlyActive');

$attributes = ExampleBackedEnum::attributes('CurrentlyActive', ['id', 'label']);

$attributes = ExampleBackedEnum::attributes();

$attributes = ExampleBackedEnum::attributes(null, ['description', 'metadata']);

$description = ExampleBackedEnum::description('CurrentlyActive');

$descriptions = ExampleBackedEnum::descriptions();

$id = ExampleBackedEnum::id('CurrentlyActive'); // 101

$ids = ExampleBackedEnum::ids();

$label = ExampleBackedEnum::label('CurrentlyActive'); // 'Active'

$labels = ExampleBackedEnum::labels();

$metadata = ExampleBackedEnum::metadata('CurrentlyActive');

$metadatum = ExampleBackedEnum::metadatum();

$string = Str::splitConstantCase('CONSTANT_CASE'); // 'CONSTANT CASE'

$string = Str::splitEnumCase('EnumCase'); // 'Enum Case'

sh
# Result:
array:3 [▼
  0 => array:2 [▼
    "text" => "Active"
    "value" => 101
  ]
  1 => array:2 [▼
    "text" => "Pending"
    "value" => 102
  ]
  2 => array:2 [▼
    "text" => "Suspended (!)"
    "value" => 103
  ]
]

sh
# Result:
array:3 [▼
  "CurrentlyActive" => array:5 [▼
    "simpleValue" => 1
    "description" => "Active status indicating the resource is currently in use"
    "id" => 101
    "label" => "Active"
    "metadata" => array:2 [▶]
  ]
  "PendingReview" => array:5 [▼
    "simpleValue" => 2
    "description" => "Pending status indicating the resource is awaiting processing or approval"
    "id" => 102
    "label" => "Pending"
    "metadata" => "{"status_type": "neutral", "display_color": "yellow"}"
  ]
  "TemporarilySuspended" => array:5 [▼
    "simpleValue" => 3
    "description" => "Temporarily suspended status indicating the resource is on hold"
    "id" => 103
    "label" => "Suspended (!)"
    "metadata" => []
  ]
]

sh
# Result:
array:3 [▼
  "CurrentlyActive" => array:2 [▼
    "description" => "Active status indicating the resource is currently in use"
    "metadata" => array:2 [▶]
  ]
  "PendingReview" => array:2 [▼
    "description" => "Pending status indicating the resource is awaiting processing or approval"
    "metadata" => "{"status_type": "neutral", "display_color": "yellow"}"
  ]
  "TemporarilySuspended" => array:2 [▼
    "description" => "Temporarily suspended status indicating the resource is on hold"
    "metadata" => []
  ]
]

sh
# Result:
array:3 [▼
  0 => array:2 [▼
    "text" => "Active"
    "value" => 101
  ]
  1 => array:2 [▼
    "text" => "Pending"
    "value" => 102
  ]
  2 => array:2 [▼
    "text" => "Suspended (!)"
    "value" => 103
  ]
]

sh
# Result:
array:3 [▼
  "CurrentlyActive" => array:5 [▼
    "simpleValue" => 1
    "description" => "Active status indicating the resource is currently in use"
    "id" => 101
    "label" => "Active"
    "metadata" => array:2 [▼
      "status_type" => "positive"
      "display_color" => "green"
    ]
  ]
  "PendingReview" => array:5 [▼
    "simpleValue" => 2
    "description" => "Pending status indicating the resource is awaiting processing or approval"
    "id" => 102
    "label" => "Pending"
    "metadata" => "{"status_type": "neutral", "display_color": "yellow"}"
  ]
  "TemporarilySuspended" => array:5 [▼
    "simpleValue" => 3
    "description" => "Temporarily suspended status indicating the resource is on hold"
    "id" => 103
    "label" => "Suspended (!)"
    "metadata" => []
  ]
]

sh
# Result:
array:3 [▼
  "CurrentlyActive" => array:2 [▼
    "description" => "Active status indicating the resource is currently in use"
    "metadata" => array:2 [▼
      "status_type" => "positive"
      "display_color" => "green"
    ]
  ]
  "PendingReview" => array:2 [▼
    "description" => "Pending status indicating the resource is awaiting processing or approval"
    "metadata" => "{"status_type": "neutral", "display_color": "yellow"}"
  ]
  "TemporarilySuspended" => array:2 [▼
    "description" => "Temporarily suspended status indicating the resource is on hold"
    "metadata" => []
  ]
]