Source for file DeprecatedFunctionsSniff.php
Documentation is available at DeprecatedFunctionsSniff.php
* Discourages the use of deprecated PHP functions.
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
namespace PHP_CodeSniffer\Standards\Generic\Sniffs\PHP;
class DeprecatedFunctionsSniff extends ForbiddenFunctionsSniff
* A list of forbidden functions with their alternatives.
* The value is NULL if no alternative exists. IE, the
* function should just not be used.
* @var array(string => string|null)
public $forbiddenFunctions = array ();
* Uses the Reflection API to get a list of deprecated functions.
public function __construct ()
foreach ($functions['internal'] as $functionName) {
$function = new \ReflectionFunction ($functionName);
if ($function->isDeprecated () === true ) {
$this->forbiddenFunctions[$functionName] = null;
* Generates the error or warning for this sniff.
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the forbidden function
* @param string $function The name of the forbidden function.
* @param string $pattern The pattern used for the match.
protected function addError ($phpcsFile, $stackPtr, $function, $pattern=null )
$data = array ($function);
$error = 'Function %s() has been deprecated';
if ($this->error === true ) {
$phpcsFile->addError ($error, $stackPtr, $type, $data);
$phpcsFile->addWarning ($error, $stackPtr, $type, $data);
Documentation generated on Mon, 11 Mar 2019 15:27:22 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|