@@ -30,9 +30,17 @@ discard block |
||
30 | 30 | } |
31 | 31 | |
32 | 32 | var $currentVersion; |
33 | + |
|
34 | + /** |
|
35 | + * @param Docman_Version $currentVersion |
|
36 | + */ |
|
33 | 37 | function setCurrentVersion(&$currentVersion) { |
34 | 38 | $this->currentVersion =& $currentVersion; |
35 | 39 | } |
40 | + |
|
41 | + /** |
|
42 | + * @return Docman_Version |
|
43 | + */ |
|
36 | 44 | function &getCurrentVersion() { |
37 | 45 | return $this->currentVersion; |
38 | 46 | } |
@@ -42,6 +50,9 @@ discard block |
||
42 | 50 | return $row; |
43 | 51 | } |
44 | 52 | |
53 | + /** |
|
54 | + * @param Docman_Widget_Embedded $visitor |
|
55 | + */ |
|
45 | 56 | function accept(&$visitor, $params = array()) { |
46 | 57 | return $visitor->visitFile($this, $params); |
47 | 58 | } |
@@ -71,6 +71,10 @@ |
||
71 | 71 | } |
72 | 72 | } |
73 | 73 | |
74 | + /** |
|
75 | + * @param string $dst_name |
|
76 | + * @param integer $dst_version_number |
|
77 | + */ |
|
74 | 78 | function copy($srcPath, $dst_name, $dst_group_id, $dst_item_id, $dst_version_number) { |
75 | 79 | $dstPath = $this->_getPath($dst_name, $dst_group_id, $dst_item_id, $dst_version_number); |
76 | 80 |
@@ -460,6 +460,9 @@ |
||
460 | 460 | class Docman_FilterGlobalText extends Docman_FilterText { |
461 | 461 | var $dynTextFields; |
462 | 462 | |
463 | + /** |
|
464 | + * @param Docman_Metadata $md |
|
465 | + */ |
|
463 | 466 | function Docman_FilterGlobalText($md, $dynTextFields) { |
464 | 467 | parent::Docman_FilterText($md); |
465 | 468 | $this->dynTextFields = $dynTextFields; |
@@ -220,6 +220,9 @@ |
||
220 | 220 | return $filter; |
221 | 221 | } |
222 | 222 | |
223 | + /** |
|
224 | + * @param Docman_ListMetadata $md |
|
225 | + */ |
|
223 | 226 | function createItemTypeFilter($md, $advSearch) { |
224 | 227 | if ($advSearch) { |
225 | 228 | $f = new Docman_FilterItemTypeAdvanced($md); |
@@ -36,6 +36,7 @@ |
||
36 | 36 | * existing function that handle prefences in this way. |
37 | 37 | * |
38 | 38 | * @param Folder |
39 | + * @param Docman_Folder $folder |
|
39 | 40 | */ |
40 | 41 | function collapse($folder) { |
41 | 42 | user_del_preference(PLUGIN_DOCMAN_EXPAND_FOLDER_PREF.'_'.$folder->getGroupId().'_'.$folder->getId()); |
@@ -78,6 +78,9 @@ |
||
78 | 78 | return $html; |
79 | 79 | } |
80 | 80 | |
81 | + /** |
|
82 | + * @param string $formName |
|
83 | + */ |
|
81 | 84 | function toHtml($formName, $trashLinkBase) { |
82 | 85 | $trashLink = ''; |
83 | 86 | if($trashLinkBase) { |
@@ -25,10 +25,17 @@ discard block |
||
25 | 25 | */ |
26 | 26 | class Docman_Icons { |
27 | 27 | var $images_path; |
28 | + |
|
29 | + /** |
|
30 | + * @param string $images_path |
|
31 | + */ |
|
28 | 32 | function Docman_Icons($images_path) { |
29 | 33 | $this->images_path = $images_path; |
30 | 34 | } |
31 | 35 | |
36 | + /** |
|
37 | + * @param string $action |
|
38 | + */ |
|
32 | 39 | function getActionIcon($action) { |
33 | 40 | switch ($action) { |
34 | 41 | case 'popup': |
@@ -186,10 +193,17 @@ discard block |
||
186 | 193 | function getSpinner() { |
187 | 194 | return $this->images_path . 'spinner.gif'; |
188 | 195 | } |
196 | + |
|
197 | + /** |
|
198 | + * @param string $icon |
|
199 | + */ |
|
189 | 200 | function getIcon($icon) { |
190 | 201 | return $this->images_path . $icon; |
191 | 202 | } |
192 | 203 | |
204 | + /** |
|
205 | + * @param string $icon |
|
206 | + */ |
|
193 | 207 | function getThemeIcon($icon) { |
194 | 208 | return util_get_image_theme('ic/'.$icon); |
195 | 209 | } |
@@ -340,6 +340,9 @@ |
||
340 | 340 | return $this->pathTitle; |
341 | 341 | } |
342 | 342 | |
343 | + /** |
|
344 | + * @param string $event |
|
345 | + */ |
|
343 | 346 | public function fireEvent($event, $user, $parent=null) { |
344 | 347 | $params = array('group_id' => $this->getGroupId(), |
345 | 348 | 'parent' => $parent, |
@@ -53,6 +53,7 @@ discard block |
||
53 | 53 | |
54 | 54 | /** |
55 | 55 | * Return the SQL statements that exclude deleted & obsolete items. |
56 | + * @param string $table |
|
56 | 57 | */ |
57 | 58 | function getCommonExcludeStmt($table) { |
58 | 59 | return Docman_ItemDao::getExcludeDeletedItemsStmt($table).' AND '. |
@@ -114,6 +115,8 @@ discard block |
||
114 | 115 | } |
115 | 116 | |
116 | 117 | /** |
118 | + * @param integer $limit |
|
119 | + * @param integer $offset |
|
117 | 120 | * @return DataAccessResult |
118 | 121 | */ |
119 | 122 | public function searchPaginatedWithVersionByGroupId($groupId, $limit, $offset) { |
@@ -312,7 +315,7 @@ discard block |
||
312 | 315 | /** |
313 | 316 | * Create a string from an array of sql statements. |
314 | 317 | * |
315 | - * @param $op Operator (AND, OR, LEFT JOIN, ...) |
|
318 | + * @param string $op Operator (AND, OR, LEFT JOIN, ...) |
|
316 | 319 | * @param $stmtArray Array of statements. |
317 | 320 | * @return string |
318 | 321 | */ |
@@ -377,8 +380,8 @@ discard block |
||
377 | 380 | /** |
378 | 381 | * Creates an item by calling the given SQL request, and returns the new ID |
379 | 382 | * |
380 | - * @param $sql SQL request |
|
381 | - * @param $updateParent Determines if the parent folder "update date" must be updated |
|
383 | + * @param string $sql SQL request |
|
384 | + * @param boolean $updateParent Determines if the parent folder "update date" must be updated |
|
382 | 385 | */ |
383 | 386 | function _createAndReturnId($sql, $updateParent) { |
384 | 387 | $inserted = $this->update($sql); |
@@ -398,7 +401,8 @@ discard block |
||
398 | 401 | /** |
399 | 402 | * Update a row in the table plugin_docman_item |
400 | 403 | * |
401 | - * @return true if there is no error |
|
404 | + * @param integer $update_date |
|
405 | + * @return boolean if there is no error |
|
402 | 406 | */ |
403 | 407 | function updateById($item_id, $parent_id=null, $group_id=null, $title=null, |
404 | 408 | $description=null, $create_date=null, $update_date=null, |
@@ -529,7 +533,7 @@ discard block |
||
529 | 533 | * Delete entry that match $item_id in plugin_docman_item |
530 | 534 | * |
531 | 535 | * @param $item_id int |
532 | - * @return true if there is no error |
|
536 | + * @return boolean if there is no error |
|
533 | 537 | */ |
534 | 538 | function delete($item_id) { |
535 | 539 | $sql = sprintf("DELETE FROM plugin_docman_item WHERE item_id=%d", |
@@ -722,6 +726,11 @@ discard block |
||
722 | 726 | * |
723 | 727 | * @note: Cross-Project query. |
724 | 728 | */ |
729 | + |
|
730 | + /** |
|
731 | + * @param integer $tsStart |
|
732 | + * @param integer $tsEnd |
|
733 | + */ |
|
725 | 734 | function searchObsoleteAcrossProjects($tsStart, $tsEnd) { |
726 | 735 | $sql = sprintf('SELECT i.*'. |
727 | 736 | ' FROM plugin_docman_item i, groups g'. |
@@ -807,7 +816,7 @@ discard block |
||
807 | 816 | /** |
808 | 817 | * This removes all users copy preferences set on item identified by $item_id. This is done once the corresponding item is deleted |
809 | 818 | * |
810 | - * @param int $itemid identifer of docman item that has been marked as deleted. |
|
819 | + * @param integer $item_id identifer of docman item that has been marked as deleted. |
|
811 | 820 | *@return void |
812 | 821 | * |
813 | 822 | */ |
@@ -822,7 +831,7 @@ discard block |
||
822 | 831 | /** |
823 | 832 | * This removes all users cut preferences set on item identified by $item_id. This is done once the corresponding item is deleted |
824 | 833 | * |
825 | - * @param int $itemid identifer of docman item that has been marked as deleted. |
|
834 | + * @param integer $item_id identifer of docman item that has been marked as deleted. |
|
826 | 835 | *@return void |
827 | 836 | * |
828 | 837 | */ |