

[ class tree: OpenID ] [ index: OpenID ] [ all elements ]

Class: Auth_OpenID_Server

Source Location: /zp-extensions/federated_logon/Auth/OpenID/Server.php

Class Auth_OpenID_Server

Class Overview

I handle requests for an OpenID server.

Some types of requests (those which are not checkid requests) may be handed to my handleRequest method, and I will take care of it and return a response.

For your convenience, I also provide an interface to Auth_OpenID_Decoder::decode() and Auth_OpenID_SigningEncoder::encode() through my methods decodeRequest and encodeResponse.

All my state is encapsulated in an Auth_OpenID_OpenIDStore.

Example:

 $oserver = new Auth_OpenID_Server(Auth_OpenID_FileStore($data_path),
                                   "http://example.com/op");
 $request = $oserver->decodeRequest();
 if (in_array($request->mode, array('checkid_immediate',
                                    'checkid_setup'))) {
     if ($app->isAuthorized($request->identity, $request->trust_root)) {
         $response = $request->answer(true);
     } else if ($request->immediate) {
         $response = $request->answer(false);
     } else {
         $app->showDecidePage($request);
         return;
     }
 } else {
     $response = $oserver->handleRequest($request);
 }

 $webresponse = $oserver->encode($response);

Located in /zp-extensions/federated_logon/Auth/OpenID/Server.php [line 1681]

Methods

[ Top ]

Method Summary

Auth_OpenID_Server	Auth_OpenID_Server()
void	decodeRequest()	Decodes a query args array into the appropriate Auth_OpenID_Request object.
void	encodeResponse()	Encodes as response in the appropriate format suitable for sending to the user agent.
Auth_OpenID_ServerResponse	handleRequest()	Handle a request. Given an Auth_OpenID_Request object, call the appropriate Auth_OpenID_Server method to process the request and generate a response.
void	openid_associate()	The callback for 'associate' messages.
void	openid_check_authentication()	The callback for 'check_authentication' messages.

[ Top ]

Methods

Constructor Auth_OpenID_Server [line 1682]

Auth_OpenID_Server Auth_OpenID_Server(

$store, [
$op_endpoint = null] 
)

Parameters:

	$store:
	$op_endpoint:

[ Top ]

decodeRequest [line 1755]

void decodeRequest(
[
$query = null] 
)

Decodes a query args array into the appropriate Auth_OpenID_Request object.

Parameters:

$query:

[ Top ]

encodeResponse [line 1746]

void encodeResponse(

$response 
)

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

Parameters:

$response:

[ Top ]

handleRequest [line 1703]

Auth_OpenID_ServerResponse handleRequest(
Auth_OpenID_Request
$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().

API Tags:

Return:

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

[ Top ]

openid_associate [line 1723]

void openid_associate(

$request 
)

The callback for 'associate' messages.

Parameters:

$request:

[ Top ]

openid_check_authentication [line 1715]

void openid_check_authentication(

$request 
)

The callback for 'check_authentication' messages.

Parameters:

$request:

[ Top ]

OpenID

Packages:

core
admin
classes
functions
GoogleMapAPI
JSMin
OpenID
PHPMailer
plugins
Services_JSON

Files:

Classes:

Documentation generated on Tue, 20 Dec 2011 16:08:06 +0100 by phpDocumentor 1.4.3

RSS feeds!

Social networks

Join the Google Groups!

zenphoto-announce
Release announcements and security alerts only (no support)
Subscribe right here:

Email:
Zenphoto Translate
Support and discussion for translators only

Zenphoto

Class: Auth_OpenID_Server