Refactor code structure for improved readability and maintainability
This commit is contained in:
		| @ -0,0 +1,350 @@ | ||||
| <?php | ||||
| /** | ||||
|  * PHPExcel | ||||
|  * | ||||
|  * Copyright (c) 2006 - 2011 PHPExcel | ||||
|  * | ||||
|  * This library is free software; you can redistribute it and/or | ||||
|  * modify it under the terms of the GNU Lesser General Public | ||||
|  * License as published by the Free Software Foundation; either | ||||
|  * version 2.1 of the License, or (at your option) any later version. | ||||
|  * | ||||
|  * This library 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 | ||||
|  * Lesser General Public License for more details. | ||||
|  * | ||||
|  * You should have received a copy of the GNU Lesser General Public | ||||
|  * License along with this library; if not, write to the Free Software | ||||
|  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA | ||||
|  * | ||||
|  * @category   PHPExcel | ||||
|  * @package    PHPExcel_Worksheet | ||||
|  * @copyright  Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) | ||||
|  * @license    http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt	LGPL | ||||
|  * @version    1.7.6, 2011-02-27 | ||||
|  */ | ||||
|  | ||||
|  | ||||
| /** | ||||
|  * PHPExcel_Worksheet_HeaderFooterDrawing | ||||
|  * | ||||
|  * @category   PHPExcel | ||||
|  * @package    PHPExcel_Worksheet | ||||
|  * @copyright  Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) | ||||
|  */ | ||||
| class PHPExcel_Worksheet_HeaderFooterDrawing extends PHPExcel_Worksheet_Drawing implements PHPExcel_IComparable | ||||
| { | ||||
| 	/** | ||||
| 	 * Path | ||||
| 	 * | ||||
| 	 * @var string | ||||
| 	 */ | ||||
| 	private $_path; | ||||
|  | ||||
| 	/** | ||||
| 	 * Name | ||||
| 	 * | ||||
| 	 * @var string | ||||
| 	 */ | ||||
| 	protected $_name; | ||||
|  | ||||
| 	/** | ||||
| 	 * Offset X | ||||
| 	 * | ||||
| 	 * @var int | ||||
| 	 */ | ||||
| 	protected $_offsetX; | ||||
|  | ||||
| 	/** | ||||
| 	 * Offset Y | ||||
| 	 * | ||||
| 	 * @var int | ||||
| 	 */ | ||||
| 	protected $_offsetY; | ||||
|  | ||||
| 	/** | ||||
| 	 * Width | ||||
| 	 * | ||||
| 	 * @var int | ||||
| 	 */ | ||||
| 	protected $_width; | ||||
|  | ||||
| 	/** | ||||
| 	 * Height | ||||
| 	 * | ||||
| 	 * @var int | ||||
| 	 */ | ||||
| 	protected $_height; | ||||
|  | ||||
| 	/** | ||||
| 	 * Proportional resize | ||||
| 	 * | ||||
| 	 * @var boolean | ||||
| 	 */ | ||||
| 	protected $_resizeProportional; | ||||
|  | ||||
|     /** | ||||
|      * Create a new PHPExcel_Worksheet_HeaderFooterDrawing | ||||
|      */ | ||||
|     public function __construct() | ||||
|     { | ||||
|     	// Initialise values | ||||
|     	$this->_path				= ''; | ||||
|     	$this->_name				= ''; | ||||
|     	$this->_offsetX				= 0; | ||||
|     	$this->_offsetY				= 0; | ||||
|     	$this->_width				= 0; | ||||
|     	$this->_height				= 0; | ||||
|     	$this->_resizeProportional	= true; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Get Name | ||||
|      * | ||||
|      * @return string | ||||
|      */ | ||||
|     public function getName() { | ||||
|     	return $this->_name; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Set Name | ||||
|      * | ||||
|      * @param string $pValue | ||||
|      * @return PHPExcel_Worksheet_HeaderFooterDrawing | ||||
|      */ | ||||
|     public function setName($pValue = '') { | ||||
|     	$this->_name = $pValue; | ||||
|     	return $this; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Get OffsetX | ||||
|      * | ||||
|      * @return int | ||||
|      */ | ||||
|     public function getOffsetX() { | ||||
|     	return $this->_offsetX; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Set OffsetX | ||||
|      * | ||||
|      * @param int $pValue | ||||
|      * @return PHPExcel_Worksheet_HeaderFooterDrawing | ||||
|      */ | ||||
|     public function setOffsetX($pValue = 0) { | ||||
|     	$this->_offsetX = $pValue; | ||||
|     	return $this; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Get OffsetY | ||||
|      * | ||||
|      * @return int | ||||
|      */ | ||||
|     public function getOffsetY() { | ||||
|     	return $this->_offsetY; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Set OffsetY | ||||
|      * | ||||
|      * @param int $pValue | ||||
|      * @return PHPExcel_Worksheet_HeaderFooterDrawing | ||||
|      */ | ||||
|     public function setOffsetY($pValue = 0) { | ||||
|     	$this->_offsetY = $pValue; | ||||
|     	return $this; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Get Width | ||||
|      * | ||||
|      * @return int | ||||
|      */ | ||||
|     public function getWidth() { | ||||
|     	return $this->_width; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Set Width | ||||
|      * | ||||
|      * @param int $pValue | ||||
|      * @return PHPExcel_Worksheet_HeaderFooterDrawing | ||||
|      */ | ||||
|     public function setWidth($pValue = 0) { | ||||
|     	// Resize proportional? | ||||
|     	if ($this->_resizeProportional && $pValue != 0) { | ||||
|     		$ratio = $this->_width / $this->_height; | ||||
|     		$this->_height = round($ratio * $pValue); | ||||
|     	} | ||||
|  | ||||
|     	// Set width | ||||
|     	$this->_width = $pValue; | ||||
|  | ||||
|     	return $this; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Get Height | ||||
|      * | ||||
|      * @return int | ||||
|      */ | ||||
|     public function getHeight() { | ||||
|     	return $this->_height; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Set Height | ||||
|      * | ||||
|      * @param int $pValue | ||||
|      * @return PHPExcel_Worksheet_HeaderFooterDrawing | ||||
|      */ | ||||
|     public function setHeight($pValue = 0) { | ||||
|     	// Resize proportional? | ||||
|     	if ($this->_resizeProportional && $pValue != 0) { | ||||
|     		$ratio = $this->_width / $this->_height; | ||||
|     		$this->_width = round($ratio * $pValue); | ||||
|     	} | ||||
|  | ||||
|     	// Set height | ||||
|     	$this->_height = $pValue; | ||||
|  | ||||
|     	return $this; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Set width and height with proportional resize | ||||
| 	 * Example: | ||||
| 	 * <code> | ||||
|      * $objDrawing->setResizeProportional(true); | ||||
|      * $objDrawing->setWidthAndHeight(160,120); | ||||
| 	 * </code> | ||||
| 	 * | ||||
|      * @author Vincent@luo MSN:kele_100@hotmail.com | ||||
|      * @param int $width | ||||
|      * @param int $height | ||||
|      * @return PHPExcel_Worksheet_HeaderFooterDrawing | ||||
|      */ | ||||
| 	public function setWidthAndHeight($width = 0, $height = 0) { | ||||
| 		$xratio = $width / $this->_width; | ||||
| 		$yratio = $height / $this->_height; | ||||
| 		if ($this->_resizeProportional && !($width == 0 || $height == 0)) { | ||||
| 			if (($xratio * $this->_height) < $height) { | ||||
| 				$this->_height = ceil($xratio * $this->_height); | ||||
| 				$this->_width  = $width; | ||||
| 			} else { | ||||
| 				$this->_width	= ceil($yratio * $this->_width); | ||||
| 				$this->_height	= $height; | ||||
| 			} | ||||
| 		} | ||||
| 		return $this; | ||||
| 	} | ||||
|  | ||||
|     /** | ||||
|      * Get ResizeProportional | ||||
|      * | ||||
|      * @return boolean | ||||
|      */ | ||||
|     public function getResizeProportional() { | ||||
|     	return $this->_resizeProportional; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Set ResizeProportional | ||||
|      * | ||||
|      * @param boolean $pValue | ||||
|      * @return PHPExcel_Worksheet_HeaderFooterDrawing | ||||
|      */ | ||||
|     public function setResizeProportional($pValue = true) { | ||||
|     	$this->_resizeProportional = $pValue; | ||||
|     	return $this; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Get Filename | ||||
|      * | ||||
|      * @return string | ||||
|      */ | ||||
|     public function getFilename() { | ||||
|     	return basename($this->_path); | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Get Extension | ||||
|      * | ||||
|      * @return string | ||||
|      */ | ||||
|     public function getExtension() { | ||||
|         $parts = explode(".", basename($this->_path)); | ||||
|         return end($parts); | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Get Path | ||||
|      * | ||||
|      * @return string | ||||
|      */ | ||||
|     public function getPath() { | ||||
|     	return $this->_path; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Set Path | ||||
|      * | ||||
|      * @param 	string 		$pValue			File path | ||||
|      * @param 	boolean		$pVerifyFile	Verify file | ||||
|      * @throws 	Exception | ||||
|      * @return PHPExcel_Worksheet_HeaderFooterDrawing | ||||
|      */ | ||||
|     public function setPath($pValue = '', $pVerifyFile = true) { | ||||
|     	if ($pVerifyFile) { | ||||
| 	    	if (file_exists($pValue)) { | ||||
| 	    		$this->_path = $pValue; | ||||
|  | ||||
| 	    		if ($this->_width == 0 && $this->_height == 0) { | ||||
| 	    			// Get width/height | ||||
| 	    			list($this->_width, $this->_height) = getimagesize($pValue); | ||||
| 	    		} | ||||
| 	    	} else { | ||||
| 	    		throw new Exception("File $pValue not found!"); | ||||
| 	    	} | ||||
|     	} else { | ||||
|     		$this->_path = $pValue; | ||||
|     	} | ||||
|     	return $this; | ||||
|     } | ||||
|  | ||||
| 	/** | ||||
| 	 * Get hash code | ||||
| 	 * | ||||
| 	 * @return string	Hash code | ||||
| 	 */ | ||||
| 	public function getHashCode() { | ||||
|     	return md5( | ||||
|     		  $this->_path | ||||
|     		. $this->_name | ||||
|     		. $this->_offsetX | ||||
|     		. $this->_offsetY | ||||
|     		. $this->_width | ||||
|     		. $this->_height | ||||
|     		. __CLASS__ | ||||
|     	); | ||||
|     } | ||||
|  | ||||
| 	/** | ||||
| 	 * Implement PHP __clone to create a deep clone, not just a shallow copy. | ||||
| 	 */ | ||||
| 	public function __clone() { | ||||
| 		$vars = get_object_vars($this); | ||||
| 		foreach ($vars as $key => $value) { | ||||
| 			if (is_object($value)) { | ||||
| 				$this->$key = clone $value; | ||||
| 			} else { | ||||
| 				$this->$key = $value; | ||||
| 			} | ||||
| 		} | ||||
| 	} | ||||
| } | ||||
		Reference in New Issue
	
	Block a user