Skupiny nastavení

Skupina spája súvisiace nastavenia pre obrazovku nastavení alebo administráciu. Uvádza triedy svojich členov; všetko ostatné má rozumné predvolené hodnoty:

namespace App\Settings;

use RoundlyConsulting\Options\Groups\OptionGroup;

final class AppearanceSettings extends OptionGroup
{
    public function label(): string { return 'Appearance'; }

    public function description(): ?string { return 'Look and feel.'; }

    /** @return list<class-string<\RoundlyConsulting\Options\OptionInterface>> */
    public function options(): array
    {
        return [LocaleOption::class, ThemeOption::class];
    }
}

Čítanie a zápis skupiny

use RoundlyConsulting\Options\Facades\Options;

// Resolve current values, keyed by option key:
Options::group(AppearanceSettings::class)->for($user)->all();
// ['locale' => 'en', 'theme' => 'dark']

// Bulk write by option key or class-string — all or nothing, like setMany(): every value is
// authorized and validated before the first write, and the writes share a transaction
// (then cast, events + observers fire):
Options::group(AppearanceSettings::class)->for($user)->set([
    'theme'             => 'dark',
    LocaleOption::class => 'sk',
]);

// The owner can also be the second argument; options() returns ordered instances:
Options::group(AppearanceSettings::class, $user)->options();

all() vráti aktuálne hodnoty podľa kľúča nastavenia. set() prijme kľúče nastavení aj class-stringy a podobne ako setMany() funguje systémom všetko alebo nič: každá hodnota sa autorizuje a overí ešte pred prvým zápisom a zápisy zdieľajú jednu transakciu — potom platia casty, eventy aj observery. Identifikátor, ktorý do skupiny nepatrí, vyhodí InvalidOptionGroup.

Definície pre UI

definition() vráti GroupDefinition so všetkým, čo formulár potrebuje:

$page = Options::group(AppearanceSettings::class)->for($user)->definition();

$page->key;           // 'appearance-settings'
$page->label;         // 'Appearance'
$page->description;   // 'Look and feel.'

foreach ($page->options as $field) {
    $field->key;          // 'theme'
    $field->optionClass;  // ThemeOption::class
    $field->label;        // 'Theme'
    $field->help;         // ?string
    $field->section;      // ?string
    $field->order;        // int
    $field->type;         // the castAs() string, or 'custom' for a cast instance
    $field->encrypted;    // bool
    $field->current;      // the resolved value for this scope
    $field->default;      // the declared default
}

Polia sú zoradené podľa order() vzostupne a potom podľa poradia deklarácie. definition() načíta aktuálnu hodnotu každého člena — jedno čítanie na nastavenie a pri zapnutom OptionResolved aj jeden event — čo je pre administráciu v poriadku.

Metadáta pre zobrazenie

Nastavenia môžu prepísať metadáta, ktoré definition() používa; všetky majú rozumné predvolené hodnoty:

public function label(): string    { return 'UI Theme'; }
public function help(): ?string    { return 'Light or dark.'; }
public function section(): ?string { return 'general'; }
public function order(): int       { return 10; }

Kľúče skupín a generovanie

Vlastný key() skupiny je predvolene názov triedy v kebab-case. Ak chcete na skupinu odkazovať krátkym kľúčom, namapujte ju v options.groups:

// config/options.php
'groups' => [
    'appearance' => App\Settings\AppearanceSettings::class,
],

// anywhere
Options::group('appearance')->for($user)->all();

make:option-group vytvorí skupinu v app/Settings; --options vopred vyplní zoznam členov:

php artisan make:option-group AppearanceSettings --options="App\Options\ThemeOption,App\Options\LocaleOption"

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