SilverLeague\LogViewer\Task\RemoveOldLogEntriesTask

Complexity

Total Complexity

8

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	run()	0	4	1
A	process()	0	7	2
A	getSchedule()	0	4	1
A	getMaxAge()	0	4	1
A	getCronEnabled()	0	4	1
A	removeOldLogs()	0	17	2

<?php

namespace SilverLeague\LogViewer\Task;

use SilverLeague\LogViewer\Model\LogEntry;
use SilverStripe\Dev\BuildTask;
use SilverStripe\Core\Config\Config;
use SilverStripe\CronTask\Interfaces\CronTask;

/**
 * Remove old LogEntry records from the database
 *
 * @package silverstripe-logviewer
 * @author  Robbie Averill <robbie@averill.co.nz>
 */
class RemoveOldLogEntriesTask extends BuildTask implements CronTask
{
    /**
     * {@inheritDoc}
     */
    private static $segment = 'RemoveOldLogEntriesTask';

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

    /**
     * {@inheritDoc}
     */
    protected $title = 'Remove LogEntry records older than a "n" days';

    /**
     * {@inheritDoc}
     */
    protected $description = 'Removes LogEntry records that are older than the configured '
        . '`LogViewer.max_log_age` setting. Will run as a cron task unless disabled via configuration.';

    /**
     * BuildTask implementation
     *
     * {@inheritDoc}
     *
     * @return bool Whether anything was removed
     */
    public function run($request)
    {
        return $this->removeOldLogs();
    }

    /**
     * CronTask implementation - can be disabled with YAML configuration
     *
     * {@inheritDoc}
     *
     * @return bool Whether anything was removed
     */
    public function process()
    {
        if (!$this->getCronEnabled()) {
            return false;
        }
        return $this->removeOldLogs();
    }

    /**
     * {@inheritDoc}
     */
    public function getSchedule()
    {
        return Config::inst()->get('LogViewer', 'cron_schedule');
    }

    /**
     * Get the maximum age allowed for a LogEntry from configuration
     *
     * @return int
     */
    public function getMaxAge()
    {
        return (int) Config::inst()->get('LogViewer', 'max_log_age');
    }

    /**
     * Return whether the cron functionality is enabled from configuration
     *
     * @return bool
     */
    public function getCronEnabled()
    {
        return (bool) Config::inst()->get('LogViewer', 'cron_enabled');
    }

    /**
     * Remove LogEntry records older than the LogViewer.max_log_age days
     *
     * @return bool Whether anything was deleted or not
     */
    protected function removeOldLogs()
    {
        $tableName = LogEntry::singleton()->baseTable();
        $maxAge = $this->getMaxAge();

        $logs = LogEntry::get()
            ->where(sprintf('"%s"."Created" <= NOW() - INTERVAL \'%d\' DAY', $tableName, $maxAge));

        $count = $logs->count();
        if ($count > 0) {
            $logs->removeAll();
        }

        echo sprintf('Finished. Removed %d logs older than %d days.', $count, $maxAge) . PHP_EOL;

        return $count > 0;
    }
}