Preskočiť na obsah

Atribúty PHP

Zobraziť ako Markdown Upraviť na GitHub Dokumentácia na 2cc7b2b

Queuety podporuje 8 atribútov PHP na registráciu obslužných tried bez konfigurácie. Označte svoje obslužné triedy pomocou #[QueuetyHandler] a zaregistrujte ich všetky naraz pomocou automatického vyhľadávania.

Atribút #[QueuetyHandler]

PHP
use Queuety\Handler;
use Queuety\Attributes\QueuetyHandler;

#[QueuetyHandler( name: 'send_email', queue: 'emails', max_attempts: 5 )]
class SendEmailHandler implements Handler {
    public function handle( array $payload ): void {
        wp_mail( $payload['to'], $payload['subject'], $payload['body'] );
    }

    public function config(): array {
        return [];
    }
}

Parametre atribútu:

Parameter Typ Predvolená hodnota Opis
name string (required) Názov obslužnej triedy používaný na jej odoslanie
queue string 'default' Predvolený front pre túto obslužnú triedu
max_attempts int 3 Maximálny počet behov pred presunutím úlohy do archívu
needs_wordpress bool false Uložené v atribúte; Queuety túto hodnotu zatiaľ nenačítava

Automatické vyhľadávanie

Vyhľadajte v adresári označené obslužné triedy a všetky ich zaregistrujte:

PHP
use Queuety\Queuety;

$count = Queuety::discover_handlers(
    __DIR__ . '/handlers',  // directory to scan
    'MyPlugin\\Handlers'    // PSR-4 namespace prefix
);
// $count = number of handlers registered

Prehľadá každý súbor .php v adresári a jeho podadresároch, odvodí názov každej triedy z predpony menného priestoru a cesty k súboru, načíta ju cez váš automatický načítavač a zaregistruje triedy, ktoré majú atribút #[QueuetyHandler] a implementujú Handler, Step alebo Contracts\Job.

Automatické vyhľadávanie cez CLI

Shell
# Preview discovered handlers
wp queuety discover /path/to/handlers MyPlugin\\Handlers

# Discover and register
wp queuety discover /path/to/handlers MyPlugin\\Handlers --register

Príklad výstupu:

Kód
+-----------------------------------+----------+------------+
| class                             | type     | name       |
+-----------------------------------+----------+------------+
| MyPlugin\Handlers\SendEmailHandler | handler  | send_email |
| MyPlugin\Handlers\SyncDataHandler  | handler  | sync_data  |
| MyPlugin\Handlers\BuildPromptStep  | step     | (none)     |
+-----------------------------------+----------+------------+

Odporúčaný postup

Registrujte obslužné triedy počas inicializácie svojho pluginu:

PHP
add_action( 'plugins_loaded', function () {
    Queuety::discover_handlers(
        __DIR__ . '/src/Handlers',
        'MyPlugin\\Handlers'
    );
} );

Tým sa nahradia manuálne volania Queuety::register() pre každú obslužnú triedu. Nové obslužné triedy sa automaticky nájdu po pridaní triedy s atribútom do adresára.

Kombinácia s manuálnou registráciou

Automaticky vyhľadané a manuálne registrované obslužné triedy môžu existovať v tom istom registri. V jednom projekte môžete použiť oba prístupy:

PHP
// Auto-discover the bulk of handlers
Queuety::discover_handlers( __DIR__ . '/handlers', 'MyPlugin\\Handlers' );

// Manually register a handler without the attribute
Queuety::register( 'legacy_handler', LegacyHandler::class );