SilverLeague\LogViewer\Handler\DataObjectHandler

Complexity

Total Complexity

7

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getDefaultFormatter()	0	4	1
A	write()	0	4	1
A	addDataObject()	0	11	1
A	setObjectClass()	0	5	1
A	getObjectClass()	0	4	1
A	getMinimumLogLevel()	0	4	1

<?php

namespace SilverLeague\LogViewer\Handler;

use Monolog\Logger;
use Monolog\Formatter\LineFormatter;
use Monolog\Handler\AbstractProcessingHandler;
use SilverStripe\Core\Config\Config;

/**
 * The DataObjectHandler allows you to use a SilverStripe DataObject for handling Monolog log entries.
 *
 * The default class to use is "LogEntry" which will store the log message, level and date/time in the database.
 *
 * @package silverstripe-logviewer
 * @author  Robbie Averill <robbie@averill.co.nz>
 */
class DataObjectHandler extends AbstractProcessingHandler
{
    /**
     * The default DataObject to use for storing log entries
     *
     * @var string
     */
    const DEFAULT_CLASS = 'SilverLeague\\LogViewer\\Model\\LogEntry';

    /**
     * The default DateTime format to use for storing the log timestamp
     *
     * @var string
     */
    const DEFAULT_DATETIME_FORMAT = 'Y-m-d H:i:s';

    /**
     * DataObject class for storing log entries
     *
     * @var string
     */
    protected $objectClass;

    /**
     * @param string  $objectClass The DataObject class to use for handling the write
     * @param int     $level       The minimum logging level at which this handler will be triggered (configurable)
     * @param boolean $bubble      Whether the messages that are handled can bubble up the stack or not
     */
    public function __construct($objectClass = self::DEFAULT_CLASS, $level = Logger::DEBUG, $bubble = true)
    {
        $this->setObjectClass($objectClass);
        $level = $this->getMinimumLogLevel();
        parent::__construct($level, $bubble);
    }

    /**
     * {@inheritDoc}
     */
    protected function getDefaultFormatter()
    {
        return new LineFormatter('%message% %context% %extra%');
    }

    /**
     * {@inheritdoc}
     */
    protected function write(array $record)
    {
        $this->addDataObject((string) $record['formatted'], $record['level_name']);
    }

    /**
     * Create a new DataObject instance and set the log information to it
     *
     * @param  string $message The log message
     * @param  string $level   The log level text, e.g. "DEBUG"
     * @return int             The written DataObject ID
     */
    public function addDataObject($message, $level)
    {
        $class = $this->getObjectClass();

        $object = $class::create();
        $object->setField('Entry', $message);
        $object->setField('Level', $level);
        $object->write();

        return $object->ID;
    }

    /**
     * Set the DataObject to use for storing log entries
     *
     * @param  string $class
     * @return $this
     */
    public function setObjectClass($class)
    {
        $this->objectClass = $class;
        return $this;
    }

    /**
     * Get the DataObject to use for storing log entries
     *
     * @return string
     */
    public function getObjectClass()
    {
        return $this->objectClass;
    }

    /**
     * Get the minimum Monolog\Logger log level to start catching messages at
     *
     * @see \Monolog\Logger
     * @return int
     */
    public function getMinimumLogLevel()
    {
        return (int) Config::inst()->get('LogViewer', 'minimum_log_level');
    }
}