All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
ApiRequest Class Reference
Inheritance diagram for ApiRequest:
ApiSoapRequest

Public Member Functions

 init ()
 
 getResultClassName ()
 
 getResponseClassName ()
 
 getParams ()
 
 getResponseFormat ()
 
 setResponseFormat ($paramsFormat)
 
 getSessionId ()
 
 getSessionToken ()
 
 getUsername ()
 
 getPassword ()
 
 getLanguage ()
 
 isSessionTokenRequired ()
 

Static Public Member Functions

static getParamsFromRequest ()
 
static isApiRequest ($moduleName= 'api')
 

Data Fields

const REST = 'REST'
 
const SOAP = 'SOAP'
 
const JSON_FORMAT = 'json'
 
const XML_FORMAT = 'xml'
 

Protected Member Functions

 getModuleId ()
 

Protected Attributes

 $paramsFormat
 
 $requestClass
 
 $resultClassName
 

Detailed Description

Handle API requests.

Definition at line 40 of file ApiRequest.php.

Member Function Documentation

static getParamsFromRequest ( )
static

To be re-declared in children classes.

Definition at line 64 of file ApiRequest.php.

init ( )

Init class.

Definition at line 71 of file ApiRequest.php.

getSessionId ( )

Get sessionId from HTTP headers

Definition at line 113 of file ApiRequest.php.

getSessionToken ( )

Get token from HTTP headers

Definition at line 121 of file ApiRequest.php.

getUsername ( )

Get username from HTTP headers

Definition at line 129 of file ApiRequest.php.

getPassword ( )

Get password from HTTP headers

Definition at line 137 of file ApiRequest.php.

getLanguage ( )

Get language from HTTP headers

Definition at line 145 of file ApiRequest.php.

static isApiRequest (   $moduleName = 'api')
static
Parameters
string$moduleName
Returns
bool

Definition at line 159 of file ApiRequest.php.


The documentation for this class was generated from the following file:
Generated on Sat May 30 2020 07:10:39