Public Member Functions | |
getSessionedUser () | |
getOwner () | |
getUser ($guid) | |
clearSession () | |
hasSession ($consumerKey, $consumerSecret, $applicationId=NULL) | |
requireSession ($consumerKey, $consumerSecret, $applicationId=NULL, $callback=NULL) | |
query ($yql) |
YahooSession::getSessionedUser | ( | ) |
YahooSession::getOwner | ( | ) |
YahooSession::getUser | ( | $ | guid | ) |
Gets the user indicated by the GUID given.
$guid | The GUID of the user to get. |
YahooSession::clearSession | ( | ) |
Destroys the current session, effectively logging out the current user.
YahooSession::hasSession | ( | $ | consumerKey, | |
$ | consumerSecret, | |||
$ | applicationId = NULL | |||
) |
Checks to see if there is a session in this PHP page request. Doesn't cause any redirects for the user to log in, for that you should call requireSession().
YahooSession::requireSession | ( | $ | consumerKey, | |
$ | consumerSecret, | |||
$ | applicationId = NULL , |
|||
$ | callback = NULL | |||
) |
Requires that there be a session in this PHP page request. Generates a redirect for the user to log in, if necessary. You must call requireSession() before any data is sent back to the user in order for the redirect to work.
$consumerKey | The OAuth consumer key. | |
$consumerSecret | The OAuth consumer key secret. | |
$applicationId | The application ID, optional. | |
$callback | The callback URL to redirect the user to after they verify the application access. |
YahooSession::query | ( | $ | yql | ) |
Executes the given YQL query.
$yql | The query to execute. |