• Home
  • Squiz_Sniffs_Commenting_LongConditionClosingCommentSniff

PHP Class Squiz_Sniffs_Commenting_LongConditionClosingCommentSniff, PHP_CodeSniffer

See link: http://pear.php.net/package/PHP_CodeSniffer
Author: Greg Sherwood ([email protected])
Author: Marc McIntyre ([email protected])
Inheritance: implements PHP_CodeSniffer_Sniff
Show file Open project: squizlabs/php_codesniffer

Public Properties

Property Type Description
$commentFormat string The placeholder %s will be replaced with the type of condition opener.
$lineLimit integer The length that a code block must be before requiring a closing comment.
$supportedTokenizers array A list of tokenizers this sniff supports.

Public Methods

Method Description
process ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr ) : void Processes this test, when one of its tokens is encountered.
register ( ) : array Returns an array of tokens this test wants to listen for.

Method Details

process() public method

Processes this test, when one of its tokens is encountered.
public process ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr ) : void
$phpcsFile PHP_CodeSniffer_File The file being scanned.
$stackPtr integer The position of the current token in the stack passed in $tokens.
return void

register() public method

Returns an array of tokens this test wants to listen for.
public register ( ) : array
return array

Property Details

$commentFormat public property

The placeholder %s will be replaced with the type of condition opener.
public string $commentFormat
return string

$lineLimit public property

The length that a code block must be before requiring a closing comment.
public int $lineLimit
return integer

$supportedTokenizers public property

A list of tokenizers this sniff supports.
public array $supportedTokenizers
return array