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/RedBasicAuth_8php.html | 127 ++++ doc/html/RedDirectory_8php.html | 127 ++++ doc/html/RedFile_8php.html | 127 ++++ doc/html/chanman_8php.js | 4 + ...edMatrix_1_1RedDAV_1_1RedBasicAuth-members.html | 133 +++++ .../classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html | 519 +++++++++++++++++ .../classRedMatrix_1_1RedDAV_1_1RedBasicAuth.js | 19 + .../classRedMatrix_1_1RedDAV_1_1RedBasicAuth.png | Bin 0 -> 957 bytes ...edMatrix_1_1RedDAV_1_1RedDirectory-members.html | 135 +++++ .../classRedMatrix_1_1RedDAV_1_1RedDirectory.html | 642 +++++++++++++++++++++ .../classRedMatrix_1_1RedDAV_1_1RedDirectory.js | 21 + .../classRedMatrix_1_1RedDAV_1_1RedDirectory.png | Bin 0 -> 1601 bytes ...lassRedMatrix_1_1RedDAV_1_1RedFile-members.html | 130 +++++ doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.html | 479 +++++++++++++++ doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.js | 16 + doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.png | Bin 0 -> 1155 bytes doc/html/dimport_8php.html | 136 +++++ doc/html/dimport_8php.js | 4 + doc/html/locs_8php.html | 167 ++++++ doc/html/locs_8php.js | 4 + 20 files changed, 2790 insertions(+) create mode 100644 doc/html/RedBasicAuth_8php.html create mode 100644 doc/html/RedDirectory_8php.html create mode 100644 doc/html/RedFile_8php.html create mode 100644 doc/html/chanman_8php.js create mode 100644 doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth-members.html create mode 100644 doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth.html create mode 100644 doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth.js create mode 100644 doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth.png create mode 100644 doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory-members.html create mode 100644 doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory.html create mode 100644 doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory.js create mode 100644 doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory.png create mode 100644 doc/html/classRedMatrix_1_1RedDAV_1_1RedFile-members.html create mode 100644 doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.html create mode 100644 doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.js create mode 100644 doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.png create mode 100644 doc/html/dimport_8php.html create mode 100644 doc/html/dimport_8php.js create mode 100644 doc/html/locs_8php.html create mode 100644 doc/html/locs_8php.js (limited to 'doc/html') 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 @@ + + + + + + +The Red Matrix: include/RedDAV/RedBasicAuth.php File Reference + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Matrix +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Classes | +Namespaces
+
+
RedBasicAuth.php File Reference
+
+
+ + + + + +

+Classes

class  RedMatrix\RedDAV\RedBasicAuth
 Authentication backend class for RedDAV. More...
 
+ + + +

+Namespaces

namespace  RedMatrix\RedDAV
 
+
+
+ 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 @@ + + + + + + +The Red Matrix: include/RedDAV/RedDirectory.php File Reference + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Matrix +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Classes | +Namespaces
+
+
RedDirectory.php File Reference
+
+
+ + + + + +

+Classes

class  RedMatrix\RedDAV\RedDirectory
 RedDirectory class. More...
 
+ + + +

+Namespaces

namespace  RedMatrix\RedDAV
 
+
+
+ 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 @@ + + + + + + +The Red Matrix: include/RedDAV/RedFile.php File Reference + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Matrix +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Classes | +Namespaces
+
+
RedFile.php File Reference
+
+
+ + + + + +

+Classes

class  RedMatrix\RedDAV\RedFile
 This class represents a file in DAV. More...
 
+ + + +

+Namespaces

namespace  RedMatrix\RedDAV
 
+
+
+ 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 @@ + + + + + + +The Red Matrix: Member List + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Matrix +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+
RedMatrix\RedDAV\RedBasicAuth Member List
+
+
+ +

This is the complete list of members for RedMatrix\RedDAV\RedBasicAuth, including all inherited members.

+ + + + + + + + + + + + + + + + + +
$browserRedMatrix\RedDAV\RedBasicAuth
$channel_hashRedMatrix\RedDAV\RedBasicAuth
$channel_idRedMatrix\RedDAV\RedBasicAuth
$channel_nameRedMatrix\RedDAV\RedBasicAuthprotected
$observerRedMatrix\RedDAV\RedBasicAuth
$owner_idRedMatrix\RedDAV\RedBasicAuth
$owner_nickRedMatrix\RedDAV\RedBasicAuth
$timezoneRedMatrix\RedDAV\RedBasicAuthprotected
getCurrentUser()RedMatrix\RedDAV\RedBasicAuth
getTimezone()RedMatrix\RedDAV\RedBasicAuth
log()RedMatrix\RedDAV\RedBasicAuth
setAuthenticated($r)RedMatrix\RedDAV\RedBasicAuthprotected
setBrowserPlugin($browser)RedMatrix\RedDAV\RedBasicAuth
setCurrentUser($name)RedMatrix\RedDAV\RedBasicAuth
setTimezone($timezone)RedMatrix\RedDAV\RedBasicAuth
validateUserPass($username, $password)RedMatrix\RedDAV\RedBasicAuthprotected
+
+ 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 @@ + + + + + + +The Red Matrix: RedMatrix\RedDAV\RedBasicAuth Class Reference + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Matrix +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Member Functions | +Public Attributes | +Protected Member Functions | +Protected Attributes | +List of all members
+
+
RedMatrix\RedDAV\RedBasicAuth Class Reference
+
+
+ +

Authentication backend class for RedDAV. + More...

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

+Public Member Functions

 setCurrentUser ($name)
 
 getCurrentUser ()
 
 setTimezone ($timezone)
 Sets the timezone from the channel in RedBasicAuth. More...
 
 getTimezone ()
 Returns the timezone. More...
 
 setBrowserPlugin ($browser)
 Set browser plugin for SabreDAV. More...
 
 log ()
 Prints out all RedBasicAuth variables to logger(). More...
 
+ + + + + + + + + + + + + +

+Public Attributes

 $channel_id = 0
 
 $channel_hash = ''
 
 $observer = ''
 
 $browser
 
 $owner_id = 0
 
 $owner_nick = ''
 
+ + + + + + + +

+Protected Member Functions

 validateUserPass ($username, $password)
 Validates a username and password. More...
 
 setAuthenticated ($r)
 Sets variables and session parameters after successfull authentication. More...
 
+ + + + + +

+Protected Attributes

 $channel_name = null
 
 $timezone = ''
 
+

Detailed Description

+

Authentication backend class for RedDAV.

+

This class also contains some data which is not necessary for authentication like timezone settings.

+

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

+

Member Function Documentation

+ +
+
+ + + + + + + +
RedMatrix\RedDAV\RedBasicAuth::getCurrentUser ()
+
+

Returns information about the currently logged-in channel.

+

If nobody is currently logged in, this method should return null.

+
See Also
::getCurrentUser
+
Returns
string|null
+ +
+
+ +
+
+ + + + + + + +
RedMatrix\RedDAV\RedBasicAuth::getTimezone ()
+
+ +

Returns the timezone.

+
Returns
string Return the channel's timezone.
+ +
+
+ +
+
+ + + + + + + +
RedMatrix\RedDAV\RedBasicAuth::log ()
+
+ +

Prints out all RedBasicAuth variables to logger().

+
Returns
void
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
RedMatrix\RedDAV\RedBasicAuth::setAuthenticated ( $r)
+ 		+protected
+
+ +

Sets variables and session parameters after successfull authentication.

+
Parameters
+ + +
array$rArray with the values for the authenticated channel.
+
+
+
Returns
bool
+ +

Referenced by RedMatrix\RedDAV\RedBasicAuth\validateUserPass().

+ +
+
+ +
+
+ + + + + + + + +
RedMatrix\RedDAV\RedBasicAuth::setBrowserPlugin ( $browser)
+
+ +

Set browser plugin for SabreDAV.

+
See Also
RedBrowser::set_writeable()
+
Parameters
+ + +
\Sabre\DAV\Browser\Plugin$browser
+
+
+ +
+
+ +
+
+ + + + + + + + +
RedMatrix\RedDAV\RedBasicAuth::setCurrentUser ( $name)
+
+

Sets the channel_name from the currently logged-in channel.

+
Parameters
+ + +
string$nameThe channel's name
+
+
+ +
+
+ +
+
+ + + + + + + + +
RedMatrix\RedDAV\RedBasicAuth::setTimezone ( $timezone)
+
+ +

Sets the timezone from the channel in RedBasicAuth.

+

Set in mod/cloud.php if the channel has a timezone set.

+
Parameters
+ + +
string$timezoneThe channel's timezone.
+
+
+
Returns
void
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
RedMatrix\RedDAV\RedBasicAuth::validateUserPass ( $username,
 $password 
)
+ 		+protected
+
+ +

Validates a username and password.

+

Guest access is granted with the password "+++".

+
See Also
::validateUserPass
+
Parameters
+ + + +
string$username
string$password
+
+
+
Returns
bool
+ +
+
+

Member Data Documentation

+ +
+
+ + + + +
RedMatrix\RedDAV\RedBasicAuth::$browser
+
+ +

Referenced by RedMatrix\RedDAV\RedBasicAuth\setBrowserPlugin().

+ +
+
+ +
+
+ + + + +
RedMatrix\RedDAV\RedBasicAuth::$channel_hash = ''
+
+ +
+
+ +
+
+ + + + +
RedMatrix\RedDAV\RedBasicAuth::$channel_id = 0
+
+ +
+
+ +
+
+ + + + + +
+ + + + +
RedMatrix\RedDAV\RedBasicAuth::$channel_name = null
+ 		+protected
+
+ +

Referenced by RedMatrix\RedDAV\RedBasicAuth\getCurrentUser().

+ +
+
+ +
+
+ + + + +
RedMatrix\RedDAV\RedBasicAuth::$observer = ''
+
+ +
+
+ +
+
+ + + + +
RedMatrix\RedDAV\RedBasicAuth::$owner_id = 0
+
+ +
+
+ +
+
+ + + + +
RedMatrix\RedDAV\RedBasicAuth::$owner_nick = ''
+
+ +
+
+ +
+
+ + + + + +
+ + + + +
RedMatrix\RedDAV\RedBasicAuth::$timezone = ''
+ 		+protected
+
+ +

Referenced by RedMatrix\RedDAV\RedBasicAuth\getTimezone(), and RedMatrix\RedDAV\RedBasicAuth\setTimezone().

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ 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 new file mode 100644 index 000000000..f361b604b Binary files /dev/null and b/doc/html/classRedMatrix_1_1RedDAV_1_1RedBasicAuth.png differ 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 @@ + + + + + + +The Red Matrix: Member List + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Matrix +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+
RedMatrix\RedDAV\RedDirectory Member List
+
+
+ +

This is the complete list of members for RedMatrix\RedDAV\RedDirectory, including all inherited members.

+ + + + + + + + + + + + + + + + + + + +
$authRedMatrix\RedDAV\RedDirectoryprivate
$ext_pathRedMatrix\RedDAV\RedDirectoryprivate
$folder_hashRedMatrix\RedDAV\RedDirectoryprivate
$os_pathRedMatrix\RedDAV\RedDirectoryprivate
$red_pathRedMatrix\RedDAV\RedDirectoryprivate
$root_dirRedMatrix\RedDAV\RedDirectoryprivate
__construct($ext_path, &$auth_plugin)RedMatrix\RedDAV\RedDirectory
childExists($name)RedMatrix\RedDAV\RedDirectory
createDirectory($name)RedMatrix\RedDAV\RedDirectory
createFile($name, $data=null)RedMatrix\RedDAV\RedDirectory
getChild($name)RedMatrix\RedDAV\RedDirectory
getChildren()RedMatrix\RedDAV\RedDirectory
getDir()RedMatrix\RedDAV\RedDirectory
getLastModified()RedMatrix\RedDAV\RedDirectory
getName()RedMatrix\RedDAV\RedDirectory
getQuotaInfo()RedMatrix\RedDAV\RedDirectory
log()RedMatrix\RedDAV\RedDirectoryprivate
setName($name)RedMatrix\RedDAV\RedDirectory
+
+ 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 @@ + + + + + + +The Red Matrix: RedMatrix\RedDAV\RedDirectory Class Reference + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Matrix +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Member Functions | +Private Member Functions | +Private Attributes | +List of all members
+
+
RedMatrix\RedDAV\RedDirectory Class Reference
+
+
+ +

RedDirectory class. + More...

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

+Public Member Functions

 __construct ($ext_path, &$auth_plugin)
 Sets up the directory node, expects a full path. More...
 
 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
 
 $folder_hash
 
 $ext_path
 
 $root_dir = ''
 
 $auth
 
 $os_path = ''
 
+

Detailed Description

+

RedDirectory class.

+

A class that represents a directory.

+

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

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
RedMatrix\RedDAV\RedDirectory::__construct ( $ext_path,
& $auth_plugin 
)
+
+ +

Sets up the directory node, expects a full path.

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

Member Function Documentation

+ +
+
+ + + + + + + + +
RedMatrix\RedDAV\RedDirectory::childExists ( $name)
+
+ +

Checks if a child exists.

+
Parameters
+ + +
string$nameThe name to check if it exists.
+
+
+
Returns
boolean
+ +
+
+ +
+
+ + + + + + + + +
RedMatrix\RedDAV\RedDirectory::createDirectory ( $name)
+
+ +

Creates a new subdirectory.

+
Parameters
+ + +
string$namethe directory to create
+
+
+
Returns
void
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
RedMatrix\RedDAV\RedDirectory::createFile ( $name,
 $data = null 
)
+
+ +

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
+ + +
\Sabre\DAV\Exception\Forbidden
+
+
+
Parameters
+ + + +
string$nameName of the file
resource | string$dataInitial payload
+
+
+
Returns
null|string ETag
+ +
+
+ +
+
+ + + + + + + + +
RedMatrix\RedDAV\RedDirectory::getChild ( $name)
+
+ +

Returns a child by name.

+
Exceptions
+ + + +
\Sabre\DAV\Exception\Forbidden
\Sabre\DAV\Exception\NotFound
+
+
+
Parameters
+ + +
string$name
+
+
+ +
+
+ +
+
+ + + + + + + +
RedMatrix\RedDAV\RedDirectory::getChildren ()
+
+ +

Returns an array with all the child nodes.

+
Exceptions
+ + +
\Sabre\DAV\Exception\Forbidden
+
+
+
Returns
array []
+ +
+
+ +
+
+ + + + + + + +
RedMatrix\RedDAV\RedDirectory::getDir ()
+
+
Todo:
add description of what this function does.
+
Exceptions
+ + +
\Sabre\DAV\Exception\NotFound
+
+
+
Returns
void
+ +

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

+ +
+
+ +
+
+ + + + + + + +
RedMatrix\RedDAV\RedDirectory::getLastModified ()
+
+ +

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
+ +
+
+ +
+
+ + + + + + + +
RedMatrix\RedDAV\RedDirectory::getName ()
+
+ +

Returns the name of the directory.

+
Returns
string
+ +
+
+ +
+
+ + + + + + + +
RedMatrix\RedDAV\RedDirectory::getQuotaInfo ()
+
+ +

Return quota usage.

+

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

+
Returns
array with used and free values in bytes.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
RedMatrix\RedDAV\RedDirectory::log ()
+ 		+private
+
+ +

Referenced by RedMatrix\RedDAV\RedDirectory\getChildren().

+ +
+
+ +
+
+ + + + + + + + +
RedMatrix\RedDAV\RedDirectory::setName ( $name)
+
+ +

Renames the directory.

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

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
RedMatrix\RedDAV\RedDirectory::$auth
+ 		+private
+
+ +
+
+ +
+
+ + + + + +
+ + + + +
RedMatrix\RedDAV\RedDirectory::$ext_path
+ 		+private
+
+ +

Referenced by RedMatrix\RedDAV\RedDirectory\__construct(), and RedMatrix\RedDAV\RedDirectory\getDir().

+ +
+
+ +
+
+ + + + + +
+ + + + +
RedMatrix\RedDAV\RedDirectory::$folder_hash
+ 		+private
+
+ +
+
+ +
+
+ + + + + +
+ + + + +
RedMatrix\RedDAV\RedDirectory::$os_path = ''
+ 		+private
+
+ +

Referenced by RedMatrix\RedDAV\RedDirectory\createFile(), and RedMatrix\RedDAV\RedDirectory\getDir().

+ +
+
+ +
+
+ + + + + +
+ + + + +
RedMatrix\RedDAV\RedDirectory::$red_path
+ 		+private
+
+ +
+
+ +
+
+ + + + + +
+ + + + +
RedMatrix\RedDAV\RedDirectory::$root_dir = ''
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ 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 new file mode 100644 index 000000000..e3eeebb23 Binary files /dev/null and b/doc/html/classRedMatrix_1_1RedDAV_1_1RedDirectory.png differ 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 @@ + + + + + + +The Red Matrix: Member List + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Matrix +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+
RedMatrix\RedDAV\RedFile Member List
+
+
+ +

This is the complete list of members for RedMatrix\RedDAV\RedFile, including all inherited members.

+ + + + + + + + + + + + + + +
$authRedMatrix\RedDAV\RedFileprivate
$dataRedMatrix\RedDAV\RedFileprivate
$nameRedMatrix\RedDAV\RedFileprivate
__construct($name, $data, &$auth)RedMatrix\RedDAV\RedFile
delete()RedMatrix\RedDAV\RedFile
get()RedMatrix\RedDAV\RedFile
getContentType()RedMatrix\RedDAV\RedFile
getETag()RedMatrix\RedDAV\RedFile
getLastModified()RedMatrix\RedDAV\RedFile
getName()RedMatrix\RedDAV\RedFile
getSize()RedMatrix\RedDAV\RedFile
put($data)RedMatrix\RedDAV\RedFile
setName($newName)RedMatrix\RedDAV\RedFile
+
+ 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: +
+
+ 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 new file mode 100644 index 000000000..9a1837e1c Binary files /dev/null and b/doc/html/classRedMatrix_1_1RedDAV_1_1RedFile.png differ 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 @@ + + + + + + +The Red Matrix: include/dimport.php File Reference + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Matrix +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Functions
+
+
dimport.php File Reference
+
+
+ + + + +

+Functions

 foofoo ()
 
+

Function Documentation

+ +
+
+ + + + + + + +
foofoo ()
+
+ +
+
+
+
+ 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 @@ + + + + + + +The Red Matrix: mod/locs.php File Reference + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Matrix +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Functions
+
+
locs.php File Reference
+
+
+ + + + +

+Functions

 locs_post (&$a)
 
+

Function Documentation

+ +
+
+ + + + + + + + +
locs_post (& $a)
+
+

Placeholder file at present. This is going to involve a bit of work.

+

This file will deal with the deletion of channels and management of hublocs.

+

We need to provide the following functionality:

+
    +
  • Delete my account and all channels from the entire network
    • +
+
    +
  • Delete my account and all channels from this server
    • +
+
    +
  • Delete a channel from the entire network
    • +
+
    +
  • Delete a channel from this server
    • +
+
    +
  • List all hub locations for this channel
    • +
+
    +
  • Remove this/some hub location from this channel
    • +
+
    +
  • promote this/some hub location to primary
    • +
+
    +
  • Remove hub location 'xyz' from this channel, (this should possibly only be allowed if that hub has been down for a period of time)
    • +
+
    +
  • Some of these actions should probably require email verification
    • +
+ +
+
+
+
+ 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 -- cgit v1.2.3