Initial Commit

database/php/pear/PHP/CodeSniffer/Standards/Generic/Sniffs/NamingConventions/ConstructorNameSniff.php

@@ -0,0 +1,101 @@
+<?php
+/**
+ * Generic_Sniffs_NamingConventions_ConstructorNameSniff.
+ *
+ * PHP version 5
+ *
+ * @category  PHP
+ * @package   PHP_CodeSniffer
+ * @author    Greg Sherwood <gsherwood@squiz.net>
+ * @author    Leif Wickland <lwickland@rightnow.com>
+ * @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
+ * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
+ * @link      http://pear.php.net/package/PHP_CodeSniffer
+ */
+
+if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) {
+    $error = 'Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found';
+    throw new PHP_CodeSniffer_Exception($error);
+}
+
+/**
+ * Generic_Sniffs_NamingConventions_ConstructorNameSniff.
+ *
+ * Favor PHP 5 constructor syntax, which uses "function __construct()".
+ * Avoid PHP 4 constructor syntax, which uses "function ClassName()".
+ *
+ * @category PHP
+ * @package  PHP_CodeSniffer
+ * @author   Leif Wickland <lwickland@rightnow.com>
+ * @license  http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
+ * @version  Release: 1.3.3
+ * @link     http://pear.php.net/package/PHP_CodeSniffer
+ */
+class Generic_Sniffs_NamingConventions_ConstructorNameSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff
+{
+
+
+    /**
+     * Constructs the test with the tokens it wishes to listen for.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        parent::__construct(array(T_CLASS, T_INTERFACE), array(T_FUNCTION), true);
+
+    }//end __construct()
+
+
+    /**
+     * Processes this test when one of its tokens is encountered.
+     *
+     * @param PHP_CodeSniffer_File $phpcsFile The current file being scanned.
+     * @param int                  $stackPtr  The position of the current token
+     *                                        in the stack passed in $tokens.
+     * @param int                  $currScope A pointer to the start of the scope.
+     *
+     * @return void
+     */
+    protected function processTokenWithinScope(
+        PHP_CodeSniffer_File $phpcsFile,
+        $stackPtr,
+        $currScope
+    ) {
+        $className  = $phpcsFile->getDeclarationName($currScope);
+        $methodName = $phpcsFile->getDeclarationName($stackPtr);
+
+        if (strcasecmp($methodName, $className) === 0) {
+            $error = 'PHP4 style constructors are not allowed; use "__construct()" instead';
+            $phpcsFile->addError($error, $stackPtr, 'OldStyle');
+        } else if (strcasecmp($methodName, '__construct') !== 0) {
+            // Not a constructor.
+            return;
+        }
+
+        $tokens = $phpcsFile->getTokens();
+
+        $parentClassName = $phpcsFile->findExtendedClassName($currScope);
+        if ($parentClassName === false) {
+            return;
+        }
+
+        $endFunctionIndex = $tokens[$stackPtr]['scope_closer'];
+        $startIndex       = $stackPtr;
+        while ($doubleColonIndex = $phpcsFile->findNext(array(T_DOUBLE_COLON), $startIndex, $endFunctionIndex)) {
+            if ($tokens[($doubleColonIndex + 1)]['code'] === T_STRING
+                && $tokens[($doubleColonIndex + 1)]['content'] === $parentClassName
+            ) {
+                $error = 'PHP4 style calls to parent constructors are not allowed; use "parent::__construct()" instead';
+                $phpcsFile->addError($error, ($doubleColonIndex + 1), 'OldStyleCall');
+            }
+
+            $startIndex = ($doubleColonIndex + 1);
+        }
+
+    }//end processTokenWithinScope()
+
+
+}//end class
+
+?>

database/php/pear/PHP/CodeSniffer/Standards/Generic/Sniffs/NamingConventions/UpperCaseConstantNameSniff.php

@@ -0,0 +1,198 @@
+<?php
+/**
+ * Generic_Sniffs_NamingConventions_UpperCaseConstantNameSniff.
+ *
+ * PHP version 5
+ *
+ * @category  PHP
+ * @package   PHP_CodeSniffer
+ * @author    Greg Sherwood <gsherwood@squiz.net>
+ * @author    Marc McIntyre <mmcintyre@squiz.net>
+ * @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
+ * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
+ * @link      http://pear.php.net/package/PHP_CodeSniffer
+ */
+
+/**
+ * Generic_Sniffs_NamingConventions_UpperCaseConstantNameSniff.
+ *
+ * Ensures that constant names are all uppercase.
+ *
+ * @category  PHP
+ * @package   PHP_CodeSniffer
+ * @author    Greg Sherwood <gsherwood@squiz.net>
+ * @author    Marc McIntyre <mmcintyre@squiz.net>
+ * @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
+ * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
+ * @version   Release: 1.3.3
+ * @link      http://pear.php.net/package/PHP_CodeSniffer
+ */
+class Generic_Sniffs_NamingConventions_UpperCaseConstantNameSniff implements PHP_CodeSniffer_Sniff
+{
+
+
+    /**
+     * Returns an array of tokens this test wants to listen for.
+     *
+     * @return array
+     */
+    public function register()
+    {
+        return array(T_STRING);
+
+    }//end register()
+
+
+    /**
+     * Processes this test, when one of its tokens is encountered.
+     *
+     * @param PHP_CodeSniffer_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(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    {
+        $tokens    = $phpcsFile->getTokens();
+        $constName = $tokens[$stackPtr]['content'];
+
+        // If this token is in a heredoc, ignore it.
+        if ($phpcsFile->hasCondition($stackPtr, T_START_HEREDOC) === true) {
+            return;
+        }
+
+        // Special case for PHPUnit.
+        if ($constName === 'PHPUnit_MAIN_METHOD') {
+            return;
+        }
+
+        // If the next non-whitespace token after this token
+        // is not an opening parenthesis then it is not a function call.
+        $openBracket = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
+        if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) {
+            $functionKeyword = $phpcsFile->findPrevious(array(T_WHITESPACE, T_COMMA, T_COMMENT, T_STRING, T_NS_SEPARATOR), ($stackPtr - 1), null, true);
+
+            $declarations = array(
+                             T_FUNCTION,
+                             T_CLASS,
+                             T_INTERFACE,
+                             T_IMPLEMENTS,
+                             T_EXTENDS,
+                             T_INSTANCEOF,
+                             T_NEW,
+                             T_NAMESPACE,
+                             T_USE,
+                             T_AS,
+                            );
+
+            if (in_array($tokens[$functionKeyword]['code'], $declarations) === true) {
+                // This is just a declaration; no constants here.
+                return;
+            }
+
+            if ($tokens[$functionKeyword]['code'] === T_CONST) {
+                // This is a class constant.
+                if (strtoupper($constName) !== $constName) {
+                    $error = 'Class constants must be uppercase; expected %s but found %s';
+                    $data  = array(
+                              strtoupper($constName),
+                              $constName,
+                             );
+                    $phpcsFile->addError($error, $stackPtr, 'ClassConstantNotUpperCase', $data);
+                }
+
+                return;
+            }
+
+            // Is this a class name?
+            $nextPtr = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
+            if ($tokens[$nextPtr]['code'] === T_DOUBLE_COLON) {
+                return;
+            }
+
+            // Is this a namespace name?
+            if ($tokens[$nextPtr]['code'] === T_NS_SEPARATOR) {
+                return;
+            }
+
+            // Is this a type hint?
+            if ($tokens[$nextPtr]['code'] === T_VARIABLE
+                || $phpcsFile->isReference($nextPtr) === true
+            ) {
+                return;
+            }
+
+            // Is this a member var name?
+            $prevPtr = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
+            if ($tokens[$prevPtr]['code'] === T_OBJECT_OPERATOR) {
+                return;
+            }
+
+            // Is this a namespace name?
+            if ($tokens[$prevPtr]['code'] === T_NS_SEPARATOR) {
+                return;
+            }
+
+            // Is this an instance of declare()
+            $prevPtr = $phpcsFile->findPrevious(array(T_WHITESPACE, T_OPEN_PARENTHESIS), ($stackPtr - 1), null, true);
+            if ($tokens[$prevPtr]['code'] === T_DECLARE) {
+                return;
+            }
+
+            // This is a real constant.
+            if (strtoupper($constName) !== $constName) {
+                $error = 'Constants must be uppercase; expected %s but found %s';
+                $data  = array(
+                          strtoupper($constName),
+                          $constName,
+                         );
+                $phpcsFile->addError($error, $stackPtr, 'ConstantNotUpperCase', $data);
+            }
+
+        } else if (strtolower($constName) === 'define' || strtolower($constName) === 'constant') {
+
+            /*
+                This may be a "define" or "constant" function call.
+            */
+
+            // Make sure this is not a method call.
+            $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
+            if ($tokens[$prev]['code'] === T_OBJECT_OPERATOR
+                || $tokens[$prev]['code'] === T_DOUBLE_COLON
+            ) {
+                return;
+            }
+
+            // The next non-whitespace token must be the constant name.
+            $constPtr = $phpcsFile->findNext(T_WHITESPACE, ($openBracket + 1), null, true);
+            if ($tokens[$constPtr]['code'] !== T_CONSTANT_ENCAPSED_STRING) {
+                return;
+            }
+
+            $constName = $tokens[$constPtr]['content'];
+
+            // Check for constants like self::CONSTANT.
+            $prefix   = '';
+            $splitPos = strpos($constName, '::');
+            if ($splitPos !== false) {
+                $prefix    = substr($constName, 0, ($splitPos + 2));
+                $constName = substr($constName, ($splitPos + 2));
+            }
+
+            if (strtoupper($constName) !== $constName) {
+                $error = 'Constants must be uppercase; expected %s but found %s';
+                $data  = array(
+                          $prefix.strtoupper($constName),
+                          $prefix.$constName,
+                         );
+                $phpcsFile->addError($error, $stackPtr, 'ConstantNotUpperCase', $data);
+            }
+        }//end if
+
+    }//end process()
+
+
+}//end class
+
+?>