Атрибути PHP

Преглед като Markdown Редактиране в GitHub Документация за 2cc7b2b

Queuety поддържа 8 атрибута PHP за регистрация на обработващи функции без конфигурация. Анотирайте класовете на обработващите функции с #[QueuetyHandler] и използвайте автоматично откриване, за да ги регистрирате наведнъж.

Атрибутът `#[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 [];
    }
}

Параметри на атрибута:

Параметър	Тип	Стойност по подразбиране	Описание
`name`	`string`	(задължително)	Име на обработващата функция, използвано за изпращане
`queue`	`string`	`'default'`	Опашка по подразбиране за тази обработваща функция
`max_attempts`	`int`	`3`	Максимален брой изпълнения, преди заданието да бъде заровено
`needs_wordpress`	`bool`	`false`	Съхранява се в атрибута; Queuety не го чете към момента

Автоматично откриване

Сканирайте директория за анотирани класове на обработващи функции и ги регистрирайте всички:

PHP

use Queuety\Queuety;

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

Това сканира всеки файл .php в директорията и нейните поддиректории, извежда името на всеки клас от префикса на пространството от имена и пътя до файла, зарежда го чрез автозареждача ви и регистрира класовете, които имат атрибута #[QueuetyHandler] и реализират Handler, Step или Contracts\Job.

Автоматично откриване чрез CLI

Обвивка

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

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

Примерен изход:

Код

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

Добри практики

Регистрирайте обработващите функции при инициализиране на приставката си:

PHP

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

Това заменя ръчните извиквания на Queuety::register() за всяка обработваща функция. Новите обработващи функции се откриват автоматично, когато добавите клас с атрибута в директорията.

Комбиниране с ръчна регистрация

Автоматично откритите и ръчно регистрираните обработващи функции съществуват съвместно в един и същ регистър. Можете да използвате и двата подхода в един проект:

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