gnh1201/seeddms-code
1
0
Fork 0
mirror of https://git.code.sf.net/p/seeddms/code synced 2025-10-15 13:31:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

- more documentation

Browse Source
This commit is contained in:
steinm 2012-01-12 17:02:30 +00:00
parent 76c9d403d4
commit 797cc442fd
2 changed files with 32 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
LetoDMS_Core/Core/inc.ClassDocument.php
View File

@ -579,7 +579,7 @@ class LetoDMS_Core_Document { /* {{{ */
} /* }}} */ } /* }}} */
/** /**
* Delete all entries for this folder from the access control list * Delete all entries for this document from the access control list
* *
* @return boolean true if operation was successful otherwise false * @return boolean true if operation was successful otherwise false
*/ */
@ -597,6 +597,17 @@ class LetoDMS_Core_Document { /* {{{ */
/** /**
* Returns a list of access privileges * Returns a list of access privileges
* *
* If the document inherits the access privileges from the parent folder
* those will be returned.
* $mode and $op can be set to restrict the list of returned access
* privileges. If $mode is set to M_ANY no restriction will apply
* regardless of the value of $op. The returned array contains a list
* of {@link LetoDMS_Core_UserAccess} and
* {@link LetoDMS_Core_GroupAccess} objects.
*
* @param integer $mode access mode (defaults to M_ANY)
* @param integer $op operation (defaults to O_EQ)
* @return array multi dimensional array
*/ */
function getAccessList($mode = M_ANY, $op = O_EQ) { /* {{{ */ function getAccessList($mode = M_ANY, $op = O_EQ) { /* {{{ */
$db = $this->_dms->getDB(); $db = $this->_dms->getDB();

20
LetoDMS_Core/Core/inc.ClassFolder.php
View File

@ -583,6 +583,21 @@ class LetoDMS_Core_Folder {
return true; return true;
} /* }}} */ } /* }}} */
/**
* Returns a list of access privileges
*
* If the document inherits the access privileges from the parent folder
* those will be returned.
* $mode and $op can be set to restrict the list of returned access
* privileges. If $mode is set to M_ANY no restriction will apply
* regardless of the value of $op. The returned array contains a list
* of {@link LetoDMS_Core_UserAccess} and
* {@link LetoDMS_Core_GroupAccess} objects.
*
* @param integer $mode access mode (defaults to M_ANY)
* @param integer $op operation (defaults to O_EQ)
* @return array multi dimensional array
*/
function getAccessList($mode = M_ANY, $op = O_EQ) { /* {{{ */ function getAccessList($mode = M_ANY, $op = O_EQ) { /* {{{ */
$db = $this->_dms->getDB(); $db = $this->_dms->getDB();
@ -618,6 +633,11 @@ class LetoDMS_Core_Folder {
return $this->_accessList[$mode]; return $this->_accessList[$mode];
} /* }}} */ } /* }}} */
/**
* Delete all entries for this folder from the access control list
*
* @return boolean true if operation was successful otherwise false
*/
function clearAccessList() { /* {{{ */ function clearAccessList() { /* {{{ */
$db = $this->_dms->getDB(); $db = $this->_dms->getDB();