• Accueil
• PHP_CodeSniffer

PHP Class PHP_CodeSniffer, PHP_CodeSniffer

Standards are specified by classes that implement the PHP_CodeSniffer_Sniff interface. A sniff registers what token types it wishes to listen for, then PHP_CodeSniffer encounters that token, the sniff is invoked and passed information about where the token was found in the stack, and the token stack itself. Sniff files and their containing class must be prefixed with Sniff, and have an extension of .php. Multiple PHP_CodeSniffer operations can be performed by re-calling the process function with different parameters. Afficher le fichier Open project: squizlabs/php_codesniffer Class Usage Examples

Méthodes publiques

Свойство	Type	Description
$allowedFileExtensions	array	An array of extensions for files we will check.
$allowedTypes	array(string)	An array of variable types for param/var we will check.
$cli	PHP_CodeSniffer_CLI	The CLI object controlling the run.
$defaultFileExtensions	array	If no extensions are set, these will be used as the defaults. If extensions are set, these will be used when the correct tokenizer can not be determined, such as when checking a passed filename instead of files in a directory.
$reporting	PHP_CodeSniffer_Reporting	The Reporting object controlling report generation.
$sniffCodes		The key is the sniff code and the value is the fully qualified name of the sniff class.

Protected Properties

Свойство	Type	Description
$file	string	The file or directory that is currently being processed.
$ignorePatterns	array	An array of patterns to use for skipping files.
$listeners	array(PHP_CodeSniffer_Sniff)	An array of sniff objects that are being used to check files.
$ruleset	array	It may be empty, indicating that the ruleset does not override any of the default sniff settings.
$rulesetDirs	string	This is declared static because it is also used in the autoloader to look for sniffs outside the PHPCS install. This way, standards designed to be installed inside PHPCS can also be used from outside the PHPCS Standards directory.
$sniffs	array(string)	An array of sniffs that are being used to check files.

Méthodes publiques

Méthode	Description
__construct ( integer $verbosity, integer $tabWidth, string $encoding = 'iso-8859-1', boolean $interactive = false )	Constructs a PHP_CodeSniffer object.
autoload ( string $className ) : void	Autoload static method for loading classes and interfaces.
chdir ( string $path ) : void	CodeSniffer alternative for chdir().
generateDocs ( string $standard, array $sniffs = [], string $generator = 'Text' ) : void	Generates documentation for a coding standard.
getAllConfigData ( ) : array	Get all config data in an array.
getConfigData ( string $key ) : string | null	Get a single config value.
getFilesToProcess ( string $paths, boolean $local = false ) : array	Get a list of files that will be processed.
getIgnorePatterns ( string $listener = null ) : array	Gets the array of ignore patterns.
getInstalledStandardPath ( string $standard ) : string | null	Return the path of an installed coding standard.
getInstalledStandardPaths ( ) : array	Get a list paths where standards are installed.
getInstalledStandards ( boolean $includeGeneric = false, string $standardsDir = '' ) : array	Get a list of all coding standards installed.
getSniffs ( ) : PHP_CodeSniffer_Sniff[]	Gets the array of PHP_CodeSniffer_Sniff's.
getTokenSniffs ( ) : array	Gets the array of PHP_CodeSniffer_Sniff's indexed by token type.
initStandard ( string | array $standards, array $restrictions = [], array $exclusions = [] ) : void	Initialise the standard that the run will use.
isCamelCaps ( string $string, boolean $classFormat = false, boolean $public = true, boolean $strict = true ) : boolean	Returns true if the specified string is in the camel caps format.
isInstalledStandard ( string $standard ) : boolean	Determine if a standard is installed.
isPharFile ( string $path ) : mixed	Return TRUE, if the path is a phar file.
isUnderscoreName ( string $string ) : boolean	Returns true if the specified string is in the underscore caps format.
populateTokenListeners ( ) : void	Populates the array of PHP_CodeSniffer_Sniff's for this file.
prepareForOutput ( string $content ) : string	Prepares token content for output to screen.
process ( string | array $files, string | array $standards, array $restrictions = [], boolean $local = false ) : void	Start a PHP_CodeSniffer run.
processFile ( string $file, string $contents = null ) : PHP_CodeSniffer_File	Run the code sniffs over a single given file.
processFiles ( string | array $files, boolean $local = false ) : void	Processes the files/directories that PHP_CodeSniffer was constructed with.
processRuleset ( string $rulesetPath, integer $depth ) : array	Processes a single ruleset and returns a list of the sniffs it represents.
realpath ( string $path ) : mixed	CodeSniffer alternative for realpath.
registerSniffs ( array $files, array $restrictions, array $exclusions ) : void	Loads and stores sniffs objects used for sniffing files.
setAllowedFileExtensions ( array $extensions ) : void	Sets an array of file extensions that we will allow checking of.
setCli ( object $cli ) : void	Sets the internal CLI object.
setConfigData ( string $key, string | null $value, boolean $temp = false ) : boolean	Set a single config value.
setEncoding ( string $encoding ) : void	Sets the encoding.
setIgnorePatterns ( array $patterns ) : void	Sets an array of ignore patterns that we use to skip files and folders.
setInteractive ( boolean $interactive ) : void	Sets the interactive flag.
setSniffProperty ( string $listenerClass, string $name, string $value ) : void	Set a single property for a sniff.
setTabWidth ( integer $tabWidth ) : void	Sets the tab width.
setVerbosity ( integer $verbosity ) : void	Sets the verbosity level.
shouldIgnoreFile ( string $path, string $basedir ) : boolean	Checks filtering rules to see if a file should be ignored.
shouldProcessFile ( string $path, string $basedir ) : boolean	Checks filtering rules to see if a file should be checked.
suggestType ( string $varType ) : string	Returns a valid variable type for param/var tag.

Private Methods

Méthode	Description
_expandRulesetReference ( string $ref, string $rulesetDir, integer $depth ) : array	Expands a ruleset reference into a list of sniff files.
_expandSniffDirectory ( string $directory, integer $depth ) : array	Expands a directory into a list of sniff files within.
_processFile ( string $file, string $contents ) : PHP_CodeSniffer_File	Process the sniffs for a single file.
_processRule ( SimpleXMLElement $rule, integer $depth ) : void	Processes a rule from a ruleset XML file, overriding built-in defaults.
_shouldProcessElement ( SimpleXMLElement $element, integer $depth ) : boolean	Determine if an element should be processed or ignored.

Method Details

Property Details