Tokens
in package
Table of Contents
- $arithmeticTokens : array<int|string, int|string>
- Tokens that represent arithmetic operators.
- $assignmentTokens : array<int|string, int|string>
- Tokens that represent assignments.
- $blockOpeners : array<int|string, int|string>
- Tokens that open code blocks.
- $booleanOperators : array<int|string, int|string>
- Tokens that perform boolean operations.
- $bracketTokens : array<int|string, int|string>
- Tokens that represent brackets and parenthesis.
- $castTokens : array<int|string, int|string>
- Tokens that represent casting.
- $commentTokens : array<int|string, int|string>
- Tokens that are comments.
- $comparisonTokens : array<int|string, int|string>
- Tokens that represent comparison operator.
- $emptyTokens : array<int|string, int|string>
- Tokens that don't represent code.
- $equalityTokens : array<int|string, int|string>
- Tokens that represent equality comparisons.
- $functionNameTokens : array<int|string, int|string>
- Tokens that represent the names of called functions.
- $heredocTokens : array<int|string, int|string>
- Tokens that make up a heredoc string.
- $includeTokens : array<int|string, int|string>
- Tokens that include files.
- $magicConstants : array<string|int, mixed>
- Tokens representing PHP magic constants.
- $methodPrefixes : array<int|string, int|string>
- Tokens that can prefix a method name
- $ooScopeTokens : array<int|string, int|string>
- Tokens that open class and object scopes.
- $operators : array<int|string, int|string>
- Tokens that perform operations.
- $parenthesisOpeners : array<int|string, int|string>
- Token types that open parenthesis.
- $phpcsCommentTokens : array<int|string, int|string>
- Tokens that are comments containing PHPCS instructions.
- $scopeModifiers : array<int|string, int|string>
- Tokens that represent scope modifiers.
- $scopeOpeners : array<int|string, int|string>
- Tokens that are allowed to open scopes.
- $stringTokens : array<int|string, int|string>
- Tokens that represent strings.
- $textStringTokens : array<int|string, int|string>
- Tokens that represent text strings.
- $weightings : array<int|string, int>
- The token weightings.
- getHighestWeightedToken() : int|false
- Returns the highest weighted token type.
- tokenName() : string
- Given a token, returns the name of the token.
Properties
$arithmeticTokens
Tokens that represent arithmetic operators.
public
static array<int|string, int|string>
$arithmeticTokens
= [T_PLUS => T_PLUS, T_MINUS => T_MINUS, T_MULTIPLY => T_MULTIPLY, T_DIVIDE => T_DIVIDE, T_MODULUS => T_MODULUS, T_POW => T_POW]
$assignmentTokens
Tokens that represent assignments.
public
static array<int|string, int|string>
$assignmentTokens
= [T_EQUAL => T_EQUAL, T_AND_EQUAL => T_AND_EQUAL, T_OR_EQUAL => T_OR_EQUAL, T_CONCAT_EQUAL => T_CONCAT_EQUAL, T_DIV_EQUAL => T_DIV_EQUAL, T_MINUS_EQUAL => T_MINUS_EQUAL, T_POW_EQUAL => T_POW_EQUAL, T_MOD_EQUAL => T_MOD_EQUAL, T_MUL_EQUAL => T_MUL_EQUAL, T_PLUS_EQUAL => T_PLUS_EQUAL, T_XOR_EQUAL => T_XOR_EQUAL, T_DOUBLE_ARROW => T_DOUBLE_ARROW, T_SL_EQUAL => T_SL_EQUAL, T_SR_EQUAL => T_SR_EQUAL, T_COALESCE_EQUAL => T_COALESCE_EQUAL, T_ZSR_EQUAL => T_ZSR_EQUAL]
$blockOpeners
Tokens that open code blocks.
public
static array<int|string, int|string>
$blockOpeners
= [T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET, T_OPEN_SQUARE_BRACKET => T_OPEN_SQUARE_BRACKET, T_OPEN_PARENTHESIS => T_OPEN_PARENTHESIS, T_OBJECT => T_OBJECT]
$booleanOperators
Tokens that perform boolean operations.
public
static array<int|string, int|string>
$booleanOperators
= [T_BOOLEAN_AND => T_BOOLEAN_AND, T_BOOLEAN_OR => T_BOOLEAN_OR, T_LOGICAL_AND => T_LOGICAL_AND, T_LOGICAL_OR => T_LOGICAL_OR, T_LOGICAL_XOR => T_LOGICAL_XOR]
$bracketTokens
Tokens that represent brackets and parenthesis.
public
static array<int|string, int|string>
$bracketTokens
= [T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET, T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET, T_OPEN_SQUARE_BRACKET => T_OPEN_SQUARE_BRACKET, T_CLOSE_SQUARE_BRACKET => T_CLOSE_SQUARE_BRACKET, T_OPEN_PARENTHESIS => T_OPEN_PARENTHESIS, T_CLOSE_PARENTHESIS => T_CLOSE_PARENTHESIS]
$castTokens
Tokens that represent casting.
public
static array<int|string, int|string>
$castTokens
= [T_INT_CAST => T_INT_CAST, T_STRING_CAST => T_STRING_CAST, T_DOUBLE_CAST => T_DOUBLE_CAST, T_ARRAY_CAST => T_ARRAY_CAST, T_BOOL_CAST => T_BOOL_CAST, T_OBJECT_CAST => T_OBJECT_CAST, T_UNSET_CAST => T_UNSET_CAST, T_BINARY_CAST => T_BINARY_CAST]
$commentTokens
Tokens that are comments.
public
static array<int|string, int|string>
$commentTokens
= [T_COMMENT => T_COMMENT, T_DOC_COMMENT => T_DOC_COMMENT, T_DOC_COMMENT_STAR => T_DOC_COMMENT_STAR, T_DOC_COMMENT_WHITESPACE => T_DOC_COMMENT_WHITESPACE, T_DOC_COMMENT_TAG => T_DOC_COMMENT_TAG, T_DOC_COMMENT_OPEN_TAG => T_DOC_COMMENT_OPEN_TAG, T_DOC_COMMENT_CLOSE_TAG => T_DOC_COMMENT_CLOSE_TAG, T_DOC_COMMENT_STRING => T_DOC_COMMENT_STRING, T_PHPCS_ENABLE => T_PHPCS_ENABLE, T_PHPCS_DISABLE => T_PHPCS_DISABLE, T_PHPCS_SET => T_PHPCS_SET, T_PHPCS_IGNORE => T_PHPCS_IGNORE, T_PHPCS_IGNORE_FILE => T_PHPCS_IGNORE_FILE]
$comparisonTokens
Tokens that represent comparison operator.
public
static array<int|string, int|string>
$comparisonTokens
= [T_IS_EQUAL => T_IS_EQUAL, T_IS_IDENTICAL => T_IS_IDENTICAL, T_IS_NOT_EQUAL => T_IS_NOT_EQUAL, T_IS_NOT_IDENTICAL => T_IS_NOT_IDENTICAL, T_LESS_THAN => T_LESS_THAN, T_GREATER_THAN => T_GREATER_THAN, T_IS_SMALLER_OR_EQUAL => T_IS_SMALLER_OR_EQUAL, T_IS_GREATER_OR_EQUAL => T_IS_GREATER_OR_EQUAL, T_SPACESHIP => T_SPACESHIP, T_COALESCE => T_COALESCE]
$emptyTokens
Tokens that don't represent code.
public
static array<int|string, int|string>
$emptyTokens
= [T_WHITESPACE => T_WHITESPACE, T_COMMENT => T_COMMENT, T_DOC_COMMENT => T_DOC_COMMENT, T_DOC_COMMENT_STAR => T_DOC_COMMENT_STAR, T_DOC_COMMENT_WHITESPACE => T_DOC_COMMENT_WHITESPACE, T_DOC_COMMENT_TAG => T_DOC_COMMENT_TAG, T_DOC_COMMENT_OPEN_TAG => T_DOC_COMMENT_OPEN_TAG, T_DOC_COMMENT_CLOSE_TAG => T_DOC_COMMENT_CLOSE_TAG, T_DOC_COMMENT_STRING => T_DOC_COMMENT_STRING, T_PHPCS_ENABLE => T_PHPCS_ENABLE, T_PHPCS_DISABLE => T_PHPCS_DISABLE, T_PHPCS_SET => T_PHPCS_SET, T_PHPCS_IGNORE => T_PHPCS_IGNORE, T_PHPCS_IGNORE_FILE => T_PHPCS_IGNORE_FILE]
$equalityTokens
Tokens that represent equality comparisons.
public
static array<int|string, int|string>
$equalityTokens
= [T_IS_EQUAL => T_IS_EQUAL, T_IS_NOT_EQUAL => T_IS_NOT_EQUAL, T_IS_IDENTICAL => T_IS_IDENTICAL, T_IS_NOT_IDENTICAL => T_IS_NOT_IDENTICAL, T_IS_SMALLER_OR_EQUAL => T_IS_SMALLER_OR_EQUAL, T_IS_GREATER_OR_EQUAL => T_IS_GREATER_OR_EQUAL]
$functionNameTokens
Tokens that represent the names of called functions.
public
static array<int|string, int|string>
$functionNameTokens
= [T_STRING => T_STRING, T_EVAL => T_EVAL, T_EXIT => T_EXIT, T_INCLUDE => T_INCLUDE, T_INCLUDE_ONCE => T_INCLUDE_ONCE, T_REQUIRE => T_REQUIRE, T_REQUIRE_ONCE => T_REQUIRE_ONCE, T_ISSET => T_ISSET, T_UNSET => T_UNSET, T_EMPTY => T_EMPTY, T_SELF => T_SELF, T_STATIC => T_STATIC]
Mostly, these are just strings. But PHP tokenizes some language constructs and functions using their own tokens.
$heredocTokens
Tokens that make up a heredoc string.
public
static array<int|string, int|string>
$heredocTokens
= [T_START_HEREDOC => T_START_HEREDOC, T_END_HEREDOC => T_END_HEREDOC, T_HEREDOC => T_HEREDOC, T_START_NOWDOC => T_START_NOWDOC, T_END_NOWDOC => T_END_NOWDOC, T_NOWDOC => T_NOWDOC]
$includeTokens
Tokens that include files.
public
static array<int|string, int|string>
$includeTokens
= [T_REQUIRE_ONCE => T_REQUIRE_ONCE, T_REQUIRE => T_REQUIRE, T_INCLUDE_ONCE => T_INCLUDE_ONCE, T_INCLUDE => T_INCLUDE]
$magicConstants
Tokens representing PHP magic constants.
public
static array<string|int, mixed>
$magicConstants
= [T_CLASS_C => T_CLASS_C, T_DIR => T_DIR, T_FILE => T_FILE, T_FUNC_C => T_FUNC_C, T_LINE => T_LINE, T_METHOD_C => T_METHOD_C, T_NS_C => T_NS_C, T_TRAIT_C => T_TRAIT_C]
<int|string> => <int|string>
Tags
$methodPrefixes
Tokens that can prefix a method name
public
static array<int|string, int|string>
$methodPrefixes
= [T_PRIVATE => T_PRIVATE, T_PUBLIC => T_PUBLIC, T_PROTECTED => T_PROTECTED, T_ABSTRACT => T_ABSTRACT, T_STATIC => T_STATIC, T_FINAL => T_FINAL]
$ooScopeTokens
Tokens that open class and object scopes.
public
static array<int|string, int|string>
$ooScopeTokens
= [T_CLASS => T_CLASS, T_ANON_CLASS => T_ANON_CLASS, T_INTERFACE => T_INTERFACE, T_TRAIT => T_TRAIT]
$operators
Tokens that perform operations.
public
static array<int|string, int|string>
$operators
= [T_MINUS => T_MINUS, T_PLUS => T_PLUS, T_MULTIPLY => T_MULTIPLY, T_DIVIDE => T_DIVIDE, T_MODULUS => T_MODULUS, T_POW => T_POW, T_SPACESHIP => T_SPACESHIP, T_COALESCE => T_COALESCE, T_BITWISE_AND => T_BITWISE_AND, T_BITWISE_OR => T_BITWISE_OR, T_BITWISE_XOR => T_BITWISE_XOR, T_SL => T_SL, T_SR => T_SR]
$parenthesisOpeners
Token types that open parenthesis.
public
static array<int|string, int|string>
$parenthesisOpeners
= [T_ARRAY => T_ARRAY, T_LIST => T_LIST, T_FUNCTION => T_FUNCTION, T_CLOSURE => T_CLOSURE, T_ANON_CLASS => T_ANON_CLASS, T_WHILE => T_WHILE, T_FOR => T_FOR, T_FOREACH => T_FOREACH, T_SWITCH => T_SWITCH, T_IF => T_IF, T_ELSEIF => T_ELSEIF, T_CATCH => T_CATCH, T_DECLARE => T_DECLARE, T_MATCH => T_MATCH]
$phpcsCommentTokens
Tokens that are comments containing PHPCS instructions.
public
static array<int|string, int|string>
$phpcsCommentTokens
= [T_PHPCS_ENABLE => T_PHPCS_ENABLE, T_PHPCS_DISABLE => T_PHPCS_DISABLE, T_PHPCS_SET => T_PHPCS_SET, T_PHPCS_IGNORE => T_PHPCS_IGNORE, T_PHPCS_IGNORE_FILE => T_PHPCS_IGNORE_FILE]
$scopeModifiers
Tokens that represent scope modifiers.
public
static array<int|string, int|string>
$scopeModifiers
= [T_PRIVATE => T_PRIVATE, T_PUBLIC => T_PUBLIC, T_PROTECTED => T_PROTECTED]
$scopeOpeners
Tokens that are allowed to open scopes.
public
static array<int|string, int|string>
$scopeOpeners
= [T_CLASS => T_CLASS, T_ANON_CLASS => T_ANON_CLASS, T_INTERFACE => T_INTERFACE, T_TRAIT => T_TRAIT, T_NAMESPACE => T_NAMESPACE, T_FUNCTION => T_FUNCTION, T_CLOSURE => T_CLOSURE, T_IF => T_IF, T_SWITCH => T_SWITCH, T_CASE => T_CASE, T_DECLARE => T_DECLARE, T_DEFAULT => T_DEFAULT, T_WHILE => T_WHILE, T_ELSE => T_ELSE, T_ELSEIF => T_ELSEIF, T_FOR => T_FOR, T_FOREACH => T_FOREACH, T_DO => T_DO, T_TRY => T_TRY, T_CATCH => T_CATCH, T_FINALLY => T_FINALLY, T_PROPERTY => T_PROPERTY, T_OBJECT => T_OBJECT, T_USE => T_USE, T_MATCH => T_MATCH]
$stringTokens
Tokens that represent strings.
public
static array<int|string, int|string>
$stringTokens
= [T_CONSTANT_ENCAPSED_STRING => T_CONSTANT_ENCAPSED_STRING, T_DOUBLE_QUOTED_STRING => T_DOUBLE_QUOTED_STRING]
Note that T_STRINGS are NOT represented in this list.
$textStringTokens
Tokens that represent text strings.
public
static array<int|string, int|string>
$textStringTokens
= [T_CONSTANT_ENCAPSED_STRING => T_CONSTANT_ENCAPSED_STRING, T_DOUBLE_QUOTED_STRING => T_DOUBLE_QUOTED_STRING, T_INLINE_HTML => T_INLINE_HTML, T_HEREDOC => T_HEREDOC, T_NOWDOC => T_NOWDOC]
$weightings
The token weightings.
public
static array<int|string, int>
$weightings
= [
T_CLASS => 1000,
T_INTERFACE => 1000,
T_TRAIT => 1000,
T_NAMESPACE => 1000,
T_FUNCTION => 100,
T_CLOSURE => 100,
/*
* Conditions.
*/
T_WHILE => 50,
T_FOR => 50,
T_FOREACH => 50,
T_IF => 50,
T_ELSE => 50,
T_ELSEIF => 50,
T_DO => 50,
T_TRY => 50,
T_CATCH => 50,
T_FINALLY => 50,
T_SWITCH => 50,
T_MATCH => 50,
T_SELF => 25,
T_PARENT => 25,
/*
* Operators and arithmetic.
*/
T_BITWISE_AND => 8,
T_BITWISE_OR => 8,
T_BITWISE_XOR => 8,
T_MULTIPLY => 5,
T_DIVIDE => 5,
T_PLUS => 5,
T_MINUS => 5,
T_MODULUS => 5,
T_POW => 5,
T_SPACESHIP => 5,
T_COALESCE => 5,
T_COALESCE_EQUAL => 5,
T_SL => 5,
T_SR => 5,
T_SL_EQUAL => 5,
T_SR_EQUAL => 5,
T_EQUAL => 5,
T_AND_EQUAL => 5,
T_CONCAT_EQUAL => 5,
T_DIV_EQUAL => 5,
T_MINUS_EQUAL => 5,
T_MOD_EQUAL => 5,
T_MUL_EQUAL => 5,
T_OR_EQUAL => 5,
T_PLUS_EQUAL => 5,
T_XOR_EQUAL => 5,
T_BOOLEAN_AND => 5,
T_BOOLEAN_OR => 5,
/*
* Equality.
*/
T_IS_EQUAL => 5,
T_IS_NOT_EQUAL => 5,
T_IS_IDENTICAL => 5,
T_IS_NOT_IDENTICAL => 5,
T_IS_SMALLER_OR_EQUAL => 5,
T_IS_GREATER_OR_EQUAL => 5,
]
Methods
getHighestWeightedToken()
Returns the highest weighted token type.
public
static getHighestWeightedToken(array<string|int, int|string> $tokens) : int|false
Tokens are weighted by their approximate frequency of appearance in code
- the less frequently they appear in the code, the higher the weighting. For example T_CLASS tokens appear very infrequently in a file, and therefore have a high weighting.
Returns false if there are no weightings for any of the specified tokens.
Parameters
- $tokens : array<string|int, int|string>
-
The token types to get the highest weighted type for.
Return values
int|false —The highest weighted token.
tokenName()
Given a token, returns the name of the token.
public
static tokenName(int|string $token) : string
If passed an integer, the token name is sourced from PHP's token_name() function. If passed a string, it is assumed to be a PHPCS-supplied token that begins with PHPCS_T_, so the name is sourced from the token value itself.
Parameters
- $token : int|string
-
The token to get the name for.