yiisoft/yii2

View on GitHub
framework/base/ErrorHandler.php

Summary

Maintainability
B
5 hrs
Test Coverage

handleFallbackExceptionMessage accesses the super-global variable $_SERVER.
Open

    protected function handleFallbackExceptionMessage($exception, $previousException)
    {
        $msg = "An Error occurred while handling another error:\n";
        $msg .= (string) $exception;
        $msg .= "\nPrevious exception:\n";
Severity: Minor
Found in framework/base/ErrorHandler.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

The class ErrorHandler has 12 public methods. Consider refactoring ErrorHandler to keep number of public methods under 10.
Open

abstract class ErrorHandler extends Component
{
    /**
     * @event Event an event that is triggered when the handler is called by shutdown function via [[handleFatalError()]].
     * @since 2.0.46
Severity: Minor
Found in framework/base/ErrorHandler.php by phpmd

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

The class ErrorHandler has an overall complexity of 53 which is very high. The configured complexity threshold is 50.
Open

abstract class ErrorHandler extends Component
{
    /**
     * @event Event an event that is triggered when the handler is called by shutdown function via [[handleFatalError()]].
     * @since 2.0.46
Severity: Minor
Found in framework/base/ErrorHandler.php by phpmd

Function handleError has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
Open

    public function handleError($code, $message, $file, $line)
    {
        if (error_reporting() & $code) {
            // load ErrorException manually here because autoloading them will not work
            // when error occurs while autoloading a class
Severity: Minor
Found in framework/base/ErrorHandler.php - About 2 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function handleFatalError has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

    public function handleFatalError()
    {
        unset($this->_memoryReserve);

        if (isset($this->_workingDirectory)) {
Severity: Minor
Found in framework/base/ErrorHandler.php - About 45 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Method handleHhvmError has 6 arguments (exceeds 4 allowed). Consider refactoring.
Open

    public function handleHhvmError($code, $message, $file, $line, $context, $backtrace)
Severity: Minor
Found in framework/base/ErrorHandler.php - About 45 mins to fix

    Function handleException has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

        public function handleException($exception)
        {
            if ($exception instanceof ExitException) {
                return;
            }
    Severity: Minor
    Found in framework/base/ErrorHandler.php - About 45 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Function register has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

        public function register()
        {
            if (!$this->_registered) {
                ini_set('display_errors', false);
                set_exception_handler([$this, 'handleException']);
    Severity: Minor
    Found in framework/base/ErrorHandler.php - About 45 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Function handleFallbackExceptionMessage has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        protected function handleFallbackExceptionMessage($exception, $previousException)
        {
            $msg = "An Error occurred while handling another error:\n";
            $msg .= (string) $exception;
            $msg .= "\nPrevious exception:\n";
    Severity: Minor
    Found in framework/base/ErrorHandler.php - About 25 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    The class ErrorHandler has a coupling between objects value of 13. Consider to reduce the number of dependencies under 13.
    Open

    abstract class ErrorHandler extends Component
    {
        /**
         * @event Event an event that is triggered when the handler is called by shutdown function via [[handleFatalError()]].
         * @since 2.0.46
    Severity: Minor
    Found in framework/base/ErrorHandler.php by phpmd

    CouplingBetweenObjects

    Since: 1.1.0

    A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

    Example

    class Foo {
        /**
         * @var \foo\bar\X
         */
        private $x = null;
    
        /**
         * @var \foo\bar\Y
         */
        private $y = null;
    
        /**
         * @var \foo\bar\Z
         */
        private $z = null;
    
        public function setFoo(\Foo $foo) {}
        public function setBar(\Bar $bar) {}
        public function setBaz(\Baz $baz) {}
    
        /**
         * @return \SplObjectStorage
         * @throws \OutOfRangeException
         * @throws \InvalidArgumentException
         * @throws \ErrorException
         */
        public function process(\Iterator $it) {}
    
        // ...
    }

    Source https://phpmd.org/rules/design.html#couplingbetweenobjects

    Missing class import via use statement (line '225', column '24').
    Open

                $ref = new \ReflectionProperty('\Exception', 'trace');
    Severity: Minor
    Found in framework/base/ErrorHandler.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    Remove error control operator '@' on line 369.
    Open

        public function clearOutput()
        {
            // the following manual level counting is to deal with zlib.output_compression set to On
            for ($level = ob_get_level(); $level > 0; --$level) {
                if (!@ob_end_clean()) {
    Severity: Minor
    Found in framework/base/ErrorHandler.php by phpmd

    ErrorControlOperator

    Error suppression should be avoided if possible as it doesn't just suppress the error, that you are trying to stop, but will also suppress errors that you didn't predict would ever occur. Consider changing error_reporting() level and/or setting up your own error handler.

    Example

    function foo($filePath) {
        $file = @fopen($filPath); // hides exceptions
        $key = @$array[$notExistingKey]; // assigns null to $key
    }

    Source http://phpmd.org/rules/cleancode.html#errorcontroloperator

    The method handleFallbackExceptionMessage() contains an exit expression.
    Open

            exit(1);
    Severity: Minor
    Found in framework/base/ErrorHandler.php by phpmd

    ExitExpression

    Since: 0.2

    An exit-expression within regular code is untestable and therefore it should be avoided. Consider to move the exit-expression into some kind of startup script where an error/exception code is returned to the calling environment.

    Example

    class Foo {
        public function bar($param)  {
            if ($param === 42) {
                exit(23);
            }
        }
    }

    Source https://phpmd.org/rules/design.html#exitexpression

    The method handleFatalError() contains an exit expression.
    Open

                exit(1);
    Severity: Minor
    Found in framework/base/ErrorHandler.php by phpmd

    ExitExpression

    Since: 0.2

    An exit-expression within regular code is untestable and therefore it should be avoided. Consider to move the exit-expression into some kind of startup script where an error/exception code is returned to the calling environment.

    Example

    class Foo {
        public function bar($param)  {
            if ($param === 42) {
                exit(23);
            }
        }
    }

    Source https://phpmd.org/rules/design.html#exitexpression

    The method handleError() contains an exit expression.
    Open

                            exit(1);
    Severity: Minor
    Found in framework/base/ErrorHandler.php by phpmd

    ExitExpression

    Since: 0.2

    An exit-expression within regular code is untestable and therefore it should be avoided. Consider to move the exit-expression into some kind of startup script where an error/exception code is returned to the calling environment.

    Example

    class Foo {
        public function bar($param)  {
            if ($param === 42) {
                exit(23);
            }
        }
    }

    Source https://phpmd.org/rules/design.html#exitexpression

    Avoid unused parameters such as '$context'.
    Open

        public function handleHhvmError($code, $message, $file, $line, $context, $backtrace)
    Severity: Minor
    Found in framework/base/ErrorHandler.php by phpmd

    UnusedFormalParameter

    Since: 0.2

    Avoid passing parameters to methods or constructors and then not using those parameters.

    Example

    class Foo
    {
        private function bar($howdy)
        {
            // $howdy is not used
        }
    }

    Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

    The method handleException() contains an exit expression.
    Open

                    exit(1);
    Severity: Minor
    Found in framework/base/ErrorHandler.php by phpmd

    ExitExpression

    Since: 0.2

    An exit-expression within regular code is untestable and therefore it should be avoided. Consider to move the exit-expression into some kind of startup script where an error/exception code is returned to the calling environment.

    Example

    class Foo {
        public function bar($param)  {
            if ($param === 42) {
                exit(23);
            }
        }
    }

    Source https://phpmd.org/rules/design.html#exitexpression

    There are no issues that match your filters.

    Category
    Status