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

add more documentation

Browse Source
This commit is contained in:
Uwe Steinmann 2016-04-22 08:21:18 +02:00
parent 823e7bf76e
commit e1926ed217
2 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
inc/inc.ClassAccessOperation.php
View File

@ -348,14 +348,17 @@ class SeedDMS_AccessOperation {
* Check for access permission on view
*
* If the parameter $view is an array then each element is considered the
* name of a view and true will be returned if one is accessible.
* name of a view and true will be returned if one of them is accessible.
* Whether access is allowed also depends on the currently logged in user
* stored in the view object. If the user is an admin the access
* on a view must be explicitly disallowed. For regular users the access
* must be explicitly allowed.
*
* If advanced access control is turn off, this function will always return
* true for admins and false for other users.
*
* @param mixed $view Instanz of view, name of view or array of view names
* @param string $get query parameters
* @param string $get query parameters possible containing the element 'action'
* @return boolean true if access is allowed, false if access is disallowed
* no specific access right is set, otherwise false
*/

8
inc/inc.ClassViewCommon.php
View File

@ -171,10 +171,10 @@ class SeedDMS_View_Common {
* Check if the access on the view with given name or the current view itself
* may be accessed.
*
* The function behaves differently for admins and other users. For admins
* a view must be explitly disallowed for this function to return false.
* For other users access on a view must be explicitly allow for the this
* function to return true.
* The function requires the parameter 'accessobject' to be available in the
* view, because it calls SeedDMS_AccessOperation::check_view_access()
* to check access rights. If the the optional $name is not set the
* current view is used.
*
* @param string|array $name name of view or list of view names
* @return boolean true if access is allowed otherwise false