85 lines
2.6 KiB
PHP
85 lines
2.6 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* WordPress Coding Standard.
|
||
|
|
*
|
||
|
|
* @package WPCS\WordPressCodingStandards
|
||
|
|
* @link https://github.com/WordPress/WordPress-Coding-Standards
|
||
|
|
* @license https://opensource.org/licenses/MIT MIT
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace WordPressCS\WordPress\Helpers;
|
||
|
|
|
||
|
|
use PHP_CodeSniffer\Files\File;
|
||
|
|
use PHP_CodeSniffer\Util\Tokens;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Helper utilities for checking whether something has been marked as deprecated.
|
||
|
|
*
|
||
|
|
* ---------------------------------------------------------------------------------------------
|
||
|
|
* This class is only intended for internal use by WordPressCS and is not part of the public API.
|
||
|
|
* This also means that it has no promise of backward compatibility. Use at your own risk.
|
||
|
|
* ---------------------------------------------------------------------------------------------
|
||
|
|
*
|
||
|
|
* {@internal The functionality in this class will likely be replaced at some point in
|
||
|
|
* the future by functions from PHPCSUtils.}
|
||
|
|
*
|
||
|
|
* @internal
|
||
|
|
*
|
||
|
|
* @since 3.0.0 The method in this class was previously contained in the
|
||
|
|
* `WordPressCS\WordPress\Sniff` class and has been moved here.
|
||
|
|
*/
|
||
|
|
final class DeprecationHelper {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check whether a function has been marked as deprecated via a @deprecated tag
|
||
|
|
* in the function docblock.
|
||
|
|
*
|
||
|
|
* @since 2.2.0
|
||
|
|
* @since 3.0.0 Moved from the Sniff class to this class.
|
||
|
|
*
|
||
|
|
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
|
||
|
|
* @param int $stackPtr The position of a T_FUNCTION
|
||
|
|
* token in the stack.
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public static function is_function_deprecated( File $phpcsFile, $stackPtr ) {
|
||
|
|
$tokens = $phpcsFile->getTokens();
|
||
|
|
if ( isset( $tokens[ $stackPtr ] ) === false ) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
$ignore = Tokens::$methodPrefixes;
|
||
|
|
$ignore[ \T_WHITESPACE ] = \T_WHITESPACE;
|
||
|
|
|
||
|
|
for ( $comment_end = ( $stackPtr - 1 ); $comment_end >= 0; $comment_end-- ) {
|
||
|
|
if ( isset( $ignore[ $tokens[ $comment_end ]['code'] ] ) === true ) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( \T_ATTRIBUTE_END === $tokens[ $comment_end ]['code']
|
||
|
|
&& isset( $tokens[ $comment_end ]['attribute_opener'] ) === true
|
||
|
|
) {
|
||
|
|
$comment_end = $tokens[ $comment_end ]['attribute_opener'];
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( \T_DOC_COMMENT_CLOSE_TAG !== $tokens[ $comment_end ]['code'] ) {
|
||
|
|
// Function doesn't have a doc comment or is using the wrong type of comment.
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
$comment_start = $tokens[ $comment_end ]['comment_opener'];
|
||
|
|
foreach ( $tokens[ $comment_start ]['comment_tags'] as $tag ) {
|
||
|
|
if ( '@deprecated' === $tokens[ $tag ]['content'] ) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
}
|