PHP属性

Markdownとして表示 GitHubで編集ドキュメント: 2cc7b2b

Queuetyは、設定不要でハンドラーを登録するためにPHPの8属性をサポートしています。ハンドラークラスに#[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 );