nuxia/acl-manager-bundle

ACL Manager for Symfony2

v2.0.2 2015-03-04 16:59 UTC

Requires

• php: >=5.4
• symfony/framework-bundle: 2.*
• symfony/security-bundle: 2.*

Requires (Dev)

• doctrine/orm: ~2.4

Suggests

• doctrine/couchdb-odm-bundle: *
• symfony/doctrine-bundle: *
• symfony/mongodb-odm-bundle: *

MIT

• Derek Stobbe
• Nuxia

• acl

README

Add this bundle to your composer.json file:

{
    "require": {
        "nuxia/acl-manager-bundle": "*"
    }
}

Register the bundle in app/AppKernel.php:

<?php

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

If you haven't configured the ACL enable it in app/config/security.yml:

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

Finally run the ACL init command

php app/console init:acl

Usage

<?php

$comment = new Comment(); // create some entity
// ... do work on entity

$em->persist($comment);
$em->flush(); // entity must be persisted and flushed before AclManager can act on it (needs identifier)
$aclManager = $this->get('problematic.acl_manager');

// Adds a permission no matter what other permissions existed before
$aclManager->addObjectPermission($comment, MaskBuilder::MASK_OWNER, $userEntity);
// Or:
$aclManager->addObjectPermission($comment, MaskBuilder::MASK_OWNER);
// Replaces all current permissions with this new one
$aclManager->setObjectPermission($comment, MaskBuilder::MASK_OWNER, $userEntity);
$aclManager->revokePermission($comment, MaskBUILDER::MASK_DELETE, $userEntity);
$aclManager->revokeAllObjectPermissions($comment, $userEntity);

// Same with class permissions:
$aclManager->addClassPermission($comment, MaskBuilder::MASK_OWNER, $userEntity);
//Or:
$aclManager->addClassPermission(Comment::CLASS, MaskBuilder::MASK_OWNER, $userEntity);
//Or:
$aclManager->addClassPermission('Acme\\Bundle\\Entity\\Comment', MaskBuilder::MASK_OWNER, $userEntity);
$aclManager->setClassPermission($comment, MaskBuilder::MASK_OWNER, $userEntity);
$aclManager->revokePermission($comment, MaskBUILDER::MASK_DELETE, $userEntity, 'class');
$aclManager->revokeAllClassPermissions($comment, $userEntity);

// You can alse use object-field...
$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);
// ...and class-field scope permissions :
$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);

$aclManager->deleteAclFor($comment);
$em->remove($comment);
$em->flush();

If no $userEntity is provided, the current session user will be used instead.

If you'll be doing work on a lot of entities, use AclManager#preloadAcls():

<?php

$products = $repo->findAll();

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

// ... carry on

ACL ORM Filter

If you are using Doctrine ORM, you can use our filter to directly retrieve granted rows.

//Repository class
$qb = $this->getEntityManager()->createQueryBuilder();
$qb
    ->select('client_alias', 'client_user_alias')
    ->from($this->getEntityName(), 'client_alias')
    ->leftJoin('client_alias.user', 'client_user_alias')
;

$query = $this->aclFilter->apply($qb, ['VIEW', 'EDIT'], $currentUser, 'client_alias');
return $query->getResult();
//Will return only rows where $currentUser is granted VIEW,EDIT on Client (retrieved form table alias client_alias)

You can add extra criteria.

$query = $this->aclFilter->apply($query, ['OPERATOR'], $user, 'client_alias', function(ExtraAclCriteria $criteria){
$criteria->setExpression(sprintf('OR %s.status = ?', $criteria->getSQLTableAlias('user_table_name', 'client_user_alias')));
	$criteria->setParameters([User::STATUS_INACTIVE]);
});