PHPDoctor


NoPackageTagFound\OfuzApiClientBase
class/OfuzApiClientBase.class.php at line 19

Class OfuzApiClientBase

OfuzApiClientBase

public class OfuzApiClientBase

This will basically process the user request. Checks for user authentication and adds data to the database if there is no data error occur. Copyright 2002 - 2007 SQLFusion LLC

Author:
Abhik Chakraborty info@sqlfusion.com
Version:
0.1 Base class for the Ofuz REST API /

Field Summary
mixed

$api_url

mixed

$params

mixed

$postParams

mixed

$response_object

mixed

$return_object

Method Summary
void

__construct(str key, str format)

void

clearRequest()

void

getFormat()

void

getKey()

void

getObject()

void

getParam(mixed var, string parameter)

return request parameter value

void

getResponse()

void

requestQuery()

void

setAuth(mixed key)

void

setFormat(mixed format)

void

setMethod(mixed method)

void

setObject(mixed bool)

void

setParam(mixed var, mixed value, string parameter)

set a parameter value

void

setResponse(mixed response)

array

submit()

Submit the Request to the API

Field Detail

class/OfuzApiClientBase.class.php at line 23

api_url

public mixed $api_url = "http://www.ofuz.net/api.php"

class/OfuzApiClientBase.class.php at line 22

params

public mixed $params = Array()

class/OfuzApiClientBase.class.php at line 21

postParams

public mixed $postParams = array()

class/OfuzApiClientBase.class.php at line 24

response_object

public mixed $response_object

class/OfuzApiClientBase.class.php at line 25

return_object

public mixed $return_object = false

Method Detail

class/OfuzApiClientBase.class.php at line 28

__construct

public void __construct(str key, str format)

class/OfuzApiClientBase.class.php at line 150

clearRequest

public void clearRequest()

class/OfuzApiClientBase.class.php at line 49

getFormat

public void getFormat()

class/OfuzApiClientBase.class.php at line 40

getKey

public void getKey()

class/OfuzApiClientBase.class.php at line 56

getObject

public void getObject()

class/OfuzApiClientBase.class.php at line 109

getParam

public void getParam(mixed var, string parameter)

return request parameter value

Parameters:
parameter - name

class/OfuzApiClientBase.class.php at line 73

getResponse

public void getResponse()

class/OfuzApiClientBase.class.php at line 59

requestQuery

public void requestQuery()

class/OfuzApiClientBase.class.php at line 37

setAuth

public void setAuth(mixed key)

class/OfuzApiClientBase.class.php at line 46

setFormat

public void setFormat(mixed format)

class/OfuzApiClientBase.class.php at line 43

setMethod

public void setMethod(mixed method)

class/OfuzApiClientBase.class.php at line 53

setObject

public void setObject(mixed bool)

class/OfuzApiClientBase.class.php at line 122

setParam

public void setParam(mixed var, mixed value, string parameter)

set a parameter value

Parameters:
parameter - name
parameter - value

class/OfuzApiClientBase.class.php at line 76

setResponse

public void setResponse(mixed response)

class/OfuzApiClientBase.class.php at line 86

submit

public array submit()

Submit the Request to the API

Returns:
with the API response

PHPDoctor