Added @Property tags for __get() and __set().

Updated htmldoc::offsetSet() to assume that there is always an index.
comment::minify() now checks that there is content.
custom::__construct() now check that $tagName is not null.
Tightened properties in tag.
Fixed bug in tag::append() where clones were not spliced correctly.
tag::getIndex() now check that the parent is not null.
Fixed some typing issues in tag::minify().
Fixed return value issue in tag::attr().

Author: hexydec

composer.lock

@@ -94,7 +94,7 @@ $ vendor/bin/phpunit
 
 ## Support
 
-HTMLdoc supports PHP version 7.3+.
+HTMLdoc supports PHP version 7.4+.
 
 ## Contributing
 

readme.md

@@ -3,6 +3,10 @@
 namespace hexydec\html;
 use \hexydec\tokens\tokenise;
 
+/**
+ * @property-read array $config
+ * @property-read int $length
+ */
 class htmldoc extends config implements \ArrayAccess, \Iterator {
 
 	/**
@@ -88,11 +92,7 @@ public function toArray() : array {
 	 * @param mixed $value The value of the array key in the children array to be updated
 	 */
 	public function offsetSet($i, $value) : void {
-		if (\is_null($i)) {
-			$this->children[] = $value;
-		} else {
-			$this->children[$i] = $value;
-		}
+		$this->children[$i] = $value;
 	}
 
 	/**
@@ -767,7 +767,7 @@ public function remove(string $selector = null) : htmldoc {
 	 * Compile the document as an HTML string and save it to the specified location
 	 *
 	 * @param array $options An array indicating output options, this is merged with htmldoc::$output
-	 * @return string The compiled HTML
+	 * @return string|bool The compiled HTML
 	 */
 	public function save(string $file = null, array $options = []) {
 

src/htmldoc.php

@@ -39,8 +39,10 @@ public function parse(tokenise $tokens) : void {
 	 * @return void
 	 */
 	public function minify(array $minify) : void {
-		if (!empty($minify['comments']['remove']) && (empty($minify['comments']['ie']) || (\mb_strpos($this->content, '[if ') !== 0 && $this->content !== '<![endif]'))) {
-			$this->content = null;
+		if (!empty($minify['comments']['remove']) && $this->content) {
+			if (empty($minify['comments']['ie']) || (\mb_strpos($this->content, '[if ') !== 0 && $this->content !== '<![endif]')) {
+				$this->content = null;
+			}
 		}
 	}
 

src/tokens/comment.php

@@ -27,7 +27,7 @@ class custom implements token {
 	 * @param string $tag The name of the custom tag, note this cannot be null
 	 */
 	public function __construct(htmldoc $root, string $tagName = null) {
-		$this->tagName = $tagName = \mb_strtolower($tagName);
+		$this->tagName = $tagName = \mb_strtolower($tagName ?? '');
 		$this->config = $root->config['custom'][$tagName];
 	}
 

src/tokens/custom.php

@@ -3,6 +3,17 @@
 namespace hexydec\html;
 use \hexydec\tokens\tokenise;
 
+/**
+ * @property-write \hexydec\html\tag $parent
+ * @property-read htmldoc $root
+ * @property-read array $config
+ * @property-read tag|null $parent
+ * @property-read array $parenttags
+ * @property-read string|null $tagName
+ * @property-read array $attributes
+ * @property-read string|null $singleton
+ * @property-read array $children
+ */
 class tag implements token {
 
 	/**
@@ -16,14 +27,14 @@ class tag implements token {
 	protected array $config = [];
 
 	/**
-	 * @var tag The parent tag object
+	 * @var tag|null The parent tag object
 	 */
 	protected ?tag $parent = null;
 
 	/**
 	 * @var array Cache for the list of parent tags
 	 */
-	protected ?array $parenttags = null;
+	protected array $parenttags = [];
 
 	/**
 	 * @var string The type of tag
@@ -36,7 +47,7 @@ class tag implements token {
 	protected array $attributes = [];
 
 	/**
-	 * @var string If the tag is a singleton, this defines the closing string
+	 * @var string|null If the tag is a singleton, this defines the closing string
 	 */
 	protected ?string $singleton = null;
 
@@ -311,7 +322,7 @@ public function append(array $nodes, int $index = null) : void {
 
 		// insert the nodes
 		if ($index !== null) {
-			$this->chidren = \array_splice($this->children, $index, 0, $clones);
+			\array_splice($this->children, $index, 0, $clones);
 		}
 	}
 
@@ -335,9 +346,11 @@ public function prepend(array $nodes) : void {
 	 * @return int|null The index of the current element with the parent, or null if there is no parent
 	 */
 	protected function getIndex() : ?int {
-		foreach ($this->parent->children() AS $key => $item) {
-			if ($item === $this) {
-				return $key;
+		if ($this->parent) {
+			foreach ($this->parent->children() AS $key => $item) {
+				if ($item === $this) {
+					return $key;
+				}
 			}
 		}
 		return null;
@@ -394,7 +407,7 @@ public function remove(tag $node) : void {
 	public function minify(array $minify) : void {
 		$config = $this->config;
 		$attr = $config['attributes'];
-		if ($minify['lowercase']) {
+		if ($minify['lowercase'] && $this->tagName) {
 			$this->tagName = \mb_strtolower($this->tagName);
 		}
 		$folder = null;
@@ -404,6 +417,7 @@ public function minify(array $minify) : void {
 		// minify attributes
 		$tag = $this->tagName;
 		$attributes = $this->attributes;
+		$host = null;
 		foreach ($attributes AS $key => $value) {
 
 			// lowercase attribute key
@@ -433,7 +447,7 @@ public function minify(array $minify) : void {
 
 				// remove host for own domain
 				if ($minify['urls']['host'] && isset($_SERVER['HTTP_HOST'])) {
-					$host ??= ['//'.$_SERVER['HTTP_HOST'], $scheme.$_SERVER['HTTP_HOST']];
+					$host = $host ?? ['//'.$_SERVER['HTTP_HOST'], $scheme.$_SERVER['HTTP_HOST']];
 					foreach ($host AS $item) {
 
 						// check if link goes to root
@@ -570,7 +584,7 @@ public function minify(array $minify) : void {
 			}
 
 			// if last tag, remove closing tag
-			if (!$children || $next) {
+			if (empty($children) || $next) {
 				$this->close = false;
 			}
 		}
@@ -778,7 +792,7 @@ public function find(array $selector, bool $searchChildren = true) : array {
 	 *
 	 * @param string $key The key of the attribute whos value you wish to retrieve or update
 	 * @param string $value The value of the attribute to update
-	 * @return string The value of the attrbute or NULL if the attribute does not exist
+	 * @return string|null The value of the attrbute or NULL if the attribute does not exist
 	 */
 	public function attr(string $key, ?string $value = null) : ?string {
 
@@ -787,8 +801,8 @@ public function attr(string $key, ?string $value = null) : ?string {
 			$this->attributes[$key] = $value;
 
 		// get the value
-		} elseif (\array_key_exists($key, $this->attributes)) {
-			return $this->attributes[$key] === null ? true : $this->attributes[$key];
+		} else {
+			return $this->attributes[$key] ?? null;
 		}
 		return null;
 	}

src/tokens/tag.php

@@ -11,9 +11,9 @@ class text implements token {
 	protected htmldoc $root;
 
 	/**
-	 * @var tag The parent tag object
+	 * @var tag|null The parent tag object
 	 */
-	protected tag $parent;
+	protected ?tag $parent = null;
 
 	/**
 	 * @var string The text content of this object
@@ -26,7 +26,7 @@ class text implements token {
 	 * @param htmldoc $root The parent HTMLdoc object
 	 * @param tag $parent The parent tag object
 	 */
-	public function __construct(htmldoc $root, tag $parent = null) {
+	public function __construct(htmldoc $root, ?tag $parent = null) {
 		$this->root = $root;
 		$this->parent = $parent;
 	}