SilverLeague\LogViewer\Model\LogEntry

Complexity

Total Complexity

19

Size/Duplication

Total Lines	138
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	1
Bugs	1	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	canEdit()	0	4	1
B	getCMSFields()	0	25	4
B	entryToUl()	0	16	5
C	formatLegacyEntry()	0	28	7
A	getGridfieldSummary()	0	6	2

<?php

namespace SilverLeague\LogViewer\Model;

use SilverStripe\Core\Convert;
use SilverStripe\Forms\LiteralField;
use SilverStripe\ORM\DataObject;

/**
 * A LogEntry is a set of data provided from Monolog via the DataObjectHandler
 *
 * @package silverstripe-logviewer
 * @author  Robbie Averill <robbie@averill.co.nz>
 * @author  Simon Erkelens <simon@casa-laguna.net>
 *
 * @property string $Entry
 * @property string $Level
 */
class LogEntry extends DataObject
{
    /**
     * {@inheritDoc}
     */
    private static $table_name = 'LogEntry';

Consider using a different property name as you override a private property of the parent class.

The property $table_name is not used and could be removed.

    /**
     * @var bool
     */
    private static $format_entry = true;

The property $format_entry is not used and could be removed.

    /**
     * {@inheritDoc}
     */
    private static $db = [

Consider using a different property name as you override a private property of the parent class.

The property $db is not used and could be removed.

        'Entry' => 'Text',
        'Level' => 'Varchar'
    ];

    /**
     * {@inheritDoc}
     */
    private static $summary_fields = [

Consider using a different property name as you override a private property of the parent class.

The property $summary_fields is not used and could be removed.

        'GridfieldSummary' => 'Entry',
        'Created'          => 'Created',
        'Level'            => 'Level'
    ];

    /**
     * We should never need to edit log entries
     *
     * {@inheritDoc}
     */
    public function canEdit($member = false, $context = [])

The parameter $context is not used and could be removed.

    {
        return false;
    }

    /**
     * @inheritdoc
     * @return \SilverStripe\Forms\FieldList
     */
    public function getCMSFields()
    {
        $config = self::config()->get('format_entry');
        $fields = parent::getCMSFields();
        if ($config) { // Default setting, format the entry
            $fields->removeByName(array('Entry'));
            $text = $this->Entry;
            $asArray = Convert::json2array($text);
            if (!is_array($asArray)) {
                /** @deprecated We're falling back to the legacy text-only error */
                $entry = $this->formatLegacyEntry($text);

The method SilverLeague\LogViewer\Model\LogEntry::formatLegacyEntry() has been deprecated with message: This method exists to make sure non-JSONFormatted messages won't break the flow

            } else {
                $entry = $this->entryToUl($asArray, true);
            }
            $entry = nl2br("<pre>" . $entry . "</pre>");
            $fields->addFieldToTab('Root.Main', LiteralField::create('FormattedEntry', $entry));
        } else { // Just move the field after the Level
            $entryField = $fields->dataFieldByName('Entry');
            if ($entryField !== null) {
                $fields->insertAfter('Level', $entryField);
            }
        }

        return $fields;
    }

    /**
     * Recursive method, will call itself if a sub element is an array
     * @param array $data
     * @param bool $first start with an opening bracket? if true, skip (counterintuitive, but naming)
     * @return string formatted <ul><li> of the array;
     */
    private function entryToUl($data, $first = false)
    {
        $out = $first ? '' : '[';
        $out .= '<ul style="margin-bottom: 0">';
        foreach ($data as $key => $arrayItem) {
            if (!is_array($arrayItem)) {
                $out .= '<li  class="list-unstyled"><span>' . $key . ' => ' . $arrayItem . '</span></li>';
            } else {
                $out .= '<li class="list-unstyled"><span>' . $key . ' => </span>' . $this->entryToUl($arrayItem) . '</li>';
            }
        }
        $out .= '</ul>';
        $out .= $first ? '' : ']';

        return $out;
    }

    /**
     * @param string $text
     * @return string
     * @deprecated This method exists to make sure non-JSONFormatted messages won't break the flow
     */
    private function formatLegacyEntry($text)
    {
        preg_match_all("/(\{\".*?}+)\s/", $text, $matches);
        $entry = "<h2>Entry</h2>";
        if (count($matches[1])) {
            foreach ($matches[1] as $key => $match) {
                $pretext = substr($text, 0, strpos($text, $match)); // Header of the error
                $asArray = Convert::json2array($match); // Convert the rest to array
                $text = substr($text, strlen($pretext . $match)); // Prepare for the next entry
                $entry .= ($key > 0 ? "\n" : '') . trim($pretext) . ' => ';
                if (is_array($asArray)) {
                    $entry .= $this->entryToUl($asArray);
                } else {
                    $entry .= "\n" . $match;
                }
            }
            if (Convert::json2array(trim($text)) !== null) {
                $text = Convert::json2array(trim($text));
                $entry .= "\nOther => " . $this->entryToUl($text);

It seems like $text defined by \SilverStripe\Core\Convert::json2array(trim($text)) on line 134 can also be of type boolean; however, SilverLeague\LogViewer\Model\LogEntry::entryToUl() does only seem to accept array, maybe add an additional type check?

            } elseif (strlen(trim($text))) { // add the leftover if there is any
                $entry .= "\nOther:\n" . $text;
            }
        } else {
            $entry = '<p>' . $text . '</p>';
        }

        return $entry;
    }

    /**
     * @param int $length Length of the summary
     * @return string shortened string of the entry if too long.
     */
    public function getGridfieldSummary($length = 300)
    {
        $elipsis = strlen($this->Entry) > $length ? '...' : '';

        return substr($this->Entry, 0, $length) . $elipsis;
    }
}