API Documentation
\

\BEAR_Form

Form

フォームにPEAR::HTML_QuickFormを利用しています。

Summary

Methods
Properties
Constants
factory()
__construct()
onInject()
setConfig()
getConfig()
setService()
init()
setRenderer()
getRenderer()
setSubmitHeader()
getSubmitHeader()
getSubmitFormName()
renderForms()
getFormNumber()
$submitValue
$submitHeader
$errorTemplate
$requireTemplate
$requireNotes
$jsWarning
$formNames
$method
RENDERER_APP
RENDERER_SMARTY_ARRAY
RENDERER_DHTML_TABLELESS
JS_WARNING
REQUIRE_NOTES
TEMPLATE_ERROR
TEMPLATE_REQUIRED
FORM_ERRORS
_exception()
$_config
$_formToken
$_log
N/A
_factory()
$_renderer
$_usedToken
$_instance
$_rendererCallback
$_renderConfig
N/A

Constants

RENDERER_APP

RENDERER_APP

DHTML_TABLELESSを継承したPC/Mobile対応のAppレンダラー

RENDERER_SMARTY_ARRAY

RENDERER_SMARTY_ARRAY

'静的な' Smarty テンプレートのためのレンダラ

RENDERER_DHTML_TABLELESS

RENDERER_DHTML_TABLELESS

完全に妥当な XHTML を出力するレンダラ

JS_WARNING

JS_WARNING

JS Alertのメッセージ

REQUIRE_NOTES

REQUIRE_NOTES

必須項目メッセージ

TEMPLATE_ERROR

TEMPLATE_ERROR

エラーテンプレート

TEMPLATE_REQUIRED

TEMPLATE_REQUIRED

必須項目テンプレート

FORM_ERRORS

FORM_ERRORS

フォームエラーSmarty変数アサイン名

Properties

$submitValue

$submitValue : \arry

SubmitValue値

Quick_Form::getSubmitValues()の値、onAction($submit)の$submitは Quick_Form::exportValue()で出力された値でsubmitボタンの値などは出力されない

Type

\arry

$submitHeader

$submitHeader : array

サブミットヘッダー

$submitの属性情報

Type

array

$errorTemplate

$errorTemplate : string

エラーテンプレート

Type

string

$requireTemplate

$requireTemplate : string

必須項目テンプレート

Type

string

$requireNotes

$requireNotes : string

必須項目説明表示

Type

string

$jsWarning

$jsWarning : string

JS警告

Type

string

$formNames

$formNames : array

フォーム名

Type

array

$method

$method : string

送信方法

Type

string

$_config

$_config : array

Class config

Type

array

$_formToken

$_formToken : \BEAR_Form_Token

フォームトークン

Type

\BEAR_Form_Token

$_renderer

$_renderer : string

フォームレンダラ

Type

string

$_usedToken

$_usedToken : array

使用済みトークン

Type

array

$_instance

$_instance : object

シングルトンインスタンス

Type

object

$_rendererCallback

$_rendererCallback : callable

レンダラーコールバック

Type

callable

$_renderConfig

$_renderConfig : array

Render Config

Type

array

Methods

factory()

factory() : \HTML_QuickForm

ファクトリー

Quick_Formオブエクトを生成して設定します。

Returns

\HTML_QuickForm

__construct()

__construct(array  $config)

Constructor

Parameters

array $config

onInject()

onInject() : void

Inject

setConfig()

setConfig(mixed  $config, mixed  $values = null) : self

Set config

Parameters

mixed $config

(string) 設定キー | (array) 設定配列
mixed $values

(string) $configの時の設定値

Returns

self

getConfig()

getConfig(string  $key = null) : mixed

Get config

Parameters

string $key

設定キー、指定なければ全ての設定を取得

Returns

mixed

setService()

setService(string  $name, mixed  $service) : void

Set service

Parameters

string $name

サービスキー
mixed $service

サービス

init()

init() : void

インスタンス解放

ページの再生成で使用されます

setRenderer()

setRenderer(string  $renderer) : void

フォームレンダラ指定

フォームのレンダラーを指定します。

self::setRenderer(self::RENDERER_SMARTY_ARRAY); //デファオルト
self::setRenderer(self::RENDERER_DHTML_TABLELESS); //DHTML

                                    
Parameters

                    

                                                    

                                string
                                $renderer 
                                
フォームレンダラー

getRenderer()

getRenderer() : string

現在のレンダラーを返します

Returns

string

setSubmitHeader()

setSubmitHeader(\HTML_Quick_Form  $form, string  $key, string  $value) : void

Add submit header

サブミットの装飾値をヘッダーとして付加します。 これは例えばフォームの遷移の状態などフォームそのものではないが フォームとして利用したい時に使用します。

onAction($submit)の$submitには渡りません。

Parameters

\HTML_Quick_Form $form

QuickForm
string $key

ヘッダーキー
string $value

ヘッダーの値

getSubmitHeader()

getSubmitHeader(string  $submitHeaderKey = null) : string

サブミットヘッダーの取得

Parameters

string $submitHeaderKey

ヘッダーのキー

Returns

string

getSubmitFormName()

getSubmitFormName(array  $submits) : string

Submitされたフォームの名前を取得

マルチフォームの場合にどのフォームでサブミットされたかを調べます。

Parameters

array $submits

サブミット値

Returns

string —

フォーム名

renderForms()

renderForms(\Smarty  $smarty, string  $ua, boolean  $enableJs = false) : string

フォームレンダリング

Parameters

\Smarty $smarty
string $ua

UAコード
boolean $enableJs

JS有効?

Returns

string

getFormNumber()

getFormNumber() : integer

フォームの数を返す

Returns

integer

_exception()

_exception(string  $msg, array  $config = array()) : \BEAR_Exception

例外の作成

Parameters

string $msg

例外メッセージ
array $config

例外config

Returns

\BEAR_Exception

_factory()

_factory(mixed  $formName, array  $options) : \HTML_QuickForm

ファクトリー

HTML_QuickFormインスタンス生成

Parameters

mixed $formName

フォーム名 | フォーム名配列
array $options

オプション

Returns

\HTML_QuickForm