PHP attribútumok

Megtekintés Markdownként Szerkesztés itt: GitHub Dokumentáció itt: 2cc7b2b

A Queuety támogatja a PHP 8 attribútumot a kezelők konfiguráció nélküli regisztrálásához. Jelöld meg a kezelőosztályokat a #[QueuetyHandler] attribútummal, majd az automatikus felderítéssel regisztráld őket egyszerre.

A `#[QueuetyHandler]` attribútum

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

Az attribútum paraméterei:

Paraméter	Típus	Alapértelmezés	Leírás
`name`	`string`	(kötelező)	A diszpécseléshez használt kezelőnév
`queue`	`string`	`'default'`	A kezelő alapértelmezett sora
`max_attempts`	`int`	`3`	A feladat elrejtése előtti futtatások maximális száma
`needs_wordpress`	`bool`	`false`	Az attribútum tárolja; a Queuety jelenleg nem olvassa be

Automatikus felderítés

Vizsgálj át egy könyvtárat a megjelölt kezelőosztályokért, majd regisztráld őket:

PHP

use Queuety\Queuety;

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

A rendszer átvizsgálja a könyvtárban és az alkönyvtáraiban található összes .php fájlt, a névtérprefix és a fájlútvonal alapján levezeti az egyes osztályneveket, betölti őket az automatikus betöltővel, majd regisztrálja a #[QueuetyHandler] attribútummal ellátott és a Handler, Step vagy Contracts\Job interfészt megvalósító osztályokat.

Automatikus felderítés a CLI segítségével

Shell

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

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

Példa a kimenetre:

Kód

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

Javasolt gyakorlat

A kezelőket a bővítmény inicializálásakor regisztráld:

PHP

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

Ezzel elhagyhatók az egyes kezelőkhöz tartozó kézi Queuety::register() hívások. Ha attribútummal ellátott osztályt adsz a könyvtárhoz, az új kezelő automatikusan bekerül a rendszerbe.

Kézi regisztrálással együtt használva

Az automatikusan felderített és a kézzel regisztrált kezelők ugyanabban a nyilvántartásban szerepelhetnek. A két megközelítést egyazon projektben is használhatod:

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