RESTClientResponse::get_header() - Code Metrics - robertmain/communique - Measure and Improve Code Quality continuously with Scrutinizer

RESTClientResponse::get_header() A
last analyzed 2017-03-07 13:59 UTC

↳ Parent: RESTClientResponse

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * This file is part of Communique.
 * 
 * @author Robert Main
 * @package Communique
 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Communique;

/**
 * REST Response
 *
 * This class is used to encapsulate the response from the API. Whilst it is used internally, it is also
 * made available to response interceptors for reading from and/or writing to.
 * 
 */
class RESTClientResponse {

	/** @var int The HTTP status code returned by the server */
	public $status;

	/** @var Mixed The response payload from the server */
	public $payload;

	/** @var Array An array of headers returned by the server */
	public $headers;

	/**
	 * Response object constructor. Response properties should be set here (rather than just setting the object properties directly).
	 * @param int    $status  The HTTP status code of the request
	 * @param mixed  $payload The response issued by the API
	 * @param array  $headers Any headers returned by the server
	 */
	public function __construct($status, $payload, array $headers = array()) {
		$this->status = $status;
		$this->payload = $payload;
		$this->headers = $headers;
	}

	/**
	 * Searches the request headers by key
	 * @param  String $key The key of the header to return
	 * @return mixed       The value of the requested header
	 */
	public function get_header($key) {
		return $this->headers[$key];
	}
}

1			<?php
2
3			/**
4			* This file is part of Communique.
5			*
6			* @author Robert Main
7			* @package Communique
8			* @license http://opensource.org/licenses/gpl-license.php GNU Public License
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Communique;
15
16			/**
17			* REST Response
18			*
19			* This class is used to encapsulate the response from the API. Whilst it is used internally, it is also
20			* made available to response interceptors for reading from and/or writing to.
21			*
22			*/
23			class RESTClientResponse {
24
25			/** @var int The HTTP status code returned by the server */
26			public $status;
27
28			/** @var Mixed The response payload from the server */
29			public $payload;
30
31			/** @var Array An array of headers returned by the server */
32			public $headers;
33
34			/**
35			* Response object constructor. Response properties should be set here (rather than just setting the object properties directly).
36			* @param int $status The HTTP status code of the request
37			* @param mixed $payload The response issued by the API
38			* @param array $headers Any headers returned by the server
39			*/
40			public function __construct($status, $payload, array $headers = array()) {
41			$this->status = $status;
42			$this->payload = $payload;
43			$this->headers = $headers;
44			}
45
46			/**
47			* Searches the request headers by key
48			* @param String $key The key of the header to return
49			* @return mixed The value of the requested header
50			*/
51			public function get_header($key) {
52			return $this->headers[$key];
53			}
54			}

robertmain / communique

RESTClientResponse::get_header() A last analyzed 2017-03-07 13:59 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

RESTClientResponse::get_header() A
last analyzed 2017-03-07 13:59 UTC