Pluginy

Plugin sdružuje opakovaně použitelné nastavení na jedno místo: makra, registry typů, query pipes, callbacky hooků, výchozí konfiguraci a integraci balíčku. Je to podporovaná cesta, jak aplikace nebo doprovodný balíček změní chování frameworku — a první otázka na téhle stránce je, jestli ho vůbec potřebujete, protože closure, event nebo makro bývají menší odpověď.

Pro jednu tabulku, formulář nebo akci nejdřív preferujte veřejné fluent API. Plugin použijte, když se má stejné chování nainstalovat jednou a znovupoužít napříč více komponentami, projekty nebo balíčky.

Kdy použít plugin

Hook, event, makro nebo callback

Tenhle stack má čtyři způsoby, jak změnit chování, a který z nich sáhnout rozhoduje jediná otázka: kdo drží referenci na komponentu?

Kde pro jeden okamžik existuje hook i event — action.executing a ActionExecuting se spouští deset řádků od sebe — je event ta pozorovací půlka. Audit, telemetrie a metriky patří tam; změna toho, co se provede, patří do hooku.

Praktický případ třetího řádku je modul nainstalovaný z balíčku: jeho list se staví uvnitř kódu, který aplikace nevlastní, takže sloupec se přidá hookem table.composing, ne poděděním resource — to by stejně kolidovalo na klíči.

Co plugin může dělat

Rychlý start

Vytvořte třídu pluginu:

<?php
 
namespace App\Wire\Plugins;
 
use Illuminate\Database\Eloquent\Builder;
use NyonCode\WireCore\Core\Plugin\Contracts\Plugin;
use NyonCode\WireCore\Core\Plugin\PluginManager;
use NyonCode\WireTable\Table;
 
final class TenantPlugin implements Plugin
{
    public function getId(): string
    {
        return 'tenant';
    }
 
    public function register(PluginManager $manager): void
    {
        //
    }
 
    public function boot(PluginManager $manager): void
    {
        Table::macro('tenantScoped', function (?int $tenantId = null): static {
            $tenantId ??= auth()->user()?->tenant_id;
 
            return $this->modifyQueryUsing(
                fn (Builder $query) => $query->where('tenant_id', $tenantId)
            );
        });
    }
}

Zaregistrujte ho v config/wire-core.php:

'plugins' => [
    App\Wire\Plugins\TenantPlugin::class,
],

Použijte makro z jakékoli tabulky:

public function table(Table $table): Table
{
    return $table
        ->model(Order::class)
        ->tenantScoped()
        ->columns([
            // ...
        ]);
}

Kontrakt pluginu

Každý plugin implementuje NyonCode\WireCore\Core\Plugin\Contracts\Plugin.

<?php
 
namespace App\Wire\Plugins;
 
use NyonCode\WireCore\Core\Plugin\Contracts\Plugin;
use NyonCode\WireCore\Core\Plugin\PluginManager;
 
final class ExamplePlugin implements Plugin
{
    public function getId(): string
    {
        return 'example';
    }
 
    public function register(PluginManager $manager): void
    {
        // Zaregistrovat hooky, query pipes, aliasy typů nebo lehká metadata.
    }
 
    public function boot(PluginManager $manager): void
    {
        // Zaregistrovat makra nebo resolvovat služby po registraci všech pluginů.
    }
}

Hodnota getId() musí být unikátní. Registrace dvou pluginů se stejným ID vyhodí RuntimeException.

Životní cyklus

PluginManager::register() volá metodu register() pluginu okamžitě. PluginManager::boot() spustí metodu boot() každého pluginu jednou a uzavře registraci: plugin nabídnutý potom se odmítne, místo aby se přijal do seznamu, který už nikdo nečte.

Držte register() lehké. Neresolvujte request-scoped služby ani nepředpokládejte, že už každá Laravel služba bootla. boot() použijte pro práci, která potřebuje container, pohledy, makra nebo jiné registrované pluginy.

PluginManager API

Best practices

• Používejte stabilní, malými písmeny plugin ID jako tenant, audit-export nebo acme-billing.
• Držte register() lehké; neresolvujte tam request-scoped služby.
• Laravel makra a service-závislé nastavení dejte do boot().
• Pro jednorázové chování preferujte table/form/action fluent API.
• Vraťte payload pole z array hook callbacků, když chcete upravit data hooku.
• Používejte priority hooků střídmě a dokumentujte, proč callback musí běžet dřív nebo později.
• Zabezpečte registraci balíčku pomocí PluginManager::has(), abyste předešli duplicitním ID.

V této sekci

Související

• Moduly — byznysová oblast deklarovaná jako plugin
• Foundation — concerny, do kterých plugin registruje
• Konfigurace — kde se deklaruje plugins
• Vlastní pole — druhá cesta rozšíření, pro jednu komponentu