z1haze\Acl\Models\Permission

Complexity

Total Complexity

14

Size/Duplication

Total Lines	153
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	level()	0	4	1
A	users()	0	4	1
A	getUsers()	0	4	1
A	addUser()	0	4	1
A	addUsers()	0	6	1
A	removeUser()	0	4	1
A	removeUsers()	0	6	1
A	getUser()	0	10	3
A	buildUserArray()	0	11	2
A	boot()	0	9	1
A	__construct()	0	6	1

<?php

namespace z1haze\Acl\Models;

use Illuminate\Database\Eloquent\Model;
use z1haze\Acl\Exceptions\UserNotFoundException;
use z1haze\Acl\Traits\UserAndPermission;

class Permission extends Model
{
    use UserAndPermission;

    protected $guarded = ['id', 'created_id', 'updated_at'];
    protected $casts = ['id' => 'integer'];
    protected $table;

    /**
     * PERMISSION
     * A Permission belongs to a level
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function level()
    {
        return $this->belongsTo(config('laravel-acl.level', Level::class));
    }

    /**
     * PERMISSION
     * A permission belongs to many users
     *
     * @return mixed
     */
    public function users()
    {
        return $this->belongsToMany(config('laravel-acl.user'));
    }

    /**
     * PERMISSION
     * Return the relationship of users
     *
     * @return mixed
     */
    public function getUsers()
    {
        return $this->users;
    }

    /**
     * PERMISSION
     * Assign a single user to a permission
     *
     * @param $user
     */
    public function addUser($user)
    {
        return $this->addUsers([$user]);
    }

    /**
     * PERMISSION
     * Assign an array of users to a permission
     *
     * @param $users
     */
    public function addUsers($users)
    {
        $userObjects = $this->buildUserArray($users);

        return $this->users()->attach($userObjects);
    }

    /**
     * PERMISSION
     * Remove a single user from a permission
     *
     * @param $user
     */
    public function removeUser($user)
    {
        return $this->removeUsers([$user]);
    }

    /**
     * PERMISSION
     * Remove an array of users from a permission
     *
     * @param $users
     */
    public function removeUsers($users)
    {
        $userObjects = $this->buildUserArray($users);

        return $this->users()->detach($userObjects);
    }


    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * PERMISSION
     * Helper function to get the user whether it is the user ID
     * or the user object itself.
     *
     * @param $user
     * @return User
     * @throws UserNotFoundException
     */
    protected function getUser($user)
    {
        if (is_int($user))
            $user = config('laravel-acl.user')::find($user);

        if (!$user)
            throw new UserNotFoundException;

        return $user;
    }

    /**
     * Helper function to process users and return an
     * array of user id's
     *
     * @param $users
     * @return array
     */
    protected function buildUserArray($users)
    {
        $userArray = [];

        foreach ($users as $user) {
            $user = $this->getUser($user);
            array_push($userArray, $user->id);
        }

        return $userArray;
    }

    /**
     * Handle model events
     */
    public static function boot()
    {
        parent::boot();

        static::deleting(function ($permission) {
            $permission->users()->detach();
            $permission->level()->dissociate()->save();
        });
    }

    public function __construct(array $attributes = [])
    {
        parent::__construct($attributes);

        $this->table = config('laravel-acl.tables.permission');
    }
}