Prehľad API

Trait Helpers pridáva 19 statických a 11 inštančných metód. Metódy deklarované na vašom enume majú prednosť pred metódami traitu, takže každú z nich môžete prepísať — a natívne cases(), from() a tryFrom() z PHP zostávajú nedotknuté.

Statické metódy

Metóda	Vracia	Účel
`storable()`	`Collection<int, string\|int>`	Hodnoty backed enumu (pri čistom enume názvy prípadov) v poradí deklarácie.
`values()`	`Collection<int, string\|int>`	To isté ako storable().
`names()`	`Collection<int, string>`	Názvy prípadov v poradí deklarácie.
`labels()`	`Collection<int, string>`	readable() každého prípadu.
`collect()`	`Collection<int, self>`	Všetky prípady ako inštancie enumu.
`count()`	`int`	Počet prípadov.
`random()`	`static`	Náhodný prípad; na enume bez prípadov vyhodí EnumException.
`toOptions()`	`Collection<array-key, string>`	Mapa hodnota => popis pre selecty.
`toArray()`	`array<array-key, string>`	toOptions() ako obyčajné pole.
`options()`	`Collection<int, EnumOption>`	DTO {value, label, name} pre selecty v JS.
`presentations()`	`Collection<int, EnumPresentation>`	DTO {value, label, color} pre štítky, v poradí deklarácie.
`untranslated(?string $locale = null)`	`Collection<int, static>`	Prípady enumu s #[TranslatedLabels] bez riadku presne v danom jazyku; bez atribútu vyhodí EnumException.
`fromName(string $name)`	`static`	Prípad podľa názvu; pri nenájdení vyhodí EnumException.
`tryFromName(?string $name)`	`?static`	Prípad podľa názvu alebo null.
`fromLabel(string $label)`	`static`	Prípad podľa popisu; pri nenájdení vyhodí EnumException.
`tryFromLabel(?string $label)`	`?static`	Prípad podľa popisu alebo null.
`hasName(string $name)`	`bool`	Či existuje prípad s týmto názvom.
`hasValue(string\|int $value)`	`bool`	Či existuje prípad s touto hodnotou — pri čistom enume názvom (striktne).
`validationRule()`	`string`	Pravidlo in: pre Laravel z values(); hodnoty, ktoré by narušili jeho CSV syntax, dá do úvodzoviek.

Inštančné metódy

Metóda	Vracia	Účel
`readable()`	`string`	Riadok z #[TranslatedLabels], ak existuje, inak Str::headline() hodnoty (alebo názvu; int bez zmeny), vyhľadaný v prekladači.
`label()`	`string`	Alias readable() — prepisujte readable(), nie túto metódu.
`presentation()`	`EnumPresentation`	Prípad ako {value, label, color}.
`is(self $enum)`	`bool`	Či ide o daný prípad.
`isNot(self $enum)`	`bool`	Či nejde o daný prípad.
`isIn(array $enums)`	`bool`	Či je jedným z daných prípadov.
`isNotIn(array $enums)`	`bool`	Či nie je žiadnym z daných prípadov.
`whenIs(self $enum, Closure $callback, ?Closure $default = null)`	`self`	Pri splnení podmienky spustí $callback, inak voliteľný $default; vráti prípad.
`whenIsNot(self $enum, Closure $callback, ?Closure $default = null)`	`self`	Pri splnení podmienky spustí $callback, inak voliteľný $default; vráti prípad.
`whenIsIn(array $enums, Closure $callback, ?Closure $default = null)`	`self`	Pri splnení podmienky spustí $callback, inak voliteľný $default; vráti prípad.
`whenIsNotIn(array $enums, Closure $callback, ?Closure $default = null)`	`self`	Pri splnení podmienky spustí $callback, inak voliteľný $default; vráti prípad.

Atribút, rozhranie a DTO

#[TranslatedLabels(?string $group = null)] — RoundlyConsulting\Enums\Attributes\TranslatedLabels; pozri časť Popisy z prekladových súborov.
HasColor — RoundlyConsulting\Enums\Contracts\HasColor s jedinou metódou color(): string; pozri časť Farby štítkov a prezentácia.
EnumOption — value, label, name a toArray(); vracia ho options().
EnumPresentation — value, label, color, toArray() a jsonSerialize(); vracajú ho presentation() a presentations().

Prejavte lásku k open source

Tento balík je zadarmo pod licenciou MIT. Ak vám šetrí čas, jednorazový príspevok alebo členstvo na Patreone nám pomôže ho ďalej udržiavať, testovať a dokumentovať.

Ďalšie spôsoby podpory vrátane kryptomien

Odoslaním daru súhlasíte s našimi podmienkami prijímania darov.

Podporte našu open-source prácu Pridajte sa k nám na Patreone

Chcete to zabudovať do svojho produktu?

Naše balíky integrujeme do zákazkových Laravel a AI riešení. Napíšte nám, na čom pracujete, a ozveme sa do 48 hodín.

Ponuka do 48 hodín Prezrieť všetky balíky