YahooSessionStore Interface Reference

The session store interface. More...

List of all members.

Public Member Functions
	hasRequestToken ()
	hasAccessToken ()
	storeRequestToken ($token)
	fetchRequestToken ()
	clearRequestToken ()
	storeAccessToken ($token)
	fetchAccessToken ()
	clearAccessToken ()

---

Detailed Description

The session store interface. Developers are free to implement their own session store implementations and pass them to YahooSession::hasSession, YahooSession::requireSession and YahooSession::clearSession.

---

Member Function Documentation

YahooSessionStore::clearAccessToken

(

)

Clears the access token from the session store.

Returns:

True on success, false otherwise.

YahooSessionStore::clearRequestToken

(

)

Clears the request token from the session store.

Returns:

True on success, false otherwise.

YahooSessionStore::fetchAccessToken

(

)

Fetches and returns the access token from the session store.

Returns:

The access token.

YahooSessionStore::fetchRequestToken

(

)

Fetches and returns the request token from the session store.

Returns:

The request token.

YahooSessionStore::hasAccessToken

(

)

Indicates if the session store has an access token.

Returns:

True if an access token is present, false otherwise.

YahooSessionStore::hasRequestToken

(

)

Indicates if the session store has a request token.

Returns:

True if a request token is present, false otherwise.

YahooSessionStore::storeAccessToken

(

$

token

)

Stores the given access token in the session store.

Parameters:

$token

A PHP stdclass object containing the components of the OAuth access token.

Returns:

True on success, false otherwise.

YahooSessionStore::storeRequestToken

(

$

token

)

Stores the given request token in the session store.

Parameters:

$token

A PHP stdclass object containing the components of the OAuth request token.

Returns:

True on success, false otherwise.

---

The documentation for this interface was generated from the following file:

• lib/YahooSessionStore.inc