README

该模板依赖于laravel，包含基本权限管理所需要功能改模块，安装后简单配置即可使用，并且提供View，比较适合项目初期。

Installation

注意安装前确定laravel已经安装就绪

使用composer安装

composer require ttlphp/laravel-crbac dev-master

使用GIT安装

使用GIT命令下载程序包。

git clone https://github.com/ttlxihuan/laravel-crbac

修改自动加载配置

打开 vendor/composer/autoload_psr4.php 添加命令空间加载目录：

'Laravel\\Crbac\\' => array($vendorDir . '/laravel-crbac/src'),

打开 vendor/composer/autoload_static.php 添加命令空间加载目录，此文件有多处需要添加，暂不示例

打开 vendor/composer/autoload_files.php 添加助手函数加载：

$vendorDir . '/laravel-crbac/src/helpers.php',

Configuration

需要在laravel中启用应用，需要作几个配置修改。

打开配置文件 config/app.php 添加应用服务到容器:

    'name' => '应用名', // 展示的登录和菜单左侧
    'providers' => [ // laravel-10以内版本使用
        Laravel\Crbac\ServiceProvider::class,
    ]

打开配置文件 bootstrap/providers.php 添加应用服务到容器:（laravel-11起使用）

    return [ // laravel-11及以上版本使用
        Laravel\Crbac\ServiceProvider::class,
    ]

打开配置文件 config/auth.php 配置授权模型:

    'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'admin',
            'remember' => 4320,  // 记住登录时长（分）
            // 范围：0 ~ 50， 0 表示不锁定，默认：3
            'attempt_interval' => 3, // 登录失败尝试锁定间隔次数，达到将限时不可登录
            // 范围：0 ~ 120， 0 表示登录失败立即禁用账号，默认：12
            'attempt_max' => 5 // 最多尝试次数，超出将禁用账号
            // 范围：60 ~ 86400，默认：300
            'lock_time' => 300 // 锁定时长基数（秒），实际锁定时长 = lock_time * pow(2, attempt_total / attempt_interval)
        ],
    ],
    'providers' => [
        'admin' => [
            'driver' => 'eloquent',
            'model' => Laravel\Crbac\Models\Power\Admin::class,
        ],
        // 这里可配置其它授权模型
    ],

配置数据，运行安装命令（注意多次运行此命令会覆盖重写自带的表和数据）

php artisan crbac:table

打开浏览器验证效果

lang

项目中提供了中文基础文件，方便在验证分页等信息是自由切换，项目全部以中文提示为语言基础。安装中文需要运行命令

php artisan crbac:lang

命令会复制预定中文字典复制到语言配置目录中。

打开配置文件 config/app.php 修改默认语言

'locale' => 'cn',

table

当使用手动安装或初始化权限数据表结构时，在这里提供了 artisan 命令，方便手动重置表结构及基础数据。

表结构如下

表名	说明
power_role_admin	管理员表
power_item	权限项表，记录所有权限项基础数据
power_item_group	权限项组表，用于权限项分组，当前只设计一级。
power_menu	菜单表，记录所有菜单基础数据，并且可以关联到权限项
power_menu_group	菜单组表，用于区分不同菜单组的菜单结构。
power_menu_level	菜单层级表，记录菜单的组成层级结构。
power_role	角色表。
power_role_admin	角色与管理员关联表
power_role_item	角色与权限项关联表
power_route	路由记录表，方便添加权限项。

use

要使用Crbac功能必需配置授权模型且必需继承预定模型（参考下面介绍），如果没有配置则整个项目会跳过路由配置和权限处理初始化，即无法正常使用权限功能。

权限校验

Crbac权限处理会自动绑定在使用了auth中间件的路由上，即新增路由只需要追加auth中间件即可自动进行权限核验。

权限管理

权限使用，管理员 —> 角色（多个） —> 权限项（多个）

每个管理员可以绑定多个角色，每个角色可以绑定多个权限项，之间允许交叉和重复

菜单使用，管理员 —> 菜单组 —> 权限项（多个）

每个管理员绑定一套菜单组，方便各组管理员展示完全不同的菜单结构

定制权限

预定权限只适用预定全部功能，额外增加的权限即需要定制权限，路由和菜单权限预定功能即可满足，可自行配置增加权限组、权限项、菜单组、菜单项、角色等操作。

如果需要页面内或逻辑权限也可以定制添加，并需要在业务代码中增加权限判断，可以使用函数：

// 必需要有登录数据，否则永远返回false
// 此函数是所有权限验证通用函数
isPower($code, $default = false):bool

更多协助函数可参考文件：./vendor/ttlphp/laravel-crbac/src/helpers.php

登录和退出

Crbac会在路由加载完成后判断是否存在别名为 login 和 logout 两个路由，如果没有则会自动增加预定好的两个登录和退出路由，保证权限基本正常使用。如果需要截取预定登录和退出路由只需要手动添加两个别名路由即可。

路径式路由

路径式路由可以节省路由匹配次数。

<?php

// 添加路由，在外层也可以增加 Route::group()
// 使用此路由可生效三个注解功能： @middleware(参数)、@methods(参数)
path_route('mvc-route', '/{controller}/{action}.html', 'App\\Http\\Controllers');

控制器：php7

<?php
namespace App\Http\Controllers;

use Laravel\Crbac\Controllers\Controller;

/**
 * 追加该控制器全部中间件
 * @middleware(auth)
 */
class TestController extends Controller {
    /**
     * @methods(GET)
     * @middleware(auth)
     */
    public function testMenu(){

    }
    /**
     * @methods(GET, POST)
     */
    public function testItem(){

    }
}

控制器：php8（允许使用php7结构）

<?php
namespace App\Http\Controllers;

use Laravel\Crbac\Controllers\Controller;
use Laravel\Crbac\Annotation\Request\Methods;
use Laravel\Crbac\Annotation\Request\Middleware;

#[@Middleware('auth')]
class TestController extends Controller {

    #[Methods(Methods::GET)]
    #[@Middleware('auth')]
    public function testMenu(){

    }

    #[Methods(Methods::GET, Methods::POST)]
    public function testItem(){

    }
}

自动更新权限项

编写控制器代码

控制器：php7

<?php
// 使用注解：@powerMenu(参数) 和 @powerItem(参数)。

namespace App\Http\Controllers;

use Laravel\Crbac\Controllers\Controller;

class TestController extends Controller {
    /**
     * @powerMenu('测试菜单')
     */
    public function testMenu(){

    }
    /**
     * @powerItem('测试权限项')
     */
    public function testItem(){

    }
}

控制器：php8（允许使用php7结构）

<?php
namespace App\Http\Controllers;

use Laravel\Crbac\Annotation\PowerMenu;
use Laravel\Crbac\Annotation\PowerItem;
use Laravel\Crbac\Controllers\Controller;
use Laravel\Crbac\Annotation\Request\Methods;
use Laravel\Crbac\Annotation\Request\Middleware;

class TestController extends Controller {

    #[PowerMenu('测试菜单')]
    public function testMenu(){

    }

    #[PowerItem('测试权限项')]
    public function testItem(){

    }
}

执行更新命令即可

php artisan crbac:power

上传文件

支持分割上传处理，可将很大的文件分割成多个请求上传到服务器。

编写视图代码，file标签的 data-* 均有功能

data-split 分割上传开关
<input type="file" class="form-control" name="file" data-url="业务上传地址" accept=".png,.jpeg,.jpg" data-split="true" data-timeout="1000000" data-callback="upload_img" data-show-url="show"/>
<div id="show">
    <img src=""/>
    <input type="hidden" name="img">
</div>
<script>
function upload_img(res){
    console.info(res);
}
</script>