From 8e7e488ffe92030707a792584adecc93cd9a3708 Mon Sep 17 00:00:00 2001 From: friendica Date: Fri, 10 Oct 2014 00:13:00 -0700 Subject: doc updates --- doc/html/classRedBasicAuth.html | 176 +++++++++++++++++++++++++++++++++++++--- 1 file changed, 164 insertions(+), 12 deletions(-) (limited to 'doc/html/classRedBasicAuth.html') 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','');}); Public Member Functions | Public Attributes | Protected Member Functions | +Protected Attributes | List of all members
RedBasicAuth Class Reference
+ +

Authentication backend class for RedDAV. + More...

Inheritance diagram for RedBasicAuth:
@@ -127,16 +131,22 @@ Inheritance diagram for RedBasicAuth:
Public Member Functions  setCurrentUser ($name)   + getCurrentUser () +  + setTimezone ($timezone) + Sets the timezone from the channel in RedBasicAuth. More...
+  + getTimezone () + Returns the timezone. More...
+   setBrowserPlugin ($browser) - Set browser plugin. More...
+ Set browser plugin for SabreDAV. More...
   log ()   - - @@ -145,21 +155,68 @@ Public Attributes - + - -

Public Attributes

 $channel_name = ''
 
 $channel_id = 0
 
 $channel_hash = ''
 
 $browser
 
 $owner_id
 $owner_id = 0
 
 $owner_nick = ''
 
 $timezone
 
+ + + + +

Protected Member Functions

 validateUserPass ($username, $password)
 Validates a username and password. More...
 
 setAuthenticated ($r)
 Sets variables and session parameters after successfull authentication. More...
 
+ + + + +

+Protected Attributes

 $channel_name = null
 
 $timezone = ''
 

Detailed Description

-

RedBasicAuth class.

+

Authentication backend class for RedDAV.

+

This class also contains some data which is not necessary for authentication like timezone settings.

Member Function Documentation

+ +
+
+ + + + + + + +
RedBasicAuth::getCurrentUser ()
+
+

Returns information about the currently logged-in channel.

+

If nobody is currently logged in, this method should return null.

+
See Also
DAV::getCurrentUser
+
Returns
string|null
+ +
+
+ +
+
+ + + + + + + +
RedBasicAuth::getTimezone ()
+
+ +

Returns the timezone.

+
Returns
string Return the channel's timezone.
+ +
+
@@ -172,6 +229,43 @@ Protected Member Functions
+

Prints out all RedBasicAuth variables to logger().

+
Returns
void
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
RedBasicAuth::setAuthenticated ( $r)
+ 		+protected
+
+ +

Sets variables and session parameters after successfull authentication.

+
Parameters
+ + +
array$rArray with the values for the authenticated channel.
+
+
+
Returns
bool
+ +

Referenced by validateUserPass().

@@ -189,8 +283,8 @@ Protected Member Functions
-

Set browser plugin.

-
See Also
RedBrowser::set_writeable()
+

Set browser plugin for SabreDAV.

+
See Also
RedBrowser::set_writeable()
Parameters
@@ -213,6 +307,39 @@ Protected Member Functions
DAV\Browser\Plugin$browser
+

Sets the channel_name from the currently logged-in channel.

+
Parameters
+ + +
string$nameThe channel's name
+
+
+ +
+
+ +
+
+ + + + + + + + +
RedBasicAuth::setTimezone ( $timezone)
+
+ +

Sets the timezone from the channel in RedBasicAuth.

+

Set in mod/cloud.php if the channel has a timezone set.

+
Parameters
+ + +
string$timezoneThe channel's timezone.
+
+
+
Returns
void
@@ -247,6 +374,10 @@ Protected Member Functions
+ +

Validates a username and password.

+

Guest access is granted with the password "+++".

+
See Also
DAV::validateUserPass
Parameters
@@ -254,6 +385,7 @@ Protected Member Functions
string$username
+
Returns
bool
@@ -299,13 +431,23 @@ Protected Member Functions
+ + + + + +
- +
RedBasicAuth::$channel_name = ''RedBasicAuth::$channel_name = null
+ 		+protected
+

Referenced by getCurrentUser().

+
@@ -325,7 +467,7 @@ Protected Member Functions
- +
RedBasicAuth::$owner_idRedBasicAuth::$owner_id = 0
@@ -347,13 +489,23 @@ Protected Member Functions
+ + + + + +
- +
RedBasicAuth::$timezoneRedBasicAuth::$timezone = ''
+ 		+protected
+

Referenced by getTimezone(), and setTimezone().

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