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_HELPER

Source Location: /HA.php

Class Overview

HA_ERRORS
   |
   --HA_HELPER

Reponse object main helper.

Constants

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 1677]
Reponse object main helper.



[ Top ]

Class Methods

constructor __construct [line 1703]

HA_HELPER __construct( object $object)

Wrap an object with the helper



Tags:

access:  public


Parameters:

object   $object   An object.

[ Top ]

method currentpage [line 2076]

int|NULL currentpage( )

Get currentpage



Tags:

access:  public


[ Top ]

method error_message [line 1800]

string|NULL error_message( )

Get error_message



Tags:

access:  public


[ Top ]

method has_pagination [line 1883]

bool has_pagination( )

Tells you if the method uses pagination. http://trac.hyves-api.nl/hyves-api/wiki/APIPaginate



Tags:

access:  public


[ Top ]

method has_users [line 1758]

bool has_users( )

Tells you if response contants users.



Tags:

access:  public


[ Top ]

method method [line 1844]

string|NULL method( )

Get method



Tags:

access:  public


[ Top ]

method o [line 1721]

object o( )

Get the response object.



Tags:

access:  public


[ Top ]

method pagination_html [line 1939]

string pagination_html( [NULL|array|string $onclick = NULL], [NULL|array|string $href = NULL], [constant $type = HA_HELPER::PAGINATION_RANGE])

Get pagination as HTML. This is also XHTML, because there is no difference in this case.



Tags:

return:  HTML
access:  public


Parameters:

NULL|array|string   $onclick   The value of the onclick=""
NULL|array|string   $href   The value of href=""
constant   $type   Constant of HA_HELPER::PAGINATION_*, default is HA_HELPER::PAGINATION_NORMAL.

[ Top ]

method request_parameters [line 1813]

object|NULL request_parameters( )

Get request_parameters



Tags:

access:  public


[ Top ]

method request_parameters_as_array [line 1826]

array|NULL request_parameters_as_array( )

Get request_parameters as array



Tags:

access:  public


[ Top ]

method resultsperpage [line 2050]

int|NULL resultsperpage( )

Get resultsperpage



Tags:

access:  public


[ Top ]

method running_milliseconds [line 1870]

int|NULL running_milliseconds( )

Get running_milliseconds http://trac.hyves-api.nl/hyves-api/wiki/APIInfoBlock



Tags:

access:  public


[ Top ]

method timestamp_difference [line 1857]

int|NULL timestamp_difference( )

Get timestamp_difference http://trac.hyves-api.nl/hyves-api/wiki/APIInfoBlock



Tags:

access:  public


[ Top ]

method totalpages [line 2063]

int|NULL totalpages( )

Get totalpages



Tags:

access:  public


[ Top ]

method totalresults [line 2037]

int|NULL totalresults( )

Get totalresults



Tags:

access:  public


[ Top ]

method user [line 1745]

object|NULL user( )

Get users. This function is not called users() because the it's contant is at $this->o()->user.



Tags:

access:  public


[ Top ]

method users_as_objects [line 1771]

array users_as_objects( )

Get user as objects of type HA_HELPER_USER in an array.



Tags:

access:  public


[ Top ]

Class Constants

PAGINATION_NORMAL =  "normal"

[line 1681]

Pagination style where


[ Top ]

PAGINATION_RANGE =  "range"

[line 1689]

Pagination style where


[ Top ]

PAGINATION_TINY =  "tiny"

[line 1685]

Pagination style where


[ Top ]


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