| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | Copyright CiviCRM LLC. All rights reserved. | |
| 5 | | | |
| 6 | | This work is published under the GNU AGPLv3 license with some | |
| 7 | | permitted exceptions and without any warranty. For full license | |
| 8 | | and copyright information, see https://civicrm.org/licensing | |
| 9 | +--------------------------------------------------------------------+ |
| 10 | */ |
| 11 | |
| 12 | namespace Civi\API\Event; |
| 13 | |
| 14 | /** |
| 15 | * Class AuthorizeEvent |
| 16 | * @package Civi\API\Event |
| 17 | * |
| 18 | * Determine whether the API request is allowed for the current user. |
| 19 | * For successful execution, at least one listener must invoke |
| 20 | * $event->authorize(). |
| 21 | * |
| 22 | * Event name: 'civi.api.authorize' |
| 23 | */ |
| 24 | class AuthorizeEvent extends Event { |
| 25 | /** |
| 26 | * @var bool |
| 27 | */ |
| 28 | private $authorized = FALSE; |
| 29 | |
| 30 | /** |
| 31 | * Mark the request as authorized. |
| 32 | */ |
| 33 | public function authorize() { |
| 34 | $this->authorized = TRUE; |
| 35 | } |
| 36 | |
| 37 | /** |
| 38 | * @return bool |
| 39 | * TRUE if the request has been authorized. |
| 40 | */ |
| 41 | public function isAuthorized() { |
| 42 | return $this->authorized; |
| 43 | } |
| 44 | |
| 45 | } |