From c9251370b26098d838fed5c3583cd8b6dce9c9b2 Mon Sep 17 00:00:00 2001 From: hickert Date: Wed, 13 Oct 2010 08:31:42 +0000 Subject: [PATCH] Added comments git-svn-id: https://oss.gonicus.de/repositories/gosa/trunk@20017 594d385d-05f5-0310-b6e9-bd551577e9d8 --- .../FolderWidget/class_FolderWidget.inc | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/gosa-plugins/groupware/personal/groupware/FolderWidget/class_FolderWidget.inc b/gosa-plugins/groupware/personal/groupware/FolderWidget/class_FolderWidget.inc index 5ebb0be28..c39905d79 100644 --- a/gosa-plugins/groupware/personal/groupware/FolderWidget/class_FolderWidget.inc +++ b/gosa-plugins/groupware/personal/groupware/FolderWidget/class_FolderWidget.inc @@ -3,6 +3,33 @@ // Not yet finished need to be reviewed once the folder handling is working. +/*! \brief A groupware folder widget which allow to navigate through a + * given list of user or shared folders. + * Folders can be added or removed and ACLs assigned and updated. + * + * + * @param Config The GOsa configuration object + * @param Array The folder list to handle, e.g. + * + * $folders['shared/support']['status'] = ''; + * $folders['shared/support']['name'] = 'support'; + * $folders['shared/support']['acls'] = array(); + * + * $folders['shared/support/2010']['status'] = 'added'; + * $folders['shared/support/2010']['name'] = '2010'; + * $folders['shared/support/2010']['acls'] = array('anne' => 1024, 'klaus' => '210'); + * + * // 'status' Represents the folder status, maybe it wasn't touched then status is ''; + * // If the folder was added, then the status is 'added'. Status 'removed' + * // handles the folder as removed. + * + * // 'name' Represents the entry name, this should match the name in the path. + * + * // 'acls' Represents ACLs set for the folder. + * Syntax ['userNmae' => ACL] // See $this->setPermissions(); + * + * + */ class FolderWidget extends plugin { public $pathTitle = "Folder"; -- 2.30.2