PHPackages                             stanislavge/laravel-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. stanislavge/laravel-enum

ActiveLibrary

stanislavge/laravel-enum
========================

Elegant Enum implementation for Laravel. With make:enum command, ability to casting for Eloquent models and labels translations via lang files.

022PHP

Since Jul 24Pushed 1y ago1 watchersCompare

[ Source](https://github.com/StanislavGe/laravel-enum)[ Packagist](https://packagist.org/packages/stanislavge/laravel-enum)[ RSS](/packages/stanislavge-laravel-enum/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Elegant Enum implementation for Laravel
=======================================

[](#elegant-enum-implementation-for-laravel)

[![Latest Version on Packagist](https://camo.githubusercontent.com/50d17e4564d3b6e92e10ecb5be28c537b258a6bd2e90c8dde80511af7edbfbe8/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d61642d7765622f6c61726176656c2d656e756d2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/mad-web/laravel-enum)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Build Status](https://github.com/mad-web/laravel-enum/workflows/tests/badge.svg)](https://github.com/mad-web/laravel-enum/actions)[![StyleCI](https://camo.githubusercontent.com/626520cb30686f7fb2cf91090b04ffa2ffb001a4c33763d092b69557a98b7637/68747470733a2f2f7374796c6563692e696f2f7265706f732f3133383439373934382f736869656c64)](https://styleci.io/repos/138497948)[![Coverage Status](https://camo.githubusercontent.com/ae0971768fd6921afe45f5373f93cf0c0e945e3e363593a3e7a0e3ff39cf52ba/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f636f7665726167652f672f6d61642d7765622f6c61726176656c2d656e756d2e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/mad-web/laravel-enum/code-structure)[![Quality Score](https://camo.githubusercontent.com/a9bcdf7ec1e06a49b2b7cf04e5db1f95f77de1c04aa4bf3dacf443ce91cddbae/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f6d61642d7765622f6c61726176656c2d656e756d2e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/mad-web/laravel-enum)[![Total Downloads](https://camo.githubusercontent.com/403b35b118bd4772962e5d466fa2d6cf9cba01c2a1b61eeec0d41457b5403c5d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6d61642d7765622f6c61726176656c2d656e756d2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/mad-web/laravel-enum)

Based on [MyCLabs PHP Enum](https://github.com/myclabs/php-enum) and implements [SplEnum](http://php.net/manual/ru/class.splenum.php) interface.

You could find documentation for base features in [PHP Enum Readme](https://github.com/myclabs/php-enum/blob/master/README.md).

Features:

- `make:enum` command
- ability to cast enum fields for Eloquent models
- labels translation via lang files
- simple validation rule

Simple Enum Example
-------------------

[](#simple-enum-example)

```
namespace App\Enums;

use MadWeb\Enum\Enum;

/**
 * @method static PostStatusEnum FOO()
 * @method static PostStatusEnum BAR()
 * @method static PostStatusEnum BAZ()
 */
final class PostStatusEnum extends Enum
{
    const __default = self::PENDING;

    const PUBLISHED = 'published';
    const PENDING = 'pending';
    const DRAFT = 'draft';
}
```

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

[](#installation)

For **Laravel < 7** version - use [1.0 branch](https://github.com/mad-web/laravel-enum/tree/1.0).

You can install the package via composer:

```
composer require mad-web/laravel-enum
```

Usage
-----

[](#usage)

Make new Enum class via artisan command:

```
php artisan make:enum PostStatusEnum
```

to populate Enum with your own values, pass it after `name` argument:

```
php artisan make:enum PostStatusEnum DRAFT=draft PENDING=pending PUBLISHED=published
```

Create instance of Enum class

```
$status = new PostStatusEnum(PostStatusEnum::PENDING);

// or just use magic static method
$status = PostStatusEnum::PENDING();
```

Enums support native [Custom Casts](https://laravel.com/docs/7.x/eloquent-mutators#custom-casts) feature out of the box. Specify Enum class for attribute in `$casts` array:

```
class Post extends Model
{
    protected $fillable = ['title', 'status'];

    protected $casts = [
        'status' => PostStatusEnum::class,
    ];
}
```

after that you could get and set enum field using enum classes

```
$post = Post::first();

$status = $post->status; // PostStatusEnum

$post->status = PostStatusEnum::PENDING();

$post->save();
```

### Enum values labels (Localization)

[](#enum-values-labels-localization)

Create `enums.php` lang file and declare labels for enum values

```
// resources/lang/en/enums.php

return [
    PostStatusEnum::class => [
        PostStatusEnum::PENDING => 'Pending Label',
        PostStatusEnum::PUBLISHED => 'Published Label',
        PostStatusEnum::DRAFT => 'Draft Label',
    ],
];
```

and get a label

```
PostStatusEnum::PENDING()->label(); // Pending Label
```

---

To override default enum lang file path, publish `laravel-enum` config

```
php artisan vendor:publish --provider=MadWeb\\Enum\\EnumServiceProvider
```

and change `lang_file_path` option

```
// config/enum.php

return [
    'lang_file_path' => 'custom.path.to.enums',
];
```

### Validation Rule

[](#validation-rule)

You may validate an enum value from a request by using the `EnumRule` class or `Enum::rule()` method.

```
public function store(Request $request)
{
    $this->validate($request, [
        'status' => ['required', new EnumRule(PostStatusEnum::class)],
    ]);

    // OR

    $this->validate($request, [
        'status' => ['required', PostStatusEnum::rule()],
    ]);
}
```

If you want to validate an enum key instead of an enum value you can by specifying you want to validate against the key instead of the value.

```
public function store(Request $request)
{
    $this->validate($request, [
        'status' => ['required', new EnumRule(PostStatusEnum::class, true)],
    ]);

    // OR

    $this->validate($request, [
        'status' => ['required', PostStatusEnum::ruleByKey()],
    ]);
}
```

---

To customize validation message, add `enum` key to validation lang file

```
// resources/lang/en/validation.php
return [
    //...
    'enum' => 'Custom validation message form enum attribute :attribute',
];
```

Additional methods
------------------

[](#additional-methods)

### getRandomKey(): string

[](#getrandomkey-string)

Returns a random key from the enum.

```
PostStatusEnum::getRandomKey(); // Returns 'PUBLISHED` or `PENDING` or `DRAFT`
```

### getRandomValue()

[](#getrandomvalue)

Returns a random value from the enum.

```
PostStatusEnum::getRandomValue(); // Returns 'published` or `pending` or `draft`
```

### label(): string

[](#label-string)

Returns label for the enum value object

```
PostStatusEnum::PUBLISHED()->label(); // Returns 'published` or custom label declared in a lang file
```

### labels(): array

[](#labels-array)

Returns all labels for a enum

```
PostStatusEnum::labels(); // Returns ['published`, 'pending', 'draft'] or array of custom labels declared in a lang file
```

### is($value): bool

[](#isvalue-bool)

Checks whether the current enum value is equal to a given enum

```
$status = PostStatusEnum::PENDING();

PostStatusEnum::PUBLISHED()->is($status); // false

PostStatusEnum::PENDING()->is($status); // true

// or

PostStatusEnum::PUBLISHED()->is($status->getValue()); // false

PostStatusEnum::PENDING()->is($status->getValue()); // true

// or check one of multiple values

$status->is([PostStatusEnum::DRAFT(), PostStatusEnum::PUBLISHED()]) // false

$status->is([PostStatusEnum::DRAFT(), PostStatusEnum::PENDING()]) // true
```

### rule(): EnumRule

[](#rule-enumrule)

Returns instance of validation rule class for the Enum

```
PostStatusEnum::rule(); // new EnumRule(PostStatusEnum::class);
```

### getConstList(bool $include\_default = false): array

[](#getconstlistbool-include_default--false-array)

Returns all consts (possible values) as an array according to [SplEnum::getConstList](http://php.net/manual/en/splenum.getconstlist.php)

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Testing
-------

[](#testing)

```
composer test
```

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE\_OF\_CONDUCT](CODE_OF_CONDUCT.md) for details.

Credits
-------

[](#credits)

- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

15

—

LowBetter than 3% of packages

Maintenance28

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity17

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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/a5ba76abd4fbaa3b49ff56b88cc87e016be5f9000080364f3fb6316186ebccab?d=identicon)[StanislavGe](/maintainers/StanislavGe)

---

Top Contributors

[![StanislavGe](https://avatars.githubusercontent.com/u/87075457?v=4)](https://github.com/StanislavGe "StanislavGe (5 commits)")

### Embed Badge

![Health badge](/badges/stanislavge-laravel-enum/health.svg)

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

PHPackages © 2026

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