1 <?php

     2 

     3 /*

     4  * This file is part of the Symfony package.

     5  *

     6  * (c) Fabien Potencier <fabien@symfony.com>

     7  *

     8  * For the full copyright and license information, please view the LICENSE

     9  * file that was distributed with this source code.

    10  */

    11 

    12 namespace Symfony\Component\Security\Acl\Model;

    13 

    14 /**

    15  * Provides a common interface for retrieving ACLs.

    16  *

    17  * @author Johannes M. Schmitt <schmittjoh@gmail.com>

    18  */

    19 interface AclProviderInterface

    20 {

    21     /**

    22      * Retrieves all child object identities from the database

    23      *

    24      * @param ObjectIdentityInterface $parentOid

    25      * @param Boolean $directChildrenOnly

    26      * @return array returns an array of child 'ObjectIdentity's

    27      */

    28     function findChildren(ObjectIdentityInterface $parentOid, $directChildrenOnly = false);

    29 

    30     /**

    31      * Returns the ACL that belongs to the given object identity

    32      *

    33      * @throws AclNotFoundException when there is no ACL

    34      * @param ObjectIdentityInterface $oid

    35      * @param array $sids

    36      * @return AclInterface

    37      */

    38     function findAcl(ObjectIdentityInterface $oid, array $sids = array());

    39 

    40     /**

    41      * Returns the ACLs that belong to the given object identities

    42      *

    43      * @throws AclNotFoundException when we cannot find an ACL for all identities

    44      * @param array $oids an array of ObjectIdentityInterface implementations

    45      * @param array $sids an array of SecurityIdentityInterface implementations

    46      * @return \SplObjectStorage mapping the passed object identities to ACLs

    47      */

    48     function findAcls(array $oids, array $sids = array());

    49 }