Star_rating

Complexity

Total Complexity

25

Size/Duplication

Total Lines	207
Duplicated Lines	15.94 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	adminAutoload()	0	4	1
A	autoload()	0	3	1
B	show_star_rating()	0	57	9
C	ajax_rate()	0	62	9
B	_install()	33	34	2
A	_deinstall()	0	6	2

<?php

use CMSFactory\assetManager;

if (!defined('BASEPATH')) {
    exit('No direct script access allowed');
}

/**
 * Image CMS
 *
 * In oder to show "Star rating" type in template:
 * {$CI->load->module('star_rating')->show_star_rating()}
 *
 * If you want to show "Star rating" for product
 * {$CI->load->module('star_rating')->show_star_rating(SProducts $product)}
 *
 * More turn on autoload and url access.
 *
 * Star rating module
 *
 * @property Rating_model rating_model
 */
class Star_rating extends MY_Controller
{

Opening brace of a class must be on the same line as the definition

    private $new_votes = 0;

    private $new_rating = 0;

    private $list_for_show = ['main', 'category', 'brand', 'product', 'shop_category', 'page'];

    public function __construct() {

        parent::__construct();
        $this->load->helper('path');
        $this->load->model('rating_model');
        $obj = new MY_Lang();
        $obj->load('star_rating');
    }

    public static function adminAutoload() {

        parent::adminAutoload();
    }

    public function autoload() {

    }

    /**
     * Show star_rating
     * @param SProducts $item

Should the type for parameter $item not be SProducts|null?

     * @param bool $registerScript
     * @return $this|bool

Consider making the return type a bit more specific; maybe use false|Star_rating.

@return data type must not contain "$"

     */
    public function show_star_rating($item = null, $registerScript = true) {
        $this->list_for_show = $this->rating_model->get_settings();

It seems like $this->rating_model->get_settings() can also be of type null or string. However, the property $list_for_show is declared as type array. Maybe add an additional type check?

        if ($this->list_for_show == null) {
            $this->list_for_show = [];
        }
        $id = $this->core->core_data['id'];
        $type = $this->core->core_data['data_type'];

        // product rating
        if ($item != null && $item instanceof SProducts) {

The class SProducts does not exist. Did you forget a USE statement, or did you not list all dependencies?

            if ($item->getRating() != null) {
                $rating_s = (int) $item->getRating() * 20; // rating in percent
            } else {
                $rating_s = 0;
            }

            $data = [
                'id_type' => $item->getId(),
                'type' => 'product',
                'votes' => $item->getVotes(),
                'rating' => $rating_s
            ];
            $template = 'product_star_rating';
        } else {
            if (in_array($type, array_keys($this->list_for_show))) {
                $rating = $this->rating_model->get_rating($id, $type);
                if ($rating->votes != 0) {
                    $rating_s = $rating->rating / $rating->votes * 20; //rating in percent
                } else {
                    $rating_s = 0;
                }
                $data = [
                    'id' => $rating->id,
                    'type' => $rating->type,
                    'votes' => $rating->votes,
                    'rating' => $rating_s
                ];

                $template = 'star_rating';
            } else {
                $template = null;

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

                return false;
            }
        }

        //Show template with prepared parameters
        if ($template !== null) {
            $renderTemplate = assetManager::create();
        }
        $renderTemplate->setData($data)
            ->registerStyle('style');
        if ($registerScript) {
            $renderTemplate->registerScript('scripts');
        }
        $renderTemplate->render($template, true);
        return $this;
    }

    /**
     * Change rating for pages / product
     * @return string|null
     */
    public function ajax_rate() {

        $id = $this->input->post('cid');
        $type = $this->input->post('type');
        $rating = (int) $this->input->post('val');

        if ($id != null && $type != null && !$this->session->userdata('voted_g' . $id . $type) == true) {
            //Check if rating exists
            $check = $this->rating_model->get_rating($id, $type);
            if ($check != null) {
                $this->new_votes = $check->votes + 1;
                $this->new_rating = $check->rating + $rating;
                $data = [
                    'votes' => $this->new_votes,
                    'rating' => $this->new_rating
                ];
                $rating_res = $this->new_rating / $this->new_votes * 20;
                $votes_res = $this->new_votes;
                $this->rating_model->update_rating($id, $type, $data);
            } else {
                $data = [
                    'id_type' => $id,
                    'type' => $type,
                    'votes' => 1,
                    'rating' => $rating
                ];
                $votes_res = 1;
                $rating_res = $rating * 20;
                $this->rating_model->insert_rating($data);
            }
            //Change rating for product
            if ($type == 'product') {
                if (SProductsQuery::create()->findPk($id) !== null) {
                    $model = SProductsRatingQuery::create()->findPk($id);
                    if ($model === null) {
                        $model = new SProductsRating;

Instantiating objects should always be done with parentheses.

                        $model->setProductId($id);
                    }
                    $rating_res = (($model->getRating() + $rating) / ($model->getVotes() + 1)) * 20;
                    $votes_res = $model->getVotes() + 1;

                    $model->setVotes($model->getVotes() + 1);
                    $model->setRating($model->getRating() + $rating);
                    $model->save();
                }
            }
            //Save in session user's info
            $this->session->set_userdata('voted_g' . $id . $type, true);

            //If ajax request than return data for with new rating and votes
            if ($this->input->is_ajax_request()) {
                return json_encode(
                    [
                        'rate' => "$rating_res",
                        'votes' => "$votes_res"
                    ]
                );
            }
        } else {
            return json_encode(['rate' => null]);
        }
    }

    /**
     * Install module
     */
    public function _install() {

        $this->load->dbforge();
        ($this->dx_auth->is_admin()) OR exit;
        $fields = [
            'id' => [
                'type' => 'INT',
                'auto_increment' => TRUE
            ],
            'id_type' => [
                'type' => 'VARCHAR',
                'constraint' => '25',
                'null' => TRUE,
            ],
            'type' => [
                'type' => 'VARCHAR',
                'constraint' => '25',
                'null' => TRUE,
            ],
            'votes' => [
                'type' => 'INT',
            ],
            'rating' => [
                'type' => 'INT',
            ],
        ];

        $this->dbforge->add_field($fields);
        $this->dbforge->add_key('id', TRUE);
        $this->dbforge->create_table('rating');

        $this->db->where('name', 'star_rating');
        $this->db->update('components', ['enabled' => 1]);
    }

    /**
     * Deinstall module
     */
    public function _deinstall() {

        $this->load->dbforge();
        ($this->dx_auth->is_admin()) OR exit;
        $this->dbforge->drop_table('rating');
    }

}