From 478e7c4479f0c994fb9119d5b44032cc072b7c0a Mon Sep 17 00:00:00 2001 From: friendica Date: Sun, 19 Oct 2014 15:54:51 -0700 Subject: doc updates --- doc/html/include_2attach_8php.html | 48 +++++++++++++++++++++++++++++--------- 1 file changed, 37 insertions(+), 11 deletions(-) (limited to 'doc/html/include_2attach_8php.html') diff --git a/doc/html/include_2attach_8php.html b/doc/html/include_2attach_8php.html index 8cfed4f91..22833ea99 100644 --- a/doc/html/include_2attach_8php.html +++ b/doc/html/include_2attach_8php.html @@ -141,7 +141,7 @@ Functions  Changes permissions of a file. More...
   attach_delete ($channel_id, $resource) - Delete a file/directory. More...
+ Delete a file/directory from a channel. More...
   get_cloudpath ($arr)  Returns path to file in cloud/. More...
@@ -150,8 +150,10 @@ Functions  Returns path to parent folder in cloud/. More...
   find_folder_hash_by_attach_hash ($channel_id, $attachHash) + Return the hash of an attachment's folder. More...
   find_filename_by_hash ($channel_id, $attachHash) + Returns the filename of an attachment in a given channel. More...
   pipe_streams ($in, $out)   @@ -391,16 +393,18 @@ Functions
-

Delete a file/directory.

+

Delete a file/directory from a channel.

+

If the provided resource hash is from a directory it will delete everything recursively under this directory.

Parameters
- - + +
int$channel_id
string$resourcea hash to delete
int$channel_idThe id of the channel
string$resourceThe hash to delete
+
Returns
void
-

Referenced by RedDirectory\createFile(), RedFile\delete(), filestorage_content(), and RedFile\put().

+

Referenced by RedMatrix\RedDAV\RedDirectory\createFile(), RedMatrix\RedDAV\RedFile\delete(), filestorage_content(), and RedMatrix\RedDAV\RedFile\put().

@@ -523,7 +527,7 @@ Functions -

Referenced by RedDirectory\createDirectory().

+

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

@@ -600,6 +604,16 @@ Functions
+

Returns the filename of an attachment in a given channel.

+
Parameters
+ + + +
mixed$channel_idThe id of the channel
mixed$attachHashThe hash of the attachment
+
+
+
Returns
string The filename of the attachment
+

Referenced by get_parent_cloudpath().

@@ -628,6 +642,16 @@ Functions
+

Return the hash of an attachment's folder.

+
Parameters
+ + + +
int$channel_idThe id of the channel
string$attachHashThe hash of the attachment
+
+
+
Returns
string
+

Referenced by get_parent_cloudpath().

@@ -649,11 +673,11 @@ Functions

Returns path to file in cloud/.

Parameters
- +
$arr
array$arr,[uid]int the channels uid $arr[folder] string $arr[filename]] string
-
Returns
string with the path the file to cloud/
+
Returns
string path to the file in cloud/

Referenced by filestorage_content().

@@ -692,11 +716,13 @@ Functions

Returns path to parent folder in cloud/.

Parameters
- + + +
$arr
int$channel_idThe id of the channel
string$channel_nameThe name of the channel
string$attachHash
-
Returns
string with the folder path
+
Returns
string with the full folder path

Referenced by filestorage_content(), and filestorage_post().

@@ -761,7 +787,7 @@ Functions
Returns
string The mimetype according to a file ending.
-

Referenced by attach_store(), and RedDirectory\createFile().

+

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

-- cgit v1.2.3