Packages:
PHP_CodeSniffer

Classes:

Class: Tokens

Source Location: /PHP_CodeSniffer-3.0.0RC2/src/Util/Tokens.php

[ Top ]

Tokens that represent arithmetic operators.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that represent assignments.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that open code blocks.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that perform boolean operations.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that represent brackets and parenthesis.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that represent casting.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that are comments.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that represent comparison operator.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that don't represent code.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that represent equality comparisons.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that represent the names of called functions.

Mostly, these are just strings. But PHP tokeizes some language constructs and functions using their own tokens.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that make up a heredoc string.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that include files.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that can prefix a method name

Var: int>
Access: public

Type: array

[ Top ]

Tokens that perform operations.

Var: int>
Access: public

Type: array

[ Top ]

Token types that open parenthesis.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that represent scope modifiers.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that are allowed to open scopes.

Var: int>
Access: public

Type: array

[ Top ]

Tokens that represent strings.

Note that T_STRINGS are NOT represented in this list.

Var: int>
Access: public

Type: array

[ Top ]

The token weightings.

Var: int>
Access: public

Type: array

[ Top ]

int getHighestWeightedToken(
array
$tokens)

Returns the highest weighted token type.

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.

Return: The highest weighted token.
Access: public

array$tokens — int> $tokens The token types to get the highest weighted type for.

[ Top ]

Class: Tokens

Class Overview

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$arithmeticTokens = array( T_PLUS => T_PLUS, T_MINUS => T_MINUS, T_MULTIPLY => T_MULTIPLY, T_DIVIDE => T_DIVIDE, T_MODULUS => T_MODULUS, )

$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 = 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, )

$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, )

$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 = 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, )

$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 = array( T_REQUIRE_ONCE => T_REQUIRE_ONCE, T_REQUIRE => T_REQUIRE, T_INCLUDE_ONCE => T_INCLUDE_ONCE, T_INCLUDE => T_INCLUDE, )

$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, )

$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 = array( T_PRIVATE => T_PRIVATE, T_PUBLIC => T_PUBLIC, T_PROTECTED => T_PROTECTED, )

$stringTokens = array( T_CONSTANT_ENCAPSED_STRING => T_CONSTANT_ENCAPSED_STRING, T_DOUBLE_QUOTED_STRING => T_DOUBLE_QUOTED_STRING, )

Method Detail

getHighestWeightedToken [line 559]

Parameters:

$arithmeticTokens = array(
T_PLUS => T_PLUS,
T_MINUS => T_MINUS,
T_MULTIPLY => T_MULTIPLY,
T_DIVIDE => T_DIVIDE,
T_MODULUS => T_MODULUS,
)

$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 = 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,
)

$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,
)

$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 = 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,
)

$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 = array(
T_REQUIRE_ONCE => T_REQUIRE_ONCE,
T_REQUIRE => T_REQUIRE,
T_INCLUDE_ONCE => T_INCLUDE_ONCE,
T_INCLUDE => T_INCLUDE,
)

$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,
)

$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 = array(
T_PRIVATE => T_PRIVATE,
T_PUBLIC => T_PUBLIC,
T_PROTECTED => T_PROTECTED,
)

$stringTokens = array(
T_CONSTANT_ENCAPSED_STRING => T_CONSTANT_ENCAPSED_STRING,
T_DOUBLE_QUOTED_STRING => T_DOUBLE_QUOTED_STRING,
)