Skip to content

False positive for function names starting with triple underscore #1240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 15, 2016
Merged

False positive for function names starting with triple underscore #1240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CodeSniffer/Standards/Generic/Sniffs/NamingConventions/CamelCapsFunctionNameSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $sta
$errorData = array($className.'::'.$methodName);

// Is this a magic method. i.e., is prefixed with "__" ?
if (preg_match('|^__|', $methodName) !== 0) {
if (preg_match('|^__[^_]|', $methodName) !== 0) {
$magicPart = strtolower(substr($methodName, 2));
if (isset($this->magicMethods[$magicPart]) === false
&& isset($this->methodsDoubleUnderscore[$magicPart]) === false
Expand Down Expand Up @@ -194,7 +194,7 @@ protected function processTokenOutsideScope(PHP_CodeSniffer_File $phpcsFile, $st
$errorData = array($functionName);

// Is this a magic function. i.e., it is prefixed with "__".
if (preg_match('|^__|', $functionName) !== 0) {
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';
Expand Down
6 changes: 6 additions & 0 deletions CodeSniffer/Standards/Generic/Tests/NamingConventions/CamelCapsFunctionNameUnitTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,3 +119,9 @@ function __debugInfo() {}
class Foo {
function __debugInfo() {}
}

function ___tripleUnderscore() {} // Ok.

class triple {
public function ___tripleUnderscore() {} // Ok.
}
2 changes: 1 addition & 1 deletion CodeSniffer/Standards/PSR1/Sniffs/Methods/CamelCapsMethodNameSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $sta
}

// Ignore magic methods.
if (preg_match('|^__|', $methodName) !== 0) {
if (preg_match('|^__[^_]|', $methodName) !== 0) {
$magicPart = strtolower(substr($methodName, 2));
if (isset($this->magicMethods[$magicPart]) === true
|| isset($this->methodsDoubleUnderscore[$magicPart]) === true
Expand Down
6 changes: 6 additions & 0 deletions CodeSniffer/Standards/PSR1/Tests/Methods/CamelCapsMethodNameUnitTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,10 @@ class Foo extends \SoapClient

function __() {}
}

function ___tripleUnderscore() {} // Ok.

class triple {
public function ___tripleUnderscore() {} // Ok.
}
?>