README

Управление пользовательскими разрешениями для Yii2

Установка

Выполните

php composer.phar require cusodede/yii2-permissions "^1.0.0"

или добавьте

"cusodede/yii2-permissions": "^1.0.0"

в секцию require.

Миграции

Модуль хранит данные в таблицах, которые будут созданы командой

php yii migrate/up --migrationPath=@vendor/cusodede/yii2-permissions/migrations

список названий таблиц, создаваемых миграцией, можно посмотреть в файле migrations/m000000_000000_sys_permissions.php. Само собой, эту миграцию нужно выполнять только для новых проектов, для текущих, если эти таблицы были созданы ранее, миграцию применять не нужно.

Конфиги

Вот вам пример конфига по умолчанию с описаниями параметров:

return [
    // ...
    'modules' => [
        'permissions' => [
            'class' => cusodede\permissions\PermissionsModule::class,
            'params' => [
                'cache' => null, /* Собственный компонент кеширования, который будет использоваться классом, null для кеша Yii. */
                'viewPath' => [
                    'permissions' => '@vendor/cusodede/yii2-permissions/src/views/permissions', /* Путь к кастомным шаблонам для управления доступами */
                    'permissions-collections' => '@vendor/cusodede/yii2-permissions/src/views/permissions-collections' /* Путь к кастомным шаблонам для управления коллекциями доступов */
                ],
                'userIdentityClass' => Yii::$app->user->identityClass, /* Имя класса (либо замыкание, это имя возвращающее), определяющего identity пользователя. */
                'userCurrentIdentity' => Yii::$app->user->identity, /* Экземпляр класса, идентифицирующий сущность текущего пользователя */
                'controllerDirs' => [, /* Перечисление каталогов контроллеров, которые а) должны появиться в соответствующих настройках доступов; б) см. issue #1 Формат: 'путь_к_каталогу' => 'модуль_контроллера. Примеры ниже. '*/
                    /*
                     * '@app/controllers' => null, # для контроллеров, загружаемых приложением, модуль не указывается
                     * '@app/modules/api/controllers' => 'api', # для каталога с контроллерами модуля указываем id модуля
                     * '@vendor/cusodede/yii2-permissions/src/controllers' => '@permissions', # если id модуля указан через @, то модуль не будет загружаться при инициализации контроллеров (для получения списка действий)
                    */
                ],
                'ignorePaths' => [/* Игнорируемые пути. Поддерживаются файловые маски, например: */
                    '@app/controllers/ignored_dir/*',//ignore by directory path
                    '@app/controllers/IgnoredController.php',//ignore by file path
                ],
                'basicActionInput' => false,/* true: включение простого поля ввода имени действия в редакторе привилегий, false: включить выпадающий список действий выбранного контроллера*/
                'enablePathWarnFlag' => true, /*false: отключает проверку и вывод флага Permissions::WARN_NO_PATH, требующую инстанцирования контроллеров */
                'grantAll' => [1],/* id пользователей, которые будут получать все привилегии */
                'grant' => [/* перечисление прямых назначений привилегий в формате user_id => [список получаемых привилегий]. Пример ниже. */
                    /*
                     * 1 => ['login_as_another_user', 'some_other_permission']
                     */
                ],
                'permissions' => [/* Список именованных привилегий, создаваемых командой init-config-permissions. Примеры ниже. Привилегии контроллер-экшен-etc в этой конфигурации не поддерживаются. */ 
                    /*
                     * 'system' => [
                     *      'comment' => 'Разрешение на доступ к системным параметрам',
                     * ],
                     * 'login_as_another_user' => [
                     *      'comment' => 'Разрешение авторизоваться под другим пользователем',
                     * ]
                     */
                ]
            ]
        ] 
    ]
    // ...
]

Команды модуля

TBD

Использование (модели, трейты, etc)

TBD

Запуск локальных тестов

Скопируйте tests/.env.example в tests/.env, и измените конфигурацию соответственно вашему локальному окружению. Затем выполните команду php vendor/bin/codecept run.

cusodede / yii2-permissions

Maintainers

Details