apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: Tokens

Source Location: /PHP_CodeSniffer-3.1.1/src/Util/Tokens.php

Class Overview




Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 124]


[ Top ]


Class Variables

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

[line 268]

Tokens that represent arithmetic operators.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 213]

Tokens that represent assignments.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 408]

Tokens that open code blocks.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 395]

Tokens that perform boolean operations.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 478]

Tokens that represent brackets and parenthesis.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 282]

Tokens that represent casting.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 437]

Tokens that are comments.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 250]

Tokens that represent comparison operator.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 420]

Tokens that don't represent code.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 236]

Tokens that represent equality comparisons.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 521]

Tokens that represent the names of called functions.

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

  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 504]

Tokens that make up a heredoc string.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

$includeTokens = array(
                                    T_REQUIRE_ONCE => T_REQUIRE_ONCE,
                                    T_REQUIRE      => T_REQUIRE,
                                    T_INCLUDE_ONCE => T_INCLUDE_ONCE,
                                    T_INCLUDE      => T_INCLUDE,
                                   )

[line 492]

Tokens that include files.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 360]

Tokens that can prefix a method name
  • Var: int>
  • Access: public

Type:   array


[ Top ]

$ooScopeTokens = array(
                                    T_CLASS      => T_CLASS,
                                    T_ANON_CLASS => T_ANON_CLASS,
                                    T_INTERFACE  => T_INTERFACE,
                                    T_TRAIT      => T_TRAIT,
                                   )

[line 541]

Tokens that are open class and object scopes.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 374]

Tokens that perform operations.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 298]

Token types that open parenthesis.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

$scopeModifiers = array(
                                     T_PRIVATE   => T_PRIVATE,
                                     T_PUBLIC    => T_PUBLIC,
                                     T_PROTECTED => T_PROTECTED,
                                    )

[line 349]

Tokens that represent scope modifiers.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 317]

Tokens that are allowed to open scopes.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 455]

Tokens that represent strings.

Note that T_STRINGS are NOT represented in this list.

  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 465]

Tokens that represent text strings.
  • Var: int>
  • Access: public

Type:   array


[ Top ]

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

[line 132]

The token weightings.
  • Var: int>
  • Access: public

Type:   array


[ Top ]



Method Detail

getHighestWeightedToken   [line 587]

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

Parameters:

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

[ Top ]

tokenName   [line 560]

string tokenName( int|string $token)

Given a token, returns the name of the token.

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.

  • Access: public

Parameters:

int|string   $token   —  The token to get the name for.

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:27:50 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.