GreyLogException - Code Metrics - lucderheld/php-greylog-exception - Measure and Improve Code Quality continuously with Scrutinizer

GreyLogException B
last analyzed 2016-11-15 21:46 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	448
Duplicated Lines	19.64 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	37
lcom	1
cbo	4
dl	88
loc	448
ccs	0
cts	181
cp	0
rs	8.6
c	0
b	0
f	0

22 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	38	4
B	validateExceptionDetails()	0	20	7
A	formatErrorMessage()	0	9	2
A	getNumberOfVariables()	0	6	2
A	getExceptionCode()	0	8	2
A	innerNotice()	0	14	1
A	emergency()	11	11	1
A	alert()	11	11	1
A	critical()	11	11	1
A	error()	11	11	1
A	warning()	11	11	1
A	notice()	11	11	1
A	info()	11	11	1
A	debug()	11	11	1
A	setShortMessage()	0	3	1
A	setMessage()	0	3	1
A	setLevel()	0	3	1
A	setFacility()	0	3	1
A	setAdditionals()	0	9	1
A	addParameters()	0	21	4
A	publishMessage()	0	3	1
A	loggerPanic()	0	3	1

How to fix Duplicated Code

<?php

/*
 * Copyright (C) 2016 luc <[email protected]>
 *
 * 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 3 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 GreyLogException;

/**
 * This is the main class for the GreyLogException module.
 * @author luc <[email protected]>
 * @version 0.2
 */
class GreyLogException extends \Exception {

    /**
     * The application name that is logging the exception (facility in GrayLog).
     */
    private $sApplication = "SampleApplicationName";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

    /**
     * The IP the GrayLog2-Server listens to.
     */
    private $sLogServerIp = "127.0.0.1";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

    /**
     * PSR LogLevel 8
     */
    const EMERGENCY = \Psr\Log\LogLevel::EMERGENCY;

    /**
     * PSR LogLevel 7
     */
    const ALERT = \Psr\Log\LogLevel::ALERT;

    /**
     * PSR LogLevel 6
     */
    const CRITICAL = \Psr\Log\LogLevel::CRITICAL;

    /**
     * PSR LogLevel 5
     */
    const ERROR = \Psr\Log\LogLevel::ERROR;

    /**
     * PSR LogLevel 4
     */
    const WARNING = \Psr\Log\LogLevel::WARNING;

    /**
     * PSR LogLevel 3
     */
    const NOTICE = \Psr\Log\LogLevel::NOTICE;

    /**
     * PSR LogLevel 2
     */
    const INFO = \Psr\Log\LogLevel::INFO;

    /**
     * PSR LogLevel 1
     */
    const DEBUG = \Psr\Log\LogLevel::DEBUG;

    /**
     * The publisher object for GreyLog2-Server.
     * @var \Gelf\Publisher $publisher Holds the publisher object. 
     */
    private $publisher;

    /**
     * The message object to send to GreyLog2-Server.
     * @var \Gelf\Message $message Holds the message object.
     */
    private $gelfMessage;

    /**
     * The actual exception message.
     * @var String  $sExceptionMessage  The message for the exception.
     */
    public $sExceptionMessage;

    /**
     * The actual exception code.
     * @var Integer $iExceptionCode Holds the exception code.
     */
    public $iExceptionCode;

    /**
     * The actual exception identifier/shortMessage.
     * @var String  $sExceptionShortMessage Holds the exceptionShortMessage. 
     */
    public $sExceptionShortMessage;

    /**
     * The actual exception level. Possible values:
     * EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFO, DEBUG
     * @var String  $sExceptionLevel    Holds the exceptionLevel.
     */
    private $sExceptionLevel;

    /**
     * The actual class where the exception was thrown.
     * @var String  $sExceptionClass    Holds the exceptionClass.
     */
    private $sExceptionClass;

    /**
     * The actual function/method where the exception was thrown.
     * @var String  $sExceptionFunction Holds the exceptionFunction.
     */
    private $sExceptionFunction;

    /**
     * The actual exception class the exception came from.
     * @var String  $sModuleName    Holds the moduleName.
     */
    private $sModuleName;

    /**
     * Sends a new exception with the help of an exceptionDetails array and aditional parameters.
     * @param Array $_aExceptionDetails The exceptionDetails in form: "[int ExceptionCode, lfException::LOGLEVEL, string ExceptionMessage]".
     * @param Mixed $_aAdditionalInformations The array of all other given parameters for setting them in the exceptionMessage.
     */
    public function __construct(Array $_aExceptionDetails, ...$_aAdditionalInformations) {
        //get configruation
        $this->sApplication = GreyLogExceptionConfig::$sApplicationNameToLog;
        $this->sLogServerIp = GreyLogExceptionConfig::$sGreyLogServerIp;

        try {
            //call user-code for exception if there is any
            $oClass = new \ReflectionClass(get_called_class());
            $sExceptionArrayKey = array_search($_aExceptionDetails, $oClass->getConstants());
            if ($sExceptionArrayKey !== false && method_exists(get_called_class(), $sExceptionArrayKey)) {
                $sClassToCall = get_called_class();
                $sClassToCall::$sExceptionArrayKey();
            }

            //prepare transport objects to GreyLog2
            $oTransportObject = new \Gelf\Transport\UdpTransport($this->sLogServerIp, 12201, \Gelf\Transport\UdpTransport::CHUNK_SIZE_LAN);
            $this->publisher = new \Gelf\Publisher();
            $this->publisher->addTransport($oTransportObject);

            //validate exception details
            $this->validateExceptionDetails($_aExceptionDetails);
            //format/create the exception message
            $this->sExceptionMessage = $this->formatErrorMessage($_aAdditionalInformations);
            //create standard exception
            parent::__construct($this->sExceptionMessage, $this->iExceptionCode);
            //set additional exception details
            $this->sExceptionShortMessage = $this->getExceptionCode($_aExceptionDetails, get_called_class());
            $this->sExceptionClass = $this->getTrace()[0]['class'];
            $this->sExceptionFunction = $this->getTrace()[0]['function'];
            $this->sModuleName = get_called_class();
            //log exception
            $sFunctionToCall = $this->sExceptionLevel;
            $this->$sFunctionToCall();
        } catch (\Exception $ex) {
            //use your own code in loggerPanic to do something when message cant be logged
            $this->loggerPanic($this->sExceptionShortMessage);
        }
    }

    /**
     * Checks the exceptionArray for valid contents and sets its values.
     * Sets a standard value if details are missing in array.
     * Sends a notice exception if there are missing details.
     * @param array $_aExceptionDetails The exceptionDetails in form: "[int ExceptionCode, lfException::LOGLEVEL, string ExceptionMessage]".
     */
    private function validateExceptionDetails(Array $_aExceptionDetails) {
        if (isset($_aExceptionDetails[0]) && is_numeric($_aExceptionDetails[0])) {
            $this->iExceptionCode = $_aExceptionDetails[0];
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
            if (isset($_aExceptionDetails[1]) && method_exists($this, $_aExceptionDetails[1])) {
                $this->sExceptionLevel = $_aExceptionDetails[1];
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
                if (isset($_aExceptionDetails[2]) && is_string($_aExceptionDetails[2])) {
                    $this->sExceptionMessage = $_aExceptionDetails[2];
                } else {
                    $this->sExceptionMessage = "__ERR_NOT_FOUND__";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
                    $this->innerNotice("WrongConfig", "The exeption thrown, has no exceptionMessage.");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
                }
            } else {
                $this->sExceptionLevel = self::ERROR;
                $this->innerNotice("WrongConfig", "The exeption thrown, has no or invalid exceptionLevel, using ERROR instead.");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            }
        } else {
            $this->iExceptionCode = 000000;
            $this->innerNotice("WrongConfig", "The exeption thrown, has no exceptionCode. Using '000000' instead.");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        }
    }

    /**
     * Formats the errorMessage and fills the variables with content if there are any. 
     * @param array $_aAdditionalInformations   An array containing all values for variables that has to be replaced in errorMessage.
     * @return string   The formated errorMessage.
     */
    public function formatErrorMessage(array $_aAdditionalInformations) {
        if (count($_aAdditionalInformations) > 0) {
            $sFormatedExceptionMessage = vsprintf($this->sExceptionMessage, $_aAdditionalInformations);
            $sFormatedExceptionMessage .= "." . PHP_EOL . "Call-Stack:" . PHP_EOL . $this->getTraceAsString();
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        } else {
            $sFormatedExceptionMessage = $this->sExceptionMessage . "." . PHP_EOL . "Call-Stack:" . PHP_EOL . $this->getTraceAsString();
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        }
        return $sFormatedExceptionMessage;
    }

    /**
     * Gets the number of variables that can be replaces by sprintf function in a string.
     * @param string $_sReplaceableString The string to search for replacable variables.
     * @return int Returns the number of valriables that can be relaced via sprintf.
     */
    public function getNumberOfVariables(string $_sReplaceableString) {
        if (preg_match_all("~%(?:(\d+)[$])?[-+]?(?:[ 0]|['].)?(?:[-]?\d+)?(?:[.]\d+)?[%bcdeEufFgGosxX]~", $_sReplaceableString, $iNumberOfVariables) > 0) {
            return count($iNumberOfVariables[1]);
        }
        return 0;
    }

    /**
     * Seaches the key of the given class constant value.
     * @param array $_aExceptionDetails The value of an exception constant.
     * @param string $_sExceptionClass The class the exception constant has to be searched.
     * @return mixed the key for <i>needle</i> if it is found in the array, <b>FALSE</b> otherwise.
     * @todo Could be cached with storing all exceptions in opCache
     * @todo Inner exception should be added when getExceptionCode fails. But at the moment innerNotice function has circular reference to ExceptinShortMessage
     */
    public function getExceptionCode($_aExceptionDetails, $_sExceptionClass) {
        $oClass = new \ReflectionClass($_sExceptionClass);
        $sExceptionCode = array_search($_aExceptionDetails, $oClass->getConstants());
        if($sExceptionCode === false){
            $sExceptionCode = "UNKNOWN";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        }
        return $sExceptionCode;
    }

    /**
     * Sends an notice to GreyLog-Server before sending the actual exception.
     * @param string $sShortMessage The notice identifier.
     * @param string $sMessage  The message for the notice.
     */
    private function innerNotice(string $sShortMessage, string $sMessage) {
        $message = new \Gelf\Message();
        $message->setShortMessage($sShortMessage . "_" . $this->iExceptionCode . ":" . $this->sExceptionShortMessage)
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
                ->setLevel(self::NOTICE)
                ->setFullMessage($sMessage)
                ->setFacility($this->sApplication)
                ->setAdditional('ModuleName', $this->sModuleName)
                ->setAdditional('ExceptionClassName', $this->sExceptionClass)
                ->setAdditional('ExceptionFunctionName', $this->sExceptionFunction)
                ->setAdditional('ExceptionCode', $this->code)
                ->setAdditional('ExceptionFileName', $this->file)
                ->setAdditional('ExceptionLineNumber', $this->line);
        $this->publisher->publish($message);
    }

    /**
     * Sends an execption of type "EMERGENCY" to configured GreyLog2-Server.
     */
    private function emergency() {

        $this->gelfMessage = new \Gelf\Message();
        $this->setShortMessage();
        $this->setMessage();
        $this->setLevel();
        $this->setFacility();
        $this->setAdditionals();
        $this->addParameters();
        //send message
        $this->publishMessage();
    }

    /**
     * Sends an execption of type "ALERT" to configured GreyLog2-Server.
     */
    private function alert() {

        $this->gelfMessage = new \Gelf\Message();
        $this->setShortMessage();
        $this->setMessage();
        $this->setLevel();
        $this->setFacility();
        $this->setAdditionals();
        $this->addParameters();
        //send message
        $this->publishMessage();
    }

    /**
     * Sends an execption of type "CRITICAL" to configured GreyLog2-Server.
     */
    private function critical() {

        $this->gelfMessage = new \Gelf\Message();
        $this->setShortMessage();
        $this->setMessage();
        $this->setLevel();
        $this->setFacility();
        $this->setAdditionals();
        $this->addParameters();
        //send message
        $this->publishMessage();
    }

    /**
     * Sends an execption of type "ERROR" to configured GreyLog2-Server.
     */
    private function error() {

        $this->gelfMessage = new \Gelf\Message();
        $this->setShortMessage();
        $this->setMessage();
        $this->setLevel();
        $this->setFacility();
        $this->setAdditionals();
        $this->addParameters();
        //send message
        $this->publishMessage();
    }

    /**
     * Sends an execption of type "WARNING" to configured GreyLog2-Server.
     */
    private function warning() {

        $this->gelfMessage = new \Gelf\Message();
        $this->setShortMessage();
        $this->setMessage();
        $this->setLevel();
        $this->setFacility();
        $this->setAdditionals();
        $this->addParameters();
        //send message
        $this->publishMessage();
    }

    /**
     * Sends an execption of type "NOTICE" to configured GreyLog2-Server.
     */
    private function notice() {

        $this->gelfMessage = new \Gelf\Message();
        $this->setShortMessage();
        $this->setMessage();
        $this->setLevel();
        $this->setFacility();
        $this->setAdditionals();
        $this->addParameters();
        //send message
        $this->publishMessage();
    }

    /**
     * Sends an execption of type "INFO" to configured GreyLog2-Server.
     */
    private function info() {

        $this->gelfMessage = new \Gelf\Message();
        $this->setShortMessage();
        $this->setMessage();
        $this->setLevel();
        $this->setFacility();
        $this->setAdditionals();
        $this->addParameters();
        //send message
        $this->publishMessage();
    }

    /**
     * Sends an execption of type "DEBUG" to configured GreyLog2-Server.
     */
    private function debug() {

        $this->gelfMessage = new \Gelf\Message();
        $this->setShortMessage();
        $this->setMessage();
        $this->setLevel();
        $this->setFacility();
        $this->setAdditionals();
        $this->addParameters();
        //send message
        $this->publishMessage();
    }

    /**
     * Sets the ShortMessage and returns message object.
     * @return Gelf\Message Sets the ShortMessage and returns message object.

     */
    private function setShortMessage() {
        return $this->gelfMessage->setShortMessage($this->iExceptionCode . ":" . $this->sExceptionShortMessage);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }

    /**
     * Sets the Message and returns message object.
     * @return Gelf\Message Sets the Message and returns message object.

     */
    private function setMessage() {
        return $this->gelfMessage->setFullMessage($this->sExceptionMessage);
    }

    /**
     * Sets the Level and returns message object.
     * @return Gelf\Message Sets the Level and returns message object.

     */
    private function setLevel() {
        return $this->gelfMessage->setLevel($this->sExceptionLevel);
    }

    /**
     * Sets the Facility and returns message object.
     * @return Gelf\Message Sets the Facility and returns message object.

     */
    private function setFacility() {
        return $this->gelfMessage->setFacility($this->sApplication);
    }

    /**
     * Sets additional details from exception object and returns message object.
     * @return Gelf\Message Sets the additional details from exception object and returns message object.

     */
    private function setAdditionals() {
        $this->gelfMessage->setAdditional('ModuleName', $this->sModuleName);
        $this->gelfMessage->setAdditional('ExceptionClassName', $this->sExceptionClass);
        $this->gelfMessage->setAdditional('ExceptionFunctionName', $this->sExceptionFunction);
        $this->gelfMessage->setAdditional('ExceptionCode', $this->code);
        $this->gelfMessage->setAdditional('ExceptionFileName', $this->file);
        $this->gelfMessage->setAdditional('ExceptionLineNumber', $this->line);
        return $this->gelfMessage;
    }

    /**
     * Checks if function/method parameters are equal to function declaration and logs warning if not.
     * Gets all names of function/method parameters and its values and adds it to message object as additional.
     * @return Gelf\Message Sets additional details to message object and returns the message object.

     */
    private function addParameters() {
        //get function/method parameters and parameters function was called
        $ref = new \ReflectionMethod($this->sExceptionClass, $this->sExceptionFunction);
        $aFunctionParameters = $ref->getParameters();
        $aFunctionParametersSetted = $this->getTrace()[0]['args'];
        //log notice if number of parameters does not match
        if (count($aFunctionParameters) < count($aFunctionParametersSetted)) {
            $this->innerNotice("MissUse", "Function was called with '" . count($aFunctionParametersSetted) . "' parameters, but defined on function is only '" . count($aFunctionParameters) . "'");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        }
        //add parameters and values to exception to log
        $i = 0;
        foreach ($aFunctionParametersSetted as $mParameterValue) {
            if (!isset($aFunctionParameters[$i])) {
                $this->gelfMessage->setAdditional("Param_UNKNOWN" . $i, serialize($mParameterValue));
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            } else {
                $this->gelfMessage->setAdditional("Param_" . $aFunctionParameters[$i]->name, serialize($mParameterValue));
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            }
            $i++;
        }
        return $this->gelfMessage;
    }

    /**
     * Publishes the message object to configured GreyLog2-Server instance.
     * @return Gelf\publisher The publisher object.

     */
    private function publishMessage() {
        $this->publisher->publish($this->gelfMessage);
    }

    private function loggerPanic(string $_sMessage) {
        die("<html><head><title>Error</title></head><body><h1>Error!</h1><h3>Error while logging the error {$_sMessage}</h3><h4><style 'font-color:red'>Application stoped!</font></h4></body></html>");
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
    }

}


1			<?php
2
3			/*
4			* Copyright (C) 2016 luc <[email protected]>
5			*
6			* This program is free software: you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15			*
16			* You should have received a copy of the GNU General Public License
17			* along with this program. If not, see <http://www.gnu.org/licenses/>.
18			*/
19
20			namespace GreyLogException;
21
22			/**
23			* This is the main class for the GreyLogException module.
24			* @author luc <[email protected]>
25			* @version 0.2
26			*/
27			class GreyLogException extends \Exception {
28
29			/**
30			* The application name that is logging the exception (facility in GrayLog).
31			*/
32			private $sApplication = "SampleApplicationName";
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-11-15 21:04 UTC by Report Bug Copy Issue Report The string literal `SampleApplicationName` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
33
34			/**
35			* The IP the GrayLog2-Server listens to.
36			*/
37			private $sLogServerIp = "127.0.0.1";
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-11-15 21:04 UTC by Report Bug Copy Issue Report The string literal `127.0.0.1` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
38

lucderheld / php-greylog-exception

GreyLogException B last analyzed 2016-11-15 21:46 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

22 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

GreyLogException B
last analyzed 2016-11-15 21:46 UTC