<?php

/**
 * Verifies that properties are declared correctly.
 *
 * @author    Greg Sherwood <gsherwood@squiz.net>
 * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
 * @license   https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 */
namespace PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes;

use Exception;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\AbstractVariableSniff;
use PHP_CodeSniffer\Util\Tokens;
class PropertyDeclarationSniff extends AbstractVariableSniff
{
    /**
     * Processes the function tokens within the class.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
     * @param int                         $stackPtr  The position where the token was found.
     *
     * @return void
     */
    protected function processMemberVar(File $phpcsFile, $stackPtr)
    {
        $tokens = $phpcsFile->getTokens();
        if ($tokens[$stackPtr]['content'][1] === '_') {
            $error = 'Property name "%s" should not be prefixed with an underscore to indicate visibility';
            $data = [$tokens[$stackPtr]['content']];
            $phpcsFile->addWarning($error, $stackPtr, 'Underscore', $data);
        }
        // Detect multiple properties defined at the same time. Throw an error
        // for this, but also only process the first property in the list so we don't
        // repeat errors.
        $find = Tokens::$scopeModifiers;
        $find[] = \T_VARIABLE;
        $find[] = \T_VAR;
        $find[] = \T_READONLY;
        $find[] = \T_FINAL;
        $find[] = \T_ABSTRACT;
        $find[] = \T_SEMICOLON;
        $find[] = \T_OPEN_CURLY_BRACKET;
        $prev = $phpcsFile->findPrevious($find, $stackPtr - 1);
        if ($tokens[$prev]['code'] === \T_VARIABLE) {
            return;
        }
        if ($tokens[$prev]['code'] === \T_VAR) {
            $error = 'The var keyword must not be used to declare a property';
            $phpcsFile->addError($error, $stackPtr, 'VarUsed');
        }
        $next = $phpcsFile->findNext([\T_VARIABLE, \T_SEMICOLON], $stackPtr + 1);
        if ($next !== \false && $tokens[$next]['code'] === \T_VARIABLE) {
            $error = 'There must not be more than one property declared per statement';
            $phpcsFile->addError($error, $stackPtr, 'Multiple');
        }
        try {
            $propertyInfo = $phpcsFile->getMemberProperties($stackPtr);
            if (empty($propertyInfo) === \true) {
                return;
            }
        } catch (Exception $e) {
            // Turns out not to be a property after all.
            return;
        }
        if ($propertyInfo['type'] !== '') {
            $typeToken = $propertyInfo['type_end_token'];
            $error = 'There must be 1 space after the property type declaration; %s found';
            if ($tokens[$typeToken + 1]['code'] !== \T_WHITESPACE) {
                $data = ['0'];
                $fix = $phpcsFile->addFixableError($error, $typeToken, 'SpacingAfterType', $data);
                if ($fix === \true) {
                    $phpcsFile->fixer->addContent($typeToken, ' ');
                }
            } else {
                if ($tokens[$typeToken + 1]['content'] !== ' ') {
                    $next = $phpcsFile->findNext(\T_WHITESPACE, $typeToken + 1, null, \true);
                    if ($tokens[$next]['line'] !== $tokens[$typeToken]['line']) {
                        $found = 'newline';
                    } else {
                        $found = $tokens[$typeToken + 1]['length'];
                    }
                    $data = [$found];
                    $nextNonWs = $phpcsFile->findNext(Tokens::$emptyTokens, $typeToken + 1, null, \true);
                    if ($nextNonWs !== $next) {
                        $phpcsFile->addError($error, $typeToken, 'SpacingAfterType', $data);
                    } else {
                        $fix = $phpcsFile->addFixableError($error, $typeToken, 'SpacingAfterType', $data);
                        if ($fix === \true) {
                            if ($found === 'newline') {
                                $phpcsFile->fixer->beginChangeset();
                                for ($x = $typeToken + 1; $x < $next; $x++) {
                                    $phpcsFile->fixer->replaceToken($x, '');
                                }
                                $phpcsFile->fixer->addContent($typeToken, ' ');
                                $phpcsFile->fixer->endChangeset();
                            } else {
                                $phpcsFile->fixer->replaceToken($typeToken + 1, ' ');
                            }
                        }
                    }
                }
            }
            //end if
        }
        //end if
        if ($propertyInfo['scope_specified'] === \false && $propertyInfo['set_scope'] === \false) {
            $error = 'Visibility must be declared on property "%s"';
            $data = [$tokens[$stackPtr]['content']];
            $phpcsFile->addError($error, $stackPtr, 'ScopeMissing', $data);
        }
        /*
         * Note: per PSR-PER section 4.6 v 2.1/3.0, the order should be:
         * - Inheritance modifier: `abstract` or `final`.
         * - Visibility modifier: `public`, `protected`, or `private`.
         * - Set-visibility modifier: `public(set)`, `protected(set)`, or `private(set)`
         * - Scope modifier: `static`.
         * - Mutation modifier: `readonly`.
         * - Type declaration.
         * - Name.
         *
         * Ref:
         * - https://www.php-fig.org/per/coding-style/#46-modifier-keywords
         * - https://github.com/php-fig/per-coding-style/pull/99
         *
         * The `static` and `readonly` modifiers are mutually exclusive and cannot be used together.
         *
         * Based on that, the below modifier keyword order checks are sufficient (for now).
         */
        $hasVisibilityModifier = $propertyInfo['scope_specified'] === \true || $propertyInfo['set_scope'] !== \false;
        $lastVisibilityModifier = $phpcsFile->findPrevious(Tokens::$scopeModifiers, $stackPtr - 1);
        $firstVisibilityModifier = $lastVisibilityModifier;
        if ($propertyInfo['scope_specified'] === \true && $propertyInfo['set_scope'] !== \false) {
            $scopePtr = $phpcsFile->findPrevious([\T_PUBLIC, \T_PROTECTED, \T_PRIVATE], $stackPtr - 1);
            $setScopePtr = $phpcsFile->findPrevious([\T_PUBLIC_SET, \T_PROTECTED_SET, \T_PRIVATE_SET], $stackPtr - 1);
            if ($scopePtr > $setScopePtr) {
                $error = 'The "read"-visibility must come before the "write"-visibility';
                $fix = $phpcsFile->addFixableError($error, $stackPtr, 'AvizKeywordOrder');
                if ($fix === \true) {
                    $phpcsFile->fixer->beginChangeset();
                    for ($i = $scopePtr + 1; $scopePtr < $stackPtr; $i++) {
                        if ($tokens[$i]['code'] !== \T_WHITESPACE) {
                            break;
                        }
                        $phpcsFile->fixer->replaceToken($i, '');
                    }
                    $phpcsFile->fixer->replaceToken($scopePtr, '');
                    $phpcsFile->fixer->addContentBefore($setScopePtr, $tokens[$scopePtr]['content'] . ' ');
                    $phpcsFile->fixer->endChangeset();
                }
            }
            $firstVisibilityModifier = \min($scopePtr, $setScopePtr);
        }
        //end if
        if ($hasVisibilityModifier === \true && $propertyInfo['is_final'] === \true) {
            $scopePtr = $firstVisibilityModifier;
            $finalPtr = $phpcsFile->findPrevious(\T_FINAL, $stackPtr - 1);
            if ($finalPtr > $scopePtr) {
                $error = 'The final declaration must come before the visibility declaration';
                $fix = $phpcsFile->addFixableError($error, $stackPtr, 'FinalAfterVisibility');
                if ($fix === \true) {
                    $phpcsFile->fixer->beginChangeset();
                    for ($i = $finalPtr + 1; $finalPtr < $stackPtr; $i++) {
                        if ($tokens[$i]['code'] !== \T_WHITESPACE) {
                            break;
                        }
                        $phpcsFile->fixer->replaceToken($i, '');
                    }
                    $phpcsFile->fixer->replaceToken($finalPtr, '');
                    $phpcsFile->fixer->addContentBefore($scopePtr, $tokens[$finalPtr]['content'] . ' ');
                    $phpcsFile->fixer->endChangeset();
                }
            }
        }
        //end if
        if ($hasVisibilityModifier === \true && $propertyInfo['is_abstract'] === \true) {
            $scopePtr = $firstVisibilityModifier;
            $abstractPtr = $phpcsFile->findPrevious(\T_ABSTRACT, $stackPtr - 1);
            if ($abstractPtr > $scopePtr) {
                $error = 'The abstract declaration must come before the visibility declaration';
                $fix = $phpcsFile->addFixableError($error, $stackPtr, 'AbstractAfterVisibility');
                if ($fix === \true) {
                    $phpcsFile->fixer->beginChangeset();
                    for ($i = $abstractPtr + 1; $abstractPtr < $stackPtr; $i++) {
                        if ($tokens[$i]['code'] !== \T_WHITESPACE) {
                            break;
                        }
                        $phpcsFile->fixer->replaceToken($i, '');
                    }
                    $phpcsFile->fixer->replaceToken($abstractPtr, '');
                    $phpcsFile->fixer->addContentBefore($scopePtr, $tokens[$abstractPtr]['content'] . ' ');
                    $phpcsFile->fixer->endChangeset();
                }
            }
        }
        //end if
        if ($hasVisibilityModifier === \true && $propertyInfo['is_static'] === \true) {
            $scopePtr = $lastVisibilityModifier;
            $staticPtr = $phpcsFile->findPrevious(\T_STATIC, $stackPtr - 1);
            if ($scopePtr > $staticPtr) {
                $error = 'The static declaration must come after the visibility declaration';
                $fix = $phpcsFile->addFixableError($error, $stackPtr, 'StaticBeforeVisibility');
                if ($fix === \true) {
                    $phpcsFile->fixer->beginChangeset();
                    for ($i = $staticPtr + 1; $staticPtr < $stackPtr; $i++) {
                        if ($tokens[$i]['code'] !== \T_WHITESPACE) {
                            break;
                        }
                        $phpcsFile->fixer->replaceToken($i, '');
                    }
                    $phpcsFile->fixer->replaceToken($staticPtr, '');
                    $phpcsFile->fixer->addContent($scopePtr, ' ' . $tokens[$staticPtr]['content']);
                    $phpcsFile->fixer->endChangeset();
                }
            }
        }
        //end if
        if ($hasVisibilityModifier === \true && $propertyInfo['is_readonly'] === \true) {
            $scopePtr = $lastVisibilityModifier;
            $readonlyPtr = $phpcsFile->findPrevious(\T_READONLY, $stackPtr - 1);
            if ($scopePtr > $readonlyPtr) {
                $error = 'The readonly declaration must come after the visibility declaration';
                $fix = $phpcsFile->addFixableError($error, $stackPtr, 'ReadonlyBeforeVisibility');
                if ($fix === \true) {
                    $phpcsFile->fixer->beginChangeset();
                    for ($i = $readonlyPtr + 1; $readonlyPtr < $stackPtr; $i++) {
                        if ($tokens[$i]['code'] !== \T_WHITESPACE) {
                            break;
                        }
                        $phpcsFile->fixer->replaceToken($i, '');
                    }
                    $phpcsFile->fixer->replaceToken($readonlyPtr, '');
                    $phpcsFile->fixer->addContent($scopePtr, ' ' . $tokens[$readonlyPtr]['content']);
                    $phpcsFile->fixer->endChangeset();
                }
            }
        }
        //end if
    }
    //end processMemberVar()
    /**
     * Processes normal variables.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
     * @param int                         $stackPtr  The position where the token was found.
     *
     * @return void
     */
    protected function processVariable(File $phpcsFile, $stackPtr)
    {
        /*
            We don't care about normal variables.
        */
    }
    //end processVariable()
    /**
     * Processes variables in double quoted strings.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
     * @param int                         $stackPtr  The position where the token was found.
     *
     * @return void
     */
    protected function processVariableInString(File $phpcsFile, $stackPtr)
    {
        /*
            We don't care about normal variables.
        */
    }
    //end processVariableInString()
}
//end class
