Backpack\CRUD\PanelTraits\ViewsAndRestoresRevisions

Complexity

Total Complexity

4

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	listRevisions()	0	23	3
A	restoreRevision()	0	11	1

<?php

namespace Backpack\CRUD\PanelTraits;

use Venturecraft\Revisionable\Revision;

trait ViewsAndRestoresRevisions
{
    /**
     * Build a list of Revisions, grouped by revision date
     * 
     * @return [Array] of revision groups, keyed by revision date

The doc-type [Array] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public function listRevisions($id)
    {
        $revisions = [];
        // Group revisions by change date
        foreach($this->getEntry($id)->revisionHistory as $history) {

It seems like getEntry() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            // Get just the date from the revision created timestamp
            $revisionDate = date('Y-m-d', strtotime((string)$history->created_at));

            // Be sure to instantiate the initial grouping array
            if(!array_key_exists($revisionDate, $revisions)) {
                $revisions[$revisionDate] = [];
            }

            // Push onto the top of the current group - so we get orderBy decending timestamp
            array_unshift($revisions[$revisionDate], $history);
        }

        // Sort the array by timestamp descending (so that the most recent are at the top)
        arsort($revisions);

        return $revisions;
    }

    /**
     * Restore a single revision
     * 
     * @param  [int] $id         The ID of the source CRUD Model instance to update

The doc-type [int] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     * @param  [int] $revisionId The ID of the revision to use for the update

The doc-type [int] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public function restoreRevision($id, $revisionId) {
        $entry = $this->getEntry($id);

It seems like getEntry() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $revision = Revision::findOrFail($revisionId);

        // Update the revisioned field with the old value
        $entry->{$revision->fieldName()} = $revision->oldValue();
        $entry->save();

        // Reload the entry so we have the latest revisions
        $entry = $this->getEntry($id);

It seems like getEntry() must be provided by classes using this trait. How about adding it as abstract method to this trait?

$entry is not used, you could remove the assignment.

    }
}