<!-- HTML header for doxygen 1.8.5-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Fat-Free Framework: Web\OpenID Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Fat-Free Framework
 <span id="projectnumber">3.2.2</span>
 <span class="menu"><a href="index.html">Overview</a> <a href="annotated.html">Class List</a> <a href="hierarchy.html">Hierarchy</a></span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>Web</b></li><li class="navelem"><a class="el" href="classWeb_1_1OpenID.html">OpenID</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classWeb_1_1OpenID-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Web\OpenID Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>OpenID consumer.
<a href="classWeb_1_1OpenID.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Web\OpenID:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classWeb_1_1OpenID.png" usemap="#Web\OpenID_map" alt=""/>
<map id="Web\OpenID_map" name="Web\OpenID_map">
<area href="classMagic.html" title="PHP magic wrapper. " alt="Magic" shape="rect" coords="0,56,87,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aaecc8347b4526e4e5c09ce4043d4cb3b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1OpenID.html#aaecc8347b4526e4e5c09ce4043d4cb3b">auth</a> ($proxy=NULL, $attr=array(), array $reqd=NULL)</td></tr>
<tr class="separator:aaecc8347b4526e4e5c09ce4043d4cb3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60af8b0c37358df5e9c1fe2d594ec964"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1OpenID.html#a60af8b0c37358df5e9c1fe2d594ec964">verified</a> ($proxy=NULL)</td></tr>
<tr class="separator:a60af8b0c37358df5e9c1fe2d594ec964"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ecb94c8974b342e42467124b8635967"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1OpenID.html#a7ecb94c8974b342e42467124b8635967">response</a> ()</td></tr>
<tr class="separator:a7ecb94c8974b342e42467124b8635967"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f806b737b97be037432695e74d67b6b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1OpenID.html#a5f806b737b97be037432695e74d67b6b">exists</a> ($key)</td></tr>
<tr class="separator:a5f806b737b97be037432695e74d67b6b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ea562419a97caaacd351ed6b4ecedca"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1OpenID.html#a7ea562419a97caaacd351ed6b4ecedca">set</a> ($key, $val)</td></tr>
<tr class="separator:a7ea562419a97caaacd351ed6b4ecedca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3c98f3fae6201f02a07db8115299a225"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1OpenID.html#a3c98f3fae6201f02a07db8115299a225">get</a> ($key)</td></tr>
<tr class="separator:a3c98f3fae6201f02a07db8115299a225"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a306f1b99fcd989d9e067c6f440827dbf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1OpenID.html#a306f1b99fcd989d9e067c6f440827dbf">clear</a> ($key)</td></tr>
<tr class="separator:a306f1b99fcd989d9e067c6f440827dbf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classMagic"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classMagic')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classMagic.html">Magic</a></td></tr>
<tr class="memitem:ad242c359b007dc35794690e744924974 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#ad242c359b007dc35794690e744924974">exists</a> ($key)</td></tr>
<tr class="separator:ad242c359b007dc35794690e744924974 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5969f61e6fcb580733fba9302de076a inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#af5969f61e6fcb580733fba9302de076a">set</a> ($key, $val)</td></tr>
<tr class="separator:af5969f61e6fcb580733fba9302de076a inherit pub_methods_classMagic"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab809dfcdbba37cb93b82d526b25f3112 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#ab809dfcdbba37cb93b82d526b25f3112">get</a> ($key)</td></tr>
<tr class="separator:ab809dfcdbba37cb93b82d526b25f3112 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9aa6fe25a7c2ed6d90c98e5f517aa78 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#ad9aa6fe25a7c2ed6d90c98e5f517aa78">clear</a> ($key)</td></tr>
<tr class="separator:ad9aa6fe25a7c2ed6d90c98e5f517aa78 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8146b8fc5ed9a0e30e9612afb9cd8d80 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#a8146b8fc5ed9a0e30e9612afb9cd8d80">offsetexists</a> ($key)</td></tr>
<tr class="separator:a8146b8fc5ed9a0e30e9612afb9cd8d80 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e02946d9f8d5314fc60c5ff3badd6ef inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#a5e02946d9f8d5314fc60c5ff3badd6ef">__isset</a> ($key)</td></tr>
<tr class="separator:a5e02946d9f8d5314fc60c5ff3badd6ef inherit pub_methods_classMagic"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add3add2badb418eb7712b7b789b6e52b inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#add3add2badb418eb7712b7b789b6e52b">offsetset</a> ($key, $val)</td></tr>
<tr class="separator:add3add2badb418eb7712b7b789b6e52b inherit pub_methods_classMagic"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66319e2327b1fdf7643e3dff9b786495 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#a66319e2327b1fdf7643e3dff9b786495">__set</a> ($key, $val)</td></tr>
<tr class="separator:a66319e2327b1fdf7643e3dff9b786495 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a91b6f39d7c711d0abe8f66715eaad0f1 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#a91b6f39d7c711d0abe8f66715eaad0f1">offsetget</a> ($key)</td></tr>
<tr class="separator:a91b6f39d7c711d0abe8f66715eaad0f1 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72010b7bf92e61a7b8279de02b8c5820 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#a72010b7bf92e61a7b8279de02b8c5820">__get</a> ($key)</td></tr>
<tr class="separator:a72010b7bf92e61a7b8279de02b8c5820 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1bdb5f01422cda7f03c76674cd82812d inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#a1bdb5f01422cda7f03c76674cd82812d">offsetunset</a> ($key)</td></tr>
<tr class="separator:a1bdb5f01422cda7f03c76674cd82812d inherit pub_methods_classMagic"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a93e1d416a15653d133228111c7b5eb20 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#a93e1d416a15653d133228111c7b5eb20">__unset</a> ($key)</td></tr>
<tr class="separator:a93e1d416a15653d133228111c7b5eb20 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a687bcd6f62c94363cebee708a3c4a57a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a687bcd6f62c94363cebee708a3c4a57a"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1OpenID.html#a687bcd6f62c94363cebee708a3c4a57a">$args</a> =array()</td></tr>
<tr class="memdesc:a687bcd6f62c94363cebee708a3c4a57a"><td class="mdescLeft"> </td><td class="mdescRight">HTTP request parameters. <br/></td></tr>
<tr class="separator:a687bcd6f62c94363cebee708a3c4a57a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a40e15911834c4d5e6d3e612a4b4dc798"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1OpenID.html#a40e15911834c4d5e6d3e612a4b4dc798">discover</a> ($proxy)</td></tr>
<tr class="separator:a40e15911834c4d5e6d3e612a4b4dc798"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:aec6a08892e53ec7f5f5ccec35f494375"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec6a08892e53ec7f5f5ccec35f494375"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1OpenID.html#aec6a08892e53ec7f5f5ccec35f494375">$url</a></td></tr>
<tr class="memdesc:aec6a08892e53ec7f5f5ccec35f494375"><td class="mdescLeft"> </td><td class="mdescRight">OpenID provider endpoint URL. <br/></td></tr>
<tr class="separator:aec6a08892e53ec7f5f5ccec35f494375"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>OpenID consumer. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aaecc8347b4526e4e5c09ce4043d4cb3b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Web\OpenID::auth </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$proxy</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>$attr</em> = <code>array()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">array </td>
<td class="paramname"><em>$reqd</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initiate OpenID authentication sequence; Return FALSE on failure or redirect to OpenID provider URL </p>
<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$proxy</td><td>string </td></tr>
<tr><td class="paramname">$attr</td><td>array </td></tr>
<tr><td class="paramname">$reqd</td><td>string|array </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a306f1b99fcd989d9e067c6f440827dbf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Web\OpenID::clear </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove OpenID request parameter </p>
<dl class="section return"><dt>Returns</dt><dd>NULL </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$key</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a40e15911834c4d5e6d3e612a4b4dc798"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Web\OpenID::discover </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$proxy</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine OpenID provider </p>
<dl class="section return"><dt>Returns</dt><dd>string|FALSE </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$proxy</td><td>string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5f806b737b97be037432695e74d67b6b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Web\OpenID::exists </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return TRUE if OpenID request parameter exists </p>
<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$key</td><td>string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3c98f3fae6201f02a07db8115299a225"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Web\OpenID::get </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return value of OpenID request parameter </p>
<dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$key</td><td>string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7ecb94c8974b342e42467124b8635967"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Web\OpenID::response </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return OpenID response fields </p>
<dl class="section return"><dt>Returns</dt><dd>array </dd></dl>
</div>
</div>
<a class="anchor" id="a7ea562419a97caaacd351ed6b4ecedca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Web\OpenID::set </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>$val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Bind value to OpenID request parameter </p>
<dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$key</td><td>string </td></tr>
<tr><td class="paramname">$val</td><td>string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a60af8b0c37358df5e9c1fe2d594ec964"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Web\OpenID::verified </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$proxy</em> = <code>NULL</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return TRUE if OpenID verification was successful </p>
<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$proxy</td><td>string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>web/openid.php</li>
</ul>
</div><!-- contents -->