Merge pull request #1 from farhoudi/develop

Initial commit

Author: farhoudi

composer.json

@@ -0,0 +1,28 @@
+{
+    "name": "farhoudi/laravel-rbac",
+    "description": "Role based access control for Laravel 5+",
+    "keywords": [
+        "laravel",
+        "rbac",
+        "role",
+        "permission",
+        "acl"
+    ],
+    "type": "library",
+    "authors": [
+        {
+            "name": "Ali Farhoudi",
+            "email": "af.farhoudi@gmail.com"
+        }
+    ],
+    "license": "MIT",
+    "require": {
+        "php": ">=5.5.9",
+        "illuminate/support": "5.2.*"
+    },
+    "autoload": {
+        "psr-4": {
+            "Farhoudi\\Rbac\\": "src/"
+        }
+    }
+}

src/Models/Permission.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Farhoudi\Rbac\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * Class Permission
+ * @package Farhoudi\Rbac\Models
+ */
+class Permission extends Model {
+
+    public $table = 'rbac_permissions';
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'name',
+        'alias',
+        'description',
+    ];
+
+    /**
+     * The attributes that should be casted to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'name' => 'string',
+        'alias' => 'string',
+        'description' => 'string',
+    ];
+
+    /**
+     * Validation rules
+     *
+     * @var array
+     */
+    public static $rules = [
+        'name' => 'required|string',
+        'alias' => 'nullable|string|unique:rbac_permissions,alias',
+        'description' => 'nullable|string',
+    ];
+
+    protected $hidden = [
+        'created_at',
+        'updated_at',
+        'description',
+    ];
+
+    public function roles() {
+        return $this->belongsToMany(Role::class, 'rbac_permission_role', 'permission_id', 'role_id');
+    }
+
+}

src/Models/PermissionGroup.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Farhoudi\Rbac\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * Class Permission
+ * @package Farhoudi\Rbac\Models
+ */
+class PermissionGroup extends Model {
+
+    public $table = 'rbac_permission_groups';
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'name',
+        'description',
+    ];
+
+    /**
+     * Validation rules
+     *
+     * @var array
+     */
+    public static $rules = [
+        'name' => 'required|unique:rbac_permissions,alias',
+        'description' => 'nullable|string',
+    ];
+
+    protected $hidden = [
+        'created_at',
+        'updated_at',
+        'description',
+    ];
+
+    public function permissions() {
+        return $this->hasMany(Permission::class, 'group_id', 'id');
+    }
+
+}

src/Models/Role.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace Farhoudi\Rbac\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Farhoudi\User\Models\User;
+
+/**
+ * Class Role
+ * @package Farhoudi\Rbac\Models
+ */
+class Role extends Model {
+
+    public $table = 'rbac_roles';
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'name',
+        'alias',
+        'description',
+    ];
+
+    /**
+     * The attributes that should be casted to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'name' => 'string',
+        'alias' => 'string',
+        'description' => 'string',
+    ];
+
+    /**
+     * Validation rules
+     *
+     * @var array
+     */
+    public static $rules = [
+        'name' => 'required|string',
+        'alias' => 'nullable|string|unique:rbac_roles,alias',
+        'description' => 'nullable|string',
+    ];
+
+    protected $hidden = [
+        'created_at',
+        'updated_at',
+        'description',
+    ];
+
+    public function permissions() {
+        return $this->belongsToMany(Permission::class, 'rbac_permission_role', 'role_id', 'permission_id');
+    }
+
+    public function users() {
+        return $this->belongsToMany(User::class, 'rbac_role_user', 'role_id', 'user_id');
+    }
+
+    public function attachPermission($permission) {
+        if (is_array($permission)) {
+            foreach ($permission as $item) {
+                $this->attachPermission($item);
+            }
+        }
+
+        if ($permission instanceof Permission) {
+            $this->permissions()->save($permission);
+        } else if (is_string($permission)) {
+            $permission = Permission::where('alias', $permission)->first();
+            if (!empty($permission)) {
+                $this->permissions()->save($permission);
+            }
+        }
+    }
+
+}

src/Rbac.php

@@ -0,0 +1,123 @@
+<?php
+
+namespace Farhoudi\Rbac;
+
+use Illuminate\Database\Eloquent\Collection;
+use Farhoudi\Rbac\Models\Role;
+
+/**
+ * Trait Rbac
+ */
+trait Rbac {
+
+    private $rbacIsLoaded = false;
+
+    private $roles;
+
+    private $permissions;
+
+    /**
+     * @param string|array $role
+     * @return bool
+     */
+    public function hasRole($role) {
+        if (!$this->rbacIsLoaded) {
+            $this->loadPermissions();
+            $this->rbacIsLoaded = true;
+        }
+
+        if (is_array($role)) {
+            foreach ($role as $r) {
+                if (!$this->hasRole($r)) {
+                    return false;
+                }
+            }
+            return true;
+        }
+
+        $roles = explode('|', $role);
+        foreach ($roles as $role) {
+            if (!empty($this->roles->where('alias', $role)->first())) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * @param string|array $permission
+     * @return bool
+     */
+    public function hasPermission($permission) {
+        if (!$this->rbacIsLoaded) {
+            $this->loadPermissions();
+            $this->rbacIsLoaded = true;
+        }
+
+        if (is_array($permission)) {
+            foreach ($permission as $p) {
+                if (!$this->hasPermission($p)) {
+                    return false;
+                }
+            }
+            return true;
+        }
+
+        $permissions = explode('|', $permission);
+        foreach ($permissions as $permission) {
+            if (!empty($this->permissions->where('alias', $permission)->first())) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Assign Role to User
+     *
+     * @param string|Role $role
+     */
+    public function assignRole($role) {
+        if (is_array($role)) {
+            foreach ($role as $item) {
+                $this->assignRole($item);
+            }
+        }
+
+        if ($role instanceof Role) {
+            if (!$this->hasRole($role->alias)) {
+                $this->roles()->save($role);
+            }
+        } else if (is_string($role)) {
+            $role = Role::where('alias', $role)->first();
+            if (!empty($role)) {
+                if (!$this->hasRole($role->alias)) {
+                    $this->roles()->save($role);
+                }
+            }
+        }
+
+        if ($this->rbacIsLoaded) {
+            $this->loadPermissions();
+        }
+    }
+
+    public function loadPermissions() {
+        $this->roles = $this->roles()->with(['permissions'])->get();
+        $this->permissions = new Collection();
+        foreach ($this->roles as $key => $role) {
+            foreach ($role->permissions as $permission) {
+                if (empty($this->permissions->where('name', $permission->name)->first()) && empty($this->permissions->where('alias', $permission->alias)->first())) {
+                    $this->permissions->add($permission);
+                }
+                unset($role->permissions);
+            }
+        }
+        return $this->permissions;
+    }
+
+    public function roles() {
+        return $this->belongsToMany(Role::class, 'rbac_role_user', 'user_id', 'role_id');
+    }
+
+}

src/RbacServiceProvider.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Farhoudi\Rbac;
+
+use Illuminate\Support\Facades\Event;
+use Illuminate\Support\Facades\Lang;
+use Illuminate\Support\ServiceProvider;
+
+class RbacServiceProvider extends ServiceProvider {
+
+    public function register() {
+        //
+    }
+
+    public function boot() {
+        $this->publishes([
+            __DIR__.'/migrations/' => database_path('migrations')
+        ], 'migrations');
+    }
+
+}