Rev 911 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed
<?php/*QBPWCF, Quick Build PHP website Component base on Fedora Linux.Copyright (C) 2015~2024 Min-Jhin,ChenThis file is part of QBPWCF.QBPWCF is free software: you can redistribute it and/or modifyit under the terms of the GNU General Public License as published bythe 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 ofMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See theGNU General Public License for more details.You should have received a copy of the GNU General Public Licensealong with Foobar. If not, see <http://www.gnu.org/licenses/>.*/namespace qbpwcf;/*類別說明:跟SOAP應用相關的類別.備註:無.*/class soap{/*#函式說明:#當前類別被呼叫的靜態方法不存在時,將會執行該函數,回報該方法不存在.#回傳結果:#$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,陣列,為呼叫方法時所用的參數.#可省略參數:#無.#參考資料:#__callStatic=>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/*#函式說明:#demo用的服務內容範例#回傳結果#$result,$conf["argv"]的內容。#必填參數:$conf["argv"]="";#要回傳的內容#可省略參數:#無.#參考資料:#無.#備註:#怪怪的,建議做個測試.*/public static function demoService(&$conf){#函式說明:#檢查陣列裡面的特定元素是否存在以及其變數型態是否正確,如果沒有設定則回傳提示訊息。#回傳的結果:#$result["passed"],識別要檢查的全體變數是否存在以及型態是否正確的變數,"true"代表檢查全部通過;"false"代表檢查不通過#$result[$shouldBtCheckedVarName]["varExist"],所檢查的變數是否存在,"false"代表不存在;"true"代表存在#$result[$shouldBtCheckedVarName]["varType"],所檢查的變數型態是否正確,"false"代表錯誤;"true"代表正確#必填寫的參數:$conf["variableCheck"]["isexistMuti"]["varInput"]=$conf;#要檢查的陣列變數$conf["variableCheck"]["isexistMuti"]["variableCheck"]=array("argv1","argv2");#要檢查的變數名稱陣列,形態爲陣列變數,例如: $conf["variableCheck"] = array("id","account","password");#可以省略的參數:#$conf["variableType"]=array();#要檢查的陣列變數內的元素應該爲何種變數形態,形態爲陣列 例如: $conf[variableType] = array("string","int","double");#$conf["canBeEmptyString"]="false";#變數內容如果是空字串就不能算是有設置的話,請設為"false",預設為也算是有設置。$checkResult=variableCheck::isexistMulti($conf["variableCheck"]["isexistMuti"]);unset($conf["variableCheck"]);#如果檢查失敗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#回傳結果return $conf;}#function demoService end/*#函式說明:#demo用的服務內容範例#回傳結果#$result,$conf["argv"]的內容。#必填參數:$conf["argv"]="";#要回傳的內容#可省略參數:#無.#參考資料:#無.#備註:#怪怪的,建議做個測試.*/public static function demoServiceDumpArgu(&$conf){#回傳結果return $conf;}#function demoServiceDumpArgu end/*#函式說明:#建立webService#回傳的結果#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.#$reuslt["error"],執行不正常結束的錯訊息陣列.#$result["function"],當前執行的函式名稱.#$result["info"],webService的要求資訊#$result["listFunctions"],為目前定義可以使用的類別與函式,其他的結果為錯誤尋息。#必填參數:#$conf["servicePhpFile"],字串,提供服務內容的php檔案位置,裏面要有1個名爲 $conf["serviceClassName"] 類別$conf["servicePhpFile"]="";#$conf["serviceClassName"],字串.提供服務的類別名稱,需要在$conf["servicePhpFile"]檔案裏面有的類別,若有使用命名空間,請加上。ex: "yourNamespace\className"$conf["serviceClassName"]=""#可省略參數:#無.#參考資料:#http://www.cnblogs.com/chance1/archive/2009/04/08/1431949.html#http://www.php.net/manual/en/function.is-soap-fault.php#http://www.php.net/manual/en/soapserver.soapserver.php#http://www.php.net/manual/en/soapserver.setclass.php#http://www.php.net/manual/en/soapserver.handle.php#備註:#webService的服務端如果出現任何非xml的輸出就會導致用戶端執行失敗#一份php檔案裡面只能有一個createService函數執行.#要建立為服務的類別必須要include進來後再使用本函數.*/public static function createService(&$conf){#初始化要回傳的變數$result=array();#初始化當前執行的函數名稱$result["funciton"]=__FUNCTION__;#如果 $conf 不為陣列if(gettype($conf)!="array"){#設置執行失敗$result["status"]="false";#設置執行錯誤訊息$result["error"][]="\$conf變數須為陣列形態";#如果傳入的參數為 nullif($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("servicePhpFile","serviceClassName");#$conf["variableCheck::checkArguments"]["mustBeFilledVariableType"],爲必填參數的變數陣列應該爲何種變數形態,形態爲陣列 例如: $conf["mustBeFilledVariableType"] = array("string",integer,"double");$conf["variableCheck::checkArguments"]["mustBeFilledVariableType"]=array("string","string");#$conf["variableCheck::checkArguments"]["referenceVarKey"],字串,$conf參數後面的key值,用於移除不要的參考陣列.$conf["variableCheck::checkArguments"]["referenceVarKey"]="variableCheck::checkArguments";#可以省略的參數:#$conf["variableCheck::checkArguments"]["canBeEmptyString"],必填變數內容如果是空字串就不能算是有設置的話,請設為"false",預設爲"true"。#$conf["variableCheck::checkArguments"]["canBeEmptyString"]="false";#$conf["variableCheck::checkArguments"]["skipableVariableName"],爲可省略參數的變數名稱陣列,形態爲陣列變數,例如: $conf["skipableVariableName"] = array("id","account","password");#$conf["variableCheck::checkArguments"]["skipableVariableName"]=array("ssl","serverIp","port");#$conf["variableCheck::checkArguments"]["skipableVariableType"],爲可省略參數的變數名稱陣列,形態爲陣列變數,例如: $conf["skipableVariableType"] = array("string",integer,"double");#$conf["variableCheck::checkArguments"]["skipableVariableType"]=array("string","string","string");#$conf["variableCheck::checkArguments"]["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是必填參數之一,請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".#$conf["variableCheck::checkArguments"]["skipableVarDefaultValue"]=array("true","127.0.0.1",null);#$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#建立 soap 的服務#因為是在命名空間裡面,所以必須加上絕對位置「\」$array["uri"]=basename($conf["servicePhpFile"]);$soapServer=new \SoapServer(null,$array);#取得webService的要求資訊$result["info"]=$array;#檢查 $conf["serviceClassName"] 是否存在if(!(class_exists($conf["serviceClassName"]))){#設置執行不正常$result["status"]="false";#設置錯誤訊息$result["error"][]="類別 ".$conf["serviceClassName"]." 不存在,請檢查有無在allInOne.php與allInOneForSOAP.php匯入!";#回傳結果return $result;}#if end#設置處理服務的類別$soapServer->setClass($conf["serviceClassName"]);#取得目前已經可以被存取的class與function$result["listFunctions"]=$soapServer->getFunctions();#設置可以接收服務的要求$soapServer->handle();#執行到這邊代表執行正常$result["status"]="true";#值行到這邊代表執行順利return $result;}#function createService end/*#函式說明:#呼叫WebService#回傳的結果#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.#$reuslt["error"],執行不正常結束的錯訊息陣列.#$result["function"],當前執行的函式名稱.#$result["content"],呼叫完WebService所得回傳結果.#$result["info"],取得webService的要求資訊.#$result["info"]["method"],呼叫的方法.#$result["info"]["argv"],呼叫方法用的參數.#必填參數:#$conf["servicePhpFile"],字串,提供服務內容的php檔案的完整絕對位置,裏面要有1個名爲 $conf["serviceClassName"] 類別$conf["servicePhpFile"]="";#$conf["soapMethod"],字串,要呼叫的方法$conf["soapMethod"]="";#$conf["argv"],字串陣列,呼叫方法時所要用到的參數內容,每個元素代表一個參數.$conf["argv"]=array("");#可省略參數:#$conf["ssl"],字串,是否使用ssl,"true"代表要使用;"false"代表不使用,預設爲"false"#$conf["ssl"]="false";#$conf["pem"],字串,用於tls的憑證位置.#$conf["pem"]="";#$conf["serverIp"],字串,服務提供的主機ip位置,預設爲本機"127.0.0.1",也可以用doman name#$conf["serverIp"]="127.0.0.1";#$conf["port"],port通常不用ssl時為80,用ssl時為443.#$conf["port"]="443";#備註:#若$conf["ssl"]設為"true"將會呼叫失敗.#目前無法用非80port呼叫主機的服務.#參考資料:#http://www.cnblogs.com/chance1/archive/2009/04/08/1431949.html#http://www.php.net/manual/en/soapclient.soapcall.php#https://www.php.net/manual/en/soapclient.getlastresponse.php#備註:#$conf["pem"]參數無法真正運作。*/public static function callService(&$conf){#初始化要回傳的變數$result=array();#初始化當前執行的函數名稱$result["funciton"]=__FUNCTION__;#如果沒有參數if(func_num_args()==0){#設置執行失敗$result["status"]="false";#設置執行錯誤訊息$result["error"]="函數".$result["function"]."需要參數";#回傳結果return $result;}#if end#取得參數$result["argv"]=$conf;#如果 $conf 不為陣列if(gettype($conf)!="array"){#設置執行失敗$result["status"]="false";#設置執行錯誤訊息$result["error"][]="\$conf變數須為陣列形態";#如果傳入的參數為 nullif($conf==null){#設置執行錯誤訊息$result["error"][]="\$conf變數不得為null,請檢查函數「".$result["function"]."」的參數設置有無正確!";}#if end#回傳結果return $result;}#if end#檢查參數#函式說明:#檢查必填與可省略的參數,可省略參數可指定預設要給與什麼數值內容。#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.#$reuslt["error"],執行不正常結束的錯訊息陣列.#$result["function"],當前執行的函式名稱.#$result["warning"],警告訊息陣列.#$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("servicePhpFile","soapMethod","argv");#$conf["variableCheck::checkArguments"]["mustBeFilledVariableType"],爲必填參數的變數陣列應該爲何種變數形態,形態爲陣列 例如: $conf["mustBeFilledVariableType"] = array("string",integer,"double");$conf["variableCheck::checkArguments"]["mustBeFilledVariableType"]=array("string","string","array");#$conf["variableCheck::checkArguments"]["referenceVarKey"],字串,$conf參數後面的key值,用於移除不要的參考陣列.$conf["variableCheck::checkArguments"]["referenceVarKey"]="variableCheck::checkArguments";#可以省略的參數:#$conf["variableCheck::checkArguments"]["canBeEmptyString"],必填變數內容如果是空字串就不能算是有設置的話,請設為"false",預設爲"true"。$conf["variableCheck::checkArguments"]["canBeEmptyString"]="false";#$conf["variableCheck::checkArguments"]["skipableVariableName"],爲可省略參數的變數名稱陣列,形態爲陣列變數,例如: $conf["skipableVariableName"] = array("id","account","password");$conf["variableCheck::checkArguments"]["skipableVariableName"]=array("ssl","serverIp","port","pem");#$conf["variableCheck::checkArguments"]["skipableVariableType"],爲可省略參數的變數名稱陣列,形態爲陣列變數,例如: $conf["skipableVariableType"] = array("string",integer,"double");$conf["variableCheck::checkArguments"]["skipableVariableType"]=array("string","string","string","string");#$conf["variableCheck::checkArguments"]["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是必填參數之一,請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".$conf["variableCheck::checkArguments"]["skipableVarDefaultValue"]=array("false","127.0.0.1",null,null);#$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#如果爲要使用 sslif($conf["ssl"]=="true"){#採用 https 協定$conf["ssl"]="https";}#if end#如果爲不使用 sslelse{#則採用 http 協定$conf["ssl"]="http";}#else end#如果沒有設定 $conf["port"]if(!isset($conf["port"])){#如果 $conf["ssl"] 為 "http"if($conf["ssl"]=="http"){#預設為 "80"$conf["port"]="80";}#if end#如果 $conf["ssl"] 為 "true"if($conf["ssl"]=="https"){#預設為 "443"$conf["port"]="443";}#if end}#if end#與webServiceServer建立連結#因為是在命名空間裡面,所以必須加上絕對位置「\」#初始化儲存 SoapClient 用的參數.$soapClientArray=array();#被呼叫的服務其所在位置$soapClientArray["location"]=$conf["ssl"]."://".$conf["serverIp"].":".$conf["port"]."/".$conf["servicePhpFile"];#服務的命名空間$soapClientArray["uri"]=basename($soapClientArray["location"]);#如果是 httpsif($conf["ssl"]==="https"){#如果有設置 "pem"if(isset($conf["pem"])){#如果 "pem" 檔案存在if(file_exists($conf["pem"])){#設置 local_cert#$soapClientArray["local_cert"]=$conf["pem"];#$soapClientArray["passphrase"]="pwd";}#if end}#if end/*#allow_self_signed SSL#https://bugs.php.net/bug.php?id=68855$soapClientArray["stream_context"]=stream_context_create(['ssl' =>[#不驗證 ssl'verify_peer' => false,'verify_peer_name' => false,'allow_self_signed'=> true,#'ciphers' => "SHA1",]]);*/$soapClientArray["ssl_method"]='SOAP_SSL_METHOD_TLS';$soapClientArray["trace"]=true;$soapClientArray["exceptions"]=true;}#if end$soapClient=new \SoapClient(null,$soapClientArray);#取得webService的要求資訊$result["info"]=$soapClientArray;$result["info"]["method"]=$conf["soapMethod"];$result["info"]["argv"]=$conf["argv"];/*#抓取soap過程中的錯誤訊息#http://php.net/manual/en/class.soapfault.php*/#嘗試執行 __soapCalltry{#間接呼叫webService的方法$soapCallresult=$soapClient->__soapCall($conf["soapMethod"],$conf["argv"]);#儲存運行的XML要求$result["requestXML"]="REQUEST:\n" .$soapClient->__getLastRequest() . "\n";}#try end#抓取例外狀況#抓取SoapFault類別,結果儲存到$ecatch(\SoapFault $e){#設置執行失敗$result["status"]="false";#設置錯誤訊息$result["error"]["getCode"]=$e->getCode();$result["error"]["getMessage"]=$e->getMessage();$result["error"]["getFile"]=$e->getFile();$result["error"]["getLine"]=$e->getLine();$result["error"]["getTrace"]=$e->getTrace();$result["error"]["getTraceAsString"]=$e->getTraceAsString();#取得service的回應$result["rawOutput"]=$soapClient->__getLastResponse();#回傳結果return $result;}#catch end#如果沒有回傳的內容if($soapCallresult==NULL){#設置警告訊息$result["warning"][]="沒有接收到回傳的內容(可能執行過程遇到錯誤)";}#if end#取得soap執行後的回傳結果$result["content"]=$soapCallresult;#取得service的回應$result["rawOutput"]=$soapClient->__getLastResponse();#執行到這邊代表執行正常$result["status"]="true";#回傳執行解果return $result;}#function callService end}#class soap end?>