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 documtation for getDocumentLink() and getDocumentLinks()

Browse Source
This commit is contained in:
Uwe Steinmann 2013-04-10 15:39:50 +02:00
parent 21437e5a90
commit db53b06b18
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
SeedDMS_Core/Core/inc.ClassDocument.php
View File

@ -1409,6 +1409,13 @@ class SeedDMS_Core_Document extends SeedDMS_Core_Object { /* {{{ */
return true;
} /* }}} */
/**
* Return a certain document link
*
* @param integer $linkID id of link
* @return object instance of SeedDMS_Core_DocumentLink or false in case of
* an error.
*/
function getDocumentLink($linkID) { /* {{{ */
$db = $this->_dms->getDB();
@ -1425,6 +1432,15 @@ class SeedDMS_Core_Document extends SeedDMS_Core_Object { /* {{{ */
return new SeedDMS_Core_DocumentLink($resArr["id"], $document, $target, $resArr["userID"], $resArr["public"]);
} /* }}} */
/**
* Return all document links
*
* The list contains all links to other documents, even those which
* may not be visible certain users. The application should call
* SeedDMS_Core_DMS::filterDocumentLinks() afterwards.
*
* @return array list of objects of class SeedDMS_Core_DocumentLink
*/
function getDocumentLinks() { /* {{{ */
if (!isset($this->_documentLinks)) {
$db = $this->_dms->getDB();