SilverLeague\LogViewer\Model\LogEntry

Complexity

Total Complexity

12

Size/Duplication

Total Lines	135
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes	1
Bugs	1	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getCMSFields()	0	18	3
A	buildEntry()	0	17	2
A	getGridfieldSummary()	0	6	2
A	providePermissions()	0	15	1
A	canCreate()	0	4	1
A	canEdit()	0	4	1
A	canDelete()	0	4	1
A	canView()	0	4	1

<?php

namespace SilverLeague\LogViewer\Model;

use SilverLeague\LogViewer\Helper\DeprecatedLogFormatter;
use SilverLeague\LogViewer\Helper\LogFormatter;
use SilverStripe\Core\Convert;
use SilverStripe\Forms\HeaderField;
use SilverStripe\Forms\LiteralField;
use SilverStripe\ORM\DataObject;
use SilverStripe\Security\Permission;
use SilverStripe\Security\PermissionProvider;

/**
 * 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 implements PermissionProvider
{
    /**
     * {@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'
    ];

    /**
     * @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->addFieldToTab('Root.Main', HeaderField::create('EntryHeading', 'Entry', 3));
            $fields->removeByName(array('Entry'));
            $entry = $this->buildEntry();
            $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;
    }

    private function buildEntry()
    {
        $text = $this->Entry;
        $asArray = Convert::json2array($text);
        // Inline styling for now
        $entry = "<pre class='form-control-static logentry-entry' style='white-space: normal; max-width: 85%;'>";
        if (!is_array($asArray)) {
            /** @deprecated We're falling back to the legacy text-only error */
            $entry .= DeprecatedLogFormatter::formatLegacyEntry($text);
        } else {
            $entry .= LogFormatter::entryToUl($asArray, false);
        }
        $entry .= '</pre>';
        $entry = nl2br($entry);

        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;
    }

    /**
     * Permissions
     */
    public function providePermissions()
    {
        return array(
            'DELETE_ENTRY' => array(
                'name'     => _t('LogEntry.PERMISSION_DELETE_DESCRIPTION', 'Delete log entries'),
                'category' => _t('Permissions.LOGENTRY_CATEGORY', 'Log entry permissions'),
                'help'     => _t('LogEntry.PERMISSION_DELETE_HELP', 'Permission required to delete existing log entries.')
            ),
            'VIEW_ENTRY'   => array(
                'name'     => _t('LogEntry.PERMISSION_VIEW_DESCRIPTION', 'View log entries'),
                'category' => _t('Permissions.LOGENTRY_CATEGORY', 'Log entry permissions'),
                'help'     => _t('LogEntry.PERMISSION_VIEW_HELP', 'Permission required to view existing log entries.')
            ),
        );
    }

    /**
     * {@inheritdoc}
     */
    public function canCreate($member = null, $context = [])
    {
        return false;
    }

    /**
     * We should never edit log entries
     *
     * {@inheritDoc}
     */
    public function canEdit($member = null)
    {
        return false;
    }
    /**
     * {@inheritdoc}
     */
    public function canDelete($member = null)
    {
        return Permission::checkMember($member, array('DELETE_ENTRY', 'CMS_ACCESS_LogViewerAdmin'));
    }

    /**
     * {@inheritdoc}
     */
    public function canView($member = null)
    {
        return Permission::checkMember($member, array('VIEW_ENTRY', 'CMS_ACCESS_LogViewerAdmin'));
    }

}