PHPCompatibility_Sniffs_Upgrade_Release716Sniff

Complexity

Total Complexity

3

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	6	1
A	process()	0	15	2

<?php
/**
 * PHPCompatibility_Sniffs_Upgrade_Release716Sniff.
 *
 * @category PHP
 * @package  PHPCompatibility
 * @author   Juliette Reinders Folmer <phpcompatibility_nospam@adviesenzo.nl>
 */

/**
 * PHPCompatibility_Sniffs_Upgrade_Release716Sniff.
 *
 * Adds a temporary warning about the breaking changes in the upcoming 7.1.6
 * release of the PHPCompatibility standard.
 *
 * @category PHP
 * @package  PHPCompatibility
 * @author   Juliette Reinders Folmer <phpcompatibility_nospam@adviesenzo.nl>
 */
class PHPCompatibility_Sniffs_Upgrade_Release716Sniff extends PHPCompatibility_Sniff

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
	/**
	 * Keep track of whether the warning has been thrown yet.
	 *
	 * This warning should only be thrown once per run.
	 *
	 * @var bool
	 */
	protected $thrown = false;

    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array
     */
    public function register()
    {
        return array(
            T_OPEN_TAG,
        );
    }

    /**
     * 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)
    {
		// Don't do anything if the warning has already been thrown once.
        if ($this->thrown === true) {
            return ($phpcsFile->numTokens + 1);
        }

        $phpcsFile->addWarning(
            "IMPORTANT NOTICE:\nPlease be advised that the upcoming 7.1.6 version of the PHPCompatibility standard will contain a breaking change.\n\nPlease read the changelog carefully when you upgrade and follow the instructions contained therein to retain uninterupted service.\n\nThank you for using PHPCompatibility!",
            0,
            'BreakingChange'
        );

        $this->thrown = true;
    }
}