March 9, 2013

FuelPHPで作ったDBドキュメントジェネレータを改良したのでGitLabのDBドキュメントを生成して公開してみた

2013/03/11 00:26 追記:
ホットキー対応しました。サンプル右上のHotkeysをクリックしてみて下さい。
(暫く使ってみて使いづらかったら割り当て変えます。。。)

2013/03/09 21:12 追記:
検索機能もつけてみました。サンプルも更新してあります。

--

ちょっと前に、fuel-dbdocsというDBドキュメントジェネレータを作りました。
http://madroom-project.blogspot.jp/2013/02/fuelphpmysqlpostgresqlsqlite.html

GitHub:
https://github.com/mp-php/fuel-dbdocs


GitHubやGitLabのように、特定の行(カラム)に対してリンクができて、色付けもされれば便利かなと思い、改良してみました。


説明するよりも見た方が早いと思いますので、試しにGitLabのDBドキュメントを生成して、以下に置いておきました。
http://fueldbdocssample.madroom.net/index.html


例えば、usersテーブルは以下になります。
http://fueldbdocssample.madroom.net/table_users.html

usersテーブルのemailカラムは以下になります。
http://fueldbdocssample.madroom.net/table_users.html#_column_email
* emailカラムと、"Indexes"の"index_users_on_email"に色が付いています。


カラム名から、外部キーの判別も、ある程度はしています。

例えば、users_projectsテーブルだと
http://fueldbdocssample.madroom.net/table_users_projects.html
* user_id
* project_id
が外部キーと判別されています。

この判別処理はfunctionとして設定ファイルに書いてあるので、独自に修正可能です。


あと、設定でWEBフォントの指定もできるので、指定した状態で出力してみました。

よかったら使ってみて下さい。

No comments:

Post a Comment