mirror of
https://github.com/WordPress/WordPress-Coding-Standards.git
synced 2026-07-30 11:06:59 +08:00
133 lines
4.5 KiB
PHP
133 lines
4.5 KiB
PHP
<?php
|
|
/**
|
|
* Enforces WordPress function name format, based upon Squiz code
|
|
*
|
|
* PHP version 5
|
|
*
|
|
* @category PHP
|
|
* @package PHP_CodeSniffer
|
|
* @author John Godley <john@urbangiraffe.com>
|
|
*/
|
|
|
|
/**
|
|
* Enforces WordPress array format
|
|
*
|
|
* @category PHP
|
|
* @package PHP_CodeSniffer
|
|
* @author John Godley <john@urbangiraffe.com>
|
|
*/
|
|
class WordPress_Sniffs_NamingConventions_ValidFunctionNameSniff extends PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff
|
|
{
|
|
|
|
private $_magicMethods = array(
|
|
'construct',
|
|
'destruct',
|
|
'call',
|
|
'callStatic',
|
|
'get',
|
|
'set',
|
|
'isset',
|
|
'unset',
|
|
'sleep',
|
|
'wakeup',
|
|
'toString',
|
|
'set_state',
|
|
'clone',
|
|
);
|
|
|
|
|
|
/**
|
|
* Processes the tokens outside the scope.
|
|
*
|
|
* @param PHP_CodeSniffer_File $phpcsFile The file being processed.
|
|
* @param int $stackPtr The position where this token was
|
|
* found.
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function processTokenOutsideScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
|
{
|
|
$functionName = $phpcsFile->getDeclarationName($stackPtr);
|
|
|
|
if (strtolower($functionName) !== $functionName) {
|
|
$suggested = preg_replace('/([A-Z])/', '_$1', $functionName);
|
|
$suggested = strtolower($suggested);
|
|
$suggested = str_replace('__', '_', $suggested);
|
|
|
|
$error = "Function name \"$functionName\" is in camel caps format, try '".$suggested."'";
|
|
$phpcsFile->addError($error, $stackPtr);
|
|
}
|
|
|
|
}//end processTokenOutsideScope()
|
|
|
|
|
|
/**
|
|
* Processes the tokens within the scope.
|
|
*
|
|
* @param PHP_CodeSniffer_File $phpcsFile The file being processed.
|
|
* @param int $stackPtr The position where this token was
|
|
* found.
|
|
* @param int $currScope The position of the current scope.
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope)
|
|
{
|
|
$className = $phpcsFile->getDeclarationName($currScope);
|
|
$methodName = $phpcsFile->getDeclarationName($stackPtr);
|
|
|
|
// Is this a magic method. IE. is prefixed with "__".
|
|
if (preg_match('|^__|', $methodName) !== 0) {
|
|
$magicPart = substr($methodName, 2);
|
|
if (in_array($magicPart, $this->_magicMethods) === false) {
|
|
$error = "Method name \"$className::$methodName\" is invalid; only PHP magic methods should be prefixed with a double underscore";
|
|
$phpcsFile->addError($error, $stackPtr);
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
// PHP4 constructors are allowed to break our rules.
|
|
if ($methodName === $className) {
|
|
return;
|
|
}
|
|
|
|
// PHP4 destructors are allowed to break our rules.
|
|
if ($methodName === '_'.$className) {
|
|
return;
|
|
}
|
|
|
|
$methodProps = $phpcsFile->getMethodProperties($stackPtr);
|
|
$scope = $methodProps['scope'];
|
|
$scopeSpecified = $methodProps['scope_specified'];
|
|
|
|
if ($methodProps['scope'] === 'private')
|
|
$isPublic = false;
|
|
else
|
|
$isPublic = true;
|
|
|
|
// If the scope was specified on the method, then the method must be
|
|
// camel caps and an underscore should be checked for. If it wasn't
|
|
// specified, treat it like a public method and remove the underscore
|
|
// prefix if there is one because we can't determine if it is private or
|
|
// public.
|
|
$testMethodName = $methodName;
|
|
if ($scopeSpecified === false && $methodName{0} === '_') {
|
|
$testMethodName = substr($methodName, 1);
|
|
}
|
|
|
|
if (strtolower($testMethodName) !== $testMethodName) {
|
|
$suggested = preg_replace('/([A-Z])/', '_$1', $methodName);
|
|
$suggested = strtolower($suggested);
|
|
$suggested = str_replace('__', '_', $suggested);
|
|
|
|
$error = "Function name \"$methodName\" is in camel caps format, try '".$suggested."'";
|
|
$phpcsFile->addError($error, $stackPtr);
|
|
}
|
|
|
|
}//end processTokenWithinScope()
|
|
|
|
|
|
}//end class
|
|
|
|
?>
|
