blob: 5f07edc7d8ff31385cfea9d569daf8e2b7e5fc20 (
plain) (
tree)
|
|
<!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: RedMatrix\RedDAV\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('classRedMatrix_1_1RedDAV_1_1RedDirectory.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="classRedMatrix_1_1RedDAV_1_1RedDirectory-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">RedMatrix\RedDAV\RedDirectory Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html" title="RedDirectory class.">RedDirectory</a> class.
<a href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for RedMatrix\RedDAV\RedDirectory:</div>
<div class="dyncontent">
<div class="center">
<img src="classRedMatrix_1_1RedDAV_1_1RedDirectory.png" usemap="#RedMatrix\RedDAV\RedDirectory_map" alt=""/>
<map id="RedMatrix\RedDAV\RedDirectory_map" name="RedMatrix\RedDAV\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:a76b58fe5223e565c97f1b9af93031a99"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a76b58fe5223e565c97f1b9af93031a99">__construct</a> ($ext_path, &$auth_plugin)</td></tr>
<tr class="memdesc:a76b58fe5223e565c97f1b9af93031a99"><td class="mdescLeft"> </td><td class="mdescRight">Sets up the directory node, expects a full path. <a href="#a76b58fe5223e565c97f1b9af93031a99">More...</a><br/></td></tr>
<tr class="separator:a76b58fe5223e565c97f1b9af93031a99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b9a0b5bfa4de1f78e6cafaa534b6f6a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a9b9a0b5bfa4de1f78e6cafaa534b6f6a">getChildren</a> ()</td></tr>
<tr class="memdesc:a9b9a0b5bfa4de1f78e6cafaa534b6f6a"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array with all the child nodes. <a href="#a9b9a0b5bfa4de1f78e6cafaa534b6f6a">More...</a><br/></td></tr>
<tr class="separator:a9b9a0b5bfa4de1f78e6cafaa534b6f6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a37850bdd1f188abd6160559698d5d7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a1a37850bdd1f188abd6160559698d5d7">getChild</a> ($name)</td></tr>
<tr class="memdesc:a1a37850bdd1f188abd6160559698d5d7"><td class="mdescLeft"> </td><td class="mdescRight">Returns a child by name. <a href="#a1a37850bdd1f188abd6160559698d5d7">More...</a><br/></td></tr>
<tr class="separator:a1a37850bdd1f188abd6160559698d5d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55f7172814a0749b5342f152ab3fa0df"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a55f7172814a0749b5342f152ab3fa0df">getName</a> ()</td></tr>
<tr class="memdesc:a55f7172814a0749b5342f152ab3fa0df"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the directory. <a href="#a55f7172814a0749b5342f152ab3fa0df">More...</a><br/></td></tr>
<tr class="separator:a55f7172814a0749b5342f152ab3fa0df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a14ac61d31a031d139956763db4e03956"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a14ac61d31a031d139956763db4e03956">setName</a> ($name)</td></tr>
<tr class="memdesc:a14ac61d31a031d139956763db4e03956"><td class="mdescLeft"> </td><td class="mdescRight">Renames the directory. <a href="#a14ac61d31a031d139956763db4e03956">More...</a><br/></td></tr>
<tr class="separator:a14ac61d31a031d139956763db4e03956"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58e750256cdc2f0f79fbe8d5463ffefe"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a58e750256cdc2f0f79fbe8d5463ffefe">createFile</a> ($name, $data=null)</td></tr>
<tr class="memdesc:a58e750256cdc2f0f79fbe8d5463ffefe"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new file in the directory. <a href="#a58e750256cdc2f0f79fbe8d5463ffefe">More...</a><br/></td></tr>
<tr class="separator:a58e750256cdc2f0f79fbe8d5463ffefe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca0e8d574ea66a0e210f571700663c62"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#aca0e8d574ea66a0e210f571700663c62">createDirectory</a> ($name)</td></tr>
<tr class="memdesc:aca0e8d574ea66a0e210f571700663c62"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new subdirectory. <a href="#aca0e8d574ea66a0e210f571700663c62">More...</a><br/></td></tr>
<tr class="separator:aca0e8d574ea66a0e210f571700663c62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a964b13fde1a5da6f76b51ca5519234dc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a964b13fde1a5da6f76b51ca5519234dc">childExists</a> ($name)</td></tr>
<tr class="memdesc:a964b13fde1a5da6f76b51ca5519234dc"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a child exists. <a href="#a964b13fde1a5da6f76b51ca5519234dc">More...</a><br/></td></tr>
<tr class="separator:a964b13fde1a5da6f76b51ca5519234dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a825dc5f3e0f83f50736c16daa6a4809d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a825dc5f3e0f83f50736c16daa6a4809d">getDir</a> ()</td></tr>
<tr class="separator:a825dc5f3e0f83f50736c16daa6a4809d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69db5f641f8f5dc999e55cee1832ecd5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a69db5f641f8f5dc999e55cee1832ecd5">getLastModified</a> ()</td></tr>
<tr class="memdesc:a69db5f641f8f5dc999e55cee1832ecd5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the last modification time for the directory, as a UNIX timestamp. <a href="#a69db5f641f8f5dc999e55cee1832ecd5">More...</a><br/></td></tr>
<tr class="separator:a69db5f641f8f5dc999e55cee1832ecd5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69db443ed3c84938b4352fe515bf8d68"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a69db443ed3c84938b4352fe515bf8d68">getQuotaInfo</a> ()</td></tr>
<tr class="memdesc:a69db443ed3c84938b4352fe515bf8d68"><td class="mdescLeft"> </td><td class="mdescRight">Return quota usage. <a href="#a69db443ed3c84938b4352fe515bf8d68">More...</a><br/></td></tr>
<tr class="separator:a69db443ed3c84938b4352fe515bf8d68"><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:af90a1a74cfd643a5c56b9a17ea250d59"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#af90a1a74cfd643a5c56b9a17ea250d59">log</a> ()</td></tr>
<tr class="separator:af90a1a74cfd643a5c56b9a17ea250d59"><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:a4bba2e56bc8ec3e05f05eae46f56f36d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a4bba2e56bc8ec3e05f05eae46f56f36d">$red_path</a></td></tr>
<tr class="separator:a4bba2e56bc8ec3e05f05eae46f56f36d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2fc4e6b9be2108bbaa1ca1a03fd6d44e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a2fc4e6b9be2108bbaa1ca1a03fd6d44e">$folder_hash</a></td></tr>
<tr class="separator:a2fc4e6b9be2108bbaa1ca1a03fd6d44e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf8735b3118cdf2f42416edaf42b82e9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#adf8735b3118cdf2f42416edaf42b82e9">$ext_path</a></td></tr>
<tr class="separator:adf8735b3118cdf2f42416edaf42b82e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a438066fb1565fbcffa22c12d5ce23695"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a438066fb1565fbcffa22c12d5ce23695">$root_dir</a> = ''</td></tr>
<tr class="separator:a438066fb1565fbcffa22c12d5ce23695"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aab6907e7fb7f9f7227f9cd42bdc84eb9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#aab6907e7fb7f9f7227f9cd42bdc84eb9">$auth</a></td></tr>
<tr class="separator:aab6907e7fb7f9f7227f9cd42bdc84eb9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17ea47e34cb76b6e79f36ebed790d76a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a17ea47e34cb76b6e79f36ebed790d76a">$os_path</a> = ''</td></tr>
<tr class="separator:a17ea47e34cb76b6e79f36ebed790d76a"><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="classRedMatrix_1_1RedDAV_1_1RedDirectory.html" title="RedDirectory class.">RedDirectory</a> class. </p>
<p>A class that represents a directory.</p>
<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">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a76b58fe5223e565c97f1b9af93031a99"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.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="a964b13fde1a5da6f76b51ca5519234dc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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>The name to check if it exists. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
</div>
</div>
<a class="anchor" id="aca0e8d574ea66a0e210f571700663c62"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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="a58e750256cdc2f0f79fbe8d5463ffefe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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">\Sabre\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="a1a37850bdd1f188abd6160559698d5d7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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">\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="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="a9b9a0b5bfa4de1f78e6cafaa534b6f6a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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">\Sabre\DAV\Exception\Forbidden</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>array [] </dd></dl>
</div>
</div>
<a class="anchor" id="a825dc5f3e0f83f50736c16daa6a4809d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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#_todo000006">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">\Sabre\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="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a76b58fe5223e565c97f1b9af93031a99">RedMatrix\RedDAV\RedDirectory\__construct()</a>.</p>
</div>
</div>
<a class="anchor" id="a69db5f641f8f5dc999e55cee1832ecd5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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="a55f7172814a0749b5342f152ab3fa0df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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="a69db443ed3c84938b4352fe515bf8d68"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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>Should 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="af90a1a74cfd643a5c56b9a17ea250d59"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a9b9a0b5bfa4de1f78e6cafaa534b6f6a">RedMatrix\RedDAV\RedDirectory\getChildren()</a>.</p>
</div>
</div>
<a class="anchor" id="a14ac61d31a031d139956763db4e03956"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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#_todo000005">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">\Sabre\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="aab6907e7fb7f9f7227f9cd42bdc84eb9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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="adf8735b3118cdf2f42416edaf42b82e9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a76b58fe5223e565c97f1b9af93031a99">RedMatrix\RedDAV\RedDirectory\__construct()</a>, and <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a825dc5f3e0f83f50736c16daa6a4809d">RedMatrix\RedDAV\RedDirectory\getDir()</a>.</p>
</div>
</div>
<a class="anchor" id="a2fc4e6b9be2108bbaa1ca1a03fd6d44e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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="a17ea47e34cb76b6e79f36ebed790d76a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a58e750256cdc2f0f79fbe8d5463ffefe">RedMatrix\RedDAV\RedDirectory\createFile()</a>, and <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a825dc5f3e0f83f50736c16daa6a4809d">RedMatrix\RedDAV\RedDirectory\getDir()</a>.</p>
</div>
</div>
<a class="anchor" id="a4bba2e56bc8ec3e05f05eae46f56f36d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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="a438066fb1565fbcffa22c12d5ce23695"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RedMatrix\RedDAV\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/RedDAV/<a class="el" href="RedDirectory_8php.html">RedDirectory.php</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
|
