gravityview / GravityView

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Tests/VersionControl/GitMergeConflictUnitTest.3.inc

Doc Comments +1 added lines, -19 removed lines

@@ -22,22 +22,4 @@
 <<<<<<< HEAD
 $a = 1;
 =======
-$a = 2;
->>>>>>> master
-
-/*
- * The above tests are based on "normal" tokens.
- * The below test checks that once the tokenizer breaks down because of
- * unexpected merge conflict boundaries - i.e. after the first merge conflict
- * opener in non-comment, non-heredoc/nowdoc, non-inline HTML code -, subsequent
- * merge conflict boundaries will still be detected correctly.
- */
-?>
-
-<div class="abc">
-<<<<<<< HEAD
-	<p id="test-this">Testing a merge conflict.</p>
-=======
-	<p id="test-that">Another text string.</p>
->>>>>>> ref/heads/feature-branch
-</div>
+$a
\ No newline at end of file

Indentation +1 added lines, -19 removed lines

@@ -22,22 +22,4 @@
 <<<<<<< HEAD
 $a = 1;
 =======
-$a = 2;
->>>>>>> master
-
-/*
- * The above tests are based on "normal" tokens.
- * The below test checks that once the tokenizer breaks down because of
- * unexpected merge conflict boundaries - i.e. after the first merge conflict
- * opener in non-comment, non-heredoc/nowdoc, non-inline HTML code -, subsequent
- * merge conflict boundaries will still be detected correctly.
- */
-?>
-
-<div class="abc">
-<<<<<<< HEAD
-	<p id="test-this">Testing a merge conflict.</p>
-=======
-	<p id="test-that">Another text string.</p>
->>>>>>> ref/heads/feature-branch
-</div>
+$a
\ No newline at end of file

Switch Indentation +1 added lines, -19 removed lines

@@ -22,22 +22,4 @@
 <<<<<<< HEAD
 $a = 1;
 =======
-$a = 2;
->>>>>>> master
-
-/*
- * The above tests are based on "normal" tokens.
- * The below test checks that once the tokenizer breaks down because of
- * unexpected merge conflict boundaries - i.e. after the first merge conflict
- * opener in non-comment, non-heredoc/nowdoc, non-inline HTML code -, subsequent
- * merge conflict boundaries will still be detected correctly.
- */
-?>
-
-<div class="abc">
-<<<<<<< HEAD
-	<p id="test-this">Testing a merge conflict.</p>
-=======
-	<p id="test-that">Another text string.</p>
->>>>>>> ref/heads/feature-branch
-</div>
+$a
\ No newline at end of file

Spacing +2 added lines, -20 removed lines

@@ -19,25 +19,7 @@
 <?php
 
 // Break the tokenizer.
-<<<<<<< HEAD
+<< << <<< HEAD
 $a = 1;
 =======
-$a = 2;
->>>>>>> master
-
-/*
- * The above tests are based on "normal" tokens.
- * The below test checks that once the tokenizer breaks down because of
- * unexpected merge conflict boundaries - i.e. after the first merge conflict
- * opener in non-comment, non-heredoc/nowdoc, non-inline HTML code -, subsequent
- * merge conflict boundaries will still be detected correctly.
- */
-?>
-
-<div class="abc">
-<<<<<<< HEAD
-	<p id="test-this">Testing a merge conflict.</p>
-=======
-	<p id="test-that">Another text string.</p>
->>>>>>> ref/heads/feature-branch
-</div>
+$a
\ No newline at end of file

Braces +1 added lines, -19 removed lines

@@ -22,22 +22,4 @@
 <<<<<<< HEAD
 $a = 1;
 =======
-$a = 2;
->>>>>>> master
-
-/*
- * The above tests are based on "normal" tokens.
- * The below test checks that once the tokenizer breaks down because of
- * unexpected merge conflict boundaries - i.e. after the first merge conflict
- * opener in non-comment, non-heredoc/nowdoc, non-inline HTML code -, subsequent
- * merge conflict boundaries will still be detected correctly.
- */
-?>
-
-<div class="abc">
-<<<<<<< HEAD
-	<p id="test-this">Testing a merge conflict.</p>
-=======
-	<p id="test-that">Another text string.</p>
->>>>>>> ref/heads/feature-branch
-</div>
+$a
\ No newline at end of file

Upper-Lower-Casing +1 added lines, -19 removed lines

@@ -22,22 +22,4 @@
 <<<<<<< HEAD
 $a = 1;
 =======
-$a = 2;
->>>>>>> master
-
-/*
- * The above tests are based on "normal" tokens.
- * The below test checks that once the tokenizer breaks down because of
- * unexpected merge conflict boundaries - i.e. after the first merge conflict
- * opener in non-comment, non-heredoc/nowdoc, non-inline HTML code -, subsequent
- * merge conflict boundaries will still be detected correctly.
- */
-?>
-
-<div class="abc">
-<<<<<<< HEAD
-	<p id="test-this">Testing a merge conflict.</p>
-=======
-	<p id="test-that">Another text string.</p>
->>>>>>> ref/heads/feature-branch
-</div>
+$a
\ No newline at end of file

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Tests/VersionControl/GitMergeConflictUnitTest.4.inc

Doc Comments +1 added lines, -5 removed lines

@@ -64,8 +64,4 @@
 <<<<<<< HEAD
 can be problematic.
 EOD;
-$a = 1;
-=======
-should also be detected.
-EOT;
->>>>>>> ref/heads/other-branchname
+$a
\ No newline at end of file

Indentation +1 added lines, -5 removed lines

@@ -64,8 +64,4 @@
 <<<<<<< HEAD
 can be problematic.
 EOD;
-$a = 1;
-=======
-should also be detected.
-EOT;
->>>>>>> ref/heads/other-branchname
+$a
\ No newline at end of file

Switch Indentation +1 added lines, -5 removed lines

@@ -64,8 +64,4 @@
 <<<<<<< HEAD
 can be problematic.
 EOD;
-$a = 1;
-=======
-should also be detected.
-EOT;
->>>>>>> ref/heads/other-branchname
+$a
\ No newline at end of file

Spacing +3 added lines, -7 removed lines

@@ -22,11 +22,11 @@ 
 =======
 should also be detected.
 EOT;
->>>>>>> ref/heads/other-branchname
+>> >> >> > ref / heads / other - branchname
 
 // Merge conflict starter outside with a closer inside of the heredoc.
 // This breaks the tokenizer.
-<<<<<<< HEAD
+<< << <<< HEAD
 $string =
 <<<EOT
 Merge conflicts in heredocs
@@ -64,8 +64,4 @@ 
 <<<<<<< HEAD
 can be problematic.
 EOD;
-$a = 1;
-=======
-should also be detected.
-EOT;
->>>>>>> ref/heads/other-branchname
+$a
\ No newline at end of file

Braces +1 added lines, -5 removed lines

@@ -64,8 +64,4 @@
 <<<<<<< HEAD
 can be problematic.
 EOD;
-$a = 1;
-=======
-should also be detected.
-EOT;
->>>>>>> ref/heads/other-branchname
+$a
\ No newline at end of file

Upper-Lower-Casing +3 added lines, -7 removed lines

@@ -9,7 +9,7 @@ 
 should also be detected.
 >>>>>>> ref/heads/other-branchname
 And now they are.
-EOD;
+eod;
 
 // Heredoc with a merge conflict starter, the closer is outside the heredoc.
 $string =
@@ -21,7 +21,7 @@ 
 $a = 1;
 =======
 should also be detected.
-EOT;
+eot;
 >>>>>>> ref/heads/other-branchname
 
 // Merge conflict starter outside with a closer inside of the heredoc.
@@ -64,8 +64,4 @@ 
 <<<<<<< HEAD
 can be problematic.
 EOD;
-$a = 1;
-=======
-should also be detected.
-EOT;
->>>>>>> ref/heads/other-branchname
+$a
\ No newline at end of file

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Tests/VersionControl/GitMergeConflictUnitTest.5.inc

Doc Comments +1 added lines, -10 removed lines

@@ -22,13 +22,4 @@
  * merge conflict boundaries will still be detected correctly.
  */
 
-$string =
-<<<'EOD'
-can be problematic.
-<<<<<<< HEAD
-were previously not detected.
-=======
-should also be detected.
->>>>>>> ref/heads/other-branchname
-And now they are.
-EOD;
+$string
\ No newline at end of file

Indentation +1 added lines, -10 removed lines

@@ -22,13 +22,4 @@
  * merge conflict boundaries will still be detected correctly.
  */
 
-$string =
-<<<'EOD'
-can be problematic.
-<<<<<<< HEAD
-were previously not detected.
-=======
-should also be detected.
->>>>>>> ref/heads/other-branchname
-And now they are.
-EOD;
+$string
\ No newline at end of file

Switch Indentation +1 added lines, -10 removed lines

@@ -22,13 +22,4 @@
  * merge conflict boundaries will still be detected correctly.
  */
 
-$string =
-<<<'EOD'
-can be problematic.
-<<<<<<< HEAD
-were previously not detected.
-=======
-should also be detected.
->>>>>>> ref/heads/other-branchname
-And now they are.
-EOD;
+$string
\ No newline at end of file

Spacing +2 added lines, -11 removed lines

@@ -12,7 +12,7 @@ 
 EOD;
 
 // Break the tokenizer.
-<<<<<<< HEAD
+<< << <<< HEAD
 
 /*
  * The above tests are based on "normal" tokens.
@@ -22,13 +22,4 @@ 
  * merge conflict boundaries will still be detected correctly.
  */
 
-$string =
-<<<'EOD'
-can be problematic.
-<<<<<<< HEAD
-were previously not detected.
-=======
-should also be detected.
->>>>>>> ref/heads/other-branchname
-And now they are.
-EOD;
+$string
\ No newline at end of file

Braces +1 added lines, -10 removed lines

@@ -22,13 +22,4 @@
  * merge conflict boundaries will still be detected correctly.
  */
 
-$string =
-<<<'EOD'
-can be problematic.
-<<<<<<< HEAD
-were previously not detected.
-=======
-should also be detected.
->>>>>>> ref/heads/other-branchname
-And now they are.
-EOD;
+$string
\ No newline at end of file

Upper-Lower-Casing +2 added lines, -11 removed lines

@@ -9,7 +9,7 @@ 
 should also be detected.
 >>>>>>> ref/heads/other-branchname
 And now they are.
-EOD;
+eod;
 
 // Break the tokenizer.
 <<<<<<< HEAD
@@ -22,13 +22,4 @@ 
  * merge conflict boundaries will still be detected correctly.
  */
 
-$string =
-<<<'EOD'
-can be problematic.
-<<<<<<< HEAD
-were previously not detected.
-=======
-should also be detected.
->>>>>>> ref/heads/other-branchname
-And now they are.
-EOD;
+$string
\ No newline at end of file

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Tests/VersionControl/GitMergeConflictUnitTest.6.inc

Doc Comments +1 added lines, -10 removed lines

@@ -22,13 +22,4 @@
  * merge conflict boundaries will still be detected correctly.
  */
 
-$string =
-		<<<"EOD"
-		Merge conflicts in PHP 7.3 indented heredocs
-<<<<<<< HEAD
-		can be problematic.
-=======
-		should also be detected.
->>>>>>> ref/heads/other-branchname
-		And now they are.
-		EOD;
+$string
\ No newline at end of file

Indentation +1 added lines, -10 removed lines

@@ -22,13 +22,4 @@
  * merge conflict boundaries will still be detected correctly.
  */
 
-$string =
-		<<<"EOD"
-		Merge conflicts in PHP 7.3 indented heredocs
-<<<<<<< HEAD
-		can be problematic.
-=======
-		should also be detected.
->>>>>>> ref/heads/other-branchname
-		And now they are.
-		EOD;
+$string
\ No newline at end of file

Switch Indentation +1 added lines, -10 removed lines

@@ -22,13 +22,4 @@
  * merge conflict boundaries will still be detected correctly.
  */
 
-$string =
-		<<<"EOD"
-		Merge conflicts in PHP 7.3 indented heredocs
-<<<<<<< HEAD
-		can be problematic.
-=======
-		should also be detected.
->>>>>>> ref/heads/other-branchname
-		And now they are.
-		EOD;
+$string
\ No newline at end of file

Spacing +1 added lines, -10 removed lines

@@ -22,13 +22,4 @@
  * merge conflict boundaries will still be detected correctly.
  */
 
-$string =
-		<<<"EOD"
-		Merge conflicts in PHP 7.3 indented heredocs
-<<<<<<< HEAD
-		can be problematic.
-=======
-		should also be detected.
->>>>>>> ref/heads/other-branchname
-		And now they are.
-		EOD;
+$string
\ No newline at end of file

Braces +1 added lines, -10 removed lines

@@ -22,13 +22,4 @@
  * merge conflict boundaries will still be detected correctly.
  */
 
-$string =
-		<<<"EOD"
-		Merge conflicts in PHP 7.3 indented heredocs
-<<<<<<< HEAD
-		can be problematic.
-=======
-		should also be detected.
->>>>>>> ref/heads/other-branchname
-		And now they are.
-		EOD;
+$string
\ No newline at end of file

Upper-Lower-Casing +1 added lines, -10 removed lines

@@ -22,13 +22,4 @@
  * merge conflict boundaries will still be detected correctly.
  */
 
-$string =
-		<<<"EOD"
-		Merge conflicts in PHP 7.3 indented heredocs
-<<<<<<< HEAD
-		can be problematic.
-=======
-		should also be detected.
->>>>>>> ref/heads/other-branchname
-		And now they are.
-		EOD;
+$string
\ No newline at end of file

vendor/squizlabs/php_codesniffer/src/Standards/MySource/Sniffs/Channels/IncludeOwnSystemSniff.php

Doc Comments +2 added lines, -2 removed lines

@@ -19,7 +19,7 @@ 
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return integer[]
      */
     public function register()
     {
@@ -82,7 +82,7 @@ 
      * @param int                         $stackPtr  The position in the tokens array of the
      *                                               potentially included class.
      *
-     * @return string
+     * @return boolean
      */
     protected function getIncludedClassFromToken(
         $phpcsFile,

Indentation +77 added lines, -77 removed lines

@@ -16,83 +16,83 @@
 {
 
 
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return [T_DOUBLE_COLON];
-
-    }//end register()
-
-
-    /**
-     * Processes this sniff, when one of its tokens is encountered.
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
-     * @param int                         $stackPtr  The position of the current token in
-     *                                               the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(File $phpcsFile, $stackPtr)
-    {
-        $fileName = $phpcsFile->getFilename();
-        $matches  = [];
-        if (preg_match('|/systems/(.*)/([^/]+)?actions.inc$|i', $fileName, $matches) === 0) {
-            // Not an actions file.
-            return;
-        }
-
-        $ownClass = $matches[2];
-        $tokens   = $phpcsFile->getTokens();
-
-        $typeName = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($stackPtr + 2), null, false, true);
-        $typeName = trim($tokens[$typeName]['content'], " '");
-        switch (strtolower($tokens[($stackPtr + 1)]['content'])) {
-        case 'includesystem' :
-            $included = strtolower($typeName);
-            break;
-        case 'includeasset' :
-            $included = strtolower($typeName).'assettype';
-            break;
-        case 'includewidget' :
-            $included = strtolower($typeName).'widgettype';
-            break;
-        default:
-            return;
-        }
-
-        if ($included === strtolower($ownClass)) {
-            $error = "You do not need to include \"%s\" from within the system's own actions file";
-            $data  = [$ownClass];
-            $phpcsFile->addError($error, $stackPtr, 'NotRequired', $data);
-        }
-
-    }//end process()
-
-
-    /**
-     * Determines the included class name from given token.
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
-     * @param array                       $tokens    The array of file tokens.
-     * @param int                         $stackPtr  The position in the tokens array of the
-     *                                               potentially included class.
-     *
-     * @return string
-     */
-    protected function getIncludedClassFromToken(
-        $phpcsFile,
-        array $tokens,
-        $stackPtr
-    ) {
-
-        return false;
-
-    }//end getIncludedClassFromToken()
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		return [T_DOUBLE_COLON];
+
+	}//end register()
+
+
+	/**
+	 * Processes this sniff, when one of its tokens is encountered.
+	 *
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
+	 * @param int                         $stackPtr  The position of the current token in
+	 *                                               the stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	public function process(File $phpcsFile, $stackPtr)
+	{
+		$fileName = $phpcsFile->getFilename();
+		$matches  = [];
+		if (preg_match('|/systems/(.*)/([^/]+)?actions.inc$|i', $fileName, $matches) === 0) {
+			// Not an actions file.
+			return;
+		}
+
+		$ownClass = $matches[2];
+		$tokens   = $phpcsFile->getTokens();
+
+		$typeName = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($stackPtr + 2), null, false, true);
+		$typeName = trim($tokens[$typeName]['content'], " '");
+		switch (strtolower($tokens[($stackPtr + 1)]['content'])) {
+		case 'includesystem' :
+			$included = strtolower($typeName);
+			break;
+		case 'includeasset' :
+			$included = strtolower($typeName).'assettype';
+			break;
+		case 'includewidget' :
+			$included = strtolower($typeName).'widgettype';
+			break;
+		default:
+			return;
+		}
+
+		if ($included === strtolower($ownClass)) {
+			$error = "You do not need to include \"%s\" from within the system's own actions file";
+			$data  = [$ownClass];
+			$phpcsFile->addError($error, $stackPtr, 'NotRequired', $data);
+		}
+
+	}//end process()
+
+
+	/**
+	 * Determines the included class name from given token.
+	 *
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
+	 * @param array                       $tokens    The array of file tokens.
+	 * @param int                         $stackPtr  The position in the tokens array of the
+	 *                                               potentially included class.
+	 *
+	 * @return string
+	 */
+	protected function getIncludedClassFromToken(
+		$phpcsFile,
+		array $tokens,
+		$stackPtr
+	) {
+
+		return false;
+
+	}//end getIncludedClassFromToken()
 
 
 }//end class

Switch Indentation +11 added lines, -11 removed lines

@@ -52,17 +52,17 @@
         $typeName = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($stackPtr + 2), null, false, true);
         $typeName = trim($tokens[$typeName]['content'], " '");
         switch (strtolower($tokens[($stackPtr + 1)]['content'])) {
-        case 'includesystem' :
-            $included = strtolower($typeName);
-            break;
-        case 'includeasset' :
-            $included = strtolower($typeName).'assettype';
-            break;
-        case 'includewidget' :
-            $included = strtolower($typeName).'widgettype';
-            break;
-        default:
-            return;
+        	case 'includesystem' :
+            	$included = strtolower($typeName);
+            	break;
+        	case 'includeasset' :
+            	$included = strtolower($typeName).'assettype';
+            	break;
+        	case 'includewidget' :
+            	$included = strtolower($typeName).'widgettype';
+            	break;
+        	default:
+            	return;
         }
 
         if ($included === strtolower($ownClass)) {

Spacing +14 added lines, -14 removed lines

@@ -23,7 +23,7 @@ 
      */
     public function register()
     {
-        return [T_DOUBLE_COLON];
+        return [ T_DOUBLE_COLON ];
 
     }//end register()
 
@@ -37,38 +37,38 @@ 
      *
      * @return void
      */
-    public function process(File $phpcsFile, $stackPtr)
+    public function process( File $phpcsFile, $stackPtr )
     {
         $fileName = $phpcsFile->getFilename();
-        $matches  = [];
-        if (preg_match('|/systems/(.*)/([^/]+)?actions.inc$|i', $fileName, $matches) === 0) {
+        $matches  = [ ];
+        if ( preg_match( '|/systems/(.*)/([^/]+)?actions.inc$|i', $fileName, $matches ) === 0 ) {
             // Not an actions file.
             return;
         }
 
-        $ownClass = $matches[2];
+        $ownClass = $matches[ 2 ];
         $tokens   = $phpcsFile->getTokens();
 
-        $typeName = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($stackPtr + 2), null, false, true);
-        $typeName = trim($tokens[$typeName]['content'], " '");
-        switch (strtolower($tokens[($stackPtr + 1)]['content'])) {
+        $typeName = $phpcsFile->findNext( T_CONSTANT_ENCAPSED_STRING, ( $stackPtr + 2 ), null, false, true );
+        $typeName = trim( $tokens[ $typeName ][ 'content' ], " '" );
+        switch ( strtolower( $tokens[ ( $stackPtr + 1 ) ][ 'content' ] ) ) {
         case 'includesystem' :
-            $included = strtolower($typeName);
+            $included = strtolower( $typeName );
             break;
         case 'includeasset' :
-            $included = strtolower($typeName).'assettype';
+            $included = strtolower( $typeName ) . 'assettype';
             break;
         case 'includewidget' :
-            $included = strtolower($typeName).'widgettype';
+            $included = strtolower( $typeName ) . 'widgettype';
             break;
         default:
             return;
         }
 
-        if ($included === strtolower($ownClass)) {
+        if ( $included === strtolower( $ownClass ) ) {
             $error = "You do not need to include \"%s\" from within the system's own actions file";
-            $data  = [$ownClass];
-            $phpcsFile->addError($error, $stackPtr, 'NotRequired', $data);
+            $data  = [ $ownClass ];
+            $phpcsFile->addError( $error, $stackPtr, 'NotRequired', $data );
         }
 
     }//end process()

Braces +3 added lines, -6 removed lines

@@ -12,8 +12,7 @@ 
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Files\File;
 
-class IncludeOwnSystemSniff implements Sniff
-{
+class IncludeOwnSystemSniff implements Sniff {
 
 
     /**
@@ -21,8 +20,7 @@ 
      *
      * @return array
      */
-    public function register()
-    {
+    public function register() {
         return [T_DOUBLE_COLON];
 
     }//end register()
@@ -37,8 +35,7 @@ 
      *
      * @return void
      */
-    public function process(File $phpcsFile, $stackPtr)
-    {
+    public function process(File $phpcsFile, $stackPtr) {
         $fileName = $phpcsFile->getFilename();
         $matches  = [];
         if (preg_match('|/systems/(.*)/([^/]+)?actions.inc$|i', $fileName, $matches) === 0) {

vendor/squizlabs/php_codesniffer/src/Standards/MySource/Tests/Channels/DisallowSelfActionsUnitTest.inc

Doc Comments +3 added lines

@@ -35,6 +35,9 @@
 
 abstract class AbstractEditingScreenModeWidgetActions extends AbstractEditingModeWidgetActions {
 
+    /**
+     * @param string $systemName
+     */
     public static function getScreens($systemName)
     {
 

Indentation +37 added lines, -37 removed lines

@@ -2,50 +2,50 @@
 class SomethingActions
 {
 
-    private static function _x()
-    {
-    }
-
-
-    public static function y()
-    {
-        self::z();
-        static::z();
-        SomethingActions::z();
-        static::_x();
-        self::a();
-        static::a();
-    }
-
-
-    public static function z()
-    {
-    }
-
-    protected static function a()
-    {
-        self::a(); // recursion, yay!
-        self::z();
-        static::y();
-        self::b();
-        echo self::$_myVar;
-        echo static::$yourVar;
-    }
+	private static function _x()
+	{
+	}
+
+
+	public static function y()
+	{
+		self::z();
+		static::z();
+		SomethingActions::z();
+		static::_x();
+		self::a();
+		static::a();
+	}
+
+
+	public static function z()
+	{
+	}
+
+	protected static function a()
+	{
+		self::a(); // recursion, yay!
+		self::z();
+		static::y();
+		self::b();
+		echo self::$_myVar;
+		echo static::$yourVar;
+	}
 }
 
 abstract class AbstractEditingScreenModeWidgetActions extends AbstractEditingModeWidgetActions {
 
-    public static function getScreens($systemName)
-    {
+	public static function getScreens($systemName)
+	{
 
-    }//end getScreens()
+	}//end getScreens()
 
-    public static function setHelpScreenTitle()
-    {
-        // This is allowed because we are in an abstract class.
-        $screens = self::getScreens('');
+	public static function setHelpScreenTitle()
+	{
+		// This is allowed because we are in an abstract class.
+		$screens = self::getScreens('');
 
-    }//end setHelpScreenTitle()
+	}//end setHelpScreenTitle()
 
 }//end class
 ?>

Spacing +2 added lines, -2 removed lines

@@ -35,7 +35,7 @@ 
 
 abstract class AbstractEditingScreenModeWidgetActions extends AbstractEditingModeWidgetActions {
 
-    public static function getScreens($systemName)
+    public static function getScreens( $systemName )
     {
 
     }//end getScreens()
@@ -43,7 +43,7 @@ 
     public static function setHelpScreenTitle()
     {
         // This is allowed because we are in an abstract class.
-        $screens = self::getScreens('');
+        $screens = self::getScreens( '' );
 
     }//end setHelpScreenTitle()
 

Braces +7 added lines, -14 removed lines

@@ -1,14 +1,11 @@ 
 <?php
-class SomethingActions
-{
+class SomethingActions {
 
-    private static function _x()
-    {
+    private static function _x() {
     }
 
 
-    public static function y()
-    {
+    public static function y() {
         self::z();
         static::z();
         SomethingActions::z();
@@ -18,12 +15,10 @@ 
     }
 
 
-    public static function z()
-    {
+    public static function z() {
     }
 
-    protected static function a()
-    {
+    protected static function a() {
         self::a(); // recursion, yay!
         self::z();
         static::y();
@@ -35,13 +30,11 @@ 
 
 abstract class AbstractEditingScreenModeWidgetActions extends AbstractEditingModeWidgetActions {
 
-    public static function getScreens($systemName)
-    {
+    public static function getScreens($systemName) {
 
     }//end getScreens()
 
-    public static function setHelpScreenTitle()
-    {
+    public static function setHelpScreenTitle() {
         // This is allowed because we are in an abstract class.
         $screens = self::getScreens('');
 

vendor/squizlabs/php_codesniffer/src/Standards/PEAR/Tests/Commenting/FunctionCommentUnitTest.inc

Doc Comments +2 added lines, -3 removed lines

@@ -9,10 +9,10 @@ 
      *
      * @param int $stackPtr   The position in @ @unknown the stack of the token
      *                        that opened the scope
-     * @param int $detph    How many scope levels down we are.
+     * @param int $depth    How many scope levels down we are.
      * @param int    $index    The index
      * @return
-     * @throws
+     integer @throws
      */
     private function _functionCall($stackPtr, $depth=1, $index)
     {
@@ -121,7 +121,6 @@ 
      *
      * @return
      * @param   int   $threeSpaces
-     * @param int     $superfluous
      * @param missing
      * @param
      */

Indentation +161 added lines, -161 removed lines

@@ -2,148 +2,148 @@ 
 class PHP_CodeSniffer_File
 {
 
-    /**
-     * A simple function comment.
-     *
-     * long desc here
-     *
-     * @param int $stackPtr   The position in @ @unknown the stack of the token
-     *                        that opened the scope
-     * @param int $detph    How many scope levels down we are.
-     * @param int    $index    The index
-     * @return
-     * @throws
-     */
-    private function _functionCall($stackPtr, $depth=1, $index)
-    {
-        return $stackPtr;
-
-    }//end _functionCall()
-
-    //
-    // Sample function comment
-    //
-    //
-    //
-    public function invalidCommentStyle()
-    {
-
-    }//end invalidCommentStyle()
-
-
-    /**
-     *
-     *
-     * A simple function comment
-     *
-     *
-     * Long description with extra blank line before and after
-     *
-     *
-     * @return void
-     */
-    public function extraDescriptionNewlines()
-    {
-
-    }//end extraDescriptionNewlines()
-
-
-    /**
-     * A simple function comment
-     * @return void
-     */
-    public function missingNewlinesBeforeTags()
-    {
-
-    }//end missingNewlinesBeforeTags()
-
-
-    /**
-     * Access tag should not be treated as a long description
-     *
-     * @access public
-     * @return void
-     */
-    public function accessTag()
-    {
-
-    }//end accessTag()
-
-    /**
-     * Constructor
-     *
-     * No return tag
-     */
-    function PHP_CodeSniffer_File()
-    {
-        return;
-    }
-
-
-    /**
-     * Destructor
-     *
-     * No return tag too
-     */
-    function _PHP_CodeSniffer_File()
-    {
-        return;
-    }
-
-
-    /**
-     * Destructor PHP5
-     */
-    function __destruct()
-    {
-        return;
-    }
-
-
-    function missingComment()
-    {
-        return;
-    }
-
-
-    /**
-     * no return tag
-     *
-     */
-    public function noReturn($one)
-    {
-
-    }//end noReturn()
-
-
-    /**
-     * Param not immediate
-     *
-     * @return
-     * @param   int   $threeSpaces
-     * @param int     $superfluous
-     * @param missing
-     * @param
-     */
-    public function missingDescription($threeSpaces)
-    {
-
-    }//end missingDescription()
-
-
-    /**
-     * Param not immediate
-     *
-     * @param int      $one   comment
-     * @param int      $two   comment
-     * @param string   $three comment
-     *
-     * @return void
-     */
-    public function oneSpaceAfterLongestVar($one, $two, $three)
-    {
-
-    }//end oneSpaceAfterLongestVar()
+	/**
+	 * A simple function comment.
+	 *
+	 * long desc here
+	 *
+	 * @param int $stackPtr   The position in @ @unknown the stack of the token
+	 *                        that opened the scope
+	 * @param int $detph    How many scope levels down we are.
+	 * @param int    $index    The index
+	 * @return
+	 * @throws
+	 */
+	private function _functionCall($stackPtr, $depth=1, $index)
+	{
+		return $stackPtr;
+
+	}//end _functionCall()
+
+	//
+	// Sample function comment
+	//
+	//
+	//
+	public function invalidCommentStyle()
+	{
+
+	}//end invalidCommentStyle()
+
+
+	/**
+	 *
+	 *
+	 * A simple function comment
+	 *
+	 *
+	 * Long description with extra blank line before and after
+	 *
+	 *
+	 * @return void
+	 */
+	public function extraDescriptionNewlines()
+	{
+
+	}//end extraDescriptionNewlines()
+
+
+	/**
+	 * A simple function comment
+	 * @return void
+	 */
+	public function missingNewlinesBeforeTags()
+	{
+
+	}//end missingNewlinesBeforeTags()
+
+
+	/**
+	 * Access tag should not be treated as a long description
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function accessTag()
+	{
+
+	}//end accessTag()
+
+	/**
+	 * Constructor
+	 *
+	 * No return tag
+	 */
+	function PHP_CodeSniffer_File()
+	{
+		return;
+	}
+
+
+	/**
+	 * Destructor
+	 *
+	 * No return tag too
+	 */
+	function _PHP_CodeSniffer_File()
+	{
+		return;
+	}
+
+
+	/**
+	 * Destructor PHP5
+	 */
+	function __destruct()
+	{
+		return;
+	}
+
+
+	function missingComment()
+	{
+		return;
+	}
+
+
+	/**
+	 * no return tag
+	 *
+	 */
+	public function noReturn($one)
+	{
+
+	}//end noReturn()
+
+
+	/**
+	 * Param not immediate
+	 *
+	 * @return
+	 * @param   int   $threeSpaces
+	 * @param int     $superfluous
+	 * @param missing
+	 * @param
+	 */
+	public function missingDescription($threeSpaces)
+	{
+
+	}//end missingDescription()
+
+
+	/**
+	 * Param not immediate
+	 *
+	 * @param int      $one   comment
+	 * @param int      $two   comment
+	 * @param string   $three comment
+	 *
+	 * @return void
+	 */
+	public function oneSpaceAfterLongestVar($one, $two, $three)
+	{
+
+	}//end oneSpaceAfterLongestVar()
 
 
 }//end class
@@ -159,19 +159,19 @@ 
  */
 function functionOutsideClass(&$str, &$foo)
 {
-    return;
+	return;
 }//end functionOutsideClass()
 
 function missingCommentOutsideClass()
 {
-    return;
+	return;
 }//end missingCommentOutsideClass()
 
 
 ?><?php
 function tagBeforeComment()
 {
-    return;
+	return;
 }//end tagBeforeComment()
 
 
@@ -244,12 +244,12 @@ 
 function myFunction() {}
 
 abstract class MyClass {
-    /**
-     * An abstract function.
-     *
-     * @return string[]
-     */
-    abstract protected function myFunction();
+	/**
+	 * An abstract function.
+	 *
+	 * @return string[]
+	 */
+	abstract protected function myFunction();
 }
 
 /**
@@ -271,18 +271,18 @@ 
  *
  */
 function _() {
-    return $foo;
+	return $foo;
 }
 
 class Baz {
-    /**
-     * The PHP5 constructor
-     *
-     * No return tag
-     */
-    public function __construct() {
-
-    }
+	/**
+	 * The PHP5 constructor
+	 *
+	 * No return tag
+	 */
+	public function __construct() {
+
+	}
 }
 
 /**
@@ -295,7 +295,7 @@ 
  * @return void
  */
 function completeStep($status, array $array = [Class1::class, 'test'], $note = '') {
-    echo 'foo';
+	echo 'foo';
 }
 
 /**

Spacing +15 added lines, -15 removed lines

@@ -14,7 +14,7 @@ 
      * @return
      * @throws
      */
-    private function _functionCall($stackPtr, $depth=1, $index)
+    private function _functionCall( $stackPtr, $depth = 1, $index )
     {
         return $stackPtr;
 
@@ -110,7 +110,7 @@ 
      * no return tag
      *
      */
-    public function noReturn($one)
+    public function noReturn( $one )
     {
 
     }//end noReturn()
@@ -125,7 +125,7 @@ 
      * @param missing
      * @param
      */
-    public function missingDescription($threeSpaces)
+    public function missingDescription( $threeSpaces )
     {
 
     }//end missingDescription()
@@ -140,7 +140,7 @@ 
      *
      * @return void
      */
-    public function oneSpaceAfterLongestVar($one, $two, $three)
+    public function oneSpaceAfterLongestVar( $one, $two, $three )
     {
 
     }//end oneSpaceAfterLongestVar()
@@ -157,7 +157,7 @@ 
  *
  * @return void
  */
-function functionOutsideClass(&$str, &$foo)
+function functionOutsideClass( &$str, &$foo )
 {
     return;
 }//end functionOutsideClass()
@@ -195,7 +195,7 @@ 
  * @return void
  * @fine  Unknown tag
  */
-function missingTwoParamComment($one, $two, $three)
+function missingTwoParamComment( $one, $two, $three )
 {
 
 }//end missingTwoParamComment()
@@ -217,7 +217,7 @@ 
  * @access public
  * @return bool
  */
-function myFunction($arg1) {}
+function myFunction( $arg1 ) {}
 
 
 /**
@@ -231,7 +231,7 @@ 
 
 echo $blah;
 
-function myFunction($arg1) {}
+function myFunction( $arg1 ) {}
 
 /**
  * Test function.
@@ -261,7 +261,7 @@ 
  *
  * @return void
  */
-function foo(&$tokens, $tokenizer, $eolChar)
+function foo( &$tokens, $tokenizer, $eolChar )
 {
 
 }//end foo()
@@ -294,7 +294,7 @@ 
  *
  * @return void
  */
-function completeStep($status, array $array = [Class1::class, 'test'], $note = '') {
+function completeStep( $status, array $array = [ Class1::class, 'test' ], $note = '' ) {
     echo 'foo';
 }
 
@@ -306,7 +306,7 @@ 
  *
  * @return void
  */
-function myFunction(string $name1, string ...$name2) {
+function myFunction( string $name1, string ...$name2 ) {
 }
 
 
@@ -318,7 +318,7 @@ 
  *
  * @return void
  */
-function myFunction(string $name1, string ...$name2) {
+function myFunction( string $name1, string ...$name2 ) {
 }
 
 /**
@@ -333,7 +333,7 @@ 
  *   Return value
  *
  */
-function foo($bar) {
+function foo( $bar ) {
 }
 
 /**
@@ -348,7 +348,7 @@ 
  * @return void
  * @see    register()
  */
-function process(File $phpcsFile, $stackPtr)
+function process( File $phpcsFile, $stackPtr )
 {
 
 }//end process()
@@ -366,7 +366,7 @@ 
  * @return void
  * @see    register()
  */
-function process(File $phpcsFile, $stackPtr)
+function process( File $phpcsFile, $stackPtr )
 {
 
 }//end process()

Braces +22 added lines, -44 removed lines

@@ -1,6 +1,5 @@ 
 <?php
-class PHP_CodeSniffer_File
-{
+class PHP_CodeSniffer_File {
 
     /**
      * A simple function comment.
@@ -14,8 +13,7 @@ 
      * @return
      * @throws
      */
-    private function _functionCall($stackPtr, $depth=1, $index)
-    {
+    private function _functionCall($stackPtr, $depth=1, $index) {
         return $stackPtr;
 
     }//end _functionCall()
@@ -25,8 +23,7 @@ 
     //
     //
     //
-    public function invalidCommentStyle()
-    {
+    public function invalidCommentStyle() {
 
     }//end invalidCommentStyle()
 
@@ -42,8 +39,7 @@ 
      *
      * @return void
      */
-    public function extraDescriptionNewlines()
-    {
+    public function extraDescriptionNewlines() {
 
     }//end extraDescriptionNewlines()
 
@@ -52,8 +48,7 @@ 
      * A simple function comment
      * @return void
      */
-    public function missingNewlinesBeforeTags()
-    {
+    public function missingNewlinesBeforeTags() {
 
     }//end missingNewlinesBeforeTags()
 
@@ -64,8 +59,7 @@ 
      * @access public
      * @return void
      */
-    public function accessTag()
-    {
+    public function accessTag() {
 
     }//end accessTag()
 
@@ -74,8 +68,7 @@ 
      *
      * No return tag
      */
-    function PHP_CodeSniffer_File()
-    {
+    function PHP_CodeSniffer_File() {
         return;
     }
 
@@ -85,8 +78,7 @@ 
      *
      * No return tag too
      */
-    function _PHP_CodeSniffer_File()
-    {
+    function _PHP_CodeSniffer_File() {
         return;
     }
 
@@ -94,14 +86,12 @@ 
     /**
      * Destructor PHP5
      */
-    function __destruct()
-    {
+    function __destruct() {
         return;
     }
 
 
-    function missingComment()
-    {
+    function missingComment() {
         return;
     }
 
@@ -110,8 +100,7 @@ 
      * no return tag
      *
      */
-    public function noReturn($one)
-    {
+    public function noReturn($one) {
 
     }//end noReturn()
 
@@ -125,8 +114,7 @@ 
      * @param missing
      * @param
      */
-    public function missingDescription($threeSpaces)
-    {
+    public function missingDescription($threeSpaces) {
 
     }//end missingDescription()
 
@@ -140,8 +128,7 @@ 
      *
      * @return void
      */
-    public function oneSpaceAfterLongestVar($one, $two, $three)
-    {
+    public function oneSpaceAfterLongestVar($one, $two, $three) {
 
     }//end oneSpaceAfterLongestVar()
 
@@ -157,20 +144,17 @@ 
  *
  * @return void
  */
-function functionOutsideClass(&$str, &$foo)
-{
+function functionOutsideClass(&$str, &$foo) {
     return;
 }//end functionOutsideClass()
 
-function missingCommentOutsideClass()
-{
+function missingCommentOutsideClass() {
     return;
 }//end missingCommentOutsideClass()
 
 
 ?><?php
-function tagBeforeComment()
-{
+function tagBeforeComment() {
     return;
 }//end tagBeforeComment()
 
@@ -181,8 +165,7 @@ 
  *
  *
  */
-function noReturnOutsideClass()
-{
+function noReturnOutsideClass() {
 
 }//end noReturnOutsideClass()
 
@@ -195,8 +178,7 @@ 
  * @return void
  * @fine  Unknown tag
  */
-function missingTwoParamComment($one, $two, $three)
-{
+function missingTwoParamComment($one, $two, $three) {
 
 }//end missingTwoParamComment()
 
@@ -204,8 +186,7 @@ 
 /**
  *
  */
-function emptyFunctionDocComment()
-{
+function emptyFunctionDocComment() {
 }//end emptyFunctionDocComment()
 
 
@@ -261,8 +242,7 @@ 
  *
  * @return void
  */
-function foo(&$tokens, $tokenizer, $eolChar)
-{
+function foo(&$tokens, $tokenizer, $eolChar) {
 
 }//end foo()
 
@@ -348,8 +328,7 @@ 
  * @return void
  * @see    register()
  */
-function process(File $phpcsFile, $stackPtr)
-{
+function process(File $phpcsFile, $stackPtr) {
 
 }//end process()
 
@@ -366,7 +345,6 @@ 
  * @return void
  * @see    register()
  */
-function process(File $phpcsFile, $stackPtr)
-{
+function process(File $phpcsFile, $stackPtr) {
 
 }//end process()

vendor/squizlabs/php_codesniffer/src/Standards/PSR1/Sniffs/Files/SideEffectsSniff.php

Doc Comments +2 added lines, -2 removed lines

@@ -20,7 +20,7 @@ 
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return integer[]
      */
     public function register()
     {
@@ -36,7 +36,7 @@ 
      * @param int                         $stackPtr  The position of the current token in
      *                                               the token stack.
      *
-     * @return void
+     * @return integer
      */
     public function process(File $phpcsFile, $stackPtr)
     {

Indentation +259 added lines, -259 removed lines

@@ -17,265 +17,265 @@
 {
 
 
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return [T_OPEN_TAG];
-
-    }//end register()
-
-
-    /**
-     * Processes this sniff, when one of its tokens is encountered.
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
-     * @param int                         $stackPtr  The position of the current token in
-     *                                               the token stack.
-     *
-     * @return void
-     */
-    public function process(File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
-        $result = $this->searchForConflict($phpcsFile, 0, ($phpcsFile->numTokens - 1), $tokens);
-
-        if ($result['symbol'] !== null && $result['effect'] !== null) {
-            $error = 'A file should declare new symbols (classes, functions, constants, etc.) and cause no other side effects, or it should execute logic with side effects, but should not do both. The first symbol is defined on line %s and the first side effect is on line %s.';
-            $data  = [
-                $tokens[$result['symbol']]['line'],
-                $tokens[$result['effect']]['line'],
-            ];
-            $phpcsFile->addWarning($error, 0, 'FoundWithSymbols', $data);
-            $phpcsFile->recordMetric($stackPtr, 'Declarations and side effects mixed', 'yes');
-        } else {
-            $phpcsFile->recordMetric($stackPtr, 'Declarations and side effects mixed', 'no');
-        }
-
-        // Ignore the rest of the file.
-        return ($phpcsFile->numTokens + 1);
-
-    }//end process()
-
-
-    /**
-     * Searches for symbol declarations and side effects.
-     *
-     * Returns the positions of both the first symbol declared and the first
-     * side effect in the file. A NULL value for either indicates nothing was
-     * found.
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
-     * @param int                         $start     The token to start searching from.
-     * @param int                         $end       The token to search to.
-     * @param array                       $tokens    The stack of tokens that make up
-     *                                               the file.
-     *
-     * @return array
-     */
-    private function searchForConflict($phpcsFile, $start, $end, $tokens)
-    {
-        $symbols = [
-            T_CLASS     => T_CLASS,
-            T_INTERFACE => T_INTERFACE,
-            T_TRAIT     => T_TRAIT,
-            T_FUNCTION  => T_FUNCTION,
-        ];
-
-        $conditions = [
-            T_IF     => T_IF,
-            T_ELSE   => T_ELSE,
-            T_ELSEIF => T_ELSEIF,
-        ];
-
-        $checkAnnotations = $phpcsFile->config->annotations;
-
-        $firstSymbol = null;
-        $firstEffect = null;
-        for ($i = $start; $i <= $end; $i++) {
-            // Respect phpcs:disable comments.
-            if ($checkAnnotations === true
-                && $tokens[$i]['code'] === T_PHPCS_DISABLE
-                && (empty($tokens[$i]['sniffCodes']) === true
-                || isset($tokens[$i]['sniffCodes']['PSR1']) === true
-                || isset($tokens[$i]['sniffCodes']['PSR1.Files']) === true
-                || isset($tokens[$i]['sniffCodes']['PSR1.Files.SideEffects']) === true)
-            ) {
-                do {
-                    $i = $phpcsFile->findNext(T_PHPCS_ENABLE, ($i + 1));
-                } while ($i !== false
-                    && empty($tokens[$i]['sniffCodes']) === false
-                    && isset($tokens[$i]['sniffCodes']['PSR1']) === false
-                    && isset($tokens[$i]['sniffCodes']['PSR1.Files']) === false
-                    && isset($tokens[$i]['sniffCodes']['PSR1.Files.SideEffects']) === false);
-
-                if ($i === false) {
-                    // The entire rest of the file is disabled,
-                    // so return what we have so far.
-                    break;
-                }
-
-                continue;
-            }
-
-            // Ignore whitespace and comments.
-            if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === true) {
-                continue;
-            }
-
-            // Ignore PHP tags.
-            if ($tokens[$i]['code'] === T_OPEN_TAG
-                || $tokens[$i]['code'] === T_CLOSE_TAG
-            ) {
-                continue;
-            }
-
-            // Ignore shebang.
-            if (substr($tokens[$i]['content'], 0, 2) === '#!') {
-                continue;
-            }
-
-            // Ignore logical operators.
-            if (isset(Tokens::$booleanOperators[$tokens[$i]['code']]) === true) {
-                continue;
-            }
-
-            // Ignore entire namespace, declare, const and use statements.
-            if ($tokens[$i]['code'] === T_NAMESPACE
-                || $tokens[$i]['code'] === T_USE
-                || $tokens[$i]['code'] === T_DECLARE
-                || $tokens[$i]['code'] === T_CONST
-            ) {
-                if (isset($tokens[$i]['scope_opener']) === true) {
-                    $i = $tokens[$i]['scope_closer'];
-                } else {
-                    $semicolon = $phpcsFile->findNext(T_SEMICOLON, ($i + 1));
-                    if ($semicolon !== false) {
-                        $i = $semicolon;
-                    }
-                }
-
-                continue;
-            }
-
-            // Ignore function/class prefixes.
-            if (isset(Tokens::$methodPrefixes[$tokens[$i]['code']]) === true) {
-                continue;
-            }
-
-            // Ignore anon classes.
-            if ($tokens[$i]['code'] === T_ANON_CLASS) {
-                $i = $tokens[$i]['scope_closer'];
-                continue;
-            }
-
-            // Detect and skip over symbols.
-            if (isset($symbols[$tokens[$i]['code']]) === true
-                && isset($tokens[$i]['scope_closer']) === true
-            ) {
-                if ($firstSymbol === null) {
-                    $firstSymbol = $i;
-                }
-
-                $i = $tokens[$i]['scope_closer'];
-                continue;
-            } else if ($tokens[$i]['code'] === T_STRING
-                && strtolower($tokens[$i]['content']) === 'define'
-            ) {
-                $prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($i - 1), null, true);
-                if ($tokens[$prev]['code'] !== T_OBJECT_OPERATOR
-                    && $tokens[$prev]['code'] !== T_DOUBLE_COLON
-                    && $tokens[$prev]['code'] !== T_FUNCTION
-                ) {
-                    if ($firstSymbol === null) {
-                        $firstSymbol = $i;
-                    }
-
-                    $semicolon = $phpcsFile->findNext(T_SEMICOLON, ($i + 1));
-                    if ($semicolon !== false) {
-                        $i = $semicolon;
-                    }
-
-                    continue;
-                }
-            }//end if
-
-            // Special case for defined() as it can be used to see
-            // if a constant (a symbol) should be defined or not and
-            // doesn't need to use a full conditional block.
-            if ($tokens[$i]['code'] === T_STRING
-                && strtolower($tokens[$i]['content']) === 'defined'
-            ) {
-                $openBracket = $phpcsFile->findNext(Tokens::$emptyTokens, ($i + 1), null, true);
-                if ($tokens[$openBracket]['code'] === T_OPEN_PARENTHESIS
-                    && isset($tokens[$openBracket]['parenthesis_closer']) === true
-                ) {
-                    $prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($i - 1), null, true);
-                    if ($tokens[$prev]['code'] !== T_OBJECT_OPERATOR
-                        && $tokens[$prev]['code'] !== T_DOUBLE_COLON
-                        && $tokens[$prev]['code'] !== T_FUNCTION
-                    ) {
-                        $i = $tokens[$openBracket]['parenthesis_closer'];
-                        continue;
-                    }
-                }
-            }//end if
-
-            // Conditional statements are allowed in symbol files as long as the
-            // contents is only a symbol definition. So don't count these as effects
-            // in this case.
-            if (isset($conditions[$tokens[$i]['code']]) === true) {
-                if (isset($tokens[$i]['scope_opener']) === false) {
-                    // Probably an "else if", so just ignore.
-                    continue;
-                }
-
-                $result = $this->searchForConflict(
-                    $phpcsFile,
-                    ($tokens[$i]['scope_opener'] + 1),
-                    ($tokens[$i]['scope_closer'] - 1),
-                    $tokens
-                );
-
-                if ($result['symbol'] !== null) {
-                    if ($firstSymbol === null) {
-                        $firstSymbol = $result['symbol'];
-                    }
-
-                    if ($result['effect'] !== null) {
-                        // Found a conflict.
-                        $firstEffect = $result['effect'];
-                        break;
-                    }
-                }
-
-                if ($firstEffect === null) {
-                    $firstEffect = $result['effect'];
-                }
-
-                $i = $tokens[$i]['scope_closer'];
-                continue;
-            }//end if
-
-            if ($firstEffect === null) {
-                $firstEffect = $i;
-            }
-
-            if ($firstSymbol !== null) {
-                // We have a conflict we have to report, so no point continuing.
-                break;
-            }
-        }//end for
-
-        return [
-            'symbol' => $firstSymbol,
-            'effect' => $firstEffect,
-        ];
-
-    }//end searchForConflict()
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		return [T_OPEN_TAG];
+
+	}//end register()
+
+
+	/**
+	 * Processes this sniff, when one of its tokens is encountered.
+	 *
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
+	 * @param int                         $stackPtr  The position of the current token in
+	 *                                               the token stack.
+	 *
+	 * @return void
+	 */
+	public function process(File $phpcsFile, $stackPtr)
+	{
+		$tokens = $phpcsFile->getTokens();
+		$result = $this->searchForConflict($phpcsFile, 0, ($phpcsFile->numTokens - 1), $tokens);
+
+		if ($result['symbol'] !== null && $result['effect'] !== null) {
+			$error = 'A file should declare new symbols (classes, functions, constants, etc.) and cause no other side effects, or it should execute logic with side effects, but should not do both. The first symbol is defined on line %s and the first side effect is on line %s.';
+			$data  = [
+				$tokens[$result['symbol']]['line'],
+				$tokens[$result['effect']]['line'],
+			];
+			$phpcsFile->addWarning($error, 0, 'FoundWithSymbols', $data);
+			$phpcsFile->recordMetric($stackPtr, 'Declarations and side effects mixed', 'yes');
+		} else {
+			$phpcsFile->recordMetric($stackPtr, 'Declarations and side effects mixed', 'no');
+		}
+
+		// Ignore the rest of the file.
+		return ($phpcsFile->numTokens + 1);
+
+	}//end process()
+
+
+	/**
+	 * Searches for symbol declarations and side effects.
+	 *
+	 * Returns the positions of both the first symbol declared and the first
+	 * side effect in the file. A NULL value for either indicates nothing was
+	 * found.
+	 *
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
+	 * @param int                         $start     The token to start searching from.
+	 * @param int                         $end       The token to search to.
+	 * @param array                       $tokens    The stack of tokens that make up
+	 *                                               the file.
+	 *
+	 * @return array
+	 */
+	private function searchForConflict($phpcsFile, $start, $end, $tokens)
+	{
+		$symbols = [
+			T_CLASS     => T_CLASS,
+			T_INTERFACE => T_INTERFACE,
+			T_TRAIT     => T_TRAIT,
+			T_FUNCTION  => T_FUNCTION,
+		];
+
+		$conditions = [
+			T_IF     => T_IF,
+			T_ELSE   => T_ELSE,
+			T_ELSEIF => T_ELSEIF,
+		];
+
+		$checkAnnotations = $phpcsFile->config->annotations;
+
+		$firstSymbol = null;
+		$firstEffect = null;
+		for ($i = $start; $i <= $end; $i++) {
+			// Respect phpcs:disable comments.
+			if ($checkAnnotations === true
+				&& $tokens[$i]['code'] === T_PHPCS_DISABLE
+				&& (empty($tokens[$i]['sniffCodes']) === true
+				|| isset($tokens[$i]['sniffCodes']['PSR1']) === true
+				|| isset($tokens[$i]['sniffCodes']['PSR1.Files']) === true
+				|| isset($tokens[$i]['sniffCodes']['PSR1.Files.SideEffects']) === true)
+			) {
+				do {
+					$i = $phpcsFile->findNext(T_PHPCS_ENABLE, ($i + 1));
+				} while ($i !== false
+					&& empty($tokens[$i]['sniffCodes']) === false
+					&& isset($tokens[$i]['sniffCodes']['PSR1']) === false
+					&& isset($tokens[$i]['sniffCodes']['PSR1.Files']) === false
+					&& isset($tokens[$i]['sniffCodes']['PSR1.Files.SideEffects']) === false);
+
+				if ($i === false) {
+					// The entire rest of the file is disabled,
+					// so return what we have so far.
+					break;
+				}
+
+				continue;
+			}
+
+			// Ignore whitespace and comments.
+			if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === true) {
+				continue;
+			}
+
+			// Ignore PHP tags.
+			if ($tokens[$i]['code'] === T_OPEN_TAG
+				|| $tokens[$i]['code'] === T_CLOSE_TAG
+			) {
+				continue;
+			}
+
+			// Ignore shebang.
+			if (substr($tokens[$i]['content'], 0, 2) === '#!') {
+				continue;
+			}
+
+			// Ignore logical operators.
+			if (isset(Tokens::$booleanOperators[$tokens[$i]['code']]) === true) {
+				continue;
+			}
+
+			// Ignore entire namespace, declare, const and use statements.
+			if ($tokens[$i]['code'] === T_NAMESPACE
+				|| $tokens[$i]['code'] === T_USE
+				|| $tokens[$i]['code'] === T_DECLARE
+				|| $tokens[$i]['code'] === T_CONST
+			) {
+				if (isset($tokens[$i]['scope_opener']) === true) {
+					$i = $tokens[$i]['scope_closer'];
+				} else {
+					$semicolon = $phpcsFile->findNext(T_SEMICOLON, ($i + 1));
+					if ($semicolon !== false) {
+						$i = $semicolon;
+					}
+				}
+
+				continue;
+			}
+
+			// Ignore function/class prefixes.
+			if (isset(Tokens::$methodPrefixes[$tokens[$i]['code']]) === true) {
+				continue;
+			}
+
+			// Ignore anon classes.
+			if ($tokens[$i]['code'] === T_ANON_CLASS) {
+				$i = $tokens[$i]['scope_closer'];
+				continue;
+			}
+
+			// Detect and skip over symbols.
+			if (isset($symbols[$tokens[$i]['code']]) === true
+				&& isset($tokens[$i]['scope_closer']) === true
+			) {
+				if ($firstSymbol === null) {
+					$firstSymbol = $i;
+				}
+
+				$i = $tokens[$i]['scope_closer'];
+				continue;
+			} else if ($tokens[$i]['code'] === T_STRING
+				&& strtolower($tokens[$i]['content']) === 'define'
+			) {
+				$prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($i - 1), null, true);
+				if ($tokens[$prev]['code'] !== T_OBJECT_OPERATOR
+					&& $tokens[$prev]['code'] !== T_DOUBLE_COLON
+					&& $tokens[$prev]['code'] !== T_FUNCTION
+				) {
+					if ($firstSymbol === null) {
+						$firstSymbol = $i;
+					}
+
+					$semicolon = $phpcsFile->findNext(T_SEMICOLON, ($i + 1));
+					if ($semicolon !== false) {
+						$i = $semicolon;
+					}
+
+					continue;
+				}
+			}//end if
+
+			// Special case for defined() as it can be used to see
+			// if a constant (a symbol) should be defined or not and
+			// doesn't need to use a full conditional block.
+			if ($tokens[$i]['code'] === T_STRING
+				&& strtolower($tokens[$i]['content']) === 'defined'
+			) {
+				$openBracket = $phpcsFile->findNext(Tokens::$emptyTokens, ($i + 1), null, true);
+				if ($tokens[$openBracket]['code'] === T_OPEN_PARENTHESIS
+					&& isset($tokens[$openBracket]['parenthesis_closer']) === true
+				) {
+					$prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($i - 1), null, true);
+					if ($tokens[$prev]['code'] !== T_OBJECT_OPERATOR
+						&& $tokens[$prev]['code'] !== T_DOUBLE_COLON
+						&& $tokens[$prev]['code'] !== T_FUNCTION
+					) {
+						$i = $tokens[$openBracket]['parenthesis_closer'];
+						continue;
+					}
+				}
+			}//end if
+
+			// Conditional statements are allowed in symbol files as long as the
+			// contents is only a symbol definition. So don't count these as effects
+			// in this case.
+			if (isset($conditions[$tokens[$i]['code']]) === true) {
+				if (isset($tokens[$i]['scope_opener']) === false) {
+					// Probably an "else if", so just ignore.
+					continue;
+				}
+
+				$result = $this->searchForConflict(
+					$phpcsFile,
+					($tokens[$i]['scope_opener'] + 1),
+					($tokens[$i]['scope_closer'] - 1),
+					$tokens
+				);
+
+				if ($result['symbol'] !== null) {
+					if ($firstSymbol === null) {
+						$firstSymbol = $result['symbol'];
+					}
+
+					if ($result['effect'] !== null) {
+						// Found a conflict.
+						$firstEffect = $result['effect'];
+						break;
+					}
+				}
+
+				if ($firstEffect === null) {
+					$firstEffect = $result['effect'];
+				}
+
+				$i = $tokens[$i]['scope_closer'];
+				continue;
+			}//end if
+
+			if ($firstEffect === null) {
+				$firstEffect = $i;
+			}
+
+			if ($firstSymbol !== null) {
+				// We have a conflict we have to report, so no point continuing.
+				break;
+			}
+		}//end for
+
+		return [
+			'symbol' => $firstSymbol,
+			'effect' => $firstEffect,
+		];
+
+	}//end searchForConflict()
 
 
 }//end class

Spacing +79 added lines, -79 removed lines

@@ -24,7 +24,7 @@ 
      */
     public function register()
     {
-        return [T_OPEN_TAG];
+        return [ T_OPEN_TAG ];
 
     }//end register()
 
@@ -38,25 +38,25 @@ 
      *
      * @return void
      */
-    public function process(File $phpcsFile, $stackPtr)
+    public function process( File $phpcsFile, $stackPtr )
     {
         $tokens = $phpcsFile->getTokens();
-        $result = $this->searchForConflict($phpcsFile, 0, ($phpcsFile->numTokens - 1), $tokens);
+        $result = $this->searchForConflict( $phpcsFile, 0, ( $phpcsFile->numTokens - 1 ), $tokens );
 
-        if ($result['symbol'] !== null && $result['effect'] !== null) {
+        if ( $result[ 'symbol' ] !== null && $result[ 'effect' ] !== null ) {
             $error = 'A file should declare new symbols (classes, functions, constants, etc.) and cause no other side effects, or it should execute logic with side effects, but should not do both. The first symbol is defined on line %s and the first side effect is on line %s.';
             $data  = [
-                $tokens[$result['symbol']]['line'],
-                $tokens[$result['effect']]['line'],
+                $tokens[ $result[ 'symbol' ] ][ 'line' ],
+                $tokens[ $result[ 'effect' ] ][ 'line' ],
             ];
-            $phpcsFile->addWarning($error, 0, 'FoundWithSymbols', $data);
-            $phpcsFile->recordMetric($stackPtr, 'Declarations and side effects mixed', 'yes');
+            $phpcsFile->addWarning( $error, 0, 'FoundWithSymbols', $data );
+            $phpcsFile->recordMetric( $stackPtr, 'Declarations and side effects mixed', 'yes' );
         } else {
-            $phpcsFile->recordMetric($stackPtr, 'Declarations and side effects mixed', 'no');
+            $phpcsFile->recordMetric( $stackPtr, 'Declarations and side effects mixed', 'no' );
         }
 
         // Ignore the rest of the file.
-        return ($phpcsFile->numTokens + 1);
+        return ( $phpcsFile->numTokens + 1 );
 
     }//end process()
 
@@ -76,7 +76,7 @@ 
      *
      * @return array
      */
-    private function searchForConflict($phpcsFile, $start, $end, $tokens)
+    private function searchForConflict( $phpcsFile, $start, $end, $tokens )
     {
         $symbols = [
             T_CLASS     => T_CLASS,
@@ -95,24 +95,24 @@ 
 
         $firstSymbol = null;
         $firstEffect = null;
-        for ($i = $start; $i <= $end; $i++) {
+        for ( $i = $start; $i <= $end; $i++ ) {
             // Respect phpcs:disable comments.
-            if ($checkAnnotations === true
-                && $tokens[$i]['code'] === T_PHPCS_DISABLE
-                && (empty($tokens[$i]['sniffCodes']) === true
-                || isset($tokens[$i]['sniffCodes']['PSR1']) === true
-                || isset($tokens[$i]['sniffCodes']['PSR1.Files']) === true
-                || isset($tokens[$i]['sniffCodes']['PSR1.Files.SideEffects']) === true)
+            if ( $checkAnnotations === true
+                && $tokens[ $i ][ 'code' ] === T_PHPCS_DISABLE
+                && ( empty( $tokens[ $i ][ 'sniffCodes' ] ) === true
+                || isset( $tokens[ $i ][ 'sniffCodes' ][ 'PSR1' ] ) === true
+                || isset( $tokens[ $i ][ 'sniffCodes' ][ 'PSR1.Files' ] ) === true
+                || isset( $tokens[ $i ][ 'sniffCodes' ][ 'PSR1.Files.SideEffects' ] ) === true )
             ) {
                 do {
-                    $i = $phpcsFile->findNext(T_PHPCS_ENABLE, ($i + 1));
-                } while ($i !== false
-                    && empty($tokens[$i]['sniffCodes']) === false
-                    && isset($tokens[$i]['sniffCodes']['PSR1']) === false
-                    && isset($tokens[$i]['sniffCodes']['PSR1.Files']) === false
-                    && isset($tokens[$i]['sniffCodes']['PSR1.Files.SideEffects']) === false);
-
-                if ($i === false) {
+                    $i = $phpcsFile->findNext( T_PHPCS_ENABLE, ( $i + 1 ) );
+                } while ( $i !== false
+                    && empty( $tokens[ $i ][ 'sniffCodes' ] ) === false
+                    && isset( $tokens[ $i ][ 'sniffCodes' ][ 'PSR1' ] ) === false
+                    && isset( $tokens[ $i ][ 'sniffCodes' ][ 'PSR1.Files' ] ) === false
+                    && isset( $tokens[ $i ][ 'sniffCodes' ][ 'PSR1.Files.SideEffects' ] ) === false );
+
+                if ( $i === false ) {
                     // The entire rest of the file is disabled,
                     // so return what we have so far.
                     break;
@@ -122,38 +122,38 @@ 
             }
 
             // Ignore whitespace and comments.
-            if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === true) {
+            if ( isset( Tokens::$emptyTokens[ $tokens[ $i ][ 'code' ] ] ) === true ) {
                 continue;
             }
 
             // Ignore PHP tags.
-            if ($tokens[$i]['code'] === T_OPEN_TAG
-                || $tokens[$i]['code'] === T_CLOSE_TAG
+            if ( $tokens[ $i ][ 'code' ] === T_OPEN_TAG
+                || $tokens[ $i ][ 'code' ] === T_CLOSE_TAG
             ) {
                 continue;
             }
 
             // Ignore shebang.
-            if (substr($tokens[$i]['content'], 0, 2) === '#!') {
+            if ( substr( $tokens[ $i ][ 'content' ], 0, 2 ) === '#!' ) {
                 continue;
             }
 
             // Ignore logical operators.
-            if (isset(Tokens::$booleanOperators[$tokens[$i]['code']]) === true) {
+            if ( isset( Tokens::$booleanOperators[ $tokens[ $i ][ 'code' ] ] ) === true ) {
                 continue;
             }
 
             // Ignore entire namespace, declare, const and use statements.
-            if ($tokens[$i]['code'] === T_NAMESPACE
-                || $tokens[$i]['code'] === T_USE
-                || $tokens[$i]['code'] === T_DECLARE
-                || $tokens[$i]['code'] === T_CONST
+            if ( $tokens[ $i ][ 'code' ] === T_NAMESPACE
+                || $tokens[ $i ][ 'code' ] === T_USE
+                || $tokens[ $i ][ 'code' ] === T_DECLARE
+                || $tokens[ $i ][ 'code' ] === T_CONST
             ) {
-                if (isset($tokens[$i]['scope_opener']) === true) {
-                    $i = $tokens[$i]['scope_closer'];
+                if ( isset( $tokens[ $i ][ 'scope_opener' ] ) === true ) {
+                    $i = $tokens[ $i ][ 'scope_closer' ];
                 } else {
-                    $semicolon = $phpcsFile->findNext(T_SEMICOLON, ($i + 1));
-                    if ($semicolon !== false) {
+                    $semicolon = $phpcsFile->findNext( T_SEMICOLON, ( $i + 1 ) );
+                    if ( $semicolon !== false ) {
                         $i = $semicolon;
                     }
                 }
@@ -162,40 +162,40 @@ 
             }
 
             // Ignore function/class prefixes.
-            if (isset(Tokens::$methodPrefixes[$tokens[$i]['code']]) === true) {
+            if ( isset( Tokens::$methodPrefixes[ $tokens[ $i ][ 'code' ] ] ) === true ) {
                 continue;
             }
 
             // Ignore anon classes.
-            if ($tokens[$i]['code'] === T_ANON_CLASS) {
-                $i = $tokens[$i]['scope_closer'];
+            if ( $tokens[ $i ][ 'code' ] === T_ANON_CLASS ) {
+                $i = $tokens[ $i ][ 'scope_closer' ];
                 continue;
             }
 
             // Detect and skip over symbols.
-            if (isset($symbols[$tokens[$i]['code']]) === true
-                && isset($tokens[$i]['scope_closer']) === true
+            if ( isset( $symbols[ $tokens[ $i ][ 'code' ] ] ) === true
+                && isset( $tokens[ $i ][ 'scope_closer' ] ) === true
             ) {
-                if ($firstSymbol === null) {
+                if ( $firstSymbol === null ) {
                     $firstSymbol = $i;
                 }
 
-                $i = $tokens[$i]['scope_closer'];
+                $i = $tokens[ $i ][ 'scope_closer' ];
                 continue;
-            } else if ($tokens[$i]['code'] === T_STRING
-                && strtolower($tokens[$i]['content']) === 'define'
+            } else if ( $tokens[ $i ][ 'code' ] === T_STRING
+                && strtolower( $tokens[ $i ][ 'content' ] ) === 'define'
             ) {
-                $prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($i - 1), null, true);
-                if ($tokens[$prev]['code'] !== T_OBJECT_OPERATOR
-                    && $tokens[$prev]['code'] !== T_DOUBLE_COLON
-                    && $tokens[$prev]['code'] !== T_FUNCTION
+                $prev = $phpcsFile->findPrevious( Tokens::$emptyTokens, ( $i - 1 ), null, true );
+                if ( $tokens[ $prev ][ 'code' ] !== T_OBJECT_OPERATOR
+                    && $tokens[ $prev ][ 'code' ] !== T_DOUBLE_COLON
+                    && $tokens[ $prev ][ 'code' ] !== T_FUNCTION
                 ) {
-                    if ($firstSymbol === null) {
+                    if ( $firstSymbol === null ) {
                         $firstSymbol = $i;
                     }
 
-                    $semicolon = $phpcsFile->findNext(T_SEMICOLON, ($i + 1));
-                    if ($semicolon !== false) {
+                    $semicolon = $phpcsFile->findNext( T_SEMICOLON, ( $i + 1 ) );
+                    if ( $semicolon !== false ) {
                         $i = $semicolon;
                     }
 
@@ -206,19 +206,19 @@ 
             // Special case for defined() as it can be used to see
             // if a constant (a symbol) should be defined or not and
             // doesn't need to use a full conditional block.
-            if ($tokens[$i]['code'] === T_STRING
-                && strtolower($tokens[$i]['content']) === 'defined'
+            if ( $tokens[ $i ][ 'code' ] === T_STRING
+                && strtolower( $tokens[ $i ][ 'content' ] ) === 'defined'
             ) {
-                $openBracket = $phpcsFile->findNext(Tokens::$emptyTokens, ($i + 1), null, true);
-                if ($tokens[$openBracket]['code'] === T_OPEN_PARENTHESIS
-                    && isset($tokens[$openBracket]['parenthesis_closer']) === true
+                $openBracket = $phpcsFile->findNext( Tokens::$emptyTokens, ( $i + 1 ), null, true );
+                if ( $tokens[ $openBracket ][ 'code' ] === T_OPEN_PARENTHESIS
+                    && isset( $tokens[ $openBracket ][ 'parenthesis_closer' ] ) === true
                 ) {
-                    $prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($i - 1), null, true);
-                    if ($tokens[$prev]['code'] !== T_OBJECT_OPERATOR
-                        && $tokens[$prev]['code'] !== T_DOUBLE_COLON
-                        && $tokens[$prev]['code'] !== T_FUNCTION
+                    $prev = $phpcsFile->findPrevious( Tokens::$emptyTokens, ( $i - 1 ), null, true );
+                    if ( $tokens[ $prev ][ 'code' ] !== T_OBJECT_OPERATOR
+                        && $tokens[ $prev ][ 'code' ] !== T_DOUBLE_COLON
+                        && $tokens[ $prev ][ 'code' ] !== T_FUNCTION
                     ) {
-                        $i = $tokens[$openBracket]['parenthesis_closer'];
+                        $i = $tokens[ $openBracket ][ 'parenthesis_closer' ];
                         continue;
                     }
                 }
@@ -227,44 +227,44 @@ 
             // Conditional statements are allowed in symbol files as long as the
             // contents is only a symbol definition. So don't count these as effects
             // in this case.
-            if (isset($conditions[$tokens[$i]['code']]) === true) {
-                if (isset($tokens[$i]['scope_opener']) === false) {
+            if ( isset( $conditions[ $tokens[ $i ][ 'code' ] ] ) === true ) {
+                if ( isset( $tokens[ $i ][ 'scope_opener' ] ) === false ) {
                     // Probably an "else if", so just ignore.
                     continue;
                 }
 
                 $result = $this->searchForConflict(
                     $phpcsFile,
-                    ($tokens[$i]['scope_opener'] + 1),
-                    ($tokens[$i]['scope_closer'] - 1),
+                    ( $tokens[ $i ][ 'scope_opener' ] + 1 ),
+                    ( $tokens[ $i ][ 'scope_closer' ] - 1 ),
                     $tokens
                 );
 
-                if ($result['symbol'] !== null) {
-                    if ($firstSymbol === null) {
-                        $firstSymbol = $result['symbol'];
+                if ( $result[ 'symbol' ] !== null ) {
+                    if ( $firstSymbol === null ) {
+                        $firstSymbol = $result[ 'symbol' ];
                     }
 
-                    if ($result['effect'] !== null) {
+                    if ( $result[ 'effect' ] !== null ) {
                         // Found a conflict.
-                        $firstEffect = $result['effect'];
+                        $firstEffect = $result[ 'effect' ];
                         break;
                     }
                 }
 
-                if ($firstEffect === null) {
-                    $firstEffect = $result['effect'];
+                if ( $firstEffect === null ) {
+                    $firstEffect = $result[ 'effect' ];
                 }
 
-                $i = $tokens[$i]['scope_closer'];
+                $i = $tokens[ $i ][ 'scope_closer' ];
                 continue;
             }//end if
 
-            if ($firstEffect === null) {
+            if ( $firstEffect === null ) {
                 $firstEffect = $i;
             }
 
-            if ($firstSymbol !== null) {
+            if ( $firstSymbol !== null ) {
                 // We have a conflict we have to report, so no point continuing.
                 break;
             }

Braces +4 added lines, -8 removed lines

@@ -13,8 +13,7 @@ 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Util\Tokens;
 
-class SideEffectsSniff implements Sniff
-{
+class SideEffectsSniff implements Sniff {
 
 
     /**
@@ -22,8 +21,7 @@ 
      *
      * @return array
      */
-    public function register()
-    {
+    public function register() {
         return [T_OPEN_TAG];
 
     }//end register()
@@ -38,8 +36,7 @@ 
      *
      * @return void
      */
-    public function process(File $phpcsFile, $stackPtr)
-    {
+    public function process(File $phpcsFile, $stackPtr) {
         $tokens = $phpcsFile->getTokens();
         $result = $this->searchForConflict($phpcsFile, 0, ($phpcsFile->numTokens - 1), $tokens);
 
@@ -76,8 +73,7 @@ 
      *
      * @return array
      */
-    private function searchForConflict($phpcsFile, $start, $end, $tokens)
-    {
+    private function searchForConflict($phpcsFile, $start, $end, $tokens) {
         $symbols = [
             T_CLASS     => T_CLASS,
             T_INTERFACE => T_INTERFACE,

vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/Commenting/InlineCommentSniff.php

Doc Comments +1 added lines, -1 removed lines

@@ -49,7 +49,7 @@
      * @param int                         $stackPtr  The position of the current token in the
      *                                               stack passed in $tokens.
      *
-     * @return void
+     * @return null|integer
      */
     public function process(File $phpcsFile, $stackPtr)
     {

Indentation +322 added lines, -322 removed lines

@@ -16,328 +16,328 @@
 class InlineCommentSniff implements Sniff
 {
 
-    /**
-     * A list of tokenizers this sniff supports.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = [
-        'PHP',
-        'JS',
-    ];
-
-
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return [
-            T_COMMENT,
-            T_DOC_COMMENT_OPEN_TAG,
-        ];
-
-    }//end register()
-
-
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
-     * @param int                         $stackPtr  The position of the current token in the
-     *                                               stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
-
-        // If this is a function/class/interface doc block comment, skip it.
-        // We are only interested in inline doc block comments, which are
-        // not allowed.
-        if ($tokens[$stackPtr]['code'] === T_DOC_COMMENT_OPEN_TAG) {
-            $nextToken = $phpcsFile->findNext(
-                Tokens::$emptyTokens,
-                ($stackPtr + 1),
-                null,
-                true
-            );
-
-            $ignore = [
-                T_CLASS,
-                T_INTERFACE,
-                T_TRAIT,
-                T_FUNCTION,
-                T_CLOSURE,
-                T_PUBLIC,
-                T_PRIVATE,
-                T_PROTECTED,
-                T_FINAL,
-                T_STATIC,
-                T_ABSTRACT,
-                T_CONST,
-                T_PROPERTY,
-                T_INCLUDE,
-                T_INCLUDE_ONCE,
-                T_REQUIRE,
-                T_REQUIRE_ONCE,
-            ];
-
-            if (in_array($tokens[$nextToken]['code'], $ignore, true) === true) {
-                return;
-            }
-
-            if ($phpcsFile->tokenizerType === 'JS') {
-                // We allow block comments if a function or object
-                // is being assigned to a variable.
-                $ignore    = Tokens::$emptyTokens;
-                $ignore[]  = T_EQUAL;
-                $ignore[]  = T_STRING;
-                $ignore[]  = T_OBJECT_OPERATOR;
-                $nextToken = $phpcsFile->findNext($ignore, ($nextToken + 1), null, true);
-                if ($tokens[$nextToken]['code'] === T_FUNCTION
-                    || $tokens[$nextToken]['code'] === T_CLOSURE
-                    || $tokens[$nextToken]['code'] === T_OBJECT
-                    || $tokens[$nextToken]['code'] === T_PROTOTYPE
-                ) {
-                    return;
-                }
-            }
-
-            $prevToken = $phpcsFile->findPrevious(
-                Tokens::$emptyTokens,
-                ($stackPtr - 1),
-                null,
-                true
-            );
-
-            if ($tokens[$prevToken]['code'] === T_OPEN_TAG) {
-                return;
-            }
-
-            if ($tokens[$stackPtr]['content'] === '/**') {
-                $error = 'Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead';
-                $phpcsFile->addError($error, $stackPtr, 'DocBlock');
-            }
-        }//end if
-
-        if ($tokens[$stackPtr]['content']{0} === '#') {
-            $error = 'Perl-style comments are not allowed; use "// Comment" instead';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'WrongStyle');
-            if ($fix === true) {
-                $comment = ltrim($tokens[$stackPtr]['content'], "# \t");
-                $phpcsFile->fixer->replaceToken($stackPtr, "// $comment");
-            }
-        }
-
-        // We don't want end of block comments. Check if the last token before the
-        // comment is a closing curly brace.
-        $previousContent = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
-        if ($tokens[$previousContent]['line'] === $tokens[$stackPtr]['line']) {
-            if ($tokens[$previousContent]['code'] === T_CLOSE_CURLY_BRACKET) {
-                return;
-            }
-
-            // Special case for JS files.
-            if ($tokens[$previousContent]['code'] === T_COMMA
-                || $tokens[$previousContent]['code'] === T_SEMICOLON
-            ) {
-                $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($previousContent - 1), null, true);
-                if ($tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) {
-                    return;
-                }
-            }
-        }
-
-        // Only want inline comments.
-        if (substr($tokens[$stackPtr]['content'], 0, 2) !== '//') {
-            return;
-        }
-
-        $commentTokens = [$stackPtr];
-
-        $nextComment = $stackPtr;
-        $lastComment = $stackPtr;
-        while (($nextComment = $phpcsFile->findNext(T_COMMENT, ($nextComment + 1), null, false)) !== false) {
-            if ($tokens[$nextComment]['line'] !== ($tokens[$lastComment]['line'] + 1)) {
-                break;
-            }
-
-            // Only want inline comments.
-            if (substr($tokens[$nextComment]['content'], 0, 2) !== '//') {
-                break;
-            }
-
-            // There is a comment on the very next line. If there is
-            // no code between the comments, they are part of the same
-            // comment block.
-            $prevNonWhitespace = $phpcsFile->findPrevious(T_WHITESPACE, ($nextComment - 1), $lastComment, true);
-            if ($prevNonWhitespace !== $lastComment) {
-                break;
-            }
-
-            $commentTokens[] = $nextComment;
-            $lastComment     = $nextComment;
-        }//end while
-
-        $commentText = '';
-        foreach ($commentTokens as $lastCommentToken) {
-            $comment = rtrim($tokens[$lastCommentToken]['content']);
-
-            if (trim(substr($comment, 2)) === '') {
-                continue;
-            }
-
-            $spaceCount = 0;
-            $tabFound   = false;
-
-            $commentLength = strlen($comment);
-            for ($i = 2; $i < $commentLength; $i++) {
-                if ($comment[$i] === "\t") {
-                    $tabFound = true;
-                    break;
-                }
-
-                if ($comment[$i] !== ' ') {
-                    break;
-                }
-
-                $spaceCount++;
-            }
-
-            $fix = false;
-            if ($tabFound === true) {
-                $error = 'Tab found before comment text; expected "// %s" but found "%s"';
-                $data  = [
-                    ltrim(substr($comment, 2)),
-                    $comment,
-                ];
-                $fix   = $phpcsFile->addFixableError($error, $lastCommentToken, 'TabBefore', $data);
-            } else if ($spaceCount === 0) {
-                $error = 'No space found before comment text; expected "// %s" but found "%s"';
-                $data  = [
-                    substr($comment, 2),
-                    $comment,
-                ];
-                $fix   = $phpcsFile->addFixableError($error, $lastCommentToken, 'NoSpaceBefore', $data);
-            } else if ($spaceCount > 1) {
-                $error = 'Expected 1 space before comment text but found %s; use block comment if you need indentation';
-                $data  = [
-                    $spaceCount,
-                    substr($comment, (2 + $spaceCount)),
-                    $comment,
-                ];
-                $fix   = $phpcsFile->addFixableError($error, $lastCommentToken, 'SpacingBefore', $data);
-            }//end if
-
-            if ($fix === true) {
-                $newComment = '// '.ltrim($tokens[$lastCommentToken]['content'], "/\t ");
-                $phpcsFile->fixer->replaceToken($lastCommentToken, $newComment);
-            }
-
-            $commentText .= trim(substr($tokens[$lastCommentToken]['content'], 2));
-        }//end foreach
-
-        if ($commentText === '') {
-            $error = 'Blank comments are not allowed';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'Empty');
-            if ($fix === true) {
-                $phpcsFile->fixer->replaceToken($stackPtr, '');
-            }
-
-            return ($lastCommentToken + 1);
-        }
-
-        if (preg_match('/^\p{Ll}/u', $commentText) === 1) {
-            $error = 'Inline comments must start with a capital letter';
-            $phpcsFile->addError($error, $stackPtr, 'NotCapital');
-        }
-
-        // Only check the end of comment character if the start of the comment
-        // is a letter, indicating that the comment is just standard text.
-        if (preg_match('/^\p{L}/u', $commentText) === 1) {
-            $commentCloser   = $commentText[(strlen($commentText) - 1)];
-            $acceptedClosers = [
-                'full-stops'        => '.',
-                'exclamation marks' => '!',
-                'or question marks' => '?',
-            ];
-
-            if (in_array($commentCloser, $acceptedClosers, true) === false) {
-                $error = 'Inline comments must end in %s';
-                $ender = '';
-                foreach ($acceptedClosers as $closerName => $symbol) {
-                    $ender .= ' '.$closerName.',';
-                }
-
-                $ender = trim($ender, ' ,');
-                $data  = [$ender];
-                $phpcsFile->addError($error, $lastCommentToken, 'InvalidEndChar', $data);
-            }
-        }
-
-        // Finally, the line below the last comment cannot be empty if this inline
-        // comment is on a line by itself.
-        if ($tokens[$previousContent]['line'] < $tokens[$stackPtr]['line']) {
-            $next = $phpcsFile->findNext(T_WHITESPACE, ($lastCommentToken + 1), null, true);
-            if ($next === false) {
-                // Ignore if the comment is the last non-whitespace token in a file.
-                return ($lastCommentToken + 1);
-            }
-
-            if ($tokens[$next]['code'] === T_DOC_COMMENT_OPEN_TAG) {
-                // If this inline comment is followed by a docblock,
-                // ignore spacing as docblock/function etc spacing rules
-                // are likely to conflict with our rules.
-                return ($lastCommentToken + 1);
-            }
-
-            $errorCode = 'SpacingAfter';
-
-            if (isset($tokens[$stackPtr]['conditions']) === true) {
-                $conditions   = $tokens[$stackPtr]['conditions'];
-                $type         = end($conditions);
-                $conditionPtr = key($conditions);
-
-                if (($type === T_FUNCTION || $type === T_CLOSURE)
-                    && $tokens[$conditionPtr]['scope_closer'] === $next
-                ) {
-                    $errorCode = 'SpacingAfterAtFunctionEnd';
-                }
-            }
-
-            for ($i = ($lastCommentToken + 1); $i < $phpcsFile->numTokens; $i++) {
-                if ($tokens[$i]['line'] === ($tokens[$lastCommentToken]['line'] + 1)) {
-                    if ($tokens[$i]['code'] !== T_WHITESPACE) {
-                        return ($lastCommentToken + 1);
-                    }
-                } else if ($tokens[$i]['line'] > ($tokens[$lastCommentToken]['line'] + 1)) {
-                    break;
-                }
-            }
-
-            $error = 'There must be no blank line following an inline comment';
-            $fix   = $phpcsFile->addFixableError($error, $lastCommentToken, $errorCode);
-            if ($fix === true) {
-                $phpcsFile->fixer->beginChangeset();
-                for ($i = ($lastCommentToken + 1); $i < $next; $i++) {
-                    if ($tokens[$i]['line'] === $tokens[$next]['line']) {
-                        break;
-                    }
-
-                    $phpcsFile->fixer->replaceToken($i, '');
-                }
-
-                $phpcsFile->fixer->endChangeset();
-            }
-        }//end if
-
-        return ($lastCommentToken + 1);
-
-    }//end process()
+	/**
+	 * A list of tokenizers this sniff supports.
+	 *
+	 * @var array
+	 */
+	public $supportedTokenizers = [
+		'PHP',
+		'JS',
+	];
+
+
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		return [
+			T_COMMENT,
+			T_DOC_COMMENT_OPEN_TAG,
+		];
+
+	}//end register()
+
+
+	/**
+	 * Processes this test, when one of its tokens is encountered.
+	 *
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
+	 * @param int                         $stackPtr  The position of the current token in the
+	 *                                               stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	public function process(File $phpcsFile, $stackPtr)
+	{
+		$tokens = $phpcsFile->getTokens();
+
+		// If this is a function/class/interface doc block comment, skip it.
+		// We are only interested in inline doc block comments, which are
+		// not allowed.
+		if ($tokens[$stackPtr]['code'] === T_DOC_COMMENT_OPEN_TAG) {
+			$nextToken = $phpcsFile->findNext(
+				Tokens::$emptyTokens,
+				($stackPtr + 1),
+				null,
+				true
+			);
+
+			$ignore = [
+				T_CLASS,
+				T_INTERFACE,
+				T_TRAIT,
+				T_FUNCTION,
+				T_CLOSURE,
+				T_PUBLIC,
+				T_PRIVATE,
+				T_PROTECTED,
+				T_FINAL,
+				T_STATIC,
+				T_ABSTRACT,
+				T_CONST,
+				T_PROPERTY,
+				T_INCLUDE,
+				T_INCLUDE_ONCE,
+				T_REQUIRE,
+				T_REQUIRE_ONCE,
+			];
+
+			if (in_array($tokens[$nextToken]['code'], $ignore, true) === true) {
+				return;
+			}
+
+			if ($phpcsFile->tokenizerType === 'JS') {
+				// We allow block comments if a function or object
+				// is being assigned to a variable.
+				$ignore    = Tokens::$emptyTokens;
+				$ignore[]  = T_EQUAL;
+				$ignore[]  = T_STRING;
+				$ignore[]  = T_OBJECT_OPERATOR;
+				$nextToken = $phpcsFile->findNext($ignore, ($nextToken + 1), null, true);
+				if ($tokens[$nextToken]['code'] === T_FUNCTION
+					|| $tokens[$nextToken]['code'] === T_CLOSURE
+					|| $tokens[$nextToken]['code'] === T_OBJECT
+					|| $tokens[$nextToken]['code'] === T_PROTOTYPE
+				) {
+					return;
+				}
+			}
+
+			$prevToken = $phpcsFile->findPrevious(
+				Tokens::$emptyTokens,
+				($stackPtr - 1),
+				null,
+				true
+			);
+
+			if ($tokens[$prevToken]['code'] === T_OPEN_TAG) {
+				return;
+			}
+
+			if ($tokens[$stackPtr]['content'] === '/**') {
+				$error = 'Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead';
+				$phpcsFile->addError($error, $stackPtr, 'DocBlock');
+			}
+		}//end if
+
+		if ($tokens[$stackPtr]['content']{0} === '#') {
+			$error = 'Perl-style comments are not allowed; use "// Comment" instead';
+			$fix   = $phpcsFile->addFixableError($error, $stackPtr, 'WrongStyle');
+			if ($fix === true) {
+				$comment = ltrim($tokens[$stackPtr]['content'], "# \t");
+				$phpcsFile->fixer->replaceToken($stackPtr, "// $comment");
+			}
+		}
+
+		// We don't want end of block comments. Check if the last token before the
+		// comment is a closing curly brace.
+		$previousContent = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
+		if ($tokens[$previousContent]['line'] === $tokens[$stackPtr]['line']) {
+			if ($tokens[$previousContent]['code'] === T_CLOSE_CURLY_BRACKET) {
+				return;
+			}
+
+			// Special case for JS files.
+			if ($tokens[$previousContent]['code'] === T_COMMA
+				|| $tokens[$previousContent]['code'] === T_SEMICOLON
+			) {
+				$lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($previousContent - 1), null, true);
+				if ($tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) {
+					return;
+				}
+			}
+		}
+
+		// Only want inline comments.
+		if (substr($tokens[$stackPtr]['content'], 0, 2) !== '//') {
+			return;
+		}
+
+		$commentTokens = [$stackPtr];
+
+		$nextComment = $stackPtr;
+		$lastComment = $stackPtr;
+		while (($nextComment = $phpcsFile->findNext(T_COMMENT, ($nextComment + 1), null, false)) !== false) {
+			if ($tokens[$nextComment]['line'] !== ($tokens[$lastComment]['line'] + 1)) {
+				break;
+			}
+
+			// Only want inline comments.
+			if (substr($tokens[$nextComment]['content'], 0, 2) !== '//') {
+				break;
+			}
+
+			// There is a comment on the very next line. If there is
+			// no code between the comments, they are part of the same
+			// comment block.
+			$prevNonWhitespace = $phpcsFile->findPrevious(T_WHITESPACE, ($nextComment - 1), $lastComment, true);
+			if ($prevNonWhitespace !== $lastComment) {
+				break;
+			}
+
+			$commentTokens[] = $nextComment;
+			$lastComment     = $nextComment;
+		}//end while
+
+		$commentText = '';
+		foreach ($commentTokens as $lastCommentToken) {
+			$comment = rtrim($tokens[$lastCommentToken]['content']);
+
+			if (trim(substr($comment, 2)) === '') {
+				continue;
+			}
+
+			$spaceCount = 0;
+			$tabFound   = false;
+
+			$commentLength = strlen($comment);
+			for ($i = 2; $i < $commentLength; $i++) {
+				if ($comment[$i] === "\t") {
+					$tabFound = true;
+					break;
+				}
+
+				if ($comment[$i] !== ' ') {
+					break;
+				}
+
+				$spaceCount++;
+			}
+
+			$fix = false;
+			if ($tabFound === true) {
+				$error = 'Tab found before comment text; expected "// %s" but found "%s"';
+				$data  = [
+					ltrim(substr($comment, 2)),
+					$comment,
+				];
+				$fix   = $phpcsFile->addFixableError($error, $lastCommentToken, 'TabBefore', $data);
+			} else if ($spaceCount === 0) {
+				$error = 'No space found before comment text; expected "// %s" but found "%s"';
+				$data  = [
+					substr($comment, 2),
+					$comment,
+				];
+				$fix   = $phpcsFile->addFixableError($error, $lastCommentToken, 'NoSpaceBefore', $data);
+			} else if ($spaceCount > 1) {
+				$error = 'Expected 1 space before comment text but found %s; use block comment if you need indentation';
+				$data  = [
+					$spaceCount,
+					substr($comment, (2 + $spaceCount)),
+					$comment,
+				];
+				$fix   = $phpcsFile->addFixableError($error, $lastCommentToken, 'SpacingBefore', $data);
+			}//end if
+
+			if ($fix === true) {
+				$newComment = '// '.ltrim($tokens[$lastCommentToken]['content'], "/\t ");
+				$phpcsFile->fixer->replaceToken($lastCommentToken, $newComment);
+			}
+
+			$commentText .= trim(substr($tokens[$lastCommentToken]['content'], 2));
+		}//end foreach
+
+		if ($commentText === '') {
+			$error = 'Blank comments are not allowed';
+			$fix   = $phpcsFile->addFixableError($error, $stackPtr, 'Empty');
+			if ($fix === true) {
+				$phpcsFile->fixer->replaceToken($stackPtr, '');
+			}
+
+			return ($lastCommentToken + 1);
+		}
+
+		if (preg_match('/^\p{Ll}/u', $commentText) === 1) {
+			$error = 'Inline comments must start with a capital letter';
+			$phpcsFile->addError($error, $stackPtr, 'NotCapital');
+		}
+
+		// Only check the end of comment character if the start of the comment
+		// is a letter, indicating that the comment is just standard text.
+		if (preg_match('/^\p{L}/u', $commentText) === 1) {
+			$commentCloser   = $commentText[(strlen($commentText) - 1)];
+			$acceptedClosers = [
+				'full-stops'        => '.',
+				'exclamation marks' => '!',
+				'or question marks' => '?',
+			];
+
+			if (in_array($commentCloser, $acceptedClosers, true) === false) {
+				$error = 'Inline comments must end in %s';
+				$ender = '';
+				foreach ($acceptedClosers as $closerName => $symbol) {
+					$ender .= ' '.$closerName.',';
+				}
+
+				$ender = trim($ender, ' ,');
+				$data  = [$ender];
+				$phpcsFile->addError($error, $lastCommentToken, 'InvalidEndChar', $data);
+			}
+		}
+
+		// Finally, the line below the last comment cannot be empty if this inline
+		// comment is on a line by itself.
+		if ($tokens[$previousContent]['line'] < $tokens[$stackPtr]['line']) {
+			$next = $phpcsFile->findNext(T_WHITESPACE, ($lastCommentToken + 1), null, true);
+			if ($next === false) {
+				// Ignore if the comment is the last non-whitespace token in a file.
+				return ($lastCommentToken + 1);
+			}
+
+			if ($tokens[$next]['code'] === T_DOC_COMMENT_OPEN_TAG) {
+				// If this inline comment is followed by a docblock,
+				// ignore spacing as docblock/function etc spacing rules
+				// are likely to conflict with our rules.
+				return ($lastCommentToken + 1);
+			}
+
+			$errorCode = 'SpacingAfter';
+
+			if (isset($tokens[$stackPtr]['conditions']) === true) {
+				$conditions   = $tokens[$stackPtr]['conditions'];
+				$type         = end($conditions);
+				$conditionPtr = key($conditions);
+
+				if (($type === T_FUNCTION || $type === T_CLOSURE)
+					&& $tokens[$conditionPtr]['scope_closer'] === $next
+				) {
+					$errorCode = 'SpacingAfterAtFunctionEnd';
+				}
+			}
+
+			for ($i = ($lastCommentToken + 1); $i < $phpcsFile->numTokens; $i++) {
+				if ($tokens[$i]['line'] === ($tokens[$lastCommentToken]['line'] + 1)) {
+					if ($tokens[$i]['code'] !== T_WHITESPACE) {
+						return ($lastCommentToken + 1);
+					}
+				} else if ($tokens[$i]['line'] > ($tokens[$lastCommentToken]['line'] + 1)) {
+					break;
+				}
+			}
+
+			$error = 'There must be no blank line following an inline comment';
+			$fix   = $phpcsFile->addFixableError($error, $lastCommentToken, $errorCode);
+			if ($fix === true) {
+				$phpcsFile->fixer->beginChangeset();
+				for ($i = ($lastCommentToken + 1); $i < $next; $i++) {
+					if ($tokens[$i]['line'] === $tokens[$next]['line']) {
+						break;
+					}
+
+					$phpcsFile->fixer->replaceToken($i, '');
+				}
+
+				$phpcsFile->fixer->endChangeset();
+			}
+		}//end if
+
+		return ($lastCommentToken + 1);
+
+	}//end process()
 
 
 }//end class

Spacing +95 added lines, -95 removed lines

@@ -51,17 +51,17 @@ 
      *
      * @return void
      */
-    public function process(File $phpcsFile, $stackPtr)
+    public function process( File $phpcsFile, $stackPtr )
     {
         $tokens = $phpcsFile->getTokens();
 
         // If this is a function/class/interface doc block comment, skip it.
         // We are only interested in inline doc block comments, which are
         // not allowed.
-        if ($tokens[$stackPtr]['code'] === T_DOC_COMMENT_OPEN_TAG) {
+        if ( $tokens[ $stackPtr ][ 'code' ] === T_DOC_COMMENT_OPEN_TAG ) {
             $nextToken = $phpcsFile->findNext(
                 Tokens::$emptyTokens,
-                ($stackPtr + 1),
+                ( $stackPtr + 1 ),
                 null,
                 true
             );
@@ -86,22 +86,22 @@ 
                 T_REQUIRE_ONCE,
             ];
 
-            if (in_array($tokens[$nextToken]['code'], $ignore, true) === true) {
+            if ( in_array( $tokens[ $nextToken ][ 'code' ], $ignore, true ) === true ) {
                 return;
             }
 
-            if ($phpcsFile->tokenizerType === 'JS') {
+            if ( $phpcsFile->tokenizerType === 'JS' ) {
                 // We allow block comments if a function or object
                 // is being assigned to a variable.
                 $ignore    = Tokens::$emptyTokens;
-                $ignore[]  = T_EQUAL;
-                $ignore[]  = T_STRING;
-                $ignore[]  = T_OBJECT_OPERATOR;
-                $nextToken = $phpcsFile->findNext($ignore, ($nextToken + 1), null, true);
-                if ($tokens[$nextToken]['code'] === T_FUNCTION
-                    || $tokens[$nextToken]['code'] === T_CLOSURE
-                    || $tokens[$nextToken]['code'] === T_OBJECT
-                    || $tokens[$nextToken]['code'] === T_PROTOTYPE
+                $ignore[ ]  = T_EQUAL;
+                $ignore[ ]  = T_STRING;
+                $ignore[ ]  = T_OBJECT_OPERATOR;
+                $nextToken = $phpcsFile->findNext( $ignore, ( $nextToken + 1 ), null, true );
+                if ( $tokens[ $nextToken ][ 'code' ] === T_FUNCTION
+                    || $tokens[ $nextToken ][ 'code' ] === T_CLOSURE
+                    || $tokens[ $nextToken ][ 'code' ] === T_OBJECT
+                    || $tokens[ $nextToken ][ 'code' ] === T_PROTOTYPE
                 ) {
                     return;
                 }
@@ -109,99 +109,99 @@ 
 
             $prevToken = $phpcsFile->findPrevious(
                 Tokens::$emptyTokens,
-                ($stackPtr - 1),
+                ( $stackPtr - 1 ),
                 null,
                 true
             );
 
-            if ($tokens[$prevToken]['code'] === T_OPEN_TAG) {
+            if ( $tokens[ $prevToken ][ 'code' ] === T_OPEN_TAG ) {
                 return;
             }
 
-            if ($tokens[$stackPtr]['content'] === '/**') {
+            if ( $tokens[ $stackPtr ][ 'content' ] === '/**' ) {
                 $error = 'Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead';
-                $phpcsFile->addError($error, $stackPtr, 'DocBlock');
+                $phpcsFile->addError( $error, $stackPtr, 'DocBlock' );
             }
         }//end if
 
-        if ($tokens[$stackPtr]['content']{0} === '#') {
+        if ( $tokens[ $stackPtr ][ 'content' ]{0} === '#' ) {
             $error = 'Perl-style comments are not allowed; use "// Comment" instead';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'WrongStyle');
-            if ($fix === true) {
-                $comment = ltrim($tokens[$stackPtr]['content'], "# \t");
-                $phpcsFile->fixer->replaceToken($stackPtr, "// $comment");
+            $fix   = $phpcsFile->addFixableError( $error, $stackPtr, 'WrongStyle' );
+            if ( $fix === true ) {
+                $comment = ltrim( $tokens[ $stackPtr ][ 'content' ], "# \t" );
+                $phpcsFile->fixer->replaceToken( $stackPtr, "// $comment" );
             }
         }
 
         // We don't want end of block comments. Check if the last token before the
         // comment is a closing curly brace.
-        $previousContent = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
-        if ($tokens[$previousContent]['line'] === $tokens[$stackPtr]['line']) {
-            if ($tokens[$previousContent]['code'] === T_CLOSE_CURLY_BRACKET) {
+        $previousContent = $phpcsFile->findPrevious( T_WHITESPACE, ( $stackPtr - 1 ), null, true );
+        if ( $tokens[ $previousContent ][ 'line' ] === $tokens[ $stackPtr ][ 'line' ] ) {
+            if ( $tokens[ $previousContent ][ 'code' ] === T_CLOSE_CURLY_BRACKET ) {
                 return;
             }
 
             // Special case for JS files.
-            if ($tokens[$previousContent]['code'] === T_COMMA
-                || $tokens[$previousContent]['code'] === T_SEMICOLON
+            if ( $tokens[ $previousContent ][ 'code' ] === T_COMMA
+                || $tokens[ $previousContent ][ 'code' ] === T_SEMICOLON
             ) {
-                $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($previousContent - 1), null, true);
-                if ($tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) {
+                $lastContent = $phpcsFile->findPrevious( T_WHITESPACE, ( $previousContent - 1 ), null, true );
+                if ( $tokens[ $lastContent ][ 'code' ] === T_CLOSE_CURLY_BRACKET ) {
                     return;
                 }
             }
         }
 
         // Only want inline comments.
-        if (substr($tokens[$stackPtr]['content'], 0, 2) !== '//') {
+        if ( substr( $tokens[ $stackPtr ][ 'content' ], 0, 2 ) !== '//' ) {
             return;
         }
 
-        $commentTokens = [$stackPtr];
+        $commentTokens = [ $stackPtr ];
 
         $nextComment = $stackPtr;
         $lastComment = $stackPtr;
-        while (($nextComment = $phpcsFile->findNext(T_COMMENT, ($nextComment + 1), null, false)) !== false) {
-            if ($tokens[$nextComment]['line'] !== ($tokens[$lastComment]['line'] + 1)) {
+        while ( ( $nextComment = $phpcsFile->findNext( T_COMMENT, ( $nextComment + 1 ), null, false ) ) !== false ) {
+            if ( $tokens[ $nextComment ][ 'line' ] !== ( $tokens[ $lastComment ][ 'line' ] + 1 ) ) {
                 break;
             }
 
             // Only want inline comments.
-            if (substr($tokens[$nextComment]['content'], 0, 2) !== '//') {
+            if ( substr( $tokens[ $nextComment ][ 'content' ], 0, 2 ) !== '//' ) {
                 break;
             }
 
             // There is a comment on the very next line. If there is
             // no code between the comments, they are part of the same
             // comment block.
-            $prevNonWhitespace = $phpcsFile->findPrevious(T_WHITESPACE, ($nextComment - 1), $lastComment, true);
-            if ($prevNonWhitespace !== $lastComment) {
+            $prevNonWhitespace = $phpcsFile->findPrevious( T_WHITESPACE, ( $nextComment - 1 ), $lastComment, true );
+            if ( $prevNonWhitespace !== $lastComment ) {
                 break;
             }
 
-            $commentTokens[] = $nextComment;
+            $commentTokens[ ] = $nextComment;
             $lastComment     = $nextComment;
         }//end while
 
         $commentText = '';
-        foreach ($commentTokens as $lastCommentToken) {
-            $comment = rtrim($tokens[$lastCommentToken]['content']);
+        foreach ( $commentTokens as $lastCommentToken ) {
+            $comment = rtrim( $tokens[ $lastCommentToken ][ 'content' ] );
 
-            if (trim(substr($comment, 2)) === '') {
+            if ( trim( substr( $comment, 2 ) ) === '' ) {
                 continue;
             }
 
             $spaceCount = 0;
             $tabFound   = false;
 
-            $commentLength = strlen($comment);
-            for ($i = 2; $i < $commentLength; $i++) {
-                if ($comment[$i] === "\t") {
+            $commentLength = strlen( $comment );
+            for ( $i = 2; $i < $commentLength; $i++ ) {
+                if ( $comment[ $i ] === "\t" ) {
                     $tabFound = true;
                     break;
                 }
 
-                if ($comment[$i] !== ' ') {
+                if ( $comment[ $i ] !== ' ' ) {
                     break;
                 }
 
@@ -209,133 +209,133 @@ 
             }
 
             $fix = false;
-            if ($tabFound === true) {
+            if ( $tabFound === true ) {
                 $error = 'Tab found before comment text; expected "// %s" but found "%s"';
                 $data  = [
-                    ltrim(substr($comment, 2)),
+                    ltrim( substr( $comment, 2 ) ),
                     $comment,
                 ];
-                $fix   = $phpcsFile->addFixableError($error, $lastCommentToken, 'TabBefore', $data);
-            } else if ($spaceCount === 0) {
+                $fix   = $phpcsFile->addFixableError( $error, $lastCommentToken, 'TabBefore', $data );
+            } else if ( $spaceCount === 0 ) {
                 $error = 'No space found before comment text; expected "// %s" but found "%s"';
                 $data  = [
-                    substr($comment, 2),
+                    substr( $comment, 2 ),
                     $comment,
                 ];
-                $fix   = $phpcsFile->addFixableError($error, $lastCommentToken, 'NoSpaceBefore', $data);
-            } else if ($spaceCount > 1) {
+                $fix   = $phpcsFile->addFixableError( $error, $lastCommentToken, 'NoSpaceBefore', $data );
+            } else if ( $spaceCount > 1 ) {
                 $error = 'Expected 1 space before comment text but found %s; use block comment if you need indentation';
                 $data  = [
                     $spaceCount,
-                    substr($comment, (2 + $spaceCount)),
+                    substr( $comment, ( 2 + $spaceCount ) ),
                     $comment,
                 ];
-                $fix   = $phpcsFile->addFixableError($error, $lastCommentToken, 'SpacingBefore', $data);
+                $fix = $phpcsFile->addFixableError( $error, $lastCommentToken, 'SpacingBefore', $data );
             }//end if
 
-            if ($fix === true) {
-                $newComment = '// '.ltrim($tokens[$lastCommentToken]['content'], "/\t ");
-                $phpcsFile->fixer->replaceToken($lastCommentToken, $newComment);
+            if ( $fix === true ) {
+                $newComment = '// ' . ltrim( $tokens[ $lastCommentToken ][ 'content' ], "/\t " );
+                $phpcsFile->fixer->replaceToken( $lastCommentToken, $newComment );
             }
 
-            $commentText .= trim(substr($tokens[$lastCommentToken]['content'], 2));
+            $commentText .= trim( substr( $tokens[ $lastCommentToken ][ 'content' ], 2 ) );
         }//end foreach
 
-        if ($commentText === '') {
+        if ( $commentText === '' ) {
             $error = 'Blank comments are not allowed';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'Empty');
-            if ($fix === true) {
-                $phpcsFile->fixer->replaceToken($stackPtr, '');
+            $fix   = $phpcsFile->addFixableError( $error, $stackPtr, 'Empty' );
+            if ( $fix === true ) {
+                $phpcsFile->fixer->replaceToken( $stackPtr, '' );
             }
 
-            return ($lastCommentToken + 1);
+            return ( $lastCommentToken + 1 );
         }
 
-        if (preg_match('/^\p{Ll}/u', $commentText) === 1) {
+        if ( preg_match( '/^\p{Ll}/u', $commentText ) === 1 ) {
             $error = 'Inline comments must start with a capital letter';
-            $phpcsFile->addError($error, $stackPtr, 'NotCapital');
+            $phpcsFile->addError( $error, $stackPtr, 'NotCapital' );
         }
 
         // Only check the end of comment character if the start of the comment
         // is a letter, indicating that the comment is just standard text.
-        if (preg_match('/^\p{L}/u', $commentText) === 1) {
-            $commentCloser   = $commentText[(strlen($commentText) - 1)];
+        if ( preg_match( '/^\p{L}/u', $commentText ) === 1 ) {
+            $commentCloser   = $commentText[ ( strlen( $commentText ) - 1 ) ];
             $acceptedClosers = [
                 'full-stops'        => '.',
                 'exclamation marks' => '!',
                 'or question marks' => '?',
             ];
 
-            if (in_array($commentCloser, $acceptedClosers, true) === false) {
+            if ( in_array( $commentCloser, $acceptedClosers, true ) === false ) {
                 $error = 'Inline comments must end in %s';
                 $ender = '';
-                foreach ($acceptedClosers as $closerName => $symbol) {
-                    $ender .= ' '.$closerName.',';
+                foreach ( $acceptedClosers as $closerName => $symbol ) {
+                    $ender .= ' ' . $closerName . ',';
                 }
 
-                $ender = trim($ender, ' ,');
-                $data  = [$ender];
-                $phpcsFile->addError($error, $lastCommentToken, 'InvalidEndChar', $data);
+                $ender = trim( $ender, ' ,' );
+                $data  = [ $ender ];
+                $phpcsFile->addError( $error, $lastCommentToken, 'InvalidEndChar', $data );
             }
         }
 
         // Finally, the line below the last comment cannot be empty if this inline
         // comment is on a line by itself.
-        if ($tokens[$previousContent]['line'] < $tokens[$stackPtr]['line']) {
-            $next = $phpcsFile->findNext(T_WHITESPACE, ($lastCommentToken + 1), null, true);
-            if ($next === false) {
+        if ( $tokens[ $previousContent ][ 'line' ] < $tokens[ $stackPtr ][ 'line' ] ) {
+            $next = $phpcsFile->findNext( T_WHITESPACE, ( $lastCommentToken + 1 ), null, true );
+            if ( $next === false ) {
                 // Ignore if the comment is the last non-whitespace token in a file.
-                return ($lastCommentToken + 1);
+                return ( $lastCommentToken + 1 );
             }
 
-            if ($tokens[$next]['code'] === T_DOC_COMMENT_OPEN_TAG) {
+            if ( $tokens[ $next ][ 'code' ] === T_DOC_COMMENT_OPEN_TAG ) {
                 // If this inline comment is followed by a docblock,
                 // ignore spacing as docblock/function etc spacing rules
                 // are likely to conflict with our rules.
-                return ($lastCommentToken + 1);
+                return ( $lastCommentToken + 1 );
             }
 
             $errorCode = 'SpacingAfter';
 
-            if (isset($tokens[$stackPtr]['conditions']) === true) {
-                $conditions   = $tokens[$stackPtr]['conditions'];
-                $type         = end($conditions);
-                $conditionPtr = key($conditions);
+            if ( isset( $tokens[ $stackPtr ][ 'conditions' ] ) === true ) {
+                $conditions   = $tokens[ $stackPtr ][ 'conditions' ];
+                $type         = end( $conditions );
+                $conditionPtr = key( $conditions );
 
-                if (($type === T_FUNCTION || $type === T_CLOSURE)
-                    && $tokens[$conditionPtr]['scope_closer'] === $next
+                if ( ( $type === T_FUNCTION || $type === T_CLOSURE )
+                    && $tokens[ $conditionPtr ][ 'scope_closer' ] === $next
                 ) {
                     $errorCode = 'SpacingAfterAtFunctionEnd';
                 }
             }
 
-            for ($i = ($lastCommentToken + 1); $i < $phpcsFile->numTokens; $i++) {
-                if ($tokens[$i]['line'] === ($tokens[$lastCommentToken]['line'] + 1)) {
-                    if ($tokens[$i]['code'] !== T_WHITESPACE) {
-                        return ($lastCommentToken + 1);
+            for ( $i = ( $lastCommentToken + 1 ); $i < $phpcsFile->numTokens; $i++ ) {
+                if ( $tokens[ $i ][ 'line' ] === ( $tokens[ $lastCommentToken ][ 'line' ] + 1 ) ) {
+                    if ( $tokens[ $i ][ 'code' ] !== T_WHITESPACE ) {
+                        return ( $lastCommentToken + 1 );
                     }
-                } else if ($tokens[$i]['line'] > ($tokens[$lastCommentToken]['line'] + 1)) {
+                } else if ( $tokens[ $i ][ 'line' ] > ( $tokens[ $lastCommentToken ][ 'line' ] + 1 ) ) {
                     break;
                 }
             }
 
             $error = 'There must be no blank line following an inline comment';
-            $fix   = $phpcsFile->addFixableError($error, $lastCommentToken, $errorCode);
-            if ($fix === true) {
+            $fix   = $phpcsFile->addFixableError( $error, $lastCommentToken, $errorCode );
+            if ( $fix === true ) {
                 $phpcsFile->fixer->beginChangeset();
-                for ($i = ($lastCommentToken + 1); $i < $next; $i++) {
-                    if ($tokens[$i]['line'] === $tokens[$next]['line']) {
+                for ( $i = ( $lastCommentToken + 1 ); $i < $next; $i++ ) {
+                    if ( $tokens[ $i ][ 'line' ] === $tokens[ $next ][ 'line' ] ) {
                         break;
                     }
 
-                    $phpcsFile->fixer->replaceToken($i, '');
+                    $phpcsFile->fixer->replaceToken( $i, '' );
                 }
 
                 $phpcsFile->fixer->endChangeset();
             }
         }//end if
 
-        return ($lastCommentToken + 1);
+        return ( $lastCommentToken + 1 );
 
     }//end process()
 

Braces +3 added lines, -6 removed lines

@@ -13,8 +13,7 @@ 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Util\Tokens;
 
-class InlineCommentSniff implements Sniff
-{
+class InlineCommentSniff implements Sniff {
 
     /**
      * A list of tokenizers this sniff supports.
@@ -32,8 +31,7 @@ 
      *
      * @return array
      */
-    public function register()
-    {
+    public function register() {
         return [
             T_COMMENT,
             T_DOC_COMMENT_OPEN_TAG,
@@ -51,8 +49,7 @@ 
      *
      * @return void
      */
-    public function process(File $phpcsFile, $stackPtr)
-    {
+    public function process(File $phpcsFile, $stackPtr) {
         $tokens = $phpcsFile->getTokens();
 
         // If this is a function/class/interface doc block comment, skip it.