Auth_OpenID Class Reference

Static Public Member Functions
static	isFailure ($thing)
static	getQuery ($query_str=null)
static	params_from_string ($str)
static	ensureDir ($dir_name)
static	addPrefix ($values, $prefix)
static	arrayGet ($arr, $key, $fallback=null)
static	parse_str ($query)
static	httpBuildQuery ($data)
static	appendArgs ($url, $args)
static	urlunparse ($scheme, $host, $port=null, $path='/', $query='', $fragment='')
static	normalizeUrl ($url)
static	intval ($value)
static	bytes ($str)
static	toBytes ($str)
static	urldefrag ($url)
static	filter ($callback, &$sequence)
static	update (&$dest, &$src)
static	log ($format_string)
static	autoSubmitHTML ($form, $title="OpenId transaction in progress")

Detailed Description

Definition at line 110 of file OpenID.php.

Member Function Documentation

addPrefix()

static Auth_OpenID::addPrefix (   $values,   $prefix  )

static

Adds a string prefix to all values of an array. Returns a new array containing the prefixed values.

private

Definition at line 226 of file OpenID.php.

Referenced by Auth_OpenID_GenericConsumer\_doIdRes(), and params_from_string().

appendArgs()

static Auth_OpenID::appendArgs (   $url,   $args  )

static

"Appends" query arguments onto a URL. The URL may or may not already have arguments (following a question mark).

private

Parameters

string	$url	A URL, which may or may not already have arguments.
array	$args	Either an array key/value pairs or an array of arrays, each of which holding two values: a key and a value, sequentially. If $args is an ordinary key/value array, the parameters will be added to the URL in sorted alphabetical order; if $args is an array of arrays, their order will be preserved.

Returns

string $url The original URL with the new parameters added.

Definition at line 324 of file OpenID.php.

Referenced by Auth_OpenID_AuthRequest\getMessage(), params_from_string(), and Auth_OpenID_Message\toURL().

arrayGet()

static Auth_OpenID::arrayGet (   $arr,   $key,   $fallback = null  )

static

Convenience function for getting array values. Given an array $arr and a key $key, get the corresponding value from the array or return $default if the key is absent.

private

Definition at line 242 of file OpenID.php.

Referenced by Auth_OpenID_GenericConsumer\_checkReturnTo(), Auth_OpenID_Association\_makePairs(), Auth_OpenID_GenericConsumer\_verifyReturnToArgs(), Auth_OpenID_AX_FetchRequest\Auth_OpenID_AX_FetchRequest(), Auth_OpenID_AX_FetchResponse\Auth_OpenID_AX_FetchResponse(), Auth_OpenID_AX_KeyValueMessage\Auth_OpenID_AX_KeyValueMessage(), Auth_OpenID_getSessionTypes(), Auth_OpenID_PAPE_Response\Auth_OpenID_PAPE_Response(), Auth_OpenID_GenericConsumer\complete(), Auth_OpenID_Decoder\decode(), Auth_OpenID_SRegResponse\extractResponse(), Auth_OpenID_Parse\findFirstHref(), Auth_OpenID_AssociateRequest\fromMessage(), Auth_OpenID_PAPE_Request\fromOpenIDRequest(), Auth_OpenID_SRegResponse\get(), params_from_string(), and Auth_OpenID_SRegRequest\parseExtensionArgs().

autoSubmitHTML()

static Auth_OpenID::autoSubmitHTML (   $form,   $title = "OpenId transaction in progress"  )

static

Definition at line 532 of file OpenID.php.

Referenced by Auth_OpenID_AuthRequest\htmlMarkup(), Auth_OpenID_ServerError\toHTML(), and Auth_OpenID_ServerResponse\toHTML().

bytes()

static Auth_OpenID::bytes (   $str )

static

Count the number of bytes in a string independently of multibyte support conditions.

Parameters

string

$str

The string of bytes to count.

Returns

int The number of bytes in $str.

Definition at line 462 of file OpenID.php.

Referenced by Auth_OpenID_SQLStore\_octify(), Auth_OpenID_HMACSHA1(), params_from_string(), Auth_OpenID_MathLibrary\rand(), and Auth_OpenID_DiffieHellman\xorSecret().

ensureDir()

static Auth_OpenID::ensureDir (   $dir_name )

static

Create dir_name as a directory if it does not exist. If it exists, make sure that it is, in fact, a directory. Returns true if the operation succeeded; false if not.

private

Definition at line 204 of file OpenID.php.

Referenced by Auth_OpenID_FileStore\_setup(), Auth_OpenID_FileStore\Auth_OpenID_FileStore(), and params_from_string().

filter()

static Auth_OpenID::filter (   $callback, &  $sequence  )

static

Definition at line 498 of file OpenID.php.

References $result.

getQuery()

static Auth_OpenID::getQuery (   $query_str = null )

static

Gets the query data from the server environment based on the request method used. If GET was used, this looks at $_SERVER['QUERY_STRING'] directly. If POST was used, this fetches data from the special php://input file stream.

Returns an associative array of the query arguments.

Skips invalid key/value pairs (i.e. keys with no '=value' portion).

Returns an empty array if neither GET nor POST was used, or if POST was used but php://input cannot be opened.

See background: http://lists.openidenabled.com/pipermail/dev/2007-March/000395.html

private

Definition at line 142 of file OpenID.php.

Referenced by Auth_OpenID_Consumer\complete(), and Auth_OpenID_Server\decodeRequest().

httpBuildQuery()

static Auth_OpenID::httpBuildQuery (   $data )

static

Implements the PHP 5 'http_build_query' functionality.

private

Parameters

array

$data

Either an array key/value pairs or an array of arrays, each of which holding two values: a key and a value, sequentially.

Returns

string $result The result of url-encoding the key/value pairs from $data into a URL query string (e.g. "username=bob&id=56").

Definition at line 296 of file OpenID.php.

Referenced by Auth_Yadis_XRIAppendArgs(), params_from_string(), and Auth_OpenID_Message\toURLEncoded().

intval()

static Auth_OpenID::intval (   $value )

static

Replacement (wrapper) for PHP's intval() because it's broken.

private

Definition at line 444 of file OpenID.php.

Referenced by Auth_OpenID_GenericConsumer\_extractAssociation(), Auth_OpenID_AX_FetchRequest\Auth_OpenID_AX_FetchRequest(), Auth_OpenID_AX_KeyValueMessage\Auth_OpenID_AX_KeyValueMessage(), Auth_OpenID_PAPE_Response\Auth_OpenID_PAPE_Response(), Auth_OpenID_PAPE_Request\fromOpenIDRequest(), and params_from_string().

isFailure()

static Auth_OpenID::isFailure (   $thing )

static

Return true if $thing is an Auth_OpenID_FailureResponse object; false if not.

private

Definition at line 118 of file OpenID.php.

Referenced by Auth_OpenID_GenericConsumer\_checkReturnTo(), Auth_OpenID_GenericConsumer\_doIdRes(), Auth_OpenID_GenericConsumer\_extractAssociation(), Auth_OpenID_GenericConsumer\_idResCheckForFields(), Auth_OpenID_GenericConsumer\_idResCheckSignature(), Auth_OpenID_Association\_makePairs(), Auth_OpenID_GenericConsumer\_negotiateAssociation(), Auth_OpenID_GenericConsumer\_verifyDiscoveryResultsOpenID1(), Auth_OpenID_GenericConsumer\_verifyDiscoveryResultsOpenID2(), Auth_OpenID_GenericConsumer\_verifyDiscoveryServices(), Auth_OpenID_GenericConsumer\_verifyReturnToArgs(), Auth_OpenID_AX_FetchResponse\Auth_OpenID_AX_FetchResponse(), Auth_OpenID_Association\checkMessageSignature(), Auth_OpenID_Decoder\decode(), Auth_OpenID_Decoder\defaultDecoder(), Auth_OpenID_Message\delArg(), Auth_OpenID_AuthRequest\formMarkup(), Auth_OpenID_SRegRequest\fromOpenIDRequest(), Auth_OpenID_SRegResponse\fromSuccessResponse(), Auth_OpenID_Message\getArg(), Auth_OpenID_Message\getArgs(), Auth_OpenID_Message\getKey(), Auth_OpenID_SuccessResponse\getSignedNS(), Auth_OpenID_Message\hasKey(), Auth_OpenID_AuthRequest\htmlMarkup(), Auth_OpenID_AuthRequest\redirectURL(), TYPO3\CMS\Openid\OpenidService\sendOpenIDRequest(), Auth_OpenID_Message\setArg(), and Auth_OpenID_Message\updateArgs().

log()

static Auth_OpenID::log (   $format_string )

static

Wrap PHP's standard error_log functionality. Use this to perform all logging. It will interpolate any additional arguments into the format string before logging.

Parameters

string

$format_string

The sprintf format for the message

Definition at line 525 of file OpenID.php.

Referenced by Auth_OpenID_NamespaceMap\addAlias(), Auth_Yadis_ParanoidHTTPFetcher\get(), Auth_Yadis_ParanoidHTTPFetcher\post(), Auth_OpenID_Message\setOpenIDNamespace(), and update().

normalizeUrl()

static Auth_OpenID::normalizeUrl (   $url )

static

Given a URL, this "normalizes" it by adding a trailing slash and / or a leading http:// scheme where necessary. Returns null if the original URL is malformed and cannot be normalized.

private

Parameters

string

$url

The URL to be normalized.

Returns

mixed $new_url The URL after normalization, or null if $url was malformed.

Definition at line 413 of file OpenID.php.

Referenced by Auth_OpenID_discoverURI(), and params_from_string().

params_from_string()

static Auth_OpenID::params_from_string (   $str )

static

Definition at line 178 of file OpenID.php.

References $host, $pairs, $result, $sep, addPrefix(), appendArgs(), arrayGet(), Auth_OpenID_urinorm(), bytes(), ensureDir(), httpBuildQuery(), intval(), normalizeUrl(), parse_str(), toBytes(), urldefrag(), and urlunparse().

parse_str()

static Auth_OpenID::parse_str (   $query )

static

Replacement for PHP's broken parse_str.

Definition at line 262 of file OpenID.php.

Referenced by Auth_OpenID_GenericConsumer\_verifyReturnToArgs(), and params_from_string().

toBytes()

static Auth_OpenID::toBytes (   $str )

static

Get the bytes in a string independently of multibyte support conditions.

Definition at line 471 of file OpenID.php.

Referenced by Auth_OpenID_FileStore\_filenameEscape(), and params_from_string().

update()

static Auth_OpenID::update ( &  $dest, &  $src  )

static

Definition at line 511 of file OpenID.php.

References log().

Referenced by Auth_OpenID_AX_FetchResponse\Auth_OpenID_AX_FetchResponse().

urldefrag()

static Auth_OpenID::urldefrag (   $url )

static

Definition at line 487 of file OpenID.php.

Referenced by Auth_OpenID_GenericConsumer\_verifyDiscoverySingle(), and params_from_string().

urlunparse()

static Auth_OpenID::urlunparse (   $scheme,   $host,   $port = null,   $path = '/',   $query = '',   $fragment = ''  )

static

Implements python's urlunparse, which is not available in PHP. Given the specified components of a URL, this function rebuilds and returns the URL.

private

Parameters

string	$scheme	The scheme (e.g. 'http'). Defaults to 'http'.
string	$host	The host. Required.
string	$port	The port.
string	$path	The path.
string	$query	The query.
string	$fragment	The fragment.

Returns

string $url The URL resulting from assembling the specified components.

Definition at line 368 of file OpenID.php.

Referenced by params_from_string().