HCE Project PHP language client API bindings OOP style  1.1.1
Hierarchical Cluster Engine PHP Client Interface API OOP style
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Protected Attributes | List of all members
HCE\transport\Response Class Reference

Public Member Functions

 addResponseItem ($responseItem)
 deleteResponseItem ($index)
 setResponses ($responses)
 getResponseItem ($index=NULL)
 getResponses ()
 setErrorCode ($errorCode)
 getErrorCode ()
 getResponseItemField ($index=NULL, $fieldName=NULL)
 __construct ($responseItem=null)
 __destruct ()

Protected Attributes

 $responseData = array ()
 $error = 0

Detailed Description

HCE Response class implements basic functionality of client-side of HCE Cluster Node application interaction

Definition at line 19 of file Response.inc.php.

Constructor & Destructor Documentation

HCE\transport\Response::__construct (   $responseItem = null)

create instance and set response message data item

Parameters
$responseItem- response data item array

Definition at line 133 of file Response.inc.php.

HCE\transport\Response::__destruct ( )

delete HCE response instance

Definition at line 140 of file Response.inc.php.

Member Function Documentation

HCE\transport\Response::addResponseItem (   $responseItem)

Set response data item

Parameters
$responseItem- is array with fields zmq message, id, body and error code - returned from request

Definition at line 36 of file Response.inc.php.

HCE\transport\Response::deleteResponseItem (   $index)

UnSet response data item

Parameters
$index- item index to delete

Definition at line 48 of file Response.inc.php.

HCE\transport\Response::getErrorCode ( )

Returns erro code of last executed request

Returns
error code

Definition at line 102 of file Response.inc.php.

HCE\transport\Response::getResponseItem (   $index = NULL)

Get response item

Parameters
$index- item index number from zero

Definition at line 71 of file Response.inc.php.

HCE\transport\Response::getResponseItemField (   $index = NULL,
  $fieldName = NULL 
)

Get response item field

Parameters
$index- item number
$fieldName- item field name, supported "error", "ZMQMsg", "id", "body"

Definition at line 115 of file Response.inc.php.

HCE\transport\Response::getResponses ( )

Get response items array

Definition at line 82 of file Response.inc.php.

HCE\transport\Response::setErrorCode (   $errorCode)

Set error code

Parameters
$errorCode- error code

Definition at line 93 of file Response.inc.php.

HCE\transport\Response::setResponses (   $responses)

Set response data items array

Parameters
$responses- array of response data items

Definition at line 60 of file Response.inc.php.

Member Data Documentation

HCE\transport\Response::$error = 0
protected

Response error code of last operation result

Definition at line 28 of file Response.inc.php.

HCE\transport\Response::$responseData = array ()
protected

HCE Response class implements basic functionality of client-side of HCE Cluster Node application interaction

Definition at line 23 of file Response.inc.php.

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