Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* HTTP API: WP_HTTP_Requests_Response class

[2] Fix | Delete

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage HTTP

[5] Fix | Delete

* @since 4.6.0

[6] Fix | Delete

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Core wrapper object for a WpOrg\Requests\Response for standardization.

[10] Fix | Delete

[11] Fix | Delete

* @since 4.6.0

[12] Fix | Delete

[13] Fix | Delete

* @see WP_HTTP_Response

[14] Fix | Delete

[15] Fix | Delete

class WP_HTTP_Requests_Response extends WP_HTTP_Response {

[16] Fix | Delete

/**

[17] Fix | Delete

* Requests Response object.

[18] Fix | Delete

[19] Fix | Delete

* @since 4.6.0

[20] Fix | Delete

* @var \WpOrg\Requests\Response

[21] Fix | Delete

[22] Fix | Delete

protected $response;

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Filename the response was saved to.

[26] Fix | Delete

[27] Fix | Delete

* @since 4.6.0

[28] Fix | Delete

* @var string|null

[29] Fix | Delete

[30] Fix | Delete

protected $filename;

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Constructor.

[34] Fix | Delete

[35] Fix | Delete

* @since 4.6.0

[36] Fix | Delete

[37] Fix | Delete

* @param \WpOrg\Requests\Response $response HTTP response.

[38] Fix | Delete

* @param string $filename Optional. File name. Default empty.

[39] Fix | Delete

[40] Fix | Delete

public function __construct( WpOrg\Requests\Response $response, $filename = '' ) {

[41] Fix | Delete

$this->response = $response;

[42] Fix | Delete

$this->filename = $filename;

[43] Fix | Delete

}

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Retrieves the response object for the request.

[47] Fix | Delete

[48] Fix | Delete

* @since 4.6.0

[49] Fix | Delete

[50] Fix | Delete

* @return WpOrg\Requests\Response HTTP response.

[51] Fix | Delete

[52] Fix | Delete

public function get_response_object() {

[53] Fix | Delete

return $this->response;

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Retrieves headers associated with the response.

[58] Fix | Delete

[59] Fix | Delete

* @since 4.6.0

[60] Fix | Delete

[61] Fix | Delete

* @return \WpOrg\Requests\Utility\CaseInsensitiveDictionary Map of header name to header value.

[62] Fix | Delete

[63] Fix | Delete

public function get_headers() {

[64] Fix | Delete

// Ensure headers remain case-insensitive.

[65] Fix | Delete

$converted = new WpOrg\Requests\Utility\CaseInsensitiveDictionary();

[66] Fix | Delete

[67] Fix | Delete

foreach ( $this->response->headers->getAll() as $key => $value ) {

[68] Fix | Delete

if ( count( $value ) === 1 ) {

[69] Fix | Delete

$converted[ $key ] = $value[0];

[70] Fix | Delete

} else {

[71] Fix | Delete

$converted[ $key ] = $value;

[72] Fix | Delete

}

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

return $converted;

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* Sets all header values.

[80] Fix | Delete

[81] Fix | Delete

* @since 4.6.0

[82] Fix | Delete

[83] Fix | Delete

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

[84] Fix | Delete

[85] Fix | Delete

public function set_headers( $headers ) {

[86] Fix | Delete

$this->response->headers = new WpOrg\Requests\Response\Headers( $headers );

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* Sets a single HTTP header.

[91] Fix | Delete

[92] Fix | Delete

* @since 4.6.0

[93] Fix | Delete

[94] Fix | Delete

* @param string $key Header name.

[95] Fix | Delete

* @param string $value Header value.

[96] Fix | Delete

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

[97] Fix | Delete

* Default true.

[98] Fix | Delete

[99] Fix | Delete

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

[100] Fix | Delete

if ( $replace ) {

[101] Fix | Delete

unset( $this->response->headers[ $key ] );

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

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

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

/**

[108] Fix | Delete

* Retrieves the HTTP return code for the response.

[109] Fix | Delete

[110] Fix | Delete

* @since 4.6.0

[111] Fix | Delete

[112] Fix | Delete

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

[113] Fix | Delete

[114] Fix | Delete

public function get_status() {

[115] Fix | Delete

return $this->response->status_code;

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

/**

[119] Fix | Delete

* Sets the 3-digit HTTP status code.

[120] Fix | Delete

[121] Fix | Delete

* @since 4.6.0

[122] Fix | Delete

[123] Fix | Delete

* @param int $code HTTP status.

[124] Fix | Delete

[125] Fix | Delete

public function set_status( $code ) {

[126] Fix | Delete

$this->response->status_code = absint( $code );

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* Retrieves the response data.

[131] Fix | Delete

[132] Fix | Delete

* @since 4.6.0

[133] Fix | Delete

[134] Fix | Delete

* @return string Response data.

[135] Fix | Delete

[136] Fix | Delete

public function get_data() {

[137] Fix | Delete

return $this->response->body;

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

/**

[141] Fix | Delete

* Sets the response data.

[142] Fix | Delete

[143] Fix | Delete

* @since 4.6.0

[144] Fix | Delete

[145] Fix | Delete

* @param string $data Response data.

[146] Fix | Delete

[147] Fix | Delete

public function set_data( $data ) {

[148] Fix | Delete

$this->response->body = $data;

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete

/**

[152] Fix | Delete

* Retrieves cookies from the response.

[153] Fix | Delete

[154] Fix | Delete

* @since 4.6.0

[155] Fix | Delete

[156] Fix | Delete

* @return WP_HTTP_Cookie[] List of cookie objects.

[157] Fix | Delete

[158] Fix | Delete

public function get_cookies() {

[159] Fix | Delete

$cookies = array();

[160] Fix | Delete

foreach ( $this->response->cookies as $cookie ) {

[161] Fix | Delete

$cookies[] = new WP_Http_Cookie(

[162] Fix | Delete

array(

[163] Fix | Delete

'name' => $cookie->name,

[164] Fix | Delete

'value' => urldecode( $cookie->value ),

[165] Fix | Delete

'expires' => isset( $cookie->attributes['expires'] ) ? $cookie->attributes['expires'] : null,

[166] Fix | Delete

'path' => isset( $cookie->attributes['path'] ) ? $cookie->attributes['path'] : null,

[167] Fix | Delete

'domain' => isset( $cookie->attributes['domain'] ) ? $cookie->attributes['domain'] : null,

[168] Fix | Delete

'host_only' => isset( $cookie->flags['host-only'] ) ? $cookie->flags['host-only'] : null,

[169] Fix | Delete

)

[170] Fix | Delete

);

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

return $cookies;

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

/**

[177] Fix | Delete

* Converts the object to a WP_Http response array.

[178] Fix | Delete

[179] Fix | Delete

* @since 4.6.0

[180] Fix | Delete

[181] Fix | Delete

* @return array WP_Http response array, per WP_Http::request().

[182] Fix | Delete

[183] Fix | Delete

public function to_array() {

[184] Fix | Delete

return array(

[185] Fix | Delete

'headers' => $this->get_headers(),

[186] Fix | Delete

'body' => $this->get_data(),

[187] Fix | Delete

'response' => array(

[188] Fix | Delete

'code' => $this->get_status(),

[189] Fix | Delete

'message' => get_status_header_desc( $this->get_status() ),

[190] Fix | Delete

[191] Fix | Delete

'cookies' => $this->get_cookies(),

[192] Fix | Delete

'filename' => $this->filename,

[193] Fix | Delete

);

[194] Fix | Delete

}

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete