Roles::getByName() - Code Metrics - Inspection of "Hotfix settings section" - bakaphp/phalcon-api - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#22)

by Maximo

created 2018-12-26 05:24 UTC

Roles::getByName() A

↳ Parent: Roles

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	1
dl	0
loc	5
ccs	0
cts	4
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
declare(strict_types=1);

namespace Gewaer\Models;

use Gewaer\Exception\ServerErrorHttpException;
use Baka\Auth\Models\Companies as BakaCompanies;
use Phalcon\Di;
use Phalcon\Validation;
use Phalcon\Validation\Validator\PresenceOf;
use Phalcon\Validation\Validator\StringLength;

class Roles extends AbstractModel
{
    /**
     *
     * @var integer
     */
    public $id;

    /**
     *
     * @var integer
     */
    public $name;

    /**
     *
     * @var integer
     */
    public $description;

    /**
     *
     * @var integer
     */
    public $scope;

    /**
     *
     * @var integer
     */
    public $company_id;

    /**
     *
     * @var int
     */
    public $apps_id;

    /**
     *
     * @var string
     */
    public $created_at;

    /**
     *
     * @var string
     */
    public $updated_at;

    /**
     *
     * @var integer
     */
    public $is_deleted;

    /**
     * Default ACL company
     *
     */
    const DEFAULT_ACL_COMPANY_ID = 0;
    const DEFAULT_ACL_APP_ID = 0;

    /**
     * Initialize method for model.
     */
    public function initialize()
    {
        $this->setSource('roles');

        $this->hasMany(
            'roles_name',
            'Gewaer\Models\Roles',
            'name',
            ['alias' => 'role']
        );
    }

    /**
     * Validations and business logic
     */
    public function validation()
    {
        $validator = new Validation();

        $validator->add(
            'name',
            new PresenceOf([
                'field' => 'name',
                'required' => true,
            ])
        );

        $validator->add(
            'description',
            new PresenceOf([
                'field' => 'description',
                'required' => true,
            ])
        );

        $validator->add(
            'name',
            new StringLength([
                'max' => 32,
                'messageMinimum' => _('Role Name. Maxium 32 characters.'),
            ])
        );

        return $this->validate($validator);
    }

    /**
     * Returns table name mapped in the model.
     *
     * @return string
     */
    public function getSource(): string
    {
        return 'roles';
    }

    /**
     * Get the entity by its name
     *
     * @param string $name
     * @return void
     */
    public static function getByName(string $name)
    {
        return self::findFirst([

            'conditions' => 'name = ?0 AND company_id = ?1 AND apps_id = ?2 AND is_delete = 0',
            'bind' => [$name, Di::getDefault()->getUserData()->default_company, Di::getDefault()->getApp()->getId()]
        ]);
    }

    /**
     * Get the Role by it app name
     *
     * @param string $role
     * @return Roles
     */
    public static function getByAppName(string $role, BakaCompanies $company): Roles
    {
        //echeck if we have a dot , taht means we are sending the specific app to use
        if (strpos($role, '.') === false) {
            throw new ServerErrorHttpException('ACL - We are expecting the app for this role');
        }

        $appRole = explode('.', $role);
        $role = $appRole[1];

        $appName = $appRole[0];

        //look for the app and set it
        if (!$app = Apps::getACLApp($appName)) {
            throw new ServerErrorHttpException('ACL - No app found for this role');
        }

        return self::findFirst([
            'conditions' => 'apps_id in (?0, ?1) AND company_id in (?2 , ?3)',
            'bind' => [$app->getId(), self::DEFAULT_ACL_APP_ID, $company->getId(), self::DEFAULT_ACL_COMPANY_ID]
        ]);
    }
}


1		<?php
2		declare(strict_types=1);
3
4		namespace Gewaer\Models;
5
6		use Gewaer\Exception\ServerErrorHttpException;
7		use Baka\Auth\Models\Companies as BakaCompanies;
8		use Phalcon\Di;
9		use Phalcon\Validation;
10		use Phalcon\Validation\Validator\PresenceOf;
11		use Phalcon\Validation\Validator\StringLength;
12
13		class Roles extends AbstractModel
14		{
15		/**
16		*
17		* @var integer
18		*/
19		public $id;
20
21		/**
22		*
23		* @var integer
24		*/
25		public $name;
26
27		/**
28		*
29		* @var integer
30		*/
31		public $description;
32
33		/**
34		*
35		* @var integer
36		*/
37		public $scope;
38
39		/**
40		*
41		* @var integer
42		*/
43		public $company_id;
44
45		/**
46		*
47		* @var int
48		*/
49		public $apps_id;
50
51		/**
52		*
53		* @var string
54		*/
55		public $created_at;
56
57		/**
58		*
59		* @var string
60		*/
61		public $updated_at;
62
63		/**
64		*
65		* @var integer
66		*/
67		public $is_deleted;
68
69		/**
70		* Default ACL company
71		*
72		*/
73		const DEFAULT_ACL_COMPANY_ID = 0;
74		const DEFAULT_ACL_APP_ID = 0;
75
76		/**
77		* Initialize method for model.
78		*/
79	18	public function initialize()
80		{
81	18	$this->setSource('roles');
82
83	18	$this->hasMany(
84	18	'roles_name',
85	18	'Gewaer\Models\Roles',
86	18	'name',
87	18	['alias' => 'role']
88		);
89	18	}
90
91		/**
92		* Validations and business logic
93		*/
94	2	public function validation()
95		{
96	2	$validator = new Validation();
97
98	2	$validator->add(
99	2	'name',
100	2	new PresenceOf([
101	2	'field' => 'name',
102		'required' => true,
103		])
104		);
105
106	2	$validator->add(
107	2	'description',
108	2	new PresenceOf([
109	2	'field' => 'description',
110		'required' => true,
111		])
112		);
113
114	2	$validator->add(
115	2	'name',
116	2	new StringLength([
117	2	'max' => 32,
118	2	'messageMinimum' => _('Role Name. Maxium 32 characters.'),
119		])
120		);
121
122	2	return $this->validate($validator);
123		}
124
125		/**
126		* Returns table name mapped in the model.
127		*
128		* @return string
129		*/
130	17	public function getSource(): string
131		{
132	17	return 'roles';
133		}
134
135		/**
136		* Get the entity by its name
137		*
138		* @param string $name
139		* @return void
140		*/
141		public static function getByName(string $name)
142		{
143		return self::findFirst([
		0 ignored issues – show Bug Best Practice introduced 2018-12-26 05:29 UTC by Report Bug Copy Issue Report The expression `return self::findFirst(a...)->getApp()->getId())))` returns the type `Phalcon\Mvc\Model` which is incompatible with the documented return type `void`. Loading history...
144		'conditions' => 'name = ?0 AND company_id = ?1 AND apps_id = ?2 AND is_delete = 0',
145		'bind' => [$name, Di::getDefault()->getUserData()->default_company, Di::getDefault()->getApp()->getId()]
146		]);
147		}
148
149		/**
150		* Get the Role by it app name
151		*
152		* @param string $role
153		* @return Roles
154		*/
155	6	public static function getByAppName(string $role, BakaCompanies $company): Roles
156		{
157		//echeck if we have a dot , taht means we are sending the specific app to use
158	6	if (strpos($role, '.') === false) {
159		throw new ServerErrorHttpException('ACL - We are expecting the app for this role');
160		}
161
162	6	$appRole = explode('.', $role);
163	6	$role = $appRole[1];
		1 ignored issue – show Unused Code introduced 2018-11-29 01:47 UTC by Report Bug Copy Issue Report The assignment to `$role` is dead and can be removed. Loading history...
164	6	$appName = $appRole[0];
165
166		//look for the app and set it
167	6	if (!$app = Apps::getACLApp($appName)) {
168		throw new ServerErrorHttpException('ACL - No app found for this role');
169		}
170
171	6	return self::findFirst([
172	6	'conditions' => 'apps_id in (?0, ?1) AND company_id in (?2 , ?3)',
173	6	'bind' => [$app->getId(), self::DEFAULT_ACL_APP_ID, $company->getId(), self::DEFAULT_ACL_COMPANY_ID]
174		]);
175		}
176		}
177

bakaphp / phalcon-api

Pull Request — master (#22)

Roles::getByName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like