Attributi PHP

Visualizza come Markdown Modifica su GitHub Documentazione di 2cc7b2b

Queuety supporta gli attributi PHP 8 per registrare i gestori senza configurazione. Annotate le classi dei gestori con #[QueuetyHandler] e usate il rilevamento automatico per registrarli tutti insieme.

L’attributo `#[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 [];
    }
}

Parametri dell’attributo:

Parametro	Tipo	Predefinito	Descrizione
`name`	`string`	(obbligatorio)	Nome del gestore usato per l’instradamento
`queue`	`string`	`'default'`	Coda predefinita per questo gestore
`max_attempts`	`int`	`3`	Numero massimo di esecuzioni prima che il job venga messo da parte
`needs_wordpress`	`bool`	`false`	Memorizzato nell’attributo; oggi Queuety non lo legge

Rilevamento automatico

Esaminate una directory per trovare le classi di gestori annotate e registratele tutte:

PHP

use Queuety\Queuety;

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

Esamina ogni file .php nella directory e nelle sue sottodirectory, ricava il nome di ogni classe dal prefisso dello spazio dei nomi e dal percorso del file, la carica tramite l’autoloader e registra le classi che hanno l’attributo #[QueuetyHandler] e implementano Handler, Step o Contracts\Job.

Rilevamento automatico tramite 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

Output di esempio:

Codice

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

Buone pratiche

Registrate i gestori durante l’inizializzazione del plugin:

PHP

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

In questo modo si evitano chiamate manuali a Queuety::register() per ogni gestore. I nuovi gestori vengono rilevati automaticamente quando aggiungete alla directory una classe con l’attributo.

Combinare con la registrazione manuale

I gestori rilevati automaticamente e quelli registrati manualmente coesistono nello stesso registro. Potete usare entrambi gli approcci nello stesso progetto:

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 );