1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: <?php
namespace Nethgui\Authorization;
/*
* Copyright (C) 2011 Nethesis S.r.l.
*
* This script is part of NethServer.
*
* NethServer is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* NethServer is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with NethServer. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* Implementors encapsulate the authorization response,
* that can allow or deny the requested action.
*
* @api
* @author Davide Principi <davide.principi@nethesis.it>
* @since 1.0
*/
interface AccessControlResponseInterface
{
/**
* TRUE if the access is granted.
*
* @api
* @return bool TRUE, if granted, FALSE otherwise.
*/
public function isAllowed();
/**
* This is the dual of isAllowed().
*
* @api
* @see isGranted()
* @return bool TRUE, if access is denied FALSE otherwise
*/
public function isDenied();
/**
* Response explanation.
*
* @api
* @return string
*/
public function getMessage();
/**
* Response numeric code.
*
* @api
* @return integer 0 if granted, positive otherwise
*/
public function getCode();
/**
* Prepare an exception object with the response informations.
*
* @api
* @param integer $identifier The exception unique identifier
* @return \Nethgui\Exception\AuthorizationException
*/
public function asException($identifier);
}