diff options
Diffstat (limited to 'doc/html/classRedBasicAuth.html')
| -rw-r--r-- | doc/html/classRedBasicAuth.html | 176 |
1 files changed, 164 insertions, 12 deletions
diff --git a/doc/html/classRedBasicAuth.html b/doc/html/classRedBasicAuth.html index 6a8e064d9..e51a60e4c 100644 --- a/doc/html/classRedBasicAuth.html +++ b/doc/html/classRedBasicAuth.html @@ -109,11 +109,15 @@ $(document).ready(function(){initNavTree('classRedBasicAuth.html','');}); <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="classRedBasicAuth-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">RedBasicAuth Class Reference</div> </div> </div><!--header--> <div class="contents"> + +<p>Authentication backend class for RedDAV. + <a href="classRedBasicAuth.html#details">More...</a></p> <div class="dynheader"> Inheritance diagram for RedBasicAuth:</div> <div class="dyncontent"> @@ -127,16 +131,22 @@ Inheritance diagram for RedBasicAuth:</div> Public Member Functions</h2></td></tr> <tr class="memitem:a072e8244a9a7f191b32d3db5ac94f857"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a072e8244a9a7f191b32d3db5ac94f857">setCurrentUser</a> ($name)</td></tr> <tr class="separator:a072e8244a9a7f191b32d3db5ac94f857"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4a584de8eb31c786fabd8f6e1a6c8925"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a4a584de8eb31c786fabd8f6e1a6c8925">getCurrentUser</a> ()</td></tr> +<tr class="separator:a4a584de8eb31c786fabd8f6e1a6c8925"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2f5d4ef7040c65b79b2fdfdf1212395a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a2f5d4ef7040c65b79b2fdfdf1212395a">setTimezone</a> ($timezone)</td></tr> +<tr class="memdesc:a2f5d4ef7040c65b79b2fdfdf1212395a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the timezone from the channel in <a class="el" href="classRedBasicAuth.html" title="Authentication backend class for RedDAV.">RedBasicAuth</a>. <a href="#a2f5d4ef7040c65b79b2fdfdf1212395a">More...</a><br/></td></tr> +<tr class="separator:a2f5d4ef7040c65b79b2fdfdf1212395a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9fdd4b890e3e7c7e1ae96ead2301418f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a9fdd4b890e3e7c7e1ae96ead2301418f">getTimezone</a> ()</td></tr> +<tr class="memdesc:a9fdd4b890e3e7c7e1ae96ead2301418f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the timezone. <a href="#a9fdd4b890e3e7c7e1ae96ead2301418f">More...</a><br/></td></tr> +<tr class="separator:a9fdd4b890e3e7c7e1ae96ead2301418f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a358ddad4abb5aa8c1382cf49a907adbc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a358ddad4abb5aa8c1382cf49a907adbc">setBrowserPlugin</a> ($browser)</td></tr> -<tr class="memdesc:a358ddad4abb5aa8c1382cf49a907adbc"><td class="mdescLeft"> </td><td class="mdescRight">Set browser plugin. <a href="#a358ddad4abb5aa8c1382cf49a907adbc">More...</a><br/></td></tr> +<tr class="memdesc:a358ddad4abb5aa8c1382cf49a907adbc"><td class="mdescLeft"> </td><td class="mdescRight">Set browser plugin for SabreDAV. <a href="#a358ddad4abb5aa8c1382cf49a907adbc">More...</a><br/></td></tr> <tr class="separator:a358ddad4abb5aa8c1382cf49a907adbc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2cc8b1eac9c5a799bfb53ea7f287f3f0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a2cc8b1eac9c5a799bfb53ea7f287f3f0">log</a> ()</td></tr> <tr class="separator:a2cc8b1eac9c5a799bfb53ea7f287f3f0"><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:a438ab125b6ef46581947e35d49cdebac"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a438ab125b6ef46581947e35d49cdebac">$channel_name</a> = ''</td></tr> -<tr class="separator:a438ab125b6ef46581947e35d49cdebac"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2dab393650d1573e3515969a153e8354"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a2dab393650d1573e3515969a153e8354">$channel_id</a> = 0</td></tr> <tr class="separator:a2dab393650d1573e3515969a153e8354"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad5a3ea4dc4783b242d9dc6e76478b6ef"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#ad5a3ea4dc4783b242d9dc6e76478b6ef">$channel_hash</a> = ''</td></tr> @@ -145,21 +155,68 @@ Public Attributes</h2></td></tr> <tr class="separator:aa75dc43b59adc98e38a98517d3fd35d1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af14337f1baad407f8a85d48205c0f30e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#af14337f1baad407f8a85d48205c0f30e">$browser</a></td></tr> <tr class="separator:af14337f1baad407f8a85d48205c0f30e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a09c1488a0b290f5a54dc15180c5690d7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a09c1488a0b290f5a54dc15180c5690d7">$owner_id</a></td></tr> +<tr class="memitem:a09c1488a0b290f5a54dc15180c5690d7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a09c1488a0b290f5a54dc15180c5690d7">$owner_id</a> = 0</td></tr> <tr class="separator:a09c1488a0b290f5a54dc15180c5690d7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8d09b8d784cc810a0b3be580d05106a7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a8d09b8d784cc810a0b3be580d05106a7">$owner_nick</a> = ''</td></tr> <tr class="separator:a8d09b8d784cc810a0b3be580d05106a7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2d0246ed446fd5e55c17938b4ce6ac47"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a2d0246ed446fd5e55c17938b4ce6ac47">$timezone</a></td></tr> -<tr class="separator:a2d0246ed446fd5e55c17938b4ce6ac47"><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:a8dfd9a0953f8884723b421b7c1acf79b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a8dfd9a0953f8884723b421b7c1acf79b">validateUserPass</a> ($username, $password)</td></tr> +<tr class="memdesc:a8dfd9a0953f8884723b421b7c1acf79b"><td class="mdescLeft"> </td><td class="mdescRight">Validates a username and password. <a href="#a8dfd9a0953f8884723b421b7c1acf79b">More...</a><br/></td></tr> <tr class="separator:a8dfd9a0953f8884723b421b7c1acf79b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3ef43177abe0ef72da140a25bc568333"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a3ef43177abe0ef72da140a25bc568333">setAuthenticated</a> ($r)</td></tr> +<tr class="memdesc:a3ef43177abe0ef72da140a25bc568333"><td class="mdescLeft"> </td><td class="mdescRight">Sets variables and session parameters after successfull authentication. <a href="#a3ef43177abe0ef72da140a25bc568333">More...</a><br/></td></tr> +<tr class="separator:a3ef43177abe0ef72da140a25bc568333"><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:a438ab125b6ef46581947e35d49cdebac"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a438ab125b6ef46581947e35d49cdebac">$channel_name</a> = null</td></tr> +<tr class="separator:a438ab125b6ef46581947e35d49cdebac"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2d0246ed446fd5e55c17938b4ce6ac47"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html#a2d0246ed446fd5e55c17938b4ce6ac47">$timezone</a> = ''</td></tr> +<tr class="separator:a2d0246ed446fd5e55c17938b4ce6ac47"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p><a class="el" href="classRedBasicAuth.html">RedBasicAuth</a> class. </p> +<div class="textblock"><p>Authentication backend class for RedDAV. </p> +<p>This class also contains some data which is not necessary for authentication like timezone settings. </p> </div><h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a4a584de8eb31c786fabd8f6e1a6c8925"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">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>DAV::getCurrentUser </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>string|null </dd></dl> + +</div> +</div> +<a class="anchor" id="a9fdd4b890e3e7c7e1ae96ead2301418f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">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="a2cc8b1eac9c5a799bfb53ea7f287f3f0"></a> <div class="memitem"> <div class="memproto"> @@ -172,6 +229,43 @@ Protected Member Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<p>Prints out all <a class="el" href="classRedBasicAuth.html" title="Authentication backend class for RedDAV.">RedBasicAuth</a> variables to <a class="el" href="text_8php.html#a030fa5ecc64168af0c4f44897a9bce63">logger()</a>.</p> +<dl class="section return"><dt>Returns</dt><dd>void </dd></dl> + +</div> +</div> +<a class="anchor" id="a3ef43177abe0ef72da140a25bc568333"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">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="classRedBasicAuth.html#a8dfd9a0953f8884723b421b7c1acf79b">validateUserPass()</a>.</p> </div> </div> @@ -189,8 +283,8 @@ Protected Member Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Set browser plugin. </p> -<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRedBrowser.html#a40fdbb9d9fe6c1243bbf135dd5b0a06f">RedBrowser::set_writeable()</a> </dd></dl> +<p>Set browser plugin for SabreDAV. </p> +<dl class="section see"><dt>See Also</dt><dd>RedBrowser::set_writeable() </dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramtype">DAV\Browser\Plugin</td><td class="paramname">$browser</td><td></td></tr> @@ -213,6 +307,39 @@ Protected Member Functions</h2></td></tr> </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="a2f5d4ef7040c65b79b2fdfdf1212395a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">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="classRedBasicAuth.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> @@ -247,6 +374,10 @@ Protected Member Functions</h2></td></tr> </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>DAV::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> @@ -254,6 +385,7 @@ Protected Member Functions</h2></td></tr> </table> </dd> </dl> +<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl> </div> </div> @@ -299,13 +431,23 @@ Protected Member Functions</h2></td></tr> <a class="anchor" id="a438ab125b6ef46581947e35d49cdebac"></a> <div class="memitem"> <div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">RedBasicAuth::$channel_name = ''</td> + <td class="memname">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="classRedBasicAuth.html#a4a584de8eb31c786fabd8f6e1a6c8925">getCurrentUser()</a>.</p> + </div> </div> <a class="anchor" id="aa75dc43b59adc98e38a98517d3fd35d1"></a> @@ -325,7 +467,7 @@ Protected Member Functions</h2></td></tr> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">RedBasicAuth::$owner_id</td> + <td class="memname">RedBasicAuth::$owner_id = 0</td> </tr> </table> </div><div class="memdoc"> @@ -347,13 +489,23 @@ Protected Member Functions</h2></td></tr> <a class="anchor" id="a2d0246ed446fd5e55c17938b4ce6ac47"></a> <div class="memitem"> <div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">RedBasicAuth::$timezone</td> + <td class="memname">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="classRedBasicAuth.html#a9fdd4b890e3e7c7e1ae96ead2301418f">getTimezone()</a>, and <a class="el" href="classRedBasicAuth.html#a2f5d4ef7040c65b79b2fdfdf1212395a">setTimezone()</a>.</p> + </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> |