README

为 BKSCMS 项目提供必要的工具

要创建 BKSCMS 项目，请运行以下命令
composer create-project --prefer-dist bkstar123/bkscms <your-project>

1. 要求

建议使用 PHP 版本 7.1.3+ 和 Laravel 框架版本 5.6+ 来安装此包

2. 安装

composer require bkstar123/bkscms-utilities

然后，发布包的配置文件
php artisan vendor:publish --provider=Bkstar123\BksCMS\Utilities\Providers\UtilitiesServiceProvider

3. 使用

目前，此包提供了两个助手函数，可以在 BKSCMS 项目中使用

MenuHelper
CrudViewHelper

3.1 MenuHelper

发布包的配置文件后，您将得到 config/bkstar123_bkscms_sidebarmenu.php，其中您可以定义一个嵌套数组，该数组将被转换为 CMS 侧边栏菜单的内容。

初始数组如下所示

<?php
/**
 * Menu array
 * Each link component consists of 'name', 'path', 'icon', 'children' keys
 * 'name', 'path', 'icon' are of string type, 'children' is of array type
 * 'path' for an expandable link should be '#'
 */
return [
    [
        'name' => 'Dashboard',
        'path' => '/cms/dashboard',
        'icon' => 'fas fa-tachometer-alt',
    ],
    
    [
        'name' => 'Admin Managment',
        'path' => '#',
        'icon' => 'far fa-user',
        'children' => [
            [
                'name' => 'Admins',
                'path' => '/cms/admins',
                'icon' => 'fa fa-users',
            ],
            [
                'name' => 'Create Admin',
                'path' => '/cms/admins/create',
                'icon' => 'fa fa-user-plus',
            ]
        ]
    ],

    [
        'name' => 'Role Managment',
        'path' => '#',
        'icon' => 'fa fa-certificate',
        'children' => [
            [
                'name' => 'Roles',
                'path' => '/cms/roles',
                'icon' => 'fa fa-user-circle',
            ],
            [
                'name' => 'Create Role',
                'path' => '/cms/roles/create',
                'icon' => 'fa fa-plus',
            ]
        ]
    ],

    [
        'name' => 'Permission Managment',
        'path' => '#',
        'icon' => 'fa fa-universal-access',
        'children' => [
            [
                'name' => 'Permissions',
                'path' => '/cms/permissions',
                'icon' => 'fa fa-ship',
            ],
            [
                'name' => 'Create Permission',
                'path' => '/cms/permissions/create',
                'icon' => 'fa fa-plus',
            ]
        ]
    ],
];

name, path 是必填项，而 icon, children 是可选的

3.2 CrudViewHelper

它的目的是通过提供以下视图片段来确保 BKSCMS 项目中所有视图的一致性

php CrudView::checkAllBox(string $color = '')
创建一个全选按钮以选中所有视图项，其中 $color 可以是 primary, danger, success, warning, info, secondary, dark, light
php CrudView::checkBox(Model $resource, string $color = '')
在每一项旁边创建一个检查按钮，其中 $color 可以是 primary, danger, success, warning, info, secondary, dark, light，$resource 是项目实例
php CrudView::activeStatus(Model $resource, string $followRoute, string $color = '', string $text = '')
创建一个显示活动状态的按钮，其中 $color 可以是 primary, danger, success, warning, info, secondary, dark, light，$resource 是项目实例，$followRoute 是点击按钮后要重定向的路由，$text 是按钮内的文本
php CrudView::disabledStatus(Model $resource, string $followRoute, string $color = '', string $text = '')
创建一个显示禁用状态的按钮，其中 $color 可以是 primary, danger, success, warning, info, secondary, dark, light，$resource 是项目实例，$followRoute 是点击按钮后要重定向的路由，$text 是按钮内的文本
php CrudView::removeAllBtn(string $followRoute, string $color = '', string $text = '')
创建一个用于删除所有选中项的按钮，其中 $color 可以是 primary, danger, success, warning, info, secondary, dark, light，$followRoute 是点击按钮后要重定向的路由，$text 是按钮内的文本
php CrudView::removeBtn(Model $resource, string $followRoute, string $color = '', string $text = '')
为每一项创建一个删除按钮，其中 $color 可以是 primary, danger, success, warning, info, secondary, dark, light，$resource 是项目实例，$followRoute 是点击按钮后要重定向的路由，$text 是按钮内的文本
php CrudView::searchInput(string $searchRoute, string $inputName = 'search')
创建一个用于搜索项目的文本输入，其中 $searchRoute 是用于搜索的路由，$inputName 是用于搜索的文本输入的名称

bkstar123 / bkscms-utilities

维护者

详细信息