class DiscouragedFunctionsSniff

Same name in this branch

11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/PHP/DiscouragedFunctionsSniff.php \PHP_CodeSniffer\Standards\Squiz\Sniffs\PHP\DiscouragedFunctionsSniff

Discourage the use of debug functions.

@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer

Hierarchy

class \PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\ForbiddenFunctionsSniff implements \PHP_CodeSniffer\Sniffs\Sniff
- class \Drupal\Sniffs\Functions\DiscouragedFunctionsSniff extends \PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\ForbiddenFunctionsSniff

Expanded class hierarchy of DiscouragedFunctionsSniff

File

vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Functions/DiscouragedFunctionsSniff.php, line 21

Namespace

Drupal\Sniffs\Functions

View source

class DiscouragedFunctionsSniff extends ForbiddenFunctionsSniff {
    
    /**
     * A list of forbidden functions with their alternatives.
     *
     * The value is NULL if no alternative exists, i.e., the function should
     * just not be used.
     *
     * cspell:disable
     *
     * @var array<string, null>
     */
    public $forbiddenFunctions = [
        // Devel module debugging functions.
'dargs' => null,
        'dcp' => null,
        'dd' => null,
        'ddebug_backtrace' => null,
        'ddm' => null,
        'dfb' => null,
        'dfbt' => null,
        'dpm' => null,
        'dpq' => null,
        'dpr' => null,
        'dprint_r' => null,
        'drupal_debug' => null,
        'dsm' => null,
        'dvm' => null,
        'dvr' => null,
        'kdevel_print_object' => null,
        'kint' => null,
        'ksm' => null,
        'kpr' => null,
        'kprint_r' => null,
        'sdpm' => null,
        // Functions which are not available on all
        // PHP builds.
'fnmatch' => null,
        // Functions which are a security risk.
'eval' => null,
    ];
    
    /**
     * If true, an error will be thrown; otherwise a warning.
     *
     * @var boolean
     */
    public $error = false;

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
DiscouragedFunctionsSniff::$error	public	property	If true, an error will be thrown; otherwise a warning.	Overrides ForbiddenFunctionsSniff::$error
DiscouragedFunctionsSniff::$forbiddenFunctions	public	property	A list of forbidden functions with their alternatives.	Overrides ForbiddenFunctionsSniff::$forbiddenFunctions
ForbiddenFunctionsSniff::$forbiddenFunctionNames	protected	property	A cache of forbidden function names, for faster lookups.
ForbiddenFunctionsSniff::$patternMatch	protected	property	If true, forbidden functions will be considered regular expressions.
ForbiddenFunctionsSniff::addError	protected	function	Generates the error or warning for this sniff.		1
ForbiddenFunctionsSniff::process	public	function	Processes this test, when one of its tokens is encountered.	Overrides Sniff::process
ForbiddenFunctionsSniff::register	public	function	Returns an array of tokens this test wants to listen for.	Overrides Sniff::register