Source for file ValidVariableNameSniff.php
Documentation is available at ValidVariableNameSniff.php
* Checks the naming of member variables.
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
namespace PHP_CodeSniffer\Standards\PEAR\Sniffs\NamingConventions;
use PHP_CodeSniffer\Sniffs\AbstractVariableSniff;
use PHP_CodeSniffer\Files\File;
class ValidVariableNameSniff extends AbstractVariableSniff
* Processes class member variables.
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token
* in the stack passed in $tokens.
protected function processMemberVar (File $phpcsFile, $stackPtr)
$tokens = $phpcsFile->getTokens ();
$memberProps = $phpcsFile->getMemberProperties ($stackPtr);
if (empty ($memberProps) === true ) {
$memberName = ltrim($tokens[$stackPtr]['content'], '$');
$scope = $memberProps['scope'];
$scopeSpecified = $memberProps['scope_specified'];
if ($memberProps['scope'] === 'private') {
// If it's a private member, it must have an underscore on the front.
if ($isPublic === false && $memberName{0 } !== '_') {
$error = 'Private member variable "%s" must be prefixed with an underscore';
$data = array ($memberName);
$phpcsFile->addError ($error, $stackPtr, 'PrivateNoUnderscore', $data);
// If it's not a private member, it must not have an underscore on the front.
if ($isPublic === true && $scopeSpecified === true && $memberName{0 } === '_') {
$error = '%s member variable "%s" must not be prefixed with an underscore';
$phpcsFile->addError ($error, $stackPtr, 'PublicUnderscore', $data);
}//end processMemberVar()
* Processes normal variables.
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
* @param int $stackPtr The position where the token was found.
protected function processVariable (File $phpcsFile, $stackPtr)
We don't care about normal variables.
* Processes variables in double quoted strings.
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
* @param int $stackPtr The position where the token was found.
protected function processVariableInString (File $phpcsFile, $stackPtr)
We don't care about normal variables.
}//end processVariableInString()
Documentation generated on Mon, 11 Mar 2019 15:27:51 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|