Xoops: フォームエレメント
XoopsForm* クイックリファレンス
XoopsFormButton::XoopsFormButton( $caption, $name, $value = "", $type = "button")
XoopsFormButton
引数 | 型 | 内容 |
---|---|---|
$caption | string | ボタンのキャプション文字列。 |
$name | string | CGI変数の名称。 |
$value | string | CGI変数の値。 |
$value | string | このボタンの型。 button, submit, reset のいずれかの文字列を指定する。 何も指定しない場合は button を指定したことになる。 |
XoopsFormCheckBox::XoopsFormCheckBox( $caption, $name, $value = null)
XoopsFormCheckBox
引数 | 型 | 内容 |
---|---|---|
$caption | string | |
$name | string | |
$value | mixed | 値。 複数の値を引き渡す場合には、string の array 型、 一つだけの場合は単なる string 型とする。 |
XoopsFormDateTime::XoopsFormDateTime( $caption, $name, $size = 15, $value = 0)
XoopsFormDateTime
引数 | 型 | 内容 |
---|---|---|
$caption | string | |
$name | string | |
$size | int | ? デフォルトは15。 |
$value | int |
XoopsFormFile::XoopsFormFile( $caption, $name, $maxfilesize)
XoopsFormFile
引数 | 型 | 内容 |
---|---|---|
$caption | string | キャプション文字列。 |
$name | string | name属性。 |
$value | int | アップロードするファイルのサイズの上限。 |
XoopsFormHidden::XoopsFormHidden( $name, $value)
XoopsFormHidden
引数 | 型 | 内容 |
---|---|---|
$name | string | name 属性。 |
$value | string | value 属性。 |
XoopsFormLabel::XoopsFormLabel( $value = "")
フォームの中に文字列を表示するのに使う。 入力や選択などの操作はできない。
XoopsFormLabel
引数 | 型 | 内容 |
---|---|---|
$caption | string | キャプション文字列を指定する。 |
$value | string | value 属性。 ラベルとして表示する文字列を指定する。 指定しなければ空文字列 "" となる。 |
XoopsFormPassword::XoopsFormPassword( $caption, $name, $size, $maxlength, $value = "")
XoopsFormPassword
引数 | 型 | 内容 |
---|---|---|
$caption | string | |
$name | string | name 属性。 |
$size | int | テキストフィールドの長さ。 |
$maxlength | int | 入力できる文字列の最大文字数。 |
$value | int | パスワードの初期値。 デフォルトは空文字列。 ここに何か指定した場合には、 それがソースを読めばバレてしまうことに注意すること。 |
XoopsFormRadio::XoopsFormRadio( $caption, $name, $value = null)
XoopsFormRadio
引数 | 型 | 内容 |
---|---|---|
$caption | string | |
$name | string | name 属性。 |
$value | string | デフォルトで選択されている値。 |
XoopsFormRadioYN::XoopsFormRadioYN( $caption, $name, $value = null, $yes = _YES, $no = _NO)
引数 | 型 | 内容 |
---|---|---|
$caption | string | |
$name | string | |
$value | string | デフォルトで選択する値。 No を選択する場合は "0"、 Yes を選択する場合は "1" と指定する。 |
$yes | string | "Yes" に対応する文字列。 デフォルトは _YES となっている。 これは選択されている言語による Yes に対応した言葉である。 |
$no | string | "No" に対応する文字列。 デフォルトは _NO となっている。 これは選択されている言語による No に対応した言葉である。 |
XoopsFormSelect::XoopsFormSelect( $caption, $name, $value = null, $size = 1, $multiple = false)
このクラスから派生して、 XoopsFormSelectCountry、 XoopsFormSelectGroup、 XoopsFormSelectLang、 XoopsFormSelectMatchOption、 XoopsFormSelectTheme、 XoopsFormSelectTimezone、 XoopsFormSelectUser、 のクラスが用意されている。
XoopsFormSelect
引数 | 型 | 内容 |
---|---|---|
$caption | string | |
$name | string | name 属性。 |
$value | mixed | デフォルトで選択しておく value を指定する。 複数選択させたい場合は、配列にして指定する。 インデックスではなく、選択対象の値を指定することに注意。 |
$size | int | セレクタの行数。 1を指定した場合には、drop-down-list (プルダウンメニュー) が表示される。 デフォルトは1である。 |
$multiple | bool | 複数同時選択を許可する場合には true を指定する。 デフォルトは false。 |
テキスト入力フィールドをフォームに追加するには、 class XoopsFormText のインスタンスを使う。
XoopsFormText::XoopsFormText( $caption, $name, $size, $maxlength, $value = "")
XoopsFormText
引数 | 型 | 内容 |
---|---|---|
$caption | string | フォームのキャプション。 例えばフォーム全体が枠で囲まれる場合に、 その枠のタイトルとして表示される文字列。 |
$name | name | フォームの "name" 属性。 サーバーがリクエストを受け取るときに、 name と value の対で情報を get するが、 ここに name を指定しておく。 |
$size | int | フォームを表示するサイズ。カラム数。 |
$maxlength | int | 入力可能な最大文字数。 |
$value | string | デフォルトで表示する文字列。 この引数は省略できる。 省略した場合は、初期値は空になる。 |
XoopsFormTextArea::XoopsFormTextArea( $caption, $name, $value = "", $rows = 5, $cols = 50)
複数入力可能なテキストボックス(テキスト領域)を作成する。
XoopsFormTextArea
引数 | 型 | 内容 |
---|---|---|
$caption | string | |
$name | string | |
$value | string | 初期値となる文字列を指定する。 デフォルトは空文字列。 |
$rows | int | 行数。 デフォルトは5。 |
$cols | int | 桁数。 デフォルトは50。 |
XoopsFormTextDateSelect::XoopsFormTextDateSelect( $caption, $name, $size = 15, $value = 0)
XoopsFormTextDateSelect
引数 | 型 | 内容 |
---|---|---|
$caption | string | |
$name | string | |
$size | int | ? デフォルトは 5。 |
$value | int | ? デフォルトは 0。 |