PHPCSUtils
Table of Contents
Classes
- AbstractArrayDeclarationSniff
- Abstract sniff to easily examine all parts of an array declaration.
- BCFile
- PHPCS native utility functions.
- BCTokens
- Token arrays related utility methods.
- Helper
- Utility methods to retrieve (configuration) information from PHP_CodeSniffer.
- InvalidTokenArray
- Exception thrown when an non-existent token array is requested.
- LogicException
- Exception for reporting a logic error.
- MissingArgumentError
- Exception for when a (conditionally) required parameter is not passed.
- OutOfBoundsStackPtr
- Exception for when a stack pointer which doesn't exist in the current file is passed.
- RuntimeException
- Exception for reporting a runtime error.
- TestFileNotFound
- Exception thrown when the UtilityMethodTestCase::getTargetToken() method is run without a
tokenized test case file being available.
- TestMarkerNotFound
- Exception thrown when a delimiter comment can not be found in a test case file.
- TestTargetNotFound
- Exception thrown when a test target token can not be found in a test case file.
- TypeError
- Exception for an invalid argument type passed.
- UnexpectedTokenType
- Exception for when a stack pointer is passed which is not of the expected token type.
- ValueError
- Exception for an invalid argument value passed.
- SpacesFixer
- Utility to check and, if necessary, fix the whitespace between two tokens.
- ConfigDouble
- Config class for use in the tests.
- RulesetDouble
- Ruleset class for use in the tests.
- UtilityMethodTestCase
- Base class for use when testing utility methods for PHP_CodeSniffer.
- Collections
- Collections of related tokens as often used and needed for sniffs.
- TokenHelper
- Helpers for working with tokens.
- Arrays
- Utility functions for use when examining arrays.
- Conditions
- Utility functions for use when examining token conditions.
- Constants
- Utility functions for use when examining constants declared using the "const" keyword.
- Context
- Utility functions for examining in which context a certain token is used.
- ControlStructures
- Utility functions for use when examining control structures.
- FileInfo
- Utility functions to retrieve information about the file under scan.
- FilePath
- Helper functions for working with arbitrary file/directory paths.
- FunctionDeclarations
- Utility functions for use when examining function declaration statements.
- GetTokensAsString
- Utility functions to retrieve the content of a set of tokens as a string.
- Lists
- Utility functions to retrieve information when working with lists.
- MessageHelper
- Helper functions for creating PHPCS error/warning messages.
- Namespaces
- Utility functions for use when examining T_NAMESPACE tokens and to determine the
namespace of arbitrary tokens.
- NamingConventions
- Utility functions for working with identifier names.
- Numbers
- Utility functions for working with integer/float tokens.
- ObjectDeclarations
- Utility functions for use when examining object declaration statements.
- Operators
- Utility functions for use when working with operators.
- Orthography
- Utility functions for checking the orthography of arbitrary text strings.
- Parentheses
- Utility functions for use when examining parenthesis tokens and arbitrary tokens wrapped
in parentheses.
- PassedParameters
- Utility functions to retrieve information about parameters passed to function calls,
class instantiations, array declarations, isset and unset constructs.
- Scopes
- Utility functions for use when examining token scopes.
- TextStrings
- Utility functions for working with text string tokens.
- TypeString
- Utility functions for use when examining type strings.
- UseStatements
- Utility functions for examining use statements.
- Variables
- Utility functions for use when examining variables.
Constants
-
PHPCSUTILS_AUTOLOAD
= \true
-
PHPCSUTILS_PHPUNIT_ALIASES_SET
= \true
PHPCSUTILS_AUTOLOAD
public
mixed
PHPCSUTILS_AUTOLOAD
= \true
PHPCSUTILS_PHPUNIT_ALIASES_SET
public
mixed
PHPCSUTILS_PHPUNIT_ALIASES_SET
= \true