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/classRedDirectory.html | 166 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 163 insertions(+), 3 deletions(-) (limited to 'doc/html/classRedDirectory.html') diff --git a/doc/html/classRedDirectory.html b/doc/html/classRedDirectory.html index 03de4b3ca..51064468b 100644 --- a/doc/html/classRedDirectory.html +++ b/doc/html/classRedDirectory.html @@ -107,12 +107,16 @@ $(document).ready(function(){initNavTree('classRedDirectory.html','');});
Public Member Functions | +Private Member Functions | Private Attributes | List of all members
RedDirectory Class Reference
+ +

RedDirectory class. + More...

Inheritance diagram for RedDirectory:
@@ -125,44 +129,65 @@ Inheritance diagram for RedDirectory:

Public Member Functions

 __construct ($ext_path, &$auth_plugin) + Sets up the directory node, expects a full path. More...
  - log () -   getChildren () + Returns an array with all the child nodes. More...
   getChild ($name) + Returns a child by name. More...
   getName () + Returns the name of the directory. More...
  + setName ($name) + Renames the directory. More...
+   createFile ($name, $data=null) + Creates a new file in the directory. More...
   createDirectory ($name) + Creates a new subdirectory. More...
   childExists ($name) + Checks if a child exists. More...
   getDir ()    getLastModified () + Returns the last modification time for the directory, as a UNIX timestamp. More...
   getQuotaInfo () + Return quota usage. More...
  + + + +

+Private Member Functions

 log ()
 
+ + +

Private Attributes

 $red_path
 The path inside /cloud. More...
 
 $folder_hash
 
 $ext_path
 The full path as seen in the browser. /cloud + $red_path. More...
 
 $root_dir = ''
 
 $auth
 
 $os_path = ''
 The real path on the filesystem. The actual path in store/ with the hashed names. More...
 
-

Constructor & Destructor Documentation

+

Detailed Description

+

RedDirectory class.

+

A class that represents a directory.

+

Constructor & Destructor Documentation

@@ -187,6 +212,15 @@ Private Attributes
+

Sets up the directory node, expects a full path.

+
Parameters
+ + + +
string$ext_patha full path
RedBasicAuth&$auth_plugin
+
+
+

Member Function Documentation

@@ -204,6 +238,15 @@ Private Attributes
+

Checks if a child exists.

+
Parameters
+ + +
string$name
+
+
+
Returns
boolean
+
@@ -220,6 +263,15 @@ Private Attributes
+

Creates a new subdirectory.

+
Parameters
+ + +
string$namethe directory to create
+
+
+
Returns
void
+
@@ -246,6 +298,24 @@ Private Attributes
+

Creates a new file in the directory.

+

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.

+

After successful creation of the file, you may choose to return the ETag of the new file here.

+
Exceptions
+ + +
DAV\Exception\Forbidden
+
+
+
Parameters
+ + + +
string$nameName of the file
resource | string$dataInitial payload
+
+
+
Returns
null|string ETag
+
@@ -262,6 +332,21 @@ Private Attributes
+

Returns a child by name.

+
Exceptions
+ + + +
DAV\Exception\Forbidden
DAV\Exception\NotFound
+
+
+
Parameters
+ + +
string$name
+
+
+
@@ -277,6 +362,15 @@ Private Attributes
+

Returns an array with all the child nodes.

+
Exceptions
+ + +
DAV\Exception\Forbidden
+
+
+
Returns
array DAV[]
+
@@ -291,6 +385,14 @@ Private Attributes
+
Todo:
add description of what this function does.
+
Exceptions
+ + +
DAV\Exception\NotFound
+
+
+
Returns
void

Referenced by __construct().

@@ -309,6 +411,10 @@ Private Attributes
+

Returns the last modification time for the directory, as a UNIX timestamp.

+

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.

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

Returns the name of the directory.

+
Returns
string
+
@@ -339,11 +448,18 @@ Private Attributes
+

Return quota usage.

+

Do guests relly see the used/free values from filesystem of the complete store directory?

+
Returns
array with used and free values in bytes.
+
+ + + + + +
@@ -352,10 +468,47 @@ Private Attributes
RedDirectory::log
+ 		+private

Referenced by getChildren().

+
+
+ +
+
+ + + + + + + + +
RedDirectory::setName ( $name)
+
+ +

Renames the directory.

+
Todo:
handle duplicate directory name
+
Exceptions
+ + +
DAV\Exception\Forbidden
+
+
+
Parameters
+ + +
string$nameThe new name of the directory.
+
+
+
Returns
void
+

Member Data Documentation

@@ -397,6 +550,9 @@ Private Attributes
+

The full path as seen in the browser. /cloud + $red_path.

+
Todo:
I think this is not used anywhere, we always strip '/cloud' and only use it in debug
+

Referenced by __construct(), and getDir().

@@ -439,6 +595,8 @@ Private Attributes
+

The real path on the filesystem. The actual path in store/ with the hashed names.

+

Referenced by createFile(), and getDir().

@@ -461,6 +619,8 @@ Private Attributes
+

The path inside /cloud.

+
-- cgit v1.2.3