PHP 클래스 PEAR_Sniffs_Commenting_FileCommentSniff, PHP_CodeSniffer

저자: Greg Sherwood ([email protected])
저자: Marc McIntyre ([email protected])
상속: implements PHP_CodeSniffer_Sniff
파일 보기 프로젝트 열기: squizlabs/php_codesniffer 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$tags array Tags in correct order and related info.

공개 메소드들

메소드 설명
process ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr ) : integer Processes this test, when one of its tokens is encountered.
register ( ) : array Returns an array of tokens this test wants to listen for.

보호된 메소드들

메소드 설명
processAuthor ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void Process the author tag(s) that this header comment has.
processCategory ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void Process the category tag.
processCopyright ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void Process the copyright tags.
processLicense ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void Process the license tag.
processPackage ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void Process the package tag.
processSubpackage ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void Process the subpackage tag.
processTags ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr, integer $commentStart ) : void Processes each required or optional tag.
processVersion ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void Process the version tag.

메소드 상세

process() 공개 메소드

Processes this test, when one of its tokens is encountered.
public process ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr ) : integer
$phpcsFile PHP_CodeSniffer_File The file being scanned.
$stackPtr integer The position of the current token in the stack passed in $tokens.
리턴 integer

processAuthor() 보호된 메소드

Process the author tag(s) that this header comment has.
protected processAuthor ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void
$phpcsFile PHP_CodeSniffer_File The file being scanned.
$tags array The tokens for these tags.
리턴 void

processCategory() 보호된 메소드

Process the category tag.
protected processCategory ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void
$phpcsFile PHP_CodeSniffer_File The file being scanned.
$tags array The tokens for these tags.
리턴 void

processCopyright() 보호된 메소드

Process the copyright tags.
protected processCopyright ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void
$phpcsFile PHP_CodeSniffer_File The file being scanned.
$tags array The tokens for these tags.
리턴 void

processLicense() 보호된 메소드

Process the license tag.
protected processLicense ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void
$phpcsFile PHP_CodeSniffer_File The file being scanned.
$tags array The tokens for these tags.
리턴 void

processPackage() 보호된 메소드

Process the package tag.
protected processPackage ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void
$phpcsFile PHP_CodeSniffer_File The file being scanned.
$tags array The tokens for these tags.
리턴 void

processSubpackage() 보호된 메소드

Process the subpackage tag.
protected processSubpackage ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void
$phpcsFile PHP_CodeSniffer_File The file being scanned.
$tags array The tokens for these tags.
리턴 void

processTags() 보호된 메소드

Processes each required or optional tag.
protected processTags ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr, integer $commentStart ) : void
$phpcsFile PHP_CodeSniffer_File The file being scanned.
$stackPtr integer The position of the current token in the stack passed in $tokens.
$commentStart integer Position in the stack where the comment started.
리턴 void

processVersion() 보호된 메소드

Process the version tag.
protected processVersion ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void
$phpcsFile PHP_CodeSniffer_File The file being scanned.
$tags array The tokens for these tags.
리턴 void

register() 공개 메소드

Returns an array of tokens this test wants to listen for.
public register ( ) : array
리턴 array

프로퍼티 상세

$tags 보호되어 있는 프로퍼티

Tags in correct order and related info.
protected array $tags
리턴 array