The Dom\TokenList class

(PHP 8 >= 8.4.0)

Introduction

Represents a set of tokens in an attribute (e.g. class names).

Class synopsis

final class Dom\TokenList implements IteratorAggregate, Countable {

/* Properties */

public readonly int $length ;

public string $value ;

/* Methods */

public add (string ...$tokens): void

public contains (string $token): bool

public count (): int

public getIterator (): Iterator

public item (int $index): ? string

public remove (string ...$tokens): void

public replace (string $token, string $newToken): bool

public supports (string $token): bool

public toggle (string $token, ? bool $force = null ): bool

}

Properties

length: The number of tokens.
value: The value of the attribute linked to this object.

Notes

Note: The DOM extension uses UTF-8 encoding when working with methods or properties. The parser methods auto-detect the encoding or allow the caller to specify an encoding.

Note: Tokens in the list can be accessed by array syntax.

Dom\TokenList::add — Adds the given tokens to the list
Dom\TokenList::contains — Returns whether the list contains a given token
Dom\TokenList::count — Returns the number of tokens in the list
Dom\TokenList::getIterator — Returns an iterator over the token list
Dom\TokenList::item — Returns a token from the list
Dom\TokenList::remove — Removes the given tokens from the list
Dom\TokenList::replace — Replaces a token in the list with another one
Dom\TokenList::supports — Returns whether the given token is supported
Dom\TokenList::toggle — Toggles the presence of a token in the list

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

+add a note

User Contributed Notes

There are no user contributed notes for this page.