Atributi PHP

Prikaži kot Markdown Uredi na GitHub Dokumentacija za 2cc7b2b

Queuety podpira atribute PHP 8 za registracijo obravnavalnikov brez nastavitev. Razrede obravnavalnikov označite z #[QueuetyHandler] in jih vse registrirajte hkrati s samodejnim odkrivanjem.

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

Parametri atributa:

Parameter	Vrsta	Privzeto	Opis
`name`	`string`	(obvezno)	Ime obravnavalnika, uporabljeno za sprožitev
`queue`	`string`	`'default'`	Privzeta čakalna vrsta za ta obravnavalnik
`max_attempts`	`int`	`3`	Največje število izvedb, preden je opravilo umaknjeno
`needs_wordpress`	`bool`	`false`	Shranjeno v atributu; Queuety tega trenutno ne bere

Samodejno odkrivanje

Preglejte imenik za označene razrede obravnavalnikov in jih vse registrirajte:

PHP

use Queuety\Queuety;

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

Ta postopek pregleda vsako datoteko .php v imeniku in njegovih podimenikih, iz predpone imenskega prostora in poti do datoteke določi ime vsakega razreda, ga naloži prek samodejnega nalagalnika ter registrira razrede, ki imajo atribut #[QueuetyHandler] in implementirajo Handler, Step ali Contracts\Job.

Samodejno odkrivanje prek CLI

Lupina

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

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

Primer izhoda:

Koda

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

Priporočena praksa

Obravnavalnike registrirajte med inicializacijo vtičnika:

PHP

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

S tem nadomestite ročne klice Queuety::register() za vsak obravnavalnik. Novi obravnavalniki bodo samodejno zaznani, ko v imenik dodate razred z atributom.

Kombiniranje z ročno registracijo

Samodejno odkriti in ročno registrirani obravnavalniki lahko soobstajajo v istem registru. V istem projektu lahko uporabite oba pristopa:

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