CodingStandard\Sniffs\Formatting\ItemAssignmentSniff

Complexity

Total Complexity

11

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

95.83%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	4	1
A	process()	0	5	1
A	hasOnlySpaces()	0	4	1
B	checkSpacing()	0	52	8

<?php
/**
 * CodingStandard_Sniffs_Formatting_ItemAssignmentSniff.
 *
 * PHP version 5
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @author   Peter Philipp <peter.philipp@cando-image.com>
 * @author   Alexander Obuhovich <aik.bold@gmail.com>
 * @license  https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
 * @link     https://github.com/aik099/CodingStandard
 */

namespace CodingStandard\Sniffs\Formatting;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;

/**
 * CodingStandard_Sniffs_Formatting_ItemAssignmentSniff.
 *
 * Checks if the item assignment operator (=>) has
 * - a space before and after
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @author   Peter Philipp <peter.philipp@cando-image.com>
 * @author   Alexander Obuhovich <aik.bold@gmail.com>
 * @license  https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
 * @link     https://github.com/aik099/CodingStandard
 */
class ItemAssignmentSniff implements Sniff
{


    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return integer[]
     */
    public function register()
    {
        return array(T_DOUBLE_ARROW);
    }//end register()


    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param 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)
    {
        $this->checkSpacing($phpcsFile, $stackPtr, true);
        $this->checkSpacing($phpcsFile, $stackPtr, false);
    }//end process()


    /**
     * Checks spacing at given position.
     *
     * @param File $phpcsFile The file being scanned.
     * @param int  $stackPtr  The position of the current token in the
     *                        stack passed in $tokens.
     * @param bool $before    Determines direction in which to check spacing.
     *
     * @return void
     */
    protected function checkSpacing(File $phpcsFile, $stackPtr, $before)
    {
        if ($before === true) {
            $stackPtrDiff = -1;
            $errorWord    = 'prefix';
            $errorCode    = 'Before';
        } else {
            $stackPtrDiff = 1;
            $errorWord    = 'follow';
            $errorCode    = 'After';
        }

        $tokens    = $phpcsFile->getTokens();
        $tokenData = $tokens[($stackPtr + $stackPtrDiff)];

        if ($tokenData['code'] !== T_WHITESPACE) {
            $error = 'Whitespace must '.$errorWord.' the item assignment operator =>';
            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpacing'.$errorCode);
            if ($fix === true) {
                $phpcsFile->fixer->beginChangeset();

                if ($before === true) {
                    $phpcsFile->fixer->addContentBefore($stackPtr, ' ');
                } else {
                    $phpcsFile->fixer->addContent($stackPtr, ' ');
                }

                $phpcsFile->fixer->endChangeset();
            }

            return;
        }

        if (isset($tokenData['orig_content']) === true) {
            $content = $tokenData['orig_content'];
        } else {
            $content = $tokenData['content'];
        }

        if ($this->hasOnlySpaces($content) === false) {
            $error = 'Spaces must be used to '.$errorWord.' the item assignment operator =>';
            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'MixedWhitespace'.$errorCode);
            if ($fix === true) {
                $phpcsFile->fixer->beginChangeset();
                $phpcsFile->fixer->replaceToken(
                    ($stackPtr + $stackPtrDiff),
                    str_repeat(' ', strlen($content))
                );
                $phpcsFile->fixer->endChangeset();
            }
        }
    }//end checkSpacing()


    /**
     * Detects, that string contains only spaces.
     *
     * @param string $string String.
     *
     * @return bool
     */
    protected function hasOnlySpaces($string)
    {
        return substr_count($string, ' ') === strlen($string);
    }//end hasOnlySpaces()
}//end class