From 88d63d1b779b5409b400d6635681b0f445849088 Mon Sep 17 00:00:00 2001 From: friendica Date: Sun, 19 Oct 2014 15:55:22 -0700 Subject: new doc added to doc checkin --- doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.html | 479 ++++++++++++++++++++++ 1 file changed, 479 insertions(+) create mode 100644 doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.html (limited to 'doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.html') 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 @@ + + + + + + +The Red Matrix: RedMatrix\RedDAV\RedFile Class Reference + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Matrix +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
+
RedMatrix\RedDAV\RedFile Class Reference
+
+
+ +

This class represents a file in DAV. + More...

+
+Inheritance diagram for RedMatrix\RedDAV\RedFile:
+
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+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...
 
+ + + + + + + +

+Private Attributes

 $data
 
 $auth
 
 $name
 
+

Detailed Description

+

This class represents a file in DAV.

+

It provides all functions to work with files in Red's cloud through DAV protocol.

+

http://opensource.org/licenses/mit-license.php The MIT License (MIT)

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
RedMatrix\RedDAV\RedFile::__construct ( $name,
 $data,
& $auth 
)
+
+

Sets up the node, expects a full path name.

+
Parameters
+ + + + +
string$name
array$datafrom attach table
&$auth
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + +
RedMatrix\RedDAV\RedFile::delete ()
+
+ +

Delete the file.

+

This method checks the permissions and then calls attach_delete() function to actually remove the file.

+
Exceptions
+ + +
\Sabre\DAV\Exception\Forbidden
+
+
+ +
+
+ +
+
+ + + + + + + +
RedMatrix\RedDAV\RedFile::get ()
+
+ +

Returns the raw data.

+
Returns
string
+ +
+
+ +
+
+ + + + + + + +
RedMatrix\RedDAV\RedFile::getContentType ()
+
+ +

Returns the mime-type for a file.

+

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

+
Returns
mixed
+ +
+
+ +
+
+ + + + + + + +
RedMatrix\RedDAV\RedFile::getETag ()
+
+ +

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
null|string
+ +
+
+ +
+
+ + + + + + + +
RedMatrix\RedDAV\RedFile::getLastModified ()
+
+ +

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

+
Returns
int last modification time in UNIX timestamp
+ +
+
+ +
+
+ + + + + + + +
RedMatrix\RedDAV\RedFile::getName ()
+
+ +

Returns the name of the file.

+
Returns
string
+ +
+
+ +
+
+ + + + + + + +
RedMatrix\RedDAV\RedFile::getSize ()
+
+ +

Returns the size of the node, in bytes.

+
Returns
int filesize in bytes
+ +
+
+ +
+
+ + + + + + + + +
RedMatrix\RedDAV\RedFile::put ( $data)
+
+ +

Updates the data of the file.

+
Parameters
+ + +
resource$data
+
+
+
Returns
void
+ +
+
+ +
+
+ + + + + + + + +
RedMatrix\RedDAV\RedFile::setName ( $newName)
+
+ +

Renames the file.

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

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
RedMatrix\RedDAV\RedFile::$auth
+ 		+private
+
+ +

Referenced by RedMatrix\RedDAV\RedFile\__construct().

+ +
+
+ +
+
+ + + + + +
+ + + + +
RedMatrix\RedDAV\RedFile::$data
+ 		+private
+
+ +

Referenced by RedMatrix\RedDAV\RedFile\__construct(), and RedMatrix\RedDAV\RedFile\put().

+ +
+
+ +
+
+ + + + + +
+ + + + +
RedMatrix\RedDAV\RedFile::$name
+ 		+private
+
+ +

Referenced by RedMatrix\RedDAV\RedFile\__construct().

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ -- cgit v1.2.3