Yoast\WP\SEO\MyYoast_Client\Domain

HTTP_Response{} │ final │ Yoast 1.0

Immutable value object for an HTTP response returned by the OAuth client.

Carries the HTTP status code (0 on transport failure), response headers, and parsed body. The body is either an associative array (for JSON responses) or a string (for everything else).

phpcs:disable SlevomatCodingStandard.TypeHints.DisallowMixedTypeHint.DisallowedMixedTypeHint -- Response bodies are heterogeneous by design.

Хуков нет.

Использование

$HTTP_Response = new HTTP_Response();
// use class methods

Методы

1. public __construct( int $status, array $headers, $body )
2. public get_body()
3. public get_body_value( string $key, $fallback = null )
4. public get_headers()
5. public get_status()
6. public has_array_body()
7. public is_successful()
8. public is_transport_failure()

Код HTTP_Response{} HTTP Response{} ^{Yoast 28.3}

final class HTTP_Response {

	/**
	 * HTTP status code. Zero indicates a transport-level failure
	 * (e.g. DNS, TLS, timeout) where no response was received.
	 *
	 * @var int
	 */
	private $status;

	/**
	 * Response headers, keyed by header name.
	 *
	 * @var array<string, string|string[]>
	 */
	private $headers;

	/**
	 * Parsed response body. An associative array for JSON responses,
	 * otherwise the raw body string.
	 *
	 * @var array<string, mixed>|string
	 */
	private $body;

	/**
	 * Constructs an HTTP_Response.
	 *
	 * @param int                            $status  The HTTP status code.
	 * @param array<string, string|string[]> $headers The response headers.
	 * @param array<string, mixed>|string    $body    The parsed body.
	 */
	public function __construct( int $status, array $headers, $body ) {
		$this->status  = $status;
		$this->headers = $headers;
		$this->body    = $body;
	}

	/**
	 * Returns the HTTP status code.
	 *
	 * @return int The HTTP status code (0 on transport failure).
	 */
	public function get_status(): int {
		return $this->status;
	}

	/**
	 * Returns the response headers.
	 *
	 * @return array<string, string|string[]> The response headers.
	 */
	public function get_headers(): array {
		return $this->headers;
	}

	/**
	 * Returns the parsed response body.
	 *
	 * @return array<string, mixed>|string The parsed body.
	 */
	public function get_body() {
		return $this->body;
	}

	/**
	 * Whether the body is an associative array (decoded JSON).
	 *
	 * @return bool True if the body is an associative array.
	 */
	public function has_array_body(): bool {
		return \is_array( $this->body );
	}

	/**
	 * Returns a value from an array body by key, or a fallback when the
	 * body is not an array or the key is missing.
	 *
	 * @param string $key      The key to look up.
	 * @param mixed  $fallback The fallback value.
	 *
	 * @return mixed The looked-up value or the fallback.
	 */
	public function get_body_value( string $key, $fallback = null ) {
		if ( ! \is_array( $this->body ) ) {
			return $fallback;
		}

		return ( $this->body[ $key ] ?? $fallback );
	}

	/**
	 * Whether the status indicates a successful response (2xx).
	 *
	 * @return bool True if the status is 2xx.
	 */
	public function is_successful(): bool {
		return ( $this->status >= 200 && $this->status < 300 );
	}

	/**
	 * Whether no response was received (transport failure).
	 *
	 * @return bool True if the status is 0.
	 */
	public function is_transport_failure(): bool {
		return ( $this->status === 0 );
	}
}