首页
/ 技术文档:AclManagerBundle 安装与使用指南

技术文档:AclManagerBundle 安装与使用指南

2024-12-25 21:11:55作者:邵娇湘

1. 安装指南

1.1. 添加依赖

首先,需要在你的 composer.json 文件中添加以下依赖:

{
    "require": {
        "problematic/acl-manager-bundle": "dev-master"
    }
}

然后,执行 composer install 或者 composer update 来安装这个包。

1.2. 注册Bundle

接着,在 app/AppKernel.php 文件中注册这个Bundle:

<?php

// app/AppKernel.php
public function registerBundles()
{
    return array(
        // ...
        new Problematic\AclManagerBundle\ProblematicAclManagerBundle(),
    );
}

1.3. 配置ACL

如果没有配置ACL,需要在 app/config/security.yml 文件中启用它:

# app/config/security.yml
security:
    acl:
        connection: default

最后,运行ACL初始化命令:

php app/console init:acl

2. 项目使用说明

AclManagerBundle 提供了一个 AclManager 类,用于管理实体的访问控制列表(ACL)。以下是如何使用这个类的基本示例:

<?php

$comment = new Comment(); // 创建一个实体
// ... 对实体进行操作

$em->persist($comment);
$em->flush(); // 实体必须被持久化和刷新后,AclManager 才能作用于它(需要标识符)

$aclManager = $this->get('problematic.acl_manager');

// 添加一个权限,不考虑之前存在的其他权限
$aclManager->addObjectPermission($comment, MaskBuilder::MASK_OWNER, $userEntity);
// 或者:
$aclManager->addObjectPermission($comment, MaskBuilder::MASK_OWNER);

// 替换所有当前权限为新的权限
$aclManager->setObjectPermission($comment, MaskBuilder::MASK_OWNER, $userEntity);

// 撤销特定权限
$aclManager->revokePermission($comment, MaskBuilder::MASK_DELETE, $userEntity);

// 撤销所有权限
$aclManager->revokeAllObjectPermissions($comment, $userEntity);

// 类似地,也可以使用类权限:
$aclManager->addClassPermission($comment, MaskBuilder::MASK_OWNER, $userEntity);
$aclManager->setClassPermission($comment, MaskBuilder::MASK_OWNER, $userEntity);
$aclManager->revokePermission($comment, MaskBuilder::MASK_DELETE, $userEntity, 'class');
$aclManager->revokeAllClassPermissions($comment, $userEntity);

// 你也可以使用对象字段权限...
$aclManager->addObjectFieldPermission($comment, 'title', MaskBuilder::MASK_EDIT, $userEntity);
$aclManager->setObjectFieldPermission($comment, 'title', MaskBuilder::MASK_EDIT, $userEntity);
$aclManager->revokeFieldPermission($comment, 'title', MaskBuilder::MASK_DELETE, $userEntity);
$aclManager->revokeAllObjectFieldPermissions($comment, 'title', $userEntity);

// ...以及类字段范围权限:
$aclManager->addClassFieldPermission($comment, 'title', MaskBuilder::MASK_EDIT, $userEntity);
$aclManager->setClassFieldPermission($comment, 'title', MaskBuilder::MASK_EDIT, $userEntity);
$aclManager->revokeFieldPermission($comment, 'title', MaskBuilder::MASK_DELETE, $userEntity, 'class');
$aclManager->revokeAllClassFieldPermissions($comment, 'title', $userEntity);

// 删除ACL
$aclManager->deleteAclFor($comment);
$em->remove($comment);
$em->flush();

如果没有提供 $userEntity,则默认使用当前会话用户。

如果你将处理大量实体,可以使用 AclManager#preloadAcls() 方法:

<?php

$products = $repo->findAll();

$aclManager = $this->get('problematic.acl_manager');
$aclManager->preloadAcls($products);

// ...继续操作

3. 项目API使用文档

AclManagerBundle 的API主要是通过 AclManager 类来提供的。以下是一些常用的API方法:

  • addObjectPermission($object, $mask, $userEntity = null)
  • setObjectPermission($object, $mask, $userEntity = null)
  • revokePermission($object, $mask, $userEntity = null)
  • revokeAllObjectPermissions($object, $userEntity = null)
  • addClassPermission($object, $mask, $userEntity = null)
  • setClassPermission($object, $mask, $userEntity = null)
  • revokeAllClassPermissions($object, $userEntity = null)
  • addObjectFieldPermission($object, $field, $mask, $userEntity = null)
  • setObjectFieldPermission($object, $field, $mask, $userEntity = null)
  • revokeFieldPermission($object, $field, $mask, $userEntity = null, $class = false)
  • revokeAllObjectFieldPermissions($object, $field, $userEntity = null)
  • deleteAclFor($object)
  • preloadAcls($objects)

这些方法提供了对实体和类级别的访问控制权限的添加、设置、撤销和预加载功能。

4. 项目安装方式

项目的安装方式已在上述“安装指南”部分详细描述。总结如下:

  1. composer.json 中添加依赖。
  2. 使用 composer installcomposer update 安装依赖。
  3. AppKernel.php 中注册Bundle。
  4. 配置 security.yml 文件中的ACL。
  5. 运行 init:acl 命令初始化ACL。

以上就是AclManagerBundle的安装与使用指南。希望本文档能够帮助您更好地理解和应用这个Bundle。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
53
468
kernelkernel
deepin linux kernel
C
22
5
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
349
381
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
7
0
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
133
186
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
878
517
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
336
1.1 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
180
264
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
612
60
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4