Référence de la classe Auth_OpenID_AX_KeyValueMessage

Graphe d'héritage de Auth_OpenID_AX_KeyValueMessage:

Graphe de collaboration de Auth_OpenID_AX_KeyValueMessage:

Liste de tous les membres

Fonctions membres publiques

• 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)

---

Documentation des fonctions membres

Auth_OpenID_AX_KeyValueMessage::_getExtensionKVArgs

(

&$

aliases

)

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

Paramètres:

aliases,:

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

private

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.

Paramètres:

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

Renvoie:

null

Auth_OpenID_AX_KeyValueMessage::Auth_OpenID_AX_KeyValueMessage

(

)

Référencé par Auth_OpenID_AX_FetchResponse::Auth_OpenID_AX_FetchResponse().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_AX_KeyValueMessage::count

(

$

type_uri

)

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

Paramètres:

type_uri,:

The URI of the attribute

Renvoie:

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

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 []?

Paramètres:

type_uri,:

The URI of the attribute

Renvoie:

$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.

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.

Paramètres:

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

Renvoie:

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

Auth_OpenID_AX_KeyValueMessage::parseExtensionArgs

(

$

ax_args

)

Parse attribute exchange key/value arguments into this object.

Paramètres:

ax_args,:

The attribute exchange fetch_response arguments, with namespacing removed.

Renvoie:

Auth_OpenID_AX_Error or true

Réimplémentée dans Auth_OpenID_AX_FetchResponse.

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.

Paramètres:

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

---

La documentation de cette classe a été générée à partir du fichier suivant :

• AX.php