AssetAdminFile::humanizedChanges() - Code Metrics - Inspection of "#294 Add history tab to assets" - silverstripe/silverstripe-asset-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#306)

by Will

created 2016-11-15 20:43 UTC

AssetAdminFile::humanizedChanges() D

↳ Parent: AssetAdminFile

Complexity

Conditions	9
Paths	26

Size

Total Lines	43
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	43
rs	4.909
cc	9
eloc	27
nc	26
nop	2

<?php

namespace SilverStripe\AssetAdmin\Controller;

use SilverStripe\Control\Director;
use SilverStripe\ORM\DataExtension;
use SilverStripe\ORM\Versioning\Versioned;
use SilverStripe\ORM\Versioning\DataDifferencer;

/**
 * Update File dataobjects to be editable in this asset admin
 */
class AssetAdminFile extends DataExtension
{
    public function updateCMSEditLink(&$link)
    {
        // Update edit link for this file to point to the new asset admin
        $controller = AssetAdmin::singleton();
        $link = Director::absoluteURL($controller->getFileEditLink($this->owner));

    }

    /**
     * @param int $from
     * @param int $to
     *
     * @return string
     */
    public function humanizedChanges($from, $to) {
        $fromRecord = Versioned::get_version($this->owner->class, $this->owner->ID, $from);
        $toRecord = Versioned::get_version($this->owner->class, $this->owner->ID, $to);

        $diff = new DataDifferencer($fromRecord, $toRecord);
        $changes = $diff->changedFieldNames();

        $k = array_search('LastEdited', $changes);

        if($k !== false) {
            unset($changes[$k]);
        }

        $output = array();

        foreach($changes as $change) {
            $human = $change;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

            if($change == "ParentID") {
                // updated folder ID
                $human = _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdminFile.MOVEDFOLDER', "Moved file");
            } else if($change == 'Title') {
                $human = _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdminFile.RENAMEDTITLE', "Updated title to ") . $fromRecord->Title;
            } else if($change == 'Name') {
                $human = _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdminFile.RENAMEDFILE', "Renamed file to ") . $fromRecord->Filename;
            } else if($change == 'File') {
                // check to make sure the files are actually different
                if($fromRecord->getHash() != $toRecord->getHash()) {
                    $human = _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdminFile.RENAMEDFILE', "Replaced file");
                } else {
                    $human = false;
                }
            } else {
                $human = false;
            }

            if($human) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                $output[] = $human;
            }
        }

        return implode(", ", $output);
    }
}


1			<?php
2
3			namespace SilverStripe\AssetAdmin\Controller;
4
5			use SilverStripe\Control\Director;
6			use SilverStripe\ORM\DataExtension;
7			use SilverStripe\ORM\Versioning\Versioned;
8			use SilverStripe\ORM\Versioning\DataDifferencer;
9
10			/**
11			* Update File dataobjects to be editable in this asset admin
12			*/
13			class AssetAdminFile extends DataExtension
14			{
15			public function updateCMSEditLink(&$link)
16			{
17			// Update edit link for this file to point to the new asset admin
18			$controller = AssetAdmin::singleton();
19			$link = Director::absoluteURL($controller->getFileEditLink($this->owner));
			0 ignored issues – show Compatibility introduced 2016-10-07 04:35 UTC by Report Bug Copy Issue Report `$this->owner` of type `object<SilverStripe\ORM\DataObject>` is not a sub-type of `object<SilverStripe\Assets\File>`. It seems like you assume a child class of the class `SilverStripe\ORM\DataObject` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
20			}
21
22			/**
23			* @param int $from
24			* @param int $to
25			*
26			* @return string
27			*/
28			public function humanizedChanges($from, $to) {
29			$fromRecord = Versioned::get_version($this->owner->class, $this->owner->ID, $from);
30			$toRecord = Versioned::get_version($this->owner->class, $this->owner->ID, $to);
31
32			$diff = new DataDifferencer($fromRecord, $toRecord);
33			$changes = $diff->changedFieldNames();
34
35			$k = array_search('LastEdited', $changes);
36
37			if($k !== false) {
38			unset($changes[$k]);
39			}
40
41			$output = array();
42
43			foreach($changes as $change) {
44			$human = $change;
			0 ignored issues – show Unused Code introduced 2016-11-15 20:45 UTC by Report Bug Copy Issue Report `$human` 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...
45
46			if($change == "ParentID") {
47			// updated folder ID
48			$human = _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdminFile.MOVEDFOLDER', "Moved file");
49			} else if($change == 'Title') {
50			$human = _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdminFile.RENAMEDTITLE', "Updated title to ") . $fromRecord->Title;
51			} else if($change == 'Name') {
52			$human = _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdminFile.RENAMEDFILE', "Renamed file to ") . $fromRecord->Filename;
53			} else if($change == 'File') {
54			// check to make sure the files are actually different
55			if($fromRecord->getHash() != $toRecord->getHash()) {
56			$human = _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdminFile.RENAMEDFILE', "Replaced file");
57			} else {
58			$human = false;
59			}
60			} else {
61			$human = false;
62			}
63
64			if($human) {
			0 ignored issues – show Bug Best Practice introduced 2016-11-15 20:45 UTC by Report Bug Copy Issue Report The expression `$human` of type `string\|false` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
65			$output[] = $human;
66			}
67			}
68
69			return implode(", ", $output);
70			}
71			}
72

silverstripe / silverstripe-asset-admin

Pull Request — master (#306)

AssetAdminFile::humanizedChanges() D

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like