From 478e7c4479f0c994fb9119d5b44032cc072b7c0a Mon Sep 17 00:00:00 2001 From: friendica Date: Sun, 19 Oct 2014 15:54:51 -0700 Subject: doc updates --- doc/html/reddav_8php.html | 62 +++++++++++++++++++++++++---------------------- 1 file changed, 33 insertions(+), 29 deletions(-) (limited to 'doc/html/reddav_8php.html') diff --git a/doc/html/reddav_8php.html b/doc/html/reddav_8php.html index a6af84519..ac5e204bb 100644 --- a/doc/html/reddav_8php.html +++ b/doc/html/reddav_8php.html @@ -104,27 +104,15 @@ $(document).ready(function(){initNavTree('reddav_8php.html','');});
-Classes | Functions
reddav.php File Reference
-

DAV related classes from SabreDAV for Red Matrix. +

some DAV related functions for RedMatrix. More...

- - - - - - - - - -

-Classes

class  RedDirectory
 RedDirectory class. More...
 
class  RedFile
 
class  RedBasicAuth
 Authentication backend class for RedDAV. More...
 
@@ -138,10 +126,11 @@ Functions

Functions

 RedChannelList (&$auth)
 

Detailed Description

-

DAV related classes from SabreDAV for Red Matrix.

-

This file contains the classes from SabreDAV that got extended to adapt it for Red Matrix.

-

You find the original SabreDAV classes under vendor/sabre/dav/. We need to use SabreDAV 1.8.x for PHP5.3 compatibility. SabreDAV >= 2.0 requires PHP >= 5.4.

-
Todo:
split up the classes into own files.
+

some DAV related functions for RedMatrix.

+

This file contains some functions which did not fit into one of the RedDAV classes.

+

The extended SabreDAV classes you will find in the RedDAV namespace under includes/RedDAV/. The original SabreDAV classes you can find under vendor/sabre/dav/. We need to use SabreDAV 1.8.x for PHP5.3 compatibility. SabreDAV >= 2.0 requires PHP >= 5.4.

+
Todo:
split up the classes into own files.
+

http://opensource.org/licenses/mit-license.php The MIT License (MIT)

Function Documentation

@@ -158,15 +147,15 @@ Functions

Returns an array with viewable channels.

-

Get a list of RedDirectory objects with all the channels where the visitor has view_storage perms.

-
Todo:
Is there any reason why this is not inside RedDirectory class?
+

Get a list of RedDirectory objects with all the channels where the visitor has view_storage perms.

+
Todo:
Is there any reason why this is not inside RedDirectory class? function name looks like a class name, should we rename it?
Parameters
- +
$auth
RedBasicAuth&$auth
-
Returns
array containing RedDirectory objects
+
Returns
array RedDirectory[]

Referenced by RedCollectionData().

@@ -197,18 +186,25 @@ Functions

TODO what exactly does this function?

-

Array with all RedDirectory and RedFile DAV items for the given path.

-
Todo:
Is there any reason why this is not inside RedDirectory class? Seems only to be used there and we could simplify it a bit there.
+

Array with all RedDirectory and RedFile DAV items for the given path.

+
Todo:
Is there any reason why this is not inside RedDirectory class? Seems only to be used there and we could simplify it a bit there. function name looks like a class name, should we rename it?
Parameters
- + +
string$filepath to a directory
&$auth
RedBasicAuth&$auth
+
+
+
Returns
null|array []
+
Exceptions
+ + +
\Sabre\DAV\Exception\Forbidden
\Sabre\DAV\Exception\NotFound
-
Returns
array DAV[]
-

Referenced by RedDirectory\getChildren().

+

Referenced by RedMatrix\RedDAV\RedDirectory\getChildren().

@@ -243,16 +239,24 @@ Functions

TODO What exactly is this function for?

+

function name looks like a class name, should we rename it?

Parameters
- - + +
string$file
&$auth
string$filepath to file or directory
RedBasicAuth&$auth
boolean$test(optional) enable test mode
+
Returns
RedFile|RedDirectory|boolean|null
+
Exceptions
+ + +
\Sabre\DAV\Exception\Forbidden
+
+
-

Referenced by RedDirectory\childExists(), cloud_init(), and RedDirectory\getChild().

+

Referenced by RedMatrix\RedDAV\RedDirectory\childExists(), cloud_init(), and RedMatrix\RedDAV\RedDirectory\getChild().

-- cgit v1.2.3