See Release Notes
Long Term Support Release
<?php namespace PhpOffice\PhpSpreadsheet\Worksheet; use PhpOffice\PhpSpreadsheet\Cell\Hyperlink; use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException; use PhpOffice\PhpSpreadsheet\IComparable; class BaseDrawing implements IComparable { /** * Image counter. * * @var int */ private static $imageCounter = 0; /** * Image index. * * @var int */ private $imageIndex = 0; /** * Name. * * @var string */ protected $name; /** * Description. * * @var string */ protected $description; /** * Worksheet. *< * @var Worksheet> * @var null|Worksheet*/ protected $worksheet; /** * Coordinates. * * @var string */ protected $coordinates; /** * 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 bool */ protected $resizeProportional; /** * Rotation. * * @var int */ protected $rotation; /** * Shadow. * * @var Drawing\Shadow */ protected $shadow; /** * Image hyperlink. * * @var null|Hyperlink */ private $hyperlink; /**> * Image type. * Create a new BaseDrawing. > * */ > * @var int public function __construct() > */ { > protected $type; // Initialise values > $this->name = ''; > /**$this->description = ''; $this->worksheet = null; $this->coordinates = 'A1'; $this->offsetX = 0; $this->offsetY = 0; $this->width = 0; $this->height = 0; $this->resizeProportional = true; $this->rotation = 0; $this->shadow = new Drawing\Shadow();> $this->type = IMAGETYPE_UNKNOWN;// Set image index ++self::$imageCounter; $this->imageIndex = self::$imageCounter; } /** * Get image index. * * @return int */ public function getImageIndex() { return $this->imageIndex; } /** * Get Name. * * @return string */ public function getName() { return $this->name; } /** * Set Name. *< * @param string $pValue> * @param string $name*< * @return BaseDrawing> * @return $this*/< public function setName($pValue)> public function setName($name){< $this->name = $pValue;> $this->name = $name;return $this; } /** * Get Description. * * @return string */ public function getDescription() { return $this->description; } /** * Set Description. * * @param string $description *< * @return BaseDrawing> * @return $this*/ public function setDescription($description) { $this->description = $description; return $this; } /** * Get Worksheet. *< * @return Worksheet> * @return null|Worksheet*/ public function getWorksheet() { return $this->worksheet; } /** * Set Worksheet. *< * @param Worksheet $pValue < * @param bool $pOverrideOld If a Worksheet has already been assigned, overwrite it and remove image from old Worksheet? < * < * @throws PhpSpreadsheetException> * @param bool $overrideOld If a Worksheet has already been assigned, overwrite it and remove image from old Worksheet?*< * @return BaseDrawing> * @return $this*/< public function setWorksheet(Worksheet $pValue = null, $pOverrideOld = false)> public function setWorksheet(?Worksheet $worksheet = null, $overrideOld = false){ if ($this->worksheet === null) { // Add drawing to \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet< $this->worksheet = $pValue;> $this->worksheet = $worksheet;$this->worksheet->getCell($this->coordinates); $this->worksheet->getDrawingCollection()->append($this); } else {< if ($pOverrideOld) {> if ($overrideOld) {// Remove drawing from old \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $iterator = $this->worksheet->getDrawingCollection()->getIterator(); while ($iterator->valid()) {< if ($iterator->current()->getHashCode() == $this->getHashCode()) {> if ($iterator->current()->getHashCode() === $this->getHashCode()) {$this->worksheet->getDrawingCollection()->offsetUnset($iterator->key()); $this->worksheet = null; break; } } // Set new \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet< $this->setWorksheet($pValue);> $this->setWorksheet($worksheet);} else { throw new PhpSpreadsheetException('A Worksheet has already been assigned. Drawings can only exist on one \\PhpOffice\\PhpSpreadsheet\\Worksheet.'); } } return $this; } /** * Get Coordinates. * * @return string */ public function getCoordinates() { return $this->coordinates; } /** * Set Coordinates. *< * @param string $pValue eg: 'A1'> * @param string $coordinates eg: 'A1'*< * @return BaseDrawing> * @return $this*/< public function setCoordinates($pValue)> public function setCoordinates($coordinates){< $this->coordinates = $pValue;> $this->coordinates = $coordinates;return $this; } /** * Get OffsetX. * * @return int */ public function getOffsetX() { return $this->offsetX; } /** * Set OffsetX. *< * @param int $pValue> * @param int $offsetX*< * @return BaseDrawing> * @return $this*/< public function setOffsetX($pValue)> public function setOffsetX($offsetX){< $this->offsetX = $pValue;> $this->offsetX = $offsetX;return $this; } /** * Get OffsetY. * * @return int */ public function getOffsetY() { return $this->offsetY; } /** * Set OffsetY. *< * @param int $pValue> * @param int $offsetY*< * @return BaseDrawing> * @return $this*/< public function setOffsetY($pValue)> public function setOffsetY($offsetY){< $this->offsetY = $pValue;> $this->offsetY = $offsetY;return $this; } /** * Get Width. * * @return int */ public function getWidth() { return $this->width; } /** * Set Width. *< * @param int $pValue> * @param int $width*< * @return BaseDrawing> * @return $this*/< public function setWidth($pValue)> public function setWidth($width){ // Resize proportional?< if ($this->resizeProportional && $pValue != 0) {> if ($this->resizeProportional && $width != 0) {$ratio = $this->height / ($this->width != 0 ? $this->width : 1);< $this->height = round($ratio * $pValue);> $this->height = (int) round($ratio * $width);} // Set width< $this->width = $pValue;> $this->width = $width;return $this; } /** * Get Height. * * @return int */ public function getHeight() { return $this->height; } /** * Set Height. *< * @param int $pValue> * @param int $height*< * @return BaseDrawing> * @return $this*/< public function setHeight($pValue)> public function setHeight($height){ // Resize proportional?< if ($this->resizeProportional && $pValue != 0) {> if ($this->resizeProportional && $height != 0) {$ratio = $this->width / ($this->height != 0 ? $this->height : 1);< $this->width = round($ratio * $pValue);> $this->width = (int) round($ratio * $height);} // Set height< $this->height = $pValue;> $this->height = $height;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 BaseDrawing> * @return $this > * > * @author Vincent@luo MSN:kele_100@hotmail.com*/ public function setWidthAndHeight($width, $height) { $xratio = $width / ($this->width != 0 ? $this->width : 1); $yratio = $height / ($this->height != 0 ? $this->height : 1); if ($this->resizeProportional && !($width == 0 || $height == 0)) { if (($xratio * $this->height) < $height) {< $this->height = ceil($xratio * $this->height);> $this->height = (int) ceil($xratio * $this->height);$this->width = $width; } else {< $this->width = ceil($yratio * $this->width);> $this->width = (int) ceil($yratio * $this->width);$this->height = $height; } } else { $this->width = $width; $this->height = $height; } return $this; } /** * Get ResizeProportional. * * @return bool */ public function getResizeProportional() { return $this->resizeProportional; } /** * Set ResizeProportional. *< * @param bool $pValue> * @param bool $resizeProportional*< * @return BaseDrawing> * @return $this*/< public function setResizeProportional($pValue)> public function setResizeProportional($resizeProportional){< $this->resizeProportional = $pValue;> $this->resizeProportional = $resizeProportional;return $this; } /** * Get Rotation. * * @return int */ public function getRotation() { return $this->rotation; } /** * Set Rotation. *< * @param int $pValue> * @param int $rotation*< * @return BaseDrawing> * @return $this*/< public function setRotation($pValue)> public function setRotation($rotation){< $this->rotation = $pValue;> $this->rotation = $rotation;return $this; } /** * Get Shadow. * * @return Drawing\Shadow */ public function getShadow() { return $this->shadow; } /** * Set Shadow. *< * @param Drawing\Shadow $pValue < * < * @return BaseDrawing> * @return $this*/< public function setShadow(Drawing\Shadow $pValue = null)> public function setShadow(?Drawing\Shadow $shadow = null){< $this->shadow = $pValue;> $this->shadow = $shadow;return $this; } /** * Get hash code. * * @return string Hash code */ public function getHashCode() { return md5( $this->name . $this->description . $this->worksheet->getHashCode() . $this->coordinates . $this->offsetX . $this->offsetY . $this->width . $this->height . $this->rotation . $this->shadow->getHashCode() . __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 ($key == 'worksheet') { $this->worksheet = null; } elseif (is_object($value)) { $this->$key = clone $value; } else { $this->$key = $value; } } }< /** < * @param null|Hyperlink $pHyperlink < */ < public function setHyperlink(Hyperlink $pHyperlink = null)> public function setHyperlink(?Hyperlink $hyperlink = null): void{< $this->hyperlink = $pHyperlink;> $this->hyperlink = $hyperlink;} /** * @return null|Hyperlink */ public function getHyperlink() { return $this->hyperlink;> } } > } > /** > * Set Fact Sizes and Type of Image. > */ > protected function setSizesAndType(string $path): void > { > if ($this->width == 0 && $this->height == 0 && $this->type == IMAGETYPE_UNKNOWN) { > $imageData = getimagesize($path); > > if (is_array($imageData)) { > $this->width = $imageData[0]; > $this->height = $imageData[1]; > $this->type = $imageData[2]; > } > } > } > > /** > * Get Image Type. > */ > public function getType(): int > { > return $this->type;