UserAndLevel::getPermissions() - Code Metrics - Inspection of "code cleanup" - z1haze/laravel-acl - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5b1557...9caaaf )

by Stephen

created 2017-02-25 01:18 UTC

UserAndLevel::getPermissions() A

↳ Parent: UserAndLevel

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	6

Duplication

Lines	10
Ratio	100 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

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

<?php

namespace z1haze\Acl\Traits;

use Illuminate\Support\Collection;
use ReflectionClass;
use z1haze\Acl\Exceptions\PermissionNotFoundException;
use Illuminate\Support\Facades\Cache;
use z1haze\Acl\Models\Level;
use z1haze\Acl\Models\Permission;

trait UserAndLevel
{
    /**
     * USER & LEVEL
     * Check if a model has a given level
     *
     * @param mixed level
     * @return bool
     */
    public function isLevel($level)
    {
        $level = $this->getALevel($level);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return is_a($this, config('laravel-acl.level'), true) ? $this->name == $level->name : $this->level->name == $level->name;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * USER & LEVEL
     * Check if a user has or has inherited
     * a given level
     *
     * @param $level
     * @return bool
     */
    public function hasLevel($level)
    {
        $level = $this->getLevel($level);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return is_a($this, config('laravel-acl.level'), true) ? $this->rank <= $level->rank : $this->level->rank <= $level->rank;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * USER & LEVEL
     * Add a single permission to a model
     *
     * @param $permission
     */
    public function addPermission($permission)
    {
        $this->modifyPermissions([$permission], 'add');
    }

    /**
     * USER & LEVEL
     * Add an array of permissions to a model
     *
     * @param $permissions
     */
    public function addPermissions(array $permissions)
    {
        $this->modifyPermissions($permissions, 'add');
    }

    /**
     * USER & LEVEL
     * Remove a permission from a model
     *
     * @param $permission
     */
    public function removePermission($permission)
    {
        $this->modifyPermissions([$permission], 'remove');
    }

    /**
     * USER & LEVEL
     * Remove an array of permissions objects or permission names (can be mixed)
     *
     * @param $permissions
     */
    public function removePermissions(array $permissions)
    {
        $this->modifyPermissions($permissions, 'remove');
    }

    /**
     * USER & LEVEL
     * Sync permissions on a model
     *
     * @param $permissions
     */
    public function syncPermissions(array $permissions)
    {
        $this->modifyPermissions($permissions, 'sync');
    }

    /**
     * USER & LEVEL
     * Clear permissions from a model
     */
    public function clearPermissions()
    {
        if (is_a($this, config('laravel-acl.user'), true)) {
            $this->permissions()->detach();

        }

        if (is_a($this, config('laravel-acl.level'), true)) {
            config('laravel-acl.permission', Permission::class)::whereLevelId($this->id)->update(['level_id' => null]);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }
    }

    /**
     * USER & LEVEL
     * First try the cache to return the collection,
     * then fetch it from the database.
     *
     * See @cacheGetPermissions()
     *
     * @return \Illuminate\Support\Collection
     */
    public function getPermissions()
    {
        return Cache::remember(
            'laravel-acl.getPermissionsFor' . (new ReflectionClass($this))->getShortName() . '_' . $this->id,
            config('laravel-acl.cacheMinutes'),
            function() {
                return $this->cachegetPermissions();
            }
        );
    }

    /**
     * USER & LEVEL
     * First try the cache to return the collection,
     * then fetch it from the database.
     *
     * See @cacheGetAllPermissions()
     *
     * @return \Illuminate\Support\Collection
     */
    public function getAllPermissions()
    {
        return Cache::remember(
            'laravel-acl.getAllPermissionsFor' . (new ReflectionClass($this))->getShortName() . '_' . $this->id,
            config('laravel-acl.cacheMinutes'),
            function() {
                return $this->cacheGetAllPermissions();
            }
        );
    }

    /**
     * USER & LEVEL
     * First try the cache to return the collection,
     * then fetch it from the database.
     *
     * See @cacheGetInheritedPermissions()
     *
     * @return \Illuminate\Support\Collection
     */
    public function getInheritedPermissions()
    {
        return Cache::remember(
            'laravel-acl.getInheritedPermissionsFor' . (new ReflectionClass($this))->getShortName() . '_' . $this->id,
            config('laravel-acl.cacheMinutes'),
            function() {
                return $this->cacheGetInheritedPermissions();
            }
        );
    }

    /**
     * USER & LEVEL
     * First try the cache to return the collection,
     * then fetch it from the database.
     *
     * See @cacheGetAvailablePermissions()
     *
     * @return \Illuminate\Support\Collection
     */
    public function getAvailablePermissions()
    {
        return Cache::remember(
            'laravel-acl.getAvailablePermissionsFor' . (new ReflectionClass($this))->getShortName() . '_' . $this->id,
            config('laravel-acl.cacheMinutes'),
            function() {
                return $this->cacheGetAvailablePermissions();
            }
        );
    }

    /**
     * USER & LEVEL
     * First try the cache to return the collection,
     * then fetch it from the database.
     *
     * See @cacheHasPermissionTo()
     *
     * @param $permission
     * @return bool
     */
    public function hasPermissionTo($permission)
    {
        return Cache::remember(
            'laravel-acl.hasPermissionTo_' . (new ReflectionClass($this))->getShortName() . '_' . $this->id . '_Permission_' . $permission,
            config('laravel-acl.cacheMinutes'),
            function() use ($permission) {
                return $this->cacheHasPermissionTo($permission);
            }
        );
    }

    /**
     * USER & LEVEL
     * Returns if a level is lower ranking than another level,
     * or if a user is lower ranking than another user.
     *
     * @param $other
     * @return bool
     */
    public function isLowerThan($other)
    {
        return is_a($this, config('laravel-acl.user'), true) ? $this->level->rank > $other->level->rank : $this->rank > $other->rank;
    }

    /**
     * USER & LEVEL
     * Returns if a level is higher ranking than another level,
     * or if a user is higher ranking than another user.
     *
     * @param $other
     * @return bool
     */
    public function isHigherThan($other)
    {
        return is_a($this, config('laravel-acl.user'), true) ? $this->level->rank < $other->level->rank : $this->rank < $other->rank;
    }

    /**
     * USER & LEVEL
     * Returns if a equal is lower ranking than another level,
     * or if a user is equal ranking than another user.
     *
     * @param $other
     * @return bool
     */
    public function isEqualTo($other)
    {
        return is_a($this, config('laravel-acl.user'), true) ? $this->level->rank == $other->level->rank : $this->rank == $other->rank;
    }


    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * USER & LEVEL
     * Return a collection of permissions
     * assigned to a user
     *
     * @return \Illuminate\Support\Collection
     */
    protected function cacheGetPermissions()
    {
        return $this->permissions;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * USER & LEVEL
     * Return a collection of all permissions
     * associated to a user by direct or
     * inheritance
     *
     * @return \Illuminate\Support\Collection
     */
    protected function cacheGetAllPermissions()
    {
        if(is_a($this, config('laravel-acl.level'), true)) {
            $rank = $this->rank;
        } else {
            $rank = $this->level ? $this->level->rank : null;
        }

        if(!$rank) {
            return $this->permissions;
        }

        $levels = config('laravel-acl.level', Level::class)::where('rank', '>=', $rank)->with('permissions')->get();

        $allPerms = new Collection();

        $levels->each(function($level, $key) use (&$allPerms) {

            $allPerms = $allPerms->merge($level->permissions);
        });

        return $allPerms->merge($this->permissions)->unique('id');
    }

    /**
     * USER & LEVEL
     * Return a collection of permissions that
     * are inherited from a higher level
     *
     * @return \Illuminate\Support\Collection
     */
    protected function cacheGetInheritedPermissions()
    {
        $rank = is_a($this, config('laravel-acl.level'), true) ? $this->rank : $this->level->rank;

        $levels = is_a($this, config('laravel-acl.user'), true) ?
            config('laravel-acl.level', Level::class)::where('rank', '>=', $rank)->with('permissions')->get() : config('laravel-acl.level', Level::class)::where('rank', '>', $rank)->with('permissions')->get();

        $inheritedPerms = new Collection();

        $levels->each(function($level, $key) use (&$inheritedPerms) {

            $inheritedPerms = $inheritedPerms->merge($level->permissions->load('level'));
        });

        return $inheritedPerms->unique('id');
    }

    /**
     * USER & LEVEL
     * Return a collection of permissions still able to be assigned
     * ie, not already inherited or explicitly assigned
     *
     * @return \Illuminate\Support\Collection
     */
    protected function cacheGetAvailablePermissions()
    {
        $allPerms = config('laravel-acl.permission', Permission::class)::with('level')->get();

        return $allPerms->diff($this->permissions);
    }

    /**
     * USER & LEVEL
     * Check if a model has permission to do something
     *
     * @param $permission
     * @return bool
     */
    protected function cacheHasPermissionTo($permission)
    {
        $permission = $this->getPermission($permission);

        if (is_a($this, config('laravel-acl.user'), true)) {
            $negatedPermissions = $this->permissions()->wherePivot('negated', true)->get();

            if ($this->getAllPermissions()->contains('id', $permission->id)) {
                return !$negatedPermissions->contains('id', $permission->id);
            }
        }

        return $this->getAllPermissions()->contains('id', $permission->id) || $this->getAllPermissions()->contains('name', '*');
    }

    /**
     * USER & LEVEL
     * Modify a given set of permissions, given the action to be taken
     *
     * @param $permissions
     * @param string $action
     */
    protected function modifyPermissions($permissions, $action)
    {
        Cache::forget('laravel-acl.getAvailablePermissionsFor' . (new ReflectionClass($this))->getShortName() . '_' . $this->id);
        Cache::forget('laravel-acl.getAllPermissionsFor' . (new ReflectionClass($this))->getShortName() . '_' . $this->id);
        Cache::forget('laravel-acl.getNegatedPermissionsForUser_' . $this->id);

        $permissionObjects = $this->buildPermissionsArray($permissions, $action);

        switch($action) {
            case 'add':
                // Add and negate call the same method
            case 'negate':
                $this->addOrNegate($permissionObjects, $action);

                break;
            case 'remove':
                $this->remove($permissionObjects);
                break;
            case 'sync':
                $this->sync($permissionObjects);
            default:
                // Hopefully this never happens
        }
    }

    /**
     * USER & LEVEL
     * Helper function to build the array
     * for modifyPermissions
     *
     * @param $permissions
     * @param $action
     * @return array
     * @throws PermissionNotFoundException
     */
    protected function buildPermissionsArray($permissions, $action)
    {
        $permissionsObjects = [];

        foreach ($permissions as $permission) {
            $permission = $this->getPermission($permission);
            Cache::forget('laravel-acl.hasPermissionTo_' . (new ReflectionClass($this))->getShortName() . '_' . $this->id . '_Permission_' . $permission->id);

            if ($action == 'negate') {
                $permissionsObjects[$permission->id] = ['negated' => true];
            } else {
                is_a($this, config('laravel-acl.user')) ?
                    array_push($permissionsObjects, $permission->id) : array_push($permissionsObjects, $permission);
            }
        }

        return $permissionsObjects;
    }

    /**
     * USER & LEVEL
     * Helper function to handle adding or negating permissions
     *
     * @param $permissionObjects
     */
    protected function addOrNegate($permissionObjects)
    {
        if (is_a($this, config('laravel-acl.user'))) {
            $this->permissions()->attach($permissionObjects);

        }

        if (is_a($this, config('laravel-acl.level'))) {
            $this->permissions()->saveMany($permissionObjects);

        }
    }

    /**
     * USER & LEVEL
     * Helper function to handle removing permissions
     *
     * @param $permissionObjects
     */
    protected function remove($permissionObjects)

    {
        if (is_a($this, config('laravel-acl.user'))) {
            $this->permissions()->detach($permissionObjects);

        }

        if (is_a($this, config('laravel-acl.level'))) {
            config('laravel-acl.permission', Permission::class)::whereIn('id', array_map(function($permission) {
                return $permission->id;
            }, $permissionObjects))->update(['level_id' => null]);
        }
    }

    /**
     * USER & LEVEL
     * Help function to handle syncing permissions
     *
     * @param $permissionObjects
     */
    protected function sync($permissionObjects)

    {
        if (is_a($this, config('laravel-acl.user'))) {
            $this->permissions()->sync($permissionObjects);

        }

        if (is_a($this, config('laravel-acl.level'))) {
            $this->clearPermissions();

            config('laravel-acl.permission', Permission::class)::whereIn('id', array_map(function($permission) {
                return $permission->id;
            }, $permissionObjects))
                ->update(['level_id' => $this->id]);
        }
    }

    /**
     * USER & LEVEL
     * Helper function to get the permission whether it is the permission ID
     * or the permission name, or the permission object itself.
     *
     * @param $permission
     * @return \z1haze\Acl\Models\Permission
     * @throws PermissionNotFoundException
     */
    protected function getPermission($permission)

    {
        if (is_string($permission)) {
            $permission = config('laravel-acl.permission', Permission::class)::whereName($permission)->first();
        }

        if (is_int($permission)) {
            $permission = config('laravel-acl.permission', Permission::class)::find($permission);
        }

        if (!$permission) {
            throw new PermissionNotFoundException;
        }

        return $permission;
    }
}

1		<?php
2
3		namespace z1haze\Acl\Traits;
4
5		use Illuminate\Support\Collection;
6		use ReflectionClass;
7		use z1haze\Acl\Exceptions\PermissionNotFoundException;
8		use Illuminate\Support\Facades\Cache;
9		use z1haze\Acl\Models\Level;
10		use z1haze\Acl\Models\Permission;
11
12		trait UserAndLevel
13		{
14		/**
15		* USER & LEVEL
16		* Check if a model has a given level
17		*
18		* @param mixed level
19		* @return bool
20		*/
21	1	public function isLevel($level)
22		{
23	1	$level = $this->getALevel($level);
		0 ignored issues – show Bug introduced 2017-02-07 20:00 UTC by Report Bug Copy Issue Report It seems like `getALevel()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
24
25	1	return is_a($this, config('laravel-acl.level'), true) ? $this->name == $level->name : $this->level->name == $level->name;
		0 ignored issues – show Bug introduced 2017-02-06 22:10 UTC by Report Bug Copy Issue Report The property `name` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2017-02-06 22:10 UTC by Report Bug Copy Issue Report The property `level` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
26		}
27
28		/**
29		* USER & LEVEL
30		* Check if a user has or has inherited
31		* a given level
32		*
33		* @param $level
34		* @return bool
35		*/
36	1	public function hasLevel($level)
37		{
38	1	$level = $this->getLevel($level);

z1haze / laravel-acl

Push — master ( 5b1557...9caaaf )

UserAndLevel::getPermissions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like