You are viewing the documentation for an older version of this package. You can check the version you are using with the following command:


                                    composer show spatie/enum

Enum Methods

__toString()

will return the enum value.

echo WeekDayEnum::make(1); // 'Montag'

will return the enum index and could be overridden to customize the index.

WeekDayEnum::monday()->getIndex(); // 1

will return all indices available on the enum.

WeekDayEnum::getIndices(); // [1, 2, 3, 4, 5, 6, 7]

will return the enum value and could be overridden to customize the value.

WeekDayEnum::monday()->getValue(); // 'Montag'

will return all values available on the enum.

WeekDayEnum::getValues(); // ['Montag', 'Dienstag', 'Mittwoch', 'Donnerstag', 'Freitag', 'Samstag', 'Sonntag']

will return true if the enum is equal with any of the given - otherwise false.

WeekDayEnum::monday()->isAny(['monday', 0]); // true

will return true if the enum is equal with the given - otherwise false.

WeekDayEnum::monday()->isEqual('tuesday'); // false

will return an instance of the enum - further details make enum.

will return an associative array with the value as key and the index as value.

WeekDayEnum::toArray(); // ['Montag' => 1, 'Dienstag' => 2, 'Mittwoch' => 3, 'Donnerstag' => 4, 'Freitag' => 5, 'Samstag' => 6, 'Sonntag' => 7]