Documentation

HtmlBlock extends AbstractBlock
in package
implements RawMarkupContainerInterface

FinalYes

Block-level element

Table of Contents

Interfaces

RawMarkupContainerInterface
Interface for a node which contains raw, unprocessed markup (like HTML)

Constants

TYPE_1_CODE_CONTAINER  = 1
TYPE_2_COMMENT  = 2
TYPE_3  = 3
TYPE_4  = 4
TYPE_5_CDATA  = 5
TYPE_6_BLOCK_ELEMENT  = 6
TYPE_7_MISC_ELEMENT  = 7

Properties

$data  : Data
$depth  : int
$endLine  : int|null
$firstChild  : Node|null
$lastChild  : Node|null
$next  : Node|null
$parent  : Node|null
$previous  : Node|null
$startLine  : int|null
$literal  : string
$type  : int

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
getDepth()  : int
getEndLine()  : int|null
getLiteral()  : string
getStartLine()  : int|null
getType()  : int
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()  : void
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
setEndLine()  : void
setLiteral()  : void
setStartLine()  : void
setType()  : void
walker()  : NodeWalker
setParent()  : void

Constants

TYPE_1_CODE_CONTAINER

public mixed TYPE_1_CODE_CONTAINER = 1

TYPE_2_COMMENT

public mixed TYPE_2_COMMENT = 2

TYPE_6_BLOCK_ELEMENT

public mixed TYPE_6_BLOCK_ELEMENT = 6

TYPE_7_MISC_ELEMENT

public mixed TYPE_7_MISC_ELEMENT = 7

Properties

$depth

protected int $depth = 0
Tags
psalm-readonly-allow-private-mutation

$firstChild

protected Node|null $firstChild = null
Tags
psalm-readonly-allow-private-mutation

$lastChild

protected Node|null $lastChild = null
Tags
psalm-readonly-allow-private-mutation

$next

protected Node|null $next = null
Tags
psalm-readonly-allow-private-mutation

$parent

protected Node|null $parent = null
Tags
psalm-readonly-allow-private-mutation

$previous

protected Node|null $previous = null
Tags
psalm-readonly-allow-private-mutation

$type

private int $type
Tags
psalm-var

self::TYPE_* $type

phpstan-var

self::TYPE_* $type

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(int $type) : mixed
Parameters
$type : int
Tags
psalm-param

self::TYPE_* $type

phpstan-param

self::TYPE_* $type

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|null

getDepth()

public getDepth() : int
Return values
int

getEndLine()

public getEndLine() : int|null
Return values
int|null

getLiteral()

public getLiteral() : string
Return values
string

getStartLine()

public getStartLine() : int|null
Return values
int|null

getType()

public getType() : int
Tags
psalm-return

self::TYPE_*

phpstan-return

self::TYPE_*

Return values
int

hasChildren()

public hasChildren() : bool
Return values
bool

insertAfter()

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

lastChild()

public lastChild() : Node|null
Return values
Node|null

prependChild()

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|null

replaceChildren()

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

setEndLine()

public setEndLine(int|null $endLine) : void
Parameters
$endLine : int|null

setLiteral()

public setLiteral(string $literal) : void
Parameters
$literal : string

setStartLine()

public setStartLine(int|null $startLine) : void
Parameters
$startLine : int|null

setType()

public setType(int $type) : void
Parameters
$type : int
Tags
psalm-param

self::TYPE_* $type

phpstan-param

self::TYPE_* $type

setParent()

protected setParent([Node|null $node = null ]) : void
Parameters
$node : Node|null = null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results