diff options
| author | Klaus Weidenbach <Klaus.Weidenbach@gmx.net> | 2015-03-04 10:15:16 +0100 |
|---|---|---|
| committer | Klaus Weidenbach <Klaus.Weidenbach@gmx.net> | 2015-03-04 11:38:35 +0100 |
| commit | da6eecd03111660ae12221265986ba4b10b155dd (patch) | |
| tree | c9e90e99e800981196083c6c5d1086b7ef3f37d9 /doc/html/classRedDirectory.html | |
| parent | 684ce972fe7c6cb5e2d0cc7aea4df989a3734403 (diff) | |
| download | volse-hubzilla-da6eecd03111660ae12221265986ba4b10b155dd.tar.gz volse-hubzilla-da6eecd03111660ae12221265986ba4b10b155dd.tar.bz2 volse-hubzilla-da6eecd03111660ae12221265986ba4b10b155dd.zip | |
remove Doxygen API Documentation from repository.
This removes around 14MB and can get easily generate locally by
doxygen util/Doxyfile when needed.
Restructured .gitignore a bit and some additions like zotshrc, etc.
Fixed a typo in doc/main.bb
Diffstat (limited to 'doc/html/classRedDirectory.html')
| -rw-r--r-- | doc/html/classRedDirectory.html | 641 |
1 files changed, 0 insertions, 641 deletions
diff --git a/doc/html/classRedDirectory.html b/doc/html/classRedDirectory.html deleted file mode 100644 index 2975fc2ef..000000000 --- a/doc/html/classRedDirectory.html +++ /dev/null @@ -1,641 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> -<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.3.1"/> -<title>The Red Matrix: RedDirectory Class Reference</title> -<link href="tabs.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="jquery.js"></script> -<script type="text/javascript" src="dynsections.js"></script> -<link href="navtree.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="resize.js"></script> -<script type="text/javascript" src="navtree.js"></script> -<script type="text/javascript"> - $(document).ready(initResizable); - $(window).load(resizeHeight); -</script> -<link href="search/search.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="search/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</script> -<link href="doxygen.css" rel="stylesheet" type="text/css" /> -</head> -<body> -<div id="top"><!-- do not remove this div, it is closed by doxygen! --> -<div id="titlearea"> -<table cellspacing="0" cellpadding="0"> - <tbody> - <tr style="height: 56px;"> - <td id="projectlogo"><img alt="Logo" src="rm-64.png"/></td> - <td style="padding-left: 0.5em;"> - <div id="projectname">The Red Matrix - </div> - </td> - </tr> - </tbody> -</table> -</div> -<!-- end header part --> -<!-- Generated by Doxygen 1.8.3.1 --> -<script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); -</script> - <div id="navrow1" class="tabs"> - <ul class="tablist"> - <li><a href="index.html"><span>Main Page</span></a></li> - <li><a href="pages.html"><span>Related Pages</span></a></li> - <li><a href="namespaces.html"><span>Namespaces</span></a></li> - <li class="current"><a href="annotated.html"><span>Classes</span></a></li> - <li><a href="files.html"><span>Files</span></a></li> - <li> - <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> - </li> - </ul> - </div> - <div id="navrow2" class="tabs2"> - <ul class="tablist"> - <li><a href="annotated.html"><span>Class List</span></a></li> - <li><a href="classes.html"><span>Class Index</span></a></li> - <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> - <li><a href="functions.html"><span>Class Members</span></a></li> - </ul> - </div> -</div><!-- top --> -<div id="side-nav" class="ui-resizable side-nav-resizable"> - <div id="nav-tree"> - <div id="nav-tree-contents"> - <div id="nav-sync" class="sync"></div> - </div> - </div> - <div id="splitbar" style="-moz-user-select:none;" - class="ui-resizable-handle"> - </div> -</div> -<script type="text/javascript"> -$(document).ready(function(){initNavTree('classRedDirectory.html','');}); -</script> -<div id="doc-content"> -<!-- window showing the filter options --> -<div id="MSearchSelectWindow" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - onkeydown="return searchBox.OnSearchSelectKey(event)"> -<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Pages</a></div> - -<!-- iframe showing the search results (closed by default) --> -<div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> -</div> - -<div class="header"> - <div class="summary"> -<a href="#pub-methods">Public Member Functions</a> | -<a href="#pri-methods">Private Member Functions</a> | -<a href="#pri-attribs">Private Attributes</a> | -<a href="classRedDirectory-members.html">List of all members</a> </div> - <div class="headertitle"> -<div class="title">RedDirectory Class Reference</div> </div> -</div><!--header--> -<div class="contents"> - -<p><a class="el" href="classRedDirectory.html" title="RedDirectory class.">RedDirectory</a> class. - <a href="classRedDirectory.html#details">More...</a></p> -<div class="dynheader"> -Inheritance diagram for RedDirectory:</div> -<div class="dyncontent"> - <div class="center"> - <img src="classRedDirectory.png" usemap="#RedDirectory_map" alt=""/> - <map id="RedDirectory_map" name="RedDirectory_map"> -</map> - </div></div> -<table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> -Public Member Functions</h2></td></tr> -<tr class="memitem:a1e35e3cd31d2a15250655e4cafdea180"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#a1e35e3cd31d2a15250655e4cafdea180">__construct</a> ($ext_path, &$auth_plugin)</td></tr> -<tr class="memdesc:a1e35e3cd31d2a15250655e4cafdea180"><td class="mdescLeft"> </td><td class="mdescRight">Sets up the directory node, expects a full path. <a href="#a1e35e3cd31d2a15250655e4cafdea180">More...</a><br/></td></tr> -<tr class="separator:a1e35e3cd31d2a15250655e4cafdea180"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa42d3065f6f065b17db87146a7cb031a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#aa42d3065f6f065b17db87146a7cb031a">getChildren</a> ()</td></tr> -<tr class="memdesc:aa42d3065f6f065b17db87146a7cb031a"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array with all the child nodes. <a href="#aa42d3065f6f065b17db87146a7cb031a">More...</a><br/></td></tr> -<tr class="separator:aa42d3065f6f065b17db87146a7cb031a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aaa20f0f44da23781917af8170c0a2569"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#aaa20f0f44da23781917af8170c0a2569">getChild</a> ($name)</td></tr> -<tr class="memdesc:aaa20f0f44da23781917af8170c0a2569"><td class="mdescLeft"> </td><td class="mdescRight">Returns a child by name. <a href="#aaa20f0f44da23781917af8170c0a2569">More...</a><br/></td></tr> -<tr class="separator:aaa20f0f44da23781917af8170c0a2569"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:af6e4475dbd5abcdede00d20b8d388583"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#af6e4475dbd5abcdede00d20b8d388583">getName</a> ()</td></tr> -<tr class="memdesc:af6e4475dbd5abcdede00d20b8d388583"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the directory. <a href="#af6e4475dbd5abcdede00d20b8d388583">More...</a><br/></td></tr> -<tr class="separator:af6e4475dbd5abcdede00d20b8d388583"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:adc48035679e52c55d9881f83de535553"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#adc48035679e52c55d9881f83de535553">setName</a> ($name)</td></tr> -<tr class="memdesc:adc48035679e52c55d9881f83de535553"><td class="mdescLeft"> </td><td class="mdescRight">Renames the directory. <a href="#adc48035679e52c55d9881f83de535553">More...</a><br/></td></tr> -<tr class="separator:adc48035679e52c55d9881f83de535553"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2d12d99d38a6a75fc9a830b2f7fc0bf0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#a2d12d99d38a6a75fc9a830b2f7fc0bf0">createFile</a> ($name, $data=null)</td></tr> -<tr class="memdesc:a2d12d99d38a6a75fc9a830b2f7fc0bf0"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new file in the directory. <a href="#a2d12d99d38a6a75fc9a830b2f7fc0bf0">More...</a><br/></td></tr> -<tr class="separator:a2d12d99d38a6a75fc9a830b2f7fc0bf0"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a986936910f0216887a25e28916c166c7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#a986936910f0216887a25e28916c166c7">createDirectory</a> ($name)</td></tr> -<tr class="memdesc:a986936910f0216887a25e28916c166c7"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new subdirectory. <a href="#a986936910f0216887a25e28916c166c7">More...</a><br/></td></tr> -<tr class="separator:a986936910f0216887a25e28916c166c7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a5e3fc08b2bf9f61cea4d2ccae0495bec"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#a5e3fc08b2bf9f61cea4d2ccae0495bec">childExists</a> ($name)</td></tr> -<tr class="memdesc:a5e3fc08b2bf9f61cea4d2ccae0495bec"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a child exists. <a href="#a5e3fc08b2bf9f61cea4d2ccae0495bec">More...</a><br/></td></tr> -<tr class="separator:a5e3fc08b2bf9f61cea4d2ccae0495bec"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a70173d4458572d95e586b2037d2fd2f4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#a70173d4458572d95e586b2037d2fd2f4">getDir</a> ()</td></tr> -<tr class="separator:a70173d4458572d95e586b2037d2fd2f4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a6c7e08199abc24e6eeb94a4037ef8bfc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#a6c7e08199abc24e6eeb94a4037ef8bfc">getLastModified</a> ()</td></tr> -<tr class="memdesc:a6c7e08199abc24e6eeb94a4037ef8bfc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the last modification time for the directory, as a UNIX timestamp. <a href="#a6c7e08199abc24e6eeb94a4037ef8bfc">More...</a><br/></td></tr> -<tr class="separator:a6c7e08199abc24e6eeb94a4037ef8bfc"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2f7a574f2115f099d6dd103d5b252375"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#a2f7a574f2115f099d6dd103d5b252375">getQuotaInfo</a> ()</td></tr> -<tr class="memdesc:a2f7a574f2115f099d6dd103d5b252375"><td class="mdescLeft"> </td><td class="mdescRight">Return quota usage. <a href="#a2f7a574f2115f099d6dd103d5b252375">More...</a><br/></td></tr> -<tr class="separator:a2f7a574f2115f099d6dd103d5b252375"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a> -Private Member Functions</h2></td></tr> -<tr class="memitem:a11376aed1963b4471eb1592c13c63976"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#a11376aed1963b4471eb1592c13c63976">log</a> ()</td></tr> -<tr class="separator:a11376aed1963b4471eb1592c13c63976"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a> -Private Attributes</h2></td></tr> -<tr class="memitem:acb32b8df27538c57772824a745e751d7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#acb32b8df27538c57772824a745e751d7">$red_path</a></td></tr> -<tr class="separator:acb32b8df27538c57772824a745e751d7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa10254abf177bb2a0e4a88495725e09b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#aa10254abf177bb2a0e4a88495725e09b">$folder_hash</a></td></tr> -<tr class="separator:aa10254abf177bb2a0e4a88495725e09b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a0f113244cd85c17848df991001d024f4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#a0f113244cd85c17848df991001d024f4">$ext_path</a></td></tr> -<tr class="separator:a0f113244cd85c17848df991001d024f4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ad87c514a307ec97ba0f1372e9bcfa6a4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#ad87c514a307ec97ba0f1372e9bcfa6a4">$root_dir</a> = ''</td></tr> -<tr class="separator:ad87c514a307ec97ba0f1372e9bcfa6a4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a9616af16cd19a18a6afebebcc2881c44"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#a9616af16cd19a18a6afebebcc2881c44">$auth</a></td></tr> -<tr class="separator:a9616af16cd19a18a6afebebcc2881c44"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a3c148c07ad909985125aa4926d8d0021"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedDirectory.html#a3c148c07ad909985125aa4926d8d0021">$os_path</a> = ''</td></tr> -<tr class="separator:a3c148c07ad909985125aa4926d8d0021"><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="classRedDirectory.html" title="RedDirectory class.">RedDirectory</a> class. </p> -<p>A class that represents a directory.</p> -</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> -<a class="anchor" id="a1e35e3cd31d2a15250655e4cafdea180"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::__construct </td> - <td>(</td> - <td class="paramtype"> </td> - <td class="paramname"><em>$ext_path</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">& </td> - <td class="paramname"><em>$auth_plugin</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Sets up the directory node, expects a full path. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramtype">string</td><td class="paramname">$ext_path</td><td>a full path </td></tr> - <tr><td class="paramtype"><a class="el" href="classRedBasicAuth.html" title="Authentication backend class for RedDAV.">RedBasicAuth</a></td><td class="paramname">&$auth_plugin</td><td></td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<h2 class="groupheader">Member Function Documentation</h2> -<a class="anchor" id="a5e3fc08b2bf9f61cea4d2ccae0495bec"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::childExists </td> - <td>(</td> - <td class="paramtype"> </td> - <td class="paramname"><em>$name</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Checks if a child exists. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramtype">string</td><td class="paramname">$name</td><td></td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl> - -</div> -</div> -<a class="anchor" id="a986936910f0216887a25e28916c166c7"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::createDirectory </td> - <td>(</td> - <td class="paramtype"> </td> - <td class="paramname"><em>$name</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Creates a new subdirectory. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramtype">string</td><td class="paramname">$name</td><td>the directory to create </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>void </dd></dl> - -</div> -</div> -<a class="anchor" id="a2d12d99d38a6a75fc9a830b2f7fc0bf0"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::createFile </td> - <td>(</td> - <td class="paramtype"> </td> - <td class="paramname"><em>$name</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"> </td> - <td class="paramname"><em>$data</em> = <code>null</code> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Creates a new file in the directory. </p> -<p>Data will either be supplied as a stream resource, or in certain cases as a string. Keep in mind that you may have to support either.</p> -<p>After successful creation of the file, you may choose to return the ETag of the new file here.</p> -<dl class="exception"><dt>Exceptions</dt><dd> - <table class="exception"> - <tr><td class="paramname">DAV\Exception\Forbidden</td><td></td></tr> - </table> - </dd> -</dl> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramtype">string</td><td class="paramname">$name</td><td>Name of the file </td></tr> - <tr><td class="paramtype">resource | string</td><td class="paramname">$data</td><td>Initial payload </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>null|string ETag </dd></dl> - -</div> -</div> -<a class="anchor" id="aaa20f0f44da23781917af8170c0a2569"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::getChild </td> - <td>(</td> - <td class="paramtype"> </td> - <td class="paramname"><em>$name</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Returns a child by name. </p> -<dl class="exception"><dt>Exceptions</dt><dd> - <table class="exception"> - <tr><td class="paramname">DAV\Exception\Forbidden</td><td></td></tr> - <tr><td class="paramname">DAV\Exception\NotFound</td><td></td></tr> - </table> - </dd> -</dl> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramtype">string</td><td class="paramname">$name</td><td></td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="aa42d3065f6f065b17db87146a7cb031a"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::getChildren </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Returns an array with all the child nodes. </p> -<dl class="exception"><dt>Exceptions</dt><dd> - <table class="exception"> - <tr><td class="paramname">DAV\Exception\Forbidden</td><td></td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>array DAV[] </dd></dl> - -</div> -</div> -<a class="anchor" id="a70173d4458572d95e586b2037d2fd2f4"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::getDir </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000008">Todo:</a></b></dt><dd>add description of what this function does.</dd></dl> -<dl class="exception"><dt>Exceptions</dt><dd> - <table class="exception"> - <tr><td class="paramname">DAV\Exception\NotFound</td><td></td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>void </dd></dl> - -<p>Referenced by <a class="el" href="classRedDirectory.html#a1e35e3cd31d2a15250655e4cafdea180">__construct()</a>.</p> - -</div> -</div> -<a class="anchor" id="a6c7e08199abc24e6eeb94a4037ef8bfc"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::getLastModified </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Returns the last modification time for the directory, as a UNIX timestamp. </p> -<p>It looks for the last edited file in the folder. If it is an empty folder it returns the lastmodified time of the folder itself, to prevent zero timestamps.</p> -<dl class="section return"><dt>Returns</dt><dd>int last modification time in UNIX timestamp </dd></dl> - -</div> -</div> -<a class="anchor" id="af6e4475dbd5abcdede00d20b8d388583"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::getName </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Returns the name of the directory. </p> -<dl class="section return"><dt>Returns</dt><dd>string </dd></dl> - -</div> -</div> -<a class="anchor" id="a2f7a574f2115f099d6dd103d5b252375"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::getQuotaInfo </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Return quota usage. </p> -<p>Do guests relly see the used/free values from filesystem of the complete store directory?</p> -<dl class="section return"><dt>Returns</dt><dd>array with used and free values in bytes. </dd></dl> - -</div> -</div> -<a class="anchor" id="a11376aed1963b4471eb1592c13c63976"></a> -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::log </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">private</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> - -<p>Referenced by <a class="el" href="classRedDirectory.html#aa42d3065f6f065b17db87146a7cb031a">getChildren()</a>.</p> - -</div> -</div> -<a class="anchor" id="adc48035679e52c55d9881f83de535553"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::setName </td> - <td>(</td> - <td class="paramtype"> </td> - <td class="paramname"><em>$name</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Renames the directory. </p> -<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000007">Todo:</a></b></dt><dd>handle duplicate directory name</dd></dl> -<dl class="exception"><dt>Exceptions</dt><dd> - <table class="exception"> - <tr><td class="paramname">DAV\Exception\Forbidden</td><td></td></tr> - </table> - </dd> -</dl> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramtype">string</td><td class="paramname">$name</td><td>The new name of the directory. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>void </dd></dl> - -</div> -</div> -<h2 class="groupheader">Member Data Documentation</h2> -<a class="anchor" id="a9616af16cd19a18a6afebebcc2881c44"></a> -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::$auth</td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">private</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> - -</div> -</div> -<a class="anchor" id="a0f113244cd85c17848df991001d024f4"></a> -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::$ext_path</td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">private</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> - -<p>Referenced by <a class="el" href="classRedDirectory.html#a1e35e3cd31d2a15250655e4cafdea180">__construct()</a>, and <a class="el" href="classRedDirectory.html#a70173d4458572d95e586b2037d2fd2f4">getDir()</a>.</p> - -</div> -</div> -<a class="anchor" id="aa10254abf177bb2a0e4a88495725e09b"></a> -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::$folder_hash</td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">private</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> - -</div> -</div> -<a class="anchor" id="a3c148c07ad909985125aa4926d8d0021"></a> -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::$os_path = ''</td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">private</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> - -<p>Referenced by <a class="el" href="classRedDirectory.html#a2d12d99d38a6a75fc9a830b2f7fc0bf0">createFile()</a>, and <a class="el" href="classRedDirectory.html#a70173d4458572d95e586b2037d2fd2f4">getDir()</a>.</p> - -</div> -</div> -<a class="anchor" id="acb32b8df27538c57772824a745e751d7"></a> -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::$red_path</td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">private</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> - -</div> -</div> -<a class="anchor" id="ad87c514a307ec97ba0f1372e9bcfa6a4"></a> -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">RedDirectory::$root_dir = ''</td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">private</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> - -</div> -</div> -<hr/>The documentation for this class was generated from the following file:<ul> -<li>include/<a class="el" href="reddav_8php.html">reddav.php</a></li> -</ul> -</div><!-- contents --> -</div><!-- doc-content --> - |