SimpleOpenID Class Reference

Class to manage OpenID. More...

Public Member Functions
	__construct ()
	Constructor.
	SetOpenIDServer ($a)
	SetOpenIDServer. More...
	SetTrustRoot ($a)
	SetOpenIDServer. More...
	SetCancelURL ($a)
	SetOpenIDServer. More...
	SetApprovedURL ($a)
	SetApprovedURL. More...
	SetRequiredFields ($a)
	SetRequiredFields. More...
	SetOptionalFields ($a)
	SetOptionalFields. More...
	SetIdentity ($a)
	SetIdentity. More...
	GetIdentity ()
	GetIdentity. More...
	GetError ()
	SetOpenIDServer. More...
	ErrorStore ($code, $desc=null)
	ErrorStore. More...
	IsError ()
	IsError. More...
	splitResponse ($response)
	splitResponse More...
	OpenID_Standarize ($openid_identity=null)
	OpenID_Standarize. More...
	array2url ($arr)
	array2url More...
	FSOCK_Request ($url, $method="GET", $params="")
	FSOCK_Request. More...
	CURL_Request ($url, $method="GET", $params="")
	CURL_Request. More...
	HTML2OpenIDServer ($content)
	HTML2OpenIDServer. More...
	GetOpenIDServer ($url= '')
	Get openid server. More...
	GetRedirectURL ()
	GetRedirectURL. More...
	Redirect ()
	Redirect. More...
	ValidateWithServer ()
	ValidateWithServer. More...
	sendDiscoveryRequestToGetXRDS ($url= '')
	Get XRDS response and set possible servers. More...

Detailed Description

Class to manage OpenID.

Definition at line 27 of file openid.class.php.

Member Function Documentation

SimpleOpenID::array2url

(

$arr

)

array2url

Parameters

array

$arr

An array

Returns

false|string false if KO, string of url if OK

Definition at line 280 of file openid.class.php.

Referenced by CURL_Request(), and GetRedirectURL().

SimpleOpenID::CURL_Request	(		$url,
			$method = "GET",
			$params = ""
	)

CURL_Request.

Parameters

string	$url	URL
string	$method	Method
string	$params	Params

Returns

string

Definition at line 336 of file openid.class.php.

References array2url(), and ErrorStore().

SimpleOpenID::ErrorStore	(		$code,
			$desc = null
	)

ErrorStore.

Parameters

string	$code	Code
string	$desc	Description

Returns

void

Definition at line 199 of file openid.class.php.

Referenced by CURL_Request(), FSOCK_Request(), and GetOpenIDServer().

SimpleOpenID::FSOCK_Request	(		$url,
			$method = "GET",
			$params = ""
	)

FSOCK_Request.

Parameters

string	$url	URL
string	$method	Method
string	$params	Params

Returns

boolean|void True if success, False if error

Definition at line 302 of file openid.class.php.

References ErrorStore().

SimpleOpenID::GetError

(

)

SetOpenIDServer.

Returns

void

Definition at line 184 of file openid.class.php.

SimpleOpenID::GetIdentity

(

)

GetIdentity.

Returns

string

Definition at line 171 of file openid.class.php.

SimpleOpenID::GetOpenIDServer

(

$url = ''

)

Get openid server.

Parameters

string

$url

Url to found endpoint

Returns

string Endpoint

Definition at line 395 of file openid.class.php.

References ErrorStore(), getURLContent(), HTML2OpenIDServer(), SetIdentity(), and SetOpenIDServer().

SimpleOpenID::GetRedirectURL

(

)

GetRedirectURL.

Returns

string

Definition at line 424 of file openid.class.php.

References array2url(), and fields.

Referenced by Redirect().

SimpleOpenID::HTML2OpenIDServer

(

$content

)

HTML2OpenIDServer.

Parameters

string

$content

Content

Returns

array Array of servers

Definition at line 367 of file openid.class.php.

Referenced by GetOpenIDServer().

SimpleOpenID::IsError

(

)

IsError.

Returns

boolean

Definition at line 215 of file openid.class.php.

SimpleOpenID::OpenID_Standarize

(

$openid_identity = null

)

OpenID_Standarize.

Parameters

string

$openid_identity

Server

Returns

string

Definition at line 253 of file openid.class.php.

SimpleOpenID::Redirect

(

)

Redirect.

Returns

void

Definition at line 450 of file openid.class.php.

References GetRedirectURL().

SimpleOpenID::sendDiscoveryRequestToGetXRDS

(

$url = ''

)

Get XRDS response and set possible servers.

Parameters

string

$url

Url of endpoint to request

Returns

string First endpoint OpenID server found. False if it failed to found.

Definition at line 515 of file openid.class.php.

SimpleOpenID::SetApprovedURL

(

$a

)

SetApprovedURL.

Parameters

string

$a

Server

Returns

void

Definition at line 94 of file openid.class.php.

SimpleOpenID::SetCancelURL

(

$a

)

SetOpenIDServer.

Parameters

string

$a

Server

Returns

void

Definition at line 81 of file openid.class.php.

SimpleOpenID::SetIdentity

(

$a

)

SetIdentity.

Parameters

string

$a

Server

Returns

void

Definition at line 141 of file openid.class.php.

Referenced by GetOpenIDServer().

SimpleOpenID::SetOpenIDServer

(

$a

)

SetOpenIDServer.

Parameters

string

$a

Server

Returns

void

Definition at line 55 of file openid.class.php.

Referenced by GetOpenIDServer().

SimpleOpenID::SetOptionalFields

(

$a

)

SetOptionalFields.

Parameters

string | array

$a

Server

Returns

void

Definition at line 124 of file openid.class.php.

References fields.

SimpleOpenID::SetRequiredFields

(

$a

)

SetRequiredFields.

Parameters

string | array

$a

Server

Returns

void

Definition at line 107 of file openid.class.php.

References fields.

SimpleOpenID::SetTrustRoot

(

$a

)

SetOpenIDServer.

Parameters

string

$a

Server

Returns

void

Definition at line 68 of file openid.class.php.

SimpleOpenID::splitResponse

(

$response

)

splitResponse

Parameters

string

$response

Server

Returns

void

Definition at line 232 of file openid.class.php.

SimpleOpenID::ValidateWithServer

(

)

ValidateWithServer.

Returns

boolean

Definition at line 470 of file openid.class.php.

---

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

• htdocs/core/class/openid.class.php