PHP Class PHP_CodeSniffer_Tokenizers_JS, PHP_CodeSniffer

See link: http://pear.php.net/package/PHP_CodeSniffer

Author: Greg Sherwood ([email protected])

Datei anzeigen Open project: squizlabs/php_codesniffer Class Usage Examples

Public Properties

Property	Type	Description
$endScopeTokens	array	This array is just a unique collection of the end tokens from the _scopeOpeners array. The data is duplicated here to save time during parsing of the file.
$scopeOpeners	array	This array also contains information about what kind of token the scope opener uses to open and close the scope, if the token strictly requires an opener, if the token can share a scope closer, and who it can be shared with. An example of a token that shares a scope closer is a CASE scope.
$skipMinified	boolean	If TRUE, files that appear to be minified will not be processed.

Protected Properties

Property	Type	Description
$commentTokens	array	A list tokens that start and end comments.
$stringTokens	array	A list string delimiters.
$tokenValues	array	A list of special JS tokens and their types.

Public Methods

Method	Description
getRegexToken ( string $char, string $string, string $chars, string $tokens, string $eolChar ) : void	Tokenizes a regular expression if one is found.
processAdditional ( array &$tokens, string $eolChar ) : void	Performs additional processing after main tokenizing.
tokenizeString ( string $string, string $eolChar = '\n' ) : array	Creates an array of tokens when given some JS code.

Method Details

getRegexToken() public method

If a regular expression is not found, NULL is returned.

public getRegexToken ( string $char, string $string, string $chars, string $tokens, string $eolChar ) : void
$char	string	The index of the possible regex start character.
$string	string	The complete content of the string being tokenized.
$chars	string	An array of characters being tokenized.
$tokens	string	The current array of tokens found in the string.
$eolChar	string	The EOL character to use for splitting strings.
return	void

processAdditional() public method

This additional processing looks for properties, closures, labels and objects.

public processAdditional ( array &$tokens, string $eolChar ) : void
$tokens	array	The array of tokens to process.
$eolChar	string	The EOL character to use for splitting strings.
return	void

tokenizeString() public method

Creates an array of tokens when given some JS code.

public tokenizeString ( string $string, string $eolChar = '\n' ) : array
$string	string	The string to tokenize.
$eolChar	string	The EOL character to use for splitting strings.
return	array

Property Details

$commentTokens protected_oe property

A list tokens that start and end comments.

protected array $commentTokens
return	array

$endScopeTokens public_oe property

This array is just a unique collection of the end tokens from the _scopeOpeners array. The data is duplicated here to save time during parsing of the file.

public array $endScopeTokens
return	array

$scopeOpeners public_oe property

This array also contains information about what kind of token the scope opener uses to open and close the scope, if the token strictly requires an opener, if the token can share a scope closer, and who it can be shared with. An example of a token that shares a scope closer is a CASE scope.

public array $scopeOpeners
return	array

$skipMinified public_oe property

If TRUE, files that appear to be minified will not be processed.

public bool $skipMinified
return	boolean

$stringTokens protected_oe property

A list string delimiters.

protected array $stringTokens
return	array

$tokenValues protected_oe property

A list of special JS tokens and their types.

protected array $tokenValues
return	array