Class Ethna_ActionForm

Description

アクションフォームクラス

Located in /class/ActionForm.php (line 27)


	
			
Direct descendents
Class Description
 class Ethna_Form_UnitTest __ethna_unittest__フォームの実装
 class Ethna_Form_Info __ethna_info__フォームの実装
 class Ethna_SOAP_ActionForm SOAPフォームクラス
Variable Summary
 mixed $ae
 mixed $app_ne_vars
 mixed $app_vars
 mixed $backend
 array $def
 array $form
 mixed $form_vars
 mixed $i18n
 mixed $logger
 mixed $plugin
Method Summary
 Ethna_ActionForm __construct (object Ethna_Controller $controller)
 array check (string $name)
 object Ethna_Error checkURL (string $name)
 void clearFormVars ()
 mixed get (string $name)
 mixed getApp (string $name)
 array getAppArray ([boolean $escape = true])
 mixed getAppNE (string $name)
 array getAppNEArray ([boolean $escape = false])
 array getArray ([bool $escape = true])
 array getDef ([string $name = null])
 string getHiddenVars ([array $include_list = null], [array $exclude_list = null])
 mixed getName (string $name)
 void handleError (string $name, int $code)
 void set (string $name, string $value)
 void setApp (string $name, mixed $value)
 void setAppNE (string $name, mixed $value)
 array setDef (string $name, array $value)
 void setForceValidatePlus ($force_validate_plus $force_validate_plus)
 void setFormVars ()
 int validate ()
 mixed _filter (mixed $value, int $filter)
 mixed _filter_alnum_zentohan (mixed $value)
 mixed _filter_alphabet_zentohan (mixed $value)
 mixed _filter_kana_hantozen (mixed $value)
 mixed _filter_ltrim (mixed $value)
 mixed _filter_ntrim (mixed $value)
 mixed _filter_numeric_zentohan (mixed $value)
 mixed _filter_rtrim (mixed $value)
 void _getArray (array &$vars, array &$retval, bool $escape)
 void _getHelperAppObject ( $key)
 void _getPluginDef (string $form_name)
 void _setFormDef ()
 array _setFormTemplate (array $form_template)
 void _validateCustom (string $method_list, string $name)
 void _validatePlus ()
Variables
mixed $action_error (line 52)
  • access: protected
mixed $ae (line 55)
  • access: protected
mixed $app_ne_vars = array() (line 46)
  • access: protected
mixed $app_vars = array() (line 43)
  • access: protected
mixed $backend (line 49)
  • access: protected
array $def = array('name', 'required', 'max', 'min', 'regexp', 'mbregexp',
'custom', 'filter', 'form_type', 'type')
(line 67)
  • var: フォーム定義要素
  • access: protected
mixed $def_noplugin = array('type', 'form', 'name', 'plugin', 'filter',
'option', 'default')
(line 71)
  • access: protected
mixed $force_validate_plus = false (line 75)
  • access: protected
array $form = array() (line 37)
  • var: フォーム値定義
  • access: protected
array $form_template = array() (line 34)
  • var: フォーム値定義(デフォルト)
  • access: protected
mixed $form_vars = array() (line 40)
  • access: public
mixed $helper_app_object = array() (line 78)
  • access: protected
mixed $helper_skip_form = array() (line 81)
  • access: protected
mixed $i18n (line 58)
  • access: protected
mixed $logger (line 61)
  • access: protected
mixed $max_form_deps = 10 (line 84)
  • access: protected
mixed $plugin (line 64)
  • access: protected
Methods
Constructor __construct (line 94)

Ethna_ActionFormクラスのコンストラクタ

  • access: public
Ethna_ActionForm __construct (object Ethna_Controller $controller)

Redefined in descendants as:
check (line 764)

チェックメソッド(基底クラス)

  • return: チェック対象のフォーム値(エラーが無い場合はnull)
  • access: public
array check (string $name)
  • string $name: フォーム項目名
checkBoolean (line 819)

チェックメソッド: bool値

  • return: エラーオブジェクト(エラーが無い場合はnull)
  • access: public
object Ethna_Error checkBoolean (string $name)
  • string $name: フォーム項目名
checkMailaddress (line 848)

チェックメソッド: メールアドレス

  • return: エラーオブジェクト(エラーが無い場合はnull)
  • access: public
object Ethna_Error checkMailaddress (string $name)
  • string $name: フォーム項目名
checkURL (line 877)

チェックメソッド: URL

  • return: エラーオブジェクト(エラーが無い場合はnull)
  • access: public
object Ethna_Error checkURL (string $name)
  • string $name: フォーム項目名
checkVendorChar (line 784)

チェックメソッド: 機種依存文字

  • return: エラーオブジェクト(エラーが無い場合はnull)
  • access: public
object Ethna_Error checkVendorChar (string $name)
  • string $name: フォーム項目名
clearFormVars (line 431)

ユーザから送信されたフォーム値をクリアする

  • access: public
void clearFormVars ()
get (line 139)

フォーム値のアクセサ(R)

  • return: フォーム値
  • access: public
mixed get (string $name)
  • string $name: フォーム値の名称
getApp (line 489)

アプリケーション設定値のアクセサ(R)

  • return: アプリケーション設定値
  • access: public
mixed getApp (string $name)
  • string $name: キー
getAppArray (line 516)

アプリケーション設定値を配列にして返す

  • return: フォーム値を格納した配列
  • access: public
array getAppArray ([boolean $escape = true])
  • boolean $escape: HTMLエスケープフラグ(true:エスケープする)
getAppNE (line 532)

アプリケーション設定値(自動エスケープなし)のアクセサ(R)

  • return: アプリケーション設定値
  • access: public
mixed getAppNE (string $name)
  • string $name: キー
getAppNEArray (line 559)

アプリケーション設定値(自動エスケープなし)を配列にして返す

  • return: フォーム値を格納した配列
  • access: public
array getAppNEArray ([boolean $escape = false])
  • boolean $escape: HTMLエスケープフラグ(true:エスケープする)
getArray (line 473)

フォーム値を配列にして返す

  • return: フォーム値を格納した配列
  • access: public
array getArray ([bool $escape = true])
  • bool $escape: HTMLエスケープフラグ(true:エスケープする)
getDef (line 151)

フォーム値定義を取得する

  • return: フォーム値定義
  • access: public
array getDef ([string $name = null])
  • string $name: 取得するフォーム名(nullなら全ての定義を取得)
getHiddenVars (line 907)

フォーム値をhiddenタグとして返す

  • return: hiddenタグとして記述されたHTML
  • access: public
string getHiddenVars ([array $include_list = null], [array $exclude_list = null])
  • array $include_list: 配列が指定された場合、その配列に含まれるフォーム項目のみが対象となる
  • array $exclude_list: 配列が指定された場合、その配列に含まれないフォーム項目のみが対象となる
getName (line 171)

フォーム項目表示名を取得する

  • return: フォーム値の表示名
  • access: public
mixed getName (string $name)
  • string $name: フォーム値の名称
handleError (line 973)

フォーム値検証のエラー処理を行う

  • access: public
void handleError (string $name, int $code)
  • string $name: フォーム項目名
  • int $code: エラーコード
isForceValidatePlus (line 595)

追加検証強制フラグを取得する

(通常検証でエラーが発生した場合でも_validatePlus()が呼び出される)

  • return: true:追加検証強制 false:追加検証非強制
  • access: public
bool isForceValidatePlus ()
set (line 443)

フォーム値へのアクセサ(W)

  • access: public
void set (string $name, string $value)
  • string $name: フォーム値の名称
  • string $value: 設定する値
setApp (line 504)

アプリケーション設定値のアクセサ(W)

  • access: public
void setApp (string $name, mixed $value)
  • string $name: キー
  • mixed $value: 値
setAppNE (line 547)

アプリケーション設定値(自動エスケープなし)のアクセサ(W)

  • access: public
void setAppNE (string $name, mixed $value)
  • string $name: キー
  • mixed $value: 値
setDef (line 456)

フォーム値定義を設定する

  • return: フォーム値定義
  • access: public
array setDef (string $name, array $value)
  • string $name: 設定するフォーム名(nullなら全ての定義を設定)
  • array $value: 設定するフォーム値定義
setForceValidatePlus (line 606)

追加検証強制フラグを設定する

  • access: public
void setForceValidatePlus ($force_validate_plus $force_validate_plus)
  • $force_validate_plus $force_validate_plus: 追加検証強制フラグ
setFormDef_PreHelper (line 1256)

フォーム定義変更用、ユーザ定義ヘルパメソッド

Ethna_ActionForm#prepare() が実行される前に ユーザが動的にフォーム定義を変更したい場合に このメソッドをオーバーライドします。

$this->backend も初期化済みのため、DBやセッション の値に基づいてフォーム定義を変更することができます。

  • access: public
void setFormDef_PreHelper ()
setFormDef_ViewHelper (line 1274)

フォーム定義変更用、ユーザ定義ヘルパメソッド

フォームヘルパを使うときに、フォーム定義を動的に 変更したい場合に、このメソッドをオーバーライドします。

以下の定義をテンプレートで行った場合に呼び出されます。

{form ethna_action=...} (ethna_action がない場合は呼び出されません) {form_input action=...} (action がない場合は呼び出されません)

  • access: public
void setFormDef_ViewHelper ()
setFormVars (line 304)

ユーザから送信されたフォーム値をフォーム値定義に従ってインポートする

  • access: public
void setFormVars ()
validate (line 617)

フォーム値検証メソッド

  • return: 発生したエラーの数
  • access: public
int validate ()
_filter (line 1129)

フォーム値に変換フィルタを適用する

  • return: 変換結果
  • access: protected
mixed _filter (mixed $value, int $filter)
  • mixed $value: フォーム値
  • int $filter: フィルタ定義
_filter_alnum_zentohan (line 1155)

フォーム値変換フィルタ: 全角英数字->半角英数字

  • return: 変換結果
  • access: protected
mixed _filter_alnum_zentohan (mixed $value)
  • mixed $value: フォーム値
_filter_alphabet_zentohan (line 1179)

フォーム値変換フィルタ: 全角英字->半角英字

  • return: 変換結果
  • access: protected
mixed _filter_alphabet_zentohan (mixed $value)
  • mixed $value: フォーム値
_filter_kana_hantozen (line 1227)

フォーム値変換フィルタ: 半角カナ->全角カナ

  • return: 変換結果
  • access: protected
mixed _filter_kana_hantozen (mixed $value)
  • mixed $value: フォーム値
_filter_ltrim (line 1191)

フォーム値変換フィルタ: 左空白削除

  • return: 変換結果
  • access: protected
mixed _filter_ltrim (mixed $value)
  • mixed $value: フォーム値
_filter_ntrim (line 1215)

フォーム値変換フィルタ: NULL(0x00)削除

  • return: 変換結果
  • access: protected
mixed _filter_ntrim (mixed $value)
  • mixed $value: フォーム値
_filter_numeric_zentohan (line 1167)

フォーム値変換フィルタ: 全角数字->半角数字

  • return: 変換結果
  • access: protected
mixed _filter_numeric_zentohan (mixed $value)
  • mixed $value: フォーム値
_filter_rtrim (line 1203)

フォーム値変換フィルタ: 右空白削除

  • return: 変換結果
  • access: protected
mixed _filter_rtrim (mixed $value)
  • mixed $value: フォーム値
_getArray (line 576)

フォームを配列にして返す(内部処理)

  • access: public
void _getArray (array &$vars, array &$retval, bool $escape)
  • array &$vars: フォーム(等)の配列
  • array &$retval: 配列への変換結果
  • bool $escape: HTMLエスケープフラグ(true:エスケープする)
_getHelperAppObject (line 1414)

アプリケーションオブジェクト(helper)を生成する

  • access: protected
void _getHelperAppObject ( $key)
  • $key
_getPluginDef (line 1352)

フォーム値定義からプラグインの定義リストを分離する

  • access: protected
void _getPluginDef (string $form_name)
  • string $form_name: プラグインの定義リストを取得するフォームの名前
_setFormDef (line 1325)

フォーム値定義を設定する

  • access: protected
void _setFormDef ()
_setFormDef_HelperObj (line 1287)

ヘルパオブジェクト(アプリケーションオブジェクト) 経由でのフォーム値定義を設定する

  • access: protected
void _setFormDef_HelperObj ()
_setFormTemplate (line 1239)

フォーム値定義テンプレートを設定する

  • return: フォーム値テンプレート
  • access: protected
array _setFormTemplate (array $form_template)
  • array $form_template: フォーム値テンプレート
_validateCustom (line 1109)

カスタムチェックメソッドを実行する

  • access: protected
void _validateCustom (string $method_list, string $name)
  • string $method_list: カスタムメソッド名(カンマ区切り)
  • string $name: フォーム項目名
_validatePlus (line 1098)

ユーザ定義検証メソッド(フォーム値間の連携チェック等)

  • access: protected
void _validatePlus ()

Documentation generated on Fri, 11 Nov 2011 03:57:24 +0900 by phpDocumentor 1.4.3