List of keywords used in phpdoc attributes.
Keyword | Value | Count |
---|---|---|
@author | Squiz Pty Ltd |
4 |
@copyright | 2010-2014 Squiz Pty Ltd (ABN 77 084 670 600) | 4 |
@link | https://pear.php.net/manual/en/developers.packagedef.intro.php#developers.packagedef.roles | 1 |
https://www.php.net/language.constants.predefined PHP Manual on magic constants | 1 | |
https://wiki.php.net/rfc/throw_expression} | 1 | |
@package | Vendor\Package | 1 |
Package | 4 | |
@param | string $fullpath Path to file. | 1 |
\PHP_CodeSniffer\Config $config Perfunctory Config. | 1 | |
string $path The path of the file to load. | 1 | |
string $class The name of the class to load. | 1 | |
array $classesBeforeLoad The classes/interfaces/traits before the file was included. | 1 | |
array $classesAfterLoad The classes/interfaces/traits after the file was included. | 1 | |
string $path The path to the directory to search. | 1 | |
string $nsPrefix The namespace prefix used by files under this path. | 1 | |
string $path The name of the file. | 1 | |
string $class The name of the class. | 1 | |
string $rulesetPath The path to a ruleset XML file. | 1 | |
int $depth How many nested processing steps we are in. This | 1 | |
string $directory The path to a directory. | 1 | |
int $depth How many nested processing steps we are in. This | 1 | |
string $ref The reference from the ruleset XML file. | 1 | |
string $rulesetDir The directory of the ruleset XML file, used to | 1 | |
int $depth How many nested processing steps we are in. This | 1 | |
\SimpleXMLElement $rule The rule object from a ruleset XML file. | 1 | |
string[] $newSniffs An array of sniffs that got included by this rule. | 1 | |
int $depth How many nested processing steps we are in. | 1 | |
\SimpleXMLElement $element An object from a ruleset XML file. | 1 | |
array $files Paths to the sniff files to register. | 1 | |
array $restrictions The sniff class names to restrict the allowed | 1 | |
array $exclusions The sniff class names to exclude from the | 1 | |
string $sniffClass The class name of the sniff. | 1 | |
string $name The name of the property to change. | 1 | |
array $settings Array with the new value of the property and the scope of the property being set. | 1 | |
string $name The name of the property. | 1 | |
mixed $value The value of the property. | 1 | |
array |
1 | |
array $cliArgs An array of values gathered from CLI args. | 1 | |
bool $dieOnUnknownArg Whether or not to kill the process when an | 1 | |
array $args An array of command line arguments to set. | 1 | |
string $path The path to the file to add. | 1 | |
bool $return If TRUE, the usage string is returned | 1 | |
string $key The name of the config value. | 1 | |
string $name The name of the executable utility. | 1 | |
string $key The name of the config value. | 1 | |
string|null $value The value to set. If null, the config | 1 | |
boolean $temp Set this config data temporarily for this | 1 | |
array $data The config data to print. | 1 | |
string $report The report type to print. | 1 | |
int $code The level of error raised. | 1 | |
string $message The error message. | 1 | |
string $file The path of the file that raised the error. | 1 | |
int $line The line number the error was raised at. | 1 | |
\PHP_CodeSniffer\Files\File $file The file to be processed. | 1 | |
array $childProcs An array of child processes to wait for. | 1 | |
\PHP_CodeSniffer\Files\File $file The file that was processed. | 1 | |
int $numFiles The total number of files to process. | 1 | |
int $numProcessed The number of files that have been processed, | 1 | |
string $command The command which was used to initiate the PHPCS run. | 1 | |
\PHP_CodeSniffer\Files\File $phpcsFile The file being fixed. | 1 | |
string $filePath Optional file path to diff the file against. | 1 | |
boolean $colors Print coloured output or not. | 1 | |
string $content The new content of the token. | 1 | |
int $start The first character to keep. | 1 | |
int $length The number of characters to keep. If NULL, the content of | 1 | |
int $start The position of the token in the token stack | 1 | |
int $end The position of the token in the token stack | 1 | |
int $change The number of spaces to adjust the indent by | 1 | |
\RecursiveIterator $iterator The iterator we are using to get file paths. | 1 | |
string $basedir The top-level path we are filtering. | 1 | |
\PHP_CodeSniffer\Config $config The config data for the run. | 1 | |
\PHP_CodeSniffer\Ruleset $ruleset The ruleset used for the run. | 1 | |
string $path The path to the file being checked. | 1 | |
string $path The path to the file or directory being checked. | 1 | |
string $char The index of the possible regex start character. | 1 | |
string $string The complete content of the string being tokenized. | 1 | |
string $chars An array of characters being tokenized. | 1 | |
string $tokens The current array of tokens found in the string. | 1 | |
string $content The content to tokenize, | 1 | |
\PHP_CodeSniffer\Config | null $config The config data for the run. | 1 | |
string $eolChar The EOL char used in the content. | 1 | |
string $content The content to tokenize. | 1 | |
string $eolChar The EOL char used in the content. | 1 | |
array $token The token to replace tabs inside. | 1 | |
string $prefix The character to use to represent the start of a tab. | 1 | |
string $padding The character to use to represent the end of a tab. | 1 | |
int $tabWidth The number of spaces each tab represents. | 1 | |
int $stackPtr The position in the stack of the token that | 1 | |
int $depth How many scope levels down we are. | 1 | |
int $ignore How many curly braces we are ignoring. | 1 | |
string $string The comment string being tokenized. | 1 | |
string $eolChar The EOL character to use for splitting strings. | 1 | |
int $start The position in the string to start processing. | 1 | |
int $end The position in the string to end processing. | 1 | |
string $string The string to tokenize. | 1 | |
string $eolChar The EOL character to use for splitting strings. | 1 | |
int $stackPtr The position of the first token in the file. | 1 | |
string $string The comment string being tokenized. | 1 | |
int $start The position in the string to start processing. | 1 | |
int $end The position in the string to end processing. | 1 | |
string|array $token The token to convert. | 1 | |
string $token The simple token to convert. | 1 | |
array $tokens The list of tokens to iterate searching the closing token (as returned by token_get_all) | 1 | |
int $start The starting position | 1 | |
string|string[] $openerTokens The opening character | 1 | |
string $closerChar The closing character | 1 | |
array $tokens The original array of tokens (as returned by token_get_all) | 1 | |
int $stackPtr The current position in token array | 1 | |
int|string $token The token to get the name for. | 1 | |
array |
1 | |
boolean $force If TRUE, prints the output even if it has | 1 | |
string $key The key of the data to get. If NULL, | 1 | |
string $key The key of the data to set. If NULL, | 1 | |
mixed $value The value to set. | 1 | |
string $path The path to the file. | 1 | |
string $path The path of the file. | 1 | |
string $basepath The base path to remove. This should not end | 1 | |
string $contents The contents to check. | 1 | |
string $cmd The path to the system command. | 1 | |
string $content The content to prepare. | 1 | |
string[] $exclude A list of characters to leave invisible. | 1 | |
string $string The string the verify. | 1 | |
boolean $classFormat If true, check to see if the string is in the | 1 | |
boolean $public If true, the first character in the string | 1 | |
boolean $strict If true, the string must not have two capital | 1 | |
string $string The string to verify. | 1 | |
string $varType The variable type to process. | 1 | |
string $content The file content. | 1 | |
string $path The absolute path to the file to process. | 1 | |
string $error The error message. | 1 | |
array $data Replacements for the error message. | 1 | |
int $severity The severity level for this error. A value of 0 | 1 | |
boolean $fixable Can the error be fixed by the sniff? | 1 | |
string $warning The error message. | 1 | |
array $data Replacements for the warning message. | 1 | |
int $severity The severity level for this warning. A value of 0 | 1 | |
boolean $fixable Can the warning be fixed by the sniff? | 1 | |
int $line The line on which the error occurred. | 1 | |
int $line The line on which the warning occurred. | 1 | |
int $severity The severity level for this warning. A value of 0 will | 1 | |
int $severity The severity level for this warning. A value of 0 | 1 | |
boolean $error Is this an error message? | 1 | |
string $message The text of the message. | 1 | |
int $line The line on which the message occurred. | 1 | |
int $column The column at which the message occurred. | 1 | |
array $data Replacements for the message. | 1 | |
int $severity The severity level for this message. A value of 0 | 1 | |
boolean $fixable Can the problem be fixed by the sniff? | 1 | |
int $stackPtr The stack position where the metric was recorded. | 1 | |
string $metric The name of the metric being recorded. | 1 | |
string $value The value of the metric being recorded. | 1 | |
int $stackPtr The position of the declaration token which | 1 | |
int $stackPtr The position in the stack of the function token | 1 | |
int $stackPtr The position in the stack of the function token to | 1 | |
int $stackPtr The position in the stack of the T_VARIABLE token to | 1 | |
int $stackPtr The position in the stack of the T_CLASS token to | 1 | |
int $stackPtr The position of the T_BITWISE_AND token. | 1 | |
int $start The position to start from in the token stack. | 1 | |
int $length The length of tokens to traverse from the start pos. | 1 | |
bool $origContent Whether the original content or the tab replaced | 1 | |
bool $exclude If true, find the previous token that is NOT of | 1 | |
bool $exclude If true, find the next token that is NOT of | 1 | |
bool $exclude If true, find the token that is NOT of | 1 | |
string $value The value that the token must be equal to. | 1 | |
int $stackPtr The position of the token we are checking. | 1 | |
int|string|array $types The type(s) of tokens to search for. | 1 | |
int $stackPtr The position of the token we are checking. | 1 | |
int|string $type The type of token to search for. | 1 | |
bool $first If TRUE, will return the matched condition | 1 | |
int $stackPtr The stack position of the class. | 1 | |
int $stackPtr The stack position of the class or enum token. | 1 | |
int $errorCount The number of errors found. | 1 | |
int $warningCount The number of warnings found. | 1 | |
int $fixableCount The number of fixable errors found. | 1 | |
int $fixedCount The number of errors that were fixed. | 1 | |
string $content The content of the file. | 1 | |
string $path The path to the file being added. | 1 | |
\PHP_CodeSniffer\Files\File $file The file being added. | 1 | |
string $path The absolute path to the file. | 1 | |
array $errors The list of errors to replay. | 1 | |
array $warnings The list of warnings to replay. | 1 | |
string[] $checkedFiles The files checked during the run. | 1 | |
int $totalErrors Total number of errors found during the run. | 1 | |
int $totalWarnings Total number of warnings found during the run. | 1 | |
string $msg Message to display. | 1 | |
string $name The camel caps name to convert. | 1 | |
int $stackPtr The position in the PHP_CodeSniffer | 1 | |
array $scopeTokens The type of scope the test wishes to listen to. | 1 | |
array $tokens The tokens that the test wishes to listen to | 1 | |
boolean $listenOutside If true this test will also alert the | 1 | |
int $currScope The position in the tokens array that | 1 | |
int $ptr The position of current token. | 1 | |
int $arrayEnd The token that ends the array definition. | 1 | |
boolean $ignoreComments If true, comments will be ignored. | 1 | |
array $pattern The parsed pattern to find the acquire the token | 1 | |
array $pattern The pattern to acquire the listener for. | 1 | |
int $stackPtr The position in the tokens stack | 1 | |
array $patternInfo Information about the pattern used | 1 | |
\PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where the | 1 | |
int $stackPtr The position in the tokens stack where | 1 | |
string $found The actual found string in the code. | 1 | |
string $patternCode The expected pattern code. | 1 | |
\PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where to | 1 | |
int $stackPtr The position in the tokens stack to | 1 | |
string $pattern The pattern to parse. | 1 | |
string $pattern The pattern being parsed. | 1 | |
string $from The token content that the skip pattern starts from. | 1 | |
string $str The tokens string that the pattern should match. | 1 | |
integer $stackPtr The position of the current token in the | 1 | |
int $indent The number of spaces code should be indented. | 1 | |
string $type The type of the token the brackets | 1 | |
int $commentStart Position in the stack where the comment started. | 1 | |
integer $stackPtr The position of the current token | 1 | |
integer $stackPtr The position where the token was found. | 1 | |
integer $currScope The current scope opener token. | 1 | |
array(integer=>array) $tokens Array with all code sniffer tokens. | 1 | |
array(string=>mixed) $token Current for loop token | 1 | |
\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. | 1 | |
int $typeDeclStart The position of the start of the type token. | 1 | |
int $typeDeclEnd The position of the end of the type token. | 1 | |
string $error Error message template. | 1 | |
string $errorCode The error code. | 1 | |
int $stackPtr The position of the type token. | 1 | |
string $type The type found. | 1 | |
string $error Error message template. | 1 | |
string $errorCode The error code. | 1 | |
int $stackPtr The position of the current token in the stack | 1 | |
string $content The expected content of the closing tag to match the opener. | 1 | |
\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. | 1 | |
array $tokens The token stack. | 1 | |
int $openTagPointer Stack pointer to the PHP open tag. | 1 | |
int $closeTagPointer Stack pointer to the PHP close tag. | 1 | |
bool $echo Whether to add 'echo' or not. | 1 | |
string $path The path to return Subversion properties on. | 1 | |
int $length The length of the new indent. | 1 | |
int $change The difference in length between | 1 | |
int $end The token where checking should end. | 1 | |
int $stackPtr The first token on the next line. | 1 | |
int $stackPtr The position of the current token in the | 1 | |
\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. | 1 | |
int $arrayToken The position of the array token. | 1 | |
int $stackPtr The position in the stack where the token | 1 | |
int $stackPtr The position of the forbidden style | 1 | |
string $style The name of the forbidden style. | 1 | |
array $tokens Token stack for this file | 1 | |
int $stackPtr The position where the namespace building will start. | 1 | |
int $stackPtr The position where the search for the | 1 | |
int $next The position of the next token to check. | 1 | |
int $end The position of the last token to check. | 1 | |
int $stackPtr The position of the operator in | 1 | |
mixed $before The number of spaces found before the | 1 | |
mixed $after The number of spaces found after the | 1 | |
string $type The type of the token the brackets | 1 | |
int $maxType The maxlength of the longest parameter type. | 1 | |
int $maxVar The maxlength of the longest parameter name. | 1 | |
integer $stackPtr The position of the current token in | 1 | |
int $start The token to start searching from. | 1 | |
int $end The token to search to. | 1 | |
array $headerLines Header information, as sourced | 1 | |
\SimpleXMLElement $tag The current XML tag to examine. | 2 | |
string $currentDirectory The complete relative path to the | 2 | |
\PHP_CodeSniffer\Config $config The config data for the run. | 2 | |
string $listener The listener to get patterns for. If NULL, all | 2 | |
\PHP_CodeSniffer\Files\File $phpcsFile The file that has been processed. | 2 | |
string $content The content to add. | 2 | |
string $content The content to tokenize, | 2 | |
\PHP_CodeSniffer\Config $config The config data for the run. | 2 | |
string $eolChar The EOL char used in the content. | 2 | |
string $path The path to use. | 2 | |
string $sniffClass The fully qualified sniff class name. | 2 | |
boolean $includeGeneric If true, the special "Generic" | 2 | |
string $standardsDir A specific directory to look for standards | 2 | |
string $standard The name of the coding standard. | 2 | |
int $stackPtr The stack position where the error occurred. | 2 | |
string $error The error message. | 2 | |
array $data Replacements for the error message. | 2 | |
int $severity The severity level for this error. A value of 0 | 2 | |
string $warning The error message. | 2 | |
array $data Replacements for the warning message. | 2 | |
int $stackPtr The stack position where the error occurred. | 2 | |
int|null $end The end position to fail if no token is found. | 2 | |
string|null $value The value that the token(s) must be equal to. | 2 | |
bool $local If true, tokens outside the current statement | 2 | |
int $start The position to start searching from in the token stack. | 2 | |
int|string|array $ignore Token types that should not be considered stop points. | 2 | |
\PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where the | 2 | |
int $stackPtr The position of the double quoted | 2 | |
int $stackPtr The position to start looking at. | 2 | |
int $end The position to stop looking at. | 2 | |
array $tokens The array of file tokens. | 2 | |
int $stackPtr The position in the tokens array of the | 2 | |
string $testFileBase The base path that the unit tests files will have. | 2 | |
int $stackPtr The position of the forbidden function | 2 | |
string $function The name of the forbidden function. | 2 | |
string $content The content of the HTML token. | 2 | |
string $start Partial string to use as a starting point for the snippet. | 2 | |
int $length The target length of the snippet to get. Defaults to 40. | 2 | |
array $tokens The token stack. | 2 | |
int $openBracket The position of the open bracket | 2 | |
\PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where this token was found. | 2 | |
array $param The parameter to be checked. | 2 | |
int $spacing The number of spaces to add after the type. | 2 | |
string $name The name of the property. | 3 | |
string $arg The command line argument. | 3 | |
int $pos The position of the argument on the command line. | 3 | |
int $stackPtr The position of the token in the token stack. | 3 | |
string $code A violation code unique to the sniff message. | 3 | |
int|string|array $types The type(s) of tokens to search for. | 3 | |
int $start The position to start searching from in the | 3 | |
\DOMNode $node The DOMNode object for the text block. | 3 | |
\DOMNode $node The DOMNode object for the code comparison block. | 3 | |
int $stackPtr The position where the double quoted | 3 | |
\PHP_CodeSniffer\Files\File $phpcsFile The current file being processed. | 3 | |
int $currScope The position of the current scope. | 3 | |
string $pattern The pattern used for the match. | 3 | |
int $currScope A pointer to the start of the scope. | 3 | |
int $stackPtr The position of the current | 3 | |
string $string The string to tokenize. | 4 | |
string $code A violation code unique to the sniff message. | 4 | |
string $line Line to parse. | 4 | |
string $filename File to blame. | 4 | |
array $indices An array of token positions for the array keys, | 4 | |
int $currScope The current scope opener token. | 4 | |
int $stackPtr The position of the token in the token stack. | 5 | |
\PHP_CodeSniffer\Config $config The config data for the run. | 5 | |
\PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where this | 5 | |
array $tokens The stack of tokens that make up | 5 | |
\PHP_CodeSniffer\Ruleset $ruleset The ruleset used for the run. | 6 | |
\DOMNode $doc The DOMNode object for the sniff. | 6 | |
\PHP_CodeSniffer\Files\File $phpcsFile The current file being checked. | 6 | |
int $stackPtr The position of the current token | 6 | |
int $arrayStart The token that starts the array definition. | 6 | |
int $arrayEnd The token that ends the array definition. | 6 | |
int $stackPtr The position of the current token | 6 | |
\PHP_CodeSniffer\Files\File $phpcsFile The current file being scanned. | 6 | |
int $openBracket The position of the opening bracket | 7 | |
array $tokens The stack of tokens that make up | 7 | |
\PHP_CodeSniffer\Files\File $phpcsFile The file being processed. | 7 | |
int $stackPtr The position where this token was | 7 | |
int $commentStart The position in the stack where the comment started. | 7 | |
int $stackPtr The position in the stack where this | 8 | |
\PHP_CodeSniffer\Files\File $phpcsFile The current file being checked. | 8 | |
\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. | 8 | |
int $stackPtr The position of the current token | 8 | |
array $tags The tokens for these tags. | 8 | |
string $testFile The name of the file being tested. | 9 | |
\PHP_CodeSniffer\Config $config The config data for the test run. | 9 | |
\PHP_CodeSniffer\Files\File $phpcsFile All the tokens found in the document. | 9 | |
\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. | 10 | |
array $report Prepared report data. | 16 | |
\PHP_CodeSniffer\Files\File $phpcsFile The file being reported on. | 16 | |
bool $showSources Show sources? | 16 | |
int $width Maximum allowed line width. | 16 | |
string $cachedData Any partial report data that was returned from | 16 | |
int $totalFiles Total number of files processed during the run. | 16 | |
int $totalErrors Total number of errors found during the run. | 16 | |
int $totalWarnings Total number of warnings found during the run. | 16 | |
int $totalFixable Total number of problems that can be fixed. | 16 | |
bool $showSources Show sources? | 16 | |
int $width Maximum allowed line width. | 16 | |
bool $interactive Are we running in interactive mode? | 16 | |
bool $toScreen Is the report being printed to screen? | 16 | |
int $stackPtr The position where the token was found. | 18 | |
\PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found. | 26 | |
int $stackPtr The position in the stack where | 28 | |
\PHP_CodeSniffer\Files\File $phpcsFile The file where the token was found. | 29 | |
int $stackPtr The position of the current token in | 60 | |
int $stackPtr The position of the current token in the | 65 | |
string $testFile The name of the file being tested. | 86 | |
int $stackPtr The position of the current token | 97 | |
\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. | 227 | |
@property | string[] $files The files and directories to check. | 1 |
string[] $standards The standards being used for checking. | 1 | |
int $verbosity How verbose the output should be. | 1 | |
bool $interactive Enable interactive checking mode. | 1 | |
bool $parallel Check files in parallel. | 1 | |
bool $cache Enable the use of the file cache. | 1 | |
bool $cacheFile A file where the cache data should be written | 1 | |
bool $colors Display colours in output. | 1 | |
bool $explain Explain the coding standards. | 1 | |
bool $local Process local files in directories only (no recursion). | 1 | |
bool $showSources Show sniff source codes in report output. | 1 | |
bool $showProgress Show basic progress information while running. | 1 | |
bool $quiet Quiet mode; disables progress and verbose output. | 1 | |
bool $annotations Process phpcs: annotations. | 1 | |
int $tabWidth How many spaces each tab is worth. | 1 | |
string $encoding The encoding of the files being checked. | 1 | |
string[] $sniffs The sniffs that should be used for checking. | 1 | |
string[] $exclude The sniffs that should be excluded from checking. | 1 | |
string[] $ignored Regular expressions used to ignore files and folders during checking. | 1 | |
string $reportFile A file where the report output should be written. | 1 | |
string $generator The documentation generator to use. | 1 | |
string $filter The filter to use for the run. | 1 | |
string[] $bootstrap One of more files to include before the run begins. | 1 | |
int $reportWidth The maximum number of columns that reports should use for output. | 1 | |
int $errorSeverity The minimum severity an error must have to be displayed. | 1 | |
int $warningSeverity The minimum severity a warning must have to be displayed. | 1 | |
bool $recordErrors Record the content of error messages as well as error counts. | 1 | |
string $suffix A suffix to add to fixed files. | 1 | |
string $basepath A file system location to strip from the paths of files shown in reports. | 1 | |
bool $stdin Read content from STDIN instead of supplied files. | 1 | |
string $stdinContent Content passed directly to PHPCS on STDIN. | 1 | |
string $stdinPath The path to use for content passed on STDIN. | 1 | |
array |
1 | |
array |
1 | |
string[] $unknown Any arguments gathered on the command line that are unknown to us. | 1 | |
@return | bool True if the info in the "phprelease" tags is valid. False otherwise. | 1 |
array |
1 | |
string|void | 1 | |
int The number of errors and warnings found. | 1 | |
bool If a change was reverted. | 1 | |
array |
1 | |
int The position in the stack that closed the scope. | 1 | |
array|null | 1 | |
array The new token. | 1 | |
array The new token in array format. | 1 | |
int|null The position of the closing token, if found. NULL otherwise. | 1 | |
array|null The array of parsed attribute tokens | 1 | |
int|false The highest weighted token. | 1 | |
string|null The name of the class, interface, trait, or function; | 1 | |
string The token contents. | 1 | |
string|false | 1 | |
array|false | 1 | |
\PHP_CodeSniffer\Files\File | 1 | |
integer | 1 | |
string Error message or NULL if no error/warning found. | 1 | |
string Shell command with common parameters. | 1 | |
mixed[] | 1 | |
int The position in the pattern that this test should register | 1 | |
string The error message. | 1 | |
array The parsed pattern array. | 1 | |
string[] List of all found incrementer variables. | 1 | |
int|false Pointer to the position in the stack for the closing tag or false if not found. | 1 | |
int|void Integer stack pointer to skip forward or void to continue | 1 | |
boolean TRUE if the docblock contains only {@inheritdoc} (case-insensitive). | 1 | |
string The fully qualified name of the class in the loaded file. | 2 | |
\RecursiveIterator | 2 | |
array The pattern step. | 2 | |
boolean true if there was no error, false otherwise. | 2 | |
array |
3 | |
string|null | 3 | |
int|null | 3 | |
mixed | 4 | |
mixed string or false if impossible to recover. | 4 | |
array(int => int) | 4 | |
string[] | 5 | |
bool If the change was accepted. | 6 | |
int|false | 6 | |
void|int Optionally returns a stack pointer. The sniff will not be | 10 | |
boolean | 20 | |
string | 24 | |
int | 26 | |
bool | 34 | |
int[] | 48 | |
array | 216 | |
void | 436 | |
array |
491 | |
@see | standardiseToken() | 1 |
getErrors() | 1 | |
getWarnings() | 1 | |
setConfigData() | 1 | |
getAllConfigData() | 1 | |
recurseScopeMap() | 1 | |
getInstalledStandardPaths() | 1 | |
isInstalledStandard() | 1 | |
getInstalledStandards() | 1 | |
findNext() | 1 | |
findPrevious() | 1 | |
Tokens.php | 1 | |
__constructor() | 1 | |
processTokenWithinScope() | 1 | |
process() | 1 | |
register() | 1 | |
getMetrics() | 2 | |
registerSupplementary() | 2 | |
processSupplementary() | 2 | |
generate() | 2 | |
createSkipPattern() | 2 | |
createTokenPattern() | 2 | |
parse() | 2 | |
getConfigData() | 3 | |
processSniff() | 3 | |
@subpackage | Subpackage | 4 |
@throws | \PHP_CodeSniffer\Exceptions\RuntimeException When tokenizer errors are encountered. | 1 |
\Exception If the file path has not been loaded. | 1 | |
\Exception If the class name has not been loaded | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If no sniffs were registered. | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException - If the ruleset path is invalid. | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If the reference is invalid. | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If rule settings are invalid. | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If sniff registration fails. | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException When attempting to set a non-existent property on a sniff | 1 | |
\PHP_CodeSniffer\Exceptions\DeepExitException If the config file can not be written. | 1 | |
\PHP_CodeSniffer\Exceptions\DeepExitException If the config file could not be read. | 1 | |
\PHP_CodeSniffer\Exceptions\DeepExitException If a custom report class could not be found. | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If a report class is incorrectly set up. | 1 | |
\PHP_CodeSniffer\Exceptions\DeepExitException If the requirements are not met. | 1 | |
\PHP_CodeSniffer\Exceptions\DeepExitException If a referenced standard is not installed. | 1 | |
\PHP_CodeSniffer\Exceptions\TokenizerException If the nesting level gets too deep. | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If the specified token is not of type | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If the specified $stackPtr is not of | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If the specified position does not exist. | 1 | |
\PHP_CodeSniffer\Exceptions\DeepExitException If the specified filter could not be found. | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If the specified tokens arrays are empty | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If we could not determine a token to listen for. | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If ZendCodeAnalyzer could not be run. | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If Subversion properties file could | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If Javascript Lint ran into trouble. | 1 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If the setting name is invalid. | 2 | |
\PHP_CodeSniffer\Exceptions\RuntimeException | 2 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If jshint.js could not be run | 2 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If jslint.js could not be run | 2 | |
\PHP_CodeSniffer\Exceptions\TokenizerException If the file appears to be minified. | 3 | |
\PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a | 3 | |
\PHP_CodeSniffer\Exceptions\DeepExitException | 10 | |
@var | int | 1 |
\Composer\Autoload\ClassLoader | 1 | |
\SimpleXMLElement | 1 | |
array |
1 | |
array |
1 | |
array |
1 | |
array |
1 | |
\PHP_CodeSniffer\Reporter | 1 | |
\PHP_CodeSniffer\Files\File | 1 | |
array |
1 | |
array |
1 | |
void | 1 | |
\PHP_CodeSniffer\Fixer | 1 | |
\PHP_CodeSniffer\Tokenizers\Tokenizer | 1 | |
\PHP_CodeSniffer\Sniffs\Sniff[] | 1 | |
array |
1 | |
string|null Path to eslintrc. Null to autodetect. | 1 | |
array|null | 1 | |
integer[] | 1 | |
\PHP_CodeSniffer\Standards\Squiz\Sniffs\Functions\MultiLineFunctionDeclarationSniff | 1 | |
\PHP_CodeSniffer\Standards\Generic\Sniffs\Functions\FunctionCallArgumentSpacingSniff | 1 | |
string|null | 1 | |
float | 2 | |
array |
2 | |
array |
3 | |
array |
3 | |
array |
4 | |
\PHP_CodeSniffer\Ruleset | 5 | |
array |
6 | |
int[] | 6 | |
\PHP_CodeSniffer\Config | 7 | |
string[] | 11 | |
array |
23 | |
string | 26 | |
boolean | 47 | |
integer | 68 | |
array | 139 |