Automattic / jetpack

packages/codesniffer/Jetpack/Sniffs/Constants/MasterUserConstantSniff.php

<?php // phpcs:ignore WordPress.Files.FileName.NotHyphenatedLowercase

namespace Automattic\Jetpack\Sniffs\Constants;

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

/**
 * Sniffer that looks for JETPACK_MASTER_USER constant usage
 */
class MasterUserConstantSniff implements Sniff {
	/**
	 * Returns the token types that this sniff is interested in.
	 *
	 * @return array(int)

The doc-type array(int) could not be parsed: Expected "|" or "end of type", but got "(" at position 5. (view supported doc-types)

	 */
	public function register() {
		return array( T_STRING );
	}

	/**
	 * Processes the tokens that this sniff is interested in.
	 *
	 * @param File $phpcs_file The file where the token was found.
	 * @param int  $stack_ptr The position in the stack where the token was found.
	 */
	public function process( File $phpcs_file, $stack_ptr ) {

		$tokens = $phpcs_file->getTokens();

		if ( 'JETPACK_MASTER_USER' === $tokens[ $stack_ptr ]['content'] ) {
			$phpcs_file->addWarning(
				'JETPACK_MASTER_USER constant should not be used. Use the blog token to make requests instead, or use the current user token when needed.',
				$stack_ptr,
				'ShouldNotBeUsed'
			);
		}

	}

}