Subversion-Projekte lars-tiefland.php_share

<?php

/**

 * Squiz_Sniffs_Functions_FunctionDeclarationArgumentSpacingSniff.

 *

 * PHP version 5

 *

 * @category  PHP

 * @package   PHP_CodeSniffer

 * @author    Greg Sherwood <gsherwood@squiz.net>

 * @author    Marc McIntyre <mmcintyre@squiz.net>

 * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)

 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence

 * @version   CVS: $Id: FunctionDeclarationArgumentSpacingSniff.php 274897 2009-01-29 23:39:52Z squiz $

 * @link      http://pear.php.net/package/PHP_CodeSniffer

 */

/**

 * Squiz_Sniffs_Functions_FunctionDeclarationArgumentSpacingSniff.

 *

 * Checks that arguments in function declarations are spaced correctly.

 *

 * @category  PHP

 * @package   PHP_CodeSniffer

 * @author    Greg Sherwood <gsherwood@squiz.net>

 * @author    Marc McIntyre <mmcintyre@squiz.net>

 * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)

 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence

 * @version   Release: 1.2.1

 * @link      http://pear.php.net/package/PHP_CodeSniffer

 */

class Squiz_Sniffs_Functions_FunctionDeclarationArgumentSpacingSniff implements PHP_CodeSniffer_Sniff

{

    /**

     * Returns an array of tokens this test wants to listen for.

     *

     * @return array

     */

    public function register()

    {

        return array(T_FUNCTION);

    }//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();

        $functionName = $phpcsFile->findNext(array(T_STRING), $stackPtr);

        $openBracket  = $tokens[$stackPtr]['parenthesis_opener'];

        $closeBracket = $tokens[$stackPtr]['parenthesis_closer'];

        $multiLine = ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']);

        $nextParam = $openBracket;

        $params    = array();

        while (($nextParam = $phpcsFile->findNext(T_VARIABLE, ($nextParam + 1), $closeBracket)) !== false) {

            $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($nextParam + 1), ($closeBracket + 1), true);

            if ($nextToken === false) {

                break;

            }

            $nextCode = $tokens[$nextToken]['code'];

            if ($nextCode === T_EQUAL) {

                // Check parameter default spacing.

                if (($nextToken - $nextParam) > 1) {

                    $gap   = strlen($tokens[($nextParam + 1)]['content']);

                    $arg   = $tokens[$nextParam]['content'];

                    $error = "Expected 0 spaces between argument \"$arg\" and equals sign; $gap found";

                    $phpcsFile->addError($error, $nextToken);

                }

                if ($tokens[($nextToken + 1)]['code'] === T_WHITESPACE) {

                    $gap   = strlen($tokens[($nextToken + 1)]['content']);

                    $arg   = $tokens[$nextParam]['content'];

                    $error = "Expected 0 spaces between default value and equals sign for argument \"$arg\"; $gap found";

                    $phpcsFile->addError($error, $nextToken);

                }

            }

            // Find and check the comma (if there is one).

            $nextComma = $phpcsFile->findNext(T_COMMA, ($nextParam + 1), $closeBracket);

            if ($nextComma !== false) {

                // Comma found.

                if ($tokens[($nextComma - 1)]['code'] === T_WHITESPACE) {

                    $space = strlen($tokens[($nextComma - 1)]['content']);

                    $arg   = $tokens[$nextParam]['content'];

                    $error = "Expected 0 spaces between argument \"$arg\" and comma; $space found";

                    $phpcsFile->addError($error, $nextToken);

                }

            }

            // Take references into account when expecting the

            // location of whitespace.

            if ($phpcsFile->isReference(($nextParam - 1)) === true) {

                $whitespace = $tokens[($nextParam - 2)];

            } else {

                $whitespace = $tokens[($nextParam - 1)];

            }

            if (empty($params) === false) {

                // This is not the first argument in the function declaration.

                $arg = $tokens[$nextParam]['content'];

                if ($whitespace['code'] === T_WHITESPACE) {

                    $gap = strlen($whitespace['content']);

                    // Before we throw an error, make sure there is no type hint.

                    $comma     = $phpcsFile->findPrevious(T_COMMA, ($nextParam - 1));

                    $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($comma + 1), null, true);

                    if ($phpcsFile->isReference($nextToken) === true) {

                        $nextToken++;

                    }

                    if ($nextToken !== $nextParam) {

                        // There was a type hint, so check the spacing between

                        // the hint and the variable as well.

                        $hint = $tokens[$nextToken]['content'];

                        if ($gap !== 1) {

                            $error = "Expected 1 space between type hint and argument \"$arg\"; $gap found";

                            $phpcsFile->addError($error, $nextToken);

                        }

                        if ($multiLine === false) {

                            if ($tokens[($comma + 1)]['code'] !== T_WHITESPACE) {

                                $error = "Expected 1 space between comma and type hint \"$hint\"; 0 found";

                                $phpcsFile->addError($error, $nextToken);

                            } else {

                                $gap = strlen($tokens[($comma + 1)]['content']);

                                if ($gap !== 1) {

                                    $error = "Expected 1 space between comma and type hint \"$hint\"; $gap found";

                                    $phpcsFile->addError($error, $nextToken);

                                }

                            }

                        }

                    } else if ($multiLine === false && $gap !== 1) {

                        $error = "Expected 1 space between comma and argument \"$arg\"; $gap found";

                        $phpcsFile->addError($error, $nextToken);

                    }//end if

                } else {

                    $error = "Expected 1 space between comma and argument \"$arg\"; 0 found";

                    $phpcsFile->addError($error, $nextToken);

                }//end if

            } else {

                // First argument in function declaration.

                if ($whitespace['code'] === T_WHITESPACE) {

                    $gap = strlen($whitespace['content']);

                    $arg = $tokens[$nextParam]['content'];

                    // Before we throw an error, make sure there is no type hint.

                    $bracket   = $phpcsFile->findPrevious(T_OPEN_PARENTHESIS, ($nextParam - 1));

                    $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($bracket + 1), null, true);

                    if ($phpcsFile->isReference($nextToken) === true) {

                        $nextToken++;

                    }

                    if ($nextToken !== $nextParam) {

                        // There was a type hint, so check the spacing between

                        // the hint and the variable as well.

                        $hint = $tokens[$nextToken]['content'];

                        if ($gap !== 1) {

                            $error = "Expected 1 space between type hint and argument \"$arg\"; $gap found";

                            $phpcsFile->addError($error, $nextToken);

                        }

                        if ($multiLine === false

                            && $tokens[($bracket + 1)]['code'] === T_WHITESPACE

                        ) {

                            $gap   = strlen($tokens[($bracket + 1)]['content']);

                            $error = "Expected 0 spaces between opening bracket and type hint \"$hint\"; $gap found";

                            $phpcsFile->addError($error, $nextToken);

                        }

                    } else if ($multiLine === false) {

                        $error = "Expected 0 spaces between opening bracket and argument \"$arg\"; $gap found";

                        $phpcsFile->addError($error, $nextToken);

                    }

                }//end if

            }//end if

            $params[] = $nextParam;

        }//end while

        if (empty($params) === true) {

            // There are no parameters for this function.

            if (($closeBracket - $openBracket) !== 1) {

                $space = strlen($tokens[($closeBracket - 1)]['content']);

                $error = "Expected 0 spaces between brackets of function declaration; $space found";

                $phpcsFile->addError($error, $stackPtr);

            }

        } else if ($multiLine === false

            && $tokens[($closeBracket - 1)]['code'] === T_WHITESPACE

        ) {

            $lastParam = array_pop($params);

            $arg       = $tokens[$lastParam]['content'];

            $gap       = strlen($tokens[($closeBracket - 1)]['content']);

            $error     = "Expected 0 spaces between argument \"$arg\" and closing bracket; $gap found";

            $phpcsFile->addError($error, $closeBracket);

        }

    }//end process()

}//end class

?>