PageRating - Code Metrics - sunnysideup/silverstripe-pagerater - Measure and Improve Code Quality continuously with Scrutinizer

PageRating B
last analyzed 2018-07-12 04:12 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	483
Duplicated Lines	3.31 %

Coupling/Cohesion

Components	2
Dependencies	11

Importance

Changes

Metric	Value
wmc	45
lcom	2
cbo	11
dl	16
loc	483
rs	8.8
c	0
b	0
f	0

27 Methods

Rating	Name	Duplication	Size	Complexity
A	get_stars()	0	4	1
A	get_star_entry_code()	8	8	2
A	get_star_entry_name()	8	8	2
A	get_star_dropdowndown()	0	11	3
A	get_number_of_stars()	0	4	1
A	get_star_details_as_array_data()	0	32	3
B	getCMSFields()	0	69	8
A	update_ratings()	0	28	2
A	onBeforeWrite()	0	7	2
A	requireDefaultRecords()	0	9	1
A	canCreate()	0	7	2
A	canDelete()	0	7	2
A	canEdit()	0	7	2
A	Method()	0	4	1
A	getMethod()	0	5	1
A	Stars()	0	4	1
A	getStars()	0	5	1
A	Percentage()	0	4	1
A	getPercentage()	0	5	1
A	RoundedPercentage()	0	4	1
A	getRoundedPercentage()	0	5	1
A	ReversePercentage()	0	4	1
A	getReversePercentage()	0	5	1
A	ReverseRoundedPercentage()	0	4	1
A	getReverseRoundedPercentage()	0	5	1
A	StarClass()	0	4	1
A	getStarClass()	0	5	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like PageRating often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use PageRating, and based on these observations, apply Extract Interface, too.

<?php

/**
 *@author nicolaas [at] sunnysideup . co . nz
 *
 **/

class PageRating extends DataObject
namespace YourVendor;

class YourClass { }
{

    /**
     * @var bool
     */
    private static $admin_can_create = true;


    /**
     * @var bool
     */
    private static $admin_can_edit = true;


    /**
     * @var bool
     */
    private static $admin_can_delete = true;


    /**
     * @var boolean
     */
    private static $round_rating = true;


    /**
     * @var array
     */
    private static $stars = array(

        '1' => array("Code" => 'OneStar', "Title" => "One Star"),
        '2' => array("Code" => 'TwoStar', "Title" => "Two Stars"),
        '3' => array("Code" => 'ThreeStar', "Title" => "Three Stars"),
        '4' => array("Code" => 'FourStar', "Title" => "Four Stars"),
        '5' => array("Code" => 'FiveStar', "Title" => "Five Stars")
    );

    /**
     *
     * @return array

     */
    protected static function get_stars()
    {
        return Config::inst()->get("PageRating", "stars");
    }

    /**
     * returns something like OneStar
     * @param int $value
     *
     * @return string
     */
    public static function get_star_entry_code($value)

    {
        $stars = self::get_stars();
        if (isset($stars[$value]["Code"])) {
            return $stars[$value]["Code"];
        }
        return "N/A";
    }

    /**
     * returns something like One Star
     * @param int $value
     *
     * @return string
     */
    public static function get_star_entry_name($value)

    {
        $stars = self::get_stars();
        if (isset($stars[$value]["Title"])) {
            return $stars[$value]["Title"];
        }
        return "N/A";
    }

    /**
     * returns something like
     *
     *     1 => One Star,
     *     2 => Two Star
     *
     * @return array
     */
    public static function get_star_dropdowndown()
    {
        $stars = self::get_stars();
        $newArray = array();
        if (count($stars)) {
            foreach ($stars as $key => $star) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                $newArray[$key] = $star["Title"];
            }
        }
        return $newArray;
    }

    /**
     * return int
     */
    public static function get_number_of_stars()
    {
        return count(self::get_stars());
    }

    private static $_star_details_as_array_data = array();

    /**
     *
     *
     * @return ArrayData
     */
    public static function get_star_details_as_array_data($score, $parentID, $method = "unkown")
    {
        $key = $score."_".$parentID."_".$method;
        if (! isset(self::$_star_details_as_array_data[$key])) {
            $stars = $score;
            if (Config::inst()->get("PageRating", "round_rating")) {
                $stars = round($stars);
            }
            $widthOutOfOneHundredForEachStar = 100 / PageRating::get_number_of_stars();
            $percentage = round($score * $widthOutOfOneHundredForEachStar);
            $roundedPercentage = round($stars * $widthOutOfOneHundredForEachStar);
            $reversePercentage = round(100 - $percentage);
            $reverseRoundedPercentage = round(100 - $roundedPercentage);
            $starClass = PageRating::get_star_entry_code($stars);
            $page = SiteTree::get()->byId($parentID);
            self::$_star_details_as_array_data[$key] = ArrayData::create(
                array(
                    'Rating' => "Stars",
                    'Method' => $method,
                    'Score' => $score,
                    'Stars' => $stars,
                    'Percentage' => $percentage,
                    'RoundedPercentage' => $percentage,
                    'ReversePercentage' => $reversePercentage,
                    'ReverseRoundedPercentage' => $reverseRoundedPercentage,
                    'StarClass' => $starClass,
                    'Page' => $page
                )
            );
        }
        return self::$_star_details_as_array_data[$key];
    }

    private static $db = array(

        "Rating" => "Int",
        "Name" => "Varchar(100)",
        "Title" => "Varchar(100)",
        "Comment" => "Text",
        "IsApproved" => "Boolean",
        "IsDefault" => "Boolean"
    );

    private static $has_one = array(

        "Parent" => "Page"
    );

    private static $summary_fields = array(

        "Created" => "When",
        "Rating" => "Score",
        "Parent.Title" => "Page",
        "Comment" => "Comment",
        "IsApproved.Nice" => "Approved"
    );

    private static $field_labels = array(

        "Rating" => "Score",
        "Parent.Title" => "Page",
        "IsDefault" => "Default Entry Only",
        "Parent" => "Rating for",
        "IsApproved" => "Approved"
    );

    private static $casting = array(

        'Method' => "Varchar",
        'Stars' => "Float",
        'Percentage' => "Float",
        'RoundedPercentage' => "Int",
        'ReversePercentage' => "Float",
        'ReverseRoundedPercentage' => "Int",
        'StarClass' => "Varchar"
    );

    private static $default_sort = "Created DESC";


    private static $singular_name = 'Page Rating';


    private static $plural_name = 'Page Ratings';



    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $labels = $this->FieldLabels();
        $fields->replaceField("Rating", OptionSetField::create("Rating", $labels["Rating"], self::get_star_dropdowndown()));
        //$fields->removeFieldFromTab("Root.Main", "Comment");


        if ($this->ParentID && $this->Parent() && $this->Parent()->exists()) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $fields->addFieldToTab("Root.Main", $readonlyField = ReadonlyField::create("ParentDescription", $labels["Parent"], "<p><a href=\"".$this->Parent()->CMSEditLink()."\">".$this->Parent()->Title."</a></p>"));

            $readonlyField->dontEscape = true;
            $fields->removeFieldFromTab("Root.Main", "ParentID");
        } else {
            $fields->replaceField(
                "ParentID",
                TreeDropdownField::create(
                    'ParentID',
                    'Parent',
                    'SiteTree'
                )
            );
        }
        if (Config::inst()->get("PageRaterStarField", "allow_name")) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
            //do nothing
        } else {
            $fields->removeFieldFromTab("Root.Main", "Name");
        }
        if (Config::inst()->get("PageRaterStarField", "allow_title")) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
            //do nothing
        } else {
            $fields->removeFieldFromTab("Root.Main", "Title");
        }
        if (Config::inst()->get("PageRaterStarField", "allow_comments")) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
            //do nothing
        } else {
            $fields->removeFieldFromTab("Root.Main", "Comment");
        }
        if (class_exists('DataObjectOneFieldUpdateController')) {
            $linkForApproval = DataObjectOneFieldUpdateController::popup_link(
                'PageRating',
                'IsApproved',
                "IsApproved = 0",
                '',
                'Mass Approve'
            );
            $linkForDisapproval = DataObjectOneFieldUpdateController::popup_link(
                'PageRating',
                'IsApproved',
                "IsApproved = 1",
                '',
                'Mass Disapprove'
            );
            $fields->addFieldToTab(
                'Root.Batch',
                new LiteralField(
                    'QuickActions',
                    '<p class="message good">'
                        ._t('ProductVariation.QUICK_UPDATE', 'Quick update')
                        .': '
                        ."<span class=\"action ss-ui-button\">$linkForApproval</span> "
                        ."<span class=\"action ss-ui-button\">$linkForDisapproval</span>"
                        .'</p>'
                ),
                'IsDefault'
            );
        }

        $fields->makeFieldReadonly("IsDefault");
        return $fields;
    }

    /**
     * updates Page Rating for a Page and saves it with the Page.
     * Updates SiteTree.PageRating field ...
     *
     * if $siteTreeID is 0 then ALL pages are updated ...
     *
     * @param  integer $siteTreeID
     */
    public static function update_ratings($siteTreeID = 0)
    {
        if ($siteTreeID) {
            $where = "PageRating.ParentID = ".$siteTreeID;
        } else {
            $where = "PageRating.ParentID > 0";
        }
        DB::query("DELETE FROM PageRating_TEMP;");
        DB::query(
            "
            INSERT INTO PageRating_TEMP
            SELECT ParentID, (ROUND(AVG(PageRating.Rating) * 100))
            FROM PageRating
            WHERE $where
            GROUP BY PageRating.ParentID;
            "
        );
        DB::query("
            UPDATE SiteTree
                INNER JOIN PageRating_TEMP ON SiteTree.ID = PageRating_TEMP.ParentID
            SET SiteTree.PageRating = (PageRating_TEMP.Rating / 100);
        ");
        DB::query("
            UPDATE SiteTree_Live
                INNER JOIN PageRating_TEMP ON SiteTree_Live.ID = PageRating_TEMP.ParentID
            SET SiteTree_Live.PageRating = (PageRating_TEMP.Rating / 100);
        ");
    }

    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        if ($this->ParentID) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            self::update_ratings($this->ParentID);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
    }

    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        DB::query("DROP TABLE IF EXISTS PageRating_TEMP;");
        DB::query("CREATE TABLE PageRating_TEMP (ParentID INTEGER(11), Rating INTEGER);");
        DB::query("ALTER TABLE \"PageRating_TEMP\" ADD INDEX ( \"ParentID\" ) ");
        DB::query("ALTER TABLE \"PageRating_TEMP\" ADD INDEX ( \"Rating\" ) ");
        DB::alteration_message("create PageRating_TEMP", "created");
    }

    public function canCreate($member = null)
    {
        if ($this->Config()->get("admin_can_create")) {
            return parent::canCreate($member);
        }
        return false;
    }

    public function canDelete($member = null)
    {
        if ($this->Config()->get("admin_can_delete")) {
            return parent::canDelete($member);
        }
        return false;
    }

    public function canEdit($member = null)
    {
        if ($this->Config()->get("admin_can_edit")) {
            return parent::canEdit($member);
        }
        return false;
    }

    /**
     * @alias
     *
     * @return string
     */
    public function Method()
    {
        return $this->getMethod();
    }

    /**
     * casted variable
     *
     * @return string
     */
    public function getMethod()
    {
        $arrayData = self::get_star_details_as_array_data($this->Rating, $this->ParentID);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        return $arrayData->Method;

    }

    /**
     * @alias
     *
     * @return int | float
     */
    public function Stars()
    {
        return $this->getStars();
    }

    /**
     * casted variable
     *
     * @return int | float
     */
    public function getStars()
    {
        $arrayData = self::get_star_details_as_array_data($this->Rating, $this->ParentID);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        return $arrayData->Stars;
    }

    /**
     * @alias
     *
     * @return string

     */
    public function Percentage()
    {
        return $this->getPercentage();
    }

    /**
     * casted variable
     *
     * @return float
     */
    public function getPercentage()
    {
        $arrayData = self::get_star_details_as_array_data($this->Rating, $this->ParentID);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        return $arrayData->Percentage;
    }

    /**
     * @alias
     *
     * @return int
     */
    public function RoundedPercentage()
    {
        return $this->getRoundedPercentage();
    }

    /**
     * casted variable
     *
     * @return int
     */
    public function getRoundedPercentage()
    {
        $arrayData = self::get_star_details_as_array_data($this->Rating, $this->ParentID);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        return $arrayData->RoundedPercentage;
    }

    /**
     * casted alias
     *
     * @return string

     */
    public function ReversePercentage()
    {
        return $this->getReversePercentage();
    }

    /**
     * casted variable
     *
     * @return float
     */
    public function getReversePercentage()
    {
        $arrayData = self::get_star_details_as_array_data($this->Rating, $this->ParentID);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        return $arrayDat->ReversePercentage;

    }

    /**
     * @alias
     *
     * @return int
     */
    public function ReverseRoundedPercentage()
    {
        return $this->getReverseRoundedPercentage();
    }

    /**
     * casted variable
     *
     * @return int
     */
    public function getReverseRoundedPercentage()
    {
        $arrayData = self::get_star_details_as_array_data($this->Rating, $this->ParentID);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        return $arrayData->ReverseRoundedPercentage;
    }

    /**
     * @alias
     *
     * @return string
     */
    public function StarClass()
    {
        return $this->getStarClass();
    }

    /**
     * casted variable
     *
     * @return string
     */
    public function getStarClass()
    {
        $arrayData = self::get_star_details_as_array_data($this->Rating, $this->ParentID);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        return $arrayData->StarClass;
    }
}


1			<?php
2
3			/**
4			*@author nicolaas [at] sunnysideup . co . nz
5			*
6			**/
7
8			class PageRating extends DataObject
			0 ignored issues – show Coding Style Compatibility introduced 2017-01-03 01:24 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
9			{
10
11			/**
12			* @var bool
13			*/
14			private static $admin_can_create = true;
			0 ignored issues – show Unused Code introduced 2017-01-03 01:24 UTC by Report Bug Copy Issue Report The property `$admin_can_create` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
15
16			/**
17			* @var bool
18			*/
19			private static $admin_can_edit = true;
			0 ignored issues – show Unused Code introduced 2017-01-03 01:24 UTC by Report Bug Copy Issue Report The property `$admin_can_edit` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
20
21			/**
22			* @var bool
23			*/
24			private static $admin_can_delete = true;
			0 ignored issues – show Unused Code introduced 2017-01-03 01:24 UTC by Report Bug Copy Issue Report The property `$admin_can_delete` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
25
26			/**
27			* @var boolean
28			*/
29			private static $round_rating = true;
			0 ignored issues – show Unused Code introduced 2017-01-03 01:24 UTC by Report Bug Copy Issue Report The property `$round_rating` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
30
31			/**
32			* @var array
33			*/
34			private static $stars = array(
			0 ignored issues – show Unused Code introduced 2017-01-03 01:24 UTC by Report Bug Copy Issue Report The property `$stars` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...

sunnysideup / silverstripe-pagerater

PageRating B last analyzed 2018-07-12 04:12 UTC