blob: 732ee436ea8357cad556500785b7548dee698bb9 (
plain) (
tree)
|
|
<!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.3.1"/>
<title>The Red Matrix: RedMatrix\RedDAV\RedBasicAuth 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 id="projectlogo"><img alt="Logo" src="rm-64.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">The Red Matrix
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<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="classRedMatrix_1_1RedDAV_1_1RedBasicAuth-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">RedMatrix\RedDAV\RedBasicAuth Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Authentication backend class for <a class="el" href="namespaceRedMatrix_1_1RedDAV.html">RedDAV</a>.
<a href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for RedMatrix\RedDAV\RedBasicAuth:</div>
<div class="dyncontent">
<div class="center">
<img src="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.png" usemap="#RedMatrix\RedDAV\RedBasicAuth_map" alt=""/>
<map id="RedMatrix\RedDAV\RedBasicAuth_map" name="RedMatrix\RedDAV\RedBasicAuth_map">
</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:aadce020fb595c7943829d7f995d3f998"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#aadce020fb595c7943829d7f995d3f998">setCurrentUser</a> ($name)</td></tr>
<tr class="separator:aadce020fb595c7943829d7f995d3f998"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0b2a5fa9186d7dc0e637f1ecb379c42"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#aa0b2a5fa9186d7dc0e637f1ecb379c42">getCurrentUser</a> ()</td></tr>
<tr class="separator:aa0b2a5fa9186d7dc0e637f1ecb379c42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6d239fefed05859327ee8db626703f9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#af6d239fefed05859327ee8db626703f9">setTimezone</a> ($timezone)</td></tr>
<tr class="memdesc:af6d239fefed05859327ee8db626703f9"><td class="mdescLeft"> </td><td class="mdescRight">Sets the timezone from the channel in <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html" title="Authentication backend class for RedDAV.">RedBasicAuth</a>. <a href="#af6d239fefed05859327ee8db626703f9">More...</a><br/></td></tr>
<tr class="separator:af6d239fefed05859327ee8db626703f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6333c8ce58998bd11bf8102afe3b0748"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a6333c8ce58998bd11bf8102afe3b0748">getTimezone</a> ()</td></tr>
<tr class="memdesc:a6333c8ce58998bd11bf8102afe3b0748"><td class="mdescLeft"> </td><td class="mdescRight">Returns the timezone. <a href="#a6333c8ce58998bd11bf8102afe3b0748">More...</a><br/></td></tr>
<tr class="separator:a6333c8ce58998bd11bf8102afe3b0748"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc72f36f0b2b17b20ea4df900afcd697"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#adc72f36f0b2b17b20ea4df900afcd697">setBrowserPlugin</a> ($browser)</td></tr>
<tr class="memdesc:adc72f36f0b2b17b20ea4df900afcd697"><td class="mdescLeft"> </td><td class="mdescRight">Set browser plugin for SabreDAV. <a href="#adc72f36f0b2b17b20ea4df900afcd697">More...</a><br/></td></tr>
<tr class="separator:adc72f36f0b2b17b20ea4df900afcd697"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf6fe89b0a8239ed93c3b07e1fbce75b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#abf6fe89b0a8239ed93c3b07e1fbce75b">log</a> ()</td></tr>
<tr class="memdesc:abf6fe89b0a8239ed93c3b07e1fbce75b"><td class="mdescLeft"> </td><td class="mdescRight">Prints out all <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html" title="Authentication backend class for RedDAV.">RedBasicAuth</a> variables to <a class="el" href="text_8php.html#a030fa5ecc64168af0c4f44897a9bce63" title="Logging function for RedMatrix.">logger()</a>. <a href="#abf6fe89b0a8239ed93c3b07e1fbce75b">More...</a><br/></td></tr>
<tr class="separator:abf6fe89b0a8239ed93c3b07e1fbce75b"><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:abe1defedb90ac8e3b6487e124e625521"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#abe1defedb90ac8e3b6487e124e625521">$channel_id</a> = 0</td></tr>
<tr class="separator:abe1defedb90ac8e3b6487e124e625521"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a112ad78a863dc0e598b5f02c596798c0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a112ad78a863dc0e598b5f02c596798c0">$channel_hash</a> = ''</td></tr>
<tr class="separator:a112ad78a863dc0e598b5f02c596798c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a605aa09565a097316b80f0d17d6b5823"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a605aa09565a097316b80f0d17d6b5823">$observer</a> = ''</td></tr>
<tr class="separator:a605aa09565a097316b80f0d17d6b5823"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a167ae032bd2ad8e6caa2e1e1a6f1b5d3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a167ae032bd2ad8e6caa2e1e1a6f1b5d3">$browser</a></td></tr>
<tr class="separator:a167ae032bd2ad8e6caa2e1e1a6f1b5d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a23c349cc4699a8474505972684ea9c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a1a23c349cc4699a8474505972684ea9c">$owner_id</a> = 0</td></tr>
<tr class="separator:a1a23c349cc4699a8474505972684ea9c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad0ef0cc05c407de84dbfbf2050bbbbe"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#aad0ef0cc05c407de84dbfbf2050bbbbe">$owner_nick</a> = ''</td></tr>
<tr class="separator:aad0ef0cc05c407de84dbfbf2050bbbbe"><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:a6ece02655b780469e59e204c5979a624"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a6ece02655b780469e59e204c5979a624">validateUserPass</a> ($username, $password)</td></tr>
<tr class="memdesc:a6ece02655b780469e59e204c5979a624"><td class="mdescLeft"> </td><td class="mdescRight">Validates a username and password. <a href="#a6ece02655b780469e59e204c5979a624">More...</a><br/></td></tr>
<tr class="separator:a6ece02655b780469e59e204c5979a624"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2926fe923baade564f2663632fa8c633"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a2926fe923baade564f2663632fa8c633">setAuthenticated</a> ($r)</td></tr>
<tr class="memdesc:a2926fe923baade564f2663632fa8c633"><td class="mdescLeft"> </td><td class="mdescRight">Sets variables and session parameters after successfull authentication. <a href="#a2926fe923baade564f2663632fa8c633">More...</a><br/></td></tr>
<tr class="separator:a2926fe923baade564f2663632fa8c633"><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:a76fdb7fd5dd7376155abb5a58cd6fd69"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a76fdb7fd5dd7376155abb5a58cd6fd69">$channel_name</a> = null</td></tr>
<tr class="separator:a76fdb7fd5dd7376155abb5a58cd6fd69"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a849c99cf0a7ad065d630c8a30106ad5e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a849c99cf0a7ad065d630c8a30106ad5e">$timezone</a> = ''</td></tr>
<tr class="separator:a849c99cf0a7ad065d630c8a30106ad5e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Authentication backend class for <a class="el" href="namespaceRedMatrix_1_1RedDAV.html">RedDAV</a>. </p>
<p>This class also contains some data which is not necessary for authentication like timezone settings.</p>
<p><a class="el" href=""><a href="http://opensource.org/licenses/mit-license.php">http://opensource.org/licenses/mit-license.php</a> The MIT License (MIT) </a></p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa0b2a5fa9186d7dc0e637f1ecb379c42"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::getCurrentUser </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns information about the currently logged-in channel.</p>
<p>If nobody is currently logged in, this method should return null.</p>
<dl class="section see"><dt>See Also</dt><dd>::getCurrentUser </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>string|null </dd></dl>
</div>
</div>
<a class="anchor" id="a6333c8ce58998bd11bf8102afe3b0748"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::getTimezone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the timezone. </p>
<dl class="section return"><dt>Returns</dt><dd>string Return the channel's timezone. </dd></dl>
</div>
</div>
<a class="anchor" id="abf6fe89b0a8239ed93c3b07e1fbce75b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::log </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prints out all <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html" title="Authentication backend class for RedDAV.">RedBasicAuth</a> variables to <a class="el" href="text_8php.html#a030fa5ecc64168af0c4f44897a9bce63" title="Logging function for RedMatrix.">logger()</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
</div>
</div>
<a class="anchor" id="a2926fe923baade564f2663632fa8c633"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::setAuthenticated </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$r</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>Sets variables and session parameters after successfull authentication. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">array</td><td class="paramname">$r</td><td>Array with the values for the authenticated channel. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
<p>Referenced by <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a6ece02655b780469e59e204c5979a624">RedMatrix\RedDAV\RedBasicAuth\validateUserPass()</a>.</p>
</div>
</div>
<a class="anchor" id="adc72f36f0b2b17b20ea4df900afcd697"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::setBrowserPlugin </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$browser</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set browser plugin for SabreDAV. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBrowser.html#aa1607857cb59738c4dce2fe8e73d8f19">RedBrowser::set_writeable()</a> </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">\Sabre\DAV\Browser\Plugin</td><td class="paramname">$browser</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aadce020fb595c7943829d7f995d3f998"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::setCurrentUser </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the channel_name from the currently logged-in channel.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">string</td><td class="paramname">$name</td><td>The channel's name </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af6d239fefed05859327ee8db626703f9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::setTimezone </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$timezone</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the timezone from the channel in <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html" title="Authentication backend class for RedDAV.">RedBasicAuth</a>. </p>
<p>Set in <a class="el" href="cloud_8php.html" title="Initialize RedMatrix's cloud (SabreDAV).">mod/cloud.php</a> if the channel has a timezone set.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">string</td><td class="paramname">$timezone</td><td>The channel's timezone. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
</div>
</div>
<a class="anchor" id="a6ece02655b780469e59e204c5979a624"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::validateUserPass </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$username</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>$password</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>Validates a username and password. </p>
<p>Guest access is granted with the password "+++".</p>
<dl class="section see"><dt>See Also</dt><dd>::validateUserPass </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">string</td><td class="paramname">$username</td><td></td></tr>
<tr><td class="paramtype">string</td><td class="paramname">$password</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a167ae032bd2ad8e6caa2e1e1a6f1b5d3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::$browser</td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#adc72f36f0b2b17b20ea4df900afcd697">RedMatrix\RedDAV\RedBasicAuth\setBrowserPlugin()</a>.</p>
</div>
</div>
<a class="anchor" id="a112ad78a863dc0e598b5f02c596798c0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::$channel_hash = ''</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="abe1defedb90ac8e3b6487e124e625521"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::$channel_id = 0</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a76fdb7fd5dd7376155abb5a58cd6fd69"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::$channel_name = null</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>Referenced by <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#aa0b2a5fa9186d7dc0e637f1ecb379c42">RedMatrix\RedDAV\RedBasicAuth\getCurrentUser()</a>.</p>
</div>
</div>
<a class="anchor" id="a605aa09565a097316b80f0d17d6b5823"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::$observer = ''</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a1a23c349cc4699a8474505972684ea9c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::$owner_id = 0</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aad0ef0cc05c407de84dbfbf2050bbbbe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::$owner_nick = ''</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a849c99cf0a7ad065d630c8a30106ad5e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\RedBasicAuth::$timezone = ''</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>Referenced by <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a6333c8ce58998bd11bf8102afe3b0748">RedMatrix\RedDAV\RedBasicAuth\getTimezone()</a>, and <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#af6d239fefed05859327ee8db626703f9">RedMatrix\RedDAV\RedBasicAuth\setTimezone()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/RedDAV/<a class="el" href="RedBasicAuth_8php.html">RedBasicAuth.php</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
|
