Rename "checkFor" functions to "isVariableA" to be more clear

Author: sirbrillig

VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php

@@ -478,7 +478,7 @@ protected function markAllVariablesRead(File $phpcsFile, $stackPtr) {
    *
    * @return bool
    */
-  protected function checkForFunctionDefinition(File $phpcsFile, $stackPtr, $varName, $currScope) {
+  protected function isVariableAFunctionDefinition(File $phpcsFile, $stackPtr, $varName, $currScope) {
     $tokens = $phpcsFile->getTokens();
 
     // Are we a function or closure parameter?
@@ -547,7 +547,7 @@ protected function checkForFunctionDefinition(File $phpcsFile, $stackPtr, $varNa
    *
    * @return bool
    */
-  protected function checkForClassProperty(File $phpcsFile, $stackPtr) {
+  protected function isVariableAClassProperty(File $phpcsFile, $stackPtr) {
     $propertyDeclarationKeywords = [
       T_PUBLIC,
       T_PRIVATE,
@@ -587,7 +587,7 @@ protected function checkForClassProperty(File $phpcsFile, $stackPtr) {
    *
    * @return bool
    */
-  protected function checkForCatchBlock(File $phpcsFile, $stackPtr, $varName, $currScope) {
+  protected function isVariableACatchBlock(File $phpcsFile, $stackPtr, $varName, $currScope) {
     $tokens = $phpcsFile->getTokens();
 
     // Are we a catch block parameter?
@@ -617,7 +617,7 @@ protected function checkForCatchBlock(File $phpcsFile, $stackPtr, $varName, $cur
    *
    * @return bool
    */
-  protected function checkForThisWithinClass(File $phpcsFile, $stackPtr, $varName) {
+  protected function isVariableAThisWithinClass(File $phpcsFile, $stackPtr, $varName) {
     $tokens = $phpcsFile->getTokens();
     $token  = $tokens[$stackPtr];
 
@@ -654,7 +654,7 @@ protected function checkForThisWithinClass(File $phpcsFile, $stackPtr, $varName)
    *
    * @return bool
    */
-  protected function checkForSuperGlobal($varName) {
+  protected function isVariableASuperGlobal($varName) {
     // Are we a superglobal variable?
     if (in_array($varName, [
       'GLOBALS',
@@ -681,7 +681,7 @@ protected function checkForSuperGlobal($varName) {
    *
    * @return bool
    */
-  protected function checkForStaticMember(File $phpcsFile, $stackPtr) {
+  protected function isVariableAStaticMember(File $phpcsFile, $stackPtr) {
     $tokens = $phpcsFile->getTokens();
 
     $doubleColonPtr = $phpcsFile->findPrevious(Tokens::$emptyTokens, $stackPtr - 1, null, true);
@@ -715,7 +715,7 @@ protected function checkForStaticMember(File $phpcsFile, $stackPtr) {
    *
    * @return bool
    */
-  protected function checkForStaticOutsideClass(File $phpcsFile, $stackPtr, $varName) {
+  protected function isVariableAStaticOutsideClass(File $phpcsFile, $stackPtr, $varName) {
     // Are we refering to self:: outside a class?
 
     $tokens = $phpcsFile->getTokens();
@@ -759,15 +759,15 @@ protected function checkForStaticOutsideClass(File $phpcsFile, $stackPtr, $varNa
    *
    * @return bool
    */
-  protected function checkForAssignment(File $phpcsFile, $stackPtr, $varName, $currScope) {
+  protected function isVariableAAssignment(File $phpcsFile, $stackPtr, $varName, $currScope) {
     // Is the next non-whitespace an assignment?
     $assignPtr = Helpers::getNextAssignPointer($phpcsFile, $stackPtr);
     if (! is_int($assignPtr)) {
       return false;
     }
 
     // Is this a variable variable? If so, it's not an assignment to the current variable.
-    if ($this->checkForVariableVariable($phpcsFile, $stackPtr)) {
+    if ($this->isVariableAVariableVariable($phpcsFile, $stackPtr)) {
       Helpers::debug('found variable variable');
       return false;
     }
@@ -797,7 +797,7 @@ protected function checkForAssignment(File $phpcsFile, $stackPtr, $varName, $cur
    *
    * @return bool
    */
-  protected function checkForVariableVariable(File $phpcsFile, $stackPtr) {
+  protected function isVariableAVariableVariable(File $phpcsFile, $stackPtr) {
     $tokens = $phpcsFile->getTokens();
 
     $prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true);
@@ -826,7 +826,7 @@ protected function checkForVariableVariable(File $phpcsFile, $stackPtr) {
    *
    * @return bool
    */
-  protected function checkForListShorthandAssignment(File $phpcsFile, $stackPtr, $varName, $currScope) {
+  protected function isVariableAListShorthandAssignment(File $phpcsFile, $stackPtr, $varName, $currScope) {
     // OK, are we within a [ ... ] construct?
     $openPtr = Helpers::findContainingOpeningSquareBracket($phpcsFile, $stackPtr);
     if (! is_int($openPtr)) {
@@ -862,7 +862,7 @@ protected function checkForListShorthandAssignment(File $phpcsFile, $stackPtr, $
    *
    * @return bool
    */
-  protected function checkForListAssignment(File $phpcsFile, $stackPtr, $varName, $currScope) {
+  protected function isVariableAListAssignment(File $phpcsFile, $stackPtr, $varName, $currScope) {
     $tokens = $phpcsFile->getTokens();
 
     // OK, are we within a list (...) construct?
@@ -905,7 +905,7 @@ protected function checkForListAssignment(File $phpcsFile, $stackPtr, $varName,
    *
    * @return bool
    */
-  protected function checkForGlobalDeclaration(File $phpcsFile, $stackPtr, $varName, $currScope) {
+  protected function isVariableAGlobalDeclaration(File $phpcsFile, $stackPtr, $varName, $currScope) {
     $tokens = $phpcsFile->getTokens();
 
     // Are we a global declaration?
@@ -932,7 +932,7 @@ protected function checkForGlobalDeclaration(File $phpcsFile, $stackPtr, $varNam
    *
    * @return bool
    */
-  protected function checkForStaticDeclaration(File $phpcsFile, $stackPtr, $varName, $currScope) {
+  protected function isVariableAStaticDeclaration(File $phpcsFile, $stackPtr, $varName, $currScope) {
     $tokens = $phpcsFile->getTokens();
 
     // Are we a static declaration?
@@ -997,7 +997,7 @@ protected function checkForStaticDeclaration(File $phpcsFile, $stackPtr, $varNam
    *
    * @return bool
    */
-  protected function checkForNumericVariable($varName) {
+  protected function isVariableANumericVariable($varName) {
     return is_numeric(substr($varName, 0, 1));
   }
 
@@ -1009,7 +1009,7 @@ protected function checkForNumericVariable($varName) {
    *
    * @return bool
    */
-  protected function checkForForeachLoopVar(File $phpcsFile, $stackPtr, $varName, $currScope) {
+  protected function isVariableAForeachLoopVar(File $phpcsFile, $stackPtr, $varName, $currScope) {
     $tokens = $phpcsFile->getTokens();
 
     // Are we a foreach loopvar?
@@ -1058,7 +1058,7 @@ protected function checkForForeachLoopVar(File $phpcsFile, $stackPtr, $varName,
    *
    * @return bool
    */
-  protected function checkForPassByReferenceFunctionCall(File $phpcsFile, $stackPtr, $varName, $currScope) {
+  protected function isVariableAPassByReferenceFunctionCall(File $phpcsFile, $stackPtr, $varName, $currScope) {
     $tokens = $phpcsFile->getTokens();
 
     // Are we pass-by-reference to known pass-by-reference function?
@@ -1125,7 +1125,7 @@ protected function checkForPassByReferenceFunctionCall(File $phpcsFile, $stackPt
    *
    * @return bool
    */
-  protected function checkForSymbolicObjectProperty(File $phpcsFile, $stackPtr, $varName, $currScope) {
+  protected function isVariableASymbolicObjectProperty(File $phpcsFile, $stackPtr, $varName, $currScope) {
     $tokens = $phpcsFile->getTokens();
 
     // Are we a symbolic object property/function derefeference?
@@ -1180,96 +1180,96 @@ protected function processVariable(File $phpcsFile, $stackPtr) {
     //   Pass-by-reference to known pass-by-reference function
 
     // Are we a $object->$property type symbolic reference?
-    if ($this->checkForSymbolicObjectProperty($phpcsFile, $stackPtr, $varName, $currScope)) {
+    if ($this->isVariableASymbolicObjectProperty($phpcsFile, $stackPtr, $varName, $currScope)) {
       Helpers::debug('found symbolic object property');
       return;
     }
 
     // Are we a function or closure parameter?
-    if ($this->checkForFunctionDefinition($phpcsFile, $stackPtr, $varName, $currScope)) {
+    if ($this->isVariableAFunctionDefinition($phpcsFile, $stackPtr, $varName, $currScope)) {
       Helpers::debug('found function definition');
       return;
     }
 
     // Are we a catch parameter?
-    if ($this->checkForCatchBlock($phpcsFile, $stackPtr, $varName, $currScope)) {
+    if ($this->isVariableACatchBlock($phpcsFile, $stackPtr, $varName, $currScope)) {
       Helpers::debug('found catch block');
       return;
     }
 
     // Are we $this within a class?
-    if ($this->checkForThisWithinClass($phpcsFile, $stackPtr, $varName)) {
+    if ($this->isVariableAThisWithinClass($phpcsFile, $stackPtr, $varName)) {
       Helpers::debug('found this usage within a class');
       return;
     }
 
     // Are we a $GLOBALS, $_REQUEST, etc superglobal?
-    if ($this->checkForSuperGlobal($varName)) {
+    if ($this->isVariableASuperGlobal($varName)) {
       Helpers::debug('found superglobal');
       return;
     }
 
     // Check for static members used outside a class
-    if ($this->checkForStaticOutsideClass($phpcsFile, $stackPtr, $varName)) {
+    if ($this->isVariableAStaticOutsideClass($phpcsFile, $stackPtr, $varName)) {
       Helpers::debug('found static usage outside of class');
       return;
     }
 
     // $var part of class::$var static member
-    if ($this->checkForStaticMember($phpcsFile, $stackPtr)) {
+    if ($this->isVariableAStaticMember($phpcsFile, $stackPtr)) {
       Helpers::debug('found static member');
       return;
     }
 
-    if ($this->checkForClassProperty($phpcsFile, $stackPtr)) {
+    if ($this->isVariableAClassProperty($phpcsFile, $stackPtr)) {
       Helpers::debug('found class property definition');
       return;
     }
 
     // Is the next non-whitespace an assignment?
-    if ($this->checkForAssignment($phpcsFile, $stackPtr, $varName, $currScope)) {
+    if ($this->isVariableAAssignment($phpcsFile, $stackPtr, $varName, $currScope)) {
       Helpers::debug('found assignment');
       return;
     }
 
     // OK, are we within a list (...) = construct?
-    if ($this->checkForListAssignment($phpcsFile, $stackPtr, $varName, $currScope)) {
+    if ($this->isVariableAListAssignment($phpcsFile, $stackPtr, $varName, $currScope)) {
       Helpers::debug('found list assignment');
       return;
     }
 
     // OK, are we within a [...] = construct?
-    if ($this->checkForListShorthandAssignment($phpcsFile, $stackPtr, $varName, $currScope)) {
+    if ($this->isVariableAListShorthandAssignment($phpcsFile, $stackPtr, $varName, $currScope)) {
       Helpers::debug('found list shorthand assignment');
       return;
     }
 
     // Are we a global declaration?
-    if ($this->checkForGlobalDeclaration($phpcsFile, $stackPtr, $varName, $currScope)) {
+    if ($this->isVariableAGlobalDeclaration($phpcsFile, $stackPtr, $varName, $currScope)) {
       Helpers::debug('found global declaration');
       return;
     }
 
     // Are we a static declaration?
-    if ($this->checkForStaticDeclaration($phpcsFile, $stackPtr, $varName, $currScope)) {
+    if ($this->isVariableAStaticDeclaration($phpcsFile, $stackPtr, $varName, $currScope)) {
       Helpers::debug('found static declaration');
       return;
     }
 
     // Are we a foreach loopvar?
-    if ($this->checkForForeachLoopVar($phpcsFile, $stackPtr, $varName, $currScope)) {
+    if ($this->isVariableAForeachLoopVar($phpcsFile, $stackPtr, $varName, $currScope)) {
       Helpers::debug('found foreach loop variable');
       return;
     }
 
     // Are we pass-by-reference to known pass-by-reference function?
-    if ($this->checkForPassByReferenceFunctionCall($phpcsFile, $stackPtr, $varName, $currScope)) {
+    if ($this->isVariableAPassByReferenceFunctionCall($phpcsFile, $stackPtr, $varName, $currScope)) {
       Helpers::debug('found pass by reference');
       return;
     }
 
     // Are we a numeric variable used for constructs like preg_replace?
-    if ($this->checkForNumericVariable($varName)) {
+    if ($this->isVariableANumericVariable($varName)) {
       Helpers::debug('found numeric variable');
       return;
     }
@@ -1305,16 +1305,16 @@ protected function processVariableInString(File $phpcsFile, $stackPtr) {
     foreach ($matches[1] as $varName) {
       $varName = Helpers::normalizeVarName($varName);
       // Are we $this within a class?
-      if ($this->checkForThisWithinClass($phpcsFile, $stackPtr, $varName)) {
+      if ($this->isVariableAThisWithinClass($phpcsFile, $stackPtr, $varName)) {
         continue;
       }
 
-      if ($this->checkForSuperGlobal($varName)) {
+      if ($this->isVariableASuperGlobal($varName)) {
         continue;
       }
 
       // Are we a numeric variable used for constructs like preg_replace?
-      if ($this->checkForNumericVariable($varName)) {
+      if ($this->isVariableANumericVariable($varName)) {
         continue;
       }