Documentation

PHP_CodeSniffer_Tokens
in package

The Tokens class contains weightings for tokens based on their probability of occurrence in a file.

The less the chance of a high occurrence of an arbitrary token, the higher the weighting.

Tags
category

PHP

author

Greg Sherwood gsherwood@squiz.net

author

Marc McIntyre mmcintyre@squiz.net

copyright

2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)

license

https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence

version

Release: @package_version@

link
http://pear.php.net/package/PHP_CodeSniffer

Table of Contents

$arithmeticTokens  : array<string|int, mixed>|(int)
Tokens that represent arithmetic operators.
$assignmentTokens  : array<string|int, mixed>|(int)
Tokens that represent assignments.
$blockOpeners  : array<string|int, mixed>|(int)
Tokens that open code blocks.
$booleanOperators  : array<string|int, mixed>|(int)
Tokens that perform boolean operations.
$bracketTokens  : array<string|int, mixed>|(int)
Tokens that represent brackets and parenthesis.
$castTokens  : array<string|int, mixed>|(int)
Tokens that represent casting.
$commentTokens  : array<string|int, mixed>|(int)
Tokens that are comments.
$comparisonTokens  : array<string|int, mixed>|(int)
Tokens that represent comparison operator.
$emptyTokens  : array<string|int, mixed>|(int)
Tokens that don't represent code.
$equalityTokens  : array<string|int, mixed>|(int)
Tokens that represent equality comparisons.
$functionNameTokens  : array<string|int, mixed>|(int)
Tokens that represent the names of called functions.
$heredocTokens  : array<string|int, mixed>|(int)
Tokens that make up a heredoc string.
$includeTokens  : array<string|int, mixed>|(int)
Tokens that include files.
$knownLengths  : mixed
The token weightings.
$methodPrefixes  : array<string|int, mixed>|(int)
Tokens that can prefix a method name
$operators  : array<string|int, mixed>|(int)
Tokens that perform operations.
$parenthesisOpeners  : array<string|int, mixed>|(int)
Token types that open parenthesis.
$scopeModifiers  : array<string|int, mixed>|(int)
Tokens that represent scope modifiers.
$scopeOpeners  : array<string|int, mixed>|(int)
Tokens that are allowed to open scopes.
$stringTokens  : array<string|int, mixed>|(int)
Tokens that represent strings.
$textStringTokens  : array<string|int, mixed>|(int)
Tokens that represent text strings.
$weightings  : mixed
The token weightings.
getHighestWeightedToken()  : int
Returns the highest weighted token type.
__construct()  : mixed
A PHP_CodeSniffer_Tokens class cannot be constructed.

Properties

$arithmeticTokens

Tokens that represent arithmetic operators.

public static array<string|int, mixed>|(int) $arithmeticTokens = array(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<string|int, mixed>|(int) $assignmentTokens = array(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)

$blockOpeners

Tokens that open code blocks.

public static array<string|int, mixed>|(int) $blockOpeners = array(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<string|int, mixed>|(int) $booleanOperators = array(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<string|int, mixed>|(int) $bracketTokens = array(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<string|int, mixed>|(int) $castTokens = array(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<string|int, mixed>|(int) $commentTokens = array(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)

$comparisonTokens

Tokens that represent comparison operator.

public static array<string|int, mixed>|(int) $comparisonTokens = array(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<string|int, mixed>|(int) $emptyTokens = array(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)

$equalityTokens

Tokens that represent equality comparisons.

public static array<string|int, mixed>|(int) $equalityTokens = array(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<string|int, mixed>|(int) $functionNameTokens = array(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)

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<string|int, mixed>|(int) $heredocTokens = array(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<string|int, mixed>|(int) $includeTokens = array(T_REQUIRE_ONCE => T_REQUIRE_ONCE, T_REQUIRE => T_REQUIRE, T_INCLUDE_ONCE => T_INCLUDE_ONCE, T_INCLUDE => T_INCLUDE)

$knownLengths

The token weightings.

public static mixed $knownLengths = array(T_ABSTRACT => 8, T_AND_EQUAL => 2, T_ARRAY => 5, T_AS => 2, T_BOOLEAN_AND => 2, T_BOOLEAN_OR => 2, T_BREAK => 5, T_CALLABLE => 8, T_CASE => 4, T_CATCH => 5, T_CLASS => 5, T_CLASS_C => 9, T_CLONE => 5, T_CONCAT_EQUAL => 2, T_CONST => 5, T_CONTINUE => 8, T_CURLY_OPEN => 2, T_DEC => 2, T_DECLARE => 7, T_DEFAULT => 7, T_DIR => 7, T_DIV_EQUAL => 2, T_DO => 2, T_DOLLAR_OPEN_CURLY_BRACES => 2, T_DOUBLE_ARROW => 2, T_DOUBLE_COLON => 2, T_ECHO => 4, T_ELSE => 4, T_ELSEIF => 6, T_EMPTY => 5, T_ENDDECLARE => 10, T_ENDFOR => 6, T_ENDFOREACH => 10, T_ENDIF => 5, T_ENDSWITCH => 9, T_ENDWHILE => 8, T_EVAL => 4, T_EXTENDS => 7, T_FILE => 8, T_FINAL => 5, T_FINALLY => 7, T_FOR => 3, T_FOREACH => 7, T_FUNCTION => 8, T_FUNC_C => 12, T_GLOBAL => 6, T_GOTO => 4, T_HALT_COMPILER => 15, T_IF => 2, T_IMPLEMENTS => 10, T_INC => 2, T_INCLUDE => 7, T_INCLUDE_ONCE => 12, T_INSTANCEOF => 10, T_INSTEADOF => 9, T_INTERFACE => 9, T_ISSET => 5, T_IS_EQUAL => 2, T_IS_GREATER_OR_EQUAL => 2, T_IS_IDENTICAL => 3, T_IS_NOT_EQUAL => 2, T_IS_NOT_IDENTICAL => 3, T_IS_SMALLER_OR_EQUAL => 2, T_LINE => 8, T_LIST => 4, T_LOGICAL_AND => 3, T_LOGICAL_OR => 2, T_LOGICAL_XOR => 3, T_METHOD_C => 10, T_MINUS_EQUAL => 2, T_POW_EQUAL => 3, T_MOD_EQUAL => 2, T_MUL_EQUAL => 2, T_NAMESPACE => 9, T_NS_C => 13, T_NS_SEPARATOR => 1, T_NEW => 3, T_OBJECT_OPERATOR => 2, T_OPEN_TAG_WITH_ECHO => 3, T_OR_EQUAL => 2, T_PLUS_EQUAL => 2, T_PRINT => 5, T_PRIVATE => 7, T_PUBLIC => 6, T_PROTECTED => 9, T_REQUIRE => 7, T_REQUIRE_ONCE => 12, T_RETURN => 6, T_STATIC => 6, T_SWITCH => 6, T_THROW => 5, T_TRAIT => 5, T_TRAIT_C => 9, T_TRY => 3, T_UNSET => 5, T_USE => 3, T_VAR => 3, T_WHILE => 5, T_XOR_EQUAL => 2, T_YIELD => 5, T_OPEN_CURLY_BRACKET => 1, T_CLOSE_CURLY_BRACKET => 1, T_OPEN_SQUARE_BRACKET => 1, T_CLOSE_SQUARE_BRACKET => 1, T_OPEN_PARENTHESIS => 1, T_CLOSE_PARENTHESIS => 1, T_COLON => 1, T_NULLABLE => 1, T_STRING_CONCAT => 1, T_INLINE_THEN => 1, T_INLINE_ELSE => 1, T_NULL => 4, T_FALSE => 5, T_TRUE => 4, T_SEMICOLON => 1, T_EQUAL => 1, T_MULTIPLY => 1, T_DIVIDE => 1, T_PLUS => 1, T_MINUS => 1, T_MODULUS => 1, T_POW => 2, T_SPACESHIP => 3, T_COALESCE => 2, T_COALESCE_EQUAL => 3, T_BITWISE_AND => 1, T_BITWISE_OR => 1, T_BITWISE_XOR => 1, T_SL => 2, T_SR => 2, T_SL_EQUAL => 3, T_SR_EQUAL => 3, T_ARRAY_HINT => 5, T_GREATER_THAN => 1, T_LESS_THAN => 1, T_BOOLEAN_NOT => 1, T_SELF => 4, T_PARENT => 6, T_COMMA => 1, T_THIS => 4, T_CLOSURE => 8, T_BACKTICK => 1, T_OPEN_SHORT_ARRAY => 1, T_CLOSE_SHORT_ARRAY => 1)

$methodPrefixes

Tokens that can prefix a method name

public static array<string|int, mixed>|(int) $methodPrefixes = array(T_PRIVATE => T_PRIVATE, T_PUBLIC => T_PUBLIC, T_PROTECTED => T_PROTECTED, T_ABSTRACT => T_ABSTRACT, T_STATIC => T_STATIC, T_FINAL => T_FINAL)

$operators

Tokens that perform operations.

public static array<string|int, mixed>|(int) $operators = array(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<string|int, mixed>|(int) $parenthesisOpeners = array(T_ARRAY => T_ARRAY, T_FUNCTION => T_FUNCTION, T_CLOSURE => T_CLOSURE, 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)

$scopeModifiers

Tokens that represent scope modifiers.

public static array<string|int, mixed>|(int) $scopeModifiers = array(T_PRIVATE => T_PRIVATE, T_PUBLIC => T_PUBLIC, T_PROTECTED => T_PROTECTED)

$scopeOpeners

Tokens that are allowed to open scopes.

public static array<string|int, mixed>|(int) $scopeOpeners = array(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)

$stringTokens

Tokens that represent strings.

public static array<string|int, mixed>|(int) $stringTokens = array(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<string|int, mixed>|(int) $textStringTokens = array(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 mixed $weightings = array( 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_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, mixed>|(int) $tokens) : int

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, mixed>|(int)

The token types to get the highest weighted type for.

Return values
int

The highest weighted token.

__construct()

A PHP_CodeSniffer_Tokens class cannot be constructed.

private __construct() : mixed

Only static calls are allowed.

Return values
mixed

Search results