PHP-attribut

Visa som Markdown Redigera på GitHub Dokumentation på 2cc7b2b

Queuety stöder attribut i PHP 8 för registrering av hanterare utan konfiguration. Märk upp dina hanterarklasser med #[QueuetyHandler] och använd automatisk identifiering för att registrera dem alla på en gång.

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

Attributets parametrar:

Parameter	Typ	Standard	Beskrivning
`name`	`string`	(required)	Hanterarnamn som används för utskick
`queue`	`string`	`'default'`	Standardkö för den här hanteraren
`max_attempts`	`int`	`3`	Högsta antal körningar innan jobbet läggs undan
`needs_wordpress`	`bool`	`false`	Sparas i attributet; Queuety läser det inte i dagsläget

Automatisk identifiering

Sök igenom en katalog efter märkta hanterarklasser och registrera dem alla:

PHP

use Queuety\Queuety;

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

Detta söker igenom varje .php-fil i katalogen och dess underkataloger, härleder varje klassnamn från namnrymdsprefixet och filsökvägen, laddar det via din autoladdare och registrerar klasser som har attributet #[QueuetyHandler] och implementerar Handler, Step eller Contracts\Job.

Automatisk identifiering via 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

Exempel på utdata:

Kod

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

Bästa praxis

Registrera hanterare vid initieringen av ditt plugin:

PHP

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

Detta ersätter manuella anrop till Queuety::register() för varje hanterare. Nya hanterare hämtas automatiskt när du lägger till en klass med attributet i katalogen.

Kombinera med manuell registrering

Automatiskt identifierade hanterare och manuellt registrerade hanterare fungerar sida vid sida i samma register. Du kan använda båda metoderna i samma projekt:

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