From a22ec8cbfa5ec424cce751e194943328a16c1eec Mon Sep 17 00:00:00 2001 From: friendica Date: Fri, 4 Jul 2014 20:34:34 -0700 Subject: doc updates --- doc/html/classRedFile.html | 76 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 75 insertions(+), 1 deletion(-) (limited to 'doc/html/classRedFile.html') 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  __construct ($name, $data, &$auth)    getName () + Returns the name of the file. More...
   setName ($newName) + Renames the file. More...
   put ($data) + Updates the data of the file. More...
   get () + Returns the raw data. More...
   getETag () + Returns the ETag for a file. More...
   getContentType () + Returns the mime-type for a file. More...
   getSize () + Returns the size of the node, in bytes. More...
   getLastModified () + Returns the last modification time for the file, as a unix timestamp. More...
   delete () + Delete the file. More...
 

@@ -154,7 +163,9 @@ Private Attributes

 $name
 
-

Constructor & Destructor Documentation

+

Detailed Description

+

RedFile class.

+

Constructor & Destructor Documentation

@@ -184,6 +195,15 @@ Private Attributes
+

Sets up the node, expects a full path name.

+
Parameters
+ + + + +
string$name
array$datafrom attach table
&$auth
+
+
@@ -201,6 +221,15 @@ Private Attributes
+

Delete the file.

+
Exceptions
+ + +
DAV\Exception\Forbidden
+
+
+
Returns
void
+
@@ -216,6 +245,9 @@ Private Attributes
+

Returns the raw data.

+
Returns
string
+
@@ -231,6 +263,10 @@ Private Attributes
+

Returns the mime-type for a file.

+

If null is returned, we'll assume application/octet-stream

+
Returns
mixed
+
@@ -246,6 +282,11 @@ Private Attributes
+

Returns the ETag for a file.

+

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.

+

Return null if the ETag can not effectively be determined.

+
Returns
mixed
+
@@ -261,6 +302,9 @@ Private Attributes
+

Returns the last modification time for the file, as a unix timestamp.

+
Returns
int last modification time in UNIX timestamp
+
@@ -276,6 +320,9 @@ Private Attributes
+

Returns the name of the file.

+
Returns
string
+
@@ -291,6 +338,9 @@ Private Attributes
+

Returns the size of the node, in bytes.

+
Returns
int
+
@@ -307,6 +357,15 @@ Private Attributes
+

Updates the data of the file.

+
Parameters
+ + +
resource$data
+
+
+
Returns
void
+
@@ -323,6 +382,21 @@ Private Attributes
+

Renames the file.

+
Exceptions
+ + +
DAV\Exception\Forbidden
+
+
+
Parameters
+ + +
string$nameThe new name of the file.
+
+
+
Returns
void
+

Member Data Documentation

-- cgit v1.2.3