diff options
Diffstat (limited to 'doc/html/classRedFile.html')
| -rw-r--r-- | doc/html/classRedFile.html | 76 |
1 files changed, 75 insertions, 1 deletions
diff --git a/doc/html/classRedFile.html b/doc/html/classRedFile.html index c45b36c39..683dd1657 100644 --- a/doc/html/classRedFile.html +++ b/doc/html/classRedFile.html @@ -127,22 +127,31 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a9a67bdb34c9db6ce144b3f371148b183"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedFile.html#a9a67bdb34c9db6ce144b3f371148b183">__construct</a> ($name, $data, &$auth)</td></tr> <tr class="separator:a9a67bdb34c9db6ce144b3f371148b183"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0c961c5f49544d2502420361fa526437"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedFile.html#a0c961c5f49544d2502420361fa526437">getName</a> ()</td></tr> +<tr class="memdesc:a0c961c5f49544d2502420361fa526437"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the file. <a href="#a0c961c5f49544d2502420361fa526437">More...</a><br/></td></tr> <tr class="separator:a0c961c5f49544d2502420361fa526437"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a38a82bfc1b30028ea6ac75923e90fa25"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedFile.html#a38a82bfc1b30028ea6ac75923e90fa25">setName</a> ($newName)</td></tr> +<tr class="memdesc:a38a82bfc1b30028ea6ac75923e90fa25"><td class="mdescLeft"> </td><td class="mdescRight">Renames the file. <a href="#a38a82bfc1b30028ea6ac75923e90fa25">More...</a><br/></td></tr> <tr class="separator:a38a82bfc1b30028ea6ac75923e90fa25"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a41a49a583eb276b75626fcf97f4a699c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedFile.html#a41a49a583eb276b75626fcf97f4a699c">put</a> ($data)</td></tr> +<tr class="memdesc:a41a49a583eb276b75626fcf97f4a699c"><td class="mdescLeft"> </td><td class="mdescRight">Updates the data of the file. <a href="#a41a49a583eb276b75626fcf97f4a699c">More...</a><br/></td></tr> <tr class="separator:a41a49a583eb276b75626fcf97f4a699c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7c868dfcef6c70cd0e24cf3caa2c3535"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedFile.html#a7c868dfcef6c70cd0e24cf3caa2c3535">get</a> ()</td></tr> +<tr class="memdesc:a7c868dfcef6c70cd0e24cf3caa2c3535"><td class="mdescLeft"> </td><td class="mdescRight">Returns the raw data. <a href="#a7c868dfcef6c70cd0e24cf3caa2c3535">More...</a><br/></td></tr> <tr class="separator:a7c868dfcef6c70cd0e24cf3caa2c3535"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae96d5caa2db7a461c57b24380fa87e28"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedFile.html#ae96d5caa2db7a461c57b24380fa87e28">getETag</a> ()</td></tr> +<tr class="memdesc:ae96d5caa2db7a461c57b24380fa87e28"><td class="mdescLeft"> </td><td class="mdescRight">Returns the ETag for a file. <a href="#ae96d5caa2db7a461c57b24380fa87e28">More...</a><br/></td></tr> <tr class="separator:ae96d5caa2db7a461c57b24380fa87e28"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a26416827eb68554d033d1e2e5cc6dd3b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedFile.html#a26416827eb68554d033d1e2e5cc6dd3b">getContentType</a> ()</td></tr> +<tr class="memdesc:a26416827eb68554d033d1e2e5cc6dd3b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the mime-type for a file. <a href="#a26416827eb68554d033d1e2e5cc6dd3b">More...</a><br/></td></tr> <tr class="separator:a26416827eb68554d033d1e2e5cc6dd3b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acb1edbe1848fab05347746fa1ea09d8f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedFile.html#acb1edbe1848fab05347746fa1ea09d8f">getSize</a> ()</td></tr> +<tr class="memdesc:acb1edbe1848fab05347746fa1ea09d8f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the node, in bytes. <a href="#acb1edbe1848fab05347746fa1ea09d8f">More...</a><br/></td></tr> <tr class="separator:acb1edbe1848fab05347746fa1ea09d8f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a41562a28007789bbe7fe06d6a20eef47"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedFile.html#a41562a28007789bbe7fe06d6a20eef47">getLastModified</a> ()</td></tr> +<tr class="memdesc:a41562a28007789bbe7fe06d6a20eef47"><td class="mdescLeft"> </td><td class="mdescRight">Returns the last modification time for the file, as a unix timestamp. <a href="#a41562a28007789bbe7fe06d6a20eef47">More...</a><br/></td></tr> <tr class="separator:a41562a28007789bbe7fe06d6a20eef47"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aef71c9eaac7052be7dc8602eb12171e7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedFile.html#aef71c9eaac7052be7dc8602eb12171e7">delete</a> ()</td></tr> +<tr class="memdesc:aef71c9eaac7052be7dc8602eb12171e7"><td class="mdescLeft"> </td><td class="mdescRight">Delete the file. <a href="#aef71c9eaac7052be7dc8602eb12171e7">More...</a><br/></td></tr> <tr class="separator:aef71c9eaac7052be7dc8602eb12171e7"><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> @@ -154,7 +163,9 @@ Private Attributes</h2></td></tr> <tr class="memitem:acc48c05cd5a70951cb3c615ad84f03ba"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedFile.html#acc48c05cd5a70951cb3c615ad84f03ba">$name</a></td></tr> <tr class="separator:acc48c05cd5a70951cb3c615ad84f03ba"><td class="memSeparator" colspan="2"> </td></tr> </table> -<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p><a class="el" href="classRedFile.html">RedFile</a> class. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a9a67bdb34c9db6ce144b3f371148b183"></a> <div class="memitem"> <div class="memproto"> @@ -184,6 +195,15 @@ Private Attributes</h2></td></tr> </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> @@ -201,6 +221,15 @@ Private Attributes</h2></td></tr> </table> </div><div class="memdoc"> +<p>Delete the file. </p> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">DAV\Exception\Forbidden</td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>void </dd></dl> + </div> </div> <a class="anchor" id="a7c868dfcef6c70cd0e24cf3caa2c3535"></a> @@ -216,6 +245,9 @@ Private Attributes</h2></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="a26416827eb68554d033d1e2e5cc6dd3b"></a> @@ -231,6 +263,10 @@ Private Attributes</h2></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="ae96d5caa2db7a461c57b24380fa87e28"></a> @@ -246,6 +282,11 @@ Private Attributes</h2></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>mixed </dd></dl> + </div> </div> <a class="anchor" id="a41562a28007789bbe7fe06d6a20eef47"></a> @@ -261,6 +302,9 @@ Private Attributes</h2></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="a0c961c5f49544d2502420361fa526437"></a> @@ -276,6 +320,9 @@ Private Attributes</h2></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="acb1edbe1848fab05347746fa1ea09d8f"></a> @@ -291,6 +338,9 @@ Private Attributes</h2></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 </dd></dl> + </div> </div> <a class="anchor" id="a41a49a583eb276b75626fcf97f4a699c"></a> @@ -307,6 +357,15 @@ Private Attributes</h2></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="a38a82bfc1b30028ea6ac75923e90fa25"></a> @@ -323,6 +382,21 @@ Private Attributes</h2></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">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> |