Inheritance diagram for PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing:

Public Member Functions
	__construct ()
	Create a new BaseDrawing. More...

	getImageIndex ()
	Get image index. More...

	getName ()
	Get Name. More...

	setName ($pValue)
	Set Name. More...

	getDescription ()
	Get Description. More...

	setDescription ($description)
	Set Description. More...

	getWorksheet ()
	Get Worksheet. More...

	setWorksheet (?Worksheet $pValue=null, $pOverrideOld=false)
	Set Worksheet. More...

	getCoordinates ()
	Get Coordinates. More...

	setCoordinates ($pValue)
	Set Coordinates. More...

	getOffsetX ()
	Get OffsetX. More...

	setOffsetX ($pValue)
	Set OffsetX. More...

	getOffsetY ()
	Get OffsetY. More...

	setOffsetY ($pValue)
	Set OffsetY. More...

	getWidth ()
	Get Width. More...

	setWidth ($pValue)
	Set Width. More...

	getHeight ()
	Get Height. More...

	setHeight ($pValue)
	Set Height. More...

	setWidthAndHeight ($width, $height)
	Set width and height with proportional resize. More...

	getResizeProportional ()
	Get ResizeProportional. More...

	setResizeProportional ($pValue)
	Set ResizeProportional. More...

	getRotation ()
	Get Rotation. More...

	setRotation ($pValue)
	Set Rotation. More...

	getShadow ()
	Get Shadow. More...

	setShadow (?Drawing\Shadow $pValue=null)
	Set Shadow. More...

	getHashCode ()
	Get hash code. More...

	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy. More...

	setHyperlink (?Hyperlink $pHyperlink=null)

	getHyperlink ()

Protected Attributes
	$name

	$description

	$worksheet

	$coordinates

	$offsetX

	$offsetY

	$width

	$height

	$resizeProportional

	$rotation

	$shadow

Private Attributes
	$imageIndex = 0

	$hyperlink

Static Private Attributes
static	$imageCounter = 0

Detailed Description

Definition at line 9 of file BaseDrawing.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::__construct ( )

Create a new BaseDrawing.

Definition at line 112 of file BaseDrawing.php.

     {
         // 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();
 
         // Set image index
         ++self::$imageCounter;
         $this->imageIndex = self::$imageCounter;
     }

Member Function Documentation

◆ __clone()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::__clone ( )

Implement PHP __clone to create a deep clone, not just a shallow copy.

Definition at line 506 of file BaseDrawing.php.

References $key.

     {
         $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;
             }
         }
     }

◆ getCoordinates()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::getCoordinates ( )

Get Coordinates.

Returns: string

Definition at line 244 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$coordinates.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Drawing\writeDrawing().

     {
         return $this->coordinates;
     }

Here is the caller graph for this function:

◆ getDescription()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::getDescription ( )

Get Description.

Returns: string

Definition at line 171 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$description.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Drawing\writeDrawing().

     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getHashCode()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::getHashCode ( )

Get hash code.

Returns: string Hash code

Implements PhpOffice\PhpSpreadsheet\IComparable.

Definition at line 486 of file BaseDrawing.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\setWorksheet().

     {
         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__
         );
     }

Here is the caller graph for this function:

◆ getHeight()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::getHeight ( )

Get Height.

Returns: int

Definition at line 347 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$height.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Drawing\writeDrawing().

     {
         return $this->height;
     }

Here is the caller graph for this function:

◆ getHyperlink()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::getHyperlink ( )

Returns: null|Hyperlink

Definition at line 528 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$hyperlink.

     {
         return $this->hyperlink;
     }

◆ getImageIndex()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::getImageIndex ( )

Get image index.

Returns: int

Definition at line 137 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$imageIndex.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Drawing\getIndexedFilename(), and PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing\getIndexedFilename().

     {
         return $this->imageIndex;
     }

Here is the caller graph for this function:

◆ getName()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::getName ( )

Get Name.

Returns: string

Definition at line 147 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$name.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Drawing\writeDrawing().

     {
         return $this->name;
     }

Here is the caller graph for this function:

◆ getOffsetX()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::getOffsetX ( )

Get OffsetX.

Returns: int

Definition at line 268 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$offsetX.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Drawing\writeDrawing().

     {
         return $this->offsetX;
     }

Here is the caller graph for this function:

◆ getOffsetY()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::getOffsetY ( )

Get OffsetY.

Returns: int

Definition at line 292 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$offsetY.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Drawing\writeDrawing().

     {
         return $this->offsetY;
     }

Here is the caller graph for this function:

◆ getResizeProportional()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::getResizeProportional ( )

Get ResizeProportional.

Returns: bool

Definition at line 414 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$resizeProportional.

     {
         return $this->resizeProportional;
     }

◆ getRotation()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::getRotation ( )

Get Rotation.

Returns: int

Definition at line 438 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$rotation.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Drawing\writeDrawing().

     {
         return $this->rotation;
     }

Here is the caller graph for this function:

◆ getShadow()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::getShadow ( )

Get Shadow.

Returns: Drawing

Definition at line 462 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$shadow.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Drawing\writeDrawing().

     {
         return $this->shadow;
     }

Here is the caller graph for this function:

◆ getWidth()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::getWidth ( )

Get Width.

Returns: int

Definition at line 316 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$width.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Drawing\writeDrawing().

     {
         return $this->width;
     }

Here is the caller graph for this function:

◆ getWorksheet()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::getWorksheet ( )

Get Worksheet.

Returns: null|Worksheet

Definition at line 195 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$worksheet.

     {
         return $this->worksheet;
     }

◆ setCoordinates()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::setCoordinates ( $pValue )

Set Coordinates.

Parameters

string $pValue eg: 'A1'

Returns: $this

Definition at line 256 of file BaseDrawing.php.

     {
         $this->coordinates = $pValue;
 
         return $this;
     }

◆ setDescription()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::setDescription ( $description )

Set Description.

Parameters

string $description

Returns: $this

Definition at line 183 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$description.

     {
         $this->description = $description;
 
         return $this;
     }

◆ setHeight()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::setHeight ( $pValue )

Set Height.

Parameters

int $pValue

Returns: $this

Definition at line 359 of file BaseDrawing.php.

     {
         // Resize proportional?
         if ($this->resizeProportional && $pValue != 0) {
             $ratio = $this->width / ($this->height != 0 ? $this->height : 1);
             $this->width = (int) round($ratio * $pValue);
         }
 
         // Set height
         $this->height = $pValue;
 
         return $this;
     }

◆ setHyperlink()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::setHyperlink ( ?Hyperlink $pHyperlink = null )

Definition at line 520 of file BaseDrawing.php.

                                                                : void
     {
         $this->hyperlink = $pHyperlink;
     }

◆ setName()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::setName ( $pValue )

Set Name.

Parameters

string $pValue

Returns: $this

Definition at line 159 of file BaseDrawing.php.

     {
         $this->name = $pValue;
 
         return $this;
     }

◆ setOffsetX()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::setOffsetX ( $pValue )

Set OffsetX.

Parameters

int $pValue

Returns: $this

Definition at line 280 of file BaseDrawing.php.

     {
         $this->offsetX = $pValue;
 
         return $this;
     }

◆ setOffsetY()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::setOffsetY ( $pValue )

Set OffsetY.

Parameters

int $pValue

Returns: $this

Definition at line 304 of file BaseDrawing.php.

     {
         $this->offsetY = $pValue;
 
         return $this;
     }

◆ setResizeProportional()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::setResizeProportional ( $pValue )

Set ResizeProportional.

Parameters

bool $pValue

Returns: $this

Definition at line 426 of file BaseDrawing.php.

     {
         $this->resizeProportional = $pValue;
 
         return $this;
     }

◆ setRotation()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::setRotation ( $pValue )

Set Rotation.

Parameters

int $pValue

Returns: $this

Definition at line 450 of file BaseDrawing.php.

     {
         $this->rotation = $pValue;
 
         return $this;
     }

◆ setShadow()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::setShadow ( ?Drawing\Shadow $pValue = null )

Set Shadow.

Parameters

Drawing\Shadow $pValue

Returns: $this

Definition at line 474 of file BaseDrawing.php.

     {
         $this->shadow = $pValue;
 
         return $this;
     }

◆ setWidth()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::setWidth ( $pValue )

Set Width.

Parameters

int $pValue

Returns: $this

Definition at line 328 of file BaseDrawing.php.

     {
         // Resize proportional?
         if ($this->resizeProportional && $pValue != 0) {
             $ratio = $this->height / ($this->width != 0 ? $this->width : 1);
             $this->height = (int) round($ratio * $pValue);
         }
 
         // Set width
         $this->width = $pValue;
 
         return $this;
     }

◆ setWidthAndHeight()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::setWidthAndHeight	(	$width,
		$height
	)

Set width and height with proportional resize.

Example: $objDrawing->setResizeProportional(true); $objDrawing->setWidthAndHeight(160,120);

Author: Vincent MSN:kele_.nosp@m.100@.nosp@m.hotma.nosp@m.il.c.nosp@m.om

Parameters

int	$width
int	$height

Returns: $this

Definition at line 389 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$height, and PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\$width.

     {
         $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 = (int) ceil($xratio * $this->height);
                 $this->width = $width;
             } else {
                 $this->width = (int) ceil($yratio * $this->width);
                 $this->height = $height;
             }
         } else {
             $this->width = $width;
             $this->height = $height;
         }
 
         return $this;
     }

◆ setWorksheet()

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::setWorksheet	(	?Worksheet	$pValue = `null`,
			$pOverrideOld = `false`
	)

Set Worksheet.

Parameters

Worksheet	$pValue
bool	$pOverrideOld	If a Worksheet has already been assigned, overwrite it and remove image from old Worksheet?

Returns: $this

Definition at line 208 of file BaseDrawing.php.

References PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\getHashCode().

     {
         if ($this->worksheet === null) {
             // Add drawing to \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet
             $this->worksheet = $pValue;
             $this->worksheet->getCell($this->coordinates);
             $this->worksheet->getDrawingCollection()->append($this);
         } else {
             if ($pOverrideOld) {
                 // Remove drawing from old \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet
                 $iterator = $this->worksheet->getDrawingCollection()->getIterator();
 
                 while ($iterator->valid()) {
                     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);
             } else {
                 throw new PhpSpreadsheetException('A Worksheet has already been assigned. Drawings can only exist on one \\PhpOffice\\PhpSpreadsheet\\Worksheet.');
             }
         }
 
         return $this;
     }

Here is the call graph for this function:

Field Documentation

◆ $coordinates

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::$coordinates

protected

Definition at line 51 of file BaseDrawing.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\getCoordinates().

◆ $description

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::$description

protected

Definition at line 37 of file BaseDrawing.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\getDescription(), and PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\setDescription().

◆ $height

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::$height

protected

Definition at line 79 of file BaseDrawing.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing\cloneResource(), PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\getHeight(), and PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\setWidthAndHeight().

◆ $hyperlink

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::$hyperlink

private

Definition at line 107 of file BaseDrawing.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\getHyperlink().

◆ $imageCounter

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::$imageCounter = 0

staticprivate

Definition at line 16 of file BaseDrawing.php.

◆ $imageIndex

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::$imageIndex = 0

private

Definition at line 23 of file BaseDrawing.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\getImageIndex().

◆ $name

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::$name

protected

Definition at line 30 of file BaseDrawing.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\getName().

◆ $offsetX

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::$offsetX

protected

Definition at line 58 of file BaseDrawing.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\getOffsetX().

◆ $offsetY

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::$offsetY

protected

Definition at line 65 of file BaseDrawing.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\getOffsetY().

◆ $resizeProportional

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::$resizeProportional

protected

Definition at line 86 of file BaseDrawing.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\getResizeProportional().

◆ $rotation

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::$rotation

protected

Definition at line 93 of file BaseDrawing.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\getRotation().

◆ $shadow

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::$shadow

protected

Definition at line 100 of file BaseDrawing.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\getShadow().

◆ $width

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::$width

protected

Definition at line 72 of file BaseDrawing.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing\cloneResource(), PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\getWidth(), and PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\setWidthAndHeight().

◆ $worksheet

PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing::$worksheet

protected

Definition at line 44 of file BaseDrawing.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing\getWorksheet().

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Worksheet/BaseDrawing.php

Public Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ getCoordinates()

◆ getDescription()

◆ getHashCode()

◆ getHeight()

◆ getHyperlink()

◆ getImageIndex()

◆ getName()

◆ getOffsetX()

◆ getOffsetY()

◆ getResizeProportional()

◆ getRotation()

◆ getShadow()

◆ getWidth()

◆ getWorksheet()

◆ setCoordinates()

◆ setDescription()

◆ setHeight()

◆ setHyperlink()

◆ setName()

◆ setOffsetX()

◆ setOffsetY()

◆ setResizeProportional()

◆ setRotation()

◆ setShadow()

◆ setWidth()

◆ setWidthAndHeight()

◆ setWorksheet()

Field Documentation

◆ $coordinates

◆ $description

◆ $height

◆ $hyperlink

◆ $imageCounter

◆ $imageIndex

◆ $name

◆ $offsetX

◆ $offsetY

◆ $resizeProportional

◆ $rotation

◆ $shadow

◆ $width

◆ $worksheet