Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total		n/a	0 / 0		n/a	0 / 0	CRAP		n/a	0 / 0

1	<?php
2
3	namespace SDom\Node;
4
5	/**
6	* Interface to represent a node.
7	*
8	* Interface NodeInterface
9	* @package SDom\Node
10	*/
11	interface NodeInterface
12	{
13	/**
14	* Return the string (HTML) representation of the node.
15	*
16	* @return string
17	*/
18	public function __toString(): string;
19
20	/**
21	* Throw exception to signify native cloning is not allowed.
22	* One should use clone() instead.
23	*
24	* @throws \BadMethodCallException
25	*/
26	public function __clone();
27
28	/**
29	* Return the parent node or null if such isn't set.
30	*
31	* @return null|NodeInterface
32	*/
33	public function parent(): ?NodeInterface;
34
35	/**
36	* Attach this node to another one making the later a parent.
37	*
38	* When invoking this method you will also need to manually make sure that this node is present as a child node
39	* of the supplied parent when applicable to ensure a proper bidirectional relationship.
40	*
41	* If this node is already attached to a different parent node, it will be removed as a child node from the current
42	* parent before attaching to the new one when applicable.
43	*
44	* @param NodeInterface $parent
45	* @return $this
46	*/
47	public function attach(NodeInterface $parent): NodeInterface;
48
49	/**
50	* Detach this node from it's parent, if such is set, by both removing the parent node reference, and removing this
51	* node as a child node from the parent when applicable.
52	*
53	* @return $this
54	*/
55	public function detach(): NodeInterface;
56
57	/**
58	* Ensure child nodes are also cloned when applicable.
59	* Ensure old node is detached from parent.
60	* Ensure (new) cloned node is attached to parent node.
61	*
62	* @return NodeInterface
63	*/
64	public function clone(): NodeInterface;
65	}