diff --git a/SeedDMS_Core/Core/inc.ClassFolder.php b/SeedDMS_Core/Core/inc.ClassFolder.php index 51e78ab1a..1be3964ca 100644 --- a/SeedDMS_Core/Core/inc.ClassFolder.php +++ b/SeedDMS_Core/Core/inc.ClassFolder.php @@ -1452,32 +1452,32 @@ class SeedDMS_Core_Folder extends SeedDMS_Core_Object { /** * Get the access mode of a user on the folder - * + * + * The access mode is either M_READ, M_READWRITE, M_ALL, or M_NONE. + * It is determined + * - by the user (admins and owners have always access mode M_ALL) + * - by the access list for the user (possibly inherited) + * - by the default access mode + * * This function returns the access mode for a given user. An administrator * and the owner of the folder has unrestricted access. A guest user has * read only access or no access if access rights are further limited - * by access control lists. All other users have access rights according + * by access control lists all the default access. + * All other users have access rights according * to the access control lists or the default access. This function will - * recursive check for access rights of parent folders if access rights + * recursively check for access rights of parent folders if access rights * are inherited. * - * This function returns the access mode for a given user. An administrator - * and the owner of the folder has unrestricted access. A guest user has - * read only access or no access if access rights are further limited - * by access control lists. All other users have access rights according - * to the access control lists or the default access. This function will - * recursive check for access rights of parent folders if access rights - * are inherited. - * - * Before checking the access in the method itself a callback 'onCheckAccessFolder' + * Before checking the access itself a callback 'onCheckAccessFolder' * is called. If it returns a value > 0, then this will be returned by this * method without any further checks. The optional paramater $context * will be passed as a third parameter to the callback. It contains * the operation for which the access mode is retrieved. It is for example * set to 'removeDocument' if the access mode is used to check for sufficient - * permission on deleting a document. + * permission on deleting a document. This callback could be used to + * override any existing access mode in a certain context. * - * @param object $user user for which access shall be checked + * @param SeedDMS_Core_User $user user for which access shall be checked * @param string $context context in which the access mode is requested * @return integer access mode */