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

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

2024-12-25 07:23:11作者:邵娇湘

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。

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