meyfa/php-svg

<?php

namespace SVG\Nodes\Structures;

use SVG\Nodes\SVGNode;
use SVG\Nodes\SVGNodeContainer;
use SVG\Rasterization\SVGRasterizer;
use SVG\Utilities\Units\Length;

/**
 * Represents the SVG tag 'svg'. This is the root node for every image.
 * Has the special attributes x, y, width, height.
 */
class SVGDocumentFragment extends SVGNodeContainer
{
    public const TAG_NAME = 'svg';

    /**
     * @var array $initialStyles A map of style keys to their defaults.
     */
    private static array $initialStyles = [
        'fill'          => '#000000',
        'stroke'        => 'none',
        'stroke-width'  => '1',
        'opacity'       => '1',
        'font-size'     => '16px',
    ];

    /**
     * @param mixed $width  The declared width.
     * @param mixed $height The declared height.
     */
    public function __construct($width = null, $height = null)
    {
        parent::__construct();

        $this->setAttribute('width', $width);
        $this->setAttribute('height', $height);
    }

    /**
     * @return bool Whether this is the root document.
     */
    public function isRoot(): bool
    {
        return $this->getParent() === null;
    }

    /**
     * @return string|null The declared width of this document or null.
     */
    public function getWidth(): ?string
    {
        return $this->getAttribute('width');
    }

    /**
     * Declares a new width for this document.
     *
     * @param mixed $width The new width.
     *
     * @return $this This node instance, for call chaining.
     */
    public function setWidth($width): SVGDocumentFragment
    {
        return $this->setAttribute('width', $width);
    }

    /**
     * @return string|null The declared height of this document or null.
     */
    public function getHeight(): ?string
    {
        return $this->getAttribute('height');
    }

    /**
     * Declares a new height for this document.
     *
     * @param mixed $height The new height.
     *
     * @return $this This node instance, for call chaining.
     */
    public function setHeight($height): SVGDocumentFragment
    {
        return $this->setAttribute('height', $height);
    }

    /**
     * @inheritdoc
     */
    public function getComputedStyle(string $name): ?string
    {
        // return either explicit declarations ...
        $style = parent::getComputedStyle($name);
        if (isset($style) || !isset(self::$initialStyles[$name])) {
            return $style;
        }

        // ... or the default one.
        return self::$initialStyles[$name];
    }

    /**
     * @inheritdoc
     */
    public function rasterize(SVGRasterizer $rasterizer): void
    {
        if ($this->isRoot()) {
            parent::rasterize($rasterizer);
            return;
        }

        // create new rasterizer for nested viewport
        $subRasterizer = new SVGRasterizer(
            $this->getWidth(),          // document width
            $this->getHeight(),         // document height
            $this->getViewBox(),        // viewBox
            Length::convert($this->getWidth() ?: '100%', $rasterizer->getWidth()),
            Length::convert($this->getHeight() ?: '100%', $rasterizer->getHeight())
        );

        // perform rasterization as usual
        parent::rasterize($subRasterizer);
        $img = $subRasterizer->finish();

        // copy nested viewport onto parent viewport
        imagecopy(
            $rasterizer->getImage(),    // destination
            $img,                       // source
            0,                          // dst_x
            0,                          // dst_y
            0,                          // srx_x
            0,                          // src_y
            $subRasterizer->getWidth(), // src_w
            $subRasterizer->getHeight() // src_h
        );
        imagedestroy($img);
    }

    /**
     * @inheritdoc
     */
    public function getSerializableAttributes(): array
    {
        $attrs = parent::getSerializableAttributes();

        if (isset($attrs['width']) && $attrs['width'] === '100%') {
            unset($attrs['width']);
        }
        if (isset($attrs['height']) && $attrs['height'] === '100%') {
            unset($attrs['height']);
        }

        return $attrs;
    }

    /**
     * @inheritdoc
     */
    public function getSerializableNamespaces(): array
    {
        if ($this->isRoot()) {
            return parent::getSerializableNamespaces() + [
                '' => 'http://www.w3.org/2000/svg',
                'xlink' => 'http://www.w3.org/1999/xlink',
            ];
        }
        return parent::getSerializableNamespaces();
    }

    /**
     * Returns the node with the given id, or null if no such node exists in the
     * document.
     *
     * @param string $id The id to search for.
     *
     * @return SVGNode|null The node with the given id if it exists.
     */
    public function getElementById(string $id): ?SVGNode
    {
        // start with document
        $stack = [$this];

        while (!empty($stack)) {
            $elem = array_pop($stack);
            // check current node
            if ($elem->getAttribute('id') === $id) {
                return $elem;
            }
            // add children to stack (tree order traversal)
            if ($elem instanceof SVGNodeContainer) {
                for ($i = $elem->countChildren() - 1; $i >= 0; --$i) {
                    $stack[] = $elem->getChild($i);
                }
            }
        }

        return null;
    }
}