diff options
Diffstat (limited to 'doc')
20 files changed, 2790 insertions, 0 deletions
diff --git a/doc/html/RedBasicAuth_8php.html b/doc/html/RedBasicAuth_8php.html new file mode 100644 index 000000000..86984219c --- /dev/null +++ b/doc/html/RedBasicAuth_8php.html @@ -0,0 +1,127 @@ +<!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: include/RedDAV/RedBasicAuth.php File 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><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><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="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File 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('RedBasicAuth_8php.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="#nested-classes">Classes</a> | +<a href="#namespaces">Namespaces</a> </div> + <div class="headertitle"> +<div class="title">RedBasicAuth.php File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<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="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Authentication backend class for <a class="el" href="namespaceRedMatrix_1_1RedDAV.html">RedDAV</a>. <a href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#details">More...</a><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> +Namespaces</h2></td></tr> +<tr class="memitem:namespaceRedMatrix_1_1RedDAV"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceRedMatrix_1_1RedDAV.html">RedMatrix\RedDAV</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table> +</div><!-- contents --> +</div><!-- doc-content --> + diff --git a/doc/html/RedDirectory_8php.html b/doc/html/RedDirectory_8php.html new file mode 100644 index 000000000..e0e081164 --- /dev/null +++ b/doc/html/RedDirectory_8php.html @@ -0,0 +1,127 @@ +<!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: include/RedDAV/RedDirectory.php File 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><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><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="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File 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('RedDirectory_8php.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="#nested-classes">Classes</a> | +<a href="#namespaces">Namespaces</a> </div> + <div class="headertitle"> +<div class="title">RedDirectory.php File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<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="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><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><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> +Namespaces</h2></td></tr> +<tr class="memitem:namespaceRedMatrix_1_1RedDAV"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceRedMatrix_1_1RedDAV.html">RedMatrix\RedDAV</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table> +</div><!-- contents --> +</div><!-- doc-content --> + diff --git a/doc/html/RedFile_8php.html b/doc/html/RedFile_8php.html new file mode 100644 index 000000000..218102ecc --- /dev/null +++ b/doc/html/RedFile_8php.html @@ -0,0 +1,127 @@ +<!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: include/RedDAV/RedFile.php File 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><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><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="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File 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('RedFile_8php.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="#nested-classes">Classes</a> | +<a href="#namespaces">Namespaces</a> </div> + <div class="headertitle"> +<div class="title">RedFile.php File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<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="classRedMatrix_1_1RedDAV_1_1RedFile.html">RedMatrix\RedDAV\RedFile</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This class represents a file in DAV. <a href="classRedMatrix_1_1RedDAV_1_1RedFile.html#details">More...</a><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> +Namespaces</h2></td></tr> +<tr class="memitem:namespaceRedMatrix_1_1RedDAV"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceRedMatrix_1_1RedDAV.html">RedMatrix\RedDAV</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table> +</div><!-- contents --> +</div><!-- doc-content --> + diff --git a/doc/html/chanman_8php.js b/doc/html/chanman_8php.js new file mode 100644 index 000000000..803e97f0b --- /dev/null +++ b/doc/html/chanman_8php.js @@ -0,0 +1,4 @@ +var chanman_8php = +[ + [ "chanman_remove_everything_from_network", "chanman_8php.html#a21ba9a5c961e866ff27aee3ee67bf99b", null ] +];
\ No newline at end of file diff --git a/doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth-members.html b/doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth-members.html new file mode 100644 index 000000000..f2f77b15f --- /dev/null +++ b/doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth-members.html @@ -0,0 +1,133 @@ +<!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: Member List</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_1RedBasicAuth.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="headertitle"> +<div class="title">RedMatrix\RedDAV\RedBasicAuth Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a167ae032bd2ad8e6caa2e1e1a6f1b5d3">$browser</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a112ad78a863dc0e598b5f02c596798c0">$channel_hash</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#abe1defedb90ac8e3b6487e124e625521">$channel_id</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a76fdb7fd5dd7376155abb5a58cd6fd69">$channel_name</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a605aa09565a097316b80f0d17d6b5823">$observer</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a1a23c349cc4699a8474505972684ea9c">$owner_id</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#aad0ef0cc05c407de84dbfbf2050bbbbe">$owner_nick</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a849c99cf0a7ad065d630c8a30106ad5e">$timezone</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#aa0b2a5fa9186d7dc0e637f1ecb379c42">getCurrentUser</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a6333c8ce58998bd11bf8102afe3b0748">getTimezone</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#abf6fe89b0a8239ed93c3b07e1fbce75b">log</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a2926fe923baade564f2663632fa8c633">setAuthenticated</a>($r)</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#adc72f36f0b2b17b20ea4df900afcd697">setBrowserPlugin</a>($browser)</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#aadce020fb595c7943829d7f995d3f998">setCurrentUser</a>($name)</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#af6d239fefed05859327ee8db626703f9">setTimezone</a>($timezone)</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a6ece02655b780469e59e204c5979a624">validateUserPass</a>($username, $password)</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html">RedMatrix\RedDAV\RedBasicAuth</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> +</table></div><!-- contents --> +</div><!-- doc-content --> + diff --git a/doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html b/doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html new file mode 100644 index 000000000..9cd342a8d --- /dev/null +++ b/doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html @@ -0,0 +1,519 @@ +<!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\RedBasicAuth 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_1RedBasicAuth.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="#pub-attribs">Public Attributes</a> | +<a href="#pro-methods">Protected Member Functions</a> | +<a href="#pro-attribs">Protected Attributes</a> | +<a href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">RedMatrix\RedDAV\RedBasicAuth Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Authentication backend class for <a class="el" href="namespaceRedMatrix_1_1RedDAV.html">RedDAV</a>. + <a href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#details">More...</a></p> +<div class="dynheader"> +Inheritance diagram for RedMatrix\RedDAV\RedBasicAuth:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.png" usemap="#RedMatrix\RedDAV\RedBasicAuth_map" alt=""/> + <map id="RedMatrix\RedDAV\RedBasicAuth_map" name="RedMatrix\RedDAV\RedBasicAuth_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:aadce020fb595c7943829d7f995d3f998"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#aadce020fb595c7943829d7f995d3f998">setCurrentUser</a> ($name)</td></tr> +<tr class="separator:aadce020fb595c7943829d7f995d3f998"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa0b2a5fa9186d7dc0e637f1ecb379c42"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#aa0b2a5fa9186d7dc0e637f1ecb379c42">getCurrentUser</a> ()</td></tr> +<tr class="separator:aa0b2a5fa9186d7dc0e637f1ecb379c42"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af6d239fefed05859327ee8db626703f9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#af6d239fefed05859327ee8db626703f9">setTimezone</a> ($timezone)</td></tr> +<tr class="memdesc:af6d239fefed05859327ee8db626703f9"><td class="mdescLeft"> </td><td class="mdescRight">Sets the timezone from the channel in <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html" title="Authentication backend class for RedDAV.">RedBasicAuth</a>. <a href="#af6d239fefed05859327ee8db626703f9">More...</a><br/></td></tr> +<tr class="separator:af6d239fefed05859327ee8db626703f9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6333c8ce58998bd11bf8102afe3b0748"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a6333c8ce58998bd11bf8102afe3b0748">getTimezone</a> ()</td></tr> +<tr class="memdesc:a6333c8ce58998bd11bf8102afe3b0748"><td class="mdescLeft"> </td><td class="mdescRight">Returns the timezone. <a href="#a6333c8ce58998bd11bf8102afe3b0748">More...</a><br/></td></tr> +<tr class="separator:a6333c8ce58998bd11bf8102afe3b0748"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adc72f36f0b2b17b20ea4df900afcd697"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#adc72f36f0b2b17b20ea4df900afcd697">setBrowserPlugin</a> ($browser)</td></tr> +<tr class="memdesc:adc72f36f0b2b17b20ea4df900afcd697"><td class="mdescLeft"> </td><td class="mdescRight">Set browser plugin for SabreDAV. <a href="#adc72f36f0b2b17b20ea4df900afcd697">More...</a><br/></td></tr> +<tr class="separator:adc72f36f0b2b17b20ea4df900afcd697"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abf6fe89b0a8239ed93c3b07e1fbce75b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#abf6fe89b0a8239ed93c3b07e1fbce75b">log</a> ()</td></tr> +<tr class="memdesc:abf6fe89b0a8239ed93c3b07e1fbce75b"><td class="mdescLeft"> </td><td class="mdescRight">Prints out all <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html" title="Authentication backend class for RedDAV.">RedBasicAuth</a> variables to <a class="el" href="text_8php.html#a030fa5ecc64168af0c4f44897a9bce63">logger()</a>. <a href="#abf6fe89b0a8239ed93c3b07e1fbce75b">More...</a><br/></td></tr> +<tr class="separator:abf6fe89b0a8239ed93c3b07e1fbce75b"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:abe1defedb90ac8e3b6487e124e625521"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#abe1defedb90ac8e3b6487e124e625521">$channel_id</a> = 0</td></tr> +<tr class="separator:abe1defedb90ac8e3b6487e124e625521"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a112ad78a863dc0e598b5f02c596798c0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a112ad78a863dc0e598b5f02c596798c0">$channel_hash</a> = ''</td></tr> +<tr class="separator:a112ad78a863dc0e598b5f02c596798c0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a605aa09565a097316b80f0d17d6b5823"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a605aa09565a097316b80f0d17d6b5823">$observer</a> = ''</td></tr> +<tr class="separator:a605aa09565a097316b80f0d17d6b5823"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a167ae032bd2ad8e6caa2e1e1a6f1b5d3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a167ae032bd2ad8e6caa2e1e1a6f1b5d3">$browser</a></td></tr> +<tr class="separator:a167ae032bd2ad8e6caa2e1e1a6f1b5d3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1a23c349cc4699a8474505972684ea9c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a1a23c349cc4699a8474505972684ea9c">$owner_id</a> = 0</td></tr> +<tr class="separator:a1a23c349cc4699a8474505972684ea9c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aad0ef0cc05c407de84dbfbf2050bbbbe"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#aad0ef0cc05c407de84dbfbf2050bbbbe">$owner_nick</a> = ''</td></tr> +<tr class="separator:aad0ef0cc05c407de84dbfbf2050bbbbe"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> +Protected Member Functions</h2></td></tr> +<tr class="memitem:a6ece02655b780469e59e204c5979a624"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a6ece02655b780469e59e204c5979a624">validateUserPass</a> ($username, $password)</td></tr> +<tr class="memdesc:a6ece02655b780469e59e204c5979a624"><td class="mdescLeft"> </td><td class="mdescRight">Validates a username and password. <a href="#a6ece02655b780469e59e204c5979a624">More...</a><br/></td></tr> +<tr class="separator:a6ece02655b780469e59e204c5979a624"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2926fe923baade564f2663632fa8c633"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a2926fe923baade564f2663632fa8c633">setAuthenticated</a> ($r)</td></tr> +<tr class="memdesc:a2926fe923baade564f2663632fa8c633"><td class="mdescLeft"> </td><td class="mdescRight">Sets variables and session parameters after successfull authentication. <a href="#a2926fe923baade564f2663632fa8c633">More...</a><br/></td></tr> +<tr class="separator:a2926fe923baade564f2663632fa8c633"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> +Protected Attributes</h2></td></tr> +<tr class="memitem:a76fdb7fd5dd7376155abb5a58cd6fd69"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a76fdb7fd5dd7376155abb5a58cd6fd69">$channel_name</a> = null</td></tr> +<tr class="separator:a76fdb7fd5dd7376155abb5a58cd6fd69"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a849c99cf0a7ad065d630c8a30106ad5e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a849c99cf0a7ad065d630c8a30106ad5e">$timezone</a> = ''</td></tr> +<tr class="separator:a849c99cf0a7ad065d630c8a30106ad5e"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Authentication backend class for <a class="el" href="namespaceRedMatrix_1_1RedDAV.html">RedDAV</a>. </p> +<p>This class also contains some data which is not necessary for authentication like timezone settings.</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">Member Function Documentation</h2> +<a class="anchor" id="aa0b2a5fa9186d7dc0e637f1ecb379c42"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::getCurrentUser </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Returns information about the currently logged-in channel.</p> +<p>If nobody is currently logged in, this method should return null.</p> +<dl class="section see"><dt>See Also</dt><dd>::getCurrentUser </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>string|null </dd></dl> + +</div> +</div> +<a class="anchor" id="a6333c8ce58998bd11bf8102afe3b0748"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::getTimezone </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns the timezone. </p> +<dl class="section return"><dt>Returns</dt><dd>string Return the channel's timezone. </dd></dl> + +</div> +</div> +<a class="anchor" id="abf6fe89b0a8239ed93c3b07e1fbce75b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::log </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Prints out all <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html" title="Authentication backend class for RedDAV.">RedBasicAuth</a> variables to <a class="el" href="text_8php.html#a030fa5ecc64168af0c4f44897a9bce63">logger()</a>. </p> +<dl class="section return"><dt>Returns</dt><dd>void </dd></dl> + +</div> +</div> +<a class="anchor" id="a2926fe923baade564f2663632fa8c633"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::setAuthenticated </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$r</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Sets variables and session parameters after successfull authentication. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">array</td><td class="paramname">$r</td><td>Array with the values for the authenticated channel. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl> + +<p>Referenced by <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a6ece02655b780469e59e204c5979a624">RedMatrix\RedDAV\RedBasicAuth\validateUserPass()</a>.</p> + +</div> +</div> +<a class="anchor" id="adc72f36f0b2b17b20ea4df900afcd697"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::setBrowserPlugin </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$browser</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Set browser plugin for SabreDAV. </p> +<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBrowser.html#aa1607857cb59738c4dce2fe8e73d8f19">RedBrowser::set_writeable()</a> </dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">\Sabre\DAV\Browser\Plugin</td><td class="paramname">$browser</td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="aadce020fb595c7943829d7f995d3f998"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::setCurrentUser </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>Sets the channel_name from the currently logged-in channel.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">string</td><td class="paramname">$name</td><td>The channel's name </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="af6d239fefed05859327ee8db626703f9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::setTimezone </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$timezone</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Sets the timezone from the channel in <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html" title="Authentication backend class for RedDAV.">RedBasicAuth</a>. </p> +<p>Set in <a class="el" href="cloud_8php.html" title="Initialize RedMatrix's cloud (SabreDAV).">mod/cloud.php</a> if the channel has a timezone set.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">string</td><td class="paramname">$timezone</td><td>The channel's timezone. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>void </dd></dl> + +</div> +</div> +<a class="anchor" id="a6ece02655b780469e59e204c5979a624"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::validateUserPass </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$username</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$password</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Validates a username and password. </p> +<p>Guest access is granted with the password "+++".</p> +<dl class="section see"><dt>See Also</dt><dd>::validateUserPass </dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">string</td><td class="paramname">$username</td><td></td></tr> + <tr><td class="paramtype">string</td><td class="paramname">$password</td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a class="anchor" id="a167ae032bd2ad8e6caa2e1e1a6f1b5d3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::$browser</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Referenced by <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#adc72f36f0b2b17b20ea4df900afcd697">RedMatrix\RedDAV\RedBasicAuth\setBrowserPlugin()</a>.</p> + +</div> +</div> +<a class="anchor" id="a112ad78a863dc0e598b5f02c596798c0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::$channel_hash = ''</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="abe1defedb90ac8e3b6487e124e625521"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::$channel_id = 0</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a76fdb7fd5dd7376155abb5a58cd6fd69"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::$channel_name = null</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Referenced by <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#aa0b2a5fa9186d7dc0e637f1ecb379c42">RedMatrix\RedDAV\RedBasicAuth\getCurrentUser()</a>.</p> + +</div> +</div> +<a class="anchor" id="a605aa09565a097316b80f0d17d6b5823"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::$observer = ''</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a1a23c349cc4699a8474505972684ea9c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::$owner_id = 0</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="aad0ef0cc05c407de84dbfbf2050bbbbe"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::$owner_nick = ''</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a849c99cf0a7ad065d630c8a30106ad5e"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedBasicAuth::$timezone = ''</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Referenced by <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a6333c8ce58998bd11bf8102afe3b0748">RedMatrix\RedDAV\RedBasicAuth\getTimezone()</a>, and <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#af6d239fefed05859327ee8db626703f9">RedMatrix\RedDAV\RedBasicAuth\setTimezone()</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/RedDAV/<a class="el" href="RedBasicAuth_8php.html">RedBasicAuth.php</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> + diff --git a/doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth.js b/doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth.js new file mode 100644 index 000000000..b48393cea --- /dev/null +++ b/doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth.js @@ -0,0 +1,19 @@ +var classRedMatrix_1_1RedDAV_1_1RedBasicAuth = +[ + [ "getCurrentUser", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#aa0b2a5fa9186d7dc0e637f1ecb379c42", null ], + [ "getTimezone", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a6333c8ce58998bd11bf8102afe3b0748", null ], + [ "log", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#abf6fe89b0a8239ed93c3b07e1fbce75b", null ], + [ "setAuthenticated", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a2926fe923baade564f2663632fa8c633", null ], + [ "setBrowserPlugin", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#adc72f36f0b2b17b20ea4df900afcd697", null ], + [ "setCurrentUser", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#aadce020fb595c7943829d7f995d3f998", null ], + [ "setTimezone", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#af6d239fefed05859327ee8db626703f9", null ], + [ "validateUserPass", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a6ece02655b780469e59e204c5979a624", null ], + [ "$browser", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a167ae032bd2ad8e6caa2e1e1a6f1b5d3", null ], + [ "$channel_hash", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a112ad78a863dc0e598b5f02c596798c0", null ], + [ "$channel_id", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#abe1defedb90ac8e3b6487e124e625521", null ], + [ "$channel_name", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a76fdb7fd5dd7376155abb5a58cd6fd69", null ], + [ "$observer", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a605aa09565a097316b80f0d17d6b5823", null ], + [ "$owner_id", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a1a23c349cc4699a8474505972684ea9c", null ], + [ "$owner_nick", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#aad0ef0cc05c407de84dbfbf2050bbbbe", null ], + [ "$timezone", "classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html#a849c99cf0a7ad065d630c8a30106ad5e", null ] +];
\ No newline at end of file diff --git a/doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth.png b/doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth.png Binary files differnew file mode 100644 index 000000000..f361b604b --- /dev/null +++ b/doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth.png diff --git a/doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory-members.html b/doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory-members.html new file mode 100644 index 000000000..b6cf43ad2 --- /dev/null +++ b/doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory-members.html @@ -0,0 +1,135 @@ +<!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: Member List</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="headertitle"> +<div class="title">RedMatrix\RedDAV\RedDirectory Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#aab6907e7fb7f9f7227f9cd42bdc84eb9">$auth</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"><span class="mlabel">private</span></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#adf8735b3118cdf2f42416edaf42b82e9">$ext_path</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"><span class="mlabel">private</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a2fc4e6b9be2108bbaa1ca1a03fd6d44e">$folder_hash</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"><span class="mlabel">private</span></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a17ea47e34cb76b6e79f36ebed790d76a">$os_path</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"><span class="mlabel">private</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a4bba2e56bc8ec3e05f05eae46f56f36d">$red_path</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"><span class="mlabel">private</span></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a438066fb1565fbcffa22c12d5ce23695">$root_dir</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"><span class="mlabel">private</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a76b58fe5223e565c97f1b9af93031a99">__construct</a>($ext_path, &$auth_plugin)</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a964b13fde1a5da6f76b51ca5519234dc">childExists</a>($name)</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#aca0e8d574ea66a0e210f571700663c62">createDirectory</a>($name)</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a58e750256cdc2f0f79fbe8d5463ffefe">createFile</a>($name, $data=null)</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a1a37850bdd1f188abd6160559698d5d7">getChild</a>($name)</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a9b9a0b5bfa4de1f78e6cafaa534b6f6a">getChildren</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a825dc5f3e0f83f50736c16daa6a4809d">getDir</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a69db5f641f8f5dc999e55cee1832ecd5">getLastModified</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a55f7172814a0749b5342f152ab3fa0df">getName</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a69db443ed3c84938b4352fe515bf8d68">getQuotaInfo</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#af90a1a74cfd643a5c56b9a17ea250d59">log</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"><span class="mlabel">private</span></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a14ac61d31a031d139956763db4e03956">setName</a>($name)</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedDirectory.html">RedMatrix\RedDAV\RedDirectory</a></td><td class="entry"></td></tr> +</table></div><!-- contents --> +</div><!-- doc-content --> + diff --git a/doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory.html b/doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory.html new file mode 100644 index 000000000..5f07edc7d --- /dev/null +++ b/doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory.html @@ -0,0 +1,642 @@ +<!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 --> + diff --git a/doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory.js b/doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory.js new file mode 100644 index 000000000..bbb92425f --- /dev/null +++ b/doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory.js @@ -0,0 +1,21 @@ +var classRedMatrix_1_1RedDAV_1_1RedDirectory = +[ + [ "__construct", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a76b58fe5223e565c97f1b9af93031a99", null ], + [ "childExists", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a964b13fde1a5da6f76b51ca5519234dc", null ], + [ "createDirectory", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#aca0e8d574ea66a0e210f571700663c62", null ], + [ "createFile", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a58e750256cdc2f0f79fbe8d5463ffefe", null ], + [ "getChild", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a1a37850bdd1f188abd6160559698d5d7", null ], + [ "getChildren", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a9b9a0b5bfa4de1f78e6cafaa534b6f6a", null ], + [ "getDir", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a825dc5f3e0f83f50736c16daa6a4809d", null ], + [ "getLastModified", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a69db5f641f8f5dc999e55cee1832ecd5", null ], + [ "getName", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a55f7172814a0749b5342f152ab3fa0df", null ], + [ "getQuotaInfo", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a69db443ed3c84938b4352fe515bf8d68", null ], + [ "log", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#af90a1a74cfd643a5c56b9a17ea250d59", null ], + [ "setName", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a14ac61d31a031d139956763db4e03956", null ], + [ "$auth", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#aab6907e7fb7f9f7227f9cd42bdc84eb9", null ], + [ "$ext_path", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#adf8735b3118cdf2f42416edaf42b82e9", null ], + [ "$folder_hash", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a2fc4e6b9be2108bbaa1ca1a03fd6d44e", null ], + [ "$os_path", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a17ea47e34cb76b6e79f36ebed790d76a", null ], + [ "$red_path", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a4bba2e56bc8ec3e05f05eae46f56f36d", null ], + [ "$root_dir", "classRedMatrix_1_1RedDAV_1_1RedDirectory.html#a438066fb1565fbcffa22c12d5ce23695", null ] +];
\ No newline at end of file diff --git a/doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory.png b/doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory.png Binary files differnew file mode 100644 index 000000000..e3eeebb23 --- /dev/null +++ b/doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory.png diff --git a/doc/html/classRedMatrix_1_1RedDAV_1_1RedFile-members.html b/doc/html/classRedMatrix_1_1RedDAV_1_1RedFile-members.html new file mode 100644 index 000000000..2206f8cbf --- /dev/null +++ b/doc/html/classRedMatrix_1_1RedDAV_1_1RedFile-members.html @@ -0,0 +1,130 @@ +<!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: Member List</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_1RedFile.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="headertitle"> +<div class="title">RedMatrix\RedDAV\RedFile Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html">RedMatrix\RedDAV\RedFile</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a21b6e9d420c352f25610a33f57858215">$auth</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html">RedMatrix\RedDAV\RedFile</a></td><td class="entry"><span class="mlabel">private</span></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a235700e2dfbe21dc41613d36e30e8acc">$data</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html">RedMatrix\RedDAV\RedFile</a></td><td class="entry"><span class="mlabel">private</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#ab722dcb8c4598426c81fa2b2e4fad5f2">$name</a></td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html">RedMatrix\RedDAV\RedFile</a></td><td class="entry"><span class="mlabel">private</span></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a05798eac84c578152ff21758261c6ac6">__construct</a>($name, $data, &$auth)</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html">RedMatrix\RedDAV\RedFile</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#ab7ab7ba81fab28eb02382cfdfd80ecfe">delete</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html">RedMatrix\RedDAV\RedFile</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a7241beecd01f5bb4e74659863dd85bd8">get</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html">RedMatrix\RedDAV\RedFile</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#af5c88b75d0c1f590af03755534cb167e">getContentType</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html">RedMatrix\RedDAV\RedFile</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a9f14682acf3ccb70df5af5dd0687c689">getETag</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html">RedMatrix\RedDAV\RedFile</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#ac47016aa0e3f6f1a1c4570bd6fd8cf25">getLastModified</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html">RedMatrix\RedDAV\RedFile</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#ac945aa782d6c035d339e59974266ec4d">getName</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html">RedMatrix\RedDAV\RedFile</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a07e1b19e7aaf3dcce822e9be8823a87d">getSize</a>()</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html">RedMatrix\RedDAV\RedFile</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a709ec1288d21ddf1353524435ab916f0">put</a>($data)</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html">RedMatrix\RedDAV\RedFile</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a0350cb4e0327e1f9922869a48ee04f1d">setName</a>($newName)</td><td class="entry"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html">RedMatrix\RedDAV\RedFile</a></td><td class="entry"></td></tr> +</table></div><!-- contents --> +</div><!-- doc-content --> + diff --git a/doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.html b/doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.html new file mode 100644 index 000000000..1f48aa7b7 --- /dev/null +++ b/doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.html @@ -0,0 +1,479 @@ +<!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\RedFile 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_1RedFile.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-attribs">Private Attributes</a> | +<a href="classRedMatrix_1_1RedDAV_1_1RedFile-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">RedMatrix\RedDAV\RedFile Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This class represents a file in DAV. + <a href="classRedMatrix_1_1RedDAV_1_1RedFile.html#details">More...</a></p> +<div class="dynheader"> +Inheritance diagram for RedMatrix\RedDAV\RedFile:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classRedMatrix_1_1RedDAV_1_1RedFile.png" usemap="#RedMatrix\RedDAV\RedFile_map" alt=""/> + <map id="RedMatrix\RedDAV\RedFile_map" name="RedMatrix\RedDAV\RedFile_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:a05798eac84c578152ff21758261c6ac6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a05798eac84c578152ff21758261c6ac6">__construct</a> ($name, $data, &$auth)</td></tr> +<tr class="separator:a05798eac84c578152ff21758261c6ac6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac945aa782d6c035d339e59974266ec4d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#ac945aa782d6c035d339e59974266ec4d">getName</a> ()</td></tr> +<tr class="memdesc:ac945aa782d6c035d339e59974266ec4d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the file. <a href="#ac945aa782d6c035d339e59974266ec4d">More...</a><br/></td></tr> +<tr class="separator:ac945aa782d6c035d339e59974266ec4d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0350cb4e0327e1f9922869a48ee04f1d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a0350cb4e0327e1f9922869a48ee04f1d">setName</a> ($newName)</td></tr> +<tr class="memdesc:a0350cb4e0327e1f9922869a48ee04f1d"><td class="mdescLeft"> </td><td class="mdescRight">Renames the file. <a href="#a0350cb4e0327e1f9922869a48ee04f1d">More...</a><br/></td></tr> +<tr class="separator:a0350cb4e0327e1f9922869a48ee04f1d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a709ec1288d21ddf1353524435ab916f0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a709ec1288d21ddf1353524435ab916f0">put</a> ($data)</td></tr> +<tr class="memdesc:a709ec1288d21ddf1353524435ab916f0"><td class="mdescLeft"> </td><td class="mdescRight">Updates the data of the file. <a href="#a709ec1288d21ddf1353524435ab916f0">More...</a><br/></td></tr> +<tr class="separator:a709ec1288d21ddf1353524435ab916f0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7241beecd01f5bb4e74659863dd85bd8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a7241beecd01f5bb4e74659863dd85bd8">get</a> ()</td></tr> +<tr class="memdesc:a7241beecd01f5bb4e74659863dd85bd8"><td class="mdescLeft"> </td><td class="mdescRight">Returns the raw data. <a href="#a7241beecd01f5bb4e74659863dd85bd8">More...</a><br/></td></tr> +<tr class="separator:a7241beecd01f5bb4e74659863dd85bd8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9f14682acf3ccb70df5af5dd0687c689"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a9f14682acf3ccb70df5af5dd0687c689">getETag</a> ()</td></tr> +<tr class="memdesc:a9f14682acf3ccb70df5af5dd0687c689"><td class="mdescLeft"> </td><td class="mdescRight">Returns the ETag for a file. <a href="#a9f14682acf3ccb70df5af5dd0687c689">More...</a><br/></td></tr> +<tr class="separator:a9f14682acf3ccb70df5af5dd0687c689"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af5c88b75d0c1f590af03755534cb167e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#af5c88b75d0c1f590af03755534cb167e">getContentType</a> ()</td></tr> +<tr class="memdesc:af5c88b75d0c1f590af03755534cb167e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the mime-type for a file. <a href="#af5c88b75d0c1f590af03755534cb167e">More...</a><br/></td></tr> +<tr class="separator:af5c88b75d0c1f590af03755534cb167e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a07e1b19e7aaf3dcce822e9be8823a87d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a07e1b19e7aaf3dcce822e9be8823a87d">getSize</a> ()</td></tr> +<tr class="memdesc:a07e1b19e7aaf3dcce822e9be8823a87d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the node, in bytes. <a href="#a07e1b19e7aaf3dcce822e9be8823a87d">More...</a><br/></td></tr> +<tr class="separator:a07e1b19e7aaf3dcce822e9be8823a87d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac47016aa0e3f6f1a1c4570bd6fd8cf25"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#ac47016aa0e3f6f1a1c4570bd6fd8cf25">getLastModified</a> ()</td></tr> +<tr class="memdesc:ac47016aa0e3f6f1a1c4570bd6fd8cf25"><td class="mdescLeft"> </td><td class="mdescRight">Returns the last modification time for the file, as a unix timestamp. <a href="#ac47016aa0e3f6f1a1c4570bd6fd8cf25">More...</a><br/></td></tr> +<tr class="separator:ac47016aa0e3f6f1a1c4570bd6fd8cf25"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab7ab7ba81fab28eb02382cfdfd80ecfe"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#ab7ab7ba81fab28eb02382cfdfd80ecfe">delete</a> ()</td></tr> +<tr class="memdesc:ab7ab7ba81fab28eb02382cfdfd80ecfe"><td class="mdescLeft"> </td><td class="mdescRight">Delete the file. <a href="#ab7ab7ba81fab28eb02382cfdfd80ecfe">More...</a><br/></td></tr> +<tr class="separator:ab7ab7ba81fab28eb02382cfdfd80ecfe"><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:a235700e2dfbe21dc41613d36e30e8acc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a235700e2dfbe21dc41613d36e30e8acc">$data</a></td></tr> +<tr class="separator:a235700e2dfbe21dc41613d36e30e8acc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a21b6e9d420c352f25610a33f57858215"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a21b6e9d420c352f25610a33f57858215">$auth</a></td></tr> +<tr class="separator:a21b6e9d420c352f25610a33f57858215"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab722dcb8c4598426c81fa2b2e4fad5f2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#ab722dcb8c4598426c81fa2b2e4fad5f2">$name</a></td></tr> +<tr class="separator:ab722dcb8c4598426c81fa2b2e4fad5f2"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>This class represents a file in DAV. </p> +<p>It provides all functions to work with files in Red's cloud through DAV protocol.</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="a05798eac84c578152ff21758261c6ac6"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedFile::__construct </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>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">& </td> + <td class="paramname"><em>$auth</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Sets up the node, expects a full path name.</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> + <tr><td class="paramtype">array</td><td class="paramname">$data</td><td>from attach table </td></tr> + <tr><td class="paramtype"></td><td class="paramname">&$auth</td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="ab7ab7ba81fab28eb02382cfdfd80ecfe"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedFile::delete </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Delete the file. </p> +<p>This method checks the permissions and then calls <a class="el" href="include_2attach_8php.html#a70bd666e080c2af5a91f5d14c297b8cd" title="Delete a file/directory from a channel.">attach_delete()</a> function to actually remove the file.</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> + +</div> +</div> +<a class="anchor" id="a7241beecd01f5bb4e74659863dd85bd8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedFile::get </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns the raw data. </p> +<dl class="section return"><dt>Returns</dt><dd>string </dd></dl> + +</div> +</div> +<a class="anchor" id="af5c88b75d0c1f590af03755534cb167e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedFile::getContentType </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns the mime-type for a file. </p> +<p>If null is returned, we'll assume application/octet-stream</p> +<dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl> + +</div> +</div> +<a class="anchor" id="a9f14682acf3ccb70df5af5dd0687c689"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedFile::getETag </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns the ETag for a file. </p> +<p>An ETag is a unique identifier representing the current version of the file. If the file changes, the ETag MUST change. The ETag is an arbitrary string, but MUST be surrounded by double-quotes.</p> +<p>Return null if the ETag can not effectively be determined.</p> +<dl class="section return"><dt>Returns</dt><dd>null|string </dd></dl> + +</div> +</div> +<a class="anchor" id="ac47016aa0e3f6f1a1c4570bd6fd8cf25"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedFile::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 file, as a unix timestamp. </p> +<dl class="section return"><dt>Returns</dt><dd>int last modification time in UNIX timestamp </dd></dl> + +</div> +</div> +<a class="anchor" id="ac945aa782d6c035d339e59974266ec4d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedFile::getName </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns the name of the file. </p> +<dl class="section return"><dt>Returns</dt><dd>string </dd></dl> + +</div> +</div> +<a class="anchor" id="a07e1b19e7aaf3dcce822e9be8823a87d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedFile::getSize </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns the size of the node, in bytes. </p> +<dl class="section return"><dt>Returns</dt><dd>int filesize in bytes </dd></dl> + +</div> +</div> +<a class="anchor" id="a709ec1288d21ddf1353524435ab916f0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedFile::put </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$data</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Updates the data of the file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">resource</td><td class="paramname">$data</td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>void </dd></dl> + +</div> +</div> +<a class="anchor" id="a0350cb4e0327e1f9922869a48ee04f1d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedFile::setName </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$newName</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Renames the file. </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>The new name of the file. </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="a21b6e9d420c352f25610a33f57858215"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedFile::$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"> + +<p>Referenced by <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a05798eac84c578152ff21758261c6ac6">RedMatrix\RedDAV\RedFile\__construct()</a>.</p> + +</div> +</div> +<a class="anchor" id="a235700e2dfbe21dc41613d36e30e8acc"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedFile::$data</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_1RedFile.html#a05798eac84c578152ff21758261c6ac6">RedMatrix\RedDAV\RedFile\__construct()</a>, and <a class="el" href="classRedMatrix_1_1RedDAV_1_1RedFile.html#a709ec1288d21ddf1353524435ab916f0">RedMatrix\RedDAV\RedFile\put()</a>.</p> + +</div> +</div> +<a class="anchor" id="ab722dcb8c4598426c81fa2b2e4fad5f2"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">RedMatrix\RedDAV\RedFile::$name</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_1RedFile.html#a05798eac84c578152ff21758261c6ac6">RedMatrix\RedDAV\RedFile\__construct()</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/RedDAV/<a class="el" href="RedFile_8php.html">RedFile.php</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> + diff --git a/doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.js b/doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.js new file mode 100644 index 000000000..c65382641 --- /dev/null +++ b/doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.js @@ -0,0 +1,16 @@ +var classRedMatrix_1_1RedDAV_1_1RedFile = +[ + [ "__construct", "classRedMatrix_1_1RedDAV_1_1RedFile.html#a05798eac84c578152ff21758261c6ac6", null ], + [ "delete", "classRedMatrix_1_1RedDAV_1_1RedFile.html#ab7ab7ba81fab28eb02382cfdfd80ecfe", null ], + [ "get", "classRedMatrix_1_1RedDAV_1_1RedFile.html#a7241beecd01f5bb4e74659863dd85bd8", null ], + [ "getContentType", "classRedMatrix_1_1RedDAV_1_1RedFile.html#af5c88b75d0c1f590af03755534cb167e", null ], + [ "getETag", "classRedMatrix_1_1RedDAV_1_1RedFile.html#a9f14682acf3ccb70df5af5dd0687c689", null ], + [ "getLastModified", "classRedMatrix_1_1RedDAV_1_1RedFile.html#ac47016aa0e3f6f1a1c4570bd6fd8cf25", null ], + [ "getName", "classRedMatrix_1_1RedDAV_1_1RedFile.html#ac945aa782d6c035d339e59974266ec4d", null ], + [ "getSize", "classRedMatrix_1_1RedDAV_1_1RedFile.html#a07e1b19e7aaf3dcce822e9be8823a87d", null ], + [ "put", "classRedMatrix_1_1RedDAV_1_1RedFile.html#a709ec1288d21ddf1353524435ab916f0", null ], + [ "setName", "classRedMatrix_1_1RedDAV_1_1RedFile.html#a0350cb4e0327e1f9922869a48ee04f1d", null ], + [ "$auth", "classRedMatrix_1_1RedDAV_1_1RedFile.html#a21b6e9d420c352f25610a33f57858215", null ], + [ "$data", "classRedMatrix_1_1RedDAV_1_1RedFile.html#a235700e2dfbe21dc41613d36e30e8acc", null ], + [ "$name", "classRedMatrix_1_1RedDAV_1_1RedFile.html#ab722dcb8c4598426c81fa2b2e4fad5f2", null ] +];
\ No newline at end of file diff --git a/doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.png b/doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.png Binary files differnew file mode 100644 index 000000000..9a1837e1c --- /dev/null +++ b/doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.png diff --git a/doc/html/dimport_8php.html b/doc/html/dimport_8php.html new file mode 100644 index 000000000..925e95097 --- /dev/null +++ b/doc/html/dimport_8php.html @@ -0,0 +1,136 @@ +<!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: include/dimport.php File 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><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><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="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File 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('dimport_8php.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="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">dimport.php File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a581f040717941ce3e1868b0b5dceefd1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="dimport_8php.html#a581f040717941ce3e1868b0b5dceefd1">foofoo</a> ()</td></tr> +<tr class="separator:a581f040717941ce3e1868b0b5dceefd1"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="a581f040717941ce3e1868b0b5dceefd1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">foofoo </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> + diff --git a/doc/html/dimport_8php.js b/doc/html/dimport_8php.js new file mode 100644 index 000000000..1f463fb3d --- /dev/null +++ b/doc/html/dimport_8php.js @@ -0,0 +1,4 @@ +var dimport_8php = +[ + [ "foofoo", "dimport_8php.html#a581f040717941ce3e1868b0b5dceefd1", null ] +];
\ No newline at end of file diff --git a/doc/html/locs_8php.html b/doc/html/locs_8php.html new file mode 100644 index 000000000..86cc0d2a8 --- /dev/null +++ b/doc/html/locs_8php.html @@ -0,0 +1,167 @@ +<!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: mod/locs.php File 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><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><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="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File 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('locs_8php.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="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">locs.php File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a6b43654592919ac863d67a1f787a69b9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="locs_8php.html#a6b43654592919ac863d67a1f787a69b9">locs_post</a> (&$a)</td></tr> +<tr class="separator:a6b43654592919ac863d67a1f787a69b9"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="a6b43654592919ac863d67a1f787a69b9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">locs_post </td> + <td>(</td> + <td class="paramtype">& </td> + <td class="paramname"><em>$a</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Placeholder file at present. This is going to involve a bit of work.</p> +<p>This file will deal with the deletion of channels and management of hublocs.</p> +<p>We need to provide the following functionality:</p> +<ul> +<li>Delete my account and all channels from the entire network</li> +</ul> +<ul> +<li>Delete my account and all channels from this server</li> +</ul> +<ul> +<li>Delete a channel from the entire network</li> +</ul> +<ul> +<li>Delete a channel from this server</li> +</ul> +<ul> +<li>List all hub locations for this channel</li> +</ul> +<ul> +<li>Remove this/some hub location from this channel</li> +</ul> +<ul> +<li>promote this/some hub location to primary</li> +</ul> +<ul> +<li>Remove hub location 'xyz' from this channel, (this should possibly only be allowed if that hub has been down for a period of time)</li> +</ul> +<ul> +<li>Some of these actions should probably require email verification </li> +</ul> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> + diff --git a/doc/html/locs_8php.js b/doc/html/locs_8php.js new file mode 100644 index 000000000..475fc5dd6 --- /dev/null +++ b/doc/html/locs_8php.js @@ -0,0 +1,4 @@ +var locs_8php = +[ + [ "locs_post", "locs_8php.html#a6b43654592919ac863d67a1f787a69b9", null ] +];
\ No newline at end of file |
