Searchable::findRole() - Code Metrics - andrey-helldar/laravel-roles - Measure and Improve Code Quality continuously with Scrutinizer

Searchable::findRole() A
last analyzed 2020-09-24 11:24 UTC

↳ Parent: Searchable

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Helldar\Roles\Traits;

use Closure;
use Helldar\Roles\Exceptions\Core\PermissionNotFoundException;
use Helldar\Roles\Exceptions\Core\RoleNotFoundException;
use Helldar\Roles\Facades\Database\Search;
use Helldar\Roles\Models\Permission;
use Helldar\Roles\Models\Role;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

trait Searchable
{
    /**
     * @param  \Helldar\Roles\Models\Role|string  $role
     *
     * @throws \Throwable
     *
     * @return \Illuminate\Database\Eloquent\Model
     */
    protected function findRole($role)
    {
        return $this->findObject(Role::class, $role, RoleNotFoundException::class);
    }

    /**
     * @param  \Helldar\Roles\Models\Permission|string  $permission
     *
     * @throws \Throwable
     *
     * @return \Illuminate\Database\Eloquent\Model
     */
    protected function findPermission($permission)
    {
        return $this->findObject(Permission::class, $permission, PermissionNotFoundException::class);
    }

    /**
     * @param  \Illuminate\Database\Eloquent\Model|string  $model
     * @param  mixed  $value
     * @param  string  $exception
     *
     * @throws \Throwable
     *
     * @return \Illuminate\Database\Eloquent\Model
     */
    protected function findObject(string $model, $value, string $exception)
    {
        if ($value instanceof $model) {
            return $value;
        }

        return $this->searchOr($model, $value, function () use ($exception, $value) {
            throw new $exception($value);
        });
    }

    /**
     * @param  \Helldar\Roles\Models\BaseModel|string  $model
     * @param  mixed  $value
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    protected function searchBuilder($model, $value): Builder
    {
        return Search::by($model::query(), $value);

    }

    /**
     * @param  \Illuminate\Database\Eloquent\Model|string  $model
     * @param  mixed  $value
     *
     * @return bool
     */
    protected function searchExist($model, $value): bool
    {
        return $this->searchBuilder($model, $value)->exists();

    }

    /**
     * @param  \Illuminate\Database\Eloquent\Model|string  $model
     * @param  mixed  $value
     * @param  \Closure  $callback
     *
     * @return \Illuminate\Database\Eloquent\Model
     */
    protected function searchOr($model, $value, Closure $callback): Model
    {
        return $this->searchBuilder($model, $value)->firstOr(['*'], $callback);
    }
}


1		<?php
2
3		namespace Helldar\Roles\Traits;
4
5		use Closure;
6		use Helldar\Roles\Exceptions\Core\PermissionNotFoundException;
7		use Helldar\Roles\Exceptions\Core\RoleNotFoundException;
8		use Helldar\Roles\Facades\Database\Search;
9		use Helldar\Roles\Models\Permission;
10		use Helldar\Roles\Models\Role;
11		use Illuminate\Database\Eloquent\Builder;
12		use Illuminate\Database\Eloquent\Model;
13
14		trait Searchable
15		{
16		/**
17		* @param \Helldar\Roles\Models\Role\|string $role
18		*
19		* @throws \Throwable
20		*
21		* @return \Illuminate\Database\Eloquent\Model
22		*/
23	30	protected function findRole($role)
24		{
25	30	return $this->findObject(Role::class, $role, RoleNotFoundException::class);
26		}
27
28		/**
29		* @param \Helldar\Roles\Models\Permission\|string $permission
30		*
31		* @throws \Throwable
32		*
33		* @return \Illuminate\Database\Eloquent\Model
34		*/
35	24	protected function findPermission($permission)
36		{
37	24	return $this->findObject(Permission::class, $permission, PermissionNotFoundException::class);
38		}
39
40		/**
41		* @param \Illuminate\Database\Eloquent\Model\|string $model
42		* @param mixed $value
43		* @param string $exception
44		*
45		* @throws \Throwable
46		*
47		* @return \Illuminate\Database\Eloquent\Model
48		*/
49	54	protected function findObject(string $model, $value, string $exception)
50		{
51	54	if ($value instanceof $model) {
52		return $value;
53		}
54
55		return $this->searchOr($model, $value, function () use ($exception, $value) {
56		throw new $exception($value);
57	54	});
58		}
59
60		/**
61		* @param \Helldar\Roles\Models\BaseModel\|string $model
62		* @param mixed $value
63		*
64		* @return \Illuminate\Database\Eloquent\Builder
65		*/
66	54	protected function searchBuilder($model, $value): Builder
67		{
68	54	return Search::by($model::query(), $value);
		0 ignored issues – show Bug Best Practice introduced 2020-06-10 21:26 UTC by Report Bug Copy Issue Report The expression `return Helldar\Roles\Fac...model::query(), $value)` could return the type `Illuminate\Database\Eloquent\Relations\Relation` which is incompatible with the type-hinted return `Illuminate\Database\Eloquent\Builder`. Consider adding an additional type-check to rule them out. Loading history...
69		}
70
71		/**
72		* @param \Illuminate\Database\Eloquent\Model\|string $model
73		* @param mixed $value
74		*
75		* @return bool
76		*/
77		protected function searchExist($model, $value): bool
78		{
79		return $this->searchBuilder($model, $value)->exists();
		0 ignored issues – show Bug Best Practice introduced 2020-06-04 13:59 UTC by Report Bug Copy Issue Report The expression `return $this->searchBuil...odel, $value)->exists()` could return the type `Illuminate\Database\Eloquent\Builder` which is incompatible with the type-hinted return `boolean`. Consider adding an additional type-check to rule them out. Loading history...
80		}
81
82		/**
83		* @param \Illuminate\Database\Eloquent\Model\|string $model
84		* @param mixed $value
85		* @param \Closure $callback
86		*
87		* @return \Illuminate\Database\Eloquent\Model
88		*/
89	54	protected function searchOr($model, $value, Closure $callback): Model
90		{
91	54	return $this->searchBuilder($model, $value)->firstOr(['*'], $callback);
92		}
93		}
94

andrey-helldar / laravel-roles

Searchable::findRole() A last analyzed 2020-09-24 11:24 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Searchable::findRole() A
last analyzed 2020-09-24 11:24 UTC