ProfileController::getAdditionFields() - Code Metrics - Inspection of "Add formTemplate attribute, add getAdditionFields..." - itstructure/yii2-users-module - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b77654...b3682d )

by Andrey

created 2018-05-20 14:26 UTC

ProfileController::getAdditionFields() C

↳ Parent: ProfileController

Complexity

Conditions	8
Paths	22

Size

Total Lines	34
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	34
rs	5.3846
c	0
b	0
f	0
cc	8
eloc	19
nc	22
nop	0

<?php

namespace Itstructure\UsersModule\controllers;

use yii\base\InvalidConfigException;

/**
 * Class ProfileController
 * ProfileController implements the CRUD actions for identityClass.
 *
 * @package Itstructure\UsersModule\controllers
 */
class ProfileController extends BaseController
{
    /**
     * Initialize.
     * Set validateComponent and additionFields.
     */
    public function init()
    {
        $this->viewPath = '@users/views/profile';

        $this->validateComponent = $this->module->get('profile-validate-component');
<?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.");
        }
    }

}

        parent::init();
    }

    /**
     * Returns addition fields.
     * @return array
     */
    protected function getAdditionFields(): array
    {
        $additionFields = [];

        $additionFields['customRewrite'] = $this->validateComponent->getCustomRewrite();
<?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 ($this->action->id == 'create' || $this->action->id == 'update'){
            $additionFields['additionFields'] = $this->validateComponent->getFormFields();
<?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.");
        }
    }

}

            $additionTemplate = $this->validateComponent->getFormTemplate();
<?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 (is_callable($additionTemplate)){
                $additionTemplate = call_user_func($additionTemplate, $this->getModel());
            }
            if (is_string($additionTemplate)){
                $this->additionFields['additionTemplate'] = $additionTemplate;
            } else {
                throw new InvalidConfigException('Addition template as a result be a string.');
            }

            if ($this->validateComponent->getRbacManage()){
<?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.");
        }
    }

}
                $additionFields['roles'] = $this->validateComponent->getAuthManager()->getRoles();
<?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 ($this->action->id == 'index'){
            $additionFields['indexViewColumns'] = $this->validateComponent->getIndexViewColumns();
<?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 ($this->action->id == 'view'){
            $additionFields['detailViewAttributes'] = $this->validateComponent->getDetailViewAttributes();
<?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.");
        }
    }

}
        }

        return $additionFields;
    }

    /**
     * Returns identityClass model name.
     *
     * @return string
     */
    protected function getModelName():string
    {
        return \Yii::$app->user->identityClass;
    }

    /**
     * Returns identityClass Search model name.
     *
     * @return string
     */
    protected function getSearchModelName():string
    {
        return \Yii::$app->user->identityClass . 'Search';
    }
}


1			<?php
2
3			namespace Itstructure\UsersModule\controllers;
4
5			use yii\base\InvalidConfigException;
6
7			/**
8			* Class ProfileController
9			* ProfileController implements the CRUD actions for identityClass.
10			*
11			* @package Itstructure\UsersModule\controllers
12			*/
13			class ProfileController extends BaseController
14			{
15			/**
16			* Initialize.
17			* Set validateComponent and additionFields.
18			*/
19			public function init()
20			{
21			$this->viewPath = '@users/views/profile';
22
23			$this->validateComponent = $this->module->get('profile-validate-component');
			0 ignored issues – show Documentation introduced 2018-05-12 19:35 UTC by Report Bug Copy Issue Report The property `$validateComponent` is declared private in `Itstructure\UsersModule\controllers\BaseController`. Since you implemented `__set()`, maybe consider adding a @property or @property-write annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
24
25			parent::init();
26			}
27
28			/**
29			* Returns addition fields.
30			* @return array
31			*/
32			protected function getAdditionFields(): array
33			{
34			$additionFields = [];
35
36			$additionFields['customRewrite'] = $this->validateComponent->getCustomRewrite();
			0 ignored issues – show Documentation introduced 2018-05-12 19:35 UTC by Report Bug Copy Issue Report The property `$validateComponent` is declared private in `Itstructure\UsersModule\controllers\BaseController`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
37
38			if ($this->action->id == 'create' \|\| $this->action->id == 'update'){
39			$additionFields['additionFields'] = $this->validateComponent->getFormFields();
			0 ignored issues – show Documentation introduced 2018-05-12 19:35 UTC by Report Bug Copy Issue Report The property `$validateComponent` is declared private in `Itstructure\UsersModule\controllers\BaseController`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
40
41			$additionTemplate = $this->validateComponent->getFormTemplate();
			0 ignored issues – show Documentation introduced 2018-05-20 14:27 UTC by Report Bug Copy Issue Report The property `$validateComponent` is declared private in `Itstructure\UsersModule\controllers\BaseController`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
42			if (is_callable($additionTemplate)){
43			$additionTemplate = call_user_func($additionTemplate, $this->getModel());
44			}
45			if (is_string($additionTemplate)){
46			$this->additionFields['additionTemplate'] = $additionTemplate;
47			} else {
48			throw new InvalidConfigException('Addition template as a result be a string.');
49			}
50
51			if ($this->validateComponent->getRbacManage()){
			0 ignored issues – show Documentation introduced 2018-05-12 19:35 UTC by Report Bug Copy Issue Report The property `$validateComponent` is declared private in `Itstructure\UsersModule\controllers\BaseController`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
52			$additionFields['roles'] = $this->validateComponent->getAuthManager()->getRoles();
			0 ignored issues – show Documentation introduced 2018-05-12 19:35 UTC by Report Bug Copy Issue Report The property `$validateComponent` is declared private in `Itstructure\UsersModule\controllers\BaseController`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
53			}
54			}
55
56			if ($this->action->id == 'index'){
57			$additionFields['indexViewColumns'] = $this->validateComponent->getIndexViewColumns();
			0 ignored issues – show Documentation introduced 2018-05-12 19:35 UTC by Report Bug Copy Issue Report The property `$validateComponent` is declared private in `Itstructure\UsersModule\controllers\BaseController`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
58			}
59
60			if ($this->action->id == 'view'){
61			$additionFields['detailViewAttributes'] = $this->validateComponent->getDetailViewAttributes();
			0 ignored issues – show Documentation introduced 2018-05-12 19:35 UTC by Report Bug Copy Issue Report The property `$validateComponent` is declared private in `Itstructure\UsersModule\controllers\BaseController`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
62			}
63
64			return $additionFields;
65			}
66
67			/**
68			* Returns identityClass model name.
69			*
70			* @return string
71			*/
72			protected function getModelName():string
73			{
74			return \Yii::$app->user->identityClass;
75			}
76
77			/**
78			* Returns identityClass Search model name.
79			*
80			* @return string
81			*/
82			protected function getSearchModelName():string
83			{
84			return \Yii::$app->user->identityClass . 'Search';
85			}
86			}
87

itstructure / yii2-users-module

Push — master ( b77654...b3682d )

ProfileController::getAdditionFields() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like