interface/modules/zend_modules/library/Zend/Permissions/Acl/Assertion/AssertionInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Permissions\Acl\Assertion;
  11
  12 use Zend\Permissions\Acl\Acl;
  13 use Zend\Permissions\Acl\Resource\ResourceInterface;
  14 use Zend\Permissions\Acl\Role\RoleInterface;
  15
  16 interface AssertionInterface
  17 {
  18     /**
  19      * Returns true if and only if the assertion conditions are met
  20      *
  21      * This method is passed the ACL, Role, Resource, and privilege to which the authorization query applies. If the
  22      * $role, $resource, or $privilege parameters are null, it means that the query applies to all Roles, Resources, or
  23      * privileges, respectively.
  24      *
  25      * @param  Acl                        $acl
  26      * @param  RoleInterface         $role
  27      * @param  ResourceInterface $resource
  28      * @param  string                         $privilege
  29      * @return bool
  30      */
  31     public function assert(Acl $acl, RoleInterface $role = null, ResourceInterface $resource = null, $privilege = null);
  32 }