ToEmail::addToLog() - Code Metrics - Inspection of "misc fixes of loggers" - VitexSoftware/ease-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ecae65...62a409 )

by Vítězslav

created 2019-02-03 22:20 UTC

ToEmail::addToLog() A

↳ Parent: ToEmail

Complexity

Conditions	6
Paths	6

Size

Total Lines	23
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	42

Importance

Changes

Metric	Value
cc	6
eloc	12
nc	6
nop	3
dl	0
loc	23
ccs	0
cts	17
cp	0
crap	42
rs	9.2222
c	0
b	0
f	0

<?php
/**
 * Send logs by email
 *
 * @author    Vitex <[email protected]>
 * @copyright 2009-2016 [email protected] (G)
 */

namespace Ease\Logger;

/**
 * Log to Email
 *
 * @author    Vitex <[email protected]>
 * @copyright 2009-2012 [email protected] (G)
 */
class ToEmail extends ToMemory
{
    /**
     * Předvolená metoda logování.
     *
     * @var string
     */
    public $logType = 'email';

    /**
     * úroveň logování.
     *
     * @var string - silent,debug
     */
    public $logLevel = 'debug';

    /**
     * Odkaz na vlastnící objekt.
     *
     * @var \Ease\Sand
     */
    public $parentObject = null;

    /**
     * Pole uložených zpráv.
     *
     * @var array
     */
    public $statusMessages = [];

    /**
     * ID naposledy ulozene zpravy.
     *
     * @var int unsigned
     */
    private $messageID = 0;

    /**
     * Obecné konfigurace frameworku.
     *
     * @var \Ease\Shared
     */
    public $easeShared = null;

    /**
     * List of allready flushed messages.
     *
     * @var array
     */
    public $flushed = [];

    /**
     * Saves obejct instace (singleton...).
     */
    private static $_instance = null;

    /**
     * Handle to mailer.
     *
     * @var resource
     */
    public $mailer = null;

    /**
     * Recipient
     * @var string
     */
    public $recipient = null;

    /**
     * Log Subject
     * @var string
     */
    public $subject = null;

    /**
     * Logger to mail Class
     *
     * @param string $recipient
     * @param string $subject of message
     */
    public function __construct($recipient = null, $subject = null)
    {
        $this->recipient = $recipient;
        $this->subject   = empty($subject) ? $_SERVER['PHP_SELF'] : $subject;
    }

    /**
     * Pri vytvareni objektu pomoci funkce singleton (ma stejne parametry, jako
     * konstruktor) se bude v ramci behu programu pouzivat pouze jedna jeho
     * instance (ta prvni).
     *
     * @link http://docs.php.net/en/language.oop5.patterns.html Dokumentace a
     * priklad
     */
    public static function singleton()
    {
        if (!isset(self::$_instance)) {
            $class = __CLASS__;
            if (defined('EASE_APPNAME')) {
                self::$_instance = new $class(constant('EASE_EMAILTO'),
                    constant('EASE_APPNAME'));
            } else {
                self::$_instance = new $class('EaseFramework');
            }
        }

        return self::$_instance;
    }

    /**
     * Zapise zapravu do logu.
     *
     * @param string $caller  název volajícího objektu
     * @param string $message zpráva
     * @param string $type    typ zprávy (success|info|error|warning|*)
     *
     * @return null|boolean byl report zapsán ?
     */
    public function addToLog($caller, $message, $type = 'notice')
    {

        if (!is_object($this->mailer)) {

            $this->mailer = new \Ease\Mailer($this->recipient, $this->subject);

            $this->mailer->setUserNotification(false);
        }

        ++$this->messageID;
        if (($this->logLevel == 'silent') && ($type != 'error')) {
            return;
        }
        if (($this->logLevel != 'debug') && ($type == 'debug')) {
            return;
        }

        $this->statusMessages[$type][$this->messageID] = $message;

        $logLine = strftime("%D %T").' `'.$caller.'`: '.$message;

        $this->mailer->addItem(\Ease\Shared::linkify($logLine));
                       addItem(\Ease\Shared::linkify($logLine));

        return true;
    }

    /**
     * Oznamuje chybovou událost.
     *
     * @param string $caller     název volající funkce, nebo objektu
     * @param string $message    zpráva
     * @param mixed  $objectData data k zaznamenání
     */
    public function error($caller, $message, $objectData = null)
    {
        if (!is_null($objectData)) {
            $message .= print_r($objectData, true);
        }
        $this->addToLog($caller, $message, 'error');
    }

    /**
     * Send collected messages.
     */
    public function __destruct()
    {
        if (is_object($this->mailer) && ( $this->mailer->getItemsCount() > 0 )) {

            $this->mailer->send();
        }
    }

    /**
     * Flush Messages.
     *
     * @param string $caller
     *
     * @return int how many messages was flushed
     */
    public function flush($caller = null)
    {
        $flushed = 0;
        if (count($this->statusMessages)) {
            foreach ($this->statusMessages as $type => $messages) {
                foreach ($messages as $messageID => $message) {
                    if (!isset($this->flushed[$type][$messageID])) {
                        $this->addToLog($caller, $message, $type);
                        $this->flushed[$type][$messageID] = true;
                        ++$flushed;
                    }
                }
            }
        }

        return $flushed;
    }
}


VitexSoftware / ease-core

Push — master ( ecae65...62a409 )

ToEmail::addToLog() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like