/libraries/mpdf/vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/PEAR/Sniffs/NamingConventions/ValidFunctionNameSniff.php
PHP | 298 lines | 175 code | 42 blank | 81 comment | 35 complexity | 2b29de9d940816d6147e4be1c5d41c07 MD5 | raw file
- <?php
- /**
- * PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff.
- *
- * PHP version 5
- *
- * @category PHP
- * @package PHP_CodeSniffer
- * @author Greg Sherwood <gsherwood@squiz.net>
- * @author Marc McIntyre <mmcintyre@squiz.net>
- * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
- * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
- * @link http://pear.php.net/package/PHP_CodeSniffer
- */
- if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) {
- throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found');
- }
- /**
- * PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff.
- *
- * Ensures method names are correct depending on whether they are public
- * or private, and that functions are named correctly.
- *
- * @category PHP
- * @package PHP_CodeSniffer
- * @author Greg Sherwood <gsherwood@squiz.net>
- * @author Marc McIntyre <mmcintyre@squiz.net>
- * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
- * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
- * @version Release: @package_version@
- * @link http://pear.php.net/package/PHP_CodeSniffer
- */
- class PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff
- {
- /**
- * A list of all PHP magic methods.
- *
- * @var array
- */
- protected $magicMethods = array(
- 'construct' => true,
- 'destruct' => true,
- 'call' => true,
- 'callstatic' => true,
- 'get' => true,
- 'set' => true,
- 'isset' => true,
- 'unset' => true,
- 'sleep' => true,
- 'wakeup' => true,
- 'tostring' => true,
- 'set_state' => true,
- 'clone' => true,
- 'invoke' => true,
- 'debuginfo' => true,
- );
- /**
- * A list of all PHP magic functions.
- *
- * @var array
- */
- protected $magicFunctions = array('autoload' => true);
- /**
- * Constructs a PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff.
- */
- public function __construct()
- {
- parent::__construct(array(T_CLASS, T_ANON_CLASS, T_INTERFACE, T_TRAIT), array(T_FUNCTION), true);
- }//end __construct()
- /**
- * 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)
- {
- $methodName = $phpcsFile->getDeclarationName($stackPtr);
- if ($methodName === null) {
- // Ignore closures.
- return;
- }
- $className = $phpcsFile->getDeclarationName($currScope);
- $errorData = array($className.'::'.$methodName);
- // Is this a magic method. i.e., is prefixed with "__" ?
- if (preg_match('|^__[^_]|', $methodName) !== 0) {
- $magicPart = strtolower(substr($methodName, 2));
- if (isset($this->magicMethods[$magicPart]) === false) {
- $error = 'Method name "%s" is invalid; only PHP magic methods should be prefixed with a double underscore';
- $phpcsFile->addError($error, $stackPtr, 'MethodDoubleUnderscore', $errorData);
- }
- 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 it's a private method, it must have an underscore on the front.
- if ($isPublic === false) {
- if ($methodName{0} !== '_') {
- $error = 'Private method name "%s" must be prefixed with an underscore';
- $phpcsFile->addError($error, $stackPtr, 'PrivateNoUnderscore', $errorData);
- $phpcsFile->recordMetric($stackPtr, 'Private method prefixed with underscore', 'no');
- return;
- } else {
- $phpcsFile->recordMetric($stackPtr, 'Private method prefixed with underscore', 'yes');
- }
- }
- // If it's not a private method, it must not have an underscore on the front.
- if ($isPublic === true && $scopeSpecified === true && $methodName{0} === '_') {
- $error = '%s method name "%s" must not be prefixed with an underscore';
- $data = array(
- ucfirst($scope),
- $errorData[0],
- );
- $phpcsFile->addError($error, $stackPtr, 'PublicUnderscore', $data);
- return;
- }
- // 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 cant determine if it is private or
- // public.
- $testMethodName = $methodName;
- if ($scopeSpecified === false && $methodName{0} === '_') {
- $testMethodName = substr($methodName, 1);
- }
- if (PHP_CodeSniffer::isCamelCaps($testMethodName, false, $isPublic, false) === false) {
- if ($scopeSpecified === true) {
- $error = '%s method name "%s" is not in camel caps format';
- $data = array(
- ucfirst($scope),
- $errorData[0],
- );
- $phpcsFile->addError($error, $stackPtr, 'ScopeNotCamelCaps', $data);
- } else {
- $error = 'Method name "%s" is not in camel caps format';
- $phpcsFile->addError($error, $stackPtr, 'NotCamelCaps', $errorData);
- }
- return;
- }
- }//end processTokenWithinScope()
- /**
- * 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 ($functionName === null) {
- // Ignore closures.
- return;
- }
- if (ltrim($functionName, '_') === '') {
- // Ignore special functions.
- return;
- }
- $errorData = array($functionName);
- // Is this a magic function. i.e., it is prefixed with "__".
- if (preg_match('|^__[^_]|', $functionName) !== 0) {
- $magicPart = strtolower(substr($functionName, 2));
- if (isset($this->magicFunctions[$magicPart]) === false) {
- $error = 'Function name "%s" is invalid; only PHP magic methods should be prefixed with a double underscore';
- $phpcsFile->addError($error, $stackPtr, 'FunctionDoubleUnderscore', $errorData);
- }
- return;
- }
- // Function names can be in two parts; the package name and
- // the function name.
- $packagePart = '';
- $camelCapsPart = '';
- $underscorePos = strrpos($functionName, '_');
- if ($underscorePos === false) {
- $camelCapsPart = $functionName;
- } else {
- $packagePart = substr($functionName, 0, $underscorePos);
- $camelCapsPart = substr($functionName, ($underscorePos + 1));
- // We don't care about _'s on the front.
- $packagePart = ltrim($packagePart, '_');
- }
- // If it has a package part, make sure the first letter is a capital.
- if ($packagePart !== '') {
- if ($functionName{0} === '_') {
- $error = 'Function name "%s" is invalid; only private methods should be prefixed with an underscore';
- $phpcsFile->addError($error, $stackPtr, 'FunctionUnderscore', $errorData);
- return;
- }
- if ($functionName{0} !== strtoupper($functionName{0})) {
- $error = 'Function name "%s" is prefixed with a package name but does not begin with a capital letter';
- $phpcsFile->addError($error, $stackPtr, 'FunctionNoCapital', $errorData);
- return;
- }
- }
- // If it doesn't have a camel caps part, it's not valid.
- if (trim($camelCapsPart) === '') {
- $error = 'Function name "%s" is not valid; name appears incomplete';
- $phpcsFile->addError($error, $stackPtr, 'FunctionInvalid', $errorData);
- return;
- }
- $validName = true;
- $newPackagePart = $packagePart;
- $newCamelCapsPart = $camelCapsPart;
- // Every function must have a camel caps part, so check that first.
- if (PHP_CodeSniffer::isCamelCaps($camelCapsPart, false, true, false) === false) {
- $validName = false;
- $newCamelCapsPart = strtolower($camelCapsPart{0}).substr($camelCapsPart, 1);
- }
- if ($packagePart !== '') {
- // Check that each new word starts with a capital.
- $nameBits = explode('_', $packagePart);
- foreach ($nameBits as $bit) {
- if ($bit{0} !== strtoupper($bit{0})) {
- $newPackagePart = '';
- foreach ($nameBits as $bit) {
- $newPackagePart .= strtoupper($bit{0}).substr($bit, 1).'_';
- }
- $validName = false;
- break;
- }
- }
- }
- if ($validName === false) {
- $newName = rtrim($newPackagePart, '_').'_'.$newCamelCapsPart;
- if ($newPackagePart === '') {
- $newName = $newCamelCapsPart;
- } else {
- $newName = rtrim($newPackagePart, '_').'_'.$newCamelCapsPart;
- }
- $error = 'Function name "%s" is invalid; consider "%s" instead';
- $data = $errorData;
- $data[] = $newName;
- $phpcsFile->addError($error, $stackPtr, 'FunctionNameInvalid', $data);
- }
- }//end processTokenOutsideScope()
- }//end class