ObsoleteConnectionSniff.php

<?php

/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

declare(strict_types=1);

namespace Magento2\Sniffs\Legacy;

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

class ObsoleteConnectionSniff implements Sniff
{
    /**
     * @var string[]
     */
    private $obsoleteMethods = [
        '_getReadConnection',
        '_getWriteConnection',
        '_getReadAdapter',
        '_getWriteAdapter',
        'getReadConnection',
        'getWriteConnection',
        'getReadAdapter',
        'getWriteAdapter',
    ];

    private const OBSOLETE_METHOD_ERROR_CODE = 'ObsoleteMethodFound';

    /**
     * @inheritdoc
     */
    public function register()
    {
        return [
            T_OBJECT_OPERATOR,
            T_FUNCTION
        ];
    }

    /**
     * @inheritdoc
     */
    public function process(File $phpcsFile, $stackPtr)
    {
        $this->validateObsoleteMethod($phpcsFile, $stackPtr);
    }

    /**
     * Check if obsolete methods are used
     *
     * @param File $phpcsFile
     * @param int $stackPtr
     */
    private function validateObsoleteMethod(File $phpcsFile, int $stackPtr)
    {
        $tokens = $phpcsFile->getTokens();
        $stringPos = $phpcsFile->findNext(T_STRING, $stackPtr + 1);

        foreach ($this->obsoleteMethods as $method) {
            if ($tokens[$stringPos]['content'] === $method) {
                $phpcsFile->addWarning(
                    "Contains obsolete method: %s. Please use getConnection method instead.",
                    $stackPtr,
                    self::OBSOLETE_METHOD_ERROR_CODE,
                    [
                        $method,
                    ]
                );
            }
        }
    }
}