PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing

Complexity

Total Complexity

80

Size/Duplication

Total Lines	555
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

51 Methods

Rating	Name	Duplication	Size	Complexity
A	getImageWidth()	0	3	1
A	setHeight()	0	12	4
A	getDescription()	0	3	1
A	setShadow()	0	5	1
A	validEditAs()	0	3	1
A	getHyperlink()	0	3	1
A	getFlipVertical()	0	3	1
A	setOffsetY()	0	5	1
A	setFlipVertical()	0	5	1
A	getOffsetY()	0	3	1
A	setOffsetY2()	0	5	1
A	setFlipHorizontal()	0	5	1
A	getHeight()	0	3	1
A	getCoordinates()	0	3	1
A	getImageIndex()	0	3	1
A	setHyperlink()	0	3	1
A	getOpacity()	0	3	1
B	setSizesAndType()	0	14	7
A	setOffsetX2()	0	5	1
A	getSrcRect()	0	3	1
A	__clone()	0	10	4
A	getOffsetX2()	0	3	1
A	getHashCode()	0	17	2
A	getShadow()	0	3	1
A	setEditAs()	0	5	1
A	setName()	0	5	1
A	getEditAs()	0	3	1
A	getWorksheet()	0	3	1
A	__destruct()	0	3	1
A	getOffsetY2()	0	3	1
A	getOffsetX()	0	3	1
A	getImageHeight()	0	3	1
B	setWidthAndHeight()	0	18	7
A	setCoordinates2()	0	5	1
A	setDescription()	0	5	1
A	getWidth()	0	3	1
A	getRotation()	0	3	1
A	getType()	0	3	1
A	setCoordinates()	0	5	1
A	getName()	0	3	1
A	getCoordinates2()	0	3	1
A	getFlipHorizontal()	0	3	1
A	setSrcRect()	0	5	1
A	getResizeProportional()	0	3	1
A	__construct()	0	8	1
A	setOffsetX()	0	5	1
A	setWidth()	0	12	4
A	setOpacity()	0	5	1
A	setResizeProportional()	0	5	1
A	setRotation()	0	5	1
B	setWorksheet()	0	31	8

<?php

namespace PhpOffice\PhpSpreadsheet\Worksheet;

use PhpOffice\PhpSpreadsheet\Cell\Hyperlink;
use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException;
use PhpOffice\PhpSpreadsheet\IComparable;
use PhpOffice\PhpSpreadsheet\Worksheet\Drawing\Shadow;
use SimpleXMLElement;

class BaseDrawing implements IComparable
{
    const EDIT_AS_ABSOLUTE = 'absolute';
    const EDIT_AS_ONECELL = 'oneCell';
    const EDIT_AS_TWOCELL = 'twoCell';
    private const VALID_EDIT_AS = [
        self::EDIT_AS_ABSOLUTE,
        self::EDIT_AS_ONECELL,
        self::EDIT_AS_TWOCELL,
    ];

    /**
     * The editAs attribute, used only with two cell anchor.
     */
    protected string $editAs = '';

    /**
     * Image counter.
     */
    private static int $imageCounter = 0;

    /**
     * Image index.
     */
    private int $imageIndex;

    /**
     * Name.
     */
    protected string $name = '';

    /**
     * Description.
     */
    protected string $description = '';

    /**
     * Worksheet.
     */
    protected ?Worksheet $worksheet = null;

    /**
     * Coordinates.
     */
    protected string $coordinates = 'A1';

    /**
     * Offset X.
     */
    protected int $offsetX = 0;

    /**
     * Offset Y.
     */
    protected int $offsetY = 0;

    /**
     * Coordinates2.
     */
    protected string $coordinates2 = '';

    /**
     * Offset X2.
     */
    protected int $offsetX2 = 0;

    /**
     * Offset Y2.
     */
    protected int $offsetY2 = 0;

    /**
     * Width.
     */
    protected int $width = 0;

    /**
     * Height.
     */
    protected int $height = 0;

    /**
     * Pixel width of image. See $width for the size the Drawing will be in the sheet.
     */
    protected int $imageWidth = 0;

    /**
     * Pixel width of image. See $height for the size the Drawing will be in the sheet.
     */
    protected int $imageHeight = 0;

    /**
     * Proportional resize.
     */
    protected bool $resizeProportional = true;

    /**
     * Rotation.
     */
    protected int $rotation = 0;

    protected bool $flipVertical = false;

    protected bool $flipHorizontal = false;

    /**
     * Shadow.
     */
    protected Shadow $shadow;

    /**
     * Image hyperlink.
     */
    private ?Hyperlink $hyperlink = null;

    /**
     * Image type.
     */
    protected int $type = IMAGETYPE_UNKNOWN;

    /** @var null|SimpleXMLElement|string[] */
    protected $srcRect = [];

    /**
     * Percentage multiplied by 100,000, e.g. 40% = 40,000.
     * Opacity=x is the same as transparency=100000-x.
     */
    protected ?int $opacity = null;

    /**
     * Create a new BaseDrawing.
     */
    public function __construct()
    {
        // Initialise values
        $this->setShadow();

        // Set image index
        ++self::$imageCounter;
        $this->imageIndex = self::$imageCounter;
    }

    public function __destruct()
    {
        $this->worksheet = null;
    }

    public function getImageIndex(): int
    {
        return $this->imageIndex;
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function setName(string $name): self
    {
        $this->name = $name;

        return $this;
    }

    public function getDescription(): string
    {
        return $this->description;
    }

    public function setDescription(string $description): self
    {
        $this->description = $description;

        return $this;
    }

    public function getWorksheet(): ?Worksheet
    {
        return $this->worksheet;
    }

    /**
     * Set Worksheet.
     *
     * @param bool $overrideOld If a Worksheet has already been assigned, overwrite it and remove image from old Worksheet?
     */
    public function setWorksheet(?Worksheet $worksheet = null, bool $overrideOld = false): self
    {
        if ($this->worksheet === null) {
            // Add drawing to \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet
            if ($worksheet !== null && !($this instanceof Drawing && $this->getPath() === '')) {
                $this->worksheet = $worksheet;
                $this->worksheet->getCell($this->coordinates);
                $this->worksheet->getDrawingCollection()->append($this);
            }
        } else {
            if ($overrideOld) {
                // 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($worksheet);
            } else {
                throw new PhpSpreadsheetException('A Worksheet has already been assigned. Drawings can only exist on one \\PhpOffice\\PhpSpreadsheet\\Worksheet.');
            }
        }

        return $this;
    }

    public function getCoordinates(): string
    {
        return $this->coordinates;
    }

    public function setCoordinates(string $coordinates): self
    {
        $this->coordinates = $coordinates;

        return $this;
    }

    public function getOffsetX(): int
    {
        return $this->offsetX;
    }

    public function setOffsetX(int $offsetX): self
    {
        $this->offsetX = $offsetX;

        return $this;
    }

    public function getOffsetY(): int
    {
        return $this->offsetY;
    }

    public function setOffsetY(int $offsetY): self
    {
        $this->offsetY = $offsetY;

        return $this;
    }

    public function getCoordinates2(): string
    {
        return $this->coordinates2;
    }

    public function setCoordinates2(string $coordinates2): self
    {
        $this->coordinates2 = $coordinates2;

        return $this;
    }

    public function getOffsetX2(): int
    {
        return $this->offsetX2;
    }

    public function setOffsetX2(int $offsetX2): self
    {
        $this->offsetX2 = $offsetX2;

        return $this;
    }

    public function getOffsetY2(): int
    {
        return $this->offsetY2;
    }

    public function setOffsetY2(int $offsetY2): self
    {
        $this->offsetY2 = $offsetY2;

        return $this;
    }

    public function getWidth(): int
    {
        return $this->width;
    }

    public function setWidth(int $width): self
    {
        // Resize proportional?
        if ($this->resizeProportional && $width != 0) {
            $ratio = $this->height / ($this->width != 0 ? $this->width : 1);
            $this->height = (int) round($ratio * $width);
        }

        // Set width
        $this->width = $width;

        return $this;
    }

    public function getHeight(): int
    {
        return $this->height;
    }

    public function setHeight(int $height): self
    {
        // Resize proportional?
        if ($this->resizeProportional && $height != 0) {
            $ratio = $this->width / ($this->height != 0 ? $this->height : 1);
            $this->width = (int) round($ratio * $height);
        }

        // Set height
        $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
     */
    public function setWidthAndHeight(int $width, int $height): self
    {
        if ($this->width === 0 || $this->height === 0 || $width === 0 || $height === 0 || !$this->resizeProportional) {
            $this->width = $width;
            $this->height = $height;
        } else {
            $xratio = $width / $this->width;
            $yratio = $height / $this->height;
            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;
            }
        }

        return $this;
    }

    public function getResizeProportional(): bool
    {
        return $this->resizeProportional;
    }

    public function setResizeProportional(bool $resizeProportional): self
    {
        $this->resizeProportional = $resizeProportional;

        return $this;
    }

    public function getRotation(): int
    {
        return $this->rotation;
    }

    public function setRotation(int $rotation): self
    {
        $this->rotation = $rotation;

        return $this;
    }

    public function getShadow(): Shadow
    {
        return $this->shadow;
    }

    public function setShadow(?Shadow $shadow = null): self
    {
        $this->shadow = $shadow ?? new Shadow();

        return $this;
    }

    /**
     * Get hash code.
     *
     * @return string Hash code
     */
    public function getHashCode(): string
    {
        return md5(
            $this->name
            . $this->description
            . (($this->worksheet === null) ? '' : $this->worksheet->getHashCode())
            . $this->coordinates
            . $this->offsetX
            . $this->offsetY
            . $this->coordinates2
            . $this->offsetX2
            . $this->offsetY2
            . $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;
            }
        }
    }

    public function setHyperlink(?Hyperlink $hyperlink = null): void
    {
        $this->hyperlink = $hyperlink;
    }

    public function getHyperlink(): ?Hyperlink
    {
        return $this->hyperlink;
    }

    /**
     * Set Fact Sizes and Type of Image.
     */
    protected function setSizesAndType(string $path): void
    {
        if ($this->imageWidth === 0 && $this->imageHeight === 0 && $this->type === IMAGETYPE_UNKNOWN) {
            $imageData = getimagesize($path);

            if (!empty($imageData)) {
                $this->imageWidth = $imageData[0];
                $this->imageHeight = $imageData[1];
                $this->type = $imageData[2];
            }
        }
        if ($this->width === 0 && $this->height === 0) {
            $this->width = $this->imageWidth;
            $this->height = $this->imageHeight;
        }
    }

    /**
     * Get Image Type.
     */
    public function getType(): int
    {
        return $this->type;
    }

    public function getImageWidth(): int
    {
        return $this->imageWidth;
    }

    public function getImageHeight(): int
    {
        return $this->imageHeight;
    }

    public function getEditAs(): string
    {
        return $this->editAs;
    }

    public function setEditAs(string $editAs): self
    {
        $this->editAs = $editAs;

        return $this;
    }

    public function validEditAs(): bool
    {
        return in_array($this->editAs, self::VALID_EDIT_AS, true);
    }

    /**
     * @return null|SimpleXMLElement|string[]
     */
    public function getSrcRect()
    {
        return $this->srcRect;
    }

    /**
     * @param null|SimpleXMLElement|string[] $srcRect
     */
    public function setSrcRect($srcRect): self
    {
        $this->srcRect = $srcRect;

        return $this;
    }

    public function setFlipHorizontal(bool $flipHorizontal): self
    {
        $this->flipHorizontal = $flipHorizontal;

        return $this;
    }

    public function getFlipHorizontal(): bool
    {
        return $this->flipHorizontal;
    }

    public function setFlipVertical(bool $flipVertical): self
    {
        $this->flipVertical = $flipVertical;

        return $this;
    }

    public function getFlipVertical(): bool
    {
        return $this->flipVertical;
    }

    public function setOpacity(?int $opacity): self
    {
        $this->opacity = $opacity;

        return $this;
    }

    public function getOpacity(): ?int
    {
        return $this->opacity;
    }
}