[Phpgroupware-cvs] phpgwapi/inc class.acl.inc.php

[Sigurd Nes]

CVSROOT:        /sources/phpgwapi
Module name:    phpgwapi
Changes by:     Sigurd Nes <sigurdne>   06/10/23 12:42:39

Modified files:
        inc            : class.acl.inc.php 

Log message:
        doc

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/phpgwapi/inc/class.acl.inc.php?cvsroot=phpgwapi&r1=1.99&r2=1.100

Patches:
Index: class.acl.inc.php
===================================================================
RCS file: /sources/phpgwapi/phpgwapi/inc/class.acl.inc.php,v
retrieving revision 1.99
retrieving revision 1.100
diff -u -b -r1.99 -r1.100
--- class.acl.inc.php   23 Oct 2006 10:31:02 -0000      1.99
+++ class.acl.inc.php   23 Oct 2006 12:42:39 -0000      1.100
@@ -6,7 +6,7 @@
        * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General 
Public License
        * @package phpgwapi
        * @subpackage accounts
-       * @version $Id: class.acl.inc.php,v 1.99 2006/10/23 10:31:02 skwashd 
Exp $
+       * @version $Id: class.acl.inc.php,v 1.100 2006/10/23 12:42:39 sigurdne 
Exp $
        */
 
        /**
@@ -256,8 +256,8 @@
                *
                * @param string|boolean $appname Application name, defaults to 
false which means $GLOBALS['phpgw_info']['flags']['currentapp']
                * @param string $location Application location
-               * @param ??? $grantor ask sigurd
-               * @paran ??? $type ask sigurd
+               * @param integer $grantor account_id of the user that has 
granted access to his/hers records. No value means that this is a ordinary ACL 
- record
+               * @param integer $type mask or right (1 means mask , 0 means 
right)
                * @return array Array with ACL records
                */
                function delete($appname = '', $location, $grantor = False, 
$type = False)
@@ -285,8 +285,8 @@
                /**
                * Save repository in database
                *
-               * @param ??? $appname ask sigurd
-               * @param ??? $location ask sigurd
+               * @param string $appname Application name (default empty string 
is converted to false $GLOBALS['phpgw_info']['flags']['currentapp'])
+               * @param string $location location within application 
                * @return array Array with ACL records
                */
                function save_repository($appname = '', $location='')
@@ -416,11 +416,11 @@
                /**
                * Get rights from the repository not specific to this object
                *
-               * @param $location Application location
+               * @param string $location location within application
                * @param string|boolean $appname Application name, defaults to 
false which means $GLOBALS['phpgw_info']['flags']['currentapp']
-               * @param ??? $grantor ask sigurd
-               * @param ??? $type ask sigurd
-               * @param ??? $account_type ask sigurd
+               * @param integer $grantor account_id of the user that has 
granted access to his/hers records. No value means that this is a ordinary ACL 
- record
+               * @param integer $type mask or right (1 means mask , 0 means 
right)
+               * @param string|array $account_type used to disiguish between 
checkpattern:"accounts","groups" and "both" - the normal behaviour is ("both") 
to first check for rights given to groups - and then to override by rights/mask 
given to users (accounts)
                * @return integer Access rights in bitmask form
                */
                function get_rights($location,$appname = '', $grantor = False, 
$type = False, $account_type = False)
@@ -457,13 +457,6 @@
                                                
$GLOBALS['phpgw']->shm->store_value($GLOBALS['phpgw_info']['user']['domain'] . 
'acl_data_' . $account_type . '_' . $this->account_id,'empty');                 
                         
                                                }
                                        }
-
-/*                                     if(!$this->data[$this->account_id] = 
$GLOBALS['phpgw']->shm->get_value($GLOBALS['phpgw_info']['user']['domain'] . 
'acl_data_' . $account_type . '_' . $this->account_id))
-                                       {
-                                               
$this->read_repository($account_type);
-                                               
$GLOBALS['phpgw']->shm->store_value($GLOBALS['phpgw_info']['user']['domain'] . 
'acl_data_' . $account_type . '_' . 
$this->account_id,$this->data[$this->account_id]);
-                                       }
-*/
                                }
                                else
                                {
@@ -532,7 +525,7 @@
                /**
                * Check required rights (not specific to this object)
                *
-               * @param string $location Application location
+               * @param string $location location within application
                * @param integer $required Required right (bitmask) to check 
against
                * @param string $appname Application name (default empty string 
is converted to false $GLOBALS['phpgw_info']['flags']['currentapp'])
                * @return boolean True when $required bitmap matched otherwise 
false
@@ -553,7 +546,7 @@
                /**
                * Check  required rights
                *
-               * @param string $location Application location
+               * @param string $location location within application
                * @param integer $required Required right (bitmask) to check 
against
                * @param string|boolean $appname Application name, defaults to 
false which means $GLOBALS['phpgw_info']['flags']['currentapp']
                * @param integer $grantor useraccount to check against
@@ -587,7 +580,7 @@
                /**
                * Get specific rights
                *
-               * @param string $location Application location
+               * @param string $location location within application
                * @param string $appname Application name (default empty string 
is converted to false $GLOBALS['phpgw_info']['flags']['currentapp'])
                * @return integer Access rights in bitmask form
                */
@@ -628,7 +621,7 @@
                /**
                * Check specific rights
                *
-               * @param string $location Application location
+               * @param string $location location within application
                * @param integer $required Required rights as bitmap
                * @param string $appname Application name (default empty string 
is converted to false $GLOBALS['phpgw_info']['flags']['currentapp'])
                * @return boolean True when $required bitmap matched otherwise 
false
@@ -695,7 +688,7 @@
                * Add repository information for an application
                *
                * @param string $app Application name
-               * @param string $location Application location
+               * @param string $location location within application
                * @param integer $account_id Account id
                * @param integer $rights Access rights in bitmap form
                * @return boolean Always true, which seems pretty pointless 
really doesn't it
@@ -727,7 +720,7 @@
                * Delete repository information for an application
                *
                * @param string $app Application name
-               * @param string $location Application location
+               * @param string $location location within application
                * @param integer $account_id Account id - 0 = current user
                * @return integer Number of deleted entries
                */
@@ -758,7 +751,7 @@
                /**
                * Get application list for an account id
                *
-               * @param string $location Application location
+               * @param string $location location within application
                * @param integer $required Access rights as bitmap
                * @param integer $account_id Account id defaults to 0 which is 
translated to $GLOBALS['phpgw_info']['user']['account_id']
                * @return boolean|array Array with list of applications or false
@@ -849,7 +842,7 @@
                /**
                * Get ids for location
                *
-               * @param string $location Application location
+               * @param string $location location within application
                * @param integer $required Required access rights in bitmap 
format
                * @param string $app Application name, defaults to empty string 
which translates to $GLOBALS['phpgw_info']['flags']['currentapp']
                * @return array Array with account ids
@@ -929,7 +922,10 @@
                }
 
                /**
-               * I do something, but I am not really sure what, maybe ask 
sigurd
+               * Get a list of users that has grants rights to their records 
at a location within an application
+               * @param string $location location within application
+               * @param string $app Application name, defaults to empty string 
which translates to $GLOBALS['phpgw_info']['flags']['currentapp']
+               * @return array Array with account ids and corresponding rights
                */
                function get_grants($app='',$location='')
                {
@@ -955,7 +951,7 @@
                * Get application specific account based granted rights list
                *
                * @param string $app Application name, defaults to 
$GLOBALS['phpgw_info']['flags']['currentapp']
-               * @param string $location location within Application name
+               * @param string $location location within application
                * @param integer $type mask or right (1 means mask , 0 means 
right) to check against
                * @return array Associative array with granted access rights 
for accounts
                */
@@ -1062,7 +1058,7 @@
                /**
                 * Update the description of a location
                 * 
-                * @param string $location the name of the location
+                * @param string $location location within application
                 * @param string $description the description of the location - 
seen by users
                 * @param string $appname the name of the application for the 
location
                 */