HumHub Documentation (unofficial)

HTMLPurifier_Token_Start extends HTMLPurifier_Token_Tag
in package

Concrete start token class.

Table of Contents

Properties

$armor  : mixed
Lookup array of processing that this token is exempt from.
$attr  : mixed
Associative array of the tag's attributes.
$carryover  : mixed
$col  : mixed
Column of line node was on in source document. Null if unknown.
$is_tag  : mixed
Static bool marker that indicates the class is a tag.
$line  : mixed
Line number node was on in source document. Null if unknown.
$name  : mixed
The lower-case name of the tag, like 'a', 'b' or 'blockquote'.
$rewind  : mixed
$skip  : mixed
Used during MakeWellFormed. See Note [Injector skips]

Methods

__construct()  : mixed
Non-overloaded constructor, which lower-cases passed tag name.
__get()  : null|string
position()  : mixed
Sets the position of the token in the source document.
rawPosition()  : mixed
Convenience function for DirectLex settings line/col position.
toNode()  : mixed
Converts a token into its corresponding node.

Properties

$armor

Lookup array of processing that this token is exempt from.

public mixed $armor = array()

Currently, valid values are "ValidateAttributes" and "MakeWellFormed_TagClosedError"

Tags
type

array

$attr

Associative array of the tag's attributes.

public mixed $attr = array()
Tags
type

array

$carryover

public mixed $carryover
Tags
type

$col

Column of line node was on in source document. Null if unknown.

public mixed $col
Tags
type

int

$is_tag

Static bool marker that indicates the class is a tag.

public mixed $is_tag = \true

This allows us to check objects with !empty($obj->is_tag) without having to use a function call is_a().

Tags
type

bool

$line

Line number node was on in source document. Null if unknown.

public mixed $line
Tags
type

int

$name

The lower-case name of the tag, like 'a', 'b' or 'blockquote'.

public mixed $name
Tags
note

Strictly speaking, XML tags are case sensitive, so we shouldn't be lower-casing them, but these tokens cater to HTML tags, which are insensitive.

type

string

$rewind

public mixed $rewind
Tags
type

$skip

Used during MakeWellFormed. See Note [Injector skips]

public mixed $skip
Tags
type

Methods

__construct()

Non-overloaded constructor, which lower-cases passed tag name.

public __construct(string $name[, array<string|int, mixed> $attr = array() ][, int $line = null ][, int $col = null ][, array<string|int, mixed> $armor = array() ]) : mixed
Parameters
$name : string

String name.

$attr : array<string|int, mixed> = array()

Associative array of attributes.

$line : int = null
$col : int = null
$armor : array<string|int, mixed> = array()

__get()

public __get(string $n) : null|string
Parameters
$n : string
Return values
null|string

position()

Sets the position of the token in the source document.

public position([int $l = null ][, int $c = null ]) : mixed
Parameters
$l : int = null
$c : int = null

rawPosition()

Convenience function for DirectLex settings line/col position.

public rawPosition(int $l, int $c) : mixed
Parameters
$l : int
$c : int

toNode()

Converts a token into its corresponding node.

public toNode() : mixed

        
On this page

Search results