Merge pull request #1021 from PHPCSStandards/phpcs-4.0/feature/500-tokens-change-properties-to-constants

Tokens: introduce class constants to replace the static properties and start using them

Author: jrfnl

scripts/build-phar.php

@@ -63,7 +63,7 @@ function stripWhitespaceAndComments($fullpath, $config)
  continue;
  }
 
- if (isset(Tokens::$emptyTokens[$token['code']]) === false) {
+ if (isset(Tokens::EMPTY_TOKENS[$token['code']]) === false) {
  $stripped .= $token['content'];
  continue;
  }

src/Files/File.php

@@ -1560,7 +1560,7 @@ public function getMethodParameters($stackPtr)
  $paramCount++;
  break;
  case T_EQUAL:
- $defaultStart = $this->findNext(Tokens::$emptyTokens, ($i + 1), null, true);
+ $defaultStart = $this->findNext(Tokens::EMPTY_TOKENS, ($i + 1), null, true);
  $equalToken = $i;
  break;
  }//end switch
@@ -1676,7 +1676,7 @@ public function getMethodProperties($stackPtr)
  $scopeOpener = $this->tokens[$stackPtr]['scope_opener'];
  }
 
- $valid = Tokens::$nameTokens;
+ $valid = Tokens::NAME_TOKENS;
  $valid += [
  T_CALLABLE => T_CALLABLE,
  T_SELF => T_SELF,
@@ -1794,7 +1794,7 @@ public function getMemberProperties($stackPtr)
  $conditions = array_keys($conditions);
  $ptr = array_pop($conditions);
  if (isset($this->tokens[$ptr]) === false
- || isset(Tokens::$ooScopeTokens[$this->tokens[$ptr]['code']]) === false
+ || isset(Tokens::OO_SCOPE_TOKENS[$this->tokens[$ptr]['code']]) === false
  || $this->tokens[$ptr]['code'] === T_ENUM
  ) {
  throw new RuntimeException('$stackPtr is not a class member var');
@@ -1822,7 +1822,7 @@ public function getMemberProperties($stackPtr)
  T_FINAL => T_FINAL,
  ];
 
- $valid += Tokens::$emptyTokens;
+ $valid += Tokens::EMPTY_TOKENS;
 
  $scope = 'public';
  $scopeSpecified = false;
@@ -1877,7 +1877,7 @@ public function getMemberProperties($stackPtr)
 
  if ($i < $stackPtr) {
  // We've found a type.
- $valid = Tokens::$nameTokens;
+ $valid = Tokens::NAME_TOKENS;
  $valid += [
  T_CALLABLE => T_CALLABLE,
  T_SELF => T_SELF,
@@ -2014,7 +2014,7 @@ public function isReference($stackPtr)
  }
 
  $tokenBefore = $this->findPrevious(
- Tokens::$emptyTokens,
+ Tokens::EMPTY_TOKENS,
  ($stackPtr - 1),
  null,
  true
@@ -2038,14 +2038,14 @@ public function isReference($stackPtr)
  return true;
  }
 
- if (isset(Tokens::$assignmentTokens[$this->tokens[$tokenBefore]['code']]) === true) {
+ if (isset(Tokens::ASSIGNMENT_TOKENS[$this->tokens[$tokenBefore]['code']]) === true) {
  // This is directly after an assignment. It's a reference. Even if
  // it is part of an operation, the other tests will handle it.
  return true;
  }
 
  $tokenAfter = $this->findNext(
- Tokens::$emptyTokens,
+ Tokens::EMPTY_TOKENS,
  ($stackPtr + 1),
  null,
  true
@@ -2084,8 +2084,8 @@ public function isReference($stackPtr)
  if ($this->tokens[$tokenAfter]['code'] === T_VARIABLE) {
  return true;
  } else {
- $skip = Tokens::$emptyTokens;
- $skip += Tokens::$nameTokens;
+ $skip = Tokens::EMPTY_TOKENS;
+ $skip += Tokens::NAME_TOKENS;
  $skip[] = T_SELF;
  $skip[] = T_PARENT;
  $skip[] = T_STATIC;
@@ -2309,7 +2309,7 @@ public function findNext(
  */
  public function findStartOfStatement($start, $ignore=null)
  {
- $startTokens = Tokens::$blockOpeners;
+ $startTokens = Tokens::BLOCK_OPENERS;
  $startTokens[T_OPEN_SHORT_ARRAY] = true;
  $startTokens[T_OPEN_TAG] = true;
  $startTokens[T_OPEN_TAG_WITH_ECHO] = true;
@@ -2395,7 +2395,7 @@ public function findStartOfStatement($start, $ignore=null)
  // If it is the scope opener, go the first non-empty token after. $start will have been part of the first condition.
  if ($prevMatch <= $this->tokens[$matchExpression]['scope_opener']) {
  // We're before the arrow in the first case.
- $next = $this->findNext(Tokens::$emptyTokens, ($this->tokens[$matchExpression]['scope_opener'] + 1), null, true);
+ $next = $this->findNext(Tokens::EMPTY_TOKENS, ($this->tokens[$matchExpression]['scope_opener'] + 1), null, true);
  if ($next === false) {
  // Shouldn't be possible.
  return $start;
@@ -2412,7 +2412,7 @@ public function findStartOfStatement($start, $ignore=null)
  }
 
  // In both cases, go to the first non-empty token after.
- $next = $this->findNext(Tokens::$emptyTokens, ($prevMatch + 1), null, true);
+ $next = $this->findNext(Tokens::EMPTY_TOKENS, ($prevMatch + 1), null, true);
  if ($next === false) {
  // Shouldn't be possible.
  return $start;
@@ -2480,7 +2480,7 @@ public function findStartOfStatement($start, $ignore=null)
  }
  }//end if
 
- if (isset(Tokens::$emptyTokens[$this->tokens[$i]['code']]) === false) {
+ if (isset(Tokens::EMPTY_TOKENS[$this->tokens[$i]['code']]) === false) {
  $lastNotEmpty = $i;
  }
  }//end for
@@ -2575,7 +2575,7 @@ public function findEndOfStatement($start, $ignore=null)
  continue;
  }
 
- if ($i === $start && isset(Tokens::$scopeOpeners[$this->tokens[$i]['code']]) === true) {
+ if ($i === $start && isset(Tokens::SCOPE_OPENERS[$this->tokens[$i]['code']]) === true) {
  return $this->tokens[$i]['scope_closer'];
  }
 
@@ -2595,7 +2595,7 @@ public function findEndOfStatement($start, $ignore=null)
  }
  }//end if
 
- if (isset(Tokens::$emptyTokens[$this->tokens[$i]['code']]) === false) {
+ if (isset(Tokens::EMPTY_TOKENS[$this->tokens[$i]['code']]) === false) {
  $lastNotEmpty = $i;
  }
  }//end for
@@ -2778,7 +2778,7 @@ public function findExtendedClassName($stackPtr)
  return false;
  }
 
- $find = Tokens::$nameTokens;
+ $find = Tokens::NAME_TOKENS;
  $find[] = T_WHITESPACE;
 
  $end = $this->findNext($find, ($extendsIndex + 1), ($classOpenerIndex + 1), true);
@@ -2827,7 +2827,7 @@ public function findImplementedInterfaceNames($stackPtr)
  return false;
  }
 
- $find = Tokens::$nameTokens;
+ $find = Tokens::NAME_TOKENS;
  $find[] = T_WHITESPACE;
  $find[] = T_COMMA;
 

src/Sniffs/AbstractArraySniff.php

@@ -60,7 +60,7 @@ public function process(File $phpcsFile, $stackPtr)
  $arrayEnd = $tokens[$stackPtr]['bracket_closer'];
  }
 
- $lastContent = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($arrayEnd - 1), null, true);
+ $lastContent = $phpcsFile->findPrevious(Tokens::EMPTY_TOKENS, ($arrayEnd - 1), null, true);
  if ($tokens[$lastContent]['code'] === T_COMMA) {
  // Last array item ends with a comma.
  $phpcsFile->recordMetric($stackPtr, 'Array end comma', 'yes');
@@ -71,12 +71,12 @@ public function process(File $phpcsFile, $stackPtr)
  $indices = [];
 
  $current = $arrayStart;
- while (($next = $phpcsFile->findNext(Tokens::$emptyTokens, ($current + 1), $arrayEnd, true)) !== false) {
+ while (($next = $phpcsFile->findNext(Tokens::EMPTY_TOKENS, ($current + 1), $arrayEnd, true)) !== false) {
  $end = $this->getNext($phpcsFile, $next, $arrayEnd);
 
  if ($tokens[$end]['code'] === T_DOUBLE_ARROW) {
  $indexEnd = $phpcsFile->findPrevious(T_WHITESPACE, ($end - 1), null, true);
- $valueStart = $phpcsFile->findNext(Tokens::$emptyTokens, ($end + 1), null, true);
+ $valueStart = $phpcsFile->findNext(Tokens::EMPTY_TOKENS, ($end + 1), null, true);
 
  $indices[] = [
  'index_start' => $next,

src/Sniffs/AbstractPatternSniff.php

@@ -256,7 +256,7 @@ protected function processPattern($patternInfo, File $phpcsFile, $stackPtr)
 
  $ignoreTokens = [T_WHITESPACE => T_WHITESPACE];
  if ($this->ignoreComments === true) {
- $ignoreTokens += Tokens::$commentTokens;
+ $ignoreTokens += Tokens::COMMENT_TOKENS;
  }
 
  $origStackPtr = $stackPtr;
@@ -350,10 +350,10 @@ protected function processPattern($patternInfo, File $phpcsFile, $stackPtr)
  $found = 'abc';
  } else if ($pattern[$i]['type'] === 'newline') {
  if ($this->ignoreComments === true
- && isset(Tokens::$commentTokens[$tokens[$stackPtr]['code']]) === true
+ && isset(Tokens::COMMENT_TOKENS[$tokens[$stackPtr]['code']]) === true
  ) {
  $startComment = $phpcsFile->findPrevious(
- Tokens::$commentTokens,
+ Tokens::COMMENT_TOKENS,
  ($stackPtr - 1),
  null,
  true
@@ -381,7 +381,7 @@ protected function processPattern($patternInfo, File $phpcsFile, $stackPtr)
  // can ignore the error here.
  if (($tokens[($stackPtr - 1)]['content'] !== $phpcsFile->eolChar)
  && ($this->ignoreComments === true
- && isset(Tokens::$commentTokens[$tokens[($stackPtr - 1)]['code']]) === false)
+ && isset(Tokens::COMMENT_TOKENS[$tokens[($stackPtr - 1)]['code']]) === false)
  ) {
  $hasError = true;
  } else {
@@ -425,15 +425,15 @@ protected function processPattern($patternInfo, File $phpcsFile, $stackPtr)
  if ($this->ignoreComments === true) {
  // If we are ignoring comments, check to see if this current
  // token is a comment. If so skip it.
- if (isset(Tokens::$commentTokens[$tokens[$stackPtr]['code']]) === true) {
+ if (isset(Tokens::COMMENT_TOKENS[$tokens[$stackPtr]['code']]) === true) {
  continue;
  }
 
  // If the next token is a comment, the we need to skip the
  // current token as we should allow a space before a
  // comment for readability.
  if (isset($tokens[($stackPtr + 1)]) === true
- && isset(Tokens::$commentTokens[$tokens[($stackPtr + 1)]['code']]) === true
+ && isset(Tokens::COMMENT_TOKENS[$tokens[($stackPtr + 1)]['code']]) === true
  ) {
  continue;
  }
@@ -448,7 +448,7 @@ protected function processPattern($patternInfo, File $phpcsFile, $stackPtr)
  } else {
  // Get all the whitespace to the next token.
  $next = $phpcsFile->findNext(
- Tokens::$emptyTokens,
+ Tokens::EMPTY_TOKENS,
  $stackPtr,
  null,
  true
@@ -535,7 +535,7 @@ protected function processPattern($patternInfo, File $phpcsFile, $stackPtr)
  $hasComment = false;
  for ($j = $stackPtr; $j < $next; $j++) {
  $found .= $tokens[$j]['content'];
- if (isset(Tokens::$commentTokens[$tokens[$j]['code']]) === true) {
+ if (isset(Tokens::COMMENT_TOKENS[$tokens[$j]['code']]) === true) {
  $hasComment = true;
  }
  }
@@ -590,7 +590,7 @@ protected function processPattern($patternInfo, File $phpcsFile, $stackPtr)
  } else {
  // Find the previous opener.
  $next = $phpcsFile->findPrevious(
- Tokens::$blockOpeners,
+ Tokens::BLOCK_OPENERS,
  $stackPtr
  );
 
@@ -640,7 +640,7 @@ protected function processPattern($patternInfo, File $phpcsFile, $stackPtr)
  } else {
  if ($this->ignoreComments === false) {
  // The newline character cannot be part of a comment.
- if (isset(Tokens::$commentTokens[$tokens[$newline]['code']]) === true) {
+ if (isset(Tokens::COMMENT_TOKENS[$tokens[$newline]['code']]) === true) {
  $hasError = true;
  }
  }

src/Sniffs/AbstractVariableSniff.php

@@ -49,7 +49,7 @@ abstract class AbstractVariableSniff extends AbstractScopeSniff
  */
  public function __construct()
  {
- $scopes = Tokens::$ooScopeTokens;
+ $scopes = Tokens::OO_SCOPE_TOKENS;
 
  $listen = [
  T_VARIABLE,
@@ -97,7 +97,7 @@ final protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $cu
  $conditions = array_reverse($tokens[$stackPtr]['conditions'], true);
  $inFunction = false;
  foreach ($conditions as $scope => $code) {
- if (isset(Tokens::$ooScopeTokens[$code]) === true) {
+ if (isset(Tokens::OO_SCOPE_TOKENS[$code]) === true) {
  break;
  }
 

src/Standards/Generic/Sniffs/Arrays/ArrayIndentSniff.php

@@ -60,7 +60,7 @@ public function processMultiLineArray($phpcsFile, $stackPtr, $arrayStart, $array
  $tokens = $phpcsFile->getTokens();
 
  // Determine how far indented the entire array declaration should be.
- $ignore = Tokens::$emptyTokens;
+ $ignore = Tokens::EMPTY_TOKENS;
  $ignore[] = T_DOUBLE_ARROW;
  $prev = $phpcsFile->findPrevious($ignore, ($stackPtr - 1), null, true);
  $start = $phpcsFile->findStartOfStatement($prev);
@@ -108,7 +108,7 @@ public function processMultiLineArray($phpcsFile, $stackPtr, $arrayStart, $array
  $start = $index['value_start'];
  }
 
- $prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($start - 1), null, true);
+ $prev = $phpcsFile->findPrevious(Tokens::EMPTY_TOKENS, ($start - 1), null, true);
  if ($tokens[$prev]['line'] === $tokens[$start]['line']) {
  // This index isn't the only content on the line
  // so we can't check indent rules.

src/Standards/Generic/Sniffs/Classes/DuplicateClassNameSniff.php

@@ -62,7 +62,7 @@ public function process(File $phpcsFile, $stackPtr)
  while ($stackPtr !== false) {
  // Keep track of what namespace we are in.
  if ($tokens[$stackPtr]['code'] === T_NAMESPACE) {
- $nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);
+ $nextNonEmpty = $phpcsFile->findNext(Tokens::EMPTY_TOKENS, ($stackPtr + 1), null, true);
  if ($nextNonEmpty !== false) {
  if ($tokens[$nextNonEmpty]['code'] === T_STRING
  || $tokens[$nextNonEmpty]['code'] === T_NAME_QUALIFIED

src/Standards/Generic/Sniffs/CodeAnalysis/AssignmentInConditionSniff.php

@@ -44,10 +44,10 @@ class AssignmentInConditionSniff implements Sniff
  */
  public function register()
  {
- $this->assignmentTokens = Tokens::$assignmentTokens;
+ $this->assignmentTokens = Tokens::ASSIGNMENT_TOKENS;
  unset($this->assignmentTokens[T_DOUBLE_ARROW]);
 
- $starters = Tokens::$booleanOperators;
+ $starters = Tokens::BOOLEAN_OPERATORS;
  $starters[T_SEMICOLON] = T_SEMICOLON;
  $starters[T_OPEN_PARENTHESIS] = T_OPEN_PARENTHESIS;
 
@@ -133,7 +133,7 @@ public function process(File $phpcsFile, $stackPtr)
  }
 
  for ($i = $hasAssignment; $i > $conditionStart; $i--) {
- if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === true) {
+ if (isset(Tokens::EMPTY_TOKENS[$tokens[$i]['code']]) === true) {
  continue;
  }
 

src/Standards/Generic/Sniffs/CodeAnalysis/EmptyPHPStatementSniff.php

@@ -70,7 +70,7 @@ private function processSemicolon(File $phpcsFile, $stackPtr)
  {
  $tokens = $phpcsFile->getTokens();
 
- $prevNonEmpty = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true);
+ $prevNonEmpty = $phpcsFile->findPrevious(Tokens::EMPTY_TOKENS, ($stackPtr - 1), null, true);
  if ($tokens[$prevNonEmpty]['code'] !== T_SEMICOLON
  && $tokens[$prevNonEmpty]['code'] !== T_OPEN_TAG
  && $tokens[$prevNonEmpty]['code'] !== T_OPEN_TAG_WITH_ECHO

src/Standards/Generic/Sniffs/CodeAnalysis/EmptyStatementSniff.php

@@ -76,7 +76,7 @@ public function process(File $phpcsFile, $stackPtr)
  }
 
  $next = $phpcsFile->findNext(
- Tokens::$emptyTokens,
+ Tokens::EMPTY_TOKENS,
  ($token['scope_opener'] + 1),
  ($token['scope_closer'] - 1),
  true