VoteQueryBehavior::andFavorites() - Code Metrics - Inspection of "Scope for select only favorite items" - hauntd/yii2-vote - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Pull Request — master (#18)

by Lukyanov

created 2018-06-23 16:18 UTC

VoteQueryBehavior::andFavorites() A

↳ Parent: VoteQueryBehavior

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
cc	1
eloc	5
nc	1
nop	1

<?php

namespace hauntd\vote\behaviors;

use hauntd\vote\models\Vote;
use hauntd\vote\models\VoteAggregate;
use hauntd\vote\traits\ModuleTrait;
use Yii;
use yii\base\Behavior;
use yii\db\Expression;

/**
 * Class VoteQueryBehavior
 * @package hauntd\vote\behaviors
 * @property $own;er \yii\db\ActiveQuery
 */
class VoteQueryBehavior extends Behavior
{
    use ModuleTrait;

    /**
     * @var bool
     */
    protected $selectAdded = false;

    /**
     * Include vote aggregate model/values.
     *
     * @param $entity
     * @return \yii\base\Component
     * @throws \yii\base\InvalidConfigException
     */
    public function withVoteAggregate($entity)
    {
        $entityEncoded = $this->getModule()->encodeEntity($entity);
        $voteAggregateTable = VoteAggregate::tableName();
        $model = new $this->owner->modelClass();
        $this->initSelect($model);

        $this->owner
            ->leftJoin("$voteAggregateTable {$entity}Aggregate", [
                "{$entity}Aggregate.target_id" => new Expression("`{$model->tableSchema->name}`.`{$model->primaryKey()[0]}`"),
                "{$entity}Aggregate.entity" => $entityEncoded
            ])
            ->addSelect([
                new Expression("`{$entity}Aggregate`.`positive` as `{$entity}Positive`"),
                new Expression("`{$entity}Aggregate`.`negative` as `{$entity}Negative`"),
                new Expression("`{$entity}Aggregate`.`rating` as `{$entity}Rating`"),
            ]);

        return $this->owner;
    }

    /**
     * Include user vote status.
     *
     * @param $entity
     * @return \yii\base\Component
     * @throws \yii\base\InvalidConfigException
     */
    public function withUserVote($entity)
    {
        $entityEncoded = $this->getModule()->encodeEntity($entity);
        $model = new $this->owner->modelClass();
        $voteTable = Vote::tableName();
        $this->initSelect($model);

        $joinCondition = [
            "$entity.entity" => $entityEncoded,
            "$entity.target_id" => new Expression("`{$model->tableSchema->name}`.`{$model->primaryKey()[0]}`"),
        ];

        $this->owner->addGroupBy("`{$model->tableSchema->name}`.`{$model->tableSchema->primaryKey[0]}`");
        if (Yii::$app->user->isGuest) {
            $joinCondition["{$entity}.user_ip"] = Yii::$app->request->userIP;
            $joinCondition["{$entity}.user_id"] = null;
        } else {
            $joinCondition["{$entity}.user_id"] = Yii::$app->user->id;
        }

        $this->owner
            ->leftJoin("$voteTable $entity", $joinCondition)
            ->addSelect([
                new Expression("`$entity`.`value` as `{$entity}UserValue`")]);

        return $this->owner;
    }
    
     /**
     * Scope for select only favorite items
     * 
     * @param $entity
     * @return VoteQueryBehavior
     * @throws \yii\base\InvalidConfigException
     */
    public function andFavorites($entity)
    {
        $entityEncoded = $this->getModule()->encodeEntity($entity);

        $this->andWhere(["{$entity}.user_id" => Yii::$app->user->id]);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $this->andWhere(["$entity.entity" => $entityEncoded]);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        return $this;
    }

    /**
     * Add `{{%table}}`.* as first table attributes to select.
     *
     * @param $model
     */
    protected function initSelect($model)
    {
        if (!$this->selectAdded && (is_array($this->owner->select) && !array_search('*', $this->owner->select)) ||
            !isset($this->owner->select)) {
            $this->owner->addSelect("{$model->tableSchema->name}.*");
            $this->selectAdded = true;
        }
    }
}


1			<?php
2
3			namespace hauntd\vote\behaviors;
4
5			use hauntd\vote\models\Vote;
6			use hauntd\vote\models\VoteAggregate;
7			use hauntd\vote\traits\ModuleTrait;
8			use Yii;
9			use yii\base\Behavior;
10			use yii\db\Expression;
11
12			/**
13			* Class VoteQueryBehavior
14			* @package hauntd\vote\behaviors
15			* @property $own;er \yii\db\ActiveQuery
16			*/
17			class VoteQueryBehavior extends Behavior
18			{
19			use ModuleTrait;
20
21			/**
22			* @var bool
23			*/
24			protected $selectAdded = false;
25
26			/**
27			* Include vote aggregate model/values.
28			*
29			* @param $entity
30			* @return \yii\base\Component
31			* @throws \yii\base\InvalidConfigException
32			*/
33			public function withVoteAggregate($entity)
34			{
35			$entityEncoded = $this->getModule()->encodeEntity($entity);
36			$voteAggregateTable = VoteAggregate::tableName();
37			$model = new $this->owner->modelClass();
38			$this->initSelect($model);
39
40			$this->owner
41			->leftJoin("$voteAggregateTable {$entity}Aggregate", [
42			"{$entity}Aggregate.target_id" => new Expression("`{$model->tableSchema->name}`.`{$model->primaryKey()[0]}`"),
43			"{$entity}Aggregate.entity" => $entityEncoded
44			])
45			->addSelect([
46			new Expression("`{$entity}Aggregate`.`positive` as `{$entity}Positive`"),
47			new Expression("`{$entity}Aggregate`.`negative` as `{$entity}Negative`"),
48			new Expression("`{$entity}Aggregate`.`rating` as `{$entity}Rating`"),
49			]);
50
51			return $this->owner;
52			}
53
54			/**
55			* Include user vote status.
56			*
57			* @param $entity
58			* @return \yii\base\Component
59			* @throws \yii\base\InvalidConfigException
60			*/
61			public function withUserVote($entity)
62			{
63			$entityEncoded = $this->getModule()->encodeEntity($entity);
64			$model = new $this->owner->modelClass();
65			$voteTable = Vote::tableName();
66			$this->initSelect($model);
67
68			$joinCondition = [
69			"$entity.entity" => $entityEncoded,
70			"$entity.target_id" => new Expression("`{$model->tableSchema->name}`.`{$model->primaryKey()[0]}`"),
71			];
72
73			$this->owner->addGroupBy("`{$model->tableSchema->name}`.`{$model->tableSchema->primaryKey[0]}`");
74			if (Yii::$app->user->isGuest) {
75			$joinCondition["{$entity}.user_ip"] = Yii::$app->request->userIP;
76			$joinCondition["{$entity}.user_id"] = null;
77			} else {
78			$joinCondition["{$entity}.user_id"] = Yii::$app->user->id;
79			}
80
81			$this->owner
82			->leftJoin("$voteTable $entity", $joinCondition)
83			->addSelect([
84			new Expression("`$entity`.`value` as `{$entity}UserValue`")]);
85
86			return $this->owner;
87			}
88
89			/**
90			* Scope for select only favorite items
91			*
92			* @param $entity
93			* @return VoteQueryBehavior
94			* @throws \yii\base\InvalidConfigException
95			*/
96			public function andFavorites($entity)
97			{
98			$entityEncoded = $this->getModule()->encodeEntity($entity);
99
100			$this->andWhere(["{$entity}.user_id" => Yii::$app->user->id]);
			0 ignored issues – show Documentation Bug introduced 2018-06-23 16:20 UTC by Report Bug Copy Issue Report The method `andWhere` does not exist on `object<hauntd\vote\behaviors\VoteQueryBehavior>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
101			$this->andWhere(["$entity.entity" => $entityEncoded]);
			0 ignored issues – show Documentation Bug introduced 2018-06-23 16:20 UTC by Report Bug Copy Issue Report The method `andWhere` does not exist on `object<hauntd\vote\behaviors\VoteQueryBehavior>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
102
103			return $this;
104			}
105
106			/**
107			* Add `{{%table}}`.* as first table attributes to select.
108			*
109			* @param $model
110			*/
111			protected function initSelect($model)
112			{
113			if (!$this->selectAdded && (is_array($this->owner->select) && !array_search('*', $this->owner->select)) \|\|
114			!isset($this->owner->select)) {
115			$this->owner->addSelect("{$model->tableSchema->name}.*");
116			$this->selectAdded = true;
117			}
118			}
119			}
120

hauntd / yii2-vote

Pull Request — master (#18)

VoteQueryBehavior::andFavorites() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like