目次 — BLOCS ナレッジの歩き方
目次 — BLOCS ナレッジの歩き方
このエージェントには、Laravel 向けテンプレートエンジン blocs/blocs と管理画面パッケージ blocs/admin、ドキュメント生成 blocs/docs を体系的に学べるナレッジが登録されています。本ページはその地図です。
前提条件 / 編集方針
- 対象読者: Laravel(PHP)で Web アプリを開発するエンジニア。MVC・Composer・Blade の基礎知識があることを想定
- パッケージ構成:
blocs/blocs(テンプレートエンジン)を中核とし、blocs/admin(管理画面自動生成)・blocs/docs(処理機能記述書・Excel)が連携する - 記事構成: 章番号(
no)は「1 = 概要 → 2 = テンプレート → 3〜5 = 管理画面 → 6 = docs → 7 = 逆引き・FAQ」の順で読み進める設計 - 記述の深さ: 各記事は実装に必要なコード例・設定ファイル・手順を含む。リファレンス系(2.1, 2.14, 5.1)は一覧・参照向け
- 情報基準: ナレッジ本文に明記がない場合、リポジトリ
blocs/admin/docsのソースを正とする - 関連ナレッジ: 本文中の他記事への参照は
noで記載。双方向リンクはメタデータのlink_toで管理
全体構成
| 章 | テーマ | 内容 |
|---|---|---|
| 1 | 概要・アーキテクチャ | パッケージの全体像、インストール、Laravel との処理フロー |
| 2 | blocs/blocs テンプレートエンジン | data-* 属性によるテンプレート記法、バリデーション、UI コンポーネント |
| 3 | blocs/admin 自動生成・設定 | 定義ファイルからの画面自動生成、権限・メニュー設定 |
| 4 | blocs/admin 画面カスタマイズ | 一覧・編集・削除・一括操作・レイアウトのカスタマイズ |
| 5 | blocs/admin 機能拡張・UI | ヘルパー、ボタン・モーダル、アップロード、グラフ、AI 等 |
| 6 | blocs/docs | 処理機能記述書の自動生成、Excel 操作 |
| 7 | 逆引き・トラブルシューティング | やりたいことから引くレシピ、FAQ・エラー対処 |
ナレッジ一覧
| no | タイトル | 難度 |
|---|---|---|
| 1.1 | blocs/admin: パッケージ概要とインストール手順 | ★ |
| 1.2 | Laravel + BLOCS: 処理フローとアーキテクチャ概要 | ★ |
| 2.1 | blocs/blocs: テンプレートエンジン概要とデータ属性一覧 | ★ |
| 2.2 | blocs/blocs: 変数の表示(data-val)とメニュー項目の自動変換 | ★★ |
| 2.3 | blocs/blocs: 変数の代入(data-assign)と属性値の置換(data-attribute) | ★★ |
| 2.4 | blocs/blocs: 条件分岐(data-exist/none/if/unless)による表示制御 | ★★ |
| 2.5 | blocs/blocs: 繰り返し処理(data-loop) | ★★ |
| 2.6 | blocs/blocs: テンプレートの再利用(data-include / data-bloc) | ★★ |
| 2.7 | blocs/blocs: 表示の装飾(data-prefix/postfix)と変換(data-convert) | ★★ |
| 2.8 | blocs/blocs: 入力値フィルター(data-filter) | ★★ |
| 2.9 | blocs/blocs: 多言語対応(data-lang) | ★★ |
| 2.10 | blocs/blocs: バリデーション条件の指定 | ★★ |
| 2.11 | blocs/blocs: カスタムバリデーションルールの作成 | ★★★ |
| 2.12 | blocs/blocs: Auto Include(テンプレート・UIの自動読み込み) | ★★ |
| 2.13 | blocs/blocs: 入力インターフェース(ai-* クラス) | ★★ |
| 2.14 | blocs/blocs: エラーコード一覧 | ★(参照) |
| 2.15 | blocs/blocs: Validate クラスとテンプレートバリデーションの実行 | ★★ |
| 2.16 | blocs/blocs: 選択肢フォーム(radio / checkbox / select) | ★★ |
| 2.17 | blocs/blocs: 定数・環境設定リファレンス | ★(参照) |
| 2.18 | blocs/blocs: Laravel 非依存モード(Blocs\View) | ★★★ |
| 3.1 | blocs/admin: 定義ファイルの作成と管理画面の自動生成 | ★★ |
| 3.2 | blocs/admin: 自動生成後の不要機能の無効化 | ★★ |
| 3.3 | blocs/admin: アクセス権限の設定 | ★★ |
| 3.4 | blocs/admin: サイドメニューの設定 | ★★ |
| 4.1 | blocs/admin: 一覧表示機能のカスタマイズ(検索・ソート・ページネーション) | ★★★ |
| 4.2 | blocs/admin: 新規作成・編集機能のカスタマイズ | ★★★ |
| 4.3 | blocs/admin: 削除機能のカスタマイズ | ★★★ |
| 4.4 | blocs/admin: 共通レイアウト・ボタン配置・見出し・ログ・リダイレクト | ★★★ |
| 4.5 | blocs/admin: 一括削除・有効/無効のカスタマイズ(SelectTrait / ToggleTrait) | ★★★ |
| 5.1 | blocs/admin: ヘルパー関数 | ★(参照) |
| 5.2 | blocs/admin: 動的メニュー項目の追加(addOption) | ★★ |
| 5.3 | blocs/admin: ボタンコンポーネント | ★★ |
| 5.4 | blocs/admin: モーダルコンポーネント | ★★ |
| 5.5 | blocs/admin: ファイルアップロード機能 | ★★★ |
| 5.6 | blocs/admin: レコードのコピーと並び替え(CopyTrait / SortTrait) | ★★★ |
| 5.7 | blocs/admin: グラフ表示(Chart.js) | ★★★ |
| 5.8 | blocs/admin: テーブルタイプの入力画面 | ★★★ |
| 5.9 | blocs/admin: 複数ログイン画面の追加 | ★★★ |
| 5.10 | blocs/admin: AI機能(Chat / VectorStore) | ★★★ |
| 5.11 | blocs/admin: プロフィール編集画面のカスタマイズ | ★★★ |
| 6.1 | blocs/docs: 処理機能記述書の自動生成(docsミドルウェア) | ★★ |
| 6.2 | blocs/docs: Excelファイル操作(Blocs\Excel) | ★★ |
| 7.1 | blocs: 逆引きレシピ集(やりたいことから引く) | ★★ |
| 7.2 | blocs: トラブルシューティング & FAQ(エラーコード・ハマりどころ) | ★ |
クイックガイド
コースA: 短時間で全体像を掴む
1.1 → 1.2 → 2.1
パッケージの位置づけ、Laravel との処理フロー、テンプレート属性の一覧までを最短で把握する。
コースB: 管理画面を使い始める
1.1 → 3.1 → 3.2 → 3.3
インストール後、定義ファイルで画面を自動生成し、不要機能の整理と権限設定まで進める。
コースC: テンプレート記法を学ぶ
2.1 → 2.2 → 2.3 → 2.4 → 2.5 → 2.6 → 2.12 → 2.15 → 2.16
data-* 属性の基本に加え、バリデーション実行(Validate)と選択肢フォームまでを順に読む。
コースD: 画面をカスタマイズする
1.2 → 3.1 → 4.1 → 4.2 → 4.4 → 5.1
アーキテクチャを理解したうえで、自動生成画面の一覧・編集・レイアウトを手直しする。
コースE: 機能を拡張する
3.1 → 5.3 → 5.4 → 5.5 → 5.6
ボタン・モーダル・アップロード・コピー/並び替えなど、よく使う拡張機能をまとめて参照する。
疑問・エラーから引く
- やりたいことが決まっている → まず 7.1(逆引きレシピ集)
- エラーコードや挙動がおかしい → 7.2(FAQ)→ 必要なら 2.14(エラーコード一覧)
- 特定の data- 属性がわからない* → 2.1 の属性一覧から該当 no へ
- 定数・キャッシュキーの一覧 → 2.17(定数・環境設定リファレンス)
- Laravel なしでテンプレートを使う → 2.18
- ヘルパー関数の名前がわからない → 5.1(ヘルパー関数リファレンス)