Sunnysideup\VersionPruner\Api\RunForOneObject

Complexity

Total Complexity

26

Size/Duplication

Total Lines	220
Duplicated Lines	0 %

Importance

Changes	7
Bugs	0	Features	0

<?php
class RunForOneObject
{
    use Configurable;
    use Injectable;

    /**
     * Versioned DataObject.
     *
     * @var DataObject
     */
    protected $object;

    /**
     * array of Version numbers to delete.
     *
     * @var string
     */
    protected $toDelete = [];

    /**
     * reversed list of templates (most specific first).
     *
     * @var array
     */
    protected $templatesAvailable = [];

    /**
     * list of tables to delete per class name.
     *
     * @var array
     */
    protected $tablesPerClassName = [];

    /**
     * list of templates per class name.
     *
     * @var array
     */
    protected $templatesPerClassName = [];

    /**
     *
     * @var bool
     */
    protected $verbose = false;

    /**
     *
     * @var bool
     */
    protected $dryRun = false;

    /**
     * schema is:
     * ```php
     *     ClassName => [
     *         PruningTemplateClassName1 => [
     *             "PropertyName1" => Value1
     *             "PropertyName2" => Value2
     *         ],
     *         PruningTemplateClassName2 => [
     *         ],
     *     ]
     * ```.
     * N.B. least specific first!
     *
     * @var array
     */
    private static $templates = [
        'default' => [
            BasedOnTimeScale::class => [],
        ],
        SiteTree::class => [
            Drafts::class => [],
            SiteTreeVersioningTemplate::class => [],
        ],
        File::class => [
            DeleteFiles::class => [],
            BasedOnTimeScale::class => [],
        ],
    ];

    public function __construct()
    {
        $this->templatesAvailable = array_reverse(
            $this->Config()->get('templates'),
            true //important - to preserve keys!
        );
    }

    public static function inst()
    {
        return Injector::inst()->get(static::class);
    }

    public function setVerbose(?bool $verbose = true) : self
    {
        $this->verbose = $verbose;
        return $this;
    }

    public function setDry(?bool $dryRun = true) : self
    {
        $this->dryRun = $dryRun;
        return $this;
    }

    /**
     * returns the total number deleted.
     *
     * @param DataObject $object
     * @param bool       $verbose
     */
    public function deleteSuperfluousVersions($object, ?bool $verbose = false): int
    {
        $this->object = $object;
        $this->verbose = $verbose;
        if (false === $this->hasStages()) {
            if ($this->verbose) {
                DB::alteration_message('... ... ... Error, no stages', 'deleted');
            }

            return 0;
        }

        if (false === $this->object->isLiveVersion()) {
            if ($this->verbose) {
                DB::alteration_message('... ... ... Error, not a live version', 'deleted');
            }

            return 0;
        }

        // array of version IDs to delete
        // IMPORTANT
        $this->toDelete[$this->getUniqueKey()] = [];

        // Base table has Versioned data
        $totalDeleted = 0;

        $myTemplates = $this->findBestSuitedTemplates();
        foreach ($myTemplates as $className => $options) {
            $runner = new $className($this->object, $this->toDelete[$this->getUniqueKey()]);
            if ($this->verbose) {
                DB::alteration_message('... ... ... Running ' . $runner->getTitle() . ': ' . $runner->getDescription());
            }

            foreach ($options as $key => $value) {
                $method = 'set' . $key;
                $runner->{$method}($value);
            }

            $runner->run();
            $this->toDelete[$this->getUniqueKey()] = $runner->getToDelete();

            if ($this->verbose) {
                DB::alteration_message('... ... ... total versions to delete now ' . count($this->toDelete[$this->getUniqueKey()]));
            }
        }

        if (! count($this->toDelete[$this->getUniqueKey()])) {
            return 0;
        }

        // Ugly (borrowed from DataObject::class), but returns all
        // database tables relating to DataObject
        $queriedTables = $this->getTablesForClassName();
        foreach ($queriedTables as $table) {
            if($this->dryRun === true) {
                $select = '
                    SELECT COUNT(ID) AS C FROM "' . $table . '_Versions"
                    WHERE
                        "Version" IN (' . implode(',', $this->toDelete[$this->getUniqueKey()]) . ')
                        AND "RecordID" = ' . (int) $this->object->ID;

                $value = DB::query($select)->value();
                if ($this->verbose) {
                    DB::alteration_message('... ... ... running ' . $value);
                }

                $totalDeleted += DB::affected_rows();
                if ($this->verbose) {
                    DB::alteration_message('... ... ... total deleted now ... ' . $totalDeleted);
                }
            }
            } else {

A parse error occurred: Syntax error, unexpected T_ELSE on line 204 at column 14

                $delSQL = '
                    DELETE FROM "' . $table . '_Versions"
                    WHERE
                        "Version" IN (' . implode(',', $this->toDelete[$this->getUniqueKey()]) . ')
                        AND "RecordID" = ' . (int) $this->object->ID;

                DB::query($delSQL);
                if ($this->verbose) {
                    DB::alteration_message('... ... ... running ' . $delSQL);
                }

                $totalDeleted += DB::affected_rows();
                if ($this->verbose) {
                    DB::alteration_message('... ... ... total deleted now ... ' . $totalDeleted);
                }
            }
        }

        return $totalDeleted;
    }

    /**
     * we use this to make sure we never mix up two records.
     */
    protected function getUniqueKey(): string
    {
        return $this->object->ClassName . '_' . $this->object->ID;
    }

    protected function hasStages(): bool
    {
        $oldMode = Versioned::get_reading_mode();
        if ('Stage.Stage' !== $oldMode) {
            Versioned::set_reading_mode('Stage.Stage');
        }