blocs / docs
Laravel Document Generator
v2.0.18
2026-11-15 13:46 UTC
Requires
- php: >=8.3
- ext-dom: *
- ext-mbstring: *
- ext-simplexml: *
- ext-xmlreader: *
- ext-zip: *
Requires (Dev)
- phpunit/phpunit: ^11.0 || ^12.0
Suggests
- laravel/framework: ミドルウェア(Blocs\Middleware\Docs)と Excel::download() を使う場合に必要 (>=10)
Provides
None
Conflicts
None
Replaces
None
- dev-main
- v2.0.18
- v2.0.17
- v2.0.16
- v2.0.15
- v2.0.14
- v2.0.13
- v2.0.12
- v2.0.11
- v2.0.10
- v2.0.9
- v2.0.8
- v2.0.7
- v2.0.6
- v2.0.5
- v2.0.4
- v2.0.3
- v2.0.2
- v2.0.1
- v2.0.0
- v1.1.30
- v1.1.29
- v1.1.28
- v1.1.27
- v1.1.26
- v1.1.25
- v1.1.24
- v1.1.23
- v1.1.22
- v1.1.21
- v1.1.20
- v1.1.19
- v1.1.18
- v1.1.17
- v1.1.16
- v1.1.15
- v1.1.14
- v1.1.13
- v1.1.12
- v1.1.11
- v1.1.10
- v1.0.9
- v1.0.8
- v1.0.7
- v1.0.6
- v1.0.5
- v1.0.4
- v1.0.3
- v1.0.2
- v1.0.1
- dev-develop
This package is auto-updated.
Last update: 2026-11-15 13:46:51 UTC
README
Laravel Document Generator
Laravelのドキュメント生成ツール
導入方法
- PHP と Composer をセットアップ
- Composer で Laravel をインストール
composer require blocs/docs
- docsをコピー
cp -r vendor/blocs/docs/docs ./
ドキュメントの生成
コントローラーの処理を docs() で記録し、画面ごとの設計書(Excel)を docs/ に書き出します。
- ミドルウェアを登録(
bootstrap/app.php)
->withMiddleware(function (Middleware $middleware) { $middleware->web(append: [\Blocs\Middleware\Docs::class]); })
- コントローラーで処理を記録
// 処理だけ docs('# 一覧画面の表示'); // 入力, 処理 docs(['POST' => '入力値'], '入力値を検証する'); // 入力, 処理, 出力, バリデーション docs(['POST' => '入力値'], 'データを追加する', ['データベース' => 'users'], [ ['name' => 'email', 'validate' => 'required', 'message' => '必須です'], ]);
- 画面を表示すると
docs/コントローラー名@メソッド名.xlsxが生成されます
docs/format.xlsx(雛形)がない場合と、本番環境(APP_ENV=production)では生成しません- 生成に失敗しても画面の表示には影響しません(例外はログに記録されます)
- 画面名やキーワードの置き換えは
docs/common.phpとdocs/コントローラー名.phpで設定します
Excel の読み書き
use Blocs\Excel; $excel = new Excel('template.xlsx'); // 読み取り(シートは番号(1始まり)または名前、列は番号(0始まり)または名前、行は int なら0始まり・文字列なら1始まり) $value = $excel->get(1, 'A', '1'); $rows = $excel->all('Sheet1'); // 大きなファイルは1行ずつ読む $excel->open(1); while (($row = $excel->next()) !== false) { // ... } // 書き込み $excel->set(1, 'A', '1', '文字列') ->set(1, 'B', '1', 123) ->set(1, 'C', '1', new DateTime('2024-01-02')) // シリアル値で書き込み(セルに日付の書式が必要) ->name(1, '新しいシート名'); $excel->save('output.xlsx'); // 引数を省略すると読み込んだファイルを上書き return $excel->download('出力.xlsx');