Auth_OpenID_AX_KeyValueMessage Class Reference

Inheritance diagram for Auth_OpenID_AX_KeyValueMessage:

[legend]

Collaboration diagram for Auth_OpenID_AX_KeyValueMessage:

[legend]

List of all members.

---

Detailed Description

An abstract class that implements a message that has attribute keys and values. It contains the common code between fetch_response and store_request.

Definition at line 540 of file AX.php.

Public Member Functions
	Auth_OpenID_AX_KeyValueMessage ()
	addValue ($type_uri, $value)
	setValues ($type_uri, &$values)
	_getExtensionKVArgs (&$aliases)
	parseExtensionArgs ($ax_args)
	getSingle ($type_uri, $default=null)
	get ($type_uri)
	count ($type_uri)

---

Member Function Documentation

Auth_OpenID_AX_KeyValueMessage.Auth_OpenID_AX_KeyValueMessage

(

)

Definition at line 542 of file AX.php.

Auth_OpenID_AX_KeyValueMessage.addValue	(	$	type_uri,
		$	value
	)

Add a single value for the given attribute type to the message. If there are already values specified for this type, this value will be sent in addition to the values already specified.

Parameters:

	type_uri,:	The URI for the attribute
	value,:	The value to add to the response to the relying party for this attribute

Returns:

null

Definition at line 558 of file AX.php.

Auth_OpenID_AX_KeyValueMessage.setValues	(	$	type_uri,
		&$	values
	)

Set the values for the given attribute type. This replaces any values that have already been set for this attribute.

Parameters:

	type_uri,:	The URI for the attribute
	values,:	A list of values to send for this attribute.

Definition at line 575 of file AX.php.

Auth_OpenID_AX_KeyValueMessage._getExtensionKVArgs

(

&$

aliases

)

Get the extension arguments for the key/value pairs contained in this message.

Parameters:

aliases,:

An alias mapping. Set to None if you don't care about the aliases for this request.

private

Definition at line 589 of file AX.php.

Auth_OpenID_AX_KeyValueMessage.parseExtensionArgs

(

$

ax_args

)

Parse attribute exchange key/value arguments into this object.

Parameters:

ax_args,:

The attribute exchange fetch_response arguments, with namespacing removed.

Returns:

Auth_OpenID_AX_Error or true

Reimplemented in Auth_OpenID_AX_FetchResponse.

Definition at line 620 of file AX.php.

Auth_OpenID_AX_KeyValueMessage.getSingle	(	$	type_uri,
		$	default = null
	)

Get a single value for an attribute. If no value was sent for this attribute, use the supplied default. If there is more than one value for this attribute, this method will fail.

Parameters:

	type_uri,:	The URI for the attribute
	default,:	The value to return if the attribute was not sent in the fetch_response.

Returns:

$value Auth_OpenID_AX_Error on failure or the value of the attribute in the fetch_response message, or the default supplied

Definition at line 721 of file AX.php.

Auth_OpenID_AX_KeyValueMessage.get

(

$

type_uri

)

Get the list of values for this attribute in the fetch_response.

XXX: what to do if the values are not present? default parameter? this is funny because it's always supposed to return a list, so the default may break that, though it's provided by the user's code, so it might be okay. If no default is supplied, should the return be None or []?

Parameters:

type_uri,:

The URI of the attribute

Returns:

$values The list of values for this attribute in the response. May be an empty list. If the attribute was not sent in the response, returns Auth_OpenID_AX_Error.

Definition at line 752 of file AX.php.

Auth_OpenID_AX_KeyValueMessage.count

(

$

type_uri

)

Get the number of responses for a particular attribute in this fetch_response message.

Parameters:

type_uri,:

The URI of the attribute

Returns:

int The number of values sent for this attribute. If the attribute was not sent in the response, returns Auth_OpenID_AX_Error.

Definition at line 774 of file AX.php.

---

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

• core/openid/Auth/OpenID/AX.php