Element index for package PHP_CodeSniffer

[ a ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ v ] [ w ] [ _ ]

_

__construct: in file PairElement.php, method PHP_CodeSniffer_CommentParser_PairElement::__construct()
Constructs a PHP_CodeSniffer_CommentParser_PairElement doc tag.
__construct: in file FunctionCommentParser.php, method PHP_CodeSniffer_CommentParser_FunctionCommentParser::__construct()
Constructs a PHP_CodeSniffer_CommentParser_FunctionCommentParser.
__construct: in file ParameterElement.php, method PHP_CodeSniffer_CommentParser_ParameterElement::__construct()
Constructs a PHP_CodeSniffer_CommentParser_ParameterElement.
__construct: in file ParserException.php, method PHP_CodeSniffer_CommentParser_ParserException::__construct()
Constructs a DocCommentParserException.
__construct: in file ValidFunctionNameSniff.php, method PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff::__construct()
Constructs a PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff.
__construct: in file SingleElement.php, method PHP_CodeSniffer_CommentParser_SingleElement::__construct()
Constructs a SingleElement doc tag.
__construct: in file File.php, method PHP_CodeSniffer_File::__construct()
Constructs a PHP_CodeSniffer_File.
__construct: in file ControlSignatureSniff.php, method PEAR_Sniffs_ControlStructures_ControlSignatureSniff::__construct()
Constructs a PEAR_Sniffs_ControlStructures_ControlSignatureSniff.
__construct: in file AbstractPatternSniff.php, method PHP_CodeSniffer_Standards_AbstractPatternSniff::__construct()
Constructs a PHP_CodeSniffer_Standards_AbstractPatternSniff.
__construct: in file AbstractParser.php, method PHP_CodeSniffer_CommentParser_AbstractParser::__construct()
Constructs a Doc Comment Parser.
__construct: in file AbstractScopeSniff.php, method PHP_CodeSniffer_Standards_AbstractScopeSniff::__construct()
Constructs a new AbstractScopeTest.
__construct: in file AbstractVariableSniff.php, method PHP_CodeSniffer_Standards_AbstractVariableSniff::__construct()
Constructs an AbstractVariableTest.
__construct: in file CommentElement.php, method PHP_CodeSniffer_CommentParser_CommentElement::__construct()
Constructs a PHP_CodeSniffer_CommentParser_CommentElement.
__construct: in file CodeSniffer.php, method PHP_CodeSniffer::__construct()
Constructs a PHP_CodeSniffer object.
__construct: in file AbstractDocElement.php, method PHP_CodeSniffer_CommentParser_AbstractDocElement::__construct()
Constructs a Doc Element.

top

a

$afterWhitespace: in file AbstractDocElement.php, variable PHP_CodeSniffer_CommentParser_AbstractDocElement::$afterWhitespace
The whitespace the occurs after this element and its sub elements.
$assignmentTokens: in file Tokens.php, variable PHP_CodeSniffer_Tokens::$assignmentTokens
Tokens that represent assignments.
addError: in file File.php, method PHP_CodeSniffer_File::addError()
Adds an error to the error stack.
addTokenListener: in file File.php, method PHP_CodeSniffer_File::addTokenListener()
Adds a listener to the token stack that listens to the specific tokens.
addWarning: in file File.php, method PHP_CodeSniffer_File::addWarning()
Adds an warning to the warning stack.
alignsWith: in file ParameterElement.php, method PHP_CodeSniffer_CommentParser_ParameterElement::alignsWith()
Returns true if this parameter aligns with the other parameter.
AbstractDocElement.php: procedural page AbstractDocElement.php
AbstractParser.php: procedural page AbstractParser.php
AbstractPatternSniff.php: procedural page AbstractPatternSniff.php
AbstractScopeSniff.php: procedural page AbstractScopeSniff.php
AbstractVariableSniff.php: procedural page AbstractVariableSniff.php

top

c

$comment: in file AbstractParser.php, variable PHP_CodeSniffer_CommentParser_AbstractParser::$comment
The comment element that appears in the doc comment.
$commentTokens: in file Tokens.php, variable PHP_CodeSniffer_Tokens::$commentTokens
Tokens that are comments.
$content: in file SingleElement.php, variable PHP_CodeSniffer_CommentParser_SingleElement::$content
The content that exists after the tag.
$contentWhitespace: in file SingleElement.php, variable PHP_CodeSniffer_CommentParser_SingleElement::$contentWhitespace
The whitespace that exists before the content.
$currScope: in file AbstractScopeSniff.php, variable PHP_CodeSniffer_Standards_AbstractScopeSniff::$currScope
The position in the tokens array that opened the current scope.
ClassCommentParser.php: procedural page ClassCommentParser.php
CommentElement.php: procedural page CommentElement.php
ControlSignatureSniff.php: procedural page ControlSignatureSniff.php
CodeSniffer.php: procedural page CodeSniffer.php

top

d

$deprecated: in file AbstractParser.php, variable PHP_CodeSniffer_CommentParser_AbstractParser::$deprecated
A list of see elements that appear in this doc comment.
DocElement.php: procedural page DocElement.php

top

e

$emptyTokens: in file Tokens.php, variable PHP_CodeSniffer_Tokens::$emptyTokens
Tokens that don't represent code.
ERROR: in file File.php, class constant PHP_CodeSniffer_File::ERROR
A constant to represent an error in PHP_CodeSniffer.
Exception.php: procedural page Exception.php

top

f

findNext: in file File.php, method PHP_CodeSniffer_File::findNext()
Returns the position of the next specified token(s).
findPrevious: in file File.php, method PHP_CodeSniffer_File::findPrevious()
Returns the position of the next specified token(s).
FunctionCommentParser.php: procedural page FunctionCommentParser.php
File.php: procedural page File.php
FunctionCallSignatureSniff.php: procedural page FunctionCallSignatureSniff.php

top

g

getAllowedTags: in file FunctionCommentParser.php, method PHP_CodeSniffer_CommentParser_FunctionCommentParser::getAllowedTags()
Returns the allowed tags that can exist in a function comment.
getAllowedTags: in file ClassCommentParser.php, method PHP_CodeSniffer_CommentParser_ClassCommentParser::getAllowedTags()
Returns the allowed tags withing a class comment.
getAllowedTags: in file AbstractParser.php, method PHP_CodeSniffer_CommentParser_AbstractParser::getAllowedTags()
Returns a list of tags that this comment parser allows for it's comment.
getAllowedTags: in file MemberCommentParser.php, method PHP_CodeSniffer_CommentParser_MemberCommentParser::getAllowedTags()
Returns the allowed tags for this parser.
getAuthors: in file ClassCommentParser.php, method PHP_CodeSniffer_CommentParser_ClassCommentParser::getAuthors()
Returns the authors of this class comment.
getBodyComment: in file CommentElement.php, method PHP_CodeSniffer_CommentParser_CommentElement::getBodyComment()
Returns the body comment.
getCategory: in file ClassCommentParser.php, method PHP_CodeSniffer_CommentParser_ClassCommentParser::getCategory()
Returns the category of this class comment.
getComment: in file PairElement.php, method PHP_CodeSniffer_CommentParser_PairElement::getComment()
Returns the comment associated with the value of this tag.
getComment: in file AbstractParser.php, method PHP_CodeSniffer_CommentParser_AbstractParser::getComment()
Returns the comment element that appears at the top of this doc comment.
getComment: in file ParameterElement.php, method PHP_CodeSniffer_CommentParser_ParameterElement::getComment()
Returns the comment of this comment for this parameter.
getContent: in file SingleElement.php, method PHP_CodeSniffer_CommentParser_SingleElement::getContent()
Returns the content of this tag.
getCopyright: in file ClassCommentParser.php, method PHP_CodeSniffer_CommentParser_ClassCommentParser::getCopyright()
Returns the copyright of this class comment.
getDeclarationName: in file File.php, method PHP_CodeSniffer_File::getDeclarationName()
Returns the declaration names for T_CLASS, T_INTERFACE and T_FUNCTION tokens.
getDeprecated: in file AbstractParser.php, method PHP_CodeSniffer_CommentParser_AbstractParser::getDeprecated()
Returns the deprecated element found in this comment.
getErrorCount: in file File.php, method PHP_CodeSniffer_File::getErrorCount()
Returns the number of errors raised.
getErrors: in file File.php, method PHP_CodeSniffer_File::getErrors()
Returns the errors raised from processing this file.
getFilename: in file File.php, method PHP_CodeSniffer_File::getFilename()
Returns the absolute filename of this file.
getFiles: in file CodeSniffer.php, method PHP_CodeSniffer::getFiles()
Returns the PHP_CodeSniffer file objects.
getHeadlineComment: in file CommentElement.php, method PHP_CodeSniffer_CommentParser_CommentElement::getHeadlineComment()
Returns the headline comment.
getHighestWeightedToken: in file Tokens.php, method PHP_CodeSniffer_Tokens::getHighestWeightedToken()
Returns the highest weighted token type.
getInstalledStandards: in file CodeSniffer.php, method PHP_CodeSniffer::getInstalledStandards()
Get a list of all coding standards installed.
getLicense: in file ClassCommentParser.php, method PHP_CodeSniffer_CommentParser_ClassCommentParser::getLicense()
Returns the license of this class comment.
getLine: in file AbstractDocElement.php, method PHP_CodeSniffer_CommentParser_AbstractDocElement::getLine()
Returns the line in which this element first occured.
getLine: in file AbstractParser.php, method PHP_CodeSniffer_CommentParser_AbstractParser::getLine()
Returns the line that the token exists on in the doc comment.
getLine: in file DocElement.php, method PHP_CodeSniffer_CommentParser_DocElement::getLine()
Returns the line that this element started on.
getLineWithinComment: in file ParserException.php, method PHP_CodeSniffer_CommentParser_ParserException::getLineWithinComment()
Returns the line number within the comment where the exception occured.
getLinks: in file AbstractParser.php, method PHP_CodeSniffer_CommentParser_AbstractParser::getLinks()
Returns the link elements found in this comment.
getMemberProperties: in file File.php, method PHP_CodeSniffer_File::getMemberProperties()
Returns the visibility and implementation properies of the class member variable found at the specified position in the stack.
getMethodParameters: in file File.php, method PHP_CodeSniffer_File::getMethodParameters()
Returns the method parameters for the specified T_FUNCTION token.
getMethodProperties: in file File.php, method PHP_CodeSniffer_File::getMethodProperties()
Returns the visibility and implementation properies of the method found at the specified position in the stack.
getNextElement: in file DocElement.php, method PHP_CodeSniffer_CommentParser_DocElement::getNextElement()
Returns the element that appears after this element.
getNextElement: in file AbstractDocElement.php, method PHP_CodeSniffer_CommentParser_AbstractDocElement::getNextElement()
Returns the element that exists after this.
getOrder: in file AbstractDocElement.php, method PHP_CodeSniffer_CommentParser_AbstractDocElement::getOrder()
Returns the order that this element appears in the comment.
getOrder: in file DocElement.php, method PHP_CodeSniffer_CommentParser_DocElement::getOrder()
Returns the order that this element appears in the doc comment.
getPackage: in file ClassCommentParser.php, method PHP_CodeSniffer_CommentParser_ClassCommentParser::getPackage()
Returns the package that this class belongs to.
getParams: in file FunctionCommentParser.php, method PHP_CodeSniffer_CommentParser_FunctionCommentParser::getParams()
Returns the parameter elements that this function comment contains.
getPatterns: in file ControlSignatureSniff.php, method PEAR_Sniffs_ControlStructures_ControlSignatureSniff::getPatterns()
Returns the patterns that this test wishes to verify.
getPatterns: in file AbstractPatternSniff.php, method PHP_CodeSniffer_Standards_AbstractPatternSniff::getPatterns()
Returns the patterns that should be checked.
getPosition: in file ParameterElement.php, method PHP_CodeSniffer_CommentParser_ParameterElement::getPosition()
Returns the postition of this parameter are it appears in the comment.
getPreviousElement: in file AbstractDocElement.php, method PHP_CodeSniffer_CommentParser_AbstractDocElement::getPreviousElement()
Returns the element that exists before this.
getPreviousElement: in file DocElement.php, method PHP_CodeSniffer_CommentParser_DocElement::getPreviousElement()
Returns the element that appears before this element.
getRawContent: in file AbstractDocElement.php, method PHP_CodeSniffer_CommentParser_AbstractDocElement::getRawContent()
Returns the raw content of this element, ommiting the tag.
getRawContent: in file DocElement.php, method PHP_CodeSniffer_CommentParser_DocElement::getRawContent()
Returns the raw content of this element, ommiting the tag.
getReturn: in file FunctionCommentParser.php, method PHP_CodeSniffer_CommentParser_FunctionCommentParser::getReturn()
Returns the return element in this fucntion comment.
getSees: in file AbstractParser.php, method PHP_CodeSniffer_CommentParser_AbstractParser::getSees()
Returns the see elements that appear in this doc comment.
getSince: in file AbstractParser.php, method PHP_CodeSniffer_CommentParser_AbstractParser::getSince()
Returns the since element found in this comment.
getSubElements: in file PairElement.php, method PHP_CodeSniffer_CommentParser_PairElement::getSubElements()
Returns the element names that this tag is comprised of, in the order that they appear in the tag.
getSubElements: in file AbstractDocElement.php, method PHP_CodeSniffer_CommentParser_AbstractDocElement::getSubElements()
Returns the sub element names that make up this element in the order they appear in the element.
getSubElements: in file SingleElement.php, method PHP_CodeSniffer_CommentParser_SingleElement::getSubElements()
Returns the element names that this tag is comprised of, in the order that they appear in the tag.
getSubElements: in file ParameterElement.php, method PHP_CodeSniffer_CommentParser_ParameterElement::getSubElements()
Returns the element names that this tag is comprised of, in the order that they appear in the tag.
getTag: in file DocElement.php, method PHP_CodeSniffer_CommentParser_DocElement::getTag()
Returns the name of the tag that this element represents, omitting the @ symbol.
getTag: in file AbstractDocElement.php, method PHP_CodeSniffer_CommentParser_AbstractDocElement::getTag()
Returns the tag that this element represents, ommiting the @ symbol.
getThrows: in file FunctionCommentParser.php, method PHP_CodeSniffer_CommentParser_FunctionCommentParser::getThrows()
Returns the throws elements in this fucntion comment.
getTokens: in file File.php, method PHP_CodeSniffer_File::getTokens()
Returns the token stack for this file.
getTokensAsString: in file File.php, method PHP_CodeSniffer_File::getTokensAsString()
Returns the content of the tokens from the specified start position in the token stack for the specified legnth.
getType: in file ParameterElement.php, method PHP_CodeSniffer_CommentParser_ParameterElement::getType()
Returns the variable type that this string represents.
getValidScopeOpeners: in file File.php, method PHP_CodeSniffer_File::getValidScopeOpeners()
Returns the token types that are allowed to open scopes.
getValue: in file PairElement.php, method PHP_CodeSniffer_CommentParser_PairElement::getValue()
Returns the value of the tag.
getVar: in file MemberCommentParser.php, method PHP_CodeSniffer_CommentParser_MemberCommentParser::getVar()
Returns the var tag found in the member comment.
getVarName: in file ParameterElement.php, method PHP_CodeSniffer_CommentParser_ParameterElement::getVarName()
Returns the variable name that this parameter tag represents.
getVersion: in file ClassCommentParser.php, method PHP_CodeSniffer_CommentParser_ClassCommentParser::getVersion()
Returns the version of this class comment.
getWarningCount: in file File.php, method PHP_CodeSniffer_File::getWarningCount()
Returns the number of warnings raised.
getWarnings: in file File.php, method PHP_CodeSniffer_File::getWarnings()
Returns the warnings raised from processing this file.
getWhitespaceAfter: in file AbstractDocElement.php, method PHP_CodeSniffer_CommentParser_AbstractDocElement::getWhitespaceAfter()
Returns the whitespace that exists after this element.
getWhitespaceAfter: in file DocElement.php, method PHP_CodeSniffer_CommentParser_DocElement::getWhitespaceAfter()
Returns the whitespace that exists after this element.
getWhitespaceAfterHeadline: in file CommentElement.php, method PHP_CodeSniffer_CommentParser_CommentElement::getWhitespaceAfterHeadline()
Returns the whitespace that exists between the headline and the comment.
getWhitespaceBefore: in file DocElement.php, method PHP_CodeSniffer_CommentParser_DocElement::getWhitespaceBefore()
Returns the whitespace that exists before this element.
getWhitespaceBefore: in file AbstractDocElement.php, method PHP_CodeSniffer_CommentParser_AbstractDocElement::getWhitespaceBefore()
Returns the whitespace that exists before this element.
getWhiteSpaceBeforeComment: in file ParameterElement.php, method PHP_CodeSniffer_CommentParser_ParameterElement::getWhiteSpaceBeforeComment()
Returns the whitespace before the comment.
getWhitespaceBeforeContent: in file SingleElement.php, method PHP_CodeSniffer_CommentParser_SingleElement::getWhitespaceBeforeContent()
Returns the witespace before the content of this tag.
getWhiteSpaceBeforeType: in file ParameterElement.php, method PHP_CodeSniffer_CommentParser_ParameterElement::getWhiteSpaceBeforeType()
Returns the whitespace before the variable type.
getWhiteSpaceBeforeVarName: in file ParameterElement.php, method PHP_CodeSniffer_CommentParser_ParameterElement::getWhiteSpaceBeforeVarName()
Returns the whitespace before the variable name.

top

h

hasCondition: in file File.php, method PHP_CodeSniffer_File::hasCondition()
Determine if the passed token has a condition of one of the passed types.

top

i

isCamelCaps: in file CodeSniffer.php, method PHP_CodeSniffer::isCamelCaps()
Returns true if the specified string is in the camel caps format.
isEmpty: in file CommentElement.php, method PHP_CodeSniffer_CommentParser_CommentElement::isEmpty()
Returns true if there is no comment.
isInstalledStandard: in file CodeSniffer.php, method PHP_CodeSniffer::isInstalledStandard()
Determine if a standard is installed.
isReference: in file File.php, method PHP_CodeSniffer_File::isReference()
Determine if the passed token is a reference operator.
IncorrectPatternException.php: procedural page IncorrectPatternException.php
InlineCommentSniff.php: procedural page InlineCommentSniff.php
IncludingFileSniff.php: procedural page IncludingFileSniff.php

top

l

$links: in file AbstractParser.php, variable PHP_CodeSniffer_CommentParser_AbstractParser::$links
A list of see elements that appear in this doc comment.
LINE_LIMIT: in file LineLengthSniff.php, class constant PEAR_Sniffs_Files_LineLengthSniff::LINE_LIMIT
The limit that the length of a line should not exceed.
LineLengthSniff.php: procedural page LineLengthSniff.php
LowerCaseConstantSniff.php: procedural page LowerCaseConstantSniff.php

top

m

MemberCommentParser.php: procedural page MemberCommentParser.php
MethodCallArgumentSpacingSniff.php: procedural page MethodCallArgumentSpacingSniff.php
MultipleStatementSniff.php: procedural page MultipleStatementSniff.php

top

n

$nextElement: in file AbstractDocElement.php, variable PHP_CodeSniffer_CommentParser_AbstractDocElement::$nextElement
The element proceeding this element.

top

o

$operators: in file Tokens.php, variable PHP_CodeSniffer_Tokens::$operators
Tokens that perform operations.
OpeningMethodBraceSniff.php: procedural page OpeningMethodBraceSniff.php

top

p

$parenthesisOpeners: in file Tokens.php, variable PHP_CodeSniffer_Tokens::$parenthesisOpeners
Token types that open parethesis.
$previousElement: in file AbstractParser.php, variable PHP_CodeSniffer_CommentParser_AbstractParser::$previousElement
The previous doc element that was processed.
$previousElement: in file AbstractDocElement.php, variable PHP_CodeSniffer_CommentParser_AbstractDocElement::$previousElement
The element previous to this element.
parse: in file AbstractParser.php, method PHP_CodeSniffer_CommentParser_AbstractParser::parse()
Initiates the parsing of the doc comment.
parseAuthor: in file ClassCommentParser.php, method PHP_CodeSniffer_CommentParser_ClassCommentParser::parseAuthor()
Parses the author tag of this class comment.
parseCategory: in file ClassCommentParser.php, method PHP_CodeSniffer_CommentParser_ClassCommentParser::parseCategory()
Parses the category tag of this class comment.
parseComment: in file AbstractParser.php, method PHP_CodeSniffer_CommentParser_AbstractParser::parseComment()
Parses the comment element that appears at the top of the doc comment.
parseCopyright: in file ClassCommentParser.php, method PHP_CodeSniffer_CommentParser_ClassCommentParser::parseCopyright()
Parses the copyright tag of this class comment.
parseDeprecated: in file AbstractParser.php, method PHP_CodeSniffer_CommentParser_AbstractParser::parseDeprecated()
Parses \@deprecated tags.
parseLicense: in file ClassCommentParser.php, method PHP_CodeSniffer_CommentParser_ClassCommentParser::parseLicense()
Parses the license tag of this class comment.
parseLink: in file AbstractParser.php, method PHP_CodeSniffer_CommentParser_AbstractParser::parseLink()
Parses \@link tags.
parsePackage: in file ClassCommentParser.php, method PHP_CodeSniffer_CommentParser_ClassCommentParser::parsePackage()
Parses the package tag found in this test.
parseParam: in file FunctionCommentParser.php, method PHP_CodeSniffer_CommentParser_FunctionCommentParser::parseParam()
Parses parameter elements.
parseReturn: in file FunctionCommentParser.php, method PHP_CodeSniffer_CommentParser_FunctionCommentParser::parseReturn()
Parses return elements.
parseSee: in file AbstractParser.php, method PHP_CodeSniffer_CommentParser_AbstractParser::parseSee()
Parses see tag element within the doc comment.
parseSince: in file AbstractParser.php, method PHP_CodeSniffer_CommentParser_AbstractParser::parseSince()
Parses \@since tags.
parseTag: in file AbstractParser.php, method PHP_CodeSniffer_CommentParser_AbstractParser::parseTag()
Parses the specified tag.
parseThrows: in file FunctionCommentParser.php, method PHP_CodeSniffer_CommentParser_FunctionCommentParser::parseThrows()
Parses throws elements.
parseVar: in file MemberCommentParser.php, method PHP_CodeSniffer_CommentParser_MemberCommentParser::parseVar()
Parses Var tags.
parseVersion: in file ClassCommentParser.php, method PHP_CodeSniffer_CommentParser_ClassCommentParser::parseVersion()
Parses the version tag of this class comment.
PEAR_Sniffs_Commenting_InlineCommentSniff: in file InlineCommentSniff.php, class PEAR_Sniffs_Commenting_InlineCommentSniff
PHP_CodeSniffer_Sniffs_PEAR_Commenting_InlineCommentSniff.
PEAR_Sniffs_Constants_ValidConstantNameSniff: in file ValidConstantNameSniff.php, class PEAR_Sniffs_Constants_ValidConstantNameSniff
PHP_CodeSniffer_Sniffs_Squiz_Members_ValidConstantNameSniff.
PEAR_Sniffs_ControlStructures_ControlSignatureSniff: in file ControlSignatureSniff.php, class PEAR_Sniffs_ControlStructures_ControlSignatureSniff
Verifies that control statements conform to their coding standards.
PEAR_Sniffs_Files_IncludingFileSniff: in file IncludingFileSniff.php, class PEAR_Sniffs_Files_IncludingFileSniff
PEAR_Sniffs_Files_IncludingFileSniff.
PEAR_Sniffs_Files_LineLengthSniff: in file LineLengthSniff.php, class PEAR_Sniffs_Files_LineLengthSniff
PHP_CodeSniffer_Sniffs_PEAR_Files_LineLengthSniff.
PEAR_Sniffs_Methods_FunctionCallSignatureSniff: in file FunctionCallSignatureSniff.php, class PEAR_Sniffs_Methods_FunctionCallSignatureSniff
Verifies that control statements conform to their coding standards.
PEAR_Sniffs_Methods_MethodCallArgumentSpacingSniff: in file MethodCallArgumentSpacingSniff.php, class PEAR_Sniffs_Methods_MethodCallArgumentSpacingSniff
PEAR_Sniffs_Methods_MethodCallArgumentSpacingSniff.
PEAR_Sniffs_Methods_OpeningMethodBraceSniff: in file OpeningMethodBraceSniff.php, class PEAR_Sniffs_Methods_OpeningMethodBraceSniff
PEAR_Sniffs_Methods_OpeningMethodBraceSniff.
PEAR_Sniffs_Methods_ValidDefaultValueSniff: in file ValidDefaultValueSniff.php, class PEAR_Sniffs_Methods_ValidDefaultValueSniff
PEAR_Sniffs_Methods_ValidDefaultValueSniff.
PEAR_Sniffs_Misc_ShortOpenTagSniff: in file ShortOpenTagSniff.php, class PEAR_Sniffs_Misc_ShortOpenTagSniff
PEAR_Sniffs_Misc_ShortOpenTagSniff.
PEAR_Sniffs_NamingConventions_ValidClassNameSniff: in file ValidClassNameSniff.php, class PEAR_Sniffs_NamingConventions_ValidClassNameSniff
PEAR_Sniffs_NamingConventions_ValidClassNameSniff.
PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff: in file ValidFunctionNameSniff.php, class PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff
PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff.
PEAR_Sniffs_PHP_LowerCaseConstantSniff: in file LowerCaseConstantSniff.php, class PEAR_Sniffs_PHP_LowerCaseConstantSniff
PEAR_Sniffs_PHP_LowerCaseConstantSniff.
PEAR_Sniffs_Statements_MultipleStatementSniff: in file MultipleStatementSniff.php, class PEAR_Sniffs_Statements_MultipleStatementSniff
PHP_CodeSniffer_Sniffs_PEAR_Statements_MultipleStatementSniff.
PEAR_Sniffs_Whitespace_ScopeClosingBraceSniff: in file ScopeClosingBraceSniff.php, class PEAR_Sniffs_Whitespace_ScopeClosingBraceSniff
PEAR_Sniffs_Whitespace_ScopeClosingBraceSniff.
PEAR_Sniffs_Whitespace_ScopeIndentSniff: in file ScopeIndentSniff.php, class PEAR_Sniffs_Whitespace_ScopeIndentSniff
PEAR_Sniffs_Whitespace_ScopeIndentSniff.
PHP_CodeSniffer: in file CodeSniffer.php, class PHP_CodeSniffer
PHP_CodeSniffer provides functionality to verify that code conforms to certain standards.
PairElement.php: procedural page PairElement.php
ParameterElement.php: procedural page ParameterElement.php
ParserException.php: procedural page ParserException.php
PHP_CodeSniffer_CommentParser_AbstractDocElement: in file AbstractDocElement.php, class PHP_CodeSniffer_CommentParser_AbstractDocElement
A class to handle most of the parsing operations of a doc comment element.
PHP_CodeSniffer_CommentParser_AbstractParser: in file AbstractParser.php, class PHP_CodeSniffer_CommentParser_AbstractParser
Parses doc comments.
PHP_CodeSniffer_CommentParser_ClassCommentParser: in file ClassCommentParser.php, class PHP_CodeSniffer_CommentParser_ClassCommentParser
Parses Class doc comments.
PHP_CodeSniffer_CommentParser_CommentElement: in file CommentElement.php, class PHP_CodeSniffer_CommentParser_CommentElement
A class to represent Comments of a doc comment.
PHP_CodeSniffer_CommentParser_DocElement: in file DocElement.php, class PHP_CodeSniffer_CommentParser_DocElement
A DocElement represents a logical element within a Doc Comment.
PHP_CodeSniffer_CommentParser_FunctionCommentParser: in file FunctionCommentParser.php, class PHP_CodeSniffer_CommentParser_FunctionCommentParser
Parses function doc comments.
PHP_CodeSniffer_CommentParser_MemberCommentParser: in file MemberCommentParser.php, class PHP_CodeSniffer_CommentParser_MemberCommentParser
Parses class member comments.
PHP_CodeSniffer_CommentParser_PairElement: in file PairElement.php, class PHP_CodeSniffer_CommentParser_PairElement
A class to represent elements that have a value => comment format.
PHP_CodeSniffer_CommentParser_ParameterElement: in file ParameterElement.php, class PHP_CodeSniffer_CommentParser_ParameterElement
A class to represent param tags within a function comment.
PHP_CodeSniffer_CommentParser_ParserException: in file ParserException.php, class PHP_CodeSniffer_CommentParser_ParserException
An exception to be thrown when a DocCommentParser finds an anomilty in a doc comment.
PHP_CodeSniffer_CommentParser_SingleElement: in file SingleElement.php, class PHP_CodeSniffer_CommentParser_SingleElement
A class to represent single element doc tags.
PHP_CodeSniffer_Exception: in file Exception.php, class PHP_CodeSniffer_Exception
An exception thrown by PHP_CodeSniffer when it encounters an unrecoverable error.
PHP_CodeSniffer_File: in file File.php, class PHP_CodeSniffer_File
A PHP_CodeSniffer_File object represents a PHP source file and the tokens associated with it.
PHP_CodeSniffer_Sniff: in file Sniff.php, class PHP_CodeSniffer_Sniff
Represents a PHP_CodeSniffer sniff for sniffing coding standards.
PHP_CodeSniffer_Sniff_Exception: in file SniffException.php, class PHP_CodeSniffer_Sniff_Exception
An exception that a test should throw if they encounter an unrecoverable error.
PHP_CodeSniffer_Standards_AbstractPatternSniff: in file AbstractPatternSniff.php, class PHP_CodeSniffer_Standards_AbstractPatternSniff
Processes pattern strings and checks that the code conforms to the pattern.
PHP_CodeSniffer_Standards_AbstractScopeSniff: in file AbstractScopeSniff.php, class PHP_CodeSniffer_Standards_AbstractScopeSniff
An AbstractScopeTest allows for tests that extend from this class to listen for tokens within a particluar scope.
PHP_CodeSniffer_Standards_AbstractVariableSniff: in file AbstractVariableSniff.php, class PHP_CodeSniffer_Standards_AbstractVariableSniff
A class to find T_VARIABLE tokens.
PHP_CodeSniffer_Standards_IncorrectPatternException: in file IncorrectPatternException.php, class PHP_CodeSniffer_Standards_IncorrectPatternException
An exception thrown if the pattern being processed is not supposed to be validating the code in question.
PHP_CodeSniffer_Tokens: in file Tokens.php, class PHP_CodeSniffer_Tokens
The Tokens class contains weightings for tokens based on their probability of occurance in a file.
prepareError: in file AbstractPatternSniff.php, method PHP_CodeSniffer_Standards_AbstractPatternSniff::prepareError()
Prepares an error for the specified patternCode.
printErrorReport: in file CodeSniffer.php, method PHP_CodeSniffer::printErrorReport()
Prints all errors and warnings for each file processed.
printErrorReportSummary: in file CodeSniffer.php, method PHP_CodeSniffer::printErrorReportSummary()
Prints a summary of errors and warnings for each file processed.
process: in file ValidDefaultValueSniff.php, method PEAR_Sniffs_Methods_ValidDefaultValueSniff::process()
Processes this test, when one of its tokens is encountered.
process: in file ValidClassNameSniff.php, method PEAR_Sniffs_NamingConventions_ValidClassNameSniff::process()
Processes this test, when one of its tokens is encountered.
process: in file ScopeIndentSniff.php, method PEAR_Sniffs_Whitespace_ScopeIndentSniff::process()
Processes this test, when one of its tokens is encountered.
process: in file Sniff.php, method PHP_CodeSniffer_Sniff::process()
Called when one of the token types that this sniff is listening for is found.
process: in file ScopeClosingBraceSniff.php, method PEAR_Sniffs_Whitespace_ScopeClosingBraceSniff::process()
Processes this test, when one of its tokens is encountered.
process: in file ShortOpenTagSniff.php, method PEAR_Sniffs_Misc_ShortOpenTagSniff::process()
Processes this test, when one of its tokens is encountered.
process: in file ValidConstantNameSniff.php, method PEAR_Sniffs_Constants_ValidConstantNameSniff::process()
Processes this test, when one of its tokens is encountered.
process: in file MethodCallArgumentSpacingSniff.php, method PEAR_Sniffs_Methods_MethodCallArgumentSpacingSniff::process()
Processes this test, when one of its tokens is encountered.
process: in file InlineCommentSniff.php, method PEAR_Sniffs_Commenting_InlineCommentSniff::process()
Processes this test, when one of its tokens is encountered.
process: in file AbstractPatternSniff.php, method PHP_CodeSniffer_Standards_AbstractPatternSniff::process()
Processes the test.
process: in file IncludingFileSniff.php, method PEAR_Sniffs_Files_IncludingFileSniff::process()
Processes this test, when one of its tokens is encountered.
process: in file FunctionCallSignatureSniff.php, method PEAR_Sniffs_Methods_FunctionCallSignatureSniff::process()
Processes this test, when one of its tokens is encountered.
process: in file CodeSniffer.php, method PHP_CodeSniffer::process()
Processes the files/directories that PHP_CodeSniffer was constructed with.
process: in file LineLengthSniff.php, method PEAR_Sniffs_Files_LineLengthSniff::process()
Processes this test, when one of its tokens is encountered.
process: in file AbstractScopeSniff.php, method PHP_CodeSniffer_Standards_AbstractScopeSniff::process()
Processes the tokens that this test is listening for.
process: in file MultipleStatementSniff.php, method PEAR_Sniffs_Statements_MultipleStatementSniff::process()
Processes this test, when one of its tokens is encountered.
process: in file LowerCaseConstantSniff.php, method PEAR_Sniffs_PHP_LowerCaseConstantSniff::process()
Processes this test, when one of its tokens is encountered.
process: in file OpeningMethodBraceSniff.php, method PEAR_Sniffs_Methods_OpeningMethodBraceSniff::process()
Processes this test, when one of its tokens is encountered.
processMemberVar: in file AbstractVariableSniff.php, method PHP_CodeSniffer_Standards_AbstractVariableSniff::processMemberVar()
Called to process class member vars.
processPattern: in file AbstractPatternSniff.php, method PHP_CodeSniffer_Standards_AbstractPatternSniff::processPattern()
Processes the pattern and varifies the code at $stackPtr.
processSubElement: in file PairElement.php, method PHP_CodeSniffer_CommentParser_PairElement::processSubElement()
Processes the sub element with the specified name.
processSubElement: in file AbstractDocElement.php, method PHP_CodeSniffer_CommentParser_AbstractDocElement::processSubElement()
Called to process each sub element as sepcified in the return value of getSubElements().
processSubElement: in file ParameterElement.php, method PHP_CodeSniffer_CommentParser_ParameterElement::processSubElement()
Processes the sub element with the specified name.
processSubElement: in file SingleElement.php, method PHP_CodeSniffer_CommentParser_SingleElement::processSubElement()
Processes the sub element with the specified name.
processSupplementary: in file AbstractPatternSniff.php, method PHP_CodeSniffer_Standards_AbstractPatternSniff::processSupplementary()
Processes any tokens registered with registerSupplementary().
processTokenOutsideScope: in file AbstractVariableSniff.php, method PHP_CodeSniffer_Standards_AbstractVariableSniff::processTokenOutsideScope()
Processes the token outside the scope in the file.
processTokenOutsideScope: in file AbstractScopeSniff.php, method PHP_CodeSniffer_Standards_AbstractScopeSniff::processTokenOutsideScope()
Processes a token that is found within the scope that this test is listening to.
processTokenOutsideScope: in file ValidFunctionNameSniff.php, method PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff::processTokenOutsideScope()
Processes the tokens outside the scope.
processTokenWithinScope: in file AbstractVariableSniff.php, method PHP_CodeSniffer_Standards_AbstractVariableSniff::processTokenWithinScope()
Processes the token in the specified PHP_CodeSniffer_File.
processTokenWithinScope: in file AbstractScopeSniff.php, method PHP_CodeSniffer_Standards_AbstractScopeSniff::processTokenWithinScope()
Processes a token that is found within the scope that this test is listening to.
processTokenWithinScope: in file ValidFunctionNameSniff.php, method PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff::processTokenWithinScope()
Processes the tokens within the scope.
processVariable: in file AbstractVariableSniff.php, method PHP_CodeSniffer_Standards_AbstractVariableSniff::processVariable()
Called to process normal member vars.
processVariableInString: in file AbstractVariableSniff.php, method PHP_CodeSniffer_Standards_AbstractVariableSniff::processVariableInString()
Called to process variables found in duoble quoted strings.

top

r

register: in file OpeningMethodBraceSniff.php, method PEAR_Sniffs_Methods_OpeningMethodBraceSniff::register()
Registers the tokens that this sniff wants to listen for.
register: in file InlineCommentSniff.php, method PEAR_Sniffs_Commenting_InlineCommentSniff::register()
Returns an array of tokens this test wants to listen for.
register: in file ScopeIndentSniff.php, method PEAR_Sniffs_Whitespace_ScopeIndentSniff::register()
Returns an array of tokens this test wants to listen for.
register: in file AbstractScopeSniff.php, method PHP_CodeSniffer_Standards_AbstractScopeSniff::register()
The method that is called to register the tokens this test wishes to listen to.
register: in file MultipleStatementSniff.php, method PEAR_Sniffs_Statements_MultipleStatementSniff::register()
Returns an array of tokens this test wants to listen for.
register: in file MethodCallArgumentSpacingSniff.php, method PEAR_Sniffs_Methods_MethodCallArgumentSpacingSniff::register()
Returns an array of tokens this test wants to listen for.
register: in file IncludingFileSniff.php, method PEAR_Sniffs_Files_IncludingFileSniff::register()
Returns an array of tokens this test wants to listen for.
register: in file LineLengthSniff.php, method PEAR_Sniffs_Files_LineLengthSniff::register()
Returns an array of tokens this test wants to listen for.
register: in file LowerCaseConstantSniff.php, method PEAR_Sniffs_PHP_LowerCaseConstantSniff::register()
Returns an array of tokens this test wants to listen for.
register: in file FunctionCallSignatureSniff.php, method PEAR_Sniffs_Methods_FunctionCallSignatureSniff::register()
Returns an array of tokens this test wants to listen for.
register: in file ShortOpenTagSniff.php, method PEAR_Sniffs_Misc_ShortOpenTagSniff::register()
Returns an array of tokens this test wants to listen for.
register: in file ScopeClosingBraceSniff.php, method PEAR_Sniffs_Whitespace_ScopeClosingBraceSniff::register()
Returns an array of tokens this test wants to listen for.
register: in file Sniff.php, method PHP_CodeSniffer_Sniff::register()
Registers the tokens that this sniff wants to listen for.
register: in file ValidConstantNameSniff.php, method PEAR_Sniffs_Constants_ValidConstantNameSniff::register()
Returns an array of tokens this test wants to listen for.
register: in file ValidDefaultValueSniff.php, method PEAR_Sniffs_Methods_ValidDefaultValueSniff::register()
Returns an array of tokens this test wants to listen for.
register: in file AbstractPatternSniff.php, method PHP_CodeSniffer_Standards_AbstractPatternSniff::register()
Registers the tokens to listen to.
register: in file ValidClassNameSniff.php, method PEAR_Sniffs_NamingConventions_ValidClassNameSniff::register()
Returns an array of tokens this test wants to listen for.
registerSupplementary: in file AbstractPatternSniff.php, method PHP_CodeSniffer_Standards_AbstractPatternSniff::registerSupplementary()
Registers any supplementary tokens that this test might wish to process.
removeTokenListener: in file File.php, method PHP_CodeSniffer_File::removeTokenListener()
Removes a listener from listening from the specified toekns.
resolveSimpleToken: in file CodeSniffer.php, method PHP_CodeSniffer::resolveSimpleToken()
Converts simple tokens into a format that conforms to complex tokens produced by token_get_all().
resolveTstringToken: in file CodeSniffer.php, method PHP_CodeSniffer::resolveTstringToken()
Converts T_STRING tokens into more usable token names.

top

s

$scopeModifiers

in file Tokens.php, variable PHP_CodeSniffer_Tokens::$scopeModifiers
Tokens that represent scope modifiers.

$scopeOpeners

in file Tokens.php, variable PHP_CodeSniffer_Tokens::$scopeOpeners
Tokens that are allowed to open scopes.

$sees

in file AbstractParser.php, variable PHP_CodeSniffer_CommentParser_AbstractParser::$sees
A list of see elements that appear in this doc comment.

$since

in file AbstractParser.php, variable PHP_CodeSniffer_CommentParser_AbstractParser::$since
A element to represent \@since tags.

$stringTokens

in file Tokens.php, variable PHP_CodeSniffer_Tokens::$stringTokens
Tokens that represent strings.

SingleElement.php

procedural page SingleElement.php

Sniff.php

procedural page Sniff.php

SniffException.php

procedural page SniffException.php

ShortOpenTagSniff.php

procedural page ShortOpenTagSniff.php

ScopeClosingBraceSniff.php

procedural page ScopeClosingBraceSniff.php

ScopeIndentSniff.php

procedural page ScopeIndentSniff.php

standardiseToken

in file CodeSniffer.php, method PHP_CodeSniffer::standardiseToken()
Takes a token produced from

token_get_all()

and produces a more uniform token.

start

in file File.php, method PHP_CodeSniffer_File::start()
Starts the stack traversal, alerting PHP_CodeSniffer_Sniff listeners when their listening tokens are encountered.

top

t

$tag: in file AbstractDocElement.php, variable PHP_CodeSniffer_CommentParser_AbstractDocElement::$tag
The tag that this element represents (omiting the @ symbol).
$tokens: in file AbstractDocElement.php, variable PHP_CodeSniffer_CommentParser_AbstractDocElement::$tokens
The tokens that comprise this element.
Tokens.php: procedural page Tokens.php
T_ARRAY_HINT: in file Tokens.php, constant T_ARRAY_HINT
T_BITWISE_AND: in file Tokens.php, constant T_BITWISE_AND
T_BITWISE_OR: in file Tokens.php, constant T_BITWISE_OR
T_BOOLEAN_NOT: in file Tokens.php, constant T_BOOLEAN_NOT
T_CLOSE_CURLY_BRACKET: in file Tokens.php, constant T_CLOSE_CURLY_BRACKET
T_CLOSE_PARENTHESIS: in file Tokens.php, constant T_CLOSE_PARENTHESIS
T_CLOSE_SQUARE_BRACKET: in file Tokens.php, constant T_CLOSE_SQUARE_BRACKET
T_COLON: in file Tokens.php, constant T_COLON
T_COMMA: in file Tokens.php, constant T_COMMA
T_DIVIDE: in file Tokens.php, constant T_DIVIDE
T_DOUBLE_QUOTED_STRING: in file Tokens.php, constant T_DOUBLE_QUOTED_STRING
T_EQUAL: in file Tokens.php, constant T_EQUAL
T_FALSE: in file Tokens.php, constant T_FALSE
T_GREATER_THAN: in file Tokens.php, constant T_GREATER_THAN
T_INLINE_THEN: in file Tokens.php, constant T_INLINE_THEN
T_LESS_THAN: in file Tokens.php, constant T_LESS_THAN
T_MINUS: in file Tokens.php, constant T_MINUS
T_MODULUS: in file Tokens.php, constant T_MODULUS
T_MULTIPLY: in file Tokens.php, constant T_MULTIPLY
T_NONE: in file Tokens.php, constant T_NONE
T_NULL: in file Tokens.php, constant T_NULL
T_OPEN_CURLY_BRACKET: in file Tokens.php, constant T_OPEN_CURLY_BRACKET
T_OPEN_PARENTHESIS: in file Tokens.php, constant T_OPEN_PARENTHESIS
T_OPEN_SQUARE_BRACKET: in file Tokens.php, constant T_OPEN_SQUARE_BRACKET
T_PARENT: in file Tokens.php, constant T_PARENT
T_PLUS: in file Tokens.php, constant T_PLUS
T_POWER: in file Tokens.php, constant T_POWER
T_SELF: in file Tokens.php, constant T_SELF
T_SEMICOLON: in file Tokens.php, constant T_SEMICOLON
T_STRING_CONCAT: in file Tokens.php, constant T_STRING_CONCAT
T_TRUE: in file Tokens.php, constant T_TRUE

top

v

ValidConstantNameSniff.php: procedural page ValidConstantNameSniff.php
ValidDefaultValueSniff.php: procedural page ValidDefaultValueSniff.php
ValidClassNameSniff.php: procedural page ValidClassNameSniff.php
ValidFunctionNameSniff.php: procedural page ValidFunctionNameSniff.php

top

w

$weightings: in file Tokens.php, variable PHP_CodeSniffer_Tokens::$weightings
The token weightings.
$words: in file AbstractParser.php, variable PHP_CodeSniffer_CommentParser_AbstractParser::$words
The word tokens that appear in the comment.
WARNING: in file File.php, class constant PHP_CodeSniffer_File::WARNING
A constant to represent a warning in PHP_CodeSniffer.

top