PHPCI

tests/codesniffer/FHComplete/Sniffs/ControlStructures/WhileStructuresSniff.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * PHP Version 5
+ *
+ * FHComplete
+ */
+
+/**
+ * Ensures that while and do-while use curly brackets
+ *
+ */
+class FHComplete_Sniffs_ControlStructures_WhileStructuresSniff implements PHP_CodeSniffer_Sniff
+{
+
+/**
+ * Returns an array of tokens this test wants to listen for.
+ *
+ * @return array
+ */
+    public function register()
+    {
+        return array(T_DO, T_WHILE);
+    }
+
+/**
+ * Processes this test, when one of its tokens is encountered.
+ *
+ * Checks that while and do-while use curly brackets
+ *
+ * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+ * @param integer              $stackPtr  The position of the current token in the
+ *                                        stack passed in $tokens.
+ * @return void
+ */
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
+        if ($tokens[$nextToken]['code'] === T_OPEN_PARENTHESIS) {
+            $closer = $tokens[$nextToken]['parenthesis_closer'];
+            $diff = $closer - $stackPtr;
+            $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + $diff + 1), null, true);
+        }
+
+        if ($tokens[$stackPtr]['code'] === T_WHILE && $tokens[$nextToken]['code'] === T_SEMICOLON) {
+            /* This while is probably part of a do-while construction, skip it .. */
+            return;
+        }
+        if ($tokens[$nextToken]['code'] !== T_OPEN_CURLY_BRACKET && $tokens[$nextToken]['code'] !== T_COLON) {
+            $error = 'Curly brackets required in a do-while or while loop';
+            $phpcsFile->addError($error, $stackPtr, 'NotAllowed');
+        }
+    }
+
+}