Builder final class

Minn\Html\Tree\Builder · public/minn/src/Minn/Html/Tree/Builder.php · 551 lines

The HTML tree construction algorithm over the engine's tokenizer, as the reference's HTML processor runs it: tokens go through the insertion modes (HeadRules, BodyRules, TableRules) or the foreign content rules, and every node opened or closed becomes an Event with its breadcrumbs. Text is read one kind at a time (NUL bytes, white space, the rest). At the end of the input every open element closes; nothing implied is added. Where the reference does not build a tree (Unsupported), the walk stops with that error.

Uses 13

Html\Decoder Html\Scanner Html\Tags BodyRules Event ForeignRules Formatting HeadRules Node OpenElements TableRules Token Unsupported

Used by 4

BodyRules ForeignRules HeadRules TableRules

Constants and properties

const	`FRAGMENT` = `'fragment'`
const	`DOCUMENT` = `'document'`
private	`Minn\Html\Tree\OpenElements $stack`
private	`Minn\Html\Tree\Formatting $formatting`
private	`string $mode`
private	`array $templateModes`
private	`?Minn\Html\Tree\Node $headPointer`
private	`?Minn\Html\Tree\Node $formPointer`
private	`bool $framesetOk`
private	`string $compat`
private	`array $queue`
private	`array $pending`
private	`?Minn\Html\Tree\Token $token`
private	`bool $done`
private	`bool $skipNext`
private	`bool $skipping`
private	`?Minn\Html\Tree\Unsupported $error`
private	`Minn\Html\Tree\Node $context`
private	`readonly Minn\Html\Tags $tags`	Promoted from the constructor.
private	`readonly string $kind`	Promoted from the constructor.

Public

new	`__construct(Minn\Html\Tags $tags, string $kind)`#
method	`reset(): void`#	Back to the state before the first token.
method	`next(): ?Minn\Html\Tree\Event`#	The next opened or closed node, or null at the end, at an incomplete token, or once unsupported markup stopped the walk.
method	`halt(): void`#	Stops the walk for good (a failed seek leaves the processor like this).
method	`error(): ?Minn\Html\Tree\Unsupported`#	Why the walk stopped early, if it did.
method	`breadcrumbs(): array`#	The breadcrumbs of the open elements now. `@return list<string>`
method	`token(): Minn\Html\Tree\Token`#	The token being processed.
method	`stack(): Minn\Html\Tree\OpenElements`#	The stack of open elements.
method	`formatting(): Minn\Html\Tree\Formatting`#	The list of active formatting elements.
method	`isFragment(): bool`#	Whether this builder parses a fragment (in a BODY context) rather than a document.
method	`mode(): string`#	The insertion mode.
method	`switchTo(string $mode): void`#	Switches the insertion mode.
method	`reprocessIn(string $mode): void`#	Switches the insertion mode and processes the current token again under it.
method	`process(Minn\Html\Tree\Token $token): void`#	Processes a token under the current insertion mode, or the foreign content rules when they apply.
method	`processIn(string $mode, Minn\Html\Tree\Token $token): void`#	Processes a token using the rules of an insertion mode other than the current one.
method	`framesetOk(): bool`#	Whether the frameset-ok flag is still set.
method	`framesetNotOk(): void`#	Clears the frameset-ok flag.
method	`compat(): string`#	The document's compatibility mode ("no-quirks", "limited-quirks", "quirks").
method	`setCompat(string $compat): void`#	Sets the compatibility mode the doctype indicated.
method	`headPointer(): ?Minn\Html\Tree\Node`#	The head element pointer.
method	`formPointer(): ?Minn\Html\Tree\Node`#	The form element pointer.
method	`setFormPointer(?Minn\Html\Tree\Node $node): void`#	Sets (or clears) the form element pointer.
method	`templateModes(): array`#	The stack of template insertion modes. `@return list<string>`
method	`pushTemplateMode(string $mode): void`#	Pushes a template insertion mode.
method	`popTemplateMode(): void`#	Pops the current template insertion mode.
method	`adjustedCurrent(): ?Minn\Html\Tree\Node`#	The adjusted current node: the context element when only the fragment's root is open.
method	`insert(string $namespace = 'html'): Minn\Html\Tree\Node`#	Inserts an element for the current start tag, real, in the namespace.
method	`insertImplied(string $name): Minn\Html\Tree\Node`#	Inserts an element the markup implied.
method	`insertLeafElement(string $namespace = 'html'): Minn\Html\Tree\Node`#	Inserts and at once closes an element for the current start tag: a void element, one read whole, or self-closed foreign content.
method	`insertLeaf(string $namespace = 'html'): void`#	Inserts a leaf (text, comment, CDATA, processing instruction) for the current token, in the namespace.
method	`insertDocumentLeaf(): void`#	Inserts a leaf at the top of the document (a doctype or a comment before or around the html element).
method	`pop(): ?Minn\Html\Tree\Node`#	Closes the current node as implied.
method	`popUntil(string ...$names): void`#	Pops until an HTML element of one of the names closes; when the current end tag names it, that last close is real.
method	`popUntilNode(Minn\Html\Tree\Node $target): void`#	Pops until this very node closes.
method	`generateImpliedEndTags(string $except = ''): void`#	Generates implied end tags, leaving an element of the name open.
method	`generateAllImpliedEndTags(): void`#	Generates all implied end tags thoroughly (table parts as well).
method	`closeP(): void`#	Closes a P element: implied end tags but P's, then pops through the P.
method	`closePInButtonScope(): void`#	Closes a P element when one is in button scope.
method	`reconstructFormatting(): void`#	Reconstructs the active formatting elements; the reference stops when any would have to be reopened.
method	`skipNextNewline(): void`#	Asks the parser to drop one leading line feed from the next token (after PRE, LISTING).
method	`resetInsertionMode(): void`#	Resets the insertion mode from the stack of open elements.
method	`unsupported(string $message): void`#	Stops: the reference's processor does not build a tree for this markup.
method	`attribute(string $name): string\|true\|null`#	The current tag's attribute, decoded; null when absent.
method	`doctype(): array`#	The doctype's name and identifiers, for the compatibility mode. @return array{name: ?string, public: ?string, system: ?string} `@return array{name: ?string, public: ?string, system: ?string}`

Internals 9

Private and protected methods: how the class does its work. Not a contract; they change whenever the code is tidied.

private	`step(): void`#
private	`read(): array`#	`@return list<Token> the next token from the tokenizer (text in runs), an end-of-input token, or nothing when paused`
private	`textRuns(): array`#	`@return list<Token>`
private	`textValue(Minn\Html\Tree\Token $token, string $namespace): string`#
private	`usesHtmlRules(Minn\Html\Tree\Token $token): bool`#
private	`finish(): void`#	Closes everything still open at the end of the input; nothing implied is added.
private	`pushNode(Minn\Html\Tree\Node $node, ?int $offset): void`#
private	`event(string $op, Minn\Html\Tree\Node $node, ?int $offset): void`#
private	`keptAttributes(string $name, string $namespace): array`#	The attributes an element keeps for later comparison: all of a formatting element's (Noah's Ark), and encoding on MathML annotation-xml. `@return array<string, string\|true>`