PageRaterExtension_Controller::getStarRating() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/sunnys..." - sunnysideup/silverstripe-pagerater - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 32e745...4b8a40 )

by Nicolaas

created 2018-07-10 06:11 UTC

PageRaterExtension_Controller::getStarRating() A

↳ Parent: PageRaterExtension_Controller

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.9
c	0
b	0
f	0
cc	3
nc	2
nop	0

<?php



class PageRaterExtension_Controller extends Extension
namespace YourVendor;

class YourClass { }
{


    /**
     * add the default rating to each page ...
     * @var boolean
     */
    private static $items_per_page = 8;


    /**
     * @var string
     */
    private static $field_title = "Click on any star to rate:";


    /**
     * @var string
     */
    private static $field_right_title = "On a scale from 1 to 5, with 5 being the best";


    /**
     * @var boolean
     */
    private static $show_average_rating_in_rating_field = false;


    /**
     * @var boolean
     */
    private static $only_show_approved = false;


    private static $allowed_actions = array(

        "PageRatingForm",
        "rateagain",
        "dopagerating",
        "removedefaultpageratings",
        "removeallpageratings"
    );

    /**
     * action to allow use to rate again...
     */
    public function rateagain($request)

    {
        $id = intval(Session::get('PageRated'.$this->owner->dataRecord->ID))-0;

        $pageRating = PageRating::get()->byID($id);
        if ($pageRating) {
            $pageRating->delete();
        }
        Session::set('PageRated'.$this->owner->dataRecord->ID, false);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        Session::clear('PageRated'.$this->owner->dataRecord->ID);
        return $this->owner->redirect($this->owner->Link());
    }

    /**
     * @return Form
     */
    public function PageRatingForm()
    {
        Requirements::themedCSS('PageRater', "pagerater");
        if ($this->owner->PageHasBeenRatedByUser()) {
            $ratingField = LiteralField::create("RatingFor".$this->owner->dataRecord->ID, $this->owner->renderWith("PageRaterAjaxReturn"));

            $actions = FieldList::create();
            $requiredFields = null;
        } else {
            if (Config::inst()->get("PageRaterExtension_Controller", "show_average_rating_in_rating_field")) {
                $defaultStart = $this->owner->getStarRating();
            } else {
                $defaultStart = 0;
            }
            $ratingField = PageRaterStarField::create(
                'RatingFor'.$this->owner->dataRecord->ID,
                Config::inst()->get("PageRaterExtension_Controller", "field_title"),
                $defaultStart,
                PageRating::get_number_of_stars()
            );
            $ratingField->setRightTitle(Config::inst()->get("PageRaterExtension_Controller", "field_right_title"));
            $requiredFields = RequiredFields::create($ratingField->getRequiredFields());
            $actions = FieldList::create(FormAction::create('dopagerating', 'Submit'));
        }
        $fields = FieldList::create(
            $ratingField,
            HiddenField::create('ParentID', "ParentID", $this->owner->dataRecord->ID)
        );

        return Form::create($this->owner, 'PageRatingForm', $fields, $actions, $requiredFields);
    }

    /**
     * action Page Rating Form
     */
    public function dopagerating($data, $form)

    {
        $id = $this->owner->dataRecord->ID;

        $fieldName = "RatingFor".$id;
        $data = Convert::raw2sql($data);
        $pageRating = PageRating::create();
        $form->saveInto($pageRating);
        $pageRating->ParentID = $this->owner->dataRecord->ID;
<?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.");
        }
    }

}
        if (isset($data[$fieldName])) {
            $pageRating->Rating = floatval($data[$fieldName]);

        }
        if (isset($data[$fieldName."_Comment"])) {
            $pageRating->Comment = Convert::raw2sql($data[$fieldName."_Comment"]);
<?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.");
        }
    }

}
        }
        if (isset($data[$fieldName."_Name"])) {
            $pageRating->Name = Convert::raw2sql($data[$fieldName."_Name"]);
<?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.");
        }
    }

}
        }
        if (isset($data[$fieldName."_Title"])) {
            $pageRating->Title = Convert::raw2sql($data[$fieldName."_Title"]);
<?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.");
        }
    }

}
        }
        $pageRating->write();
        Session::set('PageRated'.$this->owner->dataRecord->ID, $pageRating->ID);
        if (Director::is_ajax()) {
            return $this->owner->renderWith("PageRaterAjaxReturn");
        } else {
            $this->owner->redirectBack();
        }
    }


    public function removedefaultpageratings()
    {
        if (Permission::check("ADMIN")) {
            DB::query("DELETE FROM PageRating WHERE IsDefault = 1;");
            debug::show("removed all default ratings for all pages");
        } else {
            Security::permissionFailure($this->owner, _t('Security.PERMFAILURE', ' This page is secured and you need administrator rights to access it. Enter your credentials below and we will send you right along.'));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
    }

    public function removeallpageratings()
    {
        if (Permission::check("ADMIN")) {
            DB::query("DELETE FROM PageRating;");
            debug::show("removed all ratings for all pages");
        } else {
            Security::permissionFailure($this->owner, _t('Security.PERMFAILURE', ' This page is secured and you need administrator rights to access it. Enter your credentials below and we will send you right along.'));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
    }





    /**
     * rating for this page ...
     * @return ArrayList
     */
    public function PageRatingResults()

    {
        $sqlQuery = new SQLQuery();

        $sqlQuery->setSelect("AVG(\"PageRating\".\"Rating\") RatingAverage, ParentID");
        $sqlQuery->setFrom("\"PageRating\" ");
        if ($this->onlyShowApprovedPageRatings()) {
            $sqlQuery->setWhere("\"ParentID\" = ".$this->owner->ID." AND \"PageRating\".\"IsApproved\" = 1");

        } else {
            $sqlQuery->setWhere("\"ParentID\" = ".$this->owner->ID."");
        }
        $sqlQuery->setOrderBy("RatingAverage DESC");
        $sqlQuery->setGroupby("\"ParentID\"");
        $sqlQuery->setLimit(1);
        return $this->turnPageRaterSQLIntoArrayList($sqlQuery, "PageRatingResults");
    }

    /**
     * rating of this page by this user ...
     * @return ArrayList
     */
    public function CurrentUserRating()

    {
        $sqlQuery = new SQLQuery();

        $sqlQuery->setSelect("AVG(\"PageRating\".\"Rating\") RatingAverage, ParentID");
        $sqlQuery->setFrom("\"PageRating\" ");
        if ($this->onlyShowApprovedPageRatings()) {
            $sqlQuery->setWhere("\"ParentID\" = ".$this->owner->ID." AND \"PageRating\".\"ID\" = '".Session::get('PageRated'.$this->owner->ID)."' AND \"PageRating\".\"IsApproved\" = 1");

        } else {
            $sqlQuery->setWhere("\"ParentID\" = ".$this->owner->ID." AND \"PageRating\".\"ID\" = '".Session::get('PageRated'.$this->owner->ID)."'");
        }

        $sqlQuery->setOrderBy("RatingAverage DESC");
        $sqlQuery->setGroupby("\"ParentID\"");
        $sqlQuery->setLimit(1);
        return $this->turnPageRaterSQLIntoArrayList($sqlQuery, "CurrentUserRating");
    }

    /**
     * list of all rated pages ...
     * @return ArrayList
     */
    public function PageRaterListOfAllForPage($paginated = false)
    {
        if ($this->owner->onlyShowApprovedPageRatings()) {
            $list = $this->owner->turnPageRaterSQLIntoArrayList(
                $this->owner->PageRatings()->filter(array("IsApproved" => 1)),
                "PageRaterListOfAllForPage"
            );
        } else {
            $list = $this->owner->turnPageRaterSQLIntoArrayList(
                $this->owner->PageRatings(),
                "PageRaterListOfAllForPage"
            );
        }
        if ($paginated) {
            $limit = Config::inst()->get('PageRaterExtension_Controller', 'items_per_page');
            if ($limit) {
                $list = PaginatedList::create($list, $this->owner->getRequest());
                $list->setPageLength($limit);
            }
        }
        return $list;
    }


    public function PageRaterListAll()
    {
        $sqlQuery = new SQLQuery();

        $sqlQuery->setSelect("\"PageRating\".\"Rating\" AS RatingAverage, \"PageRating\".\"ParentID\"");
        if ($this->owner->onlyShowApprovedPageRatings()) {
            $sqlQuery->setWhere("\"PageRating\".\"IsApproved\" = 1");
        }
        $sqlQuery->setFrom(" \"PageRating\"");
        $sqlQuery->addInnerJoin("SiteTree", " \"PageRating\".\"ParentID\" = \"SiteTree\".\"ID\"");
        $sqlQuery->setOrderBy("RatingAverage DESC");
        $sqlQuery->setGroupby("\"SiteTree\".\"ParentID\"");
        return $this->turnPageRaterSQLIntoArrayList($sqlQuery, "PageRaterList");
    }

    /**
     * @param $data $sqlQuery | DataList
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string $method
     *
     * @return ArrayList
     */
    protected function turnPageRaterSQLIntoArrayList($data, $method = "unknown")

    {
        if ($data instanceof SQLQuery) {
            $data = $data->execute();
        }
        $al = new ArrayList();
        if ($data) {
            foreach ($data as $record) {
                if ($record instanceof PageRating) {
                    $record->Method = $method;

                    //do nothing
                } else {
                    $score = $record["RatingAverage"];
                    $parentID = $record["ParentID"];
                    $record = PageRating::get_star_details_as_array_data($score, $parentID, $method);
                }
                $al->push($record);
            }
        }
        return $al;
    }

    /**
     * @return boolean
     */
    public function PageHasBeenRatedByUser()
    {
        return Session::get('PageRated'.$this->owner->ID) ? true : false;

    }

    /**
     *
     * @return int
     */
    public function NumberOfPageRatings()

    {
        $doSet = new ArrayList();
$myVar = 'Value';
$higher = false;

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

        $sqlQuery->setSelect("COUNT(\"PageRating\".\"Rating\") RatingCount");
        $sqlQuery->setFrom("\"PageRating\" ");
        if ($this->onlyShowApprovedPageRatings()) {
            $sqlQuery->setWhere("\"ParentID\" = ".$this->owner->ID." AND \"PageRating\".\"IsApproved\" = 1");

        } else {
            $sqlQuery->setWhere("\"ParentID\" = ".$this->owner->ID."");
        }
        $sqlQuery->setOrderBy("RatingCount ASC");
        $sqlQuery->setGroupBy("\"ParentID\"");
        $sqlQuery->setLimit(1);
        $data = $sqlQuery->execute();
        if ($data) {
            foreach ($data as $record) {
                return $record["RatingCount"];
            }
        }
        return 0;
    }

    protected function onlyShowApprovedPageRatings()
    {
        return Config::inst()->get("PageRaterExtension_Controller", "only_show_approved");
    }


    /**
     * return the average rating...
     * @return Double
     */
    public function getStarRating()
    {
        $ratings = $this->owner->PageRatingResults();
        $rating = 0;
        if ($ratings->Count() == 1) {
            foreach ($ratings as $ratingItem) {
                $rating = $ratingItem->Stars;
            }
        }
        return $rating;
    }
}


1			<?php
2
3
4
5			class PageRaterExtension_Controller extends Extension
			0 ignored issues – show Coding Style Compatibility introduced 2018-07-05 23:45 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...
6			{
7
8
9			/**
10			* add the default rating to each page ...
11			* @var boolean
12			*/
13			private static $items_per_page = 8;
			0 ignored issues – show Unused Code introduced 2018-07-05 23:45 UTC by Report Bug Copy Issue Report The property `$items_per_page` 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...
14
15			/**
16			* @var string
17			*/
18			private static $field_title = "Click on any star to rate:";
			0 ignored issues – show Unused Code introduced 2018-07-05 23:45 UTC by Report Bug Copy Issue Report The property `$field_title` 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...
19
20			/**
21			* @var string
22			*/
23			private static $field_right_title = "On a scale from 1 to 5, with 5 being the best";
			0 ignored issues – show Unused Code introduced 2018-07-05 23:45 UTC by Report Bug Copy Issue Report The property `$field_right_title` 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...
24
25			/**
26			* @var boolean
27			*/
28			private static $show_average_rating_in_rating_field = false;
			0 ignored issues – show Unused Code introduced 2018-07-05 23:45 UTC by Report Bug Copy Issue Report The property `$show_average_rating_in_rating_field` 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...
29
30			/**
31			* @var boolean
32			*/
33			private static $only_show_approved = false;
			0 ignored issues – show Unused Code introduced 2018-07-05 23:45 UTC by Report Bug Copy Issue Report The property `$only_show_approved` 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...
34

sunnysideup / silverstripe-pagerater

Push — master ( 32e745...4b8a40 )

PageRaterExtension_Controller::getStarRating() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like