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

Class: PHP_CodeSniffer_Sniff

Source Location: /PHP_CodeSniffer-0.7.0/CodeSniffer/Sniff.php

Class Overview


Represents a PHP_CodeSniffer sniff for sniffing coding standards.


Author(s):

Version:

  • Release: 0.7.0

Copyright:

  • 2006 Squiz Pty Ltd (ABN 77 084 670 600)

Methods


Inherited Variables

Inherited Methods


Class Details

[line 36]
Represents a PHP_CodeSniffer sniff for sniffing coding standards.

A sniff registers what token types it wishes to listen for, then, when PHP_CodeSniffer encounters that token, the sniff is invoked and passed information about where the token was found in the stack, and the PHP_CodeSniffer file in which the token was found.



[ Top ]


Method Detail

process   [line 89]

void process( PHP_CodeSniffer_File $phpcsFile, int $stackPtr)

Called when one of the token types that this sniff is listening for is found.

The stackPtr variable indicates where in the stack the token was found. A sniff can acquire information this token, along with all the other tokens within the stack by first acquiring the token stack:

  1.     $tokens $phpcsFile->getTokens();
  2.     echo 'Encountered a '.$tokens[$stackPtr]['type'].' token';
  3.     echo 'token information: ';
  4.     print_r($tokens[$stackPtr]);

If the sniff discovers an anomilty in the code, they can raise an error by calling addError() on the PHP_CodeSniffer_File object, specifying an error message and the position of the offending token:

  1.     $phpcsFile->addError('Encountered an error'$stackPtr);

  • Access: public

Parameters:

PHP_CodeSniffer_File   $phpcsFile   —  The PHP_CodeSniffer file where the token was found.
int   $stackPtr   —  The position in the PHP_CodeSniffer file's token stack where the token was found.

[ Top ]

register   [line 57]

array(int) register( )

Registers the tokens that this sniff wants to listen for.

An example return value for a sniff that wants to listen for whitespace and any comments would be:

  1.     return array(
  2.             T_WHITESPACE,
  3.             T_DOC_COMMENT,
  4.             T_COMMENT,
  5.            );


[ Top ]


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