| 1: | <?php |
| 2: | /* |
| 3: | * SimpleID |
| 4: | * |
| 5: | * Copyright (C) Kelvin Mo 2021-2025 |
| 6: | * |
| 7: | * This program is free software; you can redistribute it and/or |
| 8: | * modify it under the terms of the GNU General Public |
| 9: | * License as published by the Free Software Foundation; either |
| 10: | * version 2 of the License, or (at your option) any later version. |
| 11: | * |
| 12: | * This program is distributed in the hope that it will be useful, |
| 13: | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14: | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15: | * General Public License for more details. |
| 16: | * |
| 17: | * You should have received a copy of the GNU General Public |
| 18: | * License along with this program; if not, write to the Free |
| 19: | * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
| 20: | * |
| 21: | */ |
| 22: | |
| 23: | namespace SimpleID\Protocols\OAuth; |
| 24: | |
| 25: | |
| 26: | /** |
| 27: | * An event triggered when an authorisation request has been granted. |
| 28: | * |
| 29: | * Under an implicit flow, both this event and the {@link OAuthTokenGrantEvent} will be |
| 30: | * triggered. |
| 31: | * |
| 32: | */ |
| 33: | class OAuthAuthGrantEvent extends OAuthEvent { |
| 34: | /** @var Authorization */ |
| 35: | protected $authorization; |
| 36: | |
| 37: | /** @var array<string> */ |
| 38: | protected $scopes; |
| 39: | |
| 40: | /** |
| 41: | * @param array<string> $scopes |
| 42: | */ |
| 43: | public function __construct(Authorization $authorization, Request $request, Response $response, $scopes) { |
| 44: | parent::__construct($request, $response); |
| 45: | |
| 46: | $this->authorization = $authorization; |
| 47: | $this->scopes = $scopes; |
| 48: | } |
| 49: | |
| 50: | /** |
| 51: | * Returns the underlying authorisation object |
| 52: | * |
| 53: | * @return Authorization the authorisation to |
| 54: | * be granted |
| 55: | */ |
| 56: | public function getAuthorization() { |
| 57: | return $this->authorization; |
| 58: | } |
| 59: | |
| 60: | /** |
| 61: | * Returns the requested scope |
| 62: | * |
| 63: | * @return array<string> the requested scope |
| 64: | */ |
| 65: | public function getRequestedScope() { |
| 66: | return $this->scopes; |
| 67: | } |
| 68: | } |
| 69: | |
| 70: | ?> |