Atributy PHP

Zobrazit jako Markdown Upravit na GitHub Dokumentace na 2cc7b2b

Queuety podporuje 8 atributů PHP pro registraci obslužných rutin bez konfigurace. Označte třídy obslužných rutin pomocí #[QueuetyHandler] a všechny je zaregistrujte najednou pomocí automatického vyhledávání.

Atribut `#[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 [];
    }
}

Parametry atributu:

Parametr	Typ	Výchozí hodnota	Popis
`name`	`string`	(povinné)	Název obslužné rutiny používaný k jejímu spuštění
`queue`	`string`	`'default'`	Výchozí fronta pro tuto obslužnou rutinu
`max_attempts`	`int`	`3`	Maximální počet spuštění, než se úloha odloží do úložiště nevyřízených úloh
`needs_wordpress`	`bool`	`false`	Uloženo v atributu; Queuety tuto hodnotu zatím nečte

Automatické vyhledávání

Prohledejte adresář, najděte třídy obslužných rutin s atributy a zaregistrujte je všechny:

PHP

use Queuety\Queuety;

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

Prohledá každý soubor .php v adresáři a jeho podadresářích, odvodí název každé třídy z předpony jmenného prostoru a cesty k souboru, načte ji pomocí automatického zavaděče a zaregistruje třídy, které mají atribut #[QueuetyHandler] a implementují Handler, Step nebo Contracts\Job.

Automatické vyhledávání přes 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

Ukázkový výstup:

Kód

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

Doporučený postup

Registrujte obslužné rutiny při inicializaci svého zásuvného modulu:

PHP

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

Tím nahradíte ruční volání Queuety::register() pro každou obslužnou rutinu. Nové obslužné rutiny se automaticky najdou po přidání třídy s příslušným atributem do adresáře.

Kombinace s ruční registrací

Automaticky nalezené a ručně registrované obslužné rutiny mohou být ve stejném registru. V jednom projektu můžete použít oba pří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 );