YetiForceCompany/YetiForcePDF

<?php

declare(strict_types=1);
/**
 * PdfObject class.
 *
 * @package   YetiForcePDF\Objects
 *
 * @copyright YetiForce Sp. z o.o
 * @license   MIT
 * @author    Rafal Pospiech <r.pospiech@yetiforce.com>
 */

namespace YetiForcePDF\Objects;

/**
 * Class PdfObject.
 */
class PdfObject extends \YetiForcePDF\Base
{
    /**
     * Basic object type (integer, string, boolean, dictionary etc..).
     *
     * @var string
     */
    protected $basicType = '';
    /**
     * Object name.
     *
     * @var string
     */
    protected $name = 'PdfObject';
    /**
     * Id of the current object.
     *
     * @var int
     */
    protected $id = 1;
    /**
     * Add object to document objects?
     *
     * @var bool
     */
    protected $addToDocument = true;
    /**
     * @var \YetiForcePDF\Document
     */
    protected $document;
    /**
     * Children elements - referenced.
     *
     * @var array
     */
    protected $children = [];
    /**
     * Parent object.
     *
     * @var \YetiForcePDF\Objects\PdfObject
     */
    protected $parent;

    /**
     * Initialisation.
     *
     * @return $this
     */
    public function init()
    {
        if ($this->addToDocument) {
            $this->document->addObject($this);
        }
        return $this;
    }

    /**
     * Set addToDocument variable.
     *
     * @param bool $addToDocument
     *
     * @return $this
     */
    public function setAddToDocument(bool $addToDocument = true)
    {
        $this->addToDocument = $addToDocument;
        return $this;
    }

    /**
     * Set id.
     *
     * @param $id
     *
     * @return $this
     */
    public function setId($id)
    {
        $this->id = $id;
        return $this;
    }

    /**
     * Get object id.
     *
     * @return int
     */
    public function getId(): int
    {
        return $this->id;
    }

    /**
     * Get object name.
     *
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * Get raw id (that will exists in pdf file).
     *
     * @return string
     */
    public function getRawId(): string
    {
        return $this->id . ' 0';
    }

    /**
     * Get object basic type (integer,string, boolean, dictionary etc..).
     *
     * @return string
     */
    public function getBasicType(): string
    {
        return $this->basicType;
    }

    /**
     * Get children elements (pages etc).
     *
     * @param bool  $all     - do we want all children from tree (flat structure)?
     * @param array $current
     */
    public function getChildren(bool $all = false, array &$current = []): array
    {
        if ($all) {
            foreach ($this->children as $child) {
                $current[] = $child;
                $child->getChildren(true, $current);
            }
            return $current;
        }
        return $this->children;
    }

    /**
     * Add child object.
     *
     * @param PdfObject $child
     * @param PdfObject $after - add after this element
     *
     * @throws \InvalidArgumentException
     *
     * @return PdfObject
     */
    public function addChild(self $child, self $after = null): self
    {
        $afterIndex = \count($this->children);
        if ($after) {
            foreach ($this->children as $afterIndex => $childObject) {
                if ($after === $childObject) {
                    break;
                }
            }
            ++$afterIndex;
        }
        if (\in_array($this->getBasicType(), ['Dictionary', 'Array'])) {
            $child->setParent($this);
            if (!$after) {
                return $this->children[] = $child;
            }
            $merge = array_splice($this->children, $afterIndex);
            $this->children[] = $child;
            $this->children = array_merge($this->children, $merge);
            return $child;
        }
        throw new \InvalidArgumentException("Object of basic type '{$this->basicType}' cannot have a child.");
    }

    /**
     * Get parent.
     *
     * @return mixed
     */
    public function getParent()
    {
        return $this->parent;
    }

    /**
     * Set parent object.
     *
     * @param \YetiForcePDF\Objects\PdfObject $parent
     *
     * @return \YetiForcePDF\Objects\PdfObject
     */
    public function setParent(self $parent): self
    {
        $this->parent = $parent;
        return $this;
    }

    /**
     * Get object reference string.
     *
     * @return string
     */
    public function getReference(): string
    {
        return $this->getRawId() . ' R';
    }

    /**
     * Layout current object.
     *
     * @return string
     */
    public function render(): string
    {
        return '';
    }
}