• Главная
• PHP_CodeSniffer_File

PHP Класс PHP_CodeSniffer_File, PHP_CodeSniffer

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	string	The EOL character this file uses.
$fixer	PHP_CodeSniffer_Fixer	The Fixer object to control fixing errors.
$numTokens	integer	Stored here to save calling count() everywhere.
$phpcs	PHP_CodeSniffer	The PHP_CodeSniffer object controlling this run.
$tokenizer	object	The tokenizer being used for this file.
$tokenizerType	string	The tokenizer being used for this file.

Защищенные свойства (Protected)

Свойство	Тип	Описание
$ruleset	array	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.

Открытые методы

Метод	Описание
__construct ( string $file, array $listeners, array $ruleset, PHP_CodeSniffer $phpcs )	Constructs a PHP_CodeSniffer_File.
addError ( string $error, integer $stackPtr, string $code = '', array $data = [], integer $severity, boolean $fixable = false ) : boolean	Records an error against a specific token in the file.
addErrorOnLine ( string $error, integer $line, string $code = '', array $data = [], integer $severity ) : boolean	Records an error against a specific line in the file.
addFixableError ( string $error, integer $stackPtr, string $code = '', array $data = [], integer $severity ) : boolean	Records a fixable error against a specific token in the file.
addFixableWarning ( string $warning, integer $stackPtr, string $code = '', array $data = [], integer $severity ) : boolean	Records a fixable warning against a specific token in the file.
addTokenListener ( PHP_CodeSniffer_Sniff $listener, array $tokens ) : void	Adds a listener to the token stack that listens to the specific tokens.
addWarning ( string $warning, integer $stackPtr, string $code = '', array $data = [], integer $severity, boolean $fixable = false ) : boolean	Records a warning against a specific token in the file.
addWarningOnLine ( string $warning, integer $line, string $code = '', array $data = [], integer $severity ) : boolean	Records a warning against a specific token in the file.
cleanUp ( ) : void	Remove vars stored in this file that are no longer required.
detectLineEndings ( string $file, string $contents = null ) : string	Opens a file and detects the EOL character being used.
findEndOfStatement ( integer $start, integer | array $ignore = null ) : integer	Returns the position of the last non-whitespace token in a statement.
findExtendedClassName ( integer $stackPtr ) : string	Returns the name of the class that the specified class extends.
findFirstOnLine ( integer | array $types, integer $start, boolean $exclude = false, string $value = null ) : integer | boolean	Returns the position of the first token on a line, matching given type.
findImplementedInterfaceNames ( integer $stackPtr ) : array | false	Returns the name(s) of the interface(s) that the specified class implements.
findNext ( integer | array $types, integer $start, integer $end = null, boolean $exclude = false, string $value = null, boolean $local = false ) : integer | boolean	Returns the position of the next specified token(s).
findPrevious ( integer | array $types, integer $start, integer $end = null, boolean $exclude = false, string $value = null, boolean $local = false ) : integer | boolean	Returns the position of the previous specified token(s).
findStartOfStatement ( integer $start, integer | array $ignore = null ) : integer	Returns the position of the first non-whitespace token in a statement.
getClassProperties ( integer $stackPtr ) : array	Returns the visibility and implementation properties of a class.
getCondition ( integer $stackPtr, integer $type ) : integer	Return the position of the condition for the passed token.
getDeclarationName ( integer $stackPtr ) : string | null	Returns the declaration names for T_CLASS, T_INTERFACE and T_FUNCTION tokens.
getErrorCount ( ) : integer	Returns the number of errors raised.
getErrors ( ) : array	Returns the errors raised from processing this file.
getFilename ( ) : string	Returns the absolute filename of this file.
getFixableCount ( ) : integer	Returns the number of fixable errors/warnings raised.
getIgnoredLines ( ) : array	Returns the list of ignored lines.
getMemberProperties ( integer $stackPtr ) : array	Returns the visibility and implementation properties of the class member variable found at the specified position in the stack.
getMethodParameters ( integer $stackPtr ) : array	Returns the method parameters for the specified T_FUNCTION token.
getMethodProperties ( integer $stackPtr ) : array	Returns the visibility and implementation properties of a method.
getMetrics ( ) : array	Returns the metrics found while processing this file.
getSuccessCount ( ) : integer	Returns the number of successes recorded.
getTokens ( ) : array	Returns the token stack for this file.
getTokensAsString ( integer $start, integer $length ) : string	Returns the content of the tokens from the specified start position in the token stack for the specified length.
getWarningCount ( ) : integer	Returns the number of warnings raised.
getWarnings ( ) : array	Returns the warnings raised from processing this file.
hasCondition ( integer $stackPtr, integer | array $types ) : boolean	Determine if the passed token has a condition of one of the passed types.
isAnonymousFunction ( integer $stackPtr ) : boolean	Check if the token at the specified position is a anonymous function.
isReference ( integer $stackPtr ) : boolean	Determine if the passed token is a reference operator.
recordMetric ( integer $stackPtr, string $metric, string $value ) : boolean	Adds an warning to the warning stack.
refreshTokenListeners ( ) : void	Rebuilds the list of listeners to ensure their state is cleared.
removeTokenListener ( PHP_CodeSniffer_Sniff $listener, array $tokens ) : void	Removes a listener from listening from the specified tokens.
setActiveListener ( string $activeListener ) : void	Sets the name of the currently active sniff.
start ( string $contents = null ) : void	Starts the stack traversal and tells listeners when tokens are found.
tokenizeString ( string $string, object $tokenizer, string $eolChar = '\n', integer $tabWidth = null, string $encoding = null ) : array	Creates an array of tokens when given some PHP code.

Приватные методы

Метод	Описание
_addError ( string $error, integer $line, integer $column, string $code, array $data, integer $severity, boolean $fixable ) : boolean	Adds an error to the error stack.
_addWarning ( string $warning, integer $line, integer $column, string $code, array $data, integer $severity, boolean $fixable ) : boolean	Adds an warning to the warning stack.
_createLevelMap ( array &$tokens, object $tokenizer, string $eolChar ) : void	Constructs the level map.
_createParenthesisNestingMap ( array &$tokens, object $tokenizer, string $eolChar ) : void	Creates a map for the parenthesis tokens that surround other tokens.
_createPositionMap ( array &$tokens, object $tokenizer, string $eolChar, string $encoding, integer $tabWidth ) : void	Sets token position information.
_createScopeMap ( array &$tokens, object $tokenizer, string $eolChar ) : void	Creates a scope map of tokens that open scopes.
_createTokenMap ( array &$tokens, object $tokenizer, string $eolChar ) : void	Creates a map of brackets positions.
_parse ( string $contents = null ) : void	Tokenizes the file and prepares it for the test run.
_recurseScopeMap ( array &$tokens, integer $numTokens, object $tokenizer, string $eolChar, integer $stackPtr, integer $depth = 1, integer &$ignore ) : integer	Recurses though the scope openers to build a scope map.

Описание методов

Описание свойств