Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\Functions\DiscouragedFunctionsSniff.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: 
Chris@17: namespace Drupal\Sniffs\Functions;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\ForbiddenFunctionsSniff;
Chris@17: 
Chris@0: /**
Chris@0:  * Discourage the use of debug functions.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@17: class DiscouragedFunctionsSniff extends ForbiddenFunctionsSniff
Chris@0: {
Chris@0: 
Chris@0:     /**
Chris@0:      * A list of forbidden functions with their alternatives.
Chris@0:      *
Chris@0:      * The value is NULL if no alternative exists, i.e., the function should
Chris@0:      * just not be used.
Chris@0:      *
Chris@0:      * @var array(string => string|null)
Chris@0:      */
Chris@0:     public $forbiddenFunctions = array(
Chris@0:                                      // Devel module debugging functions.
Chris@0:                                   'dargs'               => null,
Chris@0:                                   'dcp'                 => null,
Chris@0:                                   'dd'                  => null,
Chris@0:                                   'dfb'                 => null,
Chris@0:                                   'dfbt'                => null,
Chris@0:                                   'dpm'                 => null,
Chris@0:                                   'dpq'                 => null,
Chris@0:                                   'dpr'                 => null,
Chris@0:                                   'dprint_r'            => null,
Chris@0:                                   'drupal_debug'        => null,
Chris@0:                                   'dsm'                 => null,
Chris@0:                                   'dvm'                 => null,
Chris@0:                                   'dvr'                 => null,
Chris@0:                                   'kdevel_print_object' => null,
Chris@0:                                   'kpr'                 => null,
Chris@0:                                   'kprint_r'            => null,
Chris@0:                                   'sdpm'                => null,
Chris@0:                                   // Functions which are not available on all
Chris@0:                                   // PHP builds.
Chris@0:                                   'fnmatch'             => null,
Chris@0:                                   // Functions which are a security risk.
Chris@0:                                   'eval'                => null,
Chris@0:                                  );
Chris@0: 
Chris@0:     /**
Chris@0:      * If true, an error will be thrown; otherwise a warning.
Chris@0:      *
Chris@0:      * @var bool
Chris@0:      */
Chris@0:     public $error = false;
Chris@0: 
Chris@0: }//end class