gnh1201/seeddms-code
1
0
Fork 0
mirror of https://git.code.sf.net/p/seeddms/code synced 2025-02-06 15:14:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

better documentation of getAccessMode()

Browse Source
This commit is contained in:
Uwe Steinmann 2021-09-24 10:22:28 +02:00
parent 959c75ff79
commit 9d926fb55c
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
SeedDMS_Core/Core/inc.ClassFolder.php
View File

@ -1453,31 +1453,31 @@ class SeedDMS_Core_Folder extends SeedDMS_Core_Object {
/** /**
* Get the access mode of a user on the folder * Get the access mode of a user on the folder
* *
* This function returns the access mode for a given user. An administrator * The access mode is either M_READ, M_READWRITE, M_ALL, or M_NONE.
* and the owner of the folder has unrestricted access. A guest user has * It is determined
* read only access or no access if access rights are further limited * - by the user (admins and owners have always access mode M_ALL)
* by access control lists. All other users have access rights according * - by the access list for the user (possibly inherited)
* to the access control lists or the default access. This function will * - by the default access mode
* recursive check for access rights of parent folders if access rights
* are inherited.
* *
* This function returns the access mode for a given user. An administrator * 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 * 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 * 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 * 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. * 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 * is called. If it returns a value > 0, then this will be returned by this
* method without any further checks. The optional paramater $context * method without any further checks. The optional paramater $context
* will be passed as a third parameter to the callback. It contains * 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 * 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 * 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 * @param string $context context in which the access mode is requested
* @return integer access mode * @return integer access mode
*/ */