YellowScreenOfDeath::renderError() - Code Metrics - KSST/KF - Measure and Improve Code Quality continuously with Scrutinizer

YellowScreenOfDeath::renderError() B
last analyzed 2017-04-11 14:32 UTC

↳ Parent: YellowScreenOfDeath
Complexity

Conditions	1
Paths	1
Size

Total Lines	77
Code Lines	47
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	47
c	0
b	0
f	0
nc	1
nop	6
dl	0
loc	77
rs	8.9342
How to fix Long Method

<?php

/**
 * Koch Framework
 * Jens-André Koch © 2005 - onwards.
 *
 * This file is part of "Koch Framework".
 *
 * License: GNU/GPL v2 or any later version, see LICENSE file.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

namespace Koch\Exception\Renderer;

use Koch\Exception\Errorhandler;
use Koch\Exception\Exception;

class YellowScreenOfDeath

{
    /**
     * Renders a Koch Framework Exception.
     */
    public static function renderException($message, $string, $code, $file, $line, $trace)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        ob_start();

        /*
         * @todo add backlink to the exception codes list
         */
        if ($code > 0) {
            $code = '(#' . $code . ')';
        } else {
            $code = '';
        }

        // Header
        $html = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"';
        $html .= ' "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
        $html .= '<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">';
        $html .= '<head>';
        $html .= '<title>Koch Framework Exception ' . $code . ' - ' . $message . '</title>';
        $html .= '<link rel="stylesheet" href="' . WWW_ROOT_THEMES_CORE . 'css/error.css" type="text/css" />';
        $html .= '</head>';

        // Body
        $html .= '<body>';

        // Fieldset
        $html .= '<fieldset id="top" class="error_yellow">';

        // Errorlogo
        $html .= '<div style="float: left; margin: 5px; margin-right: 25px; padding: 20px;">';
        $html .= '<img src="' . WWW_ROOT_THEMES_CORE . 'images/Clansuite-Toolbar-Icon-64-exception.png" ';
        $html .= 'style="border: 2px groove #000000;" alt="Clansuite Exception Icon" /></div>';

        // Fieldset Legend
        $html .= '<legend>Koch Framework Exception</legend>';

        // Exception Table
        $html .= '<table width="80%"><tr><td>';

        /*
         * Panel 1
         *
         * Exception Message and File
         */

        $html .= '<div id="panel1" class="panel">';
        $html .= '<h3>Exception ' . $code . '</h3><h4>' . $message . '</h4>';
        $html .= '<strong>' . Errorhandler::getFileLink($file, $line) . '.</strong>';
        $html .= '</div>';

        /*
         * Panel 2
         *
         * Debug Backtrace
         */
        if (defined('DEBUG') and DEBUG === 1) {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
            // lets get the backtrace as html table
            $html .= Errorhandler::getDebugBacktrace($trace);
        }

        /*
         * Panel 3
         *
         * Server Environment Informations
         */
        if (defined('DEBUG') and DEBUG === 1) {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
            $html .= '<div id="panel3" class="panel">';
            $html .= '<h3>Server Environment</h3>';
            $html .= '<table width="95%">';
            $html .= '<tr><td><strong>Date: </strong></td><td>' . date('r') . '</td></tr>';
            $html .= '<tr><td><strong>Remote: </strong></td><td>' . $_SERVER['REMOTE_ADDR'] . '</td></tr>';
            $html .= '<tr><td><strong>Request: </strong></td><td>index.php?' . $_SERVER['QUERY_STRING'] . '</td></tr>';
            $html .= '<tr><td><strong>PHP: </strong></td><td>' . PHP_VERSION . ' ' . PHP_EXTRA_VERSION . '</td></tr>';
            $html .= '<tr><td><strong>Server: </strong></td><td>' . $_SERVER['SERVER_SOFTWARE'] . '</td></tr>';
            $html .= '<tr><td><strong>Agent: </strong></td><td>' . $_SERVER['HTTP_USER_AGENT'] . '</td></tr>';
            $html .= '<tr><td><strong>Application: </strong></td>';
            $html .= '<td>' . APPLICATION_VERSION . ' ' . APPLICATION_VERSION_STATE;
            $html .= ' (' . APPLICATION_VERSION_NAME . ')</td></tr>';
            $html .= '</table></div>';
        }

        /*
         * Panel 4
         *
         * Additional Information
         */
        if (empty(self::$exception_template) === false) {
            $html .= '<div id="panel4" class="panel">';
            $html .= '<h3>Additional Information & Solution Suggestion</h3>';
            $html .= self::$exception_template . '</div>';
        }

        /*
         * Panel 5
         *
         * Rapid Development
         */
        $placeholders = [];
        // assign placeholders for replacements in the html
        if (strpos($message, 'action_')) {
            $placeholders['actionname'] = substr($message, strpos($message, 'action_'));
        } elseif (strpos($message, 'module_')) {
            $placeholders['classname'] = substr($message, strpos($message, 'module_'));
        }

        if (empty($_GET['mod']) === false) {
            $placeholders['modulename'] = (string) stripslashes($_GET['mod']);
        } else {
            $placeholders['modulename'] = '';
        }

        // add development helper template to exceptions
        if (defined('DEVELOPMENT') and DEVELOPMENT === 1 and defined('RAPIDDEVTPL') and RAPIDDEVTPL === 1) {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
            $html .= '<div id="panel5" class="panel">';
            $html .= '<h3>Rapid Application Development</h3>';
            $html .= Exception::getExceptionDevelopmentTemplate($placeholders) . '</div>';
        }

        /*
         * Panel 6
         *
         * Backlink to Bugtracker with Exceptionmessage
         * @link http://trac.clansuite.com/newticket
         */
        $html .= Errorhandler::getBugtrackerBacklinks($message, $file, $line, $trace);

        // close all html element table
        $html   .= '</table>';

        /*
         * Panel 7
         *
         * Footer with Support-Backlinks
         */
        $html  .= Errorhandler::getSupportBacklinks($this);


        // close all html elements: fieldset, body+page
        $html   .= '</fieldset>';
        $html   .= '</body></html>';

        // save session before exit - but only if this is not a pdo exception
        // that would trigger a fatal error, when trying to write to the db during session save
        if ((bool) session_id() and false === strpos($message, 'SQLSTATE')) {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
            session_write_close();
        }

        // clear all output buffers
        if (ob_get_length()) {
            ob_end_clean();
        }

        // Output the errormessage
        return $html;
    }

    /**
     * Renders a Koch Framework Error.
     *
     * @param int    $errno
     * @param string $errstr
     * @param string $errfile
     * @param string $errline
     * @param int    $errline
     * @param string $errcontext
     * @param string $errorname
     */
    public static function renderError($errno, $errorname, $errstr, $errfile, $errline, $errcontext)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        // shorten errorfile string by removing the root path
        $errfile_short     = str_replace(APPLICATION_PATH, '', $errfile);

        $short_errorstring = \Koch\Functions\Functions::shortenString($errfile, 70, '...');


        // Header
        $html = '<html><head>';
        $html .= '<title>Koch Framework Error</title>';
        $html .= '<link rel="stylesheet" href="' . WWW_ROOT_THEMES_CORE . 'css/error.css" type="text/css" />';
        $html .= '</head>';

        // Body
        $html .= '<body>';

        // Fieldset with Legend
        $html .= '<fieldset id="top" class="error_red">';
        $html .= '<legend>Koch Framework Error</legend>';

        // Add Errorlogo
        $html .= '<div style="float: left; margin: 5px; margin-right: 25px; padding: 20px;">';
        $html .= '<img src="' . WWW_ROOT_THEMES_CORE . 'images/Clansuite-Toolbar-Icon-64-error.png"';
        $html .= ' style="border: 2px groove #000000;"/></div>';

        // Open Error Table
        $html .= '<table width="80%"><tr><td>';

        // Panel 1 - Errormessage
        $html .= '<div id="panel1" class="panel">';
        $html .= '<h3>Error - ' . $errorname . ' (' . $errno . ')</h3> ';
        $html .= '<p style="font-weight: bold;">' . $errstr . '</p>';
        $html .= '<p>in file "<span style="font-weight: bold;">' . $errfile_short . '</span>"';

        $html .= ' on line #<span style="font-weight: bold;">' . $errline . '.</span></p>';
        $html .= '</div>';

        // Panel 2 - Error Context
        $html .= '<div id="panel2" class="panel">';
        $html .= '<h3>Context</h3>';
        $html .= '<p><span class="small">You are viewing the source code of the file "';
        $html .= $errfile . '" around line ' . $errline . '.</span></p>';
        $html .= Errorhandler::getErrorContext($errfile, $errline, 8) . '</div>';

        // Panel 3 - Debug Backtracing
        $html .= Errorhandler::getDebugBacktrace($short_errorstring);


        // Panel 4 - Environmental Informations at Errortime
        $html .= '<div id="panel4" class="panel">';
        $html .= '<h3>Server Environment</h3>';
        $html .= '<p><table width="95%">';
        $html .= '<tr><td colspan="2"></td></tr>';
        $html .= '<tr><td><strong>Date: </strong></td><td>' . date('r') . '</td></tr>';
        $html .= '<tr><td><strong>Remote: </strong></td><td>' . $_SERVER['REMOTE_ADDR'] . '</td></tr>';
        $html .= '<tr><td><strong>Request: </strong></td><td>' . htmlentities($_SERVER['QUERY_STRING'], ENT_QUOTES);
        $html .= '</td></tr>';
        $html .= '<tr><td><strong>PHP: </strong></td><td>' . PHP_VERSION . ' ' . PHP_EXTRA_VERSION . '</td></tr>';
        $html .= '<tr><td><strong>Server: </strong></td><td>' . $_SERVER['SERVER_SOFTWARE'] . '</td></tr>';
        $html .= '<tr><td><strong>Agent: </strong></td><td>' . $_SERVER['HTTP_USER_AGENT'] . '</td></tr>';
        $html .= '<tr><td><strong>Clansuite: </strong></td><td>';
        $html .= APPLICATION_VERSION . ' ' . APPLICATION_VERSION_STATE . ' (' . APPLICATION_VERSION_NAME . ')';
        $html .= '</td></tr>';
        $html .= '</table></p></div>';

        // Panel 5 - Backlink to Bugtracker with Errormessage -> http://trac.clansuite.com/newticket
        $html .= Errorhandler::getBugtrackerBacklinks($errorname, $errfile, $errline, $errcontext);

        // Close Error Table
        $html .= '</table>';

        // Add Footer with Support-Backlinks
        $html .= Errorhandler::getSupportBacklinks();

        // Close all html elements
        $html .= '</fieldset><br /><br />';
        $html .= '</body></html>';

        return $html;
    }
}

YellowScreenOfDeath::renderError() B
last analyzed 2017-04-11 14:32 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

KSST / KF

YellowScreenOfDeath::renderError() B last analyzed 2017-04-11 14:32 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

Duplication Side-by-Side

Filter issues like

YellowScreenOfDeath::renderError() B
last analyzed 2017-04-11 14:32 UTC
