Auth_OpenID_Server Class Reference

Collaboration diagram for Auth_OpenID_Server:

Public Member Functions
	Auth_OpenID_Server ($store, $op_endpoint=null)
	handleRequest ($request)
	Handle a request. More...
	openid_check_authentication ($request)
	The callback for 'check_authentication' messages. More...
	openid_associate ($request)
	The callback for 'associate' messages. More...
	encodeResponse ($response)
	Encodes as response in the appropriate format suitable for sending to the user agent. More...
	decodeRequest ($query=null)
	Decodes a query args array into the appropriate Auth_OpenID_Request object. More...

Detailed Description

Definition at line 1681 of file Server.php.

Member Function Documentation

Auth_OpenID_Server()

Auth_OpenID_Server::Auth_OpenID_Server	(		$store,
			$op_endpoint = null
	)

Definition at line 1682 of file Server.php.

References Auth_OpenID_getDefaultNegotiator().

    {
        $this->store = $store;
        $this->signatory = new Auth_OpenID_Signatory($this->store);
        $this->encoder = new Auth_OpenID_SigningEncoder($this->signatory);
        $this->decoder = new Auth_OpenID_Decoder($this);
        $this->op_endpoint = $op_endpoint;
        $this->negotiator = Auth_OpenID_getDefaultNegotiator();
    }

Here is the call graph for this function:

decodeRequest()

Auth_OpenID_Server::decodeRequest

(

$query = null

)

Decodes a query args array into the appropriate Auth_OpenID_Request object.

Definition at line 1755 of file Server.php.

References $query, and Auth_OpenID\getQuery().

    {
        if ($query === null) {
            $query = Auth_OpenID::getQuery();
        }

        return $this->decoder->decode($query);
    }

Here is the call graph for this function:

encodeResponse()

Auth_OpenID_Server::encodeResponse

(

$response

)

Encodes as response in the appropriate format suitable for sending to the user agent.

Definition at line 1746 of file Server.php.

    {
        return $this->encoder->encode($response);
    }

handleRequest()

Auth_OpenID_Server::handleRequest

(

$request

)

Handle a request.

Given an Auth_OpenID_Request object, call the appropriate Auth_OpenID_Server method to process the request and generate a response.

Parameters

Auth_OpenID_Request

$request

An Auth_OpenID_Request returned by Auth_OpenID_Server::decodeRequest().

Returns

Auth_OpenID_ServerResponse $response A response object capable of generating a user-agent reply.

Definition at line 1703 of file Server.php.

    {
        if (method_exists($this, "openid_" . $request->mode)) {
            $handler = array($this, "openid_" . $request->mode);
            return call_user_func($handler, &$request);
        }
        return null;
    }

openid_associate()

Auth_OpenID_Server::openid_associate

(

$request

)

The callback for 'associate' messages.

Definition at line 1723 of file Server.php.

    {
        $assoc_type = $request->assoc_type;
        $session_type = $request->session->session_type;
        if ($this->negotiator->isAllowed($assoc_type, $session_type)) {
            $assoc = $this->signatory->createAssociation(false,
                                                         $assoc_type);
            return $request->answer($assoc);
        } else {
            $message = sprintf('Association type %s is not supported with '.
                               'session type %s', $assoc_type, $session_type);
            list($preferred_assoc_type, $preferred_session_type) =
                $this->negotiator->getAllowedType();
            return $request->answerUnsupported($message,
                                               $preferred_assoc_type,
                                               $preferred_session_type);
        }
    }

openid_check_authentication()

Auth_OpenID_Server::openid_check_authentication

(

$request

)

The callback for 'check_authentication' messages.

Definition at line 1715 of file Server.php.

    {
        return $request->answer($this->signatory);
    }

---

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

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