ViewsAndRestoresRevisions::restoreRevision() - Code Metrics - Inspection of "#100 - New feature: Revisions" - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#109)

unknown

created 2016-09-16 08:29 UTC

ViewsAndRestoresRevisions::restoreRevision() A

↳ Parent: ViewsAndRestoresRevisions

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	6
c	1
b	0
f	0
nc	1
nop	2
dl	0
loc	11
rs	9.4285

<?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

     */
    public function listRevisions($id)
    {
        $revisions = [];
        // Group revisions by change date
        foreach($this->getEntry($id)->revisionHistory as $history) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

            // 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

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

     */
    public function restoreRevision($id, $revisionId) {
        $entry = $this->getEntry($id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $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);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }
}


1			<?php
2
3			namespace Backpack\CRUD\PanelTraits;
4
5			use Venturecraft\Revisionable\Revision;
6
7			trait ViewsAndRestoresRevisions
8			{
9			/**
10			* Build a list of Revisions, grouped by revision date
11			*
12			* @return [Array] of revision groups, keyed by revision date
			0 ignored issues – show Documentation introduced 2016-09-16 08:38 UTC by Report Bug Copy Issue Report The doc-type `[Array]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
13			*/
14			public function listRevisions($id)
15			{
16			$revisions = [];
17			// Group revisions by change date
18			foreach($this->getEntry($id)->revisionHistory as $history) {
			0 ignored issues – show Bug introduced 2016-09-16 08:38 UTC by Report Bug Copy Issue Report It seems like `getEntry()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
19
20			// Get just the date from the revision created timestamp
21			$revisionDate = date('Y-m-d', strtotime((string)$history->created_at));
22
23			// Be sure to instantiate the initial grouping array
24			if(!array_key_exists($revisionDate, $revisions)) {
25			$revisions[$revisionDate] = [];
26			}
27
28			// Push onto the top of the current group - so we get orderBy decending timestamp
29			array_unshift($revisions[$revisionDate], $history);
30			}
31
32			// Sort the array by timestamp descending (so that the most recent are at the top)
33			arsort($revisions);
34
35			return $revisions;
36			}
37
38			/**
39			* Restore a single revision
40			*
41			* @param [int] $id The ID of the source CRUD Model instance to update
			0 ignored issues – show Documentation introduced 2016-09-16 08:38 UTC by Report Bug Copy Issue Report The doc-type `[int]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
42			* @param [int] $revisionId The ID of the revision to use for the update
			0 ignored issues – show Documentation introduced 2016-09-16 08:38 UTC by Report Bug Copy Issue Report The doc-type `[int]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
43			*/
44			public function restoreRevision($id, $revisionId) {
45			$entry = $this->getEntry($id);
			0 ignored issues – show Bug introduced 2016-09-16 08:38 UTC by Report Bug Copy Issue Report It seems like `getEntry()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
46			$revision = Revision::findOrFail($revisionId);
47
48			// Update the revisioned field with the old value
49			$entry->{$revision->fieldName()} = $revision->oldValue();
50			$entry->save();
51
52			// Reload the entry so we have the latest revisions
53			$entry = $this->getEntry($id);
			0 ignored issues – show Bug introduced 2016-09-16 08:38 UTC by Report Bug Copy Issue Report It seems like `getEntry()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history... Unused Code introduced 2016-09-16 08:38 UTC by Report Bug Copy Issue Report `$entry` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
54			}
55			}
56

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Pull Request — master (#109)

ViewsAndRestoresRevisions::restoreRevision() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like