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

Class: HA_AUTH

Source Location: /HA.php

Class Overview

HA_ERRORS
   |
   --HA_AUTH

Helper for authorization.


Constants

Methods


Inherited Constants

Inherited Variables

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 2092]
Helper for authorization.



[ Top ]


Class Methods


static method getAccessTokens [line 2121]

static array|bool getAccessTokens( array $request_tokens)

Get an access token.



Tags:

return:  Returns an array with 'oauth_token', 'oauth_token_secret', 'userid', 'methods', 'expiredate', 'expiredate_readable' or FALSE.
access:  public


Parameters:

array   $request_tokens   Array with 'oauth_token' and 'oauth_token_secret'.

[ Top ]

static method getAuthorizationUrl [line 2176]

static string getAuthorizationUrl( constant $url, array $request_tokens, string $oauth_callback)

Get the authorization url



Tags:

return:  Authorization url
access:  public


Parameters:

constant   $url   Constant of AUTHORIZATION_URL_*.
array   $request_tokens   Request tokens.
string   $oauth_callback   Call back url.

[ Top ]

static method getRequestTokens [line 2150]

static array|bool getRequestTokens( array $methods, constant $expirationtype)

Get a request token.



Tags:

return:  Returns an array with 'oauth_token' and 'oauth_token_secret' or FALSE.
access:  public


Parameters:

array   $methods   Array with methods.
constant   $expirationtype   Constant of HA_ERRORS EXPIRATIONTYPE_*

[ Top ]


Class Constants

AUTHORIZATION_URL_API =  "http://www.hyves.nl/api/authorize/"

[line 2096]

Authorization URL for web applications.


[ Top ]

AUTHORIZATION_URL_MOBILE =  "http://www.hyves.nl/mobile/api/authorize/"

[line 2100]

Authorization URL for mobile applications.


[ Top ]

EXPIRATIONTYPE_DEFAULT =  "default"

[line 2105]

Default token, valid for 1 hour.


[ Top ]

EXPIRATIONTYPE_INFINITE =  "infinite"

[line 2109]

Infinite token, if User accepts valid for 2 years.


[ Top ]

EXPIRATIONTYPE_USER =  "user"

[line 2113]

The User chooses the expiredate for the token.


[ Top ]



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