1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113:
<?php
/**
* Copyright 2016 LINE Corporation
*
* LINE Corporation licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
namespace LINE\LINEBot;
/**
* A class represents API response.
*
* @package LINE\LINEBot
*/
class Response
{
/** @var int */
private $httpStatus;
/** @var string */
private $body;
/** @var string[] */
private $headers;
/**
* Response constructor.
*
* @param int $httpStatus HTTP status code of response.
* @param string $body Request body.
* @param string[] $headers
*/
public function __construct($httpStatus, $body, $headers = [])
{
$this->httpStatus = $httpStatus;
$this->body = $body;
$this->headers = $headers;
}
/**
* Returns HTTP status code of response.
*
* @return int HTTP status code of response.
*/
public function getHTTPStatus()
{
return $this->httpStatus;
}
/**
* Returns request is succeeded or not.
*
* @return bool Request is succeeded or not.
*/
public function isSucceeded()
{
return $this->httpStatus === 200;
}
/**
* Returns raw response body.
*
* @return string Raw request body.
*/
public function getRawBody()
{
return $this->body;
}
/**
* Returns response body as array (it means, returns JSON decoded body).
*
* @return array Request body that is JSON decoded.
*/
public function getJSONDecodedBody()
{
return json_decode($this->body, true);
}
/**
* Returns the value of the specified response header.
*
* @param string $name A String specifying the header name.
* @return string|null A response header string, or null if the response does not have a header of that name.
*/
public function getHeader($name)
{
if (array_key_exists($name, $this->headers)) {
return $this->headers[$name];
}
return null;
}
/**
* Returns all of response headers.
*
* @return string[] All of the response headers.
*/
public function getHeaders()
{
return $this->headers;
}
}