CookieSessionStore Class Reference

Cookie-based implementation of the session store. More...

List of all members.

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

---

Detailed Description

Cookie-based implementation of the session store. This is the default session storage used by the Y!OS PHP SDK. Developers are free to implement their own session store implementations and pass them to YahooSession::hasSession, YahooSession::requireSession and YahooSession::clearSession. By default, if no session store is passed to YahooSession::hasSession or YahooSession::requireSession, an instance of a CookieSessionStore is used.

---

Member Function Documentation

CookieSessionStore::clearAccessToken

(

)

Clears the access token from the session store.

Returns:

True on success, false otherwise.

CookieSessionStore::clearRequestToken

(

)

Clears the request token from the session store.

Returns:

True on success, false otherwise.

CookieSessionStore::fetchAccessToken

(

)

Fetches and returns the access token from the session store.

Returns:

The access token.

CookieSessionStore::fetchRequestToken

(

)

Fetches and returns the request token from the session store.

Returns:

The request token.

CookieSessionStore::hasAccessToken

(

)

Indicates if the session store has an access token.

Returns:

True if an access token is present, false otherwise.

CookieSessionStore::hasRequestToken

(

)

Indicates if the session store has a request token.

Returns:

True if a request token is present, false otherwise.

CookieSessionStore::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.

CookieSessionStore::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 class was generated from the following file:

• lib/Yahoo.inc