isOK ( $codes )

Did we receive the status code we expected?

Access

public

Parameters

Parameter

Type

Required

Description

$codes

integer
array

Optional

The status code(s) to expect. Pass an integer for a single acceptable value, or an array of integers for multiple acceptable values.

Returns

Type

Description

boolean

Whether we received the expected status code or not.

Examples

Successful response code should make isOK() return true.

$http = new RequestCore('http://github.com/skyzyx/requestcore/raw/master/_tests/test_request.txt');
$http->send_request();

$response = new ResponseCore(
	$http->get_response_header(),
	$http->get_response_body(),
	$http->get_response_code()
);

var_dump($response->isOK());
Result:
bool(true)

Invalid response code (e.g. 999) should make isOK() fail.

$http = new RequestCore('http://github.com/skyzyx/requestcore/raw/master/_tests/test_request.txt');
$http->send_request();

$response = new ResponseCore(
	$http->get_response_header(),
	$http->get_response_body(),
	999
);

var_dump($response->isOK());
Result:
bool(false)

Standard request with a standard (successful) response code.

$http = new RequestCore('http://github.com/skyzyx/requestcore/raw/master/_tests/test_request.txt');
$http->set_method($http::HTTP_PUT);
$response = $http->send_request(true);

var_dump($response->isOK());
Result:
bool(true)

Test response code 200 explicitly, excluding other valid response codes.

$http = new RequestCore('http://github.com/skyzyx/requestcore/raw/master/_tests/test_request.txt');
$http->set_method($http::HTTP_PUT);
$response = $http->send_request(true);

var_dump($response->isOK(200));
Result:
bool(true)

Source

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback