gnh1201/seeddms-code
1
0
Fork 0
mirror of https://git.code.sf.net/p/seeddms/code synced 2025-03-12 00:45:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add more documentation

Browse Source
This commit is contained in:
Uwe Steinmann 2021-09-17 18:21:57 +02:00
parent 4ad5628833
commit f9afc08355
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
SeedDMS_Core/Core/inc.ClassDMS.php
View File

@ -197,7 +197,7 @@ class SeedDMS_Core_DMS {
* Checks if two objects are equal by comparing their IDs
*
* The regular php check done by '==' compares all attributes of
* two objects, which is often not required. The method will first check
* two objects, which is often not required. This method will first check
* if the objects are instances of the same class and than if they
* have the same id.
*
@ -255,7 +255,8 @@ class SeedDMS_Core_DMS {
*
* The list of objects to be checked can be of any class, but has to have
* a method getAccessMode($user) which checks if the given user has at
* least access rights to the object as passed in $minMode.
* least the access right on the object as passed in $minMode.
* Hence, passing a group instead of user is possible.
*
* @param array $objArr list of objects (either documents or folders)
* @param object $user user for which access is checked
@ -279,11 +280,12 @@ class SeedDMS_Core_DMS {
* Filter out users which cannot access an object in a given mode.
*
* The list of users to be checked can be of any class, but has to have
* a method getAccessMode($user) which checks if a user has at least
* access rights as passed in $minMode.
* a method getAccessMode($user) which checks if a user has at least the
* access right as passed in $minMode. Hence, passing a list of groups
* instead of users is possible.
*
* @param object $obj object that shall be accessed
* @param array $users list of users which are to check for sufficient
* @param array $users list of users/groups which are to check for sufficient
* access rights
* @param integer $minMode minimum access right on the object for each user
* (M_ANY, M_NONE, M_READ, M_READWRITE, M_ALL)