PHPackages                             astandkaya/ex-enum - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. astandkaya/ex-enum

ActiveLibrary[Utility & Helpers](/categories/utility)

astandkaya/ex-enum
==================

Extend PHP Enum

v0.3.0(2w ago)01MITPHPPHP >=8.1CI passing

Since Jun 30Pushed 2w ago1 watchersCompare

[ Source](https://github.com/astandkaya/ex-enum)[ Packagist](https://packagist.org/packages/astandkaya/ex-enum)[ RSS](/packages/astandkaya-ex-enum/feed)WikiDiscussions master Synced 2w ago

READMEChangelogDependencies (11)Versions (4)Used By (0)

ExEnum
======

[](#exenum)

A tiny helper library that enriches PHP 8.1+ native `enum`
with **labels**, **tags**, and a handful of utility methods.

- **PHP ≥ 8.1** ‑ native `enum` required
- No external dependencies – pure PHP

---

Installation
------------

[](#installation)

```
composer require astandkaya/ex-enum
```

---

Quick Start
-----------

[](#quick-start)

```
use ExEnum\Attributes\Extension;
use ExEnum\Traits\HasExtension;

enum Suit: string
{
    /* 1. Add the trait */
    use HasExtension;

    /* 2. Decorate each case with #[Extension(...)] */
    #[Extension(
        label: 'ハート', // optional, default is case name
        tags: ['red'], // optional, default is `[]`
        order: 1, // optional, default is `0`
    )]
    case Hearts = 'hearts';

    #[Extension(
        label: 'ダイア',
        tags: ['red', 'not_hearts'],
        order: 2,
    )]
    case Diamonds = 'diamonds';

    #[Extension(
        label: 'クラブ',
        tags: ['black', 'not_hearts'],
        order: 3,
    )]
    case Clubs = 'clubs';

    #[Extension(
        label: 'スペード',
        tags: ['black', 'not_hearts'],
        order: -1,
    )]
    case Spades = 'spades';
}
```

Every `Suit` case now carries an **arbitrary label** (string) and **tags** (string\[\]),
plus your enum automatically gains dozens of helper methods 👇

---

Usage
-----

[](#usage)

### Locate a case by *name*

[](#locate-a-case-by-name)

```
Suit::fromName('Hearts');
// enum(Suit::Hearts)

Suit::tryFromName('Spades');
// enum(Suit::Hearts) or null
```

### Enumerate metadata

[](#enumerate-metadata)

```
Suit::names();
// array(4) {
//   [0]=>
//   string(6) "Hearts"
//   [1]=>
//   string(8) "Diamonds"
//   [2]=>
//   string(5) "Clubs"
//   [3]=>
//   string(6) "Spades"
// }

Suit::values();
// array(4) {
//   [0]=>
//   string(6) "hearts"
//   [1]=>
//   string(8) "diamonds"
//   [2]=>
//   string(5) "clubs"
//   [3]=>
//   string(6) "spades"
// }

Suit::labels();
// array(4) {
//   [0]=>
//   string(9) "ハート"
//   [1]=>
//   string(9) "ダイア"
//   [2]=>
//   string(9) "クラブ"
//   [3]=>
//   string(12) "スペード"
// }
```

### Filter cases by *tags*

[](#filter-cases-by-tags)

```
Suit::casesOnly(['not_hearts']);
// array(3) {
//   [0]=>
//   enum(Suit::Diamonds)
//   [1]=>
//   enum(Suit::Clubs)
//   [2]=>
//   enum(Suit::Spades)
// }

Suit::casesExcept(['red']);
// array(2) {
//   [0]=>
//   enum(Suit::Clubs)
//   [1]=>
//   enum(Suit::Spades)
// }
```

### Check if a case has a tag

[](#check-if-a-case-has-a-tag)

```
$card = Suit::Hearts;

$card->hasTag('red');
// bool(true)
$card->hasTag('not_hearts');
// bool(false)

$card->hasTags(['red', 'not_hearts']);
// bool(true)
$card->hasTags(['red', 'unknown']);
// bool(false)
```

### Sort cases by *order*

[](#sort-cases-by-order)

```
Suit::sortBy();
// array(4) {
//   [0]=>
//   enum(Suit::Spades)
//   [1]=>
//   enum(Suit::Hearts)
//   [2]=>
//   enum(Suit::Diamonds)
//   [3]=>
//   enum(Suit::Clubs)
// }

Suit::sortByAsc();
// array(4) {
//   [0]=>
//   enum(Suit::Spades)
//   [1]=>
//   enum(Suit::Hearts)
//   [2]=>
//   enum(Suit::Diamonds)
//   [3]=>
//   enum(Suit::Clubs)
// }

Suit::sortByDesc();
// array(4) {
//   [0]=>
//   enum(Suit::Clubs)
//   [1]=>
//   enum(Suit::Diamonds)
//   [2]=>
//   enum(Suit::Hearts)
//   [3]=>
//   enum(Suit::Spades)
// }
```

### Work with a single enum instance

[](#work-with-a-single-enum-instance)

```
$card = Suit::Hearts;

$card->label();
// string(9) "ハート"

$card->isHearts();
// bool(true)

$card->isDiamonds();
// bool(false)
```

### Cast array return values

[](#cast-array-return-values)

By default, methods like `casesOnly()` / `casesExcept()` / `sortBy()` / `map()` / `filter()` return plain PHP arrays.
`castArrayWith()` registers a closure that wraps the output — useful for converting to a Collection in Laravel.

```
// Laravel: In AppServiceProvider::boot()
Suit::castArrayWith(fn(array $cases) => collect($cases));

// All array-returning methods now return a Collection
Suit::casesOnly(['red']);                  // → Collection
Suit::casesExcept(['red']);               // → Collection
Suit::sortBy();                           // → Collection
Suit::map(fn($c) => $c->label());        // → Collection
Suit::filter(fn($c) => $c->hasTag('red')); // → Collection
```

> **Note:** `reduce()` is not affected as it does not return an array.

### Inject labels at runtime

[](#inject-labels-at-runtime)

`label()` can be overridden at runtime via a closure — useful for per-screen display names or when you prefer not to define labels in the `#[Extension]` attribute.

```
// In AppServiceProvider::boot() or a Controller — inject a resolver for all cases at once
Suit::injectLabels(function (Suit $case): string {
    return match ($case) {
        Suit::Hearts   => 'Cœur',
        Suit::Diamonds => 'Carreau',
        default        => $case->label(), // falls back to the original label without recursion
    };
});

$card = Suit::Hearts;
$card->label(); // string(5) "Cœur"

// Reset when no longer needed
Suit::resetLabels();

$card->label(); // string(9) "ハート"
```

> **Note:** The resolver persists for the lifetime of the PHP process. Call `resetLabels()` explicitly when the override should only apply to a limited scope.

### Utility methods

[](#utility-methods)

```
Suit::map(fn(Suit $suit) => $suit->label());
// array(4) {
//   [0]=>
//   string(9) "ハート"
//   [1]=>
//   string(9) "ダイア"
//   [2]=>
//   string(9) "クラブ"
//   [3]=>
//   string(12) "スペード"
// }

Suit::reduce(fn(string $carry, Suit $suit) => $carry . $suit->label(), '');
// string(39) "ハートダイアクラブスペード"

Suit::filter(fn(Suit $suit) => $suit->hasTag('red'));
// array(2) {
// [0]=>
// enum(Suit::Hearts)
// [1]=>
// enum(Suit::Diamonds)
// }
```

Future implementation plans
---------------------------

[](#future-implementation-plans)

MethodReturnsDescription`Suit::random()``static`Pick a random case`Suit::toArray()`array `[name => value, …]`Enum to associative array`Suit::jsonSerialize()`same as `toArray()`JSON-ready representation

###  Health Score

37

—

LowBetter than 81% of packages

Maintenance97

Actively maintained with recent releases

Popularity2

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity38

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~198 days

Total

3

Last Release

17d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/118503951?v=4)[ast.](/maintainers/astandkaya)[@astandkaya](https://github.com/astandkaya)

---

Top Contributors

[![astandkaya](https://avatars.githubusercontent.com/u/118503951?v=4)](https://github.com/astandkaya "astandkaya (16 commits)")

###  Code Quality

TestsPest

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/astandkaya-ex-enum/health.svg)

```
[![Health](https://phpackages.com/badges/astandkaya-ex-enum/health.svg)](https://phpackages.com/packages/astandkaya-ex-enum)
```

###  Alternatives

[zoujingli/ip2region

PHP IP 地理位置查询库，基于 ip2region XDB，支持 IPv4/IPv6、内置 IPv4 数据库、IPv6 按需下载和多种缓存策略

1.4k491.4k71](/packages/zoujingli-ip2region)[lara-zeus/bolt

Zeus Bolt is form builder for your users, with so many use cases

24452.3k3](/packages/lara-zeus-bolt)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)