SilverLeague\LogViewer\Model\LogEntry

Complexity

Total Complexity

6

Size/Duplication

Total Lines	120
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	5

Importance

Changes	2
Bugs	1	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	providePermissions()	0	15	1
A	getCMSFields()	0	17	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 SilverStripe\Core\Convert;
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>
 */
class LogEntry extends DataObject implements PermissionProvider
{
    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.

    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'
    ];

    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.

        'Entry',
        'Created',
        'Level'
    ];

    /**
     * Whether the cron functionality should run. This does not affect use as a BuildTask.
     * Note: you need to configure silverstripe/crontask yourself.
     *
     * @config
     * @var bool
     */
    private static $cron_enabled = true;

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

    /**
     * How often the cron should run (default: 4am daily)
     *
     * @config
     * @var string
     */
    private static $cron_schedule = '0 4 * * *';

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

    /**
     * The maximum age in days for a LogEntry before it will be removed
     *
     * @config
     * @var int
     */
    private static $max_log_age = 30;

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

    /**
     * Which Monolog\Logger levels (numeric) to start handling from (see class for examples)
     *
     * @config
     * @var integer
     */
    private static $minimum_log_level = 300;

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

    /**
     * Permissions
     */
    public function providePermissions()
    {
        return [
            'DELETE_ENTRY' => [
                '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' => [
                '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.')
            ]
        ];
    }

    /**
     * Format the log entry as JSON
     *
     * {@inheritDoc}
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $data = Convert::json2obj($this->getField('Entry'));
        $fields->addFieldToTab(
            'Root.Main',
            LiteralField::create(
                'Entry',
                '<pre class="logviewer-logentry-entry"><code>'
                . Convert::raw2json($data, JSON_PRETTY_PRINT)
                . '</code></pre>'
            )
        );

        return $fields;
    }

    /**
     * Log entries are created programmatically, they should never be created manually
     *
     * {@inheritDoc}
     */
    public function canCreate($member = null, $context = [])
    {
        return false;
    }

    /**
     * We should never edit log entries
     *
     * {@inheritDoc}
     */
    public function canEdit($member = null)
    {
        return false;
    }

    public function canDelete($member = null)
    {
        return Permission::checkMember($member, ['DELETE_ENTRY', 'CMS_ACCESS_LogViewerAdmin']);
    }

    public function canView($member = null)
    {
        return Permission::checkMember($member, ['VIEW_ENTRY', 'CMS_ACCESS_LogViewerAdmin']);
    }
}