Fat-Free Framework  3.2.1  Overview Class List Hierarchy
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Web\OpenID Class Reference

OpenID consumer. More...

+ Inheritance diagram for Web\OpenID:

Public Member Functions

 auth ($proxy=NULL, $attr=array(), array $reqd=NULL)
 
 verified ($proxy=NULL)
 
 response ()
 
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
- Public Member Functions inherited from Magic
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 offsetexists ($key)
 
 __isset ($key)
 
 offsetset ($key, $val)
 
 __set ($key, $val)
 
 offsetget ($key)
 
 __get ($key)
 
 offsetunset ($key)
 
 __unset ($key)
 

Public Attributes

 $args =array()
 HTTP request parameters.
 

Protected Member Functions

 discover ($proxy)
 

Protected Attributes

 $url
 OpenID provider endpoint URL.
 

Detailed Description

OpenID consumer.

Member Function Documentation

Web\OpenID::auth (   $proxy = NULL,
  $attr = array(),
array  $reqd = NULL 
)

Initiate OpenID authentication sequence; Return FALSE on failure or redirect to OpenID provider URL

Returns
bool
Parameters
$proxystring
$attrarray
$reqdstring|array
Web\OpenID::clear (   $key)

Remove OpenID request parameter

Returns
NULL
Parameters
$key
Web\OpenID::discover (   $proxy)
protected

Determine OpenID provider

Returns
string|FALSE
Parameters
$proxystring
Web\OpenID::exists (   $key)

Return TRUE if OpenID request parameter exists

Returns
bool
Parameters
$keystring
Web\OpenID::get (   $key)

Return value of OpenID request parameter

Returns
mixed
Parameters
$keystring
Web\OpenID::response ( )

Return OpenID response fields

Returns
array
Web\OpenID::set (   $key,
  $val 
)

Bind value to OpenID request parameter

Returns
string
Parameters
$keystring
$valstring
Web\OpenID::verified (   $proxy = NULL)

Return TRUE if OpenID verification was successful

Returns
bool
Parameters
$proxystring

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