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, // opened 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 opposite.

  array(

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

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

  array(

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

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

  'nested_parenthesis' => 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]

$fixer = null

[line 146]

$numTokens = 0

[line 169]

Stored here to save calling count() everywhere.

$phpcs = null

[line 139]

$ruleset = array()

[line 286]

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 153]

$tokenizerType = 'PHP'

[line 160]

__construct (Constructor) [line 303]

addError [line 808]

addErrorOnLine [line 875]

addFixableError [line 925]

addFixableWarning [line 956]

addTokenListener [line 365]

addWarning [line 842]

addWarningOnLine [line 899]

cleanUp [line 631]

detectLineEndings [line 750]

findEndOfStatement [line 3464]

findExtendedClassName [line 3659]

findFirstOnLine [line 3539]

findNext [line 3361]

findPrevious [line 3280]

findStartOfStatement [line 3409]

getClassProperties [line 3092]

  array(

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

getCondition [line 3626]

getDeclarationName [line 2659]

getErrorCount [line 1304]

getErrors [line 1364]

getFilename [line 1400]

getFixableCount [line 1340]

getIgnoredLines [line 1352]

getMemberProperties [line 2994]

  array(

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

getMethodParameters [line 2757]

  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 2906]

  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.
  );

getMetrics [line 1388]

getSuccessCount [line 1328]

getTokens [line 425]

getTokensAsString [line 3237]

getWarningCount [line 1316]

getWarnings [line 1376]

hasCondition [line 3589]

isAnonymousFunction [line 2699]

isReference [line 3143]

recordMetric [line 1278]

refreshTokenListeners [line 412]

removeTokenListener [line 391]

setActiveListener [line 345]

start [line 440]

tokenizeString [line 1422]