WebSVN – php-qbpwcf – Diff – /trunk/usr/lib64/qbpwcf/od.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
 跟open document有關的類別.
 備註:
 無.
 */
 class od{
 	/*
 	#函式說明:
 	#當前類別被呼叫的靜態方法不存在時,將會執行該函數,回報該方法不存在.
 	#回傳結果:
 	#$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
 	/*
 	#函式說明:
 	#匯入phpodt函式庫的函式
 	#回傳結果:
 	#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 	#無
 	#可省略參數:
 	#無
 	*/
 	function importOdtLib(){
 		#取得當前執行的函式
 		$result["function"]=__FUNCTION__;
 		#設定 phpodt lib 的路徑
 		$phpOdtLibPath="lib/phpodt-0.3.3/phpodt.php";
 		#檢查要匯入的套件是否存在
 		#涵式說明：檢查多個檔案與資料夾是否存在.
 		#回傳的結果:
 		#$result["status"],執行正常與否,"true"代表正常,"false"代表不正常.
 		#$result["error"],錯誤訊息陣列.
 		#http://php.net/manual/en/control-structures.foreach.php
 		#備註:
 		#函數file_exists檢查的路徑為檔案系統的路徑
 		$checkMultiFileExist=fileAccess::checkMultiFileExist($conf["fileAccess::checkMultiFileExist"]);
 		unset($conf["fileAccess::checkMultiFileExist"]);
 		#如果檢查檔案是否存在失敗
 		if($checkMultiFileExist["status"]=="false"){
 			#設置錯誤訊息
 			$result["error"]=$checkMultiFileExist;
 			#設置執行不正常
 			$result["status"]="false";
 			#回傳結果
 			return $result;
 			}#if end
 		#如果檔案不存在
 		if($checkMultiFileExist["allExist"]=="false"){
 			#設置錯誤訊息
 			$result["error"]=$checkMultiFileExist;
 			#設置執行不正常
 			$result["status"]="false";
 			#回傳結果
 			return $result;
 			}#if end
 		#匯入 phpodt 套件
 		include($phpOdtLibPath);
 		#設置執行正常
 		$result["status"]="true";
 		#回傳結果
 		return $result;
 		}#function importOdtLib end
 	/*
 	#函式說明:
 	#展示建立odt檔案的功能,會產生名稱為"od::demoOdt.odt"的檔案
 	#回傳結果:
 	#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 	#必填參數:
 	#無
 	#可省略參數:
 	#無
 	#參考資料:
 	#http://php-odt.sourceforge.net/
 	*/
 	function demoOdt(){
 		#取得當前執行的函式
 		$result["function"]=__FUNCTION__;
 		/*
 		#函式說明:
 		#匯入phpodt函式庫的函式
 		#回傳結果:
 		#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 		#無
 		#可省略參數:
 		#無
 		*/
 		$importLib=od::importOdtLib();
 		#如果匯入 phpodt 函式庫失敗
 		if($importLib["status"]=="false"){
 			#設置錯誤訊息
 			$result["error"]=$importLib;
 			#設置執行不正常
 			$result["status"]="false";
 			#回傳結果
 			return $result;
 			}#if end
 		#DEMO
 		$odt=\ODT::getInstance();
 		$p=new \Paragraph();
 		$p->addText('Hello World!!');
 		$odt->output('odT/demoOdt.odt');
 		#取得檔案位置
 		$result["content"]="odT/demoOdt.odt";
 		#設置執行正常
 		$result["status"]="true";
 		#回傳結果
 		return $result;
 		}#function demoOdt
 	/*
 	#函式說明:
 	#匯入phpods函式庫的函式
 	#回傳結果:
 	#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 	#無
 	#可省略參數:
 	#無
 	*/
 	function importOdsLib(){
 		#取得當前執行的函式
 		$result["function"]=__FUNCTION__;
 		#設定 phpods lib 的路徑
 		$phpOdsLibPath="lib/ods-php-0.1rc1/ods.php";
 		#檢查要匯入的套件是否存在
 		#涵式說明：檢查多個檔案與資料夾是否存在.
 		#回傳的結果:
 		#$result["status"],執行正常與否,"true"代表正常,"false"代表不正常.
 		#$result["error"],錯誤訊息陣列.
 		#http://php.net/manual/en/control-structures.foreach.php
 		#備註:
 		#函數file_exists檢查的路徑為檔案系統的路徑
 		$checkMultiFileExist=fileAccess::checkMultiFileExist($conf["fileAccess::checkMultiFileExist"]);
 		unset($conf["fileAccess::checkMultiFileExist"]);
 		#如果檢查檔案是否存在失敗
 		if($checkMultiFileExist["status"]=="false"){
 			#設置錯誤訊息
 			$result["error"]=$checkMultiFileExist;
 			#設置執行不正常
 			$result["status"]="false";
 			#回傳結果
 			return $result;
 			}#if end
 		#如果檔案不存在
 		if($checkMultiFileExist["allExist"]=="false"){
 			#設置錯誤訊息
 			$result["error"]=$checkMultiFileExist;
 			#設置執行不正常
 			$result["status"]="false";
 			#回傳結果
 			return $result;
 			}#if end
 		#匯入 phpodt 套件
 		include($phpOdsLibPath);
 		#設置執行正常
 		$result["status"]="true";
 		#回傳結果
 		return $result;
 		}#function importOdsLib end
 	/*
 	#函式說明:
 	#展示建立ods檔案的功能,會出現檔案名稱為'od::demoOdf.ods'的檔案.
 	#回傳結果:
 	#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 	#無
 	#參考資料:
 	#https://sourceforge.net/projects/ods-php/?source=typ_redirect
 	*/
 	function demoOds(){
 		/*
 		#函式說明:
 		#匯入phpods函式庫的函式
 		#回傳結果:
 		#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 		#無
 		*/
 		$importOdsLib=od::importOdsLib();
 		#如果載入 php ods lib 失敗
 		if($importOdsLib["status"]=="false"){
 			#設置錯誤訊息
 			$result["error"]=$importLib;
 			#設置執行不正常
 			$result["status"]="false";
 			#回傳結果
 			return $result;
 			}#if end
 		#create a new ods file
 		$object=\newOds();
 		#add a cell to sheet 0, row 0, cell 0, with value 1 and type float
 		$object->addCell(0,0,0,1,'float');
 		#add a cell to sheet 0, row 0, cell 1, with value 1 and type float
 		$object->addCell(0,0,1,2,'float');
 		#add a cell to sheet 0, row 1, cell 0, with value 1 and type float
 		$object->addCell(0,1,0,1,'float');
 		#add a cell to sheet 0, row 1, cell 1, with value 1 and type float
 		$object->addCell(0,1,1,2,'float');
 		#save the object to a ods file
 		saveOds($object,'odT/demoOdf.ods');
 		#取得檔案路徑
 		$result["content"]="odT/demoOdf.ods";
 		#設置執行正常
 		$result["status"]="true";
 		#回傳結果
 		return $result;
 		}#function demoOds end
 	/*
 	#函式說明:
 	#建立ods檔案
 	#回傳結果:
 	#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 	#無
 	#參考資料:
 	#https://sourceforge.net/projects/ods-php/?source=typ_redirect
 	*/
 	function createOds(&$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"],執行不正常結束的錯訊息陣列.
 		#必填寫的參數：
 		#$conf["variableCheck::checkArguments"]["varInput"],陣列變數,要檢查的陣列變數,請在要檢查的參數前面加上&，這樣變動的結果才能被套用。
 		$conf["variableCheck::checkArguments"]["varInput"]=&$conf;
 		#$conf["variableCheck::checkArguments"]["mustBeFilledVariableName"],爲必填參數的變數名稱陣列，形態爲陣列變數，例如: $conf["mustBeFilledVariableName"] = array("id","account","password");
 		$conf["variableCheck::checkArguments"]["mustBeFilledVariableName"]=array("filePathAndName","content","fileArgu");
 		#$conf["variableCheck::checkArguments"]["mustBeFilledVariableType"],爲必填參數的變數陣列應該爲何種變數形態，形態爲陣列 例如: $conf["mustBeFilledVariableType"] = array("string",integer,"double");
 		$conf["variableCheck::checkArguments"]["mustBeFilledVariableType"]=array("string","array","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("alt","class");
 		#$conf["variableCheck::checkArguments"]["skipableVariableType"],爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableType"] = array("string",integer,"double");
 		#$conf["variableCheck::checkArguments"]["skipableVariableType"]=array("string","string");
 		#$conf["variableCheck::checkArguments"]["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是必填參數之一，請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".
 		#$conf["variableCheck::checkArguments"]["skipableVarDefaultValue"]=array("","");
 		#$conf["variableCheck::checkArguments"]["arrayCountEqualCheck"],字串陣列,為檢查哪些陣列參數的元素數量要一樣,$conf["arrayCountEqualCheck"][$i]=array()為第$i組key為哪些的變數其元素數量要相等.
 		#$conf["variableCheck::checkArguments"]["arrayCountEqualCheck"][]=array();
 		$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
 		/*
 		#函式說明:
 		#匯入phpods函式庫的函式
 		#回傳結果:
 		#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 		#無
 		#可省略參數:
 		#無
 		*/
 		$importOdsLib=od::importOdsLib();
 		#create a new ods file
 		$object=\newOds();
 		#針對每個分頁
 		foreach($conf["content"] as $tabName=>$tabContent){
 			#如果 $tabContent 不為陣列或元素數量為0
 			if(gettype($tabContent)!="array" || count($tabContent)==0){
 				#結束foreach end
 				break;
 				}#if end
 			#針對每個列
 			foreach($tabContent as $rowName=>$rowContent){
 				#如果 $rowContent 不為陣列或元素數量為0
 				if(gettype($rowContent)!="array" || count($rowContent)==0){
 					#結束foreach end
 					break;
 					}#if end
 				#針對每個行
 				foreach($rowContent as $colName=>$colContent){
 					#如果 $colContent 不為陣列或元素數量為0
 					if(gettype($colContent)!="array" || count($colContent)==0){
 						#結束foreach end
 						break;
 						}#if end
 					#針對每個欄位的內容
 					for($i=0;$i<2;$i++){
 						#如果內容元素不存在
 						if(!isset($colContent[$i])){
 							#如果是數值
 							if($i==0){
 								#設為空字串
 								$colContent[$i]="";
 								}#if end
 							#反之如果是形態
 							else if($i==1){
 								#設為字串
 								$colContent[$i]="string";
 								}#if end
 							}#if end
 						}#for end
 					#add a cell to sheet $tabName, row $rowName, cell $colName, with value $colContent[0] and type $colContent[1]
 					$object->addCell($tabName,$rowName,$colName,$colContent[0],$colContent[1]);
 					}#foreach end
 				}#foreache end
 			}#foreach end
 		#確保路徑
 		#涵式說明：
 		#確保路徑存在.
 		#回傳的結果：
 		#$result["status"],執行正常與否,"true"代表正常,"false"代表不正常.
 		#$result["error"],錯誤訊息陣列.
 		#$resutl["function"],當前執行的涵式名稱.
 		#必填的參數：
 		#$conf["path"],要檢查的路徑
 		$conf["fileAccess::validatePath"]["path"]=$conf["filePathAndName"];
 		#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
 		$conf["fileAccess::validatePath"]["fileArgu"]=$conf["fileArgu"];
 		#可省略參數：
 		#$conf["haveFileName"],字串,"true"代表有$conf["path"]檔案名稱,"false"代表$conf["path"]為純路徑,預設為"false".
 		$conf["fileAccess::validatePath"]["haveFileName"]="true";
 		#$conf["dirPermission"],字串,新建資料夾的權限設定，預設爲0770,亦即擁有者,同群組者可以讀,寫,存取,其他人僅能存取.
 		#$conf["dirPermission"]="";
 		$validatePath=fileAccess::validatePath($conf["fileAccess::validatePath"]);
 		unset($conf["fileAccess::validatePath"]);
 		#如果確保路徑失敗
 		if($validatePath["status"]=="false"){
 			#設置錯誤狀態
 			$result["status"]="false";
 			#設置錯誤提示
 			$result["error"]=$validatePath;
 			#回傳結果
 			return $result;
 			}#if end
 		#save the object to a ods file
 		saveOds($object,$conf["filePathAndName"].".ods");
 		#取得ods檔案的路徑
 		$result["content"]=$conf["filePathAndName"].".ods";
 		#設置執行正常
 		$result["status"]="true";
 		#回傳結果
 		return $result;
 		}#function createOds end
 	/*
 	#函式說明:
 	#建立odt檔案
 	#回傳結果:
 	#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 	#無
 	#參考資料:
 	#https://sourceforge.net/projects/ods-php/?source=typ_redirect
 	*/
 	function createOdt(&$conf){
 		#初始化要回傳的結果
 		$result=array();
 		#取得當前執行的函數名稱
 		$result["function"]=__FUNCTION__;
 		#如果沒有參數
 		if(func_num_args()==0){
 			#設置執行失敗
 			$result["status"]="false";
 			#設置執行錯誤訊息
 			$result["error"]="函數".$result["function"]."需要參數";
 			#回傳結果
 			return $result;
 			}#if end
 		#取得參數
 		$result["argu"]=$conf;
 		#如果 $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"],執行不正常結束的錯訊息陣列.
 		#$conf["canBeEmpty"]=array();
 		#$conf["skipableVariableCanNotBeEmpty"],字串陣列,哪些可省略參數不可以為空字串或空陣列.
 		#$conf["skipableVariableCanNotBeEmpty"]=array();
 		#$conf["skipableVariableName"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableName"] = array("id","account","password");
 		#$conf["variableCheck::checkArguments"]["skipableVariableName"]=array("liId");
 		#$conf["skipableVariableType"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableType"] = array("string",integer,"double");
 		#$conf["variableCheck::checkArguments"]["skipableVariableType"]=array("array");
 		#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是參數之一，請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".
 		#$conf["variableCheck::checkArguments"]["skipableVarDefaultValue"]=array("\$conf[\"liName\"]");
 		#$conf["arrayCountEqualCheck"],字串陣列,為檢查哪些陣列參數的元素數量要一樣,$conf["arrayCountEqualCheck"][$i]=array()為第$i組key為哪些的變數其元素數量要相等.
 		#$conf["variableCheck::checkArguments"]["arrayCountEqualCheck"][]=array("liName","liContnet","liId");
 		#參考資料來源:
 		#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
 		#函式說明:
 		#匯入phpodt函式庫的函式
 		#回傳結果:
 		#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 		#$reuslt["error"],執行不正常結束的錯訊息陣列.
 		#必填參數:
 		#無
 		#可省略參數:
 		#無
 		$importLib=od::importOdtLib();
 		#如果匯入 phpodt 函式庫失敗
 		if($importLib["status"]=="false"){
 			#設置錯誤訊息
 			$result["error"]=$importLib;
 			#設置執行不正常
 			$result["status"]="false";
 			#回傳結果
 			return $result;
 			}#if end
 		#建立實體
 		$odt=\ODT::getInstance();
 		#針對 $conf["content"] 的每個元素
 		foreach($conf["content"] as $pKey=>$pVal){
 			#新增段落
 			$pKey=new \Paragraph();
 			#設置內容
 			$pKey->addText($pVal);
 			}#foreach end
 		#輸出置檔案
 		$odt->output($conf["filePathAndName"].".odt");
 		#取得檔案位置
 		$result["content"]=$conf["filePathAndName"].".odt";
 		#設置執行正常
 		$result["status"]="true";
 		#回傳結果
 		return $result;
 		}#function createOdt end
 	}#class od end
 ?>

Subversion Repositories php-qbpwcf

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