Top > 開発ガイド > コンポーネント開発Tips集 > コンポーネント情報定義ファイル

コンポーネント情報定義ファイル

対象バージョン

当ドキュメントはRubricks-0.6.x向けです。

コンポーネント情報の定義

No	設定項目	概要	必須	型	上限文字数	備考
1	@display_name	コンポーネントの表示名	○	制限なし文字列	32
2	@version	コンポーネントのバージョン	○	制限なし文字列	32
3	@description	コンポーネントの説明	○	制限なし文字列	なし
4	@author	作者名	○	制限なし文字列	32
5	@license	ライセンス情報	○	制限なし文字列	32
6	@blocks	ブロック設定		ハッシュの配列	-	（詳細は後述）
7	@functions	権限設定		ハッシュの配列	-	（詳細は後述）
8	@menus	メニュー設定		ハッシュの配列	-	（詳細は後述）
9	@mobile_menus	携帯用メニュー設定		ハッシュの配列	-	（詳細は後述）
10	@trails	証跡取得設定		ハッシュの配列	-	（詳細は後述）
11	@toolbar_view	ツールバー設定		ハッシュ	-	（詳細は後述）

ブロック情報の定義（@blocksの詳細）

No	シンボル名	概要	必須	型	上限文字数	備考
1	:title	ブロックのタイトル	○	制限なし文字列	32
2	:controller	ブロックを表示を担当するコントローラ名	○	半角英数文字列	128	No3とのcontroller/actionの組み合わせが等しい指定を複数行うことは出来ない。
3	:action	ブロックを表示を担当するアクション名	○	半角英数文字列	128	No2とのcontroller/actionの組み合わせが等しい指定を複数行うことは出来ない。
4	:function	ブロックの表示権限	○	制限なし文字列		@functionsに定義される:nameの値か、'admin'、'access'のいずれかであること。
5	:description	ブロックの説明	○	制限なし文字列
6	:widget	ウィジェットの定義		ハッシュ		（詳細は後述）

ウィジェット情報の定義（@blocksにおける[:widget]の詳細）

No	シンボル名	概要	必須	型	上限文字数	備考
1	:default_height	初期表示時の高さ	○	半角数字	4	次の範囲の数字とする：1-1500
2	:default_width	初期表示時の横幅	○	半角数字	4	次の範囲の数字とする：1-1500
3	:visible	初期表示時の表示/非表示	○	boolean

機能情報の定義（@functionsの詳細）

No	シンボル名	概要	必須	型	上限文字数	備考
1	:name	機能の名称	○	半角英数文字列	32	デフォルトで提供される'admin'と'access'を含み、重複する名称の:nameを指定することはできない。
2	:display_name	機能の表示名	○	制限なし文字列	32

メニュー情報の定義（@menusの詳細）

No	シンボル名	概要	必須	型	上限文字数	備考
1	:title	メニューのタイトル	○	制限なし文字列	32
2	:extend_page	デフォルトのページレイアウト指定		'main'か'admin'のいずれか。		指定が無いとき、No2のcontroller名がAdminで始まる場合は'admin'が、そうでない場合は'main'が自動で設定される。
3	:controller	メニューを選択した際に呼び出されるコントローラ	○	半角英数文字列	128
4	:action	メニューを選択した際に呼び出されるアクション		半角英数文字列	128	指定が無い場合、メインコンテンツにmainメソッドの結果を返すメニューとなる。
5	:function	メニューの表示権限	○	制限なし文字列		@functionsに定義される:nameの値か、'admin'、'access'のいずれかであること。
6	:description	このメニューの説明	○	制限なし文字列

携帯用メニュー情報の定義（@mobile_menusの詳細）

No	シンボル名	概要	必須	型	上限文字数	備考
1	:title	メニューのタイトル	○	制限なし文字列	32
2	:controller	メニューを選択した際に呼び出されるコントローラ	○	半角英数文字列	128
3	:action	メニューを選択した際に呼び出されるアクション	○	半角英数文字列	128
4	:function	メニューの表示権限	○	制限なし文字列		@functionsに定義される:nameの値か、'admin'、'access'のいずれかであること。

証跡取得情報の定義（@trailsの詳細）

No	シンボル名	概要	必須	型	上限文字数	備考
1	:record_type	閲覧系・更新系の区別	○	制限なし文字列		'read'、'update'のいずれかであること
2	:examples	例	○	制限なし文字列		設定画面で閲覧系の例、更新系の例という形で表示される。

ツールバー情報の定義（@toolbar_viewの詳細）

No	シンボル名	概要	必須	型	上限文字数	備考
1	:function	ツールバーの表示権限	○	制限なし文字列		@functionsに定義される:nameの値か、'admin'、'access'のいずれかであること。
2	:action	ツールバーを表示するアクション	○	半角英数文字列	128
3	:controller	ツールバーを表示するコントローラ	○	半角英数文字列	128
4	:config_description	ツールバーの説明(一般設定画面で表示される)	○	制限なし文字列	64