WebSVN – php-qbpwcf – Diff – /trunk/usr/lib64/qbpwcf/stop.php

 <?php
 /*
 	QBPWCF, Quick Build PHP website Component base on Fedora Linux.
-    Copyright (C) 2015~2024 Min-Jhin,Chen
+    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
 跟程式中止有關的類別.
 備註:
 無.
 */
 class stop{
 	/*
 	#函式說明:
 	#當前類別被呼叫的靜態方法不存在時,將會執行該函數,回報該方法不存在.
 	#回傳結果:
 	#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 	#$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"代表不正常.
 	#$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".
 	#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"],當前執行的函式名稱.
 		#$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".
 	#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"],當前執行的函式名稱.
 		#$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
 ?>

Subversion Repositories php-qbpwcf

(root)/trunk/usr/lib64/qbpwcf/stop.php – Rev 3 → 226