Comparing enums | enum | Spatie

 SPATIE

enum
====

spatie.be/open-source

  [Docs](https://spatie.be/docs)  [Enum](https://spatie.be/docs/enum/v3)  Usage  Comparing enums

 Version   v3   v2   v1

 Other versions for crawler [v3](https://spatie.be/docs/enum/v3) [v2](https://spatie.be/docs/enum/v2) [v1](https://spatie.be/docs/enum/v1)

- [ Introduction ](https://spatie.be/docs/enum/v3/introduction)
- [ Postcardware ](https://spatie.be/docs/enum/v3/postcardware)
- [ Installation and setup ](https://spatie.be/docs/enum/v3/installation-and-setup)
- [ Questions & issues ](https://spatie.be/docs/enum/v3/questions-and-issues)
- [ Changelog ](https://spatie.be/docs/enum/v3/changelog)
- [ About us ](https://spatie.be/docs/enum/v3/about-us)

Usage
-----

- [ Internal enum values ](https://spatie.be/docs/enum/v3/usage/2-internal-enum-values)
- [ Overriding enum values ](https://spatie.be/docs/enum/v3/usage/3-overriding-enum-values)
- [ Overriding enum labels ](https://spatie.be/docs/enum/v3/usage/4-overriding-enum-labels)
- [ Comparing enums ](https://spatie.be/docs/enum/v3/usage/5-comparing-enums)
- [ Laravel ](https://spatie.be/docs/enum/v3/usage/100-laravel)

 Comparing enums
===============

Enums can be compared using the `equals` method:

```
$status->equals(StatusEnum::draft());
```

You can pass several enums to the `equals` method, it will return `true` if the current enum equals one of the given values.

```
$status->equals(StatusEnum::draft(), StatusEnum::archived());
```

Take note that only enum objects are allowed in the equals method. You're not allowed to compare enum objects to serialized enum values.