コマンドコメントについて †
弊社のシステムで使用している、システム用のHTMLのコメント文をコマンドコメントと呼んでいます。
コマンドコメントリファレンスにつきましては、現在、公開方法を模索中です。
コマンドコメント概要 †
ecodeで始まるコマンドコメントは以下に記述されている関数を呼び出すコードとなります。
custom/extension.php
syscodeで始まるコマンドコメントは以下に記述されている関数を呼び出すコードとなります。
custom/system/xxxSystem.php の当該system
(固有systemが存在しない場合System.php)
コマンドコメントリファレンス †
get †
GET引数を出力します。
- 引数
- 1. 変数名
表示したいGET引数の変数名
- 戻り値
- 出力
- 例
- 引数を利用した処理または表示を行いたい場合に使用します。
コマンドコメント
name : <!--# get name #-->
出力結果
name : HogeHoge
post †
POST引数を出力します。
- 引数
- 1. 変数名
表示したいPOST引数の変数名
- 戻り値
- 出力
- 例
- 引数を利用した処理または表示を行いたい場合に使用します。
コマンドコメント
name : <!--# post name #-->
出力結果
name : HogeHoge
value †
テンプレートに関連付けられたレコードの引数で指定されたカラムの内容を出力する。
- 引数
- 1. カラム名
表示するレコードのカラム名
2. フラグ
改行コードを<br>に変換するか否かを指定する。
falseを指定or省略した場合は変換されない。
trueを指定すると変換される。
- 戻り値
- 出力
- 例
- info,registCheck,editCheck,listなど、出力テンプレートとレコードが関連付いた環境で以下を呼び出す。
コマンドコメント
id : <!--# value id #-->
出力結果
id : E0000001
valueReplace †
設定されたレコードをカラム名で検索し、マッチした項目を複数の文字列から検索、対応する文字列を表示する。
表示内容を記号化してテーブルに保持している場合等に使用する。
- 引数
- 1. カラム名
置換表示するレコードのカラム名
2. 置換検索文字列
第1引数のカラムが示す値と比較し、置換対象になる文字の番数を決めるのに使用する。
3. 置換表示文字列
第2引数でマッチングした文字と同じ位置の文字列が戻り値になる
- 戻り値
- 出力
- 例
- コマンドコメント
sample = 3
<!--# valueReplace sample 1/2/3/4/5 一/二/三/四/五 #-->人います。
出力結果
三人います。
alias †
テンプレートに関連づけられたレコードの指定されたカラムを、別テーブルの指定カラムをキーに検索を行ない置換を行なう。
テーブルの結合などに使用する
- 引数
- 1. テーブル名
検索対象のテーブル名
2. カラム名
第1引数で指定したテーブルと、テンプレートに関連づけられたレコードを関連付けるカラム名。
3. 検索対象カラム
第1引数で指定したテーブルの、どのカラムを置換の対象として検索するかを設定する。
4. 表示カラム
第1、第2、第3引数でマッチングしたレコードのどのカラムを表示するかを設定する。
- 戻り値
- 出力
- 例
- info,shop,item,listなど、出力テンプレートとレコードが関連付いた環境で以下を呼び出す。
コマンドコメント
<!--# alias cUser owner id name #-->
出力結果
うぇぶすくえあ
（この例では、cUserテーブルの、検索結果レコードのnameカラムの値が"うぇぶすくえあ"と設定されているとする。）
valueAlias †
指定した文字列を別テーブルの指定カラムをキーに検索を行ない置換を行なう。
テーブルの結合などに使用する
- 引数
- 1. テーブル名
検索対象のテーブル名
2. 検索する値
第1引数で指定したテーブルとテンプレートに関連づけられたレコードを関連付ける際に検索する値を設定する。
3. 検索対象カラム
第1引数で指定したテーブルの、どのカラムを置換の対象として検索するかを設定する。
4. 表示カラム
第1、第2、第3引数でマッチングしたレコードのどのカラムを表示するかを設定する。
- 戻り値
- 出力
- 例
- info,shop,item,listなど、出力テンプレートとレコードが関連付いた環境で以下を呼び出す。
コマンドコメント
<!--# valueAlias parentCategory (!--# value parent #--) id name #-->
出力結果
海外
（この例では、parentCategoryテーブルを、値(!--# value parent #--)で、idカラムを検索し、その結果から得られるレコードのnameカラムの値が"海外"と設定されているとする。）
※コマンドコメントはこのようにネスト可能。
arrayAlias †
指定したカラムに入った各文字列を別テーブルの指定カラムをキーに検索を行ない置換を行ない、その一覧を返す。
テーブルの結合などに使用する
- 引数
- 1. テーブル名
検索対象のテーブル名
2. カラム名
第1引数で指定したテーブルと、テンプレートに関連づけられたレコードを関連付けるカラム名。
3. 検索対象カラム
第1引数で指定したテーブルの、どのカラムを置換の対象として検索するかを設定する。
4. 表示カラム
第1、第2、第3引数でマッチングしたレコードのどのカラムを表示するかを設定する。
- 戻り値
- 出力
- 例
- info,shop,item,listなど、出力テンプレートとレコードが関連付いた環境で以下を呼び出す。
コマンドコメント
<!--# arrayAlias feature feature id name #-->
出力結果
うぇぶすくえあ
websquare
ウェブスクエア
（この例では、featureテーブルの中に、検索結果レコードが複数あり、そのnameカラムをすべて表示する。）
arrayValueAlias †
指定したカラムに入った各文字列を、特定の値をキーに検索を行ない置換を行ない、その一覧を返す。
テーブルの結合などに使用する
- 引数
- 1. テーブル名
検索対象のテーブル名
2. 検索する値
第1引数で指定したテーブルと、テンプレートに関連づけられたレコードを関連付けるカラム名。
3. 検索対象カラム
第1引数で指定したテーブルの、どのカラムを置換の対象として検索するかを設定する。
4. 表示カラム
第1、第2、第3引数でマッチングしたレコードのどのカラムを表示するかを設定する。
- 戻り値
- 出力
- 例
- info,shop,item,listなど、出力テンプレートとレコードが関連付いた環境で以下を呼び出す。
コマンドコメント
<!--# arrayValueAlias feature 'moji' id name #-->
出力結果
漢字
ひらがな
カタカナ
（この例では、featureテーブルの中に、検索結果レコードが複数あり、そのnameカラムをすべて表示する。）
object †
テンプレートに関連づいたレコードから指定したカラムの値を抜きだし、存在する場合はそれを画像のパスとしてimgタグに受け渡し表示する。
詳細は以下の項目を参照。
object image †
準備中
object imageSize †
画像が存在する場合はそれを画像のパスとしてimgタグに受け渡し表示する。widthとheightを設定可能。
- 引数
- 1. name属性の値
name属性の値を設定する。GETまたはPOSTされた際、この値を使用することでデータを取り出すことができる。
2. 関連付けられているキー
出力テンプレートに関連付けられているテーブルのどのキーに、画像のファイルネームが格納されているかを設定する。
3. 横幅
表示される画像の横幅を指定します。
4. 縦幅
表示される画像の縦幅を指定します。
- 戻り値
- 出力
- 例
- コマンドコメント
<!--# object imageSize image1 320 240 #-->
出力結果
画像が表示されるには、すでに何かしらの画像がUPされている必要があります。
object imageStr †
表示する画像を、パスを指定して表示します。
- 引数
- 1. 画像のパス
表示する画像のパスを指定します。
- 戻り値
- 出力
- 例
- コマンドコメント
<!--# object ImageStr ./test.img #-->
出力結果
#ref(): File not found: "object_image.jpg" at page "パッケージ共通/コマンドコメント"
画像が存在しない場合は、何も表示されません。
object imageSizeStr †
画像が存在する場合はそれを画像のパスとしてimgタグに受け渡し表示する。widthとheightを設定可能。
- 引数
- 1. name属性の値
name属性の値を設定する。GETまたはPOSTされた際、この値を使用することでデータを取り出すことができる。
2. 画像のアップロード先
画像が存在パスを直接文字列で指定する。
3. 横幅
表示される画像の横幅を指定します。
4. 縦幅
表示される画像の縦幅を指定します。
- 戻り値
- 出力
- 例
- コマンドコメント
<!--# object imageSize image1 320 240 #-->
出力結果
画像が表示されるには、すでに何かしらの画像がUPされている必要があります。
object linkImageSize †
準備中
form †
フォームを表示する。具体的なコントロールを表示するには、後述するように引数を指定する。
form text †
テキストボックスを出力する。
- 引数
- 1. name属性の値
name属性の値を設定する。GETまたはPOSTされた際、この値を使用することでデータを取り出すことができる。
2. 横幅
テキストボックスの横幅を指定する。
3. 最大文字数
テキストボックスに入力可能な最大文字数を設定する。
- 戻り値
- 出力
- 例
- コマンドコメント
<!--# form text name 30 30 #-->
出力結果
form password †
パスワード書式のテキストボックスを出力する。
- 引数
- 1. name属性の値
name属性の値を設定する。GETまたはPOSTされた際、この値を使用することでデータを取り出すことができる。
2. 横幅
テキストボックスの横幅を指定する。
3. 最大文字数
テキストボックスに入力可能な最大文字数を設定する。
- 戻り値
- 出力
- 例
- コマンドコメント
<!--# form password name 30 30 #-->
出力結果
form textarea †
テキストエリアを出力する。
- 引数
- 1. name属性の値
name属性の値を設定する。GETまたはPOSTされた際、この値を使用することでデータを取り出すことができる。
2. テキストエリアの横幅
テキストエリアの横幅を指定する。
3. テキストエリアの行数
テキストエリアの行数を指定する。
これらは最大文字数を制限するものではないので注意。
- 戻り値
- 出力
- 例
- コマンドコメント
<!--# form textarea name 60 5 #-->
出力結果
form radio †
ラジオボタンを出力する。
１回の呼び出しで、複数のラジオボタンをひとつのグループとして扱うことが可能。
- 引数
- 1. name属性の値
name属性の値を設定する。GETまたはPOSTされた際、この値を使用することでデータを取り出すことができる。
2. デフォルト値の設定
ページをブラウザに表示する際のデフォルト値を設定する。
3. ラジオボタン間に表示する文字列
ラジオボックス間に憑依する文字列を設定する。
空白を表示したい場合は& nbsp;と記述する。
4. ラジオボタンの値
ラジオボタンが選択された際、送信される値を設定する。
／（スラッシュ）で区切ることで、複数のラジオボタンを出力できる。
5. ラジオボタンの表示文字
実際にラジオボタンの横に表示される文字列を設定する。
／（スラッシュ）で区切ることで、複数のラジオボタンを出力できるが、|
上記のスラッシュの数と一致しなければならない
- 戻り値
- 出力
- 例
- コマンドコメント
<!--# form radio sex 男 男/女 男性/女性 #-->
出力結果
form checkbox †
チェックボックスを出力する。
- 引数
- 1. name属性の値
name属性の値を設定する。GETまたはPOSTされた際、この値を使用することでデータを取り出すことができる。
2. デフォルト値
デフォルトの値を設定する。ここに何も指定しないと、チェックボックスの初期値はunchekedになる。省略可能。
3. チェックボックス間の文字列
チェックボックス間の文字列を指定する。ここにスペースなどを入れると、画面が見やすくなることがある。省略可能。
4. チェックボックスの値
submitボタンが押された際、チェックされたチェックボックスから送信される値を設定する。なお受け取り先では、値は連想配列で受け取れる。
／（スラッシュ）で区切ることで、複数のチェックボックスを出力できる。
5. チェックボックスの表示文字
チェックボックスの横に表示される文字列を設定する。
／（スラッシュ）で区切ることで、複数の行を出力できるが、|
上記のスラッシュの数と一致しなければならない
- 戻り値
- 出力
- 例
- コマンドコメント
<!--# form checkbox pass2 <br> 100/100/100 スーパー/ウルトラ/スパイダー #-->マン
出力結果
form option †
プルダウンメニューを出力する。
１回の呼び出しで、複数のチェックボックスをグループ化して出力できる。
- 引数
- 1. name属性の値
name属性の値を設定する。GETまたはPOSTされた際、この値を使用することでデータを取り出すことができる。
2. デフォルト値
デフォルトの値を設定する。ここに何も指定しないと、プルダウンメニューの初期値は一番上になる。
3. プルダウンメニューの値
submitボタンが押された際、プルダウンメニューから送信される値を設定する。
／（スラッシュ）で区切ることで、複数の行を出力できる。
4. プルダウンメニューの表示文字
実際にプルダウンメニューに表示される文字列を設定する。
／（スラッシュ）で区切ることで、複数の行を出力できるが、|
上記のスラッシュの数と一致しなければならない
- 戻り値
- 出力
- 例
- コマンドコメント
<!--# form option minute 2 1/2/3 Jan/Feb/Mar #-->
出力結果
form file †
プルダウンメニューを出力する。
- 引数
- 1. name属性の値
name属性の値を設定する。GETまたはPOSTされた際、この値を使用することでデータを取り出すことができる。
2. オプション（省略可能）
さまざまな設定を書くことができる。たとえば、size=30と記載すると、フォームの大きさを指定できる等
- 戻り値
- 出力
- 例
- コマンドコメント
<!--# form file #-->
出力結果
form hidden †
ブラウザに表示されない隠れデータを設置する。
テキストボックスを出力する。
- 引数
- 1. name属性の値
name属性の値を設定する。GETまたはPOSTされた際、この値を使用することでデータを取り出すことができる。
2. データの値
送信されるデータの値を設定する。
- 戻り値
- 出力
- 例
- コマンドコメント
<!--# form hidden name value #-->
出力結果
※何も表示されません。
variable †
準備中
