bitrix-controllers について
Bitrix 開発者向けのリファレンススキルです。コントローラーのアクション、フィルター、レスポンス、REST v3 の規則に加え、バージョン差や注意点をまとめています。
主な機能
- 01コントローラーとアクションの規則
- 02フィルター設定の指針
- 03エラーとレスポンスの処理
- 04REST v3 の解説
- 05バージョン互換性の注意点
活用シーン
- 01Bitrix コントローラーアクションの実装
- 02カーネルのバージョンに応じたフィルター設定
- 03ルートや REST の問題の調査
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ bxmaximum/ bitrix-framework-skills --skill bitrix-controllersインストール後、Claude Code で/bitrix-controllersを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
rules/basics.mderrors-response.mdfilters.md詳細
Bitrix コントローラー
基準:main 23.0+ · 検証済み:main 26.800.0
| タスク | 参照先 |
|---|---|
| ファイル、アクション名、最小構成のコントローラー、自動注入パラメーター、PageNavigation | rules/basics.md |
デフォルトのプリフィルター、フィルター属性、configureActions()、#[ActionAccess]、カスタムフィルター | rules/filters.md |
エラー、JSON エンベロープ、レスポンスクラス、renderView()、スコープ、REST v3 | rules/errors-response.md |
不変条件
- アクションの役割はオーケストレーションのみです:入力 → サービス →
Result→ データまたはaddErrors()。サービスはアクションのパラメーターとして受け取ります(DI の規範:bitrix-framework)。 - フィルター属性は main 26.250* 以降です。古いカーネルでは
configureActions()を使用してください。1 つのアクションで両方を使用しないでください(ActionConfigurationException)。 METHOD_*定数は属性Attribute\Rule\HttpMethodではなく、ActionFilter\HttpMethodにあります。属性側で参照するとコントローラーの構築時に例外が発生し、そのコントローラーのすべてのアクションが失敗します。- ルール属性はデフォルトのフィルター(
Authentication、HttpMethod([GET, POST])、Csrf)に追加されます。#[Authentication]または#[Csrf]を再度追加すると、フィルターが 2 回実行されます。 - ファイル名が PascalCase の場合、コントローラーのセグメントもクラス名の大文字小文字に合わせて記述します:
vendor:module.Post.create。小文字のpostはlib/infrastructure/controller/post.phpに解決され、Linux では失敗します。REST ではメソッド名が小文字に変換されるため、PascalCase のコントローラーには従来の REST 経由で到達できません(bitrix-rest)。 - HTML(
renderView/renderComponent)を使えるのは、ルートから到達するコントローラーのみです。BX.ajax.runAction()は JSON を想定しています。
コメント
Markdown 対応