<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* HTTP API: WP_HTTP_Response class

[2] Fix | Delete

*

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage HTTP

[5] Fix | Delete

* @since 4.4.0

[6] Fix | Delete

*/

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Core class used to prepare HTTP responses.

[10] Fix | Delete

*

[11] Fix | Delete

* @since 4.4.0

[12] Fix | Delete

*/

[13] Fix | Delete

#[AllowDynamicProperties]

[14] Fix | Delete

class WP_HTTP_Response {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Response data.

[18] Fix | Delete

*

[19] Fix | Delete

* @since 4.4.0

[20] Fix | Delete

* @var mixed

[21] Fix | Delete

*/

[22] Fix | Delete

public $data;

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Response headers.

[26] Fix | Delete

*

[27] Fix | Delete

* @since 4.4.0

[28] Fix | Delete

* @var array

[29] Fix | Delete

*/

[30] Fix | Delete

public $headers;

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Response status.

[34] Fix | Delete

*

[35] Fix | Delete

* @since 4.4.0

[36] Fix | Delete

* @var int

[37] Fix | Delete

*/

[38] Fix | Delete

public $status;

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* Constructor.

[42] Fix | Delete

*

[43] Fix | Delete

* @since 4.4.0

[44] Fix | Delete

*

[45] Fix | Delete

* @param mixed $data Response data. Default null.

[46] Fix | Delete

* @param int $status Optional. HTTP status code. Default 200.

[47] Fix | Delete

* @param array $headers Optional. HTTP header map. Default empty array.

[48] Fix | Delete

*/

[49] Fix | Delete

public function __construct( $data = null, $status = 200, $headers = array() ) {

[50] Fix | Delete

$this->set_data( $data );

[51] Fix | Delete

$this->set_status( $status );

[52] Fix | Delete

$this->set_headers( $headers );

[53] Fix | Delete

}

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* Retrieves headers associated with the response.

[57] Fix | Delete

*

[58] Fix | Delete

* @since 4.4.0

[59] Fix | Delete

*

[60] Fix | Delete

* @return array Map of header name to header value.

[61] Fix | Delete

*/

[62] Fix | Delete

public function get_headers() {

[63] Fix | Delete

return $this->headers;

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Sets all header values.

[68] Fix | Delete

*

[69] Fix | Delete

* @since 4.4.0

[70] Fix | Delete

*

[71] Fix | Delete

* @param array $headers Map of header name to header value.

[72] Fix | Delete

*/

[73] Fix | Delete

public function set_headers( $headers ) {

[74] Fix | Delete

$this->headers = $headers;

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

/**

[78] Fix | Delete

* Sets a single HTTP header.

[79] Fix | Delete

*

[80] Fix | Delete

* @since 4.4.0

[81] Fix | Delete

*

[82] Fix | Delete

* @param string $key Header name.

[83] Fix | Delete

* @param string $value Header value.

[84] Fix | Delete

* @param bool $replace Optional. Whether to replace an existing header of the same name.

[85] Fix | Delete

* Default true.

[86] Fix | Delete

*/

[87] Fix | Delete

public function header( $key, $value, $replace = true ) {

[88] Fix | Delete

if ( $replace || ! isset( $this->headers[ $key ] ) ) {

[89] Fix | Delete

$this->headers[ $key ] = $value;

[90] Fix | Delete

} else {

[91] Fix | Delete

$this->headers[ $key ] .= ', ' . $value;

[92] Fix | Delete

}

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

/**

[96] Fix | Delete

* Retrieves the HTTP return code for the response.

[97] Fix | Delete

*

[98] Fix | Delete

* @since 4.4.0

[99] Fix | Delete

*

[100] Fix | Delete

* @return int The 3-digit HTTP status code.

[101] Fix | Delete

*/

[102] Fix | Delete

public function get_status() {

[103] Fix | Delete

return $this->status;

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Sets the 3-digit HTTP status code.

[108] Fix | Delete

*

[109] Fix | Delete

* @since 4.4.0

[110] Fix | Delete

*

[111] Fix | Delete

* @param int $code HTTP status.

[112] Fix | Delete

*/

[113] Fix | Delete

public function set_status( $code ) {

[114] Fix | Delete

$this->status = absint( $code );

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

/**

[118] Fix | Delete

* Retrieves the response data.

[119] Fix | Delete

*

[120] Fix | Delete

* @since 4.4.0

[121] Fix | Delete

*

[122] Fix | Delete

* @return mixed Response data.

[123] Fix | Delete

*/

[124] Fix | Delete

public function get_data() {

[125] Fix | Delete

return $this->data;

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

/**

[129] Fix | Delete

* Sets the response data.

[130] Fix | Delete

*

[131] Fix | Delete

* @since 4.4.0

[132] Fix | Delete

*

[133] Fix | Delete

* @param mixed $data Response data.

[134] Fix | Delete

*/

[135] Fix | Delete

public function set_data( $data ) {

[136] Fix | Delete

$this->data = $data;

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* Retrieves the response data for JSON serialization.

[141] Fix | Delete

*

[142] Fix | Delete

* It is expected that in most implementations, this will return the same as get_data(),

[143] Fix | Delete

* however this may be different if you want to do custom JSON data handling.

[144] Fix | Delete

*

[145] Fix | Delete

* @since 4.4.0

[146] Fix | Delete

*

[147] Fix | Delete

* @return mixed Any JSON-serializable value.

[148] Fix | Delete

*/

[149] Fix | Delete

public function jsonSerialize() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid

[150] Fix | Delete

return $this->get_data();

[151] Fix | Delete

}

[152] Fix | Delete

}

[153] Fix | Delete