Перейти до вмісту

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