PHP Class Web\OpenID

Inheritance: extends Magic
Show file Open project: bcosca/fatfree-core

Protected Properties

Property Type Description
$args
$url

Public Methods

Method Description
auth ( $proxy = NULL, $attr = [], array $reqd = NULL ) : boolean Initiate OpenID authentication sequence; Return FALSE on failure or redirect to OpenID provider URL
clear ( $key ) : null Remove OpenID request parameter
exists ( $key ) : boolean Return TRUE if OpenID request parameter exists
get ( $key ) : mixed Return value of OpenID request parameter
response ( ) : array Return OpenID response fields
set ( $key, $val ) : string Bind value to OpenID request parameter
verified ( $proxy = NULL ) : boolean Return TRUE if OpenID verification was successful

Protected Methods

Method Description
discover ( $proxy ) : string | FALSE Determine OpenID provider

Method Details

auth() public method

Initiate OpenID authentication sequence; Return FALSE on failure or redirect to OpenID provider URL
public auth ( $proxy = NULL, $attr = [], array $reqd = NULL ) : boolean
$proxy string
$attr array
$reqd array string|array
return boolean

clear() public method

Remove OpenID request parameter
public clear ( $key ) : null
$key
return null

discover() protected method

Determine OpenID provider
protected discover ( $proxy ) : string | FALSE
$proxy string
return string | FALSE

exists() public method

Return TRUE if OpenID request parameter exists
public exists ( $key ) : boolean
$key string
return boolean

get() public method

Return value of OpenID request parameter
public get ( $key ) : mixed
$key string
return mixed

response() public method

Return OpenID response fields
public response ( ) : array
return array

set() public method

Bind value to OpenID request parameter
public set ( $key, $val ) : string
$key string
$val string
return string

verified() public method

Return TRUE if OpenID verification was successful
public verified ( $proxy = NULL ) : boolean
$proxy string
return boolean

Property Details

$args protected property

protected $args

$url protected property

protected $url