Auth_OpenID_AX_FetchResponse Klassenreferenz

Abgeleitet von Auth_OpenID_AX_KeyValueMessage.

Zusammengehörigkeiten von Auth_OpenID_AX_FetchResponse:

[Legende]

Öffentliche Methoden
	Auth_OpenID_AX_FetchResponse ($update_url=null)
	getExtensionArgs ($request=null)
	parseExtensionArgs ($ax_args)
	fromSuccessResponse ($success_response, $signed=true)
Datenfelder
	$mode = 'fetch_response'

---

Ausführliche Beschreibung

Definiert in Zeile 792 der Datei AX.php.

---

Dokumentation der Elementfunktionen

Auth_OpenID_AX_FetchResponse

(

$

update_url = null

)

Definiert in Zeile 795 der Datei AX.php.

    {
        $this->Auth_OpenID_AX_KeyValueMessage();
        $this->update_url = $update_url;

fromSuccessResponse	(	$	success_response,
		$	signed = true
	)

Construct a FetchResponse object from an OpenID library SuccessResponse object.

Parameter:

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

Rückgabe:

$response A FetchResponse containing the data from the OpenID message

Definiert in Zeile 924 der Datei AX.php.

    {
        $obj = new Auth_OpenID_AX_FetchResponse();
        if ($signed) {
            $ax_args = $success_response->getSignedNS($obj->ns_uri);
        } else {
            $ax_args = $success_response->message->getArgs($obj->ns_uri);
        }
        if ($ax_args === null || Auth_OpenID::isFailure($ax_args) ||
              sizeof($ax_args) == 0) {
            return null;
        }

        $result = $obj->parseExtensionArgs($ax_args);
        if (Auth_OpenID_AX::isError($result)) {
            #XXX log me
            return null;
        }
        return $obj;

getExtensionArgs

(

$

request = null

)

Serialize this object into arguments in the attribute exchange namespace

Rückgabe:

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

Definiert in Zeile 809 der Datei AX.php.

    {
        $aliases = new Auth_OpenID_NamespaceMap();

        $zero_value_types = array();

        if ($request !== null) {
            // Validate the data in the context of the request (the
            // same attributes should be present in each, and the
            // counts in the response must be no more than the counts
            // in the request)

            foreach ($this->data as $type_uri => $unused) {
                if (!$request->contains($type_uri)) {
                    return new Auth_OpenID_AX_Error(
                      sprintf("Response attribute not present in request: %s",
                              $type_uri)
                      );
                }
            }

            foreach ($request->iterAttrs() as $attr_info) {
                // Copy the aliases from the request so that reading
                // the response in light of the request is easier
                if ($attr_info->alias === null) {
                    $aliases->add($attr_info->type_uri);
                } else {
                    $alias = $aliases->addAlias($attr_info->type_uri,
                                                $attr_info->alias);

                    if ($alias === null) {
                        return new Auth_OpenID_AX_Error(
                          sprintf("Could not add alias %s for URI %s",
                                  $attr_info->alias, $attr_info->type_uri)
                          );
                    }
                }

                if (array_key_exists($attr_info->type_uri, $this->data)) {
                    $values = $this->data[$attr_info->type_uri];
                } else {
                    $values = array();
                    $zero_value_types[] = $attr_info;
                }

                if (($attr_info->count != Auth_OpenID_AX_UNLIMITED_VALUES) &&
                    ($attr_info->count < count($values))) {
                    return new Auth_OpenID_AX_Error(
                      sprintf("More than the number of requested values " .
                              "were specified for %s",
                              $attr_info->type_uri)
                      );
                }
            }
        }

        $kv_args = $this->_getExtensionKVArgs($aliases);

        // Add the KV args into the response with the args that are
        // unique to the fetch_response
        $ax_args = $this->_newArgs();

        // For each requested attribute, put its type/alias and count
        // into the response even if no data were returned.
        foreach ($zero_value_types as $attr_info) {
            $alias = $aliases->getAlias($attr_info->type_uri);
            $kv_args['type.' . $alias] = $attr_info->type_uri;
            $kv_args['count.' . $alias] = '0';
        }

        $update_url = null;
        if ($request) {
            $update_url = $request->update_url;
        } else {
            $update_url = $this->update_url;
        }

        if ($update_url) {
            $ax_args['update_url'] = $update_url;
        }

        Auth_OpenID::update(&$ax_args, $kv_args);

        return $ax_args;

parseExtensionArgs

(

$

ax_args

)

Rückgabe:

$result Auth_OpenID_AX_Error on failure or true on success.

Erneute Implementation von Auth_OpenID_AX_KeyValueMessage.

Definiert in Zeile 899 der Datei AX.php.

    {
        $result = parent::parseExtensionArgs($ax_args);

        if (Auth_OpenID_AX::isError($result)) {
            return $result;
        }

        $this->update_url = Auth_OpenID::arrayGet($ax_args, 'update_url');

        return true;

---

Dokumentation der Datenelemente

$mode = 'fetch_response'

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

Erneute Implementation von Auth_OpenID_AX_Message.

Definiert in Zeile 793 der Datei AX.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• Auth/OpenID/AX.php