PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer\SpContainer

Complexity

Total Complexity

27

Size/Duplication

Total Lines	288
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

26 Methods

Rating	Name	Duplication	Size	Complexity
A	getSpFlag()	0	3	1
A	setSpFlag()	0	3	1
A	getParent()	0	3	1
A	setSpgr()	0	3	1
A	setSpType()	0	3	1
A	setOPT()	0	3	1
A	getSpId()	0	3	1
A	setSpId()	0	3	1
A	setParent()	0	3	1
A	getSpType()	0	3	1
A	getSpgr()	0	3	1
A	getOPT()	0	3	1
A	setEndOffsetY()	0	3	1
A	setEndCoordinates()	0	3	1
A	getStartCoordinates()	0	3	1
A	getNestingLevel()	0	11	2
A	getStartOffsetX()	0	3	1
A	setStartOffsetY()	0	3	1
A	getEndCoordinates()	0	3	1
A	setEndOffsetX()	0	3	1
A	getEndOffsetY()	0	3	1
A	setStartCoordinates()	0	3	1
A	setStartOffsetX()	0	3	1
A	getOPTCollection()	0	3	1
A	getStartOffsetY()	0	3	1
A	getEndOffsetX()	0	3	1

<?php

namespace PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer;

use PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer;

class SpContainer
{
    /**
     * Parent Shape Group Container.
     */
    private SpgrContainer $parent;

    /**
     * Is this a group shape?
     */
    private bool $spgr = false;

    /**
     * Shape type.
     */
    private int $spType;

    /**
     * Shape flag.
     */
    private int $spFlag;

    /**
     * Shape index (usually group shape has index 0, and the rest: 1,2,3...).
     */
    private int $spId;

    /**
     * Array of options.
     */
    private array $OPT = [];

    /**
     * Cell coordinates of upper-left corner of shape, e.g. 'A1'.
     */
    private string $startCoordinates = '';

    /**
     * Horizontal offset of upper-left corner of shape measured in 1/1024 of column width.
     */
    private int|float $startOffsetX;

    /**
     * Vertical offset of upper-left corner of shape measured in 1/256 of row height.
     */
    private int|float $startOffsetY;

    /**
     * Cell coordinates of bottom-right corner of shape, e.g. 'B2'.
     */
    private string $endCoordinates;

    /**
     * Horizontal offset of bottom-right corner of shape measured in 1/1024 of column width.
     */
    private int|float $endOffsetX;

    /**
     * Vertical offset of bottom-right corner of shape measured in 1/256 of row height.
     */
    private int|float $endOffsetY;

    /**
     * Set parent Shape Group Container.
     */
    public function setParent(SpgrContainer $parent): void
    {
        $this->parent = $parent;
    }

    /**
     * Get the parent Shape Group Container.
     */
    public function getParent(): SpgrContainer
    {
        return $this->parent;
    }

    /**
     * Set whether this is a group shape.
     */
    public function setSpgr(bool $value): void
    {
        $this->spgr = $value;
    }

    /**
     * Get whether this is a group shape.
     */
    public function getSpgr(): bool
    {
        return $this->spgr;
    }

    /**
     * Set the shape type.
     */
    public function setSpType(int $value): void
    {
        $this->spType = $value;
    }

    /**
     * Get the shape type.
     */
    public function getSpType(): int
    {
        return $this->spType;
    }

    /**
     * Set the shape flag.
     */
    public function setSpFlag(int $value): void
    {
        $this->spFlag = $value;
    }

    /**
     * Get the shape flag.
     */
    public function getSpFlag(): int
    {
        return $this->spFlag;
    }

    /**
     * Set the shape index.
     */
    public function setSpId(int $value): void
    {
        $this->spId = $value;
    }

    /**
     * Get the shape index.
     */
    public function getSpId(): int
    {
        return $this->spId;
    }

    /**
     * Set an option for the Shape Group Container.
     *
     * @param int $property The number specifies the option
     */
    public function setOPT(int $property, mixed $value): void
    {
        $this->OPT[$property] = $value;
    }

    /**
     * Get an option for the Shape Group Container.
     *
     * @param int $property The number specifies the option
     */
    public function getOPT(int $property): mixed
    {
        return $this->OPT[$property] ?? null;
    }

    /**
     * Get the collection of options.
     */
    public function getOPTCollection(): array
    {
        return $this->OPT;
    }

    /**
     * Set cell coordinates of upper-left corner of shape.
     *
     * @param string $value eg: 'A1'
     */
    public function setStartCoordinates(string $value): void
    {
        $this->startCoordinates = $value;
    }

    /**
     * Get cell coordinates of upper-left corner of shape.
     */
    public function getStartCoordinates(): string
    {
        return $this->startCoordinates;
    }

    /**
     * Set offset in x-direction of upper-left corner of shape measured in 1/1024 of column width.
     */
    public function setStartOffsetX(int|float $startOffsetX): void
    {
        $this->startOffsetX = $startOffsetX;
    }

    /**
     * Get offset in x-direction of upper-left corner of shape measured in 1/1024 of column width.
     */
    public function getStartOffsetX(): int|float
    {
        return $this->startOffsetX;
    }

    /**
     * Set offset in y-direction of upper-left corner of shape measured in 1/256 of row height.
     */
    public function setStartOffsetY(int|float $startOffsetY): void
    {
        $this->startOffsetY = $startOffsetY;
    }

    /**
     * Get offset in y-direction of upper-left corner of shape measured in 1/256 of row height.
     */
    public function getStartOffsetY(): int|float
    {
        return $this->startOffsetY;
    }

    /**
     * Set cell coordinates of bottom-right corner of shape.
     *
     * @param string $value eg: 'A1'
     */
    public function setEndCoordinates(string $value): void
    {
        $this->endCoordinates = $value;
    }

    /**
     * Get cell coordinates of bottom-right corner of shape.
     */
    public function getEndCoordinates(): string
    {
        return $this->endCoordinates;
    }

    /**
     * Set offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width.
     */
    public function setEndOffsetX(int|float $endOffsetX): void
    {
        $this->endOffsetX = $endOffsetX;
    }

    /**
     * Get offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width.
     */
    public function getEndOffsetX(): int|float
    {
        return $this->endOffsetX;
    }

    /**
     * Set offset in y-direction of bottom-right corner of shape measured in 1/256 of row height.
     */
    public function setEndOffsetY(int|float $endOffsetY): void
    {
        $this->endOffsetY = $endOffsetY;
    }

    /**
     * Get offset in y-direction of bottom-right corner of shape measured in 1/256 of row height.
     */
    public function getEndOffsetY(): int|float
    {
        return $this->endOffsetY;
    }

    /**
     * Get the nesting level of this spContainer. This is the number of spgrContainers between this spContainer and
     * the dgContainer. A value of 1 = immediately within first spgrContainer
     * Higher nesting level occurs if and only if spContainer is part of a shape group.
     *
     * @return int Nesting level
     */
    public function getNestingLevel(): int
    {
        $nestingLevel = 0;

        $parent = $this->getParent();
        while ($parent instanceof SpgrContainer) {
            ++$nestingLevel;
            $parent = $parent->getParent();
        }

        return $nestingLevel;
    }
}