Class Auth_OpenID_AX_KeyValueMessage

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

Auth_OpenID_Extension

Extended by

Auth_OpenID_AX_Message

Extended by

Auth_OpenID_AX_KeyValueMessage

Direct known subclasses

Auth_OpenID_AX_FetchResponse, Auth_OpenID_AX_StoreRequest

Package: OpenID
Located at zp-extensions/federated_logon/Auth/OpenID/AX.php

Methods summary
`public`	# `Auth_OpenID_AX_KeyValueMessage( )`
`public null`	# `addValue( type_uri: $type_uri, value: $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. 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` URI for the attribute `$value` value to add to the response to the relying party for this attribute Returns null
`public`	# `setValues( type_uri: $type_uri, values: & $values )` Set the values for the given attribute type. This replaces any values that have already been set for this attribute. Set the values for the given attribute type. This replaces any values that have already been set for this attribute. Parameters `$type_uri` URI for the attribute `$values` list of values to send for this attribute.
`public`	# `_getExtensionKVArgs( aliases: $aliases )` Get the extension arguments for the key/value pairs contained in this message. Get the extension arguments for the key/value pairs contained in this message. Parameters `$aliases` alias mapping. Set to None if you don't care about the aliases for this request.
`public Auth_OpenID_AX_Error`	# `parseExtensionArgs( ax_args: $ax_args )` Parse attribute exchange key/value arguments into this object. Parse attribute exchange key/value arguments into this object. Parameters `$ax_args` attribute exchange fetch_response arguments, with namespacing removed. Returns `Auth_OpenID_AX_Error` or true
`public`	# `getSingle( type_uri: $type_uri, default: $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. 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` URI for the attribute `$default` 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
`public`	# `get( type_uri: $type_uri )` Get the list of values for this attribute in the fetch_response. Get the list of values for this attribute in the fetch_response. 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` 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.
`public`	# `count( type_uri: $type_uri )` Get the number of responses for a particular attribute in this fetch_response message. Get the number of responses for a particular attribute in this fetch_response message. Parameters `$type_uri` 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.

Methods inherited from Auth_OpenID_AX_Message
`_checkMode(), _newArgs()`

Methods inherited from Auth_OpenID_Extension
`getExtensionArgs(), toMessage()`

Properties inherited from Auth_OpenID_AX_Message
`$mode, $ns_alias, $ns_uri`