Auth_OpenID_SuccessResponse Class Reference

Inheritance diagram for Auth_OpenID_SuccessResponse:

Collaboration diagram for Auth_OpenID_SuccessResponse:

Public Member Functions
	Auth_OpenID_SuccessResponse ($endpoint, $message, $signed_args=null)
	private More...
	extensionResponse ($namespace_uri, $require_signed)
	Extract signed extension data from the server's response. More...
	isOpenID1 ()
	isSigned ($ns_uri, $ns_key)
	getSigned ($ns_uri, $ns_key, $default=null)
	getSignedNS ($ns_uri)
	getReturnTo ()
	Get the openid.return_to argument from this response. More...
Public Member Functions inherited from Auth_OpenID_ConsumerResponse
	setEndpoint ($endpoint)
	getDisplayIdentifier ()
	Return the display identifier for this response. More...

Data Fields
	$status = Auth_OpenID_SUCCESS
Data Fields inherited from Auth_OpenID_ConsumerResponse
	$status = null

Detailed Description

Definition at line 2024 of file Consumer.php.

Member Function Documentation

Auth_OpenID_SuccessResponse()

Auth_OpenID_SuccessResponse::Auth_OpenID_SuccessResponse	(		$endpoint,
			$message,
			$signed_args = null
	)

private

Definition at line 2030 of file Consumer.php.

    {
        $this->endpoint = $endpoint;
        $this->identity_url = $endpoint->claimed_id;
        $this->signed_args = $signed_args;
        $this->message = $message;

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

extensionResponse()

Auth_OpenID_SuccessResponse::extensionResponse	(		$namespace_uri,
			$require_signed
	)

Extract signed extension data from the server's response.

Parameters

string

$prefix

The extension namespace from which to extract the extension data.

Definition at line 2048 of file Consumer.php.

    {
        if ($require_signed) {
            return $this->getSignedNS($namespace_uri);
        } else {
            return $this->message->getArgs($namespace_uri);
        }
    }

getReturnTo()

Auth_OpenID_SuccessResponse::getReturnTo

(

)

Get the openid.return_to argument from this response.

This is useful for verifying that this request was initiated by this consumer.

Returns

string $return_to The return_to URL supplied to the server on the initial request, or null if the response did not contain an 'openid.return_to' argument.

Definition at line 2109 of file Consumer.php.

References Auth_OpenID_OPENID_NS.

    {
        return $this->getSigned(Auth_OpenID_OPENID_NS, 'return_to');
    }

getSigned()

Auth_OpenID_SuccessResponse::getSigned	(		$ns_uri,
			$ns_key,
			$default = null
	)

Definition at line 2070 of file Consumer.php.

    {
        // Return the specified signed field if available, otherwise
        // return default
        if ($this->isSigned($ns_uri, $ns_key)) {
            return $this->message->getArg($ns_uri, $ns_key, $default);
        } else {
            return $default;
        }
    }

getSignedNS()

Auth_OpenID_SuccessResponse::getSignedNS

(

$ns_uri

)

Definition at line 2081 of file Consumer.php.

References Auth_OpenID\isFailure().

    {
        $args = array();

        $msg_args = $this->message->getArgs($ns_uri);
        if (Auth_OpenID::isFailure($msg_args)) {
            return null;
        }

        foreach ($msg_args as $key => $value) {
            if (!$this->isSigned($ns_uri, $key)) {
                unset($msg_args[$key]);
            }
        }

        return $msg_args;
    }

Here is the call graph for this function:

isOpenID1()

Auth_OpenID_SuccessResponse::isOpenID1

(

)

Definition at line 2057 of file Consumer.php.

    {
        return $this->message->isOpenID1();
    }

isSigned()

Auth_OpenID_SuccessResponse::isSigned	(		$ns_uri,
			$ns_key
	)

Definition at line 2062 of file Consumer.php.

    {
        // Return whether a particular key is signed, regardless of
        // its namespace alias
        return in_array($this->message->getKey($ns_uri, $ns_key),
                        $this->signed_args);
    }

Field Documentation

$status

Auth_OpenID_SuccessResponse::$status = Auth_OpenID_SUCCESS

Definition at line 2025 of file Consumer.php.

---

The documentation for this class was generated from the following file:

• Services/OpenId/lib/Auth/OpenID/Consumer.php