oshyvesapilibphp5
[ class tree: oshyvesapilibphp5 ] [ index: oshyvesapilibphp5 ] [ all elements ]
Packages:
oshyvesapilibphp5


Files:
HA.php

Classes:
authhelper
   HA_AUTH
configurehelper
   HA_C
   HA_CONSUMER
   HA_GLOBAL
   HA_P
   HA_R
   HA_T
   HA_TAGS
callhelper
   HA_CALL
   HA_COL
abstracthelper
   HA_ERRORS
   HA_KEY_SECRET
   HA_KEY_VALUE
   HA_LIST
responsehelper
   HA_HELPER
   HA_HELPER_USER

Class: HA_CALL

Source Location: /HA.php

Class Overview

HA_ERRORS
   |
   --HA_CALL

Object for a single call to the Hyves API.

Methods

Inherited Constants

Class: HA_ERRORS

HA_ERRORS::ERROR_SCOPE_CURL
HA_ERRORS::ERROR_SCOPE_HYVES_API
HA_ERRORS::ERROR_SCOPE_LIBRARY

Inherited Variables

Class: HA_ERRORS

HA_ERRORS::$_runtime_errors

Inherited Methods

Class: HA_ERRORS

HA_ERRORS::addError()
Add an error array
HA_ERRORS::errorCodeToErrorMessage()
Helper for converting error codes within the ERROR_SCOPE_LIBRARY scope to an error message.
HA_ERRORS::getErrors()
Returns an array of error arrays
HA_ERRORS::getLastError()
Returns the last error array or FALSE
HA_ERRORS::hasErrors()
Return TRUE if the object has errors, else FALSE
HA_ERRORS::log()
Log the errors if a log file isset.
HA_ERRORS::nrOfErrors()
Returns the numer of errors

Class Details

[line 926]
Object for a single call to the Hyves API.



[ Top ]

Class Methods

constructor __construct [line 974]

HA_CALL __construct( $mixed 0)

Construct a call.



Tags:

access:  public


Parameters:

$mixed   0   HA_P|HA_T|HA_R|HA_TAGS|HA_CONSUMER|HA_C

[ Top ]

method createCurlHandle [line 1151]

resource|bool createCurlHandle( [constant $request_method = NULL])

Get a cURL instance.



Tags:

return:  Return a cURL resource or FALSE on failure.
access:  public


Parameters:

constant   $request_method   Constant of HA_GLOBAL::REQUEST_*

[ Top ]

method execute [line 1346]

bool execute( )

Execute a call.



Tags:

return:  Returns FALSE if you did not configure your HA_CALL object properly or the connection failed, else TRUE.
access:  public


[ Top ]

method getConfiguration [line 1069]

HA_C getConfiguration( )

Get the HA_C object.



Tags:

return:  Configuration object.
access:  public


[ Top ]

method getConsumer [line 1080]

HA_CONSUMER getConsumer( )

Get the HA_CONSUMER object.



Tags:

return:  Consumer object.
access:  public


[ Top ]

method getCurlHandle [line 1321]

resource getCurlHandle( )

Get the cURL resource.



Tags:

return:  cURL resource.
access:  public


[ Top ]

method getMethod [line 1061]

string getMethod( )

Get the method.



Tags:

return:  Method
access:  public


[ Top ]

method getOAuthRequest [line 1139]

OAuthRequest getOAuthRequest( constant $request_method)

Get an OAuthRequest object.



Tags:

access:  public


Parameters:

constant   $request_method   Constant of HA_GLOBAL::REQUEST_METHOD_*.

[ Top ]

method getParameters [line 1028]

HA_P getParameters( )

Get the HA_P object.



Tags:

return:  Parameters object.
access:  public


[ Top ]

method getResponseAsObject [line 1262]

HA_HELPER getResponseAsObject( )

Turn the response text into an object with helpers.



Tags:

return:  Response helper.
access:  public


[ Top ]

method getResponseAsText [line 1253]

string|NULL getResponseAsText( )

Get the body of a executed cURL resource



Tags:

return:  Response text.
access:  public


[ Top ]

method getResponsefields [line 1039]

HA_R getResponsefields( )

Get the HA_R object.



Tags:

return:  Responsefields object.
access:  public


[ Top ]

method getTags [line 1091]

HA_TAGS getTags( )

Get the HA_TAGS object.



Tags:

return:  Tags object.
access:  public


[ Top ]

method getToken [line 1050]

HA_T getToken( )

Get the HA_T object.



Tags:

return:  Token object.
access:  public


[ Top ]

method setCurlHandle [line 1329]

void setCurlHandle( $curl_handle)

Set the cURL resource.



Tags:

access:  public


Parameters:

   $curl_handle  

[ Top ]

method setResponseText [line 1337]

void setResponseText( $response_text)

Set the response text.



Tags:

access:  public


Parameters:

   $response_text  

[ Top ]

Documentation generated on Sat, 10 Jan 2009 01:27:20 +0100 by phpDocumentor 1.4.1