FootnoteRef
extends AbstractInline
in package
implements
ReferenceableInterface
FinalYes
Table of Contents
Interfaces
Properties
- $data : Data
- $depth : int
- $firstChild : Node|null
- $lastChild : Node|null
- $next : Node|null
- $parent : Node|null
- $previous : Node|null
- $content : string|null
- $reference : ReferenceInterface
Methods
- __clone() : mixed
- Clone the current node and its children
- __construct() : mixed
- appendChild() : void
- assertInstanceOf() : void
- children() : array<string|int, Node>
- detach() : void
- detachChildren() : void
- Detaches all child nodes of given node
- firstChild() : Node|null
- getContent() : string|null
- getDepth() : int
- getReference() : ReferenceInterface
- hasChildren() : bool
- insertAfter() : void
- Inserts the $sibling node after $this
- insertBefore() : void
- Inserts the $sibling node before $this
- iterator() : NodeIterator
- lastChild() : Node|null
- next() : Node|null
- parent() : Node|null
- prependChild() : void
- Adds $child as the very first child of $this
- previous() : Node|null
- replaceChildren() : void
- Replace all children of given node with collection of another
- replaceWith() : void
- setReference() : void
- walker() : NodeWalker
- setParent() : void
Properties
$data
public
Data
$data
Tags
$depth
protected
int
$depth
= 0
Tags
$firstChild
protected
Node|null
$firstChild
= null
Tags
$lastChild
protected
Node|null
$lastChild
= null
Tags
$next
protected
Node|null
$next
= null
Tags
$parent
protected
Node|null
$parent
= null
Tags
$previous
protected
Node|null
$previous
= null
Tags
$content
private
string|null
$content
= null
Tags
$reference
private
ReferenceInterface
$reference
Methods
__clone()
Clone the current node and its children
public
__clone() : mixed
WARNING: This is a recursive function and should not be called on deeply-nested node trees!
__construct()
public
__construct(ReferenceInterface $reference[, string|null $content = null ][, array<string|int, mixed> $data = [] ]) : mixed
Parameters
- $reference : ReferenceInterface
- $content : string|null = null
- $data : array<string|int, mixed> = []
appendChild()
public
appendChild(Node $child) : void
Parameters
- $child : Node
assertInstanceOf()
public
static assertInstanceOf(Node $node) : void
Parameters
- $node : Node
children()
public
children() : array<string|int, Node>
Return values
array<string|int, Node>detach()
public
detach() : void
detachChildren()
Detaches all child nodes of given node
public
detachChildren() : void
firstChild()
public
firstChild() : Node|null
Return values
Node|nullgetContent()
public
getContent() : string|null
Return values
string|nullgetDepth()
public
getDepth() : int
Return values
intgetReference()
public
getReference() : ReferenceInterface
Return values
ReferenceInterfacehasChildren()
public
hasChildren() : bool
Return values
boolinsertAfter()
Inserts the $sibling node after $this
public
insertAfter(Node $sibling) : void
Parameters
- $sibling : Node
insertBefore()
Inserts the $sibling node before $this
public
insertBefore(Node $sibling) : void
Parameters
- $sibling : Node
iterator()
public
iterator([int $flags = 0 ]) : NodeIterator
Parameters
- $flags : int = 0
Return values
NodeIteratorlastChild()
public
lastChild() : Node|null
Return values
Node|nullnext()
public
next() : Node|null
Return values
Node|nullparent()
public
parent() : Node|null
Return values
Node|nullprependChild()
Adds $child as the very first child of $this
public
prependChild(Node $child) : void
Parameters
- $child : Node
previous()
public
previous() : Node|null
Return values
Node|nullreplaceChildren()
Replace all children of given node with collection of another
public
replaceChildren(iterable<string|int, Node> $children) : void
Parameters
- $children : iterable<string|int, Node>
replaceWith()
public
replaceWith(Node $replacement) : void
Parameters
- $replacement : Node
setReference()
public
setReference(ReferenceInterface $reference) : void
Parameters
- $reference : ReferenceInterface
walker()
public
walker() : NodeWalker
Return values
NodeWalkersetParent()
protected
setParent([Node|null $node = null ]) : void
Parameters
- $node : Node|null = null