Horat1us / php-xml-convertible

src/XmlConvertible.php

<?php

namespace Horat1us;

use Horat1us\Services\XmlDifferenceService;
use Horat1us\Services\XmlEqualityService;
use Horat1us\Services\XmlExportService;
use Horat1us\Services\XmlIntersectionService;
use Horat1us\Services\XmlParserService;

/**
 * Class XmlConvertible
 * @package Horat1us
 *
 * @mixin XmlConvertibleInterface
 */
trait XmlConvertible
{
    /**
     * @var XmlConvertibleInterface[]|\DOMNode[]|\DOMElement[]|null
     */
    public ?array $xmlChildren = null;

    /**
     * Name of xml element (class name will be used by default)
     *
     * @var string
     */
    public $xmlElementName;

    /**
     * @param XmlConvertibleInterface $xml
     * @return XmlConvertible|XmlConvertibleInterface|null
     */
    public function xmlIntersect(
        XmlConvertibleInterface $xml
    ) {
        $service = new XmlIntersectionService($this, $xml);

$this of type Horat1us\XmlConvertible is incompatible with the type Horat1us\XmlConvertibleInterface expected by parameter $source of Horat1us\Services\XmlIntersectionService::__construct().

        return $service->intersect();
    }

    /**
     * @param XmlConvertibleInterface $xml
     * @return XmlConvertibleInterface|XmlConvertible|null
     */
    public function xmlDiff(XmlConvertibleInterface $xml)
    {
        $service = new XmlDifferenceService($this, $xml);

$this of type Horat1us\XmlConvertible is incompatible with the type Horat1us\XmlConvertibleInterface expected by parameter $source of Horat1us\Services\XmlDifferenceService::__construct().

        return $service->difference();
    }

    /**
     * Converts object to XML and compares it with given
     *
     * @param XmlConvertibleInterface $xml
     * @return bool
     */
    public function xmlEqual(XmlConvertibleInterface $xml): bool
    {
        $service = new XmlEqualityService($this, $xml);

$this of type Horat1us\XmlConvertible is incompatible with the type Horat1us\XmlConvertibleInterface|null expected by parameter $first of Horat1us\Services\XmlEqualityService::__construct().

        return $service->compare();
    }

    /**
     * @param \DOMDocument|\DOMElement $document
     * @param array $aliases
     * @return XmlConvertibleInterface
     */
    public static function fromXml($document, array $aliases = [])
    {
        /** @var \DOMElement $document */
        if (!in_array(get_called_class(), $aliases)) {
            $aliases[(new \ReflectionClass(get_called_class()))->getShortName()] = get_called_class();
        }
        return (new XmlParserService($document, $aliases))->convert();
    }

    /**
     * @param \DOMDocument|null $document
     * @return \DOMElement
     */
    public function toXml(?\DOMDocument $document = null): \DOMElement
    {
        $service = new XmlExportService($this, $document);

$this of type Horat1us\XmlConvertible is incompatible with the type Horat1us\XmlConvertibleInterface expected by parameter $object of Horat1us\Services\XmlExportService::__construct().

        return $service->export();
    }

    /**
     * Name of xml element (class name will be used by default)
     *
     * @return string
     */
    public function getXmlElementName(): string
    {
        return $this->xmlElementName ?? (new \ReflectionClass(get_called_class()))->getShortName();
    }

    /**
     * Settings name of xml element
     *
     * @param string $name
     * @return static
     */
    public function setXmlElementName(?string $name = null)
    {
        $this->xmlElementName = $name;
        return $this;
    }

    /**
     * @return XmlConvertibleInterface[]|\DOMNode[]|\DOMElement[]|null
     */
    public function getXmlChildren()
    {
        return $this->xmlChildren;
    }

    /**
     * @param XmlConvertibleInterface[]|\DOMNode[]|\DOMElement[]|null $xmlChildren
     * @return static
     */
    public function setXmlChildren(?array $xmlChildren = null)
    {
        $this->xmlChildren = $xmlChildren ?: null;
        return $this;
    }

    /**
     * Getting array of property names which will be used as attributes in created XML
     *
     * @param array|null $properties
     * @return array|string[]
     */
    public function getXmlProperties(?array $properties = null): array
    {
        $properties = $properties
            ?? array_map(
                function (\ReflectionProperty $property) {
                    return $property->getName();
                },
                (new \ReflectionClass(get_called_class()))
                    ->getProperties(\ReflectionProperty::IS_PUBLIC),
            );


        return array_filter($properties, function (string $property) {
            return !in_array($property, ['xmlChildren', 'xmlElementName']);
        });
    }

    public function getXmlProperty(string $property)
    {
        if (!in_array($property, $this->getXmlProperties())) {
            return;
        }
        return $this->{$property};
    }

    /**
     * Cloning all children by default
     */
    public function __clone()
    {
        $this->xmlChildren = array_map(function ($xmlChild) {
            return clone $xmlChild;
        }, $this->xmlChildren ?? []) ?: null;
    }
}