Maileon PHP client  1.2.5
Easily integrate your PHP application with Maileon.
com_maileon_api_HTTPResponseCodes Class Reference

Static Public Member Functions

static getStringFromHTTPStatusCode ($httpStatusCode)
 

Public Attributes

const OK = 200
 
const CREATED = 201
 
const ACCEPTED = 202
 
const NO_CONTENT = 204
 
const MOVED_PERMANENTLY = 301
 
const SEE_OTHER = 303
 
const NOT_MODIFIED = 304
 
const TEMPORARY_REDIRECT = 307
 
const BAD_REQUEST = 400
 
const UNAUTHORIZED = 401
 
const FORBIDDEN = 403
 
const NOT_FOUND = 404
 
const NOT_ACCEPTABLE = 406
 
const CONFLICT = 409
 
const GONE = 410
 
const PRECONDITION_FAILED = 412
 
const UNSUPPORTED_MEDIA_TYPE = 415
 
const INTERNAL_SERVER_ERROR = 500
 
const SERVICE_UNAVAILABLE = 503
 

Static Protected Attributes

static $codes
 

Detailed Description

This class allows translating between HTTP response codes and human readable strings

Author
Felix Heinrichs | Trusted Mails GmbH | felix.heinrichs@trusted-mails.com
Marcus Ständer | Trusted Mails GmbH | marcus.staender@trusted-mails.com

Definition at line 9 of file HTTPResponseCodes.php.

Member Function Documentation

static com_maileon_api_HTTPResponseCodes::getStringFromHTTPStatusCode (   $httpStatusCode)
static

Maps a numeric HTTP status code to the corresponding string message.

Parameters
number$httpStatusCodethe HTTP status code to translate
Returns
string the corresponding string message, or an error message if the status code is unkown

Definition at line 138 of file HTTPResponseCodes.php.

Member Data Documentation

const com_maileon_api_HTTPResponseCodes::OK = 200

200 OK, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">HTTP/1.1documentation</a>.

Definition at line 16 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::CREATED = 201

201 Created, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.2">HTTP/1.1documentation</a>.

Definition at line 21 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::ACCEPTED = 202

202 Accepted, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.3">HTTP/1.1documentation</a>.

Definition at line 26 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::NO_CONTENT = 204

204 No Content, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.5">HTTP/1.1documentation</a>.

Definition at line 31 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::MOVED_PERMANENTLY = 301

301 Moved Permanently, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.2">HTTP/1.1documentation</a>.

Definition at line 36 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::SEE_OTHER = 303

303 See Other, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.4">HTTP/1.1documentation</a>.

Definition at line 41 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::NOT_MODIFIED = 304

304 Not Modified, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.5">HTTP/1.1documentation</a>.

Definition at line 46 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::TEMPORARY_REDIRECT = 307

307 Temporary Redirect, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.8">HTTP/1.1documentation</a>.

Definition at line 51 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::BAD_REQUEST = 400

400 Bad Request, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">HTTP/1.1documentation</a>.

Definition at line 56 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::UNAUTHORIZED = 401

401 Unauthorized, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">HTTP/1.1documentation</a>.

Definition at line 61 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::FORBIDDEN = 403

403 Forbidden, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4">HTTP/1.1documentation</a>.

Definition at line 66 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::NOT_FOUND = 404

404 Not Found, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">HTTP/1.1documentation</a>.

Definition at line 71 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::NOT_ACCEPTABLE = 406

406 Not Acceptable, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7">HTTP/1.1documentation</a>.

Definition at line 76 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::CONFLICT = 409

409 Conflict, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10">HTTP/1.1documentation</a>.

Definition at line 81 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::GONE = 410

410 Gone, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11">HTTP/1.1documentation</a>.

Definition at line 86 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::PRECONDITION_FAILED = 412

412 Precondition Failed, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13">HTTP/1.1documentation</a>.

Definition at line 91 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::UNSUPPORTED_MEDIA_TYPE = 415

415 Unsupported Media Type, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16">HTTP/1.1documentation</a>.

Definition at line 96 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::INTERNAL_SERVER_ERROR = 500

500 Internal Server Error, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">HTTP/1.1documentation</a>.

Definition at line 101 of file HTTPResponseCodes.php.

const com_maileon_api_HTTPResponseCodes::SERVICE_UNAVAILABLE = 503

503 Service Unavailable, see ahref="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4">HTTP/1.1documentation</a>.

Definition at line 106 of file HTTPResponseCodes.php.

com_maileon_api_HTTPResponseCodes::$codes
staticprotected
Initial value:
= array(
200 => "OK",
201 => "Created",
202 => "Accepted",
204 => "No Content",
301 => "Moved Permanently",
303 => "See Other",
304 => "Not Modified",
307 => "Temporary Redirect",
400 => "Bad Request",
401 => "Unauthorized",
403 => "Forbidden",
404 => "Not Found",
406 => "Not Acceptable",
409 => "Conflict",
410 => "Gone",
412 => "Precondition Failed",
415 => "Unsupported Media Type",
500 => "Internal Server Error",
503 => "Service Unavailable"
)

Definition at line 108 of file HTTPResponseCodes.php.


The documentation for this class was generated from the following file: