

[ class tree: OpenID ] [ index: OpenID ] [ all elements ]

Class: Auth_OpenID_AX_FetchResponse

Source Location: /zp-extensions/federated_logon/Auth/OpenID/AX.php

Class Auth_OpenID_AX_FetchResponse

Class Overview

A fetch_response attribute exchange message.

Located in /zp-extensions/federated_logon/Auth/OpenID/AX.php [line 793]

Auth_OpenID_Extension
   |
   --Auth_OpenID_AX_Message
      |
      --Auth_OpenID_AX_KeyValueMessage
         |
         --Auth_OpenID_AX_FetchResponse

Properties

$mode

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Auth_OpenID_AX_Message

Auth_OpenID_AX_Message::$ns_alias

Auth_OpenID_AX_Message::$ns_uri

Inherited From Auth_OpenID_AX_KeyValueMessage

Auth_OpenID_AX_KeyValueMessage::Auth_OpenID_AX_KeyValueMessage()

Auth_OpenID_AX_KeyValueMessage::addValue()

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.

Auth_OpenID_AX_KeyValueMessage::count()

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

Auth_OpenID_AX_KeyValueMessage::get()

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

Auth_OpenID_AX_KeyValueMessage::getSingle()

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.

Auth_OpenID_AX_KeyValueMessage::parseExtensionArgs()

Parse attribute exchange key/value arguments into this object.

Auth_OpenID_AX_KeyValueMessage::setValues()

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

Inherited From Auth_OpenID_Extension

Auth_OpenID_Extension::getExtensionArgs()

Get the string arguments that should be added to an OpenID message for this extension.

Auth_OpenID_Extension::toMessage()

Add the arguments from this extension to the provided message.

[ Top ]

Property Summary

mixed

$mode

[ Top ]

Method Summary

static $response	fromSuccessResponse()	Construct a FetchResponse object from an OpenID library SuccessResponse object.
Auth_OpenID_AX_FetchResponse	Auth_OpenID_AX_FetchResponse()
$args	getExtensionArgs()	Serialize this object into arguments in the attribute exchange namespace
$result	parseExtensionArgs()

[ Top ]

Properties

mixed $mode = 'fetch_response' [line 794]

Redefinition of:

Auth_OpenID_AX_Message::$mode: mode: The type of this attribute exchange message. This must be overridden in subclasses.

[ Top ]

Methods

static method fromSuccessResponse [line 925]

static $response fromSuccessResponse(
success_response:
$success_response, [signed:
$signed = true] 
)

Construct a FetchResponse object from an OpenID library SuccessResponse object.

Parameters:

success_response:	$success_response:	A successful id_res response object
signed:	$signed:	Whether non-signed args should be processsed. If True (the default), only signed arguments will be processsed.

API Tags:

Return:

A FetchResponse containing the data from the OpenID message

[ Top ]

Constructor Auth_OpenID_AX_FetchResponse [line 796]

Auth_OpenID_AX_FetchResponse Auth_OpenID_AX_FetchResponse(
[
$update_url = null] 
)

Parameters:

$update_url:

[ Top ]

getExtensionArgs [line 810]

$args getExtensionArgs(
[
$request = null] 
)

Serialize this object into arguments in the attribute exchange namespace

Parameters:

$request:

API Tags:

Return:

The dictionary of unqualified attribute exchange arguments that represent this fetch_response, or Auth_OpenID_AX_Error on error.

Redefinition of:

Auth_OpenID_Extension::getExtensionArgs(): Get the string arguments that should be added to an OpenID message for this extension.

[ Top ]

parseExtensionArgs [line 900]

$result parseExtensionArgs(

$ax_args 
)

Parameters:

$ax_args:

API Tags:

Return:

Auth_OpenID_AX_Error on failure or true on success.

Redefinition of:

Auth_OpenID_AX_KeyValueMessage::parseExtensionArgs(): Parse attribute exchange key/value arguments into this object.

[ Top ]

OpenID

Packages:

core
admin
classes
functions
GoogleMapAPI
JSMin
OpenID
PHPMailer
plugins
Services_JSON

Files:

Classes:

Documentation generated on Tue, 20 Dec 2011 16:06:37 +0100 by phpDocumentor 1.4.3

RSS feeds!

Social networks

Join the Google Groups!

zenphoto-announce
Release announcements and security alerts only (no support)
Subscribe right here:

Email:
Zenphoto Translate
Support and discussion for translators only

Zenphoto

Class: Auth_OpenID_AX_FetchResponse