## Class mr_server_abstract

Description

MR Server Abstract

The server is responsible for security validation and the routing of incoming requests to mr_server_service_abstract.

- author: Mark Nielsen
- abstract:
- example: Example server usage
- example: Example client

Located in /server/abstract.php (line 52)

Direct descendents

Class | Description
--- | ---
mr_server_rest | MR Server Rest

Variable Summary
Zend_Controller_Request_Http $request
mr_server_response_abstract $response
string $responseclass
Zend_Server_Interface $server
string $serviceclass
Zend_Validate $validator
Method Summary
mr_server_abstract __construct (string $serviceclass, string $responseclass, Zend_Validate $validator)
mr_server_abstract document (string $response)
string fault (string $message, [int $code = NULL])
Zend_Controller_Request_Http get_request ()
mr_server_response_abstract get_response ()
void|string handle ([array|bool $request = false], [boolean $return = false])
boolean is_successful ()
object new_server ()
void security ()
void send_headers ()
mr_server_abstract simpletest_report (string $response)
Variables
Zend_Controller_Request_Http $request (line 86)

Server request

- access: protected

mr_server_response_abstract $response (line 79)

Response class

- access: protected

string $responseclass (line 65)

The response class name

- access: protected

Zend_Server_Interface $server (line 72)

Server instance

- access: protected

string $serviceclass (line 58)

The service class name

- access: protected

Zend_Validate $validator (line 93)

Validator chain to validate the incoming request

- access: protected

Methods
Constructor __construct (line 102)

Constructor

- access: public

mr_server_abstract __construct (string $serviceclass, string $responseclass, Zend_Validate $validator)

- string $serviceclass: The service class name to be used by the server
- string $responseclass: The response class name to use
- Zend_Validate $validator: A vaidator chain used to validate the request

document (line 137)

Document the service and its response

- access: public

mr_server_abstract document (string $response)

- string $response: The server response

fault (line 219)

Generate server fault XML

- access: public

string fault (string $message, [int $code = NULL])

- string $message: Reason for the fault
- int $code: Error code

get_request (line 177)

Get the HTTP request

- access: public

Zend_Controller_Request_Http get_request ()
get_response (line 190)

Get the response instance

- access: protected

mr_server_response_abstract get_response ()
handle (line 246)

Handle web service request

- access: public

void|string handle ([array|bool $request = false], [boolean $return = false])

- array|bool $request: The request (Really only used for testing)
- boolean $return: Return the response or not (Really only used for testing)

is_successful (line 122)

Was the last handle() successful?

- access: public

boolean is_successful ()
new_server (line 115)

Create a new Zend Server instance

- abstract:
- access: protected

object new_server ()

Redefined in descendants as:

- mr_server_rest::new_server() : Use a Zend_Rest_Server

security (line 204)

Security checks

- throws: Exception
- access: public

void security ()
send_headers (line 235)

Send server headers

- access: protected

void send_headers ()
simpletest_report (line 155)

Output something nice when running simpletest

- access: public

mr_server_abstract simpletest_report (string $response)

- string $response: The server response

Documentation generated on Thu, 28 Jun 2012 16:33:45 -0700 by phpDocumentor 1.4.3