MultilanguageValidateModel::setMainModel() - Code Metrics - Inspection of "Code fixes according with the PSR standards" - itstructure/yii2-admin-module - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a1e0c4...aac760 )

by Andrey

created 2018-08-05 13:04 UTC

MultilanguageValidateModel::setMainModel() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace Itstructure\AdminModule\models;

use yii\db\ActiveRecord as BaseActiveRecord;
use yii\base\Model;
use yii\helpers\ArrayHelper;
use Itstructure\AdminModule\interfaces\ModelInterface;

/**
 * Class MultilanguageValidateModel
 * General validation model together with multilingual fields.
 *
 * @property array $dynamicFields Dynamic fields from which the translated fields are formed.
 * @property BaseActiveRecord|MultilanguageTrait $mainModel Basic data model.
 *
 * @package Itstructure\AdminModule\models
 *
 * @author Andrey Girnik <[email protected]>
 */
class MultilanguageValidateModel extends Model implements ModelInterface
{
    /**
     * Dynamic fields from which the translated fields are formed.
     *
     * @var array
     */
    public $dynamicFields = [];

    /**
     * Basic data model.
     *
     * @var BaseActiveRecord|MultilanguageTrait
     */
    private $mainModel;

    /**
     * Scripts Constants.
     * Required for certain validation rules to work for specific scenarios.
     */
    const SCENARIO_CREATE = 'create';
    const SCENARIO_UPDATE = 'update';

    /**
     * Validation rules for all fields together with dynamic.
     *
     * @return array
     */
    public function rules(): array
    {
        return ArrayHelper::merge(
            $this->getDynamicValidationRules(),
            $this->mainModel->rules()
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        );
    }

    /**
     * Scenarios.
     *
     * @return array
     */
    public function scenarios(): array
    {
        return [
            self::SCENARIO_CREATE => $this->attributes(),
            self::SCENARIO_UPDATE => $this->attributes(),
            self::SCENARIO_DEFAULT => $this->attributes(),
        ];
    }

    /**
     * Labels of all fields.
     *
     * @inheritdoc
     */
    public function attributeLabels()
    {
        $dynamicAttributeLabels = [];
        $staticAttributeLabels = [];

        $translateAttributeLabels = call_user_func([
            $this->mainModel->getTranslateModelName(),
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            'attributeLabels',
        ]);

        foreach ($this->dynamicFields as $fieldConditions) {

            $fieldName = $fieldConditions['name'];

            if (array_key_exists($fieldName, $translateAttributeLabels)) {

                $staticAttributeLabels[$fieldName] = $translateAttributeLabels[$fieldName];

                foreach ($this->getShortLanguageList() as $language) {
                    $dynamicAttributeLabels[$fieldName.'_'.$language] = $translateAttributeLabels[$fieldName];
                }
            }
        }

        return ArrayHelper::merge(
            ArrayHelper::merge(
                $dynamicAttributeLabels,
                $staticAttributeLabels
            ),
            $this->mainModel->attributeLabels()
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        );
    }

    /**
     * Specifies the value of the field.
     *
     * @param string $name - name of field.
     * @param mixed  $value - value to be stored in field.
     *
     * @return void
     */
    public function __set($name, $value)
    {
        $setter = 'set' . $name;
        if (method_exists($this, $setter)) {
            $this->$setter($value);
        } else {
            $this->{$name} = $value;
        }
    }

    /**
     * Gets the value of the field.
     *
     * @param string $name - field name.
     *
     * @return mixed
     */
    public function __get($name)
    {
        $getter = 'get' . $name;
        if (method_exists($this, $getter)) {
            return $this->$getter();
        }

        if ($this->mainModel->isNewRecord) {
            return $this->{$name} ?? '';
        } else {
            return $this->mainModel->{$name} ?? '';
        }
    }

    /**
     * Setter for main model.
     *
     * @param BaseActiveRecord $mainModel
     */
    public function setMainModel(BaseActiveRecord $mainModel)
    {
        $this->mainModel = $mainModel;
    }

    /**
     * Getter for main model.
     *
     * @return mixed
     */
    public function getMainModel()
    {
        return $this->mainModel;
    }

    /**
     * Attributes along with dynamic and from the basic model.
     *
     * @return array
     */
    public function attributes(): array
    {
        return ArrayHelper::merge(
            $this->getDynamicAttributes(),
            $this->mainModel->attributes()
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        );
    }

    /**
     * Saves data in the main model.
     *
     * @return bool
     */
    public function save(): bool
    {
        if ($this->mainModel->isNewRecord) {
            $this->setScenario(self::SCENARIO_CREATE);
        } else {
            $this->setScenario(self::SCENARIO_UPDATE);
        }

        if (!$this->validate()){
            return false;
        }

        // Transferring attribute values from this model to the main.
        foreach ($this->attributes() as $attribute) {

            $this->mainModel->{$attribute} = $this->{$attribute};
        }

        return $this->mainModel->save();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    /**
     * Returns the id of the current model.
     *
     * @return int
     */
    public function getId()
    {
        return $this->mainModel->id;
    }

    /**
     * Returns an array of all multilanguage attributes.
     *
     * @return array
     */
    private function getDynamicAttributes(): array
    {
        $languageList = $this->getShortLanguageList();
        $dynamicAttributes = [];
        foreach ($languageList as $language) {
            foreach ($this->dynamicFields as $fieldConditions) {
                $dynamicAttributes[] = $fieldConditions['name'] . '_' . $language;
            }
        }
        return array_values($dynamicAttributes);
    }

    /**
     * Creates validation rules for dynamic fields for all languages.
     *
     * @return array
     */
    private function getDynamicValidationRules(): array
    {
        $rules = [];
        foreach ($this->getShortLanguageList() as $language) {
            foreach ($this->dynamicFields as $fieldConditions) {

                $fieldName = $fieldConditions['name'];
                $fieldRules = isset($fieldConditions['rules']) ? $fieldConditions['rules'] : [];

                foreach ($fieldRules as $fieldRule) {

                    if (in_array('required', $fieldRule) && $language != Language::getDefaultLanguage()->shortName) {
                        continue;
                    }

                    if (in_array('unique', $fieldRule)) {
                        $fieldRule = ArrayHelper::merge(
                            $fieldRule,
                            [
                                'skipOnError'     => true,
                                'targetClass'     => $this->mainModel->getTranslateModelName(),
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                                'targetAttribute' => [$fieldName . '_' . $language => $fieldName],

                                'filter' => $this->getScenario() == self::SCENARIO_UPDATE ?
                                    $this->mainModel->getKeyToMainModel().' != '.$this->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.");
        }
    }

}

                                'message' => isset($fieldRule['message']) ?
                                    $fieldRule['message'] : 'Record with such attribute "{attribute}" already exists'
                            ]
                        );
                    }

                    $rules[] = ArrayHelper::merge(
                        [$fieldName . '_' . $language],
                        $fieldRule
                    );
                }
            }
        }

        return $rules;
    }

    /**
     * Returns the list of available languages in the short name format.
     *
     * @return array
     */
    private function getShortLanguageList(): array
    {
        return Language::getShortLanguageList();
    }
}


Push — master ( a1e0c4...aac760 )

MultilanguageValidateModel::setMainModel() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			namespace Itstructure\AdminModule\models;
4
5			use yii\db\ActiveRecord as BaseActiveRecord;
6			use yii\base\Model;
7			use yii\helpers\ArrayHelper;
8			use Itstructure\AdminModule\interfaces\ModelInterface;
9
10			/**
11			* Class MultilanguageValidateModel
12			* General validation model together with multilingual fields.
13			*
14			* @property array $dynamicFields Dynamic fields from which the translated fields are formed.
15			* @property BaseActiveRecord\|MultilanguageTrait $mainModel Basic data model.
16			*
17			* @package Itstructure\AdminModule\models
18			*
19			* @author Andrey Girnik <[email protected]>
20			*/
21			class MultilanguageValidateModel extends Model implements ModelInterface
22			{
23			/**
24			* Dynamic fields from which the translated fields are formed.
25			*
26			* @var array
27			*/
28			public $dynamicFields = [];
29
30			/**
31			* Basic data model.
32			*
33			* @var BaseActiveRecord\|MultilanguageTrait
34			*/
35			private $mainModel;
36
37			/**
38			* Scripts Constants.
39			* Required for certain validation rules to work for specific scenarios.
40			*/
41			const SCENARIO_CREATE = 'create';
42			const SCENARIO_UPDATE = 'update';
43
44			/**
45			* Validation rules for all fields together with dynamic.
46			*
47			* @return array
48			*/
49			public function rules(): array
50			{
51			return ArrayHelper::merge(
52			$this->getDynamicValidationRules(),
53			$this->mainModel->rules()
			0 ignored issues – show Bug introduced 2018-08-05 13:05 UTC by Report Bug Copy Issue Report The method `rules` does only exist in `yii\db\ActiveRecord`, but not in `Itstructure\AdminModule\models\MultilanguageTrait`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
54			);
55			}
56
57			/**
58			* Scenarios.
59			*
60			* @return array
61			*/
62			public function scenarios(): array
63			{
64			return [
65			self::SCENARIO_CREATE => $this->attributes(),
66			self::SCENARIO_UPDATE => $this->attributes(),
67			self::SCENARIO_DEFAULT => $this->attributes(),
68			];
69			}
70
71			/**
72			* Labels of all fields.
73			*
74			* @inheritdoc
75			*/
76			public function attributeLabels()
77			{
78			$dynamicAttributeLabels = [];
79			$staticAttributeLabels = [];
80
81			$translateAttributeLabels = call_user_func([
82			$this->mainModel->getTranslateModelName(),
			0 ignored issues – show Bug introduced 2018-08-05 13:05 UTC by Report Bug Copy Issue Report The method `getTranslateModelName` does only exist in `Itstructure\AdminModule\models\MultilanguageTrait`, but not in `yii\db\ActiveRecord`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
83			'attributeLabels',
84			]);
85
86			foreach ($this->dynamicFields as $fieldConditions) {
87
88			$fieldName = $fieldConditions['name'];
89
90			if (array_key_exists($fieldName, $translateAttributeLabels)) {
91
92			$staticAttributeLabels[$fieldName] = $translateAttributeLabels[$fieldName];
93
94			foreach ($this->getShortLanguageList() as $language) {
95			$dynamicAttributeLabels[$fieldName.'_'.$language] = $translateAttributeLabels[$fieldName];
96			}
97			}
98			}
99
100			return ArrayHelper::merge(
101			ArrayHelper::merge(
102			$dynamicAttributeLabels,
103			$staticAttributeLabels
104			),
105			$this->mainModel->attributeLabels()
			0 ignored issues – show Bug introduced 2018-08-05 13:05 UTC by Report Bug Copy Issue Report The method `attributeLabels` does only exist in `yii\db\ActiveRecord`, but not in `Itstructure\AdminModule\models\MultilanguageTrait`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
106			);
107			}
108
109			/**
110			* Specifies the value of the field.
111			*
112			* @param string $name - name of field.
113			* @param mixed $value - value to be stored in field.
114			*
115			* @return void
116			*/
117			public function __set($name, $value)
118			{
119			$setter = 'set' . $name;
120			if (method_exists($this, $setter)) {
121			$this->$setter($value);
122			} else {
123			$this->{$name} = $value;
124			}
125			}
126
127			/**
128			* Gets the value of the field.
129			*
130			* @param string $name - field name.
131			*
132			* @return mixed
133			*/
134			public function __get($name)
135			{
136			$getter = 'get' . $name;
137			if (method_exists($this, $getter)) {
138			return $this->$getter();
139			}
140
141			if ($this->mainModel->isNewRecord) {
142			return $this->{$name} ?? '';
143			} else {
144			return $this->mainModel->{$name} ?? '';
145			}
146			}
147
148			/**
149			* Setter for main model.
150			*
151			* @param BaseActiveRecord $mainModel
152			*/
153			public function setMainModel(BaseActiveRecord $mainModel)
154			{
155			$this->mainModel = $mainModel;
156			}
157
158			/**
159			* Getter for main model.
160			*
161			* @return mixed
162			*/
163			public function getMainModel()
164			{
165			return $this->mainModel;
166			}
167
168			/**
169			* Attributes along with dynamic and from the basic model.
170			*
171			* @return array
172			*/
173			public function attributes(): array
174			{
175			return ArrayHelper::merge(
176			$this->getDynamicAttributes(),
177			$this->mainModel->attributes()
			0 ignored issues – show Bug introduced 2018-08-05 13:05 UTC by Report Bug Copy Issue Report The method `attributes` does only exist in `yii\db\ActiveRecord`, but not in `Itstructure\AdminModule\models\MultilanguageTrait`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
178			);
179			}
180
181			/**
182			* Saves data in the main model.
183			*
184			* @return bool
185			*/
186			public function save(): bool
187			{
188			if ($this->mainModel->isNewRecord) {
189			$this->setScenario(self::SCENARIO_CREATE);
190			} else {
191			$this->setScenario(self::SCENARIO_UPDATE);
192			}
193
194			if (!$this->validate()){
195			return false;
196			}
197
198			// Transferring attribute values from this model to the main.
199			foreach ($this->attributes() as $attribute) {
200
201			$this->mainModel->{$attribute} = $this->{$attribute};
202			}
203
204			return $this->mainModel->save();
			0 ignored issues – show Bug introduced 2018-08-05 13:05 UTC by Report Bug Copy Issue Report The method `save` does only exist in `yii\db\ActiveRecord`, but not in `Itstructure\AdminModule\models\MultilanguageTrait`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
205			}
206
207			/**
208			* Returns the id of the current model.
209			*
210			* @return int
211			*/
212			public function getId()
213			{
214			return $this->mainModel->id;
215			}
216
217			/**
218			* Returns an array of all multilanguage attributes.
219			*
220			* @return array
221			*/
222			private function getDynamicAttributes(): array
223			{
224			$languageList = $this->getShortLanguageList();
225			$dynamicAttributes = [];
226			foreach ($languageList as $language) {
227			foreach ($this->dynamicFields as $fieldConditions) {
228			$dynamicAttributes[] = $fieldConditions['name'] . '_' . $language;
229			}
230			}
231			return array_values($dynamicAttributes);
232			}
233
234			/**
235			* Creates validation rules for dynamic fields for all languages.
236			*
237			* @return array
238			*/
239			private function getDynamicValidationRules(): array
240			{
241			$rules = [];
242			foreach ($this->getShortLanguageList() as $language) {
243			foreach ($this->dynamicFields as $fieldConditions) {
244
245			$fieldName = $fieldConditions['name'];
246			$fieldRules = isset($fieldConditions['rules']) ? $fieldConditions['rules'] : [];
247
248			foreach ($fieldRules as $fieldRule) {
249
250			if (in_array('required', $fieldRule) && $language != Language::getDefaultLanguage()->shortName) {
251			continue;
252			}
253
254			if (in_array('unique', $fieldRule)) {
255			$fieldRule = ArrayHelper::merge(
256			$fieldRule,
257			[
258			'skipOnError' => true,
259			'targetClass' => $this->mainModel->getTranslateModelName(),
			0 ignored issues – show Bug introduced 2018-08-05 13:05 UTC by Report Bug Copy Issue Report The method `getTranslateModelName` does only exist in `Itstructure\AdminModule\models\MultilanguageTrait`, but not in `yii\db\ActiveRecord`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
260			'targetAttribute' => [$fieldName . '_' . $language => $fieldName],
261
262			'filter' => $this->getScenario() == self::SCENARIO_UPDATE ?
263			$this->mainModel->getKeyToMainModel().' != '.$this->id : '',
			0 ignored issues – show Documentation introduced 2018-08-05 13:05 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Itstructure\Admin...ilanguageValidateModel>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?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 the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Bug introduced 2018-08-05 13:05 UTC by Report Bug Copy Issue Report The method `getKeyToMainModel` does only exist in `Itstructure\AdminModule\models\MultilanguageTrait`, but not in `yii\db\ActiveRecord`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /* * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
264
265			'message' => isset($fieldRule['message']) ?
266			$fieldRule['message'] : 'Record with such attribute "{attribute}" already exists'
267			]
268			);
269			}
270
271			$rules[] = ArrayHelper::merge(
272			[$fieldName . '_' . $language],
273			$fieldRule
274			);
275			}
276			}
277			}
278
279			return $rules;
280			}
281
282			/**
283			* Returns the list of available languages in the short name format.
284			*
285			* @return array
286			*/
287			private function getShortLanguageList(): array
288			{
289			return Language::getShortLanguageList();
290			}
291			}
292

itstructure / yii2-admin-module

Push — master ( a1e0c4...aac760 )

MultilanguageValidateModel::setMainModel() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like