chillerlan / php-prototype-dom

src/Node/PrototypeElementTrait.php

<?php
/**
 * Trait PrototypeElementTrait
 *
 * @filesource   PrototypeElementTrait.php
 * @created      08.05.2017
 * @package      chillerlan\PrototypeDOM\Node
 * @author       Smiley <smiley@chillerlan.net>
 * @copyright    2017 Smiley
 * @license      MIT
 *
 * @noinspection PhpParamsInspection
 * @noinspection PhpIncompatibleReturnTypeInspection
 */

namespace chillerlan\PrototypeDOM\Node;

use function array_key_exists, call_user_func_array, is_array;

/**
 * @implements \chillerlan\PrototypeDOM\Node\PrototypeElement
 */
trait PrototypeElementTrait{
	use PrototypeTraversalTrait;

	/**
	 * @inheritDoc
	 */
	public function wrap(PrototypeElement $wrapper):PrototypeElement{
		return $wrapper->insert($this->replace($wrapper));
	}

	/**
	 * @inheritDoc
	 */
	public function update($content):PrototypeElement{
		return $this->purge()->insert($content);

The method insert() does not exist on chillerlan\PrototypeDOM\Node\PrototypeNode. It seems like you code against a sub-type of chillerlan\PrototypeDOM\Node\PrototypeNode such as chillerlan\PrototypeDOM\Node\PrototypeElement.

	}

	/**
	 * @inheritDoc
	 */
	public function insert($content):PrototypeElement{

		if(!is_array($content)){

			foreach($this->ownerDocument->toNodeList($content) as $node){
				$this->insert_bottom($node);

$node of type DOMNode|null is incompatible with the type chillerlan\PrototypeDOM\Node\PrototypeElement expected by parameter $node of chillerlan\PrototypeDOM\Node\PrototypeElementTrait::insert_bottom().

			}

			return $this;

The expression return $this returns the type chillerlan\PrototypeDOM\Node\PrototypeElementTrait which is incompatible with the type-hinted return chillerlan\PrototypeDOM\Node\PrototypeElement.

		}

		foreach(['before', 'after', 'top', 'bottom'] as $pos){

			if(!array_key_exists($pos, $content)){
				continue;
			}

			$nodes = $this->ownerDocument->toNodeList($content[$pos]);

			if($pos === 'top' && $this->hasChildNodes() || $pos === 'after' && $this->nextSibling){

Consider adding parentheses for clarity. Current Interpretation: ($pos === 'top' && $this->hasChildNodes()) || $pos === 'after' && $this->nextSibling, Probably Intended Meaning: $pos === 'top' && ($this->hasChildNodes() || $pos === 'after' && $this->nextSibling)

It seems like hasChildNodes() must be provided by classes using this trait. How about adding it as abstract method to this trait?

				$nodes->reverse();
			}

			foreach($nodes as $node){
				call_user_func_array([$this, 'insert_'.$pos], [$node]);
			}

		}

		return $this;

The expression return $this returns the type chillerlan\PrototypeDOM\Node\PrototypeElementTrait which is incompatible with the type-hinted return chillerlan\PrototypeDOM\Node\PrototypeElement.

	}

	/**
	 * @inheritDoc
	 */
	public function insert_before(PrototypeElement $node, PrototypeElement $refNode = null):PrototypeElement{

		if($this->parentNode){
			$this->parentNode->insertBefore($this->importNode($node), $refNode ?? $this);

It seems like $refNode ?? $this can also be of type chillerlan\PrototypeDOM\Node\PrototypeElementTrait; however, parameter $child of DOMNode::insertBefore() does only seem to accept DOMNode|null, maybe add an additional type check?

		}

		return $this;

The expression return $this returns the type chillerlan\PrototypeDOM\Node\PrototypeElementTrait which is incompatible with the type-hinted return chillerlan\PrototypeDOM\Node\PrototypeElement.

	}

	/**
	 * @inheritDoc
	 */
	public function insert_after(PrototypeElement $node):PrototypeElement{

		if(!$this->nextSibling && $this->parentNode){
			return $this->parentNode->insert_bottom($node); // @codeCoverageIgnore
		}

		return $this->nextSibling->insert_before($node);
	}

	/**
	 * @inheritDoc
	 */
	public function insert_top(PrototypeElement $node):PrototypeElement{

		if($this->hasChildNodes()){
			return $this->firstChild->insert_before($node, $this->firstChild);
		}

		return $this->insert_bottom($node);
	}

	/**
	 * @inheritDoc
	 */
	public function insert_bottom(PrototypeElement $node):PrototypeElement{
		$this->appendChild($this->importNode($node));

It seems like appendChild() must be provided by classes using this trait. How about adding it as abstract method to this trait?

		return $this;

The expression return $this returns the type chillerlan\PrototypeDOM\Node\PrototypeElementTrait which is incompatible with the type-hinted return chillerlan\PrototypeDOM\Node\PrototypeElement.

	}

}