xarxaprod-wp-theme/vendor/phpcompatibility/php-compatibility/PHPCompatibility/Sniffs/MethodUse/NewDirectCallsToCloneSniff.php

118 lines
3.5 KiB
PHP

<?php
/**
* PHPCompatibility, an external standard for PHP_CodeSniffer.
*
* @package PHPCompatibility
* @copyright 2012-2019 PHPCompatibility Contributors
* @license https://opensource.org/licenses/LGPL-3.0 LGPL3
* @link https://github.com/PHPCompatibility/PHPCompatibility
*/
namespace PHPCompatibility\Sniffs\MethodUse;
use PHPCompatibility\Sniff;
use PHP_CodeSniffer_File as File;
use PHP_CodeSniffer_Tokens as Tokens;
/**
* Detect direct calls to the `__clone()` magic method, which is allowed since PHP 7.0.
*
* "Doing calls like `$obj->__clone()` is now allowed. This was the only magic method
* that had a compile-time check preventing some calls to it, which doesn't make sense.
* If we allow all other magic methods to be called, there's no reason to forbid this one."
*
* PHP version 7.0
*
* @link https://wiki.php.net/rfc/abstract_syntax_tree#directly_calling_clone_is_allowed
* @link https://www.php.net/manual/en/language.oop5.cloning.php
*
* @since 9.1.0
*/
class NewDirectCallsToCloneSniff extends Sniff
{
/**
* Tokens which indicate class internal use.
*
* @since 9.3.2
*
* @var array
*/
protected $classInternal = array(
\T_PARENT => true,
\T_SELF => true,
\T_STATIC => true,
);
/**
* Returns an array of tokens this test wants to listen for.
*
* @since 9.1.0
*
* @return array
*/
public function register()
{
return array(
\T_DOUBLE_COLON,
\T_OBJECT_OPERATOR,
);
}
/**
* Processes this test, when one of its tokens is encountered.
*
* @since 9.1.0
*
* @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(File $phpcsFile, $stackPtr)
{
if ($this->supportsBelow('5.6') === false) {
return;
}
$tokens = $phpcsFile->getTokens();
$nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);
if ($nextNonEmpty === false || $tokens[$nextNonEmpty]['code'] !== \T_STRING) {
/*
* Not a method call.
*
* Note: This disregards method calls with the method name in a variable, like:
* $method = '__clone';
* $obj->$method();
* However, that would be very hard to examine reliably anyway.
*/
return;
}
if (strtolower($tokens[$nextNonEmpty]['content']) !== '__clone') {
// Not a call to the __clone() method.
return;
}
$nextNextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, ($nextNonEmpty + 1), null, true);
if ($nextNextNonEmpty === false || $tokens[$nextNextNonEmpty]['code'] !== \T_OPEN_PARENTHESIS) {
// Not a method call.
return;
}
$prevNonEmpty = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true);
if ($prevNonEmpty === false || isset($this->classInternal[$tokens[$prevNonEmpty]['code']])) {
// Class internal call to __clone().
return;
}
$phpcsFile->addError(
'Direct calls to the __clone() magic method are not allowed in PHP 5.6 or earlier.',
$nextNonEmpty,
'Found'
);
}
}