WP_HTTP_Response::get_data() - Code Metrics - Inspection of "Merge branch 'master' of git://develop.git.wordpre..." - ntwb/wordpress - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a7cd2a...eabd6c )

by Stephen

created 2016-03-16 21:52 UTC

WP_HTTP_Response::get_data() A

↳ Parent: WP_HTTP_Response

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	3
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php
/**
 * HTTP API: WP_HTTP_Response class
 *
 * @package WordPress
 * @subpackage HTTP
 * @since 4.4.0
 */

/**
 * Core class used to prepare HTTP responses.
 *
 * @since 4.4.0
 */
class WP_HTTP_Response {

	/**
	 * Response data.
	 *
	 * @since 4.4.0
	 * @access public
	 * @var mixed
	 */
	public $data;

	/**
	 * Response headers.
	 *
	 * @since 4.4.0
	 * @access public
	 * @var int
	 */
	public $headers;

	/**
	 * Response status.
	 *
	 * @since 4.4.0
	 * @access public
	 * @var array
	 */
	public $status;

	/**
	 * Constructor.
	 *
	 * @since 4.4.0
	 * @access public
	 *
	 * @param mixed $data    Response data. Default null.
	 * @param int   $status  Optional. HTTP status code. Default 200.
	 * @param array $headers Optional. HTTP header map. Default empty array.
	 */
	public function __construct( $data = null, $status = 200, $headers = array() ) {
		$this->data = $data;
		$this->set_status( $status );
		$this->set_headers( $headers );
	}

	/**
	 * Retrieves headers associated with the response.
	 *
	 * @since 4.4.0
	 * @access public
	 *
	 * @return array Map of header name to header value.
	 */
	public function get_headers() {
		return $this->headers;
	}

	/**
	 * Sets all header values.
	 *
	 * @since 4.4.0
	 * @access public
	 *
	 * @param array $headers Map of header name to header value.
	 */
	public function set_headers( $headers ) {
		$this->headers = $headers;

	}

	/**
	 * Sets a single HTTP header.
	 *
	 * @since 4.4.0
	 * @access public
	 *
	 * @param string $key     Header name.
	 * @param string $value   Header value.
	 * @param bool   $replace Optional. Whether to replace an existing header of the same name.
	 *                        Default true.
	 */
	public function header( $key, $value, $replace = true ) {
		if ( $replace || ! isset( $this->headers[ $key ] ) ) {
			$this->headers[ $key ] = $value;
		} else {
			$this->headers[ $key ] .= ', ' . $value;
		}
	}

	/**
	 * Retrieves the HTTP return code for the response.
	 *
	 * @since 4.4.0
	 * @access public
	 *
	 * @return int The 3-digit HTTP status code.
	 */
	public function get_status() {
		return $this->status;
	}

	/**
	 * Sets the 3-digit HTTP status code.
	 *
	 * @since 4.4.0
	 * @access public
	 *
	 * @param int $code HTTP status.
	 */
	public function set_status( $code ) {
		$this->status = absint( $code );

	}

	/**
	 * Retrieves the response data.
	 *
	 * @since 4.4.0
	 * @access public
	 *
	 * @return mixed Response data.
	 */
	public function get_data() {
		return $this->data;
	}

	/**
	 * Sets the response data.
	 *
	 * @since 4.4.0
	 * @access public
	 *
	 * @param mixed $data Response data.
	 */
	public function set_data( $data ) {
		$this->data = $data;
	}

	/**
	 * Retrieves the response data for JSON serialization.
	 *
	 * It is expected that in most implementations, this will return the same as get_data(),
	 * however this may be different if you want to do custom JSON data handling.
	 *
	 * @since 4.4.0
	 * @access public
	 *
	 * @return mixed Any JSON-serializable value.
	 */
	public function jsonSerialize() {
		return $this->get_data();
	}
}


1			<?php
2			/**
3			* HTTP API: WP_HTTP_Response class
4			*
5			* @package WordPress
6			* @subpackage HTTP
7			* @since 4.4.0
8			*/
9
10			/**
11			* Core class used to prepare HTTP responses.
12			*
13			* @since 4.4.0
14			*/
15			class WP_HTTP_Response {
16
17			/**
18			* Response data.
19			*
20			* @since 4.4.0
21			* @access public
22			* @var mixed
23			*/
24			public $data;
25
26			/**
27			* Response headers.
28			*
29			* @since 4.4.0
30			* @access public
31			* @var int
32			*/
33			public $headers;
34
35			/**
36			* Response status.
37			*
38			* @since 4.4.0
39			* @access public
40			* @var array
41			*/
42			public $status;
43
44			/**
45			* Constructor.
46			*
47			* @since 4.4.0
48			* @access public
49			*
50			* @param mixed $data Response data. Default null.
51			* @param int $status Optional. HTTP status code. Default 200.
52			* @param array $headers Optional. HTTP header map. Default empty array.
53			*/
54			public function __construct( $data = null, $status = 200, $headers = array() ) {
55			$this->data = $data;
56			$this->set_status( $status );
57			$this->set_headers( $headers );
58			}
59
60			/**
61			* Retrieves headers associated with the response.
62			*
63			* @since 4.4.0
64			* @access public
65			*
66			* @return array Map of header name to header value.
67			*/
68			public function get_headers() {
69			return $this->headers;
70			}
71
72			/**
73			* Sets all header values.
74			*
75			* @since 4.4.0
76			* @access public
77			*
78			* @param array $headers Map of header name to header value.
79			*/
80			public function set_headers( $headers ) {
81			$this->headers = $headers;
			0 ignored issues – show Documentation Bug introduced 2016-03-16 22:18 UTC by Report Bug Copy Issue Report It seems like `$headers` of type `array` is incompatible with the declared type `integer` of property `$headers`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
82			}
83
84			/**
85			* Sets a single HTTP header.
86			*
87			* @since 4.4.0
88			* @access public
89			*
90			* @param string $key Header name.
91			* @param string $value Header value.
92			* @param bool $replace Optional. Whether to replace an existing header of the same name.
93			* Default true.
94			*/
95			public function header( $key, $value, $replace = true ) {
96			if ( $replace \|\| ! isset( $this->headers[ $key ] ) ) {
97			$this->headers[ $key ] = $value;
98			} else {
99			$this->headers[ $key ] .= ', ' . $value;
100			}
101			}
102
103			/**
104			* Retrieves the HTTP return code for the response.
105			*
106			* @since 4.4.0
107			* @access public
108			*
109			* @return int The 3-digit HTTP status code.
110			*/
111			public function get_status() {
112			return $this->status;
113			}
114
115			/**
116			* Sets the 3-digit HTTP status code.
117			*
118			* @since 4.4.0
119			* @access public
120			*
121			* @param int $code HTTP status.
122			*/
123			public function set_status( $code ) {
124			$this->status = absint( $code );
			0 ignored issues – show Documentation Bug introduced 2016-03-16 22:18 UTC by Report Bug Copy Issue Report It seems like `absint($code)` of type `integer` or `double` is incompatible with the declared type `array` of property `$status`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
125			}
126
127			/**
128			* Retrieves the response data.
129			*
130			* @since 4.4.0
131			* @access public
132			*
133			* @return mixed Response data.
134			*/
135			public function get_data() {
136			return $this->data;
137			}
138
139			/**
140			* Sets the response data.
141			*
142			* @since 4.4.0
143			* @access public
144			*
145			* @param mixed $data Response data.
146			*/
147			public function set_data( $data ) {
148			$this->data = $data;
149			}
150
151			/**
152			* Retrieves the response data for JSON serialization.
153			*
154			* It is expected that in most implementations, this will return the same as get_data(),
155			* however this may be different if you want to do custom JSON data handling.
156			*
157			* @since 4.4.0
158			* @access public
159			*
160			* @return mixed Any JSON-serializable value.
161			*/
162			public function jsonSerialize() {
163			return $this->get_data();
164			}
165			}
166

ntwb / wordpress

Push — master ( a7cd2a...eabd6c )

WP_HTTP_Response::get_data() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like