Atrybuty PHP

Wyświetl jako Markdown Edytuj w GitHub Dokumentacja: 2cc7b2b

Queuety obsługuje atrybuty PHP 8, które umożliwiają rejestrowanie handlerów bez konfiguracji. Oznacz klasy handlerów za pomocą #[QueuetyHandler] i użyj automatycznego wykrywania, aby zarejestrować je wszystkie naraz.

Atrybut `#[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 atrybutu:

Parametr	Typ	Wartość domyślna	Opis
`name`	`string`	(wymagany)	Nazwa handlera używana do wysyłania
`queue`	`string`	`'default'`	Domyślna kolejka dla tego handlera
`max_attempts`	`int`	`3`	Maksymalna liczba uruchomień przed odłożeniem zadania
`needs_wordpress`	`bool`	`false`	Przechowywane w atrybucie; Queuety obecnie tego nie odczytuje

Automatyczne wykrywanie

Przeskanuj katalog w poszukiwaniu oznaczonych klas handlerów i zarejestruj je wszystkie:

PHP

use Queuety\Queuety;

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

Skanuje to każdy plik .php w katalogu i jego podkatalogach, wyznacza nazwę każdej klasy na podstawie prefiksu przestrzeni nazw i ścieżki pliku, ładuje ją za pomocą autoloadera oraz rejestruje klasy, które mają atrybut #[QueuetyHandler] i implementują Handler, Step lub Contracts\Job.

Automatyczne wykrywanie przez CLI

Powłoka

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

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

Przykładowe dane wyjściowe:

Kod

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

Najlepsze praktyki

Rejestruj handlery podczas inicjalizacji swojej wtyczki:

PHP

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

Zastępuje to ręczne wywołania Queuety::register() dla każdego handlera. Nowe handlery są wykrywane automatycznie po dodaniu do katalogu klasy z tym atrybutem.

Łączenie z rejestracją ręczną

Handlery wykryte automatycznie i zarejestrowane ręcznie mogą współistnieć w tym samym rejestrze. Możesz stosować oba podejścia w jednym projekcie:

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