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

Packages:
PHP_CodeSniffer
PHP_CodeSniffer_MySource

Classes:

Files:

Class: PHP_CodeSniffer_Standards_AbstractPatternSniff

Source Location: /PHP_CodeSniffer-2.5.0/CodeSniffer/Standards/AbstractPatternSniff.php

Class Overview

Processes pattern strings and checks that the code conforms to the pattern.

Author(s):

Marc McIntyre <mmcintyre at squiz.net>
Greg Sherwood <gsherwood at squiz.net>

Version:

Release: 2.5.0

Copyright:

2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)

Variables

Methods

Child classes:

Squiz_Sniffs_Functions_FunctionDeclarationSniff: Squiz_Sniffs_Functions_FunctionDeclarationSniff.

PEAR_Sniffs_ControlStructures_ControlSignatureSniff: Verifies that control statements conform to their coding standards.

Inherited Variables

Inherited Methods

Class Details

[line 35]
Processes pattern strings and checks that the code conforms to the pattern.

This test essentially checks that code is correctly formatted with whitespace.

Author: Marc McIntyre <mmcintyre@squiz.net>
Author: Greg Sherwood <gsherwood@squiz.net>
Version: Release: 2.5.0
Copyright: 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
Link: http://pear.php.net/package/PHP_CodeSniffer
Abstract:
License: BSD Licence

[ Top ]

Class Variables

$currFile = ''

[line 50]

The current file being checked.

Access: protected

Type: string

[ Top ]

$ignoreComments = false

[line 43]

If true, comments will be ignored if they are found in the code.

Access: public

Type: boolean

[ Top ]

Method Detail

__construct (Constructor) [line 81]

PHP_CodeSniffer_Standards_AbstractPatternSniff __construct(
[boolean
$ignoreComments = null])

Constructs a PHP_CodeSniffer_Standards_AbstractPatternSniff.

Access: public

Parameters:

boolean $ignoreComments — If true, comments will be ignored.

[ Top ]

getPatterns [line 746]

string[] getPatterns(
)

Returns the patterns that should be checked.

Abstract:
Access: protected

Overridden in child classes as:

Squiz_Sniffs_Functions_FunctionDeclarationSniff::getPatterns(): Returns an array of patterns to check are correct.

PEAR_Sniffs_ControlStructures_ControlSignatureSniff::getPatterns(): Returns the patterns that this test wishes to verify.

[ Top ]

prepareError [line 725]

string prepareError(
string
$found, string
$patternCode)

Prepares an error for the specified patternCode.

Return: The error message.
Access: protected

Parameters:

string $found — The actual found string in the code.

string $patternCode — The expected pattern code.

[ Top ]

process [line 206]

void process(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes the test.

See: PHP_CodeSniffer_Standards_AbstractPatternSniff::register()
Access: public

Parameters:

PHP_CodeSniffer_File $phpcsFile — The PHP_CodeSniffer file where the token occurred.

int $stackPtr — The position in the tokens stack where the listening token type was found.

[ Top ]

processPattern [line 274]

array processPattern(
array
$patternInfo, PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes the pattern and verifies the code at $stackPtr.

Access: protected

Parameters:

array $patternInfo — Information about the pattern used for checking, which includes are parsed token representation of the pattern.

PHP_CodeSniffer_File $phpcsFile — The PHP_CodeSniffer file where the token occurred.

int $stackPtr — The position in the tokens stack where the listening token type was found.

[ Top ]

processSupplementary [line 777]

void processSupplementary(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes any tokens registered with registerSupplementary().

See: PHP_CodeSniffer_Standards_AbstractPatternSniff::registerSupplementary()
Access: protected

Parameters:

PHP_CodeSniffer_File $phpcsFile — The PHP_CodeSniffer file where to process the skip.

int $stackPtr — The position in the tokens stack to process.

[ Top ]

register [line 102]

int[] register(
)

Registers the tokens to listen to.

Classes extending AbstractPatternTest should implement the getPatterns() method to register the patterns they wish to test.

See: PHP_CodeSniffer_Standards_AbstractPatternSniff::process()
Access: public

[ Top ]

registerSupplementary [line 759]

int[] registerSupplementary(
)

Registers any supplementary tokens that this test might wish to process.

A sniff may wish to register supplementary tests when it wishes to group an arbitrary validation that cannot be performed using a pattern, with other pattern tests.

See: PHP_CodeSniffer_Standards_AbstractPatternSniff::processSupplementary()
Access: protected

[ Top ]