diff options
Diffstat (limited to 'doc/html/reddav_8php.html')
| -rw-r--r-- | doc/html/reddav_8php.html | 46 |
1 files changed, 45 insertions, 1 deletions
diff --git a/doc/html/reddav_8php.html b/doc/html/reddav_8php.html index c987f8a0f..e0cff75df 100644 --- a/doc/html/reddav_8php.html +++ b/doc/html/reddav_8php.html @@ -110,10 +110,14 @@ $(document).ready(function(){initNavTree('reddav_8php.html','');}); <div class="title">reddav.php File Reference</div> </div> </div><!--header--> <div class="contents"> + +<p>DAV related classes from SabreDAV for Red Matrix. +<a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html">RedDirectory</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classRedDirectory.html" title="RedDirectory class.">RedDirectory</a> class. <a href="classRedDirectory.html#details">More...</a><br/></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedFile.html">RedFile</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> @@ -125,13 +129,20 @@ Classes</h2></td></tr> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ae92ea0df1993f6a7bcd1b6efa6c1fb66"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="reddav_8php.html#ae92ea0df1993f6a7bcd1b6efa6c1fb66">RedChannelList</a> (&$auth)</td></tr> +<tr class="memdesc:ae92ea0df1993f6a7bcd1b6efa6c1fb66"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array with viewable channels. <a href="#ae92ea0df1993f6a7bcd1b6efa6c1fb66">More...</a><br/></td></tr> <tr class="separator:ae92ea0df1993f6a7bcd1b6efa6c1fb66"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5df0d09893f2e65dc5cf6bbab6cfb266"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="reddav_8php.html#a5df0d09893f2e65dc5cf6bbab6cfb266">RedCollectionData</a> ($file, &$auth)</td></tr> +<tr class="memdesc:a5df0d09893f2e65dc5cf6bbab6cfb266"><td class="mdescLeft"> </td><td class="mdescRight">TODO what exactly does this function? <a href="#a5df0d09893f2e65dc5cf6bbab6cfb266">More...</a><br/></td></tr> <tr class="separator:a5df0d09893f2e65dc5cf6bbab6cfb266"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9f531641dfb4e43cd88ac1a9ae7e2088"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="reddav_8php.html#a9f531641dfb4e43cd88ac1a9ae7e2088">RedFileData</a> ($file, &$auth, $test=false)</td></tr> +<tr class="memdesc:a9f531641dfb4e43cd88ac1a9ae7e2088"><td class="mdescLeft"> </td><td class="mdescRight">TODO What exactly is this function for? <a href="#a9f531641dfb4e43cd88ac1a9ae7e2088">More...</a><br/></td></tr> <tr class="separator:a9f531641dfb4e43cd88ac1a9ae7e2088"><td class="memSeparator" colspan="2"> </td></tr> </table> -<h2 class="groupheader">Function Documentation</h2> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>DAV related classes from SabreDAV for Red Matrix. </p> +<p>This file contains the classes from SabreDAV that got extended to adapt it for Red Matrix.</p> +<p>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. </p> +</div><h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ae92ea0df1993f6a7bcd1b6efa6c1fb66"></a> <div class="memitem"> <div class="memproto"> @@ -146,6 +157,17 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Returns an array with viewable channels. </p> +<p>Get a list of <a class="el" href="classRedDirectory.html" title="RedDirectory class.">RedDirectory</a> objects with all the channels where the visitor has <b>view_storage</b> perms.</p> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Is there any reason why this is not inside <a class="el" href="classRedDirectory.html" title="RedDirectory class.">RedDirectory</a> class?</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">$auth</td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>array containing <a class="el" href="classRedDirectory.html" title="RedDirectory class.">RedDirectory</a> objects </dd></dl> + <p>Referenced by <a class="el" href="reddav_8php.html#a5df0d09893f2e65dc5cf6bbab6cfb266">RedCollectionData()</a>.</p> </div> @@ -174,6 +196,18 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>TODO what exactly does this function? </p> +<p>Array with all <a class="el" href="classRedDirectory.html" title="RedDirectory class.">RedDirectory</a> and <a class="el" href="classRedFile.html">RedFile</a> DAV items for the given path.</p> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>Is there any reason why this is not inside <a class="el" href="classRedDirectory.html" title="RedDirectory class.">RedDirectory</a> class? Seems only to be used there and we could simplify it a bit there.</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">string</td><td class="paramname">$file</td><td>path to a directory </td></tr> + <tr><td class="paramtype"></td><td class="paramname">&$auth</td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>array DAV[] </dd></dl> + <p>Referenced by <a class="el" href="classRedDirectory.html#aa42d3065f6f065b17db87146a7cb031a">RedDirectory\getChildren()</a>.</p> </div> @@ -208,6 +242,16 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>TODO What exactly is this function for? </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">string</td><td class="paramname">$file</td><td></td></tr> + <tr><td class="paramtype"></td><td class="paramname">&$auth</td><td></td></tr> + <tr><td class="paramtype">boolean</td><td class="paramname">$test</td><td>(optional) enable test mode </td></tr> + </table> + </dd> +</dl> + <p>Referenced by <a class="el" href="classRedDirectory.html#a5e3fc08b2bf9f61cea4d2ccae0495bec">RedDirectory\childExists()</a>, <a class="el" href="cloud_8php.html#a1b79a6fe0454bc76673ad9aef55bf02d">cloud_init()</a>, and <a class="el" href="classRedDirectory.html#aaa20f0f44da23781917af8170c0a2569">RedDirectory\getChild()</a>.</p> </div> |