Перейти к содержимому

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