PHP Class Auth_OpenID_AX_KeyValueMessage

Inheritance: extends Auth_OpenID_AX_Message

Mostra file Open project: openid/php-openid Class Usage Examples

Public Methods

Method	Description
__construct ( )
_getExtensionKVArgs ( $aliases )	Get the extension arguments for the key/value pairs contained in this message.
addValue ( $type_uri, $value ) : null	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.
count ( $type_uri )	Get the number of responses for a particular attribute in this fetch_response message.
get ( $type_uri )	Get the list of values for this attribute in the fetch_response.
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.
parseExtensionArgs ( $ax_args ) : Auth_OpenID_AX_Error	Parse attribute exchange key/value arguments into this object.
setValues ( $type_uri, &$values )	Set the values for the given attribute type. This replaces any values that have already been set for this attribute.

Method Details

__construct() public method

public __construct ( )

_getExtensionKVArgs() public method

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

public _getExtensionKVArgs ( $aliases )

addValue() public method

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.

public addValue ( $type_uri, $value ) : null
return	null

count() public method

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

public count ( $type_uri )

get() public method

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

public get ( $type_uri )

getSingle() public method

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.

public getSingle ( $type_uri, $default = null )

parseExtensionArgs() public method

Parse attribute exchange key/value arguments into this object.

public parseExtensionArgs ( $ax_args ) : Auth_OpenID_AX_Error
return	Auth_OpenID_AX_Error	or true

setValues() public method

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

public setValues ( $type_uri, &$values )