tx_openid_store Class Reference

Inheritance diagram for tx_openid_store:

Collaboration diagram for tx_openid_store:

List of all members.

Public Member Functions
	storeAssociation ($serverUrl, $association)
	cleanupAssociations ()
	getAssociation ($serverUrl, $handle=null)
	removeAssociation ($serverUrl, $handle)
	cleanupNonces ()
	useNonce ($serverUrl, $timestamp, $salt)
	reset ()
Public Attributes
const	ASSOCIATION_TABLE_NAME = 'tx_openid_assoc_store'
const	ASSOCIATION_EXPIRATION_SAFETY_INTERVAL = 120
const	NONCE_TABLE_NAME = 'tx_openid_nonce_store'
const	NONCE_STORAGE_TIME = 864000
Protected Member Functions
	doesAssociationExist ($serverUrl, $association)
	updateExistingAssociation ($serverUrl, Auth_OpenID_Association $association)
	storeNewAssociation ($serverUrl, $association)
	updateAssociationTimeStamp ($recordId)

---

Detailed Description

Definition at line 37 of file class.tx_openid_store.php.

---

Member Function Documentation

tx_openid_store::cleanupAssociations

(

)

Removes all expired associations.

Returns:

int A number of removed associations

Reimplemented from Auth_OpenID_OpenIDStore.

Definition at line 73 of file class.tx_openid_store.php.

References $GLOBALS.

Referenced by getAssociation().

tx_openid_store::cleanupNonces

(

)

Removes old nonces

Returns:

void

Reimplemented from Auth_OpenID_OpenIDStore.

Definition at line 142 of file class.tx_openid_store.php.

References $GLOBALS.

tx_openid_store::doesAssociationExist	(	$	serverUrl,
		$	association
	)		[protected]

Checks if such association exists.

Parameters:

string	$serverUrl	Server URL
Auth_OpenID_Association	$association	OpenID association

Returns:

boolean

Definition at line 190 of file class.tx_openid_store.php.

References $GLOBALS, and $row.

Referenced by storeAssociation().

tx_openid_store::getAssociation	(	$	serverUrl,
		$	handle = null
	)

Obtains the association to the server

Parameters:

string	$serverUrl	Server URL
string	$handle	Association handle (optional)

Returns:

Auth_OpenID_Association

Reimplemented from Auth_OpenID_OpenIDStore.

Definition at line 86 of file class.tx_openid_store.php.

References $GLOBALS, $row, cleanupAssociations(), and updateAssociationTimeStamp().

tx_openid_store::removeAssociation	(	$	serverUrl,
		$	handle
	)

Removes the association

Parameters:

string	$serverUrl	Server URL
string	$handle	Association handle (optional)

Returns:

boolean true if the association existed

Reimplemented from Auth_OpenID_OpenIDStore.

Definition at line 128 of file class.tx_openid_store.php.

References $GLOBALS.

tx_openid_store::reset

(

)

Resets the store by removing all data in it

Returns:

void

Reimplemented from Auth_OpenID_OpenIDStore.

Definition at line 178 of file class.tx_openid_store.php.

References $GLOBALS.

tx_openid_store::storeAssociation	(	$	serverUrl,
		$	association
	)

Sores the association for future use

Parameters:

string	$serverUrl	Server URL
Auth_OpenID_Association	$association	OpenID association

Returns:

void

Reimplemented from Auth_OpenID_OpenIDStore.

Definition at line 54 of file class.tx_openid_store.php.

References $GLOBALS, doesAssociationExist(), storeNewAssociation(), and updateExistingAssociation().

tx_openid_store::storeNewAssociation	(	$	serverUrl,
		$	association
	)		[protected]

Stores new association to the database.

Parameters:

$serverUrl	Server URL
$association	OpenID association

Returns:

void

Definition at line 227 of file class.tx_openid_store.php.

References $GLOBALS.

Referenced by storeAssociation().

tx_openid_store::updateAssociationTimeStamp

(

$

recordId

)

[protected]

Updates association time stamp.

Parameters:

$recordId

Association record id in the database

Returns:

void

Definition at line 248 of file class.tx_openid_store.php.

References $GLOBALS.

Referenced by getAssociation().

tx_openid_store::updateExistingAssociation	(	$	serverUrl,
		Auth_OpenID_Association $	association
	)		[protected]

Updates existing association.

Parameters:

string	$serverUrl	Server URL
Auth_OpenID_Association	$association	OpenID association

Returns:

void

Definition at line 207 of file class.tx_openid_store.php.

References $GLOBALS.

Referenced by storeAssociation().

tx_openid_store::useNonce	(	$	serverUrl,
		$	timestamp,
		$	salt
	)

Checks if this nonce was already used

Parameters:

$serverUrl	Server URL
$timestamp	Time stamp
$salt	Nonce value

Returns:

boolean true if nonce was not used before anc can be used now

Reimplemented from Auth_OpenID_OpenIDStore.

Definition at line 154 of file class.tx_openid_store.php.

References $GLOBALS.

---

Member Data Documentation

const tx_openid_store::ASSOCIATION_EXPIRATION_SAFETY_INTERVAL = 120

Definition at line 41 of file class.tx_openid_store.php.

const tx_openid_store::ASSOCIATION_TABLE_NAME = 'tx_openid_assoc_store'

Definition at line 39 of file class.tx_openid_store.php.

const tx_openid_store::NONCE_STORAGE_TIME = 864000

Definition at line 45 of file class.tx_openid_store.php.

const tx_openid_store::NONCE_TABLE_NAME = 'tx_openid_nonce_store'

Definition at line 43 of file class.tx_openid_store.php.

---

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

• typo3/sysext/openid/sv1/class.tx_openid_store.php