Docs For Class AtomRequest

Description

Located in /class.atomapi.php (line 1380)

Variable Summary

mixed $auth

mixed $err_no

mixed $httpcode

mixed $method

mixed $payload

mixed $response

mixed $uri

Method Summary

AtomRequest AtomRequest (String $method, String $uri, AuthObject $auth, [String $payload = false])

Int/FALSE error ()

Int/FALSE exec ()

Int/FALSE get_httpcode ()

String/FALSE get_method ()

String/FALSE get_payload ()

String/FALSE get_response ()

String/FALSE get_uri ()

void set_auth (AuthObj $auth)

void set_httpcode (Int $code)

void set_method (String $method)

void set_payload (String $xml)

void set_uri (String $uri)

Variables

mixed $auth (line 1383)

mixed $err_no (line 1387)

mixed $httpcode (line 1386)

mixed $method (line 1381)

mixed $payload (line 1384)

mixed $response (line 1385)

mixed $uri (line 1382)

Methods

Constructor AtomRequest (line 1397)

Creates an object with functions for performing standard Atom requests. $method should be [GET|PUT|POST|DELETE], $uri is the endpoint/uri to execute the request against, $auth is an authentication object (BasicAuth or WSSE) and $payload is the XML of the request, if required (POST|PUT)

AtomRequest AtomRequest (String $method, String $uri, AuthObject $auth, [String $payload = false])

String $method
String $uri
AuthObject $auth
String $payload

error (line 1621)

Returns the last error registered in this class, or FALSE if none

Int/FALSE error ()

exec (line 1507)

Executes the AtomRequest on the URI specified in the object. Returns the HTTP response code, or FALSE on a serious error

return: on error

Int/FALSE exec ()

get_httpcode (line 1608)

Returns the last stored http status code for this AtomRequest

return: on error

Int/FALSE get_httpcode ()

get_method (line 1467)

Returns the current $method set for this AtomRequest. Should be [GET|PUT|POST|DELETE]. Returns FALSE if it is unset.

return: on error

String/FALSE get_method ()

get_payload (line 1494)

Returns the current stored payload, which should be an XML package, or FALSE if it is not set yet.

return: on error

String/FALSE get_payload ()

get_response (line 1581)

Returns the response content from the exec()'d AtomRequest, or FALSE if not set yet

return: on error

String/FALSE get_response ()

get_uri (line 1426)

Returns the URI stored for this AtomRequest to operate against, or FALSE if not set yet

return: on error

String/FALSE get_uri ()

set_auth (line 1440)

Set the authentication object to use for this AtomRequest

void set_auth (AuthObj $auth)

AuthObj $auth

set_httpcode (line 1595)

Internal function, used to update the http status code returned when the AtomRequest is exec()'d

void set_httpcode (Int $code)

Int $code

set_method (line 1454)

Sets the method of this AtomRequest. Allowed values are [GET|PUT|POST|DELETE]

void set_method (String $method)

String $method

set_payload (line 1481)

Set the payload (body) of the AtomRequest. Should be an XML string, and is only required for POST and PUT operations

void set_payload (String $xml)

String $xml

set_uri (line 1413)

Set the URI to execute this AtomRequest against. Should be a fully-qualified URL and start with 'http'

void set_uri (String $uri)

String $uri