<?php
/**
 * PHPCompatibility, an external standard for PHP_CodeSniffer.
 *
 * @package   PHPCompatibility
 * @copyright 2012-2020 PHPCompatibility Contributors
 * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
 * @link      https://github.com/PHPCompatibility/PHPCompatibility
 */

namespace PHPCompatibility\Sniffs\InitialValue;

use PHPCompatibility\Helpers\ScannedCode;
use PHPCompatibility\Sniff;
use PHP_CodeSniffer\Files\File;
use PHPCSUtils\Tokens\Collections;
use PHPCSUtils\Utils\Arrays;

/**
 * Detect declaration of constants using the `const` keyword with a (constant) array value
 * as supported since PHP 5.6.
 *
 * PHP version 5.6
 *
 * @link https://wiki.php.net/rfc/const_scalar_exprs
 * @link https://www.php.net/manual/en/language.constants.syntax.php
 *
 * @since 7.1.4
 * @since 9.0.0  Renamed from `ConstantArraysUsingConstSniff` to `NewConstantArraysUsingConstSniff`.
 * @since 10.0.0 This class is now `final`.
 */
final class NewConstantArraysUsingConstSniff extends Sniff
{

    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @since 7.1.4
     *
     * @return array<int|string>
     */
    public function register()
    {
        return [\T_CONST];
    }

    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @since 7.1.4
     *
     * @param \PHP_CodeSniffer\Files\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)
    {
        if (ScannedCode::shouldRunOnOrBelow('5.5') === false) {
            return;
        }

        $tokens = $phpcsFile->getTokens();
        $find   = Collections::arrayOpenTokensBC();

        while (($hasArray = $phpcsFile->findNext($find, ($stackPtr + 1), null, false, null, true)) !== false) {
            if ($tokens[$hasArray]['code'] === \T_ARRAY
                || Arrays::isShortArray($phpcsFile, $hasArray) === true
            ) {
                $phpcsFile->addError(
                    'Constant arrays using the "const" keyword are not allowed in PHP 5.5 or earlier',
                    $hasArray,
                    'Found'
                );
            }

            // Skip past the content of the array.
            $stackPtr = $hasArray;
            if (isset($tokens[$hasArray]['bracket_closer'])) {
                $stackPtr = $tokens[$hasArray]['bracket_closer'];
            } elseif (isset($tokens[$hasArray]['parenthesis_closer'])) {
                $stackPtr = $tokens[$hasArray]['parenthesis_closer'];
            }
        }
    }
}