Subversion Repositories php-qbpwcf

<?php

/*

	QBPWCF, Quick Build PHP website Component base on Fedora Linux.

    Copyright (C) 2014~2025 MIN ZHI, CHEN

    This file is part of QBPWCF.

    QBPWCF is free software: you can redistribute it and/or modify

    it under the terms of the GNU General Public License as published by

    the Free Software Foundation, either version 3 of the License, or

    (at your option) any later version.

    QBPWCF is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License

    along with QBPWCF.  If not, see <http://www.gnu.org/licenses/>.

*/

namespace qbpwcf;

/*

類別說明:

跟程式中止有關的類別.

備註:

無.

*/

class stop{

	/*

	#函式說明:

	#當前類別被呼叫的靜態方法不存在時,將會執行該函數,回報該方法不存在.

	#回傳結果:

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

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

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

	#必填參數:

	#$method,物件,為物件實體或類別名稱,會自動置入該參數.

	#$arguments,陣列,為呼叫方法時所用的參數.

	#參考資料:

	#__call=>http://php.net/manual/en/language.oop5.overloading.php#object.callstatic

	*/

	public function __call($method,$arguments){

		#取得當前執行的函式

		$result["function"]=__FUNCTION__;

		#設置執行不正常

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

		#設置執行錯誤

		$result["error"][]=__NAMESPACE__ ."/".$method."() 不存在!";

		#設置所丟入的參數

		$result["error"][]=$arguments;

		#回傳結果

		return $result;

		}#function __call end

	/*

	#函式說明:

	#當前類別被呼叫的靜態方法不存在時,將會執行該函數,回報該方法不存在.

	#回傳結果:

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

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

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

	#必填參數:

	#$method,物件,為物件實體或類別名稱,會自動置入該參數.

	#$arguments,陣列,為呼叫方法時所用的參數.

	#參考資料:

	#__call=>http://php.net/manual/en/language.oop5.overloading.php#object.callstatic

	*/

	public static function __callStatic($method,$arguments){

		#取得當前執行的函式

		$result["function"]=__FUNCTION__;

		#設置執行不正常

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

		#設置執行錯誤

		$result["error"][]="欲呼叫的". __NAMESPACE__ ."/".$method."() 不存在!";

		#設置所丟入的參數

		$result["error"][]=$arguments;

		#回傳結果

		return $result;

		}#function __callStatic end

	/*

	#函式說明:

	#停止執行程式,中止前一刻會印出一段內容

	#回傳結果:

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

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

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

	#必填參數:

	#$conf["comment"],字串,要顯示的錯誤訊息.

	$conf["comment"]="";

	#參考資料:

	#exit=>http://php.net/manual/en/function.exit.php

	#備註:

	#正常來說不會得到回傳的$result,若有則代表異常.

	*/

	function exitWithComment(&$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[$shouldBeCheckedVarName]["varExist"],所檢查的變數是否存在,"false"代表不存在;"true"代表存在

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

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

		#$result["shouldNotBeEmpty"],不應該為空字串或控陣列的變數.

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

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

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

		#必填寫的參數：

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

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

		#$conf["mustBeFilledVariableName"],爲必填參數的變數名稱陣列，形態爲陣列變數，元素數量需要跟"mustBeFilledVariableType"參數的元素數量一致,例如: $conf["mustBeFilledVariableName"] = array("id","account","password");

		$conf["variableCheck::checkArguments"]["mustBeFilledVariableName"]=array("comment");

		#$conf["mustBeFilledVariableType"],爲必填參數的變數陣列應該爲何種變數形態，形態爲陣列,元素數量需要跟"mustBeFilledVariableName"參數的元素數量一致,例如: $conf["mustBeFilledVariableType"] = array("string",integer,"double","resource","object"); , null代表不指定變數形態.

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

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

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

		#可以省略的參數：

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

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

		#$conf["skipableVariableCanNotBeEmpty"],字串陣列,哪些可省略參數不可以為空字串或集合.

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

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

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

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

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

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

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

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

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

		#參考資料來源:

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

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

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

		#如果檢查失敗

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

			#設置錯誤識別

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

			#設置錯誤訊息

			$result["error"]=$checkArguments;

			#回傳結果

			return $result;

			}#if end

		#如果檢查不通過

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

			#設置錯誤識別

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

			#設置錯誤訊息

			$result["error"]=$checkArguments;

			#回傳結果

			return $result;

			}#if end

		#停止執行之前輸出 $conf["comment"] 的內容

		exit($conf["comment"]);

		#執行到這邊代表不正常

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

		#設置錯誤訊息

		$result["error"][]="非預期的錯誤";

		#回傳結果

		return $result;

		}#function exitWithComment end

	/*

	#函式說明:

	#停止執行程式,中止前一刻會印出一段內容

	#回傳結果:

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

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

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

	#必填參數:

	#無.

	#可省略參數:

	#$conf["returnVal"],整數,要回傳給shell的數值,預設為0.

	#$conf["returnVal"]=0;

	#$conf["normalExit"],字串,是否正常結束,若為"true"則會將參數returnVal設置為0,預設為"false".

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

	#$conf["unexpectedEixt"],字串,是否不正常結束,若為"true"則會將參數returnVal設置為1,預設為"false".

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

	#參考資料:

	#exit=>http://php.net/manual/en/function.exit.php

	#備註:

	#正常來說不會得到回傳的$result,若有則代表異常.

	*/

	public static function exitWithReturnValueToShell(&$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[$shouldBeCheckedVarName]["varExist"],所檢查的變數是否存在,"false"代表不存在;"true"代表存在

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

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

		#$result["shouldNotBeEmpty"],不應該為空字串或控陣列的變數.

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

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

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

		#必填寫的參數：

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

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

		#$conf["mustBeFilledVariableName"],爲必填參數的變數名稱陣列，形態爲陣列變數，元素數量需要跟"mustBeFilledVariableType"參數的元素數量一致,例如: $conf["mustBeFilledVariableName"] = array("id","account","password");

		#$conf["variableCheck::checkArguments"]["mustBeFilledVariableName"]=array("comment");

		#$conf["mustBeFilledVariableType"],爲必填參數的變數陣列應該爲何種變數形態，形態爲陣列,元素數量需要跟"mustBeFilledVariableName"參數的元素數量一致,例如: $conf["mustBeFilledVariableType"] = array("string",integer,"double","resource","object"); , null代表不指定變數形態.

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

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

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

		#可以省略的參數：

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

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

		#$conf["skipableVariableCanNotBeEmpty"],字串陣列,哪些可省略參數不可以為空字串或集合.

		$conf["variableCheck::checkArguments"]["skipableVariableCanNotBeEmpty"]=array("returnVal","normalExit","unexpectedEixt");

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

		$conf["variableCheck::checkArguments"]["skipableVariableName"]=array("returnVal","normalExit","unexpectedEixt");

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

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

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

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

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

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

		#參考資料來源:

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

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

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

		#如果檢查失敗

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

			#設置錯誤識別

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

			#設置錯誤訊息

			$result["error"]=$checkArguments;

			#回傳結果

			return $result;

			}#if end

		#如果檢查不通過

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

			#設置錯誤識別

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

			#設置錯誤訊息

			$result["error"]=$checkArguments;

			#回傳結果

			return $result;

			}#if end

		#如果是正常結束

		if($conf["normalExit"]==="true"){

			#回傳代碼設置為0

			$conf["returnVal"]=0;

			}#if end

		else if($conf["unexpectedEixt"]==="true"){

			#回傳代碼設置為1

			$conf["returnVal"]=1;

			}#if end

		#停止執行並回傳 $conf["returnVal"] 給 shell

		exit($conf["returnVal"]);

		#執行到這邊代表不正常

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

		#設置錯誤訊息

		$result["error"][]="非預期的錯誤";

		#回傳結果

		return $result;

		}#function exitWithReturnValueToShell end

	}#class stop end

?>