Class: PHP_CodeSniffer_File

It provides a means for traversing the token stack, along with other token related operations. If a PHP_CodeSniffer_Sniff finds and error or warning within a PHP_CodeSniffer_File, you can raise an error using the addError() or addWarning() methods.

Token Information

Each token within the stack contains information about itself:

   array(

    'code'       => 301,       // the token type code (see token_get_all())
    'content'    => 'if',      // the token content
    'type'       => 'T_IF',    // the token name
    'line'       => 56,        // the line number when the token is located
    'column'     => 12,        // the column in the line where this token
                               // starts (starts from 1)
    'level'      => 2          // the depth a token is within the scopes open
    'conditions' => array(     // a list of scope condition token
                               // positions => codes that
                     2 => 50,  // openened the scopes that this token exists
                     9 => 353, // in (see conditional tokens section below)
                    ),
   );

Conditional Tokens

In addition to the standard token fields, conditions contain information to determine where their scope begins and ends:

   array(

    'scope_condition' => 38, // the token position of the condition
    'scope_opener'    => 41, // the token position that started the scope
    'scope_closer'    => 70, // the token position that ended the scope
   );

The condition, the scope opener and the scope closer each contain this information.

Parenthesis Tokens

Each parenthesis token (T_OPEN_PARENTHESIS and T_CLOSE_PARENTHESIS) has a reference to their opening and closing parenthesis, one being itself, the other being its oposite.

   array(

    'parenthesis_opener' => 34,
    'parenthesis_closer' => 40,
   );

Some tokens can "own" a set of parethesis. For example a T_FUNCTION token has parenthesis around its argument list. These tokens also have the parenthesis_opener and and parenthesis_closer indicies. Not all parethesis have owners, for example parenthesis used for arithmetic operations and function calls. The parenthesis tokens that have an owner have the following auxilery array indicies.

   array(

    'parenthesis_opener' => 34,
    'parenthesis_closer' => 40,
    'parenthesis_owner'  => 33,
   );

Each token within a set of parenthesis also has an array indicy 'nested_parenthesis' which is an array of the left parenthesis => right parenthesis token positions.

   'nested_parentheisis' => array(

                             12 => 15
                             11 => 14
                            );

Extended Tokens

PHP_CodeSniffer extends and augments some of the tokens created by token_get_all(). A full list of these tokens can be seen in the Tokens.php file.

$eolChar =  ''

[line 132]

$numTokens =  0

[line 162]

Stored here to save calling count() everywhere.

$phpcs =  null

[line 139]

$ruleset = array()

[line 252]

This value gets set by PHP_CodeSniffer when the object is created. It may be empty, indicating that the ruleset does not override any of the default sniff settings.

$tokenizer =  null

[line 146]

$tokenizers = array()

[line 241]

This value gets set by PHP_CodeSniffer when the object is created.

$tokenizerType =  'PHP'

[line 153]

__construct (Constructor)   [line 271]

addError   [line 672]

addTokenListener   [line 314]

addWarning   [line 774]

cleanUp   [line 543]

detectLineEndings   [line 615]

findExtendedClassName   [line 2718]

findFirstOnLine   [line 2598]

findNext   [line 2540]

findPrevious   [line 2473]

getClassProperties   [line 2309]

   array(

    'is_abstract' => false, // true if the abstract keyword was found.
    'is_final'    => false, // true if the final keyword was found.
   );

getCondition   [line 2685]

getDeclarationName   [line 1920]

getErrorCount   [line 869]

getErrors   [line 905]

getFilename   [line 929]

getIgnoredLines   [line 893]

getMemberProperties   [line 2214]

   array(

    'scope'       => 'public', // public private or protected
    'is_static'   => false,    // true if the static keyword was found.
   );

getMethodParameters   [line 2003]

   0 => array(

         'name'              => '$var',  // The variable name.
         'pass_by_reference' => false,   // Passed by reference.
         'type_hint'         => string,  // Type hint for array or custom type
        )

getMethodProperties   [line 2126]

   array(

    'scope'           => 'public', // public private or protected
    'scope_specified' => true,     // true is scope keyword was found.
    'is_abstract'     => false,    // true if the abstract keyword was found.
    'is_final'        => false,    // true if the final keyword was found.
    'is_static'       => false,    // true if the static keyword was found.
    'is_closure'      => false,    // true if no name is found.
   );

getTokens   [line 365]

getTokensAsString   [line 2434]

getWarningCount   [line 881]

getWarnings   [line 917]

hasCondition   [line 2648]

isAnonymousFunction   [line 1952]

isReference   [line 2360]

removeTokenListener   [line 339]

setActiveListener   [line 294]

start   [line 380]

tokenizeString   [line 948]