UnauthorizedException.php
| 1 | <?php |
| 2 | |
| 3 | declare(strict_types=1); |
| 4 | |
| 5 | namespace Automattic\WooCommerce\Api; |
| 6 | |
| 7 | /** |
| 8 | * Thrown to deny access with a 401 Unauthorized status. |
| 9 | * |
| 10 | * Use when authentication is required but missing, or when an `authorize()` |
| 11 | * method needs to deny access without distinguishing further. For credentials |
| 12 | * that are present but rejected, prefer {@see InvalidTokenException}; for |
| 13 | * "authenticated but not allowed", prefer {@see ForbiddenException}. |
| 14 | * |
| 15 | * Wire shape: `extensions.code = 'UNAUTHORIZED'`, HTTP status 401. |
| 16 | */ |
| 17 | class UnauthorizedException extends ApiException { |
| 18 | /** |
| 19 | * Constructor. |
| 20 | * |
| 21 | * @param string $message The error message. |
| 22 | * @param array $extensions Additional error metadata to surface in the GraphQL `extensions` object. |
| 23 | * @param ?\Throwable $previous The previous throwable for chaining. |
| 24 | */ |
| 25 | public function __construct( |
| 26 | string $message = 'Authentication required.', |
| 27 | array $extensions = array(), |
| 28 | ?\Throwable $previous = null, |
| 29 | ) { |
| 30 | parent::__construct( $message, 'UNAUTHORIZED', $extensions, 401, $previous ); |
| 31 | } |
| 32 | } |
| 33 |