Subversion Repositories php-qbpwcf

	#用來檢查指定 session 變數是否存在以及其值是否正確,如果檢查不通過,可進行轉址.

	#回傳結果：

	#$result["status"],執行是否正常,"true"為正常,"false"為不正常.

	#$result["function"],當前執行的函數名稱.

	#必填參數:

	#$conf["key"],字串陣列,session的key名稱與層級.

	$conf["key"]=array();

	#$conf["content"],session的內容應該要等於什麼才是對的.

	$conf["content"]=;

	#$conf["failLocation"],當驗證失敗時要轉址到的位置.

	$conf["failLocation"]="";

	#可省略參數:

	#$conf["unsetSess"],字串,預設為"false",代表不需要清除檢查過的seession變數;反之為"true".

	#$conf["unsetSess"]="false";

	#參考資料:

	#無.

	#備註:

	#無.

	*/	

	public static function validateSession(&$conf){

		#初始化要回傳的變數

		$result=array();

		#記錄當前執行的函數名稱

		$result["function"]=__FUNCTION__;

		#如果 $conf 不為陣列

		if(gettype($conf)!="array"){

			#設置執行失敗

			$result["status"]="false";

			#設置執行錯誤訊息

			$result["error"][]="\$conf變數須為陣列形態";

			#如果傳入的參數為 null

			if($conf==null){

				#設置執行錯誤訊息

				$result["error"][]="\$conf變數不得為null,請檢查函數「".$result["function"]."」的參數設置有無正確!";

				}#if end

			#回傳結果

			return $result;

			}#if end

		#檢查參數

		#函式說明:

		#檢查必填與可省略的參數，可省略參數可指定預設要給與什麼數值內容。

		#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.

		#$reuslt["error"],執行不正常結束的錯訊息陣列.

		#$result["function"],當前執行的函式名稱.

		#$result["passed"],識別要檢查的全體變數是否存在以及型態是否正確的變數,"true"代表檢查全部通過;"false"代表檢查不通過

		#$result[$shouldBtCheckedVarName]["varExist"],所檢查的變數是否存在,"false"代表不存在;"true"代表存在

		#$result[$shouldBtCheckedVarName]["varType"],所檢查的變數型態是否正確,"false"代表錯誤;"true"代表正確

		#$result[$shouldBtCheckedVarName]["error"],每個參數設定的錯誤訊息

		#$result["argu"],字串陣列,目前輸入的參數名稱陣列.

		#$result["legalVarName"],字串陣列,合法可用的參數名稱陣列.

		#$result["notNeedVar"],字串陣列,多餘的參數名稱.

		#必填參數:

		#$conf["variableCheck::checkArguments"]["varInput"],陣列變數,要檢查的陣列變數,請在要檢查的參數前面加上&，這樣變動的結果才能被套用。

		$conf["variableCheck::checkArguments"]["varInput"]=&$conf;

		#$conf["variableCheck::checkArguments"]["mustBeFilledVariableName"],爲必填參數的變數名稱陣列，形態爲陣列變數，例如: $conf["mustBeFilledVariableName"] = array("id","account","password");

		$conf["variableCheck::checkArguments"]["mustBeFilledVariableName"]=array("key","content","failLocation");

		#$conf["variableCheck::checkArguments"]["mustBeFilledVariableType"],爲必填參數的變數陣列應該爲何種變數形態，形態爲陣列 例如: $conf["mustBeFilledVariableType"] = array("string",integer,"double"); 

		$conf["variableCheck::checkArguments"]["mustBeFilledVariableType"]=array("array","string","string");

		#$conf["variableCheck::checkArguments"]["referenceVarKey"],字串,$conf參數後面的key值,用於移除不要的參考陣列.

		$conf["variableCheck::checkArguments"]["referenceVarKey"]="variableCheck::checkArguments";

		#可以省略的參數：

		#$conf["canBeEmptyString"],必填變數內容如果是空字串就不能算是有設置的話，請設為"false",預設爲"true"。

		$conf["variableCheck::checkArguments"]["canBeEmptyString"]="false";

		#$conf["skipableVariableName"],爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableName"] = array("id","account","password");

		$conf["variableCheck::checkArguments"]["skipableVariableName"]=array("unsetSess");

		#$conf["skipableVariableType"],爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableType"] = array("string",integer,"double"); 

		$conf["variableCheck::checkArguments"]["skipableVariableType"]=array("string");

		#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是必填參數之一，請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".

		$conf["variableCheck::checkArguments"]["skipableVarDefaultValue"]=array("false");

		#$conf["arrayCountEqualCheck"],字串陣列,為檢查哪些陣列參數的元素數量要一樣,$conf["arrayCountEqualCheck"][$i]=array()為第$i組key為哪些的變數其元素數量要相等.

		#$conf["arrayCountEqualCheck"][]=array();

		#參考資料來源:

		#array_keys=>http://php.net/manual/en/function.array-keys.php

		$checkResult=variableCheck::checkArguments($conf["variableCheck::checkArguments"]);

		unset($conf["variableCheck::checkArguments"]);

		#如果檢查失敗

		if($checkResult["status"]==="false"){

			#設置執行失敗

			$result["status"]="false";

			#設置執行錯誤訊息

			$result["error"]=$checkResult;

			#回傳結果

			return $result;

			}#if end

		#如果檢查不通過

		if($checkResult["passed"]==="false"){

			#設置執行失敗

			$result["status"]="false";

			#設置執行錯誤訊息

			$result["error"]=$checkResult;

			#回傳結果

			return $result;

			}#if end

		#函式說明:

		#取得指定的session數值 

		#回傳結果:

		#$result["status"],執行是否正常,"true"代表正常,"false"代表有誤.

		#$result["error"],錯誤訊息.

		#$result["founded"],是否有該session變數,"true"代表有,"false"代表沒有.

		#$result["content"],session變數的內容

		#$result["address"],session變數的位址,請用 $yourVar=&$result["address"] 來取得位址.

		#$result["function"],當前執行的函數名稱.

		#$result["argu"],使用的參數.

		#必填參數:

		#$conf["key"],字串陣列,session的key名稱與層級.

		$conf["session::getVal"]["key"]=$conf["key"];

		#可省略參數:

		#$conf["unsetSess"],字串,是否要於成功取得session變數後,將之移除,預設為"false"代表不移除;反之為"true".

		$conf["session::getVal"]["unsetSess"]=$conf["unsetSess"];

		#參考資料:

		#無.

		#備註:

		#無.

		$getVal=session::getVal($conf["session::getVal"]);

		unset($conf["session::getVal"]);

		#如果執行異常

		if($getVal["status"]=="false"){

			#設置執行失敗

			$result["status"]="false";

			#設置執行錯誤訊息

			$result["error"]=$getVal;

			#回傳結果

			return $result;

			}#if end

		#如果指定的session變數不存在 或 session 內容不一樣

		if($getVal["founded"]==="false" || $getVal["content"]!==$conf["content"]){

			#函式說明:

			#設定session變數後,立即轉址.

			#回傳的結果:

			#$result["status"],執行是否成功,"true"代表成功,"false"代表不成功.

			#$result["function"],當前執行的函數名稱.

			#$result["error"],錯誤訊息陣列.

			#必填參數:

			#$conf["headerLocation"],為要轉址到的地方,若爲 $_SERVER["PHP_SELF"]，則爲回到目前頁面,全民資安素養網爲 https://isafe.moe.edu.tw/.

			$conf["header::redirectionNow"]["headerLocation"]=$conf["failLocation"];

			#可省略參數:

			#$conf["sessionName"],字串陣列,可以指派session變數的名稱.

			#$conf["sessionName"]=array("");

			#$conf["sessionValue"]字串陣列,可以指派session變數的內容.

			#$conf["sessionValue"]=array("");

			#參考資料:

			#http://php.net/manual/en/reserved.variables.server.php

			#備註:

			#無.

			$redirectionNow=header::redirectionNow($conf["header::redirectionNow"]);

			unset($conf["header::redirectionNow"]);

			#如果執行異常

			if($redirectionNow["status"]=="false"){

				#設置執行失敗

				$result["status"]="false";

				#設置執行錯誤訊息

				$result["error"]=$redirectionNow;

				#回傳結果

				return $result;

				}#if end

			}#if end

		}#function validateSession end

	/*

	#函式說明: