ClassFileNameSniff

<?php
/**
 * Zend_Sniffs_Classes_ValidClassNameSniff.
 *
 * PHP version 5
 *
 * @category  PHP
 * @package   PHP_CodeSniffer
 * @author    Juan Sotuyo <juansotuyo@gmail.com>
 * @copyright 2010 Juan Sotuyo (Buenos Aires, Argentina)
 * @license   BSD Licence
 * @version   1.0
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 */

/**
 * Zend_Sniffs_Classes_ValidClassNameSniff.
 *
 * Ensures classes are in camel caps, and the first letter is capitalised.
 * Numers are allowed but discouraged, and undersocres are allowed.
 *
 * @category  PHP
 * @package   PHP_CodeSniffer
 * @author    Juan Sotuyo <juansotuyo@gmail.com>
 * @copyright 2010 Juan Sotuyo (Buenos Aires, Argentina)
 * @license   BSD Licence
 * @version   Release: 1.2.2
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 */
class Zend_Sniffs_Classes_ValidClassNameSniff implements PHP_CodeSniffer_Sniff
{
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array
     */
    public function register()
    {
        return array(
                T_CLASS,
                T_INTERFACE,
               );

    }//end register()


    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param PHP_CodeSniffer_File $phpcsFile The current file being processed.
     * @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();

        $name      = $phpcsFile->getDeclarationName($stackPtr);

        // Check for name format.
        $valid = $this->nameIsValid($name);

        if ($valid === false) {
            $type  = ucfirst($tokens[$stackPtr]['content']);
            $error = " name \"$name\" is not in camel caps format";
            $phpcsFile->addError($error, $stackPtr);
        }

    }//end process()

    private function nameIsValid($name)
    {
        $letters = str_split($name);

        // First letter must be upper-case or numeric, following characters must be lowercase / underscores / numbers
        $requiresUpper = true;
        $lastWasUpper = false;

        foreach ($letters as $letter) {
                if (!$requiresUpper && $letter == '_') {
                        $requiresUpper = true;
                        $lastWasUpper = false;
                        continue;
                }

                // Number are allways valid
                if (ctype_digit($letter)) {
                        $requiresUpper = false;
                        $lastWasUpper = false;
                        continue;
                }

                // If a capital letter is required
                if ($requiresUpper) {
                        if (!ctype_upper($letter)) {
                                return false;
                        }

                        $requiresUpper = false;
                        $lastWasUpper = true;
                        continue;
                }

                if (!ctype_alpha($letter)) {
                        return false;
                }

                $requiresUpper = false;
                $lastWasUpper = false;
        }

        return true;
    }//end nameIsValid()


}//end class


?>