Whoops_Run_Composite::handleError() - Code Metrics - Inspection of "Enable Whoops Blocking only when Notices/Warnings..." - Rarst/wps - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#13)

unknown

created 2020-03-20 03:27 UTC

Whoops_Run_Composite::handleError() C

↳ Parent: Whoops_Run_Composite

Complexity

Conditions	11
Paths	35

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	52
rs	6.9006
c	0
b	0
f	0
cc	11
nc	35
nop	4

How to fix Long Method Complexity

<?php
namespace Rarst\wps;

use Whoops\Exception\ErrorException;
use Whoops\Exception\Inspector;
use Whoops\Run;
use Whoops\Util\SystemFacade;

/**
 * This class will show Errors and Warnings only if they are coming from
 * Specific Plugin
 */
class Whoops_Run_Composite {

    /**
     * @var SystemFacade
     */
    private $system;
    
    /**
     * @var Run
     */
    private $run;
    
    private $skipAllNoticesAndWarnings = false;

    private $watchSpecificPlugins = [];

    private $watchSpecificThemes = [];

    public function __construct(SystemFacade $system = null)
    {
        $this->system = $system ?: new SystemFacade;
        $this->run = new Run($this->system);
    }

    public function register() {
        class_exists("\\Whoops\\Exception\\ErrorException");
        class_exists("\\Whoops\\Exception\\FrameCollection");
        class_exists("\\Whoops\\Exception\\Frame");
        class_exists("\\Whoops\\Exception\\Inspector");

        $this->system->setErrorHandler([$this, Run::ERROR_HANDLER]);
        $this->system->setExceptionHandler([$this->run, Run::EXCEPTION_HANDLER]);
        $this->system->registerShutdownFunction([$this->run, Run::SHUTDOWN_HANDLER]);
    }

    public function unregister() {
        $this->system->restoreExceptionHandler();
        $this->system->restoreErrorHandler();
    }

    public function pushHandler($handler) {
        $this->run->pushHandler($handler);
    }

    public function skipAllNoticesAndWarnings() {
        $this->skipAllNoticesAndWarnings = true;
    }

    public function watchSpecificPlugins($plugins) {
        $this->watchSpecificPlugins = $plugins;
    }

    public function watchSpecificThemes($themes) {
        $this->watchSpecificThemes = $themes;
    }

    /**
     * Silence particular errors in particular files
     * @param  array|string $patterns List or a single regex pattern to match
     * @param  int          $levels   Defaults to E_STRICT | E_DEPRECATED
     * @return Run
     * @see https://maximivanov.github.io/php-error-reporting-calculator/
     */
    public function silenceErrorsInPaths($patterns, $levels = 10240) {
        $this->run->silenceErrorsInPaths($patterns, $levels);
    }

    /**
     * Converts generic PHP errors to \ErrorException
     * instances, before passing them off to be handled.
     *
     * This method MUST be compatible with set_error_handler.
     *
     * @param int    $level
     * @param string $message
     * @param string $file
     * @param int    $line
     *
     * @return bool
     * @throws ErrorException
     */
    public function handleError($level, $message, $file = null, $line = null) {

        // Handle all fatals, exceptions etc.
        if(in_array(
            $level, 
            [E_ERROR, E_PARSE, E_CORE_ERROR, E_COMPILE_ERROR, E_USER_ERROR, E_RECOVERABLE_ERROR]
        )) {
            $this->run->handleError($level, $message, $file, $line);
            return false;
        }

        // If All Notices and Warnings should be skipped, then short-circuit
        // error handler.
        if($this->skipAllNoticesAndWarnings) {
            return false;
        }

        // Watch for all plugins and Themes
        if( empty($this->watchSpecificPlugins) && empty($this->watchSpecificThemes ) ) {
            $this->run->handleError($level, $message, $file, $line);
            return false;
        }

        $watchablePlugins = empty($this->watchSpecificPlugins) ? [] : array_map(function($pluginBaseFolder){
            return 'plugins/' . $pluginBaseFolder;
        }, $this->watchSpecificPlugins);

        $watchableThemes = empty($this->watchSpecificThemes) ? [] : array_map(function($themeBaseFolder){
            return 'themes/' . $themeBaseFolder;
        }, $this->watchSpecificThemes);

        $directoriesToWatchFor = array_merge($watchablePlugins, $watchableThemes);
        $errorBelongsToWatchCriteria = false;
        
        // We are creating an exception object because Inspector Class needs it.
        $exception = new ErrorException($message, /*code*/ $level, /*severity*/ $level, $file, $line);
        $frames = (new Inspector($exception))->getFrames();
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        foreach( $frames as $frame ) {
            foreach($directoriesToWatchFor as $directory) {
                if (strpos($frame->getFile(), $directory) !== false) {
                    $errorBelongsToWatchCriteria = true;
                    break 2;
                }
            }
        }

        if($errorBelongsToWatchCriteria) {
            $this->run->handleError($level, $message, $file, $line);
        }

        return false;
    }
}

1			<?php
2			namespace Rarst\wps;
3
4			use Whoops\Exception\ErrorException;
5			use Whoops\Exception\Inspector;
6			use Whoops\Run;
7			use Whoops\Util\SystemFacade;
8
9			/**
10			* This class will show Errors and Warnings only if they are coming from
11			* Specific Plugin
12			*/
13			class Whoops_Run_Composite {
14
15			/**
16			* @var SystemFacade
17			*/
18			private $system;
19
20			/**
21			* @var Run
22			*/
23			private $run;
24
25			private $skipAllNoticesAndWarnings = false;
26
27			private $watchSpecificPlugins = [];
28
29			private $watchSpecificThemes = [];
30
31			public function __construct(SystemFacade $system = null)
32			{
33			$this->system = $system ?: new SystemFacade;
34			$this->run = new Run($this->system);
35			}
36
37			public function register() {
38			class_exists("\\Whoops\\Exception\\ErrorException");
39			class_exists("\\Whoops\\Exception\\FrameCollection");
40			class_exists("\\Whoops\\Exception\\Frame");
41			class_exists("\\Whoops\\Exception\\Inspector");
42
43			$this->system->setErrorHandler([$this, Run::ERROR_HANDLER]);
44			$this->system->setExceptionHandler([$this->run, Run::EXCEPTION_HANDLER]);
45			$this->system->registerShutdownFunction([$this->run, Run::SHUTDOWN_HANDLER]);
46			}
47
48			public function unregister() {
49			$this->system->restoreExceptionHandler();
50			$this->system->restoreErrorHandler();
51			}
52
53			public function pushHandler($handler) {
54			$this->run->pushHandler($handler);
55			}
56
57			public function skipAllNoticesAndWarnings() {
58			$this->skipAllNoticesAndWarnings = true;
59			}
60
61			public function watchSpecificPlugins($plugins) {
62			$this->watchSpecificPlugins = $plugins;
63			}
64
65			public function watchSpecificThemes($themes) {
66			$this->watchSpecificThemes = $themes;
67			}
68
69			/**
70			* Silence particular errors in particular files
71			* @param array\|string $patterns List or a single regex pattern to match
72			* @param int $levels Defaults to E_STRICT \| E_DEPRECATED
73			* @return Run
74			* @see https://maximivanov.github.io/php-error-reporting-calculator/
75			*/
76			public function silenceErrorsInPaths($patterns, $levels = 10240) {
77			$this->run->silenceErrorsInPaths($patterns, $levels);
78			}
79
80			/**
81			* Converts generic PHP errors to \ErrorException
82			* instances, before passing them off to be handled.
83			*
84			* This method MUST be compatible with set_error_handler.
85			*
86			* @param int $level
87			* @param string $message
88			* @param string $file
89			* @param int $line
90			*
91			* @return bool
92			* @throws ErrorException
93			*/
94			public function handleError($level, $message, $file = null, $line = null) {
95
96			// Handle all fatals, exceptions etc.
97			if(in_array(
98			$level,
99			[E_ERROR, E_PARSE, E_CORE_ERROR, E_COMPILE_ERROR, E_USER_ERROR, E_RECOVERABLE_ERROR]
100			)) {
101			$this->run->handleError($level, $message, $file, $line);
102			return false;
103			}
104
105			// If All Notices and Warnings should be skipped, then short-circuit
106			// error handler.
107			if($this->skipAllNoticesAndWarnings) {
108			return false;
109			}
110
111			// Watch for all plugins and Themes
112			if( empty($this->watchSpecificPlugins) && empty($this->watchSpecificThemes ) ) {
113			$this->run->handleError($level, $message, $file, $line);
114			return false;
115			}
116
117			$watchablePlugins = empty($this->watchSpecificPlugins) ? [] : array_map(function($pluginBaseFolder){
118			return 'plugins/' . $pluginBaseFolder;
119			}, $this->watchSpecificPlugins);
120
121			$watchableThemes = empty($this->watchSpecificThemes) ? [] : array_map(function($themeBaseFolder){
122			return 'themes/' . $themeBaseFolder;
123			}, $this->watchSpecificThemes);
124
125			$directoriesToWatchFor = array_merge($watchablePlugins, $watchableThemes);
126			$errorBelongsToWatchCriteria = false;
127
128			// We are creating an exception object because Inspector Class needs it.
129			$exception = new ErrorException($message, /code/ $level, /severity/ $level, $file, $line);
130			$frames = (new Inspector($exception))->getFrames();
			0 ignored issues – show Documentation introduced 2020-03-19 17:27 UTC by Report Bug Copy Issue Report `$exception` is of type `object<Whoops\Exception\ErrorException>`, but the function expects a `object<Throwable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
131			foreach( $frames as $frame ) {
132			foreach($directoriesToWatchFor as $directory) {
133			if (strpos($frame->getFile(), $directory) !== false) {
134			$errorBelongsToWatchCriteria = true;
135			break 2;
136			}
137			}
138			}
139
140			if($errorBelongsToWatchCriteria) {
141			$this->run->handleError($level, $message, $file, $line);
142			}
143
144			return false;
145			}
146			}

Rarst / wps

Pull Request — master (#13)

Whoops_Run_Composite::handleError() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like