wordpress-seo / src / ai / http-request / domain / exceptions / remote-request-exception.php

remote-request-exception.php in Yoast SEO – Advanced SEO with real-time guidance and built-in AI 28.2, at src/ai/http-request/domain/exceptions/remote-request-exception.php

63 lines 1.9 KB

Raw Download Zip

1	<?php
2
3	// phpcs:disable Yoast.NamingConventions.NamespaceName.MaxExceeded
4
5	// phpcs:disable Yoast.NamingConventions.NamespaceName.TooLong -- Needed in the folder structure.
6	namespace Yoast\WP\SEO\AI\HTTP_Request\Domain\Exceptions;
7
8	use Exception;
9	use Throwable;
10
11	/**
12	* Class Remote_Request_Exception
13	*/
14	abstract class Remote_Request_Exception extends Exception {
15
16	/**
17	* A string error code that can be used to identify a particular type of error.
18	*
19	* @var string
20	*/
21	private $error_identifier;
22
23	/**
24	* The response headers associated with the error, keyed by lower-cased header name.
25	*
26	* @var array<string, string\|array<string>>
27	*/
28	private $response_headers;
29
30	/**
31	* Constructor.
32	*
33	* @param string $message The error message.
34	* @param int $code The error status code.
35	* @param string $error_identifier The error code identifier, used to identify a type of error.
36	* @param Throwable\|null $previous The previously thrown exception.
37	* @param array<string, string\|array<string>> $response_headers The response headers associated with the error.
38	*/
39	public function __construct( $message = '', $code = 0, $error_identifier = '', ?Throwable $previous = null, array $response_headers = [] ) {
40	parent::__construct( $message, $code, $previous );
41	$this->error_identifier = (string) $error_identifier;
42	$this->response_headers = $response_headers;
43	}
44
45	/**
46	* Returns the error identifier.
47	*
48	* @return string The error identifier.
49	*/
50	public function get_error_identifier(): string {
51	return $this->error_identifier;
52	}
53
54	/**
55	* Returns the response headers associated with the error, keyed by lower-cased header name.
56	*
57	* @return array<string, string\|array<string>> The response headers.
58	*/
59	public function get_response_headers(): array {
60	return $this->response_headers;
61	}
62	}
63