Role::slugify() - Code Metrics - Inspection of "Merge pull request #13 from ARCANEDEV/patch-slug_s..." - ARCANEDEV/LaravelAuth - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d42b43...5ac77a )

by ARCANEDEV

created 2016-09-25 18:26 UTC

Role::slugify() A

↳ Parent: Role

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php namespace Arcanedev\LaravelAuth\Models;

use Arcanedev\LaravelAuth\Bases\Model;
use Arcanedev\LaravelAuth\Models\Relationships\RoleRelationships;
use Arcanedev\LaravelAuth\Traits\Activatable;
use Arcanesoft\Contracts\Auth\Models\Permission as PermissionContract;
use Arcanesoft\Contracts\Auth\Models\Role as RoleContract;
use Illuminate\Database\Eloquent\Model as Eloquent;
use Illuminate\Support\Str;

/**
 * Class     Role
 *
 * @package  Arcanedev\LaravelAuth\Models
 * @author   ARCANEDEV <[email protected]>
 *
 * @property  int                                       id
 * @property  string                                    name
 * @property  string                                    slug
 * @property  string                                    description
 * @property  bool                                      is_active
 * @property  bool                                      is_locked
 * @property  \Carbon\Carbon                            created_at
 * @property  \Carbon\Carbon                            updated_at
 * @property  \Illuminate\Database\Eloquent\Collection  users
 * @property  \Illuminate\Database\Eloquent\Collection  permissions
 */
class Role extends Model implements RoleContract
{
    /* ------------------------------------------------------------------------------------------------
     |  Traits
     | ------------------------------------------------------------------------------------------------
     */
    use RoleRelationships, Activatable;

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

    /**
     * The attributes that should be casted to native types.
     *
     * @var array
     */
    protected $casts = [
        'is_active' => 'boolean',
        'is_locked' => 'boolean',
    ];

    /* ------------------------------------------------------------------------------------------------
     |  Constructor
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Create a new Eloquent model instance.
     *
     * @param  array  $attributes
     */
    public function __construct(array $attributes = [])
    {
        $this->setTable(config('laravel-auth.roles.table', 'roles'));

        parent::__construct($attributes);
    }

    /* ------------------------------------------------------------------------------------------------
     |  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'] = $this->slugify($slug);
    }

    /* ------------------------------------------------------------------------------------------------
     |  CRUD Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Attach a permission to a role.
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\User|int  $user
     * @param  bool                                        $reload
     */
    public function attachUser($user, $reload = true)
    {
        if ( ! $this->hasUser($user)) {
            $this->users()->attach($user);
            $this->loadUsers($reload);
        }
    }

    /**
     * Detach a user from a role.
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\User|int  $user
     * @param  bool                                        $reload
     *
     * @return int
     */
    public function detachUser($user, $reload = true)
    {
        if ($user instanceof Eloquent)
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $user = (array) $user->getKey();

        $result = $this->users()->detach($user);
        $this->loadUsers($reload);

        return $result;
    }

    /**
     * Detach all users from a role.
     *
     * @param  bool  $reload
     *
     * @return int
     */
    public function detachAllUsers($reload = true)
    {
        $result = $this->users()->detach();
        $this->loadUsers($reload);

        return $result;
    }

    /**
     * Check if role has the given user (User Model or Id).
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\User|int  $id
     *
     * @return bool
     */
    public function hasUser($id)
    {
        if ($id instanceof Eloquent)
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $id = $id->getKey();

        return $this->users->contains($id);
    }

    /**
     * Attach a permission to a role.
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\Permission|int  $permission
     * @param  bool                                              $reload
     */
    public function attachPermission($permission, $reload = true)
    {
        if ( ! $this->hasPermission($permission)) {
            $this->permissions()->attach($permission);
            $this->loadPermissions($reload);
        }
    }

    /**
     * Detach a permission from a role.
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\Permission|int  $permission
     * @param  bool                                              $reload
     *
     * @return int
     */
    public function detachPermission($permission, $reload = true)
    {
        if ($permission instanceof Eloquent)
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $permission = (array) $permission->getKey();

        $result = $this->permissions()->detach($permission);
        $this->loadPermissions($reload);

        return $result;
    }

    /**
     * Detach all permissions from a role.
     *
     * @param  bool  $reload
     *
     * @return int
     */
    public function detachAllPermissions($reload = true)
    {
        $result = $this->permissions()->detach();
        $this->loadPermissions($reload);

        return $result;
    }

    /**
     * Check if role has the given permission (Permission Model or Id).
     *
     * @param  mixed  $id
     *
     * @return bool
     */
    public function hasPermission($id)
    {
        if ($id instanceof Eloquent)
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $id = $id->getKey();

        return $this->permissions->contains($id);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Check Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Check if role is associated with a permission by slug.
     *
     * @param  string  $slug
     *
     * @return bool
     */
    public function can($slug)
    {
        $permissions = $this->permissions->filter(function(PermissionContract $permission) use ($slug) {
            return $permission->checkSlug($slug);
        });

        return $permissions->count() === 1;
    }

    /**
     * Check if a role is associated with any of given permissions.
     *
     * @param  array  $permissions
     * @param  array  &$failedPermissions
     *
     * @return bool
     */
    public function canAny(array $permissions, array &$failedPermissions = [])
    {
        foreach ($permissions as $permission) {
            if ( ! $this->can($permission))
                $failedPermissions[] = $permission;
        }

        return count($permissions) !== count($failedPermissions);
    }

    /**
     * Check if role is associated with all given permissions.
     *
     * @param  array  $permissions
     * @param  array  &$failedPermissions
     *
     * @return bool
     */
    public function canAll(array $permissions, array &$failedPermissions = [])
    {
        $this->canAny($permissions, $failedPermissions);

        return count($failedPermissions) === 0;
    }

    /**
     * Check if the role is locked.
     *
     * @return bool
     */
    public function isLocked()
    {
        return $this->is_locked;
    }

    /**
     * Check if slug is the same as the given value.
     *
     * @param  string  $value
     *
     * @return bool
     */
    public function checkSlug($value)
    {
        return $this->slug === $this->slugify($value);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Load the users.
     *
     * @param  bool  $load
     *
     * @return self
     */
    protected function loadUsers($load = true)
    {
        return $load ? $this->load('users') : $this;
    }

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

    /**
     * Slugify the value.
     *
     * @param  string  $value
     *
     * @return string
     */
    protected function slugify($value)
    {
        return Str::slug($value, config('laravel-auth.roles.slug-separator', '-'));
    }
}


Push — master ( d42b43...5ac77a )

Role::slugify() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1		<?php namespace Arcanedev\LaravelAuth\Models;
2
3		use Arcanedev\LaravelAuth\Bases\Model;
4		use Arcanedev\LaravelAuth\Models\Relationships\RoleRelationships;
5		use Arcanedev\LaravelAuth\Traits\Activatable;
6		use Arcanesoft\Contracts\Auth\Models\Permission as PermissionContract;
7		use Arcanesoft\Contracts\Auth\Models\Role as RoleContract;
8		use Illuminate\Database\Eloquent\Model as Eloquent;
9		use Illuminate\Support\Str;
10
11		/**
12		* Class Role
13		*
14		* @package Arcanedev\LaravelAuth\Models
15		* @author ARCANEDEV <[email protected]>
16		*
17		* @property int id
18		* @property string name
19		* @property string slug
20		* @property string description
21		* @property bool is_active
22		* @property bool is_locked
23		* @property \Carbon\Carbon created_at
24		* @property \Carbon\Carbon updated_at
25		* @property \Illuminate\Database\Eloquent\Collection users
26		* @property \Illuminate\Database\Eloquent\Collection permissions
27		*/
28		class Role extends Model implements RoleContract
29		{
30		/* ------------------------------------------------------------------------------------------------
31		\| Traits
32		\| ------------------------------------------------------------------------------------------------
33		*/
34		use RoleRelationships, Activatable;
35
36		/* ------------------------------------------------------------------------------------------------
37		\| Properties
38		\| ------------------------------------------------------------------------------------------------
39		*/
40		/**
41		* The attributes that are mass assignable.
42		*
43		* @var array
44		*/
45		protected $fillable = ['name', 'slug', 'description'];
46
47		/**
48		* The attributes that should be casted to native types.
49		*
50		* @var array
51		*/
52		protected $casts = [
53		'is_active' => 'boolean',
54		'is_locked' => 'boolean',
55		];
56
57		/* ------------------------------------------------------------------------------------------------
58		\| Constructor
59		\| ------------------------------------------------------------------------------------------------
60		*/
61		/**
62		* Create a new Eloquent model instance.
63		*
64		* @param array $attributes
65		*/
66	528	public function __construct(array $attributes = [])
67		{
68	528	$this->setTable(config('laravel-auth.roles.table', 'roles'));
69
70	528	parent::__construct($attributes);
71	528	}
72
73		/* ------------------------------------------------------------------------------------------------
74		\| Getters & Setters
75		\| ------------------------------------------------------------------------------------------------
76		*/
77		/**
78		* Set the name attribute.
79		*
80		* @param string $name
81		*/
82	224	public function setNameAttribute($name)
83		{
84	224	$this->attributes['name'] = $name;
85	224	$this->setSlugAttribute($name);
86	224	}
87
88		/**
89		* Set the slug attribute.
90		*
91		* @param string $slug
92		*/
93	224	public function setSlugAttribute($slug)
94		{
95	224	$this->attributes['slug'] = $this->slugify($slug);
96	224	}
97
98		/* ------------------------------------------------------------------------------------------------
99		\| CRUD Functions
100		\| ------------------------------------------------------------------------------------------------
101		*/
102		/**
103		* Attach a permission to a role.
104		*
105		* @param \Arcanesoft\Contracts\Auth\Models\User\|int $user
106		* @param bool $reload
107		*/
108	24	public function attachUser($user, $reload = true)
109		{
110	24	if ( ! $this->hasUser($user)) {
111	24	$this->users()->attach($user);
112	24	$this->loadUsers($reload);
113	18	}
114	24	}
115
116		/**
117		* Detach a user from a role.
118		*
119		* @param \Arcanesoft\Contracts\Auth\Models\User\|int $user
120		* @param bool $reload
121		*
122		* @return int
123		*/
124	8	public function detachUser($user, $reload = true)
125		{
126	8	if ($user instanceof Eloquent)
		0 ignored issues – show Bug introduced 2015-12-27 20:26 UTC by Report Bug Copy Issue Report The class `Illuminate\Database\Eloquent\Model` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
127	8	$user = (array) $user->getKey();
128	6
129		$result = $this->users()->detach($user);
130	8	$this->loadUsers($reload);
131	8
132		return $result;
133	8	}
134
135		/**
136		* Detach all users from a role.
137		*
138		* @param bool $reload
139		*
140		* @return int
141		*/
142		public function detachAllUsers($reload = true)
143	8	{
144		$result = $this->users()->detach();
145	8	$this->loadUsers($reload);
146	8
147		return $result;
148	8	}
149
150		/**
151		* Check if role has the given user (User Model or Id).
152		*
153		* @param \Arcanesoft\Contracts\Auth\Models\User\|int $id
154		*
155		* @return bool
156		*/
157		public function hasUser($id)
158	24	{
159		if ($id instanceof Eloquent)
		0 ignored issues – show Bug introduced 2015-12-27 20:26 UTC by Report Bug Copy Issue Report The class `Illuminate\Database\Eloquent\Model` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
160	24	$id = $id->getKey();
161	24
162	18	return $this->users->contains($id);
163		}
164	24
165		/**
166		* Attach a permission to a role.
167		*
168		* @param \Arcanesoft\Contracts\Auth\Models\Permission\|int $permission
169		* @param bool $reload
170		*/
171		public function attachPermission($permission, $reload = true)
172		{
173	72	if ( ! $this->hasPermission($permission)) {
174		$this->permissions()->attach($permission);
175	72	$this->loadPermissions($reload);
176	72	}
177	72	}
178	54
179	72	/**
180		* Detach a permission from a role.
181		*
182		* @param \Arcanesoft\Contracts\Auth\Models\Permission\|int $permission
183		* @param bool $reload
184		*
185		* @return int
186		*/
187		public function detachPermission($permission, $reload = true)
188		{
189	8	if ($permission instanceof Eloquent)
		0 ignored issues – show Bug introduced 2015-12-27 20:26 UTC by Report Bug Copy Issue Report The class `Illuminate\Database\Eloquent\Model` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
190		$permission = (array) $permission->getKey();
191	8
192	8	$result = $this->permissions()->detach($permission);
193	6	$this->loadPermissions($reload);
194
195	8	return $result;
196	8	}
197
198	8	/**
199		* Detach all permissions from a role.
200		*
201		* @param bool $reload
202		*
203		* @return int
204		*/
205		public function detachAllPermissions($reload = true)
206		{
207		$result = $this->permissions()->detach();
208	8	$this->loadPermissions($reload);
209
210	8	return $result;
211	8	}
212
213	8	/**
214		* Check if role has the given permission (Permission Model or Id).
215		*
216		* @param mixed $id
217		*
218		* @return bool
219		*/
220		public function hasPermission($id)
221		{
222		if ($id instanceof Eloquent)
		0 ignored issues – show Bug introduced 2016-09-25 17:55 UTC by Report Bug Copy Issue Report The class `Illuminate\Database\Eloquent\Model` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
223	72	$id = $id->getKey();
224
225	72	return $this->permissions->contains($id);
226	72	}
227	54
228		/* ------------------------------------------------------------------------------------------------
229	72	\| Check Functions
230		\| ------------------------------------------------------------------------------------------------
231		*/
232		/**
233		* Check if role is associated with a permission by slug.
234		*
235		* @param string $slug
236		*
237		* @return bool
238		*/
239		public function can($slug)
240		{
241		$permissions = $this->permissions->filter(function(PermissionContract $permission) use ($slug) {
242		return $permission->checkSlug($slug);
243		});
244
245	24	return $permissions->count() === 1;
246	24	}
247	24
248		/**
249	24	* Check if a role is associated with any of given permissions.
250		*
251		* @param array $permissions
252		* @param array &$failedPermissions
253		*
254		* @return bool
255		*/
256		public function canAny(array $permissions, array &$failedPermissions = [])
257		{
258		foreach ($permissions as $permission) {
259		if ( ! $this->can($permission))
260	16	$failedPermissions[] = $permission;
261		}
262	16
263	16	return count($permissions) !== count($failedPermissions);
264	16	}
265	12
266	12	/**
267		* Check if role is associated with all given permissions.
268	16	*
269		* @param array $permissions
270		* @param array &$failedPermissions
271		*
272		* @return bool
273		*/
274		public function canAll(array $permissions, array &$failedPermissions = [])
275		{
276		$this->canAny($permissions, $failedPermissions);
277
278		return count($failedPermissions) === 0;
279	8	}
280
281	8	/**
282		* Check if the role is locked.
283	8	*
284		* @return bool
285		*/
286		public function isLocked()
287		{
288		return $this->is_locked;
289		}
290
291	16	/**
292		* Check if slug is the same as the given value.
293	16	*
294		* @param string $value
295		*
296		* @return bool
297		*/
298		public function checkSlug($value)
299		{
300		return $this->slug === $this->slugify($value);
301		}
302
303		/* ------------------------------------------------------------------------------------------------
304		\| Other Functions
305		\| ------------------------------------------------------------------------------------------------
306		*/
307	24	/**
308		* Load the users.
309	24	*
310		* @param bool $load
311		*
312		* @return self
313		*/
314		protected function loadUsers($load = true)
315		{
316		return $load ? $this->load('users') : $this;
317		}
318
319	72	/**
320		* Load the permissions.
321	72	*
322		* @param bool $load
323		*
324		* @return self
325		*/
326		protected function loadPermissions($load = true)
327		{
328		return $load ? $this->load('permissions') : $this;
329		}
330
331		/**
332		* Slugify the value.
333		*
334		* @param string $value
335		*
336		* @return string
337		*/
338		protected function slugify($value)
339		{
340		return Str::slug($value, config('laravel-auth.roles.slug-separator', '-'));
341		}
342		}
343

ARCANEDEV / LaravelAuth

Push — master ( d42b43...5ac77a )

Role::slugify() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like