OpenID.php
This is the PHP OpenID library by JanRain, Inc.
This module contains core utility functionality used by the library. See Consumer.php and Server.php for the consumer and server implementations.
PHP versions 4 and 5
LICENSE: See the COPYING file included in this distribution.
Tags
Interfaces, Classes, Traits and Enums
- Auth_OpenID
- The OpenID utility function class.
Table of Contents
- Auth_OpenID_digits = "0123456789"
- Auth_OpenID_DO_ABOUT = 'do_about'
- Status code returned when there were no OpenID arguments passed. This code indicates that the caller should return a 200 OK response and display an HTML page that says that this is an OpenID server endpoint.
- Auth_OpenID_DO_AUTH = 'do_auth'
- Status code returned when the caller needs to authenticate the user. The associated value is a {@link Auth_OpenID_ServerRequest} object that can be used to complete the authentication. If the user has taken some authentication action, use the retry() method of the {@link Auth_OpenID_ServerRequest} object to complete the request.
- Auth_OpenID_letters = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
- Defines for regexes and format checking.
- Auth_OpenID_LOCAL_ERROR = 'local_error'
- Status code returned by the server when the only option is to show an error page, since we do not have enough information to redirect back to the consumer. The associated value is an error message that should be displayed on an HTML error page.
- Auth_OpenID_punct = "!\"#\$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
- Auth_OpenID_REDIRECT = 'redirect'
- Status code returned when there is a redirect back to the consumer. The value is the URL to redirect back to. The caller should return a 302 Found redirect with a Location: header containing the URL.
- Auth_OpenID_REMOTE_ERROR = 'remote_error'
- Status code returned when there is an error to return in key-value form to the consumer. The caller should return a 400 Bad Request response with content-type text/plain and the value as the body.
- Auth_OpenID_REMOTE_OK = 'remote_ok'
- Status code returned when there is a key-value form OK response to the consumer. The value associated with this code is the response. The caller should return a 200 OK response with content-type text/plain and the value as the body.
- Auth_OpenID_VERSION = '3.0.3'
- The library version string
- Auth_OpenID_include_init() : mixed
Constants
Auth_OpenID_digits
public
mixed
Auth_OpenID_digits
= "0123456789"
Auth_OpenID_DO_ABOUT
Status code returned when there were no OpenID arguments passed. This code indicates that the caller should return a 200 OK response and display an HTML page that says that this is an OpenID server endpoint.
public
mixed
Auth_OpenID_DO_ABOUT
= 'do_about'
Tags
Auth_OpenID_DO_AUTH
Status code returned when the caller needs to authenticate the user. The associated value is a {@link Auth_OpenID_ServerRequest} object that can be used to complete the authentication. If the user has taken some authentication action, use the retry() method of the {@link Auth_OpenID_ServerRequest} object to complete the request.
public
mixed
Auth_OpenID_DO_AUTH
= 'do_auth'
Tags
Auth_OpenID_letters
Defines for regexes and format checking.
public
mixed
Auth_OpenID_letters
= "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
Auth_OpenID_LOCAL_ERROR
Status code returned by the server when the only option is to show an error page, since we do not have enough information to redirect back to the consumer. The associated value is an error message that should be displayed on an HTML error page.
public
mixed
Auth_OpenID_LOCAL_ERROR
= 'local_error'
Tags
Auth_OpenID_punct
public
mixed
Auth_OpenID_punct
= "!\"#\$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
Auth_OpenID_REDIRECT
Status code returned when there is a redirect back to the consumer. The value is the URL to redirect back to. The caller should return a 302 Found redirect with a Location: header containing the URL.
public
mixed
Auth_OpenID_REDIRECT
= 'redirect'
Tags
Auth_OpenID_REMOTE_ERROR
Status code returned when there is an error to return in key-value form to the consumer. The caller should return a 400 Bad Request response with content-type text/plain and the value as the body.
public
mixed
Auth_OpenID_REMOTE_ERROR
= 'remote_error'
Tags
Auth_OpenID_REMOTE_OK
Status code returned when there is a key-value form OK response to the consumer. The value associated with this code is the response. The caller should return a 200 OK response with content-type text/plain and the value as the body.
public
mixed
Auth_OpenID_REMOTE_OK
= 'remote_ok'
Tags
Auth_OpenID_VERSION
The library version string
public
mixed
Auth_OpenID_VERSION
= '3.0.3'
Functions
Auth_OpenID_include_init()
Auth_OpenID_include_init() : mixed