[moodle]optional_param($parname, $default=NULL, $type=PARAM_CLEAN);

パス:/www/moodle/lib/moodlelib.php
概要:
POSTかGETから取得された、名付けられた変数から特定の値を返します、さもなければ、所定のデフォルト値を返します。

この関数は、パラメータに基づくスクリプトで全てのオプション値を初期化して利用しなければなりません。
使い方は次のようにします。
//利用例
$name = optional_param('name', 'Fred');


//@function
function optional_param($parname, $default=NULL, $type=PARAM_CLEAN);


[required]
@param string $parname
- フォーム(POST or GET)のパラメータ名を指定します。

[optional]
@param mixed $default
- 見つからなかった場合に返す値を指定します。(デフォルトはNULL)
@param int $type
- 期待されるパラメータの型(型は /www/moodle/lib/moodlelib.php 参照)

@return mixed
- 見つかったフォームの値を返します。
//function内部構造の概要
function optional_param($parname, $default=NULL, $type=PARAM_CLEAN) {

// detect_unchecked_vars addition
global $CFG;
if (!empty($CFG->detect_unchecked_vars)) {
global $UNCHECKED_VARS;
unset ($UNCHECKED_VARS->vars[$parname]);
}

if (isset($_POST[$parname])) { // POST has precedence
$param = $_POST[$parname];
} else if (isset($_GET[$parname])) {
$param = $_GET[$parname];
} else {
return $default;
}

return clean_param($param, $type);
}
このエントリーをはてなブックマークに追加

tag : moodle version 1.9.19+

コメントの投稿

非公開コメント

Translation


プロフィール

チーズくん

Author:チーズくん
個人的メモをただ羅列しています。
twitter:@cheese1038

バロメーター
最新記事
最新コメント
最新トラックバック
月別アーカイブ
カテゴリ