harukin/core
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc updates

Browse Source
This commit is contained in:
friendica
2014-10-19 15:54:51 -07:00
parent e8be2ff8da
commit 478e7c4479
114 changed files with 2239 additions and 2050 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
doc/html/reddav_8php.html
View File

@@ -104,27 +104,15 @@ $(document).ready(function(){initNavTree('reddav_8php.html','');});
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">reddav.php File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>DAV related classes from SabreDAV for Red Matrix.
<p>some DAV related functions for <a class="el" href="namespaceRedMatrix.html">RedMatrix</a>.
<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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html">RedDirectory</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedFile.html">RedFile</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedBasicAuth.html">RedBasicAuth</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Authentication backend class for RedDAV. <a href="classRedBasicAuth.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="reddav_8php.html#ae92ea0df1993f6a7bcd1b6efa6c1fb66">RedChannelList</a> (&amp;$auth)</td></tr>
@@ -138,10 +126,11 @@ Functions</h2></td></tr>
<tr class="separator:a9f531641dfb4e43cd88ac1a9ae7e2088"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<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 &gt;= 2.0 requires PHP &gt;= 5.4.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>split up the classes into own files. </dd></dl>
<div class="textblock"><p>some DAV related functions for <a class="el" href="namespaceRedMatrix.html">RedMatrix</a>. </p>
<p>This file contains some functions which did not fit into one of the RedDAV classes.</p>
<p>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 &gt;= 2.0 requires PHP &gt;= 5.4.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000007">Todo:</a></b></dt><dd>split up the classes into own files.</dd></dl>
<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">Function Documentation</h2>
<a class="anchor" id="ae92ea0df1993f6a7bcd1b6efa6c1fb66"></a>
<div class="memitem">
@@ -158,15 +147,15 @@ Functions</h2></td></tr>
</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#_todo000004">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>
<p>Get a list of RedDirectory 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#_todo000008">Todo:</a></b></dt><dd>Is there any reason why this is not inside RedDirectory class? function name looks like a class name, should we rename it?</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$auth</td><td></td></tr>
<tr><td class="paramtype">RedBasicAuth</td><td class="paramname">&amp;$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>
<dl class="section return"><dt>Returns</dt><dd>array RedDirectory[] </dd></dl>
<p>Referenced by <a class="el" href="reddav_8php.html#a5df0d09893f2e65dc5cf6bbab6cfb266">RedCollectionData()</a>.</p>
@@ -197,18 +186,25 @@ Functions</h2></td></tr>
</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#_todo000005">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>
<p>Array with all RedDirectory and RedFile DAV items for the given path.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000009">Todo:</a></b></dt><dd>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?</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">&amp;$auth</td><td></td></tr>
<tr><td class="paramtype">RedBasicAuth</td><td class="paramname">&amp;$auth</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>null|array [] </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">\Sabre\DAV\Exception\Forbidden</td><td></td></tr>
<tr><td class="paramname">\Sabre\DAV\Exception\NotFound</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>
<p>Referenced by <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a9b9a0b5bfa4de1f78e6cafaa534b6f6a">RedMatrix\RedDAV\RedDirectory\getChildren()</a>.</p>
</div>
</div>
@@ -243,16 +239,24 @@ Functions</h2></td></tr>
</div><div class="memdoc">
<p>TODO What exactly is this function for? </p>
<p>function name looks like a class name, should we rename it?</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">&amp;$auth</td><td></td></tr>
<tr><td class="paramtype">string</td><td class="paramname">$file</td><td>path to file or directory </td></tr>
<tr><td class="paramtype">RedBasicAuth</td><td class="paramname">&amp;$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>
<dl class="section return"><dt>Returns</dt><dd>RedFile|RedDirectory|boolean|null </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">\Sabre\DAV\Exception\Forbidden</td><td></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#ad2e96e917852f27dedfc263d37e13756">cloud_init()</a>, and <a class="el" href="classRedDirectory.html#aaa20f0f44da23781917af8170c0a2569">RedDirectory\getChild()</a>.</p>
<p>Referenced by <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a964b13fde1a5da6f76b51ca5519234dc">RedMatrix\RedDAV\RedDirectory\childExists()</a>, <a class="el" href="cloud_8php.html#ad2e96e917852f27dedfc263d37e13756">cloud_init()</a>, and <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a1a37850bdd1f188abd6160559698d5d7">RedMatrix\RedDAV\RedDirectory\getChild()</a>.</p>
</div>
</div>