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

Element index for package oshyvesapilibphp5

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ w ] [ _ ]

_

$_runtime_errors: in file HA.php, variable HA_ERRORS::$_runtime_errors
Array for error arrays.
__construct: in file HA.php, method HA_LIST::__construct()
Create a new instance
__construct: in file HA.php, method HA_KEY_VALUE::__construct()
Create a new instance
__construct: in file HA.php, method HA_KEY_SECRET::__construct()
Create a new instance
__get: in file HA.php, method HA_KEY_VALUE::__get()
Get a key
__get: in file HA.php, method HA_KEY_SECRET::__get()
Magic method for OAuth
__set: in file HA.php, method HA_KEY_VALUE::__set()
Set a key
__construct: in file HA.php, method HA_COL::__construct()
__construct: in file HA.php, method HA_CALL::__construct()
Construct a call.
__construct: in file HA.php, method HA_HELPER_USER::__construct()
Wrap an object with the helper
__construct: in file HA.php, method HA_HELPER::__construct()
Wrap an object with the helper

top

a

add: in file HA.php, method HA_LIST::add()
Add an element
addError: in file HA.php, method HA_ERRORS::addError()
Add an error array
AUTHORIZATION_URL_API: in file HA.php, class constant HA_AUTH::AUTHORIZATION_URL_API
Authorization URL for web applications.
AUTHORIZATION_URL_MOBILE: in file HA.php, class constant HA_AUTH::AUTHORIZATION_URL_MOBILE
Authorization URL for mobile applications.
addCall: in file HA.php, method HA_COL::addCall()
Add a HA_CALL object for batching

top

b

BATCH_CURL: in file HA.php, class constant HA_COL::BATCH_CURL
Batch method constant for using cURL multi
BATCH_HYVES: in file HA.php, class constant HA_COL::BATCH_HYVES
Batch method constant for using Hyves API method 'batch.execute'
birthday: in file HA.php, method HA_HELPER_USER::birthday()
Get birthday
birthday_age: in file HA.php, method HA_HELPER_USER::birthday_age()
Get birthday_age
birthday_day: in file HA.php, method HA_HELPER_USER::birthday_day()
Get birthday_day
birthday_month: in file HA.php, method HA_HELPER_USER::birthday_month()
Get birthday_month
birthday_year: in file HA.php, method HA_HELPER_USER::birthday_year()
Get birthday_year

top

c

createCurlHandle: in file HA.php, method HA_CALL::createCurlHandle()
Get a cURL instance.
cityid: in file HA.php, method HA_HELPER_USER::cityid()
Get cityid
cityname: in file HA.php, method HA_HELPER_USER::cityname()
Get cityname
countryid: in file HA.php, method HA_HELPER_USER::countryid()
Get countryid
countryname: in file HA.php, method HA_HELPER_USER::countryname()
Get countryname
created: in file HA.php, method HA_HELPER_USER::created()
Get created
currentpage: in file HA.php, method HA_HELPER::currentpage()
Get currentpage

top

d

displayname: in file HA.php, method HA_HELPER_USER::displayname()
Get displayname

top

e

errorCodeToErrorMessage: in file HA.php, method HA_ERRORS::errorCodeToErrorMessage()
Helper for converting error codes within the ERROR_SCOPE_LIBRARY scope to an error message.
ERROR_SCOPE_CURL: in file HA.php, class constant HA_ERRORS::ERROR_SCOPE_CURL
Error constant for in the scope of cURL
ERROR_SCOPE_HYVES_API: in file HA.php, class constant HA_ERRORS::ERROR_SCOPE_HYVES_API
Error constant for in the scope of the Hyves API
ERROR_SCOPE_LIBRARY: in file HA.php, class constant HA_ERRORS::ERROR_SCOPE_LIBRARY
Error constant for in the scope of the library
EXPIRATIONTYPE_DEFAULT: in file HA.php, class constant HA_AUTH::EXPIRATIONTYPE_DEFAULT
Default token, valid for 1 hour.
EXPIRATIONTYPE_INFINITE: in file HA.php, class constant HA_AUTH::EXPIRATIONTYPE_INFINITE
Infinite token, if User accepts valid for 2 years.
EXPIRATIONTYPE_USER: in file HA.php, class constant HA_AUTH::EXPIRATIONTYPE_USER
The User chooses the expiredate for the token.
execute: in file HA.php, method HA_COL::execute()
Execute batch.
execute: in file HA.php, method HA_CALL::execute()
Execute a call.
error_message: in file HA.php, method HA_HELPER::error_message()
Get error_message

top

f

fancylayouttag: in file HA.php, method HA_HELPER_USER::fancylayouttag()
Get fancylayouttag
firstname: in file HA.php, method HA_HELPER_USER::firstname()
Get firstname
friendscount: in file HA.php, method HA_HELPER_USER::friendscount()
Get friendscount

top

g

getData: in file HA.php, method HA_KEY_SECRET::getData()
Get the key and secret for debugging
getData: in file HA.php, method HA_LIST::getData()
Get the list for debugging
getData: in file HA.php, method HA_KEY_VALUE::getData()
Get the key-value pairs container for debugging
getErrors: in file HA.php, method HA_ERRORS::getErrors()
Returns an array of error arrays
getKey: in file HA.php, method HA_KEY_SECRET::getKey()
Get the key
getLastError: in file HA.php, method HA_ERRORS::getLastError()
Returns the last error array or FALSE
getSecret: in file HA.php, method HA_KEY_SECRET::getSecret()
Get the secret
getAccessTokens: in file HA.php, method HA_AUTH::getAccessTokens()
Get an access token.
getAuthorizationUrl: in file HA.php, method HA_AUTH::getAuthorizationUrl()
Get the authorization url
getRequestTokens: in file HA.php, method HA_AUTH::getRequestTokens()
Get a request token.
getCallByIndex: in file HA.php, method HA_COL::getCallByIndex()
Get a HA_CALL object by index, starting at 0
getCalls: in file HA.php, method HA_COL::getCalls()
Get an array of HA_CALL objects.
getCallsByTag: in file HA.php, method HA_COL::getCallsByTag()
Get calls by tag.
getConfiguration: in file HA.php, method HA_CALL::getConfiguration()
Get the HA_C object.
getConsumer: in file HA.php, method HA_CALL::getConsumer()
Get the HA_CONSUMER object.
getCurlHandle: in file HA.php, method HA_CALL::getCurlHandle()
Get the cURL resource.
getMethod: in file HA.php, method HA_CALL::getMethod()
Get the method.
getOAuthRequest: in file HA.php, method HA_CALL::getOAuthRequest()
Get an OAuthRequest object.
getParameters: in file HA.php, method HA_CALL::getParameters()
Get the HA_P object.
getResponseAsObject: in file HA.php, method HA_CALL::getResponseAsObject()
Turn the response text into an object with helpers.
getResponseAsText: in file HA.php, method HA_CALL::getResponseAsText()
Get the body of a executed cURL resource
getResponsefields: in file HA.php, method HA_CALL::getResponsefields()
Get the HA_R object.
getTags: in file HA.php, method HA_CALL::getTags()
Get the HA_TAGS object.
getToken: in file HA.php, method HA_CALL::getToken()
Get the HA_T object.
getApiUrl: in file HA.php, method HA_GLOBAL::getApiUrl()
Get api url
getAutoLog: in file HA.php, method HA_GLOBAL::getAutoLog()
Get auto log
getDateTime: in file HA.php, method HA_GLOBAL::getDateTime()
Return the date and time.
getDefaultConfiguration: in file HA.php, method HA_GLOBAL::getDefaultConfiguration()
Get default configuration
getDefaultConsumer: in file HA.php, method HA_GLOBAL::getDefaultConsumer()
Get default consumer
getLogFile: in file HA.php, method HA_GLOBAL::getLogFile()
Get log file
getNrOfCallsExecuted: in file HA.php, method HA_GLOBAL::getNrOfCallsExecuted()
Return the number of calls executed
getRequestMethod: in file HA.php, method HA_GLOBAL::getRequestMethod()
Get request method
getUnixtime: in file HA.php, method HA_GLOBAL::getUnixtime()
Return the unix timestamp.
gender: in file HA.php, method HA_HELPER_USER::gender()
Get gender

top

h

HA.php: procedural page HA.php
has: in file HA.php, method HA_KEY_VALUE::has()
Check if a key is set
has: in file HA.php, method HA_LIST::has()
Check if the element(s) is/are set
hasErrors: in file HA.php, method HA_ERRORS::hasErrors()
Return TRUE if the object has errors, else FALSE
hasKey: in file HA.php, method HA_KEY_SECRET::hasKey()
Check if the key is set
hasSecret: in file HA.php, method HA_KEY_SECRET::hasSecret()
Check if the secret is set
HA_ERRORS: in file HA.php, class HA_ERRORS
Abstract class for errors.
HA_KEY_SECRET: in file HA.php, class HA_KEY_SECRET
Abstract class for Token objects.
HA_KEY_VALUE: in file HA.php, class HA_KEY_VALUE
Abstract class for key-value pairs
HA_LIST: in file HA.php, class HA_LIST
Abstract class for lists.
HA_AUTH: in file HA.php, class HA_AUTH
Helper for authorization.
HA_CALL: in file HA.php, class HA_CALL
Object for a single call to the Hyves API.
HA_COL: in file HA.php, class HA_COL
A collection of HA_CALL objects.
hasDefaultConfiguration: in file HA.php, method HA_GLOBAL::hasDefaultConfiguration()
Check if there is a default configuration
hasDefaultConsumer: in file HA.php, method HA_GLOBAL::hasDefaultConsumer()
Check if there is a default consumer
hasLogFile: in file HA.php, method HA_GLOBAL::hasLogFile()
Is a log file set?
has_string_value: in file HA.php, method HA_GLOBAL::has_string_value()
Helper
HA_C: in file HA.php, class HA_C
Hyves Configuration Object
HA_CONSUMER: in file HA.php, class HA_CONSUMER
Hyves Consumer Object
HA_GLOBAL: in file HA.php, class HA_GLOBAL
Hyves Global object
HA_P: in file HA.php, class HA_P
Hyves Parameters Object
HA_R: in file HA.php, class HA_R
Hyves Responsefields Object
HA_T: in file HA.php, class HA_T
Hyves Token Object
HA_TAGS: in file HA.php, class HA_TAGS
Hyves Tags Object
has_pagination: in file HA.php, method HA_HELPER::has_pagination()
Tells you if the method uses pagination. http://trac.hyves-api.nl/hyves-api/wiki/APIPaginate
has_users: in file HA.php, method HA_HELPER::has_users()
Tells you if response contants users.
HA_HELPER: in file HA.php, class HA_HELPER
Reponse object main helper.
HA_HELPER_USER: in file HA.php, class HA_HELPER_USER
Reponse object user helper.

top

i

incrementNrOfCallsExecuted: in file HA.php, method HA_GLOBAL::incrementNrOfCallsExecuted()
Increment the number of calls executed.

top

l

log: in file HA.php, method HA_ERRORS::log()
Log the errors if a log file isset.
lastname: in file HA.php, method HA_HELPER_USER::lastname()
Get lastname

top

m

mediaid: in file HA.php, method HA_HELPER_USER::mediaid()
Get mediaid
method: in file HA.php, method HA_HELPER::method()
Get method

top

n

nrOfErrors: in file HA.php, method HA_ERRORS::nrOfErrors()
Returns the numer of errors
nrOfCalls: in file HA.php, method HA_COL::nrOfCalls()
Returns the number of HA_CALL objects in the batch
normalizeToString: in file HA.php, method HA_GLOBAL::normalizeToString()
Normalize to string
nickname: in file HA.php, method HA_HELPER_USER::nickname()
Get nickname

top

o

o: in file HA.php, method HA_HELPER::o()
Get the response object.
o: in file HA.php, method HA_HELPER_USER::o()
Returns the response as an object.
onmymind: in file HA.php, method HA_HELPER_USER::onmymind()
Get onmymind

top

p

pagination_html: in file HA.php, method HA_HELPER::pagination_html()
Get pagination as HTML. This is also XHTML, because there is no difference in this case.
PAGINATION_NORMAL: in file HA.php, class constant HA_HELPER::PAGINATION_NORMAL
Pagination style where
PAGINATION_RANGE: in file HA.php, class constant HA_HELPER::PAGINATION_RANGE
Pagination style where
PAGINATION_TINY: in file HA.php, class constant HA_HELPER::PAGINATION_TINY
Pagination style where
profilepicture: in file HA.php, method HA_HELPER_USER::profilepicture()
Get profilepicture
profilepicture_html: in file HA.php, method HA_HELPER_USER::profilepicture_html()
Get profilepicture as (X)HTML
profilevisible: in file HA.php, method HA_HELPER_USER::profilevisible()
Get profilevisible

top

r

remove: in file HA.php, method HA_LIST::remove()
Remove a element
remove: in file HA.php, method HA_KEY_VALUE::remove()
Remove a key
REQUEST_METHOD_GET: in file HA.php, class constant HA_GLOBAL::REQUEST_METHOD_GET
Request method where the data is passed through the URL
REQUEST_METHOD_GET_HEADER: in file HA.php, class constant HA_GLOBAL::REQUEST_METHOD_GET_HEADER
Request method where the data is passed through the URL except for the OAuth data, which is in the Authorization header
REQUEST_METHOD_POST: in file HA.php, class constant HA_GLOBAL::REQUEST_METHOD_POST
Request method where the data is passed through as POST data
REQUEST_METHOD_POST_HEADER: in file HA.php, class constant HA_GLOBAL::REQUEST_METHOD_POST_HEADER
Request method where the data is passed through as POST data except for the OAuth data, which is in the Authorization header (default)
request_parameters: in file HA.php, method HA_HELPER::request_parameters()
Get request_parameters
request_parameters_as_array: in file HA.php, method HA_HELPER::request_parameters_as_array()
Get request_parameters as array
respectscount: in file HA.php, method HA_HELPER_USER::respectscount()
Get respectscount
resultsperpage: in file HA.php, method HA_HELPER::resultsperpage()
Get resultsperpage
running_milliseconds: in file HA.php, method HA_HELPER::running_milliseconds()
Get running_milliseconds http://trac.hyves-api.nl/hyves-api/wiki/APIInfoBlock

top

s

setKey: in file HA.php, method HA_KEY_SECRET::setKey()
Set the key
setSecret: in file HA.php, method HA_KEY_SECRET::setSecret()
Set the secret
setCurlHandle: in file HA.php, method HA_CALL::setCurlHandle()
Set the cURL resource.
setResponseText: in file HA.php, method HA_CALL::setResponseText()
Set the response text.
setApiUrl: in file HA.php, method HA_GLOBAL::setApiUrl()
Set api url
setAutoLog: in file HA.php, method HA_GLOBAL::setAutoLog()
Set auto log
setDefaultConfiguration: in file HA.php, method HA_GLOBAL::setDefaultConfiguration()
Set default configuration
setDefaultConsumer: in file HA.php, method HA_GLOBAL::setDefaultConsumer()
Set default consumer
setLogFile: in file HA.php, method HA_GLOBAL::setLogFile()
Set log file
setRequestMethod: in file HA.php, method HA_GLOBAL::setRequestMethod()
Set request method
scrapscount: in file HA.php, method HA_HELPER_USER::scrapscount()
Get scrapscount
scrapsvisible: in file HA.php, method HA_HELPER_USER::scrapsvisible()
Get scrapsvisible

top

t

testimonialscount: in file HA.php, method HA_HELPER_USER::testimonialscount()
Get testimonialscount
timestamp_difference: in file HA.php, method HA_HELPER::timestamp_difference()
Get timestamp_difference http://trac.hyves-api.nl/hyves-api/wiki/APIInfoBlock
totalpages: in file HA.php, method HA_HELPER::totalpages()
Get totalpages
totalresults: in file HA.php, method HA_HELPER::totalresults()
Get totalresults

top

u

url: in file HA.php, method HA_HELPER_USER::url()
Get url
user: in file HA.php, method HA_HELPER::user()
Get users. This function is not called users() because the it's contant is at $this->o()->user.
userid: in file HA.php, method HA_HELPER_USER::userid()
Get userid
users_as_objects: in file HA.php, method HA_HELPER::users_as_objects()
Get user as objects of type HA_HELPER_USER in an array.

top

w

whitespaces: in file HA.php, method HA_HELPER_USER::whitespaces()
Get whitespaces

top

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