Auth_OpenID_AX_KeyValueMessage Klassenreferenz

Abgeleitet von Auth_OpenID_AX_Message.

Basisklasse für Auth_OpenID_AX_FetchResponse und Auth_OpenID_AX_StoreRequest.

Zusammengehörigkeiten von Auth_OpenID_AX_KeyValueMessage:

[Legende]

Öffentliche Methoden
	Auth_OpenID_AX_KeyValueMessage ()
	addValue ($type_uri, $value)
	setValues ($type_uri, &$values)
	_getExtensionKVArgs (&$aliases)
	parseExtensionArgs ($ax_args)
	getSingle ($type_uri, $default=null)
	get ($type_uri)
	count ($type_uri)

---

Ausführliche Beschreibung

Definiert in Zeile 540 der Datei AX.php.

---

Dokumentation der Elementfunktionen

_getExtensionKVArgs

(

&$

aliases

)

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

Parameter:

aliases,:

An alias mapping. Set to None if you don't care about the aliases for this request.

private

Definiert in Zeile 589 der Datei AX.php.

    {
        if ($aliases === null) {
            $aliases = new Auth_OpenID_NamespaceMap();
        }

        $ax_args = array();

        foreach ($this->data as $type_uri => $values) {
            $alias = $aliases->add($type_uri);

            $ax_args['type.' . $alias] = $type_uri;
            $ax_args['count.' . $alias] = strval(count($values));

            foreach ($values as $i => $value) {
              $key = sprintf('value.%s.%d', $alias, $i + 1);
              $ax_args[$key] = $value;
            }
        }

        return $ax_args;

addValue	(	$	type_uri,
		$	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.

Parameter:

	type_uri,:	The URI for the attribute
	value,:	The value to add to the response to the relying party for this attribute

Rückgabe:

null

Definiert in Zeile 558 der Datei AX.php.

    {
        if (!array_key_exists($type_uri, $this->data)) {
            $this->data[$type_uri] = array();
        }

        $values =& $this->data[$type_uri];
        $values[] = $value;

Auth_OpenID_AX_KeyValueMessage

(

)

Definiert in Zeile 542 der Datei AX.php.

    {
        $this->data = array();

count

(

$

type_uri

)

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

Parameter:

type_uri,:

The URI of the attribute

Rückgabe:

int The number of values sent for this attribute. If the attribute was not sent in the response, returns Auth_OpenID_AX_Error.

Definiert in Zeile 774 der Datei AX.php.

    {
        if (array_key_exists($type_uri, $this->data)) {
            return count($this->get($type_uri));
        } else {
            return new Auth_OpenID_AX_Error(
              sprintf("Type URI %s not found in response",
                      $type_uri)
              );
        }

get

(

$

type_uri

)

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

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

Parameter:

type_uri,:

The URI of the attribute

Rückgabe:

$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.

Definiert in Zeile 752 der Datei AX.php.

    {
        if (array_key_exists($type_uri, $this->data)) {
            return $this->data[$type_uri];
        } else {
            return new Auth_OpenID_AX_Error(
              sprintf("Type URI %s not found in response",
                      $type_uri)
              );
        }

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.

Parameter:

	type_uri,:	The URI for the attribute
	default,:	The value to return if the attribute was not sent in the fetch_response.

Rückgabe:

$value Auth_OpenID_AX_Error on failure or the value of the attribute in the fetch_response message, or the default supplied

Definiert in Zeile 721 der Datei AX.php.

    {
        $values = Auth_OpenID::arrayGet($this->data, $type_uri);
        if (!$values) {
            return $default;
        } else if (count($values) == 1) {
            return $values[0];
        } else {
            return new Auth_OpenID_AX_Error(
              sprintf('More than one value present for %s',
                      $type_uri)
              );
        }

parseExtensionArgs

(

$

ax_args

)

Parse attribute exchange key/value arguments into this object.

Parameter:

ax_args,:

The attribute exchange fetch_response arguments, with namespacing removed.

Rückgabe:

Auth_OpenID_AX_Error or true

Erneute Implementation in Auth_OpenID_AX_FetchResponse.

Definiert in Zeile 620 der Datei AX.php.

    {
        $result = $this->_checkMode($ax_args);
        if (Auth_OpenID_AX::isError($result)) {
            return $result;
        }

        $aliases = new Auth_OpenID_NamespaceMap();

        foreach ($ax_args as $key => $value) {
            if (strpos($key, 'type.') === 0) {
                $type_uri = $value;
                $alias = substr($key, 5);

                $result = Auth_OpenID_AX_checkAlias($alias);

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

                $alias = $aliases->addAlias($type_uri, $alias);

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

        foreach ($aliases->iteritems() as $pair) {
            list($type_uri, $alias) = $pair;

            if (array_key_exists('count.' . $alias, $ax_args)) {

                $count_key = 'count.' . $alias;
                $count_s = $ax_args[$count_key];

                $count = Auth_OpenID::intval($count_s);

                if ($count === false) {
                    return new Auth_OpenID_AX_Error(
                      sprintf("Integer value expected for %s, got %s",
                              'count. %s' . $alias, $count_s,
                              Auth_OpenID_AX_UNLIMITED_VALUES)
                                                    );
                }

                $values = array();
                for ($i = 1; $i < $count + 1; $i++) {
                    $value_key = sprintf('value.%s.%d', $alias, $i);

                    if (!array_key_exists($value_key, $ax_args)) {
                      return new Auth_OpenID_AX_Error(
                        sprintf(
                                "No value found for key %s",
                                $value_key));
                    }

                    $value = $ax_args[$value_key];
                    $values[] = $value;
                }
            } else {
                $key = 'value.' . $alias;

                if (!array_key_exists($key, $ax_args)) {
                  return new Auth_OpenID_AX_Error(
                    sprintf(
                            "No value found for key %s",
                            $key));
                }

                $value = $ax_args['value.' . $alias];

                if ($value == '') {
                    $values = array();
                } else {
                    $values = array($value);
                }
            }

            $this->data[$type_uri] = $values;
        }

        return true;

setValues	(	$	type_uri,
		&$	values
	)

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

Parameter:

	type_uri,:	The URI for the attribute
	values,:	A list of values to send for this attribute.

Definiert in Zeile 575 der Datei AX.php.

    {
        $this->data[$type_uri] =& $values;

---

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

• Auth/OpenID/AX.php