Search by

blocs / docs

blocs

Laravel Document Generator

Package info

github.com/blocs/docs

pkg:composer/blocs/docs

Statistics

Installs: 1 551

Dependents: 1

Suggesters: 0

Stars: 2

Open Issues: 0

v2.0.18 2026-11-15 13:46 UTC

README

Laravel Document Generator

Laravelのドキュメント生成ツール

Latest stable version Total downloads GitHub code size GitHub license Laravel awesome Laravel version PHP version

Website | iknow

導入方法

  1. PHP と Composer をセットアップ
  2. Composer で Laravel をインストール
composer require blocs/docs
  1. docsをコピー
cp -r vendor/blocs/docs/docs ./

ドキュメントの生成

コントローラーの処理を docs() で記録し、画面ごとの設計書(Excel)を docs/ に書き出します。

  1. ミドルウェアを登録(bootstrap/app.php)
->withMiddleware(function (Middleware $middleware) {
    $middleware->web(append: [\Blocs\Middleware\Docs::class]);
})
  1. コントローラーで処理を記録
// 処理だけ
docs('# 一覧画面の表示');

// 入力, 処理
docs(['POST' => '入力値'], '入力値を検証する');

// 入力, 処理, 出力, バリデーション
docs(['POST' => '入力値'], 'データを追加する', ['データベース' => 'users'], [
    ['name' => 'email', 'validate' => 'required', 'message' => '必須です'],
]);
  1. 画面を表示すると 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');