library/Zend/Acl/Assert/Interface.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   7  * This source file is subject to the new BSD license that is bundled
   8  * with this package in the file LICENSE.txt.
   9  * It is also available through the world-wide-web at this URL:
  10  * http://framework.zend.com/license/new-bsd
  11  * If you did not receive a copy of the license and are unable to
  12  * obtain it through the world-wide-web, please send an email
  13  * to license@zend.com so we can send you a copy immediately.
  14  *
  15  * @category   Zend
  16  * @package    Zend_Acl
  17  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  18  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  19  * @version    $Id$
  20  */
  21
  22
  23 /**
  24  * @see Zend_Acl
  25  */
  26 require_once 'Zend/Acl.php';
  27
  28
  29 /**
  30  * @see Zend_Acl_Role_Interface
  31  */
  32 require_once 'Zend/Acl/Role/Interface.php';
  33
  34
  35 /**
  36  * @see Zend_Acl_Resource_Interface
  37  */
  38 require_once 'Zend/Acl/Resource/Interface.php';
  39
  40
  41 /**
  42  * @category   Zend
  43  * @package    Zend_Acl
  44  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  45  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  46  */
  47 interface Zend_Acl_Assert_Interface
  48 {
  49     /**
  50      * Returns true if and only if the assertion conditions are met
  51      *
  52      * This method is passed the ACL, Role, Resource, and privilege to which the authorization query applies. If the
  53      * $role, $resource, or $privilege parameters are null, it means that the query applies to all Roles, Resources, or
  54      * privileges, respectively.
  55      *
  56      * @param  Zend_Acl                    $acl
  57      * @param  Zend_Acl_Role_Interface     $role
  58      * @param  Zend_Acl_Resource_Interface $resource
  59      * @param  string                      $privilege
  60      * @return boolean
  61      */
  62     public function assert(Zend_Acl $acl, Zend_Acl_Role_Interface $role = null, Zend_Acl_Resource_Interface $resource = null,
  63                            $privilege = null);
  64 }