PermissionsGroup - Code Metrics - ARCANEDEV/LaravelAuth - Measure and Improve Code Quality continuously with Scrutinizer

PermissionsGroup A
last analyzed 2018-09-06 12:49 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	316
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	15

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	23
lcom	2
cbo	15
dl	0
loc	316
rs	10
c	0
b	0
f	0
ccs	77
cts	77
cp	1

16 Methods

Rating	Name	Size	Complexity
A	__construct()	8	1
A	permissions()	7	1
A	setNameAttribute()	5	1
A	setSlugAttribute()	4	1
A	createPermission()	6	1
A	attachPermission()	10	2
A	attachPermissionById()	9	2
A	attachPermissions()	10	1
A	detachPermission()	14	2
A	detachPermissionById()	7	2
A	detachPermissions()	10	1
A	detachAllPermissions()	10	1
A	hasPermission()	6	2
A	getPermissionFromGroup()	12	2
A	getPermissionById()	4	1
A	loadPermissions()	4	2

<?php namespace Arcanedev\LaravelAuth\Models;

use Arcanedev\LaravelAuth\Events\PermissionsGroups\{
    AttachedPermissionsToGroup, AttachedPermissionToGroup, AttachingPermissionsToGroup, AttachingPermissionToGroup,
    CreatedPermissionsGroup, CreatingPermissionsGroup, DeletedPermissionsGroup, DeletingPermissionsGroup,
    DetachedAllPermissions, DetachedPermissionFromGroup, DetachedPermissionsFromGroup, DetachingAllPermissions,
    DetachingPermissionFromGroup, DetachingPermissionsFromGroup, SavedPermissionsGroup, SavingPermissionsGroup,
    UpdatedPermissionsGroup, UpdatingPermissionsGroup
};
use Arcanesoft\Contracts\Auth\Models\Permission as PermissionContract;
use Arcanesoft\Contracts\Auth\Models\PermissionsGroup as PermissionsGroupContract;
use Illuminate\Database\Eloquent\Model as Eloquent;
use Illuminate\Support\Str;

/**
 * Class     PermissionsGroup
 *
 * @package  Arcanedev\LaravelAuth\Models
 * @author   ARCANEDEV <[email protected]>
 *
 * @property  int                                       id
 * @property  string                                    name
 * @property  string                                    slug
 * @property  string                                    description
 * @property  \Carbon\Carbon                            created_at
 * @property  \Carbon\Carbon                            updated_at
 * @property  \Illuminate\Database\Eloquent\Collection  permissions
 */
class PermissionsGroup extends AbstractModel implements PermissionsGroupContract
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = ['name', 'slug', 'description'];

    /**
     * The event map for the model.
     *
     * @var array
     */
    protected $dispatchesEvents = [
        'creating' => CreatingPermissionsGroup::class,
        'created'  => CreatedPermissionsGroup::class,
        'updating' => UpdatingPermissionsGroup::class,
        'updated'  => UpdatedPermissionsGroup::class,
        'saving'   => SavingPermissionsGroup::class,
        'saved'    => SavedPermissionsGroup::class,
        'deleting' => DeletingPermissionsGroup::class,
        'deleted'  => DeletedPermissionsGroup::class,
    ];

    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'id' => 'integer',
    ];

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Create a new Eloquent model instance.
     *
     * @param  array  $attributes
     */
    public function __construct(array $attributes = [])
    {
        parent::__construct($attributes);

        $this->setTable(
            config('laravel-auth.permissions-groups.table', 'permissions_groups')
        );
    }

    /* -----------------------------------------------------------------
     |  Relationships
     | -----------------------------------------------------------------
     */

    /**
     * Permissions Groups has many permissions.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function permissions()
    {
        return $this->hasMany(
            config('laravel-auth.permissions.model', Permission::class),
            'group_id'
        );
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Set the name attribute.
     *
     * @param  string  $name
     */
    public function setNameAttribute($name)
    {
        $this->attributes['name'] = $name;
        $this->setSlugAttribute($name);
    }

    /**
     * Set the slug attribute.
     *
     * @param  string  $slug
     */
    public function setSlugAttribute($slug)
    {
        $this->attributes['slug'] = Str::slug($slug, config('laravel-auth.permissions-groups.slug-separator', '-'));
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Create and attach a permission.
     *
     * @param  array  $attributes
     * @param  bool   $reload
     */
    public function createPermission(array $attributes, $reload = true)
    {
        $this->permissions()->create($attributes);

        $this->loadPermissions($reload);
    }

    /**
     * Attach the permission to a group.
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\Permission  $permission
     * @param  bool                                          $reload
     */
    public function attachPermission(&$permission, $reload = true)
    {
        if ($this->hasPermission($permission)) return;

        event(new AttachingPermissionToGroup($this, $permission));
        $permission = $this->permissions()->save($permission);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        event(new AttachedPermissionToGroup($this, $permission));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $this->loadPermissions($reload);
    }

    /**
     * Attach the permission by id to a group.
     *
     * @param  int   $id
     * @param  bool  $reload
     *
     * @return \Arcanesoft\Contracts\Auth\Models\Permission|null
     */
    public function attachPermissionById($id, $reload = true)
    {
        $permission = $this->getPermissionById($id);

        if ($permission !== null)
            $this->attachPermission($permission, $reload);

        return $permission;
    }

    /**
     * Attach a collection of permissions to the group.
     *
     * @param  \Illuminate\Database\Eloquent\Collection|array  $permissions
     * @param  bool                                            $reload
     *
     * @return \Illuminate\Database\Eloquent\Collection|array
     */
    public function attachPermissions($permissions, $reload = true)
    {
        event(new AttachingPermissionsToGroup($this, $permissions));
        $permissions = $this->permissions()->saveMany($permissions);
        event(new AttachedPermissionsToGroup($this, $permissions));
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        $this->loadPermissions($reload);

        return $permissions;
    }

    /**
     * Attach the permission from a group.
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\Permission  $permission
     * @param  bool                                          $reload
     */
    public function detachPermission(&$permission, $reload = true)
    {
        if ( ! $this->hasPermission($permission))
            return;

        /** @var  \Arcanesoft\Contracts\Auth\Models\Permission  $permission */
        $permission = $this->getPermissionFromGroup($permission);

        event(new DetachingPermissionFromGroup($this, $permission));
        $permission->update(['group_id' => 0]);
        event(new DetachedPermissionFromGroup($this, $permission));

        $this->loadPermissions($reload);
    }

    /**
     * Attach the permission by id to a group.
     *
     * @param  int   $id
     * @param  bool  $reload
     *
     * @return \Arcanesoft\Contracts\Auth\Models\Permission
     */
    public function detachPermissionById($id, $reload = true)
    {
        if ( ! is_null($permission = $this->getPermissionById($id)))
            $this->detachPermission($permission, $reload);

        return $permission;
    }

    /**
     * Detach multiple permissions by ids.
     *
     * @param  array  $ids
     * @param  bool   $reload
     *
     * @return int
     */
    public function detachPermissions(array $ids, $reload = true)
    {
        event(new DetachingPermissionsFromGroup($this, $ids));
        $detached = $this->permissions()->whereIn('id', $ids)->update(['group_id' => 0]);
        event(new DetachedPermissionsFromGroup($this, $ids, $detached));

        $this->loadPermissions($reload);

        return $detached;
    }

    /**
     * Detach all permissions from the group.
     *
     * @param  bool  $reload
     *
     * @return int
     */
    public function detachAllPermissions($reload = true)
    {
        event(new DetachingAllPermissions($this));
        $detached = $this->permissions()->update(['group_id' => 0]);
        event(new DetachedAllPermissions($this, $detached));

        $this->loadPermissions($reload);

        return $detached;
    }

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check if role has the given permission (Permission Model or Id).
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\Permission|int  $id
     *
     * @return bool
     */
    public function hasPermission($id)
    {
        if ($id instanceof Eloquent) $id = $id->getKey();

        return $this->getPermissionFromGroup($id) !== null;
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get a permission from the group.
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\Permission|int  $id
     *
     * @return \Arcanesoft\Contracts\Auth\Models\Permission|null
     */
    private function getPermissionFromGroup($id)
    {
        if ($id instanceof Eloquent) $id = $id->getKey();

        $this->loadPermissions();

        return $this->permissions
            ->filter(function (PermissionContract $permission) use ($id) {
                return $permission->getKey() == $id;
            })
            ->first();
    }

    /**
     * Get a permission by id.
     *
     * @param  int  $id
     *
     * @return \Arcanesoft\Contracts\Auth\Models\Permission|null
     */
    private function getPermissionById($id)
    {
        return $this->permissions()->getRelated()->where('id', $id)->first();
    }

    /**
     * Load the permissions.
     *
     * @param  bool  $load
     *
     * @return self
     */
    protected function loadPermissions($load = true)
    {
        return $load ? $this->load('permissions') : $this;
    }
}


1		<?php namespace Arcanedev\LaravelAuth\Models;
2
3		use Arcanedev\LaravelAuth\Events\PermissionsGroups\{
4		AttachedPermissionsToGroup, AttachedPermissionToGroup, AttachingPermissionsToGroup, AttachingPermissionToGroup,
5		CreatedPermissionsGroup, CreatingPermissionsGroup, DeletedPermissionsGroup, DeletingPermissionsGroup,
6		DetachedAllPermissions, DetachedPermissionFromGroup, DetachedPermissionsFromGroup, DetachingAllPermissions,
7		DetachingPermissionFromGroup, DetachingPermissionsFromGroup, SavedPermissionsGroup, SavingPermissionsGroup,
8		UpdatedPermissionsGroup, UpdatingPermissionsGroup
9		};
10		use Arcanesoft\Contracts\Auth\Models\Permission as PermissionContract;
11		use Arcanesoft\Contracts\Auth\Models\PermissionsGroup as PermissionsGroupContract;
12		use Illuminate\Database\Eloquent\Model as Eloquent;
13		use Illuminate\Support\Str;
14
15		/**
16		* Class PermissionsGroup
17		*
18		* @package Arcanedev\LaravelAuth\Models
19		* @author ARCANEDEV <[email protected]>
20		*
21		* @property int id
22		* @property string name
23		* @property string slug
24		* @property string description
25		* @property \Carbon\Carbon created_at
26		* @property \Carbon\Carbon updated_at
27		* @property \Illuminate\Database\Eloquent\Collection permissions
28		*/
29		class PermissionsGroup extends AbstractModel implements PermissionsGroupContract
30		{
31		/* -----------------------------------------------------------------
32		\| Properties
33		\| -----------------------------------------------------------------
34		*/
35
36		/**
37		* The attributes that are mass assignable.
38		*
39		* @var array
40		*/
41		protected $fillable = ['name', 'slug', 'description'];
42
43		/**
44		* The event map for the model.
45		*
46		* @var array
47		*/
48		protected $dispatchesEvents = [
49		'creating' => CreatingPermissionsGroup::class,
50		'created' => CreatedPermissionsGroup::class,
51		'updating' => UpdatingPermissionsGroup::class,
52		'updated' => UpdatedPermissionsGroup::class,
53		'saving' => SavingPermissionsGroup::class,
54		'saved' => SavedPermissionsGroup::class,
55		'deleting' => DeletingPermissionsGroup::class,
56		'deleted' => DeletedPermissionsGroup::class,
57		];
58
59		/**
60		* The attributes that should be cast to native types.
61		*
62		* @var array
63		*/
64		protected $casts = [
65		'id' => 'integer',
66		];
67
68		/* -----------------------------------------------------------------
69		\| Constructor
70		\| -----------------------------------------------------------------
71		*/
72
73		/**
74		* Create a new Eloquent model instance.
75		*
76		* @param array $attributes
77		*/
78	48	public function __construct(array $attributes = [])
79		{
80	48	parent::__construct($attributes);
81
82	48	$this->setTable(
83	48	config('laravel-auth.permissions-groups.table', 'permissions_groups')
84		);
85	48	}
86
87		/* -----------------------------------------------------------------
88		\| Relationships
89		\| -----------------------------------------------------------------
90		*/
91
92		/**
93		* Permissions Groups has many permissions.
94		*
95		* @return \Illuminate\Database\Eloquent\Relations\HasMany
96		*/
97	39	public function permissions()
98		{
99	39	return $this->hasMany(
100	39	config('laravel-auth.permissions.model', Permission::class),
101	39	'group_id'
102		);
103		}
104
105		/* -----------------------------------------------------------------
106		\| Getters & Setters
107		\| -----------------------------------------------------------------
108		*/
109
110		/**
111		* Set the name attribute.
112		*
113		* @param string $name
114		*/
115	39	public function setNameAttribute($name)
116		{
117	39	$this->attributes['name'] = $name;
118	39	$this->setSlugAttribute($name);
119	39	}
120
121		/**
122		* Set the slug attribute.
123		*
124		* @param string $slug
125		*/
126	39	public function setSlugAttribute($slug)
127		{
128	39	$this->attributes['slug'] = Str::slug($slug, config('laravel-auth.permissions-groups.slug-separator', '-'));
129	39	}
130
131		/* -----------------------------------------------------------------
132		\| Main Methods
133		\| -----------------------------------------------------------------
134		*/
135
136		/**
137		* Create and attach a permission.
138		*
139		* @param array $attributes
140		* @param bool $reload
141		*/
142	6	public function createPermission(array $attributes, $reload = true)
143		{
144	6	$this->permissions()->create($attributes);
145
146	6	$this->loadPermissions($reload);
147	6	}
148
149		/**
150		* Attach the permission to a group.
151		*
152		* @param \Arcanesoft\Contracts\Auth\Models\Permission $permission
153		* @param bool $reload
154		*/
155	18	public function attachPermission(&$permission, $reload = true)
156		{
157	18	if ($this->hasPermission($permission)) return;
158
159	18	event(new AttachingPermissionToGroup($this, $permission));
160	18	$permission = $this->permissions()->save($permission);
		0 ignored issues – show Documentation introduced 2015-12-22 15:06 UTC by Report Bug Copy Issue Report `$permission` is of type `object<Arcanesoft\Contra...Auth\Models\Permission>`, but the function expects a `object<Illuminate\Database\Eloquent\Model>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
161	18	event(new AttachedPermissionToGroup($this, $permission));
		0 ignored issues – show Documentation introduced 2018-09-06 12:28 UTC by Report Bug Copy Issue Report `$permission` is of type `object<Illuminate\Database\Eloquent\Model>\|false`, but the function expects a `object<Arcanesoft\Contra...Auth\Models\Permission>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
162
163	18	$this->loadPermissions($reload);
164	18	}
165
166		/**
167		* Attach the permission by id to a group.
168		*
169		* @param int $id
170		* @param bool $reload
171		*
172		* @return \Arcanesoft\Contracts\Auth\Models\Permission\|null
173		*/
174	3	public function attachPermissionById($id, $reload = true)
175		{
176	3	$permission = $this->getPermissionById($id);
177
178	3	if ($permission !== null)
179	3	$this->attachPermission($permission, $reload);
180
181	3	return $permission;
182		}
183
184		/**
185		* Attach a collection of permissions to the group.
186		*
187		* @param \Illuminate\Database\Eloquent\Collection\|array $permissions
188		* @param bool $reload
189		*
190		* @return \Illuminate\Database\Eloquent\Collection\|array
191		*/
192	9	public function attachPermissions($permissions, $reload = true)
193		{
194	9	event(new AttachingPermissionsToGroup($this, $permissions));
195	9	$permissions = $this->permissions()->saveMany($permissions);
196	9	event(new AttachedPermissionsToGroup($this, $permissions));
		0 ignored issues – show Bug introduced 2017-11-16 17:05 UTC by Report Bug Copy Issue Report It seems like `$permissions` defined by `$this->permissions()->saveMany($permissions)` on line `195` can also be of type `object<Traversable>`; however, `Arcanedev\LaravelAuth\Ev...sToGroup::__construct()` does only seem to accept `object<Illuminate\Support\Collection>\|array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
197
198	9	$this->loadPermissions($reload);
199
200	9	return $permissions;
201		}
202
203		/**
204		* Attach the permission from a group.
205		*
206		* @param \Arcanesoft\Contracts\Auth\Models\Permission $permission
207		* @param bool $reload
208		*/
209	9	public function detachPermission(&$permission, $reload = true)
210		{
211	9	if ( ! $this->hasPermission($permission))
212	6	return;
213
214		/** @var \Arcanesoft\Contracts\Auth\Models\Permission $permission */
215	9	$permission = $this->getPermissionFromGroup($permission);
216
217	9	event(new DetachingPermissionFromGroup($this, $permission));
218	9	$permission->update(['group_id' => 0]);
219	9	event(new DetachedPermissionFromGroup($this, $permission));
220
221	9	$this->loadPermissions($reload);
222	9	}
223
224		/**
225		* Attach the permission by id to a group.
226		*
227		* @param int $id
228		* @param bool $reload
229		*
230		* @return \Arcanesoft\Contracts\Auth\Models\Permission
231		*/
232	3	public function detachPermissionById($id, $reload = true)
233		{
234	3	if ( ! is_null($permission = $this->getPermissionById($id)))
235	3	$this->detachPermission($permission, $reload);
236
237	3	return $permission;
238		}
239
240		/**
241		* Detach multiple permissions by ids.
242		*
243		* @param array $ids
244		* @param bool $reload
245		*
246		* @return int
247		*/
248	3	public function detachPermissions(array $ids, $reload = true)
249		{
250	3	event(new DetachingPermissionsFromGroup($this, $ids));
251	3	$detached = $this->permissions()->whereIn('id', $ids)->update(['group_id' => 0]);
252	3	event(new DetachedPermissionsFromGroup($this, $ids, $detached));
253
254	3	$this->loadPermissions($reload);
255
256	3	return $detached;
257		}
258
259		/**
260		* Detach all permissions from the group.
261		*
262		* @param bool $reload
263		*
264		* @return int
265		*/
266	6	public function detachAllPermissions($reload = true)
267		{
268	6	event(new DetachingAllPermissions($this));
269	6	$detached = $this->permissions()->update(['group_id' => 0]);
270	6	event(new DetachedAllPermissions($this, $detached));
271
272	6	$this->loadPermissions($reload);
273
274	6	return $detached;
275		}
276
277		/* -----------------------------------------------------------------
278		\| Check Methods
279		\| -----------------------------------------------------------------
280		*/
281
282		/**
283		* Check if role has the given permission (Permission Model or Id).
284		*
285		* @param \Arcanesoft\Contracts\Auth\Models\Permission\|int $id
286		*
287		* @return bool
288		*/
289	24	public function hasPermission($id)
290		{
291	24	if ($id instanceof Eloquent) $id = $id->getKey();
292
293	24	return $this->getPermissionFromGroup($id) !== null;
294		}
295
296		/* -----------------------------------------------------------------
297		\| Other Methods
298		\| -----------------------------------------------------------------
299		*/
300
301		/**
302		* Get a permission from the group.
303		*
304		* @param \Arcanesoft\Contracts\Auth\Models\Permission\|int $id
305		*
306		* @return \Arcanesoft\Contracts\Auth\Models\Permission\|null
307		*/
308	24	private function getPermissionFromGroup($id)
309		{
310	24	if ($id instanceof Eloquent) $id = $id->getKey();
311
312	24	$this->loadPermissions();
313
314	24	return $this->permissions
315		->filter(function (PermissionContract $permission) use ($id) {
316	24	return $permission->getKey() == $id;
317	24	})
318	24	->first();
319		}
320
321		/**
322		* Get a permission by id.
323		*
324		* @param int $id
325		*
326		* @return \Arcanesoft\Contracts\Auth\Models\Permission\|null
327		*/
328	6	private function getPermissionById($id)
329		{
330	6	return $this->permissions()->getRelated()->where('id', $id)->first();
331		}
332
333		/**
334		* Load the permissions.
335		*
336		* @param bool $load
337		*
338		* @return self
339		*/
340	33	protected function loadPermissions($load = true)
341		{
342	33	return $load ? $this->load('permissions') : $this;
343		}
344		}
345

ARCANEDEV / LaravelAuth

PermissionsGroup A last analyzed 2018-09-06 12:49 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

16 Methods

Duplication Side-by-Side

Filter issues like

PermissionsGroup A
last analyzed 2018-09-06 12:49 UTC