1. class
  2. Eccube
  3. Framework
  4. FormParam

FormParam

class FormParam

パラメーター管理クラス

:XXX: addParam と setParam で言う「パラメーター」が用語として競合しているように感じる。(2009/10/17 Seasoft 塚田)

Properties

$arrValue 何も入力されていないときに表示する値 キーはキー名
$disp_name 表示名
$keyname キー名
$length
$convert
$arrCheck
$arrDefault 何も入力されていないときに表示する値 キーはキー名
$input_db DBにそのまま挿入可能か否か
$html_disp_name

Methods

__construct()

コンストラクタ

initParam() deprecated

前方互換用

addParam($disp_name, $keyname, $length = '', $convert = '', $arrCheck = array(), $default = '', $input_db = true)

No description

setParam($arrVal, $seq = false)

No description

setHtmlDispNameArray()

No description

getHtmlDispNameArray()

No description

setParamList($arrVal2d, $keyname)

No description

setDBDate($db_date, $year_key = 'year', $month_key = 'month', $day_key = 'day')

No description

setValue($key, $value)

No description

toLower($key)

No description

checkError($br = true)

No description

void
recursionCheck(string $disp_name, string $func, mixed $value, array $arrErr, integer $length)

CheckError::doFunc() を再帰的に実行する.

void
convParam()

フォームの入力パラメーターに応じて, 再帰的に mbconvertkana 関数を実行する.

recursionConvParam(mixed $value, string $convert)

再帰的に mbconvertkana を実行する.

array
getHashArray(array $arrKey = array())

連想配列で返す

getDbArray()

No description

array
getSwapArray(array $arrKey = array())

配列の縦横を入れ替えて返す

getTitleArray()

No description

getCount()

No description

getFormParamList()

No description

array
getKeyList()

キー名の一覧を返す

getValue($keyname, $default = '')

No description

splitParamCheckBoxes($keyname) deprecated

No description

void
trimParam(boolean $has_wide_space = true)

入力パラメーターの先頭及び末尾にある空白文字を削除する.

void
recursionTrim(mixed $value, boolean $has_wide_space = true)

再帰的に入力パラメーターの先頭及び末尾にある空白文字を削除する.

array
getSearchArray(string $prefix = 'search_')

検索結果引き継ぎ用の連想配列を取得する.

getFormDispArray() deprecated

前方互換用

removeParam(string $keyname)

パラメーターの削除

overwriteParam(string $keyname, string $target, mixed $value)

パラメーター定義の上書き

mixed
getParamSetting(string $keyname = null, string $target = null)

パラメーターの設定情報を取得

Details

at line 60
__construct()

コンストラクタ

at line 92
initParam() deprecated

deprecated 2.12.0 #1702

前方互換用

at line 104
addParam($disp_name, $keyname, $length = '', $convert = '', $arrCheck = array(), $default = '', $input_db = true)

Parameters

$disp_name
$keyname
$length
$convert
$arrCheck
$default
$input_db

at line 119
setParam($arrVal, $seq = false)

Parameters

$arrVal
$seq

at line 134
setHtmlDispNameArray()

at line 159
getHtmlDispNameArray()

at line 165
setParamList($arrVal2d, $keyname)

Parameters

$arrVal2d
$keyname

at line 176
setDBDate($db_date, $year_key = 'year', $month_key = 'month', $day_key = 'day')

Parameters

$db_date
$year_key
$month_key
$day_key

at line 188
setValue($key, $value)

Parameters

$key
$value

at line 197
toLower($key)

Parameters

$key

at line 205
checkError($br = true)

Parameters

$br

at line 288
void recursionCheck(string $disp_name, string $func, mixed $value, array $arrErr, integer $length)

CheckError::doFunc() を再帰的に実行する.

再帰実行した場合は, エラーメッセージを多次元配列で格納する

Parameters

string $disp_name 表示名
string $func チェック種別
mixed $value チェック対象の値 配列の場合は再帰的にチェックする
array $arrErr エラーメッセージを格納する配列(の一部)
integer $length チェック対象の値の長さ

Return Value

void

at line 318
void convParam()

フォームの入力パラメーターに応じて, 再帰的に mbconvertkana 関数を実行する.

Return Value

void

See also

mb_convert_kana

at line 333
recursionConvParam(mixed $value, string $convert)

再帰的に mbconvertkana を実行する.

Parameters

mixed $value 変換する値. 配列の場合は再帰的に実行する.
string $convert mbconvertkana の変換オプション

at line 352
array getHashArray(array $arrKey = array())

連想配列で返す

Parameters

array $arrKey 対象のキー

Return Value

array 連想配列

at line 365
getDbArray()

at line 383
array getSwapArray(array $arrKey = array())

配列の縦横を入れ替えて返す

Parameters

array $arrKey 対象のキー

Return Value

array 縦横を入れ替えた配列

at line 391
getTitleArray()

at line 397
getCount()

at line 405
getFormParamList()

at line 427
array getKeyList()

キー名の一覧を返す

Return Value

array キー名の一覧

at line 433
getValue($keyname, $default = '')

Parameters

$keyname
$default

at line 458
splitParamCheckBoxes($keyname) deprecated

deprecated

Parameters

$keyname

at line 475
void trimParam(boolean $has_wide_space = true)

入力パラメーターの先頭及び末尾にある空白文字を削除する.

Parameters

boolean $has_wide_space 全角空白も削除する場合 true

Return Value

void

at line 489
void recursionTrim(mixed $value, boolean $has_wide_space = true)

再帰的に入力パラメーターの先頭及び末尾にある空白文字を削除する.

Parameters

mixed $value 変換する値. 配列の場合は再帰的に実行する.
boolean $has_wide_space 全角空白も削除する場合 true

Return Value

void

at line 514
array getSearchArray(string $prefix = 'search_')

検索結果引き継ぎ用の連想配列を取得する.

引数で指定した文字列で始まるパラメーター名の入力値を連想配列で取得する.

Parameters

string $prefix パラメーター名の接頭辞

Return Value

array 検索結果引き継ぎ用の連想配列.

at line 532
getFormDispArray() deprecated

deprecated 2.12.0 必要ならば getFormParamList メソッドに引数を追加するなどで実現可能

前方互換用

1次キーが添字なのが特徴だったと思われる。

at line 555
removeParam(string $keyname)

パラメーターの削除

addParamの逆の関数

Parameters

string $keyname

at line 586
overwriteParam(string $keyname, string $target, mixed $value)

パラメーター定義の上書き

Parameters

string $keyname キー名
string $target 上書きしたい項目名(disp_name,length,convert等)
mixed $value 指定した内容に上書きする

at line 606
mixed getParamSetting(string $keyname = null, string $target = null)

パラメーターの設定情報を取得

Parameters

string $keyname 取得するキー名
string $target 項目名(disp_name,length,convert等)

Return Value

mixed パラメーターの設定情報