PhpToken::is

(PHP 8)

PhpToken::is — Tells whether the token is of given kind.

Description

public PhpToken::is(int|string|array $kind): bool

Tells whether the token is of given kind.

Parameters

kind

Either a single value to match the token's id or textual content, or an array thereof.

Return Values

A boolean value whether the token is of given kind.

Examples

Example #1 PhpToken::is() example

<?php
$token = new PhpToken(T_ECHO, 'echo');
var_dump($token->is(T_ECHO));        // -> bool(true)
var_dump($token->is('echo'));        // -> bool(true)
var_dump($token->is(T_FOREACH));     // -> bool(false)
var_dump($token->is('foreach'));     // -> bool(false)

Example #2 Usage with array

<?php
function isClassType(PhpToken $token): bool {
    return $token->is([T_CLASS, T_INTERFACE, T_TRAIT]);
}

$interface = new PhpToken(T_INTERFACE, 'interface');
var_dump(isClassType($interface));   // -> bool(true)

$function = new PhpToken(T_FUNCTION, 'function');
var_dump(isClassType($function));    // -> bool(false)

See Also