Référence de la classe Auth_OpenID

Liste de tous les membres

Fonctions membres publiques

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

---

Documentation des fonctions membres

Auth_OpenID::addPrefix	(	$	values,
		$	prefix
	)

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

private

Référencé par Auth_OpenID_GenericConsumer::_doIdRes().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID::appendArgs	(	$	url,
		$	args
	)

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

private

Paramètres:

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.

Renvoie:

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

Référencé par Auth_OpenID_AuthRequest::getMessage(), et Auth_OpenID_Message::toURL().

Voici le graphe d'appel pour cette fonction :

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

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

Référencé par Auth_OpenID_GenericConsumer::_checkReturnTo(), Auth_OpenID_Association::_makePairs(), Auth_OpenID_GenericConsumer::_verifyReturnToArgs(), Auth_OpenID_getSessionTypes(), Auth_OpenID_GenericConsumer::complete(), Auth_OpenID_Decoder::decode(), Auth_OpenID_SRegResponse::extractResponse(), Auth_OpenID_Parse::findFirstHref(), Auth_OpenID_AssociateRequest::fromMessage(), Auth_OpenID_SRegResponse::get(), et Auth_OpenID_SRegRequest::parseExtensionArgs().

Voici le graphe d'appel pour cette fonction :

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

Référencé par Auth_OpenID_AuthRequest::htmlMarkup(), Auth_OpenID_ServerResponse::toHTML(), et Auth_OpenID_ServerError::toHTML().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID::bytes

(

$

str

)

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

Paramètres:

string

$str

The string of bytes to count.

Renvoie:

int The number of bytes in $str.

Référencé par Auth_OpenID_SQLStore::_octify(), Auth_OpenID_HMACSHA1(), Auth_OpenID_MathLibrary::rand(), et Auth_OpenID_DiffieHellman::xorSecret().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID::ensureDir

(

$

dir_name

)

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

Référencé par Auth_OpenID_FileStore::_setup(), et Auth_OpenID_FileStore::Auth_OpenID_FileStore().

Voici le graphe d'appel pour cette fonction :

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

Auth_OpenID::getQuery

(

$

query_str = null

)

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.

private

Référencé par Auth_OpenID_Consumer::complete(), et Auth_OpenID_Server::decodeRequest().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID::httpBuildQuery

(

$

data

)

Implements the PHP 5 'http_build_query' functionality.

private

Paramètres:

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.

Renvoie:

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

Référencé par Auth_Yadis_XRIAppendArgs(), et Auth_OpenID_Message::toURLEncoded().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID::intval

(

$

value

)

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

private

Référencé par Auth_OpenID_GenericConsumer::_extractAssociation().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID::isFailure

(

$

thing

)

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

private

Référencé par 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_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(), plgAuthenticationOpenID::onAuthenticate(), Auth_OpenID_AuthRequest::redirectURL(), Auth_OpenID_Message::setArg(), et Auth_OpenID_Message::updateArgs().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID::log

(

$

format_string

)

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.

Paramètres:

string

$format_string

The sprintf format for the message

Référencé par Auth_OpenID_NamespaceMap::addAlias(), Auth_Yadis_ParanoidHTTPFetcher::get(), Auth_Yadis_ParanoidHTTPFetcher::post(), et Auth_OpenID_Message::setOpenIDNamespace().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID::normalizeUrl

(

$

url

)

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

Paramètres:

string

$url

The URL to be normalized.

Renvoie:

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

Référencé par Auth_OpenID_discoverURI().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID::params_from_string

(

$

str

)

Auth_OpenID::parse_str

(

$

query

)

Replacement for PHP's broken parse_str.

Référencé par Auth_OpenID_GenericConsumer::_verifyReturnToArgs().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID::toBytes

(

$

str

)

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

Référencé par Auth_OpenID_FileStore::_filenameEscape().

Voici le graphe d'appel pour cette fonction :

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

Auth_OpenID::urldefrag

(

$

url

)

Référencé par Auth_OpenID_GenericConsumer::_verifyDiscoverySingle().

Voici le graphe d'appel pour cette fonction :

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

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

Paramètres:

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.

Renvoie:

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

---

La documentation de cette classe a été générée à partir du fichier suivant :

• OpenID.php