Sunnysideup\VersionPruner\PruningTemplates\BasedOnTimeScale

Complexity

Total Complexity

8

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	buildTimeScalePatternAndOnesToKeep()	0	29	3
A	setOtherFilters()	0	5	1
A	setTimeScale()	0	5	1
A	getTitle()	0	3	1
A	run()	0	15	1
A	getDescription()	0	3	1

<?php

namespace Sunnysideup\VersionPruner\PruningTemplates;

use Sunnysideup\VersionPruner\PruningTemplatesTemplate;

class BasedOnTimeScale extends PruningTemplatesTemplate
{
    protected $timeScale = [
        'Minutes' => [
            'Max' => 60,
            'Interval' => 15,
        ],
        'Hours' => [
            'Max' => 24,
            'Interval' => 3,
        ],
        'Days' => [
            'Min' => 1,
            'Max' => 7,
            'Interval' => 1,
        ],
        'Weeks' => [
            'Min' => 1,
            'Max' => 4,
            'Interval' => 1,
        ],
        'Months' => [
            'Min' => 1,
            'Max' => 12,
            'Interval' => 1,
        ],
        'Years' => [
            'Min' => 1,
            'Max' => 7,
            'Interval' => 1,
        ],
    ];

    protected $otherFilters = [];

    public function setOtherFilters(array $otherFilters): self
    {
        $this->otherFilters = $otherFilters;

        return $this;
    }

    public function setTimeScale(array $timeScale): self
    {
        $this->timeScale = $timeScale;

        return $this;
    }

    public function getTitle(): string
    {
        return 'Prune versions based on time ago';
    }

    public function getDescription(): string
    {
        return 'Ones close to now are kept at a more regular interval (e.g. one per hour) and olders ones at a less regular interval (e.g. one per month).';
    }

    public function run(?bool $verbose = false)
    {
        $toKeep = $this->buildTimeScalePatternAndOnesToKeep();
        $query = $this->getBaseQuery()
            ->addWhere(
                [
                    '"RecordID" = ?' => $this->object->ID,
                    '"Version" NOT IN (' . implode(',', ($toKeep + [-1 => 0])) . ')',
                ] +
                $this->otherFilters
            )
        ;
        $this->toDelete[$this->getUniqueKey()] += $this->addVersionNumberToArray(
            $this->toDelete[$this->getUniqueKey()],
            $query->execute()
        );
    }

    protected function buildTimeScalePatternAndOnesToKeep(): array
    {
        $keep = [];
        foreach ($this->timeScale as $name => $options) {
            $min = $options['Min'] ?? 0;
            $max = $options['Max'] ?? 7;
            $interval = (int) $options['Interval'] ?? 1;
            for ($i = $min; $i < $max; $i += $interval) {
                $untilTs = strtotime('-' . $i . ' ' . $name);
                $fromTs = strtotime('-' . ($i + $interval) . ' ' . $name);
                $where =
                    '(
                        "LastEdited" > TIMESTAMP(\'' . date('Y-m-d h:i:s', $fromTs) . '\') AND
                        "LastEdited" < TIMESTAMP(\'' . date('Y-m-d h:i:s', $untilTs) . '\') AND
                        "WasPublished" = 1
                    )';
                $query = $this->getBaseQuery()
                    ->addWhere($this->normaliseWhere([$where] + $this->otherFilters))
                    ->setLimit(1)
                ;

                $keep = $this->addVersionNumberToArray(
                    $keep,
                    $query->execute()
                );
            }
        }

        return $keep;
    }
}