PB-369: Integrate third party library to work with DOMDocument

 - add wrapper classes

Author: cspruiell

app/code/Magento/PageBuilder/Model/Dom/Adapter/AttrInterface.php

@@ -0,0 +1,16 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PageBuilder\Model\Dom\Adapter;
+
+/**
+ * Interface for Attr wrappers
+ */
+interface AttrInterface
+{
+    public function remove():self;
+}

app/code/Magento/PageBuilder/Model/Dom/Adapter/CharacterDataInterface.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PageBuilder\Model\Dom\Adapter;
+
+/**
+ * Interface for CharacterData wrappers
+ */
+interface CharacterDataInterface
+{
+}

app/code/Magento/PageBuilder/Model/Dom/Adapter/CommentInterface.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PageBuilder\Model\Dom\Adapter;
+
+/**
+ * Interface for Comment wrappers
+ */
+interface CommentInterface
+{
+}

app/code/Magento/PageBuilder/Model/Dom/Adapter/DocumentFragmentInterface.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PageBuilder\Model\Dom\Adapter;
+
+use DOMNode;
+use RuntimeException;
+
+/**
+ * Interface for DocumentFragment wrappers
+ */
+interface DocumentFragmentInterface
+{
+    public function appendHTML(string $data):bool;
+}

app/code/Magento/PageBuilder/Model/Dom/Adapter/DocumentInterface.php

@@ -0,0 +1,150 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PageBuilder\Model\Dom\Adapter;
+
+use DOMNode;
+use RuntimeException;
+
+/**
+ * Interface for Document wrappers
+ */
+interface DocumentInterface
+{
+    public function __toString():string;
+
+    public function saveHTML(DOMNode $node = null):string;
+
+    /**
+     * Closes the stream and any underlying resources.
+     *
+     * @return void
+     */
+    public function close():void;
+
+    /**
+     * Separates any underlying resources from the stream.
+     *
+     * After the stream has been detached, the stream is in an unusable state.
+     *
+     * @return resource|null Underlying PHP stream, if any
+     */
+    public function detach();
+
+    /**
+     * Get the size of the stream if known.
+     *
+     * @return int|null Returns the size in bytes if known, or null if unknown.
+     */
+    public function getSize():?int;
+
+    /**
+     * Returns the current position of the file read/write pointer
+     *
+     * @return int Position of the file pointer
+     * @throws RuntimeException on error.
+     */
+    public function tell():int;
+
+    /**
+     * Returns true if the stream is at the end of the stream.
+     *
+     * @return bool
+     */
+    public function eof():bool;
+
+    /**
+     * Returns whether or not the stream is seekable.
+     *
+     * @return bool
+     */
+    public function isSeekable():bool;
+
+    /**
+     * Seek to a position in the stream.
+     *
+     * @link http://www.php.net/manual/en/function.fseek.php
+     * @param int $offset Stream offset
+     * @param int $whence Specifies how the cursor position will be calculated
+     *     based on the seek offset. Valid values are identical to the built-in
+     *     PHP $whence values for `fseek()`.  SEEK_SET: Set position equal to
+     *     offset bytes SEEK_CUR: Set position to current location plus offset
+     *     SEEK_END: Set position to end-of-stream plus offset.
+     * @throws RuntimeException on failure.
+     */
+    public function seek($offset, $whence = SEEK_SET):void;
+
+    /**
+     * Seek to the beginning of the stream.
+     *
+     * If the stream is not seekable, this method will raise an exception;
+     * otherwise, it will perform a seek(0).
+     *
+     * @throws RuntimeException on failure.
+     * @link http://www.php.net/manual/en/function.fseek.php
+     * @see seek()
+     */
+    public function rewind():void;
+
+    /**
+     * Returns whether or not the stream is writable.
+     *
+     * @return bool
+     */
+    public function isWritable():bool;
+
+    /**
+     * Write data to the stream.
+     *
+     * @param string $string The string that is to be written.
+     * @return int Returns the number of bytes written to the stream.
+     * @throws RuntimeException on failure.
+     */
+    public function write($string):int;
+
+    /**
+     * Returns whether or not the stream is readable.
+     *
+     * @return bool
+     */
+    public function isReadable():bool;
+
+    /**
+     * Read data from the stream.
+     *
+     * @param int $length Read up to $length bytes from the object and return
+     *     them. Fewer than $length bytes may be returned if underlying stream
+     *     call returns fewer bytes.
+     * @return string Returns the data read from the stream, or an empty string
+     *     if no bytes are available.
+     * @throws RuntimeException if an error occurs.
+     */
+    public function read($length):string;
+
+    /**
+     * Returns the remaining contents in a string
+     *
+     * @return string
+     * @throws RuntimeException if unable to read or an error occurs while
+     *     reading.
+     */
+    public function getContents():string;
+
+    /**
+     * Get stream metadata as an associative array or retrieve a specific key.
+     *
+     * The keys returned are identical to the keys returned from PHP's
+     * stream_get_meta_data() function.
+     *
+     * @link http://php.net/manual/en/function.stream-get-meta-data.php
+     * @param string $key Specific metadata to retrieve.
+     * @return array|mixed|null Returns an associative array if no key is
+     *     provided. Returns a specific key value if a key is provided and the
+     *     value is found, or null if the key is not found.
+     */
+    public function getMetadata($key = null);
+}

app/code/Magento/PageBuilder/Model/Dom/Adapter/DocumentTypeInterface.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PageBuilder\Model\Dom\Adapter;
+
+/**
+ * Interface for DocumentType wrappers
+ */
+interface DocumentTypeInterface
+{
+}

app/code/Magento/PageBuilder/Model/Dom/Adapter/ElementInterface.php

@@ -0,0 +1,49 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PageBuilder\Model\Dom\Adapter;
+
+use Gt\Dom\Element;
+
+/**
+ * Interface for Element wrappers
+ */
+interface ElementInterface
+{
+    /**
+     * returns true if the element would be selected by the specified selector
+     * string; otherwise, returns false.
+     * @param string $selectors The CSS selector(s) to check against
+     * @return bool True if this element is selectable by provided selector
+     */
+    public function matches(string $selectors):bool;
+
+    /**
+     * Returns a live HTMLCollection containing all child elements which have all
+     * of the given class names. When called on the document object, the complete
+     * document is searched, including the root node.
+     * @param string $names a string representing the list of class names to
+     *  match; class names are separated by whitespace
+     * @return HtmlCollectionInterface
+     */
+    public function getElementsByClassName(string $names):HtmlCollectionInterface;
+
+    /**
+     * Returns the closest ancestor of the current element (or itself)
+     * which matches the selectors.
+     * @param string $selectors CSS selector(s)
+     * @return ElementInterface|null
+     */
+    public function closest(string $selectors): ?ElementInterface;
+
+    /**
+     * Returns the value of the specified attribute
+     * @param $name
+     * @return string|null
+     */
+    public function getAttribute($name):?string;
+}

app/code/Magento/PageBuilder/Model/Dom/Adapter/HtmlCollectionInterface.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PageBuilder\Model\Dom\Adapter;
+
+/**
+ * Interface for HtmlCollection wrappers
+ */
+interface HtmlCollectionInterface
+{
+	/**
+     * Returns the specific Node whose ID or, as a fallback,
+     * name matches the string specified by $name. Matching by name is only done
+     * as a last resort, and only if the referenced element supports the name
+     * attribute.
+     * @param string $name
+     * @return ElementInterface
+     */
+    public function namedItem(string $name): ?ElementInterface;
+
+    public function item(int $index): ?ElementInterface;
+
+    public function rewind(): void;
+
+    public function key(): int;
+
+    public function valid(): bool;
+
+    public function next(): void;
+
+    public function current(): ?ElementInterface;
+
+    public function offsetExists($offset): bool;
+
+    public function offsetGet($offset): ?ElementInterface;
+
+    public function offsetSet($offset, $value): void;
+
+    public function offsetUnset($offset): void;
+
+    public function count(): int;
+}

app/code/Magento/PageBuilder/Model/Dom/Adapter/HtmlDocumentInterface.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PageBuilder\Model\Dom\Adapter;
+
+/**
+ * Interface for HtmlDocument wrappers
+ */
+interface HtmlDocumentInterface
+{
+    /**
+     * Returns collection of elements matching the specified class names
+     * @param string $names
+     * @return HtmlCollectionInterface
+     */
+    public function getElementsByClassName(string $names):HtmlCollectionInterface;
+}

app/code/Magento/PageBuilder/Model/Dom/Adapter/NodeInterface.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PageBuilder\Model\Dom\Adapter;
+
+/**
+ * Interface for Node wrappers
+ */
+interface NodeInterface
+{
+}