Auth_OpenID_SRegResponse Klassenreferenz

Abgeleitet von Auth_OpenID_SRegBase.

Zusammengehörigkeiten von Auth_OpenID_SRegResponse:

[Legende]

Öffentliche Methoden
	Auth_OpenID_SRegResponse ($data=null, $sreg_ns_uri=Auth_OpenID_SREG_NS_URI)
	extractResponse ($request, $data)
	fromSuccessResponse (&$success_response, $signed_only=true)
	getExtensionArgs ()
	get ($field_name, $default=null)
	contents ()
Datenfelder
	$ns_alias = 'sreg'

---

Ausführliche Beschreibung

Definiert in Zeile 417 der Datei SReg.php.

---

Dokumentation der Elementfunktionen

Auth_OpenID_SRegResponse	(	$	data = null,
		$	sreg_ns_uri = Auth_OpenID_SREG_NS_URI
	)

Definiert in Zeile 421 der Datei SReg.php.

    {
        if ($data === null) {
            $this->data = array();
        } else {
            $this->data = $data;
        }

        $this->ns_uri = $sreg_ns_uri;
    }

contents

(

)

Definiert in Zeile 515 der Datei SReg.php.

    {
        return $this->data;
    }

extractResponse	(	$	request,
		$	data
	)

Take a C{L{SRegRequest}} and a dictionary of simple registration values and create a C{L{SRegResponse}} object containing that data.

request: The simple registration request object

data: The simple registration data for this response, as a dictionary from unqualified simple registration field name to string (unicode) value. For instance, the nickname should be stored under the key 'nickname'.

Definiert in Zeile 445 der Datei SReg.php.

    {
        $obj = new Auth_OpenID_SRegResponse();
        $obj->ns_uri = $request->ns_uri;

        foreach ($request->allRequestedFields() as $field) {
            $value = Auth_OpenID::arrayGet($data, $field);
            if ($value !== null) {
                $obj->data[$field] = $value;
            }
        }

        return $obj;
    }

fromSuccessResponse	(	&$	success_response,
		$	signed_only = true
	)

Create a C{L{SRegResponse}} object from a successful OpenID library response (C{L{openid.consumer.consumer.SuccessResponse}}) response message

success_response: A SuccessResponse from consumer.complete()

signed_only: Whether to process only data that was signed in the id_res message from the server.

Returns a simple registration response containing the data that was supplied with the C{id_res} response.

Definiert in Zeile 474 der Datei SReg.php.

    {
        global $Auth_OpenID_sreg_data_fields;

        $obj = new Auth_OpenID_SRegResponse();
        $obj->ns_uri = $obj->_getSRegNS($success_response->message);

        if ($signed_only) {
            $args = $success_response->getSignedNS($obj->ns_uri);
        } else {
            $args = $success_response->message->getArgs($obj->ns_uri);
        }

        if ($args === null || Auth_OpenID::isFailure($args)) {
            return null;
        }

        foreach ($Auth_OpenID_sreg_data_fields as $field_name => $desc) {
            if (in_array($field_name, array_keys($args))) {
                $obj->data[$field_name] = $args[$field_name];
            }
        }

        return $obj;
    }

get	(	$	field_name,
		$	default = null
	)

Definiert in Zeile 506 der Datei SReg.php.

    {
        if (!Auth_OpenID_checkFieldName($field_name)) {
            return null;
        }

        return Auth_OpenID::arrayGet($this->data, $field_name, $default);
    }

getExtensionArgs

(

)

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

Erneute Implementation von Auth_OpenID_Extension.

Definiert in Zeile 500 der Datei SReg.php.

    {
        return $this->data;
    }

---

Dokumentation der Datenelemente

$ns_alias = 'sreg'

Erneute Implementation von Auth_OpenID_Extension.

Definiert in Zeile 419 der Datei SReg.php.

---

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

• Auth/OpenID/SReg.php