AclInterface.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Symfony\Component\Security\Acl\Model;

use Symfony\Component\Security\Acl\Exception\NoAceFoundException;

/**
 * This interface represents an access control list (ACL) for a domain object.
 * Each domain object can have exactly one associated ACL.
 *
 * An ACL contains all access control entries (ACE) for a given domain object.
 * In order to avoid needing references to the domain object itself, implementations
 * use ObjectIdentity implementations as an additional level of indirection.
 *
 * @author Johannes M. Schmitt <schmittjoh@gmail.com>
 *
 * @method array __serialize()              returns all the necessary state of the object for serialization purposes
 * @method void  __unserialize(array $data) restores the object state from an array given by {@see __serialize}
 */
interface AclInterface extends \Serializable
{
    /**
     * Returns all class-based ACEs associated with this ACL.
     *
     * @return array<int, EntryInterface>
     */
    public function getClassAces();

    /**
     * Returns all class-field-based ACEs associated with this ACL.
     *
     * @return array<int, EntryInterface>
     */
    public function getClassFieldAces(string $field);

    /**
     * Returns all object-based ACEs associated with this ACL.
     *
     * @return array<int, EntryInterface>
     */
    public function getObjectAces();

    /**
     * Returns all object-field-based ACEs associated with this ACL.
     *
     * @return array<int, EntryInterface>
     */
    public function getObjectFieldAces(string $field);

    /**
     * Returns the object identity associated with this ACL.
     *
     * @return ObjectIdentityInterface
     */
    public function getObjectIdentity();

    /**
     * Returns the parent ACL, or null if there is none.
     *
     * @return AclInterface|null
     */
    public function getParentAcl();

    /**
     * Whether this ACL is inheriting ACEs from a parent ACL.
     *
     * @return bool
     */
    public function isEntriesInheriting();

    /**
     * Determines whether field access is granted.
     *
     * @return bool
     */
    public function isFieldGranted(string $field, array $masks, array $securityIdentities, bool $administrativeMode = false);

    /**
     * Determines whether access is granted.
     *
     * @return bool
     *
     * @throws NoAceFoundException when no ACE was applicable for this request
     */
    public function isGranted(array $masks, array $securityIdentities, bool $administrativeMode = false);

    /**
     * Whether the ACL has loaded ACEs for all of the passed security identities.
     *
     * @param SecurityIdentityInterface|SecurityIdentityInterface[] $securityIdentities
     *
     * @return bool
     */
    public function isSidLoaded($securityIdentities);
}