Counter::updateInfoForEditable() - Code Metrics - Inspection of "Merge pull request #375 from DevGroup-ru/enh/manag..." - DevGroup-ru/dotplant2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 7cfc28...20914a )

by Alexander

created 2017-05-04 07:10 UTC

Counter::updateInfoForEditable() B

↳ Parent: Counter

Complexity

Conditions	5
Paths	5

Size

Total Lines	25
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	25
rs	8.439
c	0
b	0
f	0
cc	5
eloc	19
nc	5
nop	1

<?php

namespace app\modules\seo\models;

use app\backend\BackendModule;
use app\backend\components\BackendController;
use devgroup\TagDependencyHelper\ActiveRecordHelper;
use yii\base\Event;
use yii\caching\TagDependency;
use yii\data\ActiveDataProvider;
use yii\db\ActiveRecord;
use yii\web\View;

/**
 * This is the model class for table "seo_counter".
 *
 * @property integer $id
 * @property string $name
 * @property string $description
 * @property string $code
 * @property int $position see POSITION_* constants for available options
 */
class Counter extends ActiveRecord
{
    const POSITION_AT_END_OF_BODY = 0;
    const POSITION_AT_BEGIN_OF_BODY = 1;
    const POSITION_AT_HEAD = 2;

    const MESSAGE_END_OF_BODY_TAG = "End of body tag";
    const MESSAGE_BEGINNING_OF_BODY_TAG = "Beginning of body tag";
    const MESSAGE_INSIDE_OF_HEAD_TAG = "Inside of head tag";

    /**
     * @inheritdoc
     */
    public static function tableName()
    {
        return '{{%seo_counter}}';
    }

    /**
     * @param $counter
     * @return string
     */
    private static function renderCounter($counter)
    {
        return
            "\n<!-- {$counter->name} counter -->\n"
            . "{$counter->code}"
            . "\n<!-- /{$counter->name} counter -->\n";
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [['description', 'code'], 'string'],
            [['code'], 'required'],
            [['name'], 'string', 'max' => 255],
            [['position'], 'integer']
        ];
    }

    public function behaviors()
    {
        return [
            ActiveRecordHelper::className(),
        ];
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return [
            'id' => \Yii::t('app', 'ID'),
            'name' => \Yii::t('app', 'Name'),
            'description' => \Yii::t('app', 'Description'),
            'code' => \Yii::t('app', 'Code'),
            'position' => \Yii::t('app', 'Position')
        ];
    }

    public static function renderCountersAtHead(Event $event)
    {
        $counters = self::find()->where(["position" => self::POSITION_AT_HEAD])->all();
        foreach ($counters as $counter) {
            $event->sender->jsFiles[View::POS_HEAD][] = static::renderCounter($counter);
class YourClass
{
    private static function getTemperature() {
        return "3422 °C";
}

public static function getSomeVariable()
{
    return static::getTemperature();
}
        }
    }

    public static function renderCountersAtBeginningOfBody(Event $event)
    {
        static::renderCounters($event, static::POSITION_AT_BEGIN_OF_BODY);
    }

    public static function renderCountersAtEndOfBody(Event $event)
    {
        static::renderCounters($event, static::POSITION_AT_END_OF_BODY);
    }

    /**
     * @return string[]
     */
    public static function getPositionVariants()
    {
        return [
            self::POSITION_AT_END_OF_BODY => \Yii::t("app", self::MESSAGE_END_OF_BODY_TAG),
            self::POSITION_AT_BEGIN_OF_BODY => \Yii::t("app", self::MESSAGE_BEGINNING_OF_BODY_TAG),
            self::POSITION_AT_HEAD => \Yii::t("app", self::MESSAGE_INSIDE_OF_HEAD_TAG)
        ];
    }

    /**
     * @param Counter $model
     * @return null|string
     */
    public static function updateInfoForEditable(Counter $model)
    {
        if ($model === null) {
            return null;
        }

        switch($model->position) {
            case self::POSITION_AT_BEGIN_OF_BODY:
                $value = self::MESSAGE_BEGINNING_OF_BODY_TAG;
                break;
            case self::POSITION_AT_END_OF_BODY:
                $value = self::MESSAGE_END_OF_BODY_TAG;
                break;
            case self::POSITION_AT_HEAD:
                $value = self::MESSAGE_INSIDE_OF_HEAD_TAG;
                break;
            default:
                $value = 'Unexpected value';
                break;
        }
        return \yii\helpers\Html::tag(
            'span',
            \Yii::t('app', $value)
        );
    }

    public static function renderCounters(Event $event, $mode = self::POSITION_AT_END_OF_BODY)

    {
        if (
            \Yii::$app->request->isAjax === false &&
            \Yii::$app->controller->module instanceof BackendModule === false &&
            \Yii::$app->controller instanceof BackendController === false
        ) {
            $cacheKey = \Yii::$app->getModule('seo')->cacheConfig['counterCache']['name'] . $mode;
            $counter_str = '';
            /* @var $counters Counter[] */
            if (false === $counters = \Yii::$app->getCache()->get($cacheKey)) {
                $counters = self::find()->where(["position" => $mode])->all();
                \Yii::$app->getCache()->set(
                    $cacheKey,
                    $counters,
                    \Yii::$app->getModule('seo')->cacheConfig['counterCache']['expire'],
                    new TagDependency(
                        [
                            'tags' => [
                                ActiveRecordHelper::getCommonTag(self::className()),
                            ],
                        ]
                    )
                );
            }
            foreach ($counters as $counter) {
                $counter_str .= self::renderCounter($counter);
            }
            echo $counter_str;
        }
    }

    public function scenarios()
    {
        return [
            'default' => ['id', 'name', 'description', 'code', 'position'],
        ];
    }


    /**
     * Search counters
     * @param $params
     * @return ActiveDataProvider
     */
    public
    function search(
        $params
    ) {
        $this->load($params);
        $query = self::find();
        foreach ($this->attributes as $name => $value) {
            if (!empty($value)) {
                if ($name == 'id') {
                    $query->andWhere("`$name` = :$name", [":$name" => $value]);
                } else {
                    $query->andWhere("`$name` LIKE :$name", [":$name" => "%$value%"]);
                }
            }
        }
        $dataProvider = new ActiveDataProvider(
            [
                'query' => $query,
                'pagination' => [
                    'pageSize' => 10,
                ],
            ]
        );
        return $dataProvider;
    }
}


1		<?php
2
3		namespace app\modules\seo\models;
4
5		use app\backend\BackendModule;
6		use app\backend\components\BackendController;
7		use devgroup\TagDependencyHelper\ActiveRecordHelper;
8		use yii\base\Event;
9		use yii\caching\TagDependency;
10		use yii\data\ActiveDataProvider;
11		use yii\db\ActiveRecord;
12		use yii\web\View;
13
14		/**
15		* This is the model class for table "seo_counter".
16		*
17		* @property integer $id
18		* @property string $name
19		* @property string $description
20		* @property string $code
21		* @property int $position see POSITION_* constants for available options
22		*/
23		class Counter extends ActiveRecord
24		{
25		const POSITION_AT_END_OF_BODY = 0;
26		const POSITION_AT_BEGIN_OF_BODY = 1;
27		const POSITION_AT_HEAD = 2;
28
29		const MESSAGE_END_OF_BODY_TAG = "End of body tag";
30		const MESSAGE_BEGINNING_OF_BODY_TAG = "Beginning of body tag";
31		const MESSAGE_INSIDE_OF_HEAD_TAG = "Inside of head tag";
32
33		/**
34		* @inheritdoc
35		*/
36		public static function tableName()
37		{
38		return '{{%seo_counter}}';
39		}
40
41		/**
42		* @param $counter
43		* @return string
44		*/
45		private static function renderCounter($counter)
46		{
47		return
48		"\n<!-- {$counter->name} counter -->\n"
49		. "{$counter->code}"
50		. "\n<!-- /{$counter->name} counter -->\n";
51		}
52
53		/**
54		* @inheritdoc
55		*/
56	View Code Duplication	public function rules()
57		{
58		return [
59		[['description', 'code'], 'string'],
60		[['code'], 'required'],
61		[['name'], 'string', 'max' => 255],
62		[['position'], 'integer']
63		];
64		}
65
66		public function behaviors()
67		{
68		return [
69		ActiveRecordHelper::className(),
70		];
71		}
72
73		/**
74		* @inheritdoc
75		*/
76		public function attributeLabels()
77		{
78		return [
79		'id' => \Yii::t('app', 'ID'),
80		'name' => \Yii::t('app', 'Name'),
81		'description' => \Yii::t('app', 'Description'),
82		'code' => \Yii::t('app', 'Code'),
83		'position' => \Yii::t('app', 'Position')
84		];
85		}
86
87		public static function renderCountersAtHead(Event $event)
88		{
89		$counters = self::find()->where(["position" => self::POSITION_AT_HEAD])->all();
90		foreach ($counters as $counter) {
91		$event->sender->jsFiles[View::POS_HEAD][] = static::renderCounter($counter);
		0 ignored issues – show Bug introduced 2017-01-27 07:48 UTC by Report Bug Copy Issue Report Since `renderCounter()` is declared private, calling it with `static` will lead to errors in possible sub-classes. You can either use `self`, or increase the visibility of `renderCounter()` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static function getTemperature() { return "3422 °C"; } public static function getSomeVariable() { return static::getTemperature(); } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { private static function getTemperature() { return "-182 °C"; } } print YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class YourClass { private static function getTemperature() { return "3422 °C"; } public static function getSomeVariable() { return self::getTemperature(); } } Loading history...
92		}
93		}
94
95		public static function renderCountersAtBeginningOfBody(Event $event)
96		{
97		static::renderCounters($event, static::POSITION_AT_BEGIN_OF_BODY);
98		}
99
100		public static function renderCountersAtEndOfBody(Event $event)
101		{
102		static::renderCounters($event, static::POSITION_AT_END_OF_BODY);
103		}
104
105		/**
106		* @return string[]
107		*/
108		public static function getPositionVariants()
109		{
110		return [
111		self::POSITION_AT_END_OF_BODY => \Yii::t("app", self::MESSAGE_END_OF_BODY_TAG),
112		self::POSITION_AT_BEGIN_OF_BODY => \Yii::t("app", self::MESSAGE_BEGINNING_OF_BODY_TAG),
113		self::POSITION_AT_HEAD => \Yii::t("app", self::MESSAGE_INSIDE_OF_HEAD_TAG)
114		];
115		}
116
117		/**
118		* @param Counter $model
119		* @return null\|string
120		*/
121		public static function updateInfoForEditable(Counter $model)
122		{
123		if ($model === null) {
124		return null;
125		}
126
127		switch($model->position) {
128		case self::POSITION_AT_BEGIN_OF_BODY:
129		$value = self::MESSAGE_BEGINNING_OF_BODY_TAG;
130		break;
131		case self::POSITION_AT_END_OF_BODY:
132		$value = self::MESSAGE_END_OF_BODY_TAG;
133		break;
134		case self::POSITION_AT_HEAD:
135		$value = self::MESSAGE_INSIDE_OF_HEAD_TAG;
136		break;
137		default:
138		$value = 'Unexpected value';
139		break;
140		}
141		return \yii\helpers\Html::tag(
142		'span',
143		\Yii::t('app', $value)
144		);
145		}
146
147		public static function renderCounters(Event $event, $mode = self::POSITION_AT_END_OF_BODY)
		0 ignored issues – show Unused Code introduced 2017-03-17 10:49 UTC by Report Bug Copy Issue Report The parameter `$event` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
148		{
149		if (
150		\Yii::$app->request->isAjax === false &&
151		\Yii::$app->controller->module instanceof BackendModule === false &&
152		\Yii::$app->controller instanceof BackendController === false
153		) {
154		$cacheKey = \Yii::$app->getModule('seo')->cacheConfig['counterCache']['name'] . $mode;
155		$counter_str = '';
156		/* @var $counters Counter[] */
157		if (false === $counters = \Yii::$app->getCache()->get($cacheKey)) {
158		$counters = self::find()->where(["position" => $mode])->all();
159		\Yii::$app->getCache()->set(
160		$cacheKey,
161		$counters,
162		\Yii::$app->getModule('seo')->cacheConfig['counterCache']['expire'],
163		new TagDependency(
164		[
165		'tags' => [
166		ActiveRecordHelper::getCommonTag(self::className()),
167		],
168		]
169		)
170		);
171		}
172		foreach ($counters as $counter) {
173		$counter_str .= self::renderCounter($counter);
174		}
175		echo $counter_str;
176		}
177		}
178
179		public function scenarios()
180		{
181		return [
182		'default' => ['id', 'name', 'description', 'code', 'position'],
183		];
184		}
185
186
187		/**
188		* Search counters
189		* @param $params
190		* @return ActiveDataProvider
191		*/
192		public
193		function search(
194		$params
195		) {
196		$this->load($params);
197		$query = self::find();
198		foreach ($this->attributes as $name => $value) {
199		if (!empty($value)) {
200		if ($name == 'id') {
201		$query->andWhere("`$name` = :$name", [":$name" => $value]);
202		} else {
203		$query->andWhere("`$name` LIKE :$name", [":$name" => "%$value%"]);
204		}
205		}
206		}
207		$dataProvider = new ActiveDataProvider(
208		[
209		'query' => $query,
210		'pagination' => [
211		'pageSize' => 10,
212		],
213		]
214		);
215		return $dataProvider;
216		}
217		}
218

DevGroup-ru / dotplant2

GitHub Access Token became invalid

Push — master ( 7cfc28...20914a )

Counter::updateInfoForEditable() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like