@@ -302,6 +302,7 @@ discard block |
||
302 | 302 | * A Static method used to build the initial treeview when the page is first displayed |
303 | 303 | * |
304 | 304 | * @param String div_id - this div in which to display the tree |
305 | + * @param string $div_id |
|
305 | 306 | * @return Tree - the tree that is built |
306 | 307 | */ |
307 | 308 | static function buildTreeView($div_id, $isAlive = true){ |
@@ -332,6 +333,7 @@ discard block |
||
332 | 333 | * @param String type - module/patch.... |
333 | 334 | * @param String manifest - the path to the manifest file |
334 | 335 | * @param String modify_field - the field to update when the radio button is changed |
336 | + * @param string $form_action |
|
335 | 337 | * @return String - a form used to display the license |
336 | 338 | */ |
337 | 339 | function getLicenseDisplay($license_file, $form_action, $next_step, $zipFile, $type, $manifest, $modify_field){ |
@@ -49,7 +49,7 @@ |
||
49 | 49 | * @param save_dir (optional) if specified it will direct where to save the file once downloaded |
50 | 50 | * @param download_sever (optional) if specified it will direct the url for the download |
51 | 51 | * |
52 | - * @return the full path of the saved file |
|
52 | + * @return string full path of the saved file |
|
53 | 53 | */ |
54 | 54 | function download($session_id, $file_name, $save_dir = '', $download_server = ''){ |
55 | 55 | if(empty($save_dir)){ |
@@ -76,6 +76,9 @@ discard block |
||
76 | 76 | } |
77 | 77 | /* END - SECURITY GROUPS */ |
78 | 78 | |
79 | + /** |
|
80 | + * @param string $value |
|
81 | + */ |
|
79 | 82 | static function requireOwner($category, $value, $type='module'){ |
80 | 83 | global $current_user; |
81 | 84 | if(is_admin($current_user))return false; |
@@ -83,6 +86,10 @@ discard block |
||
83 | 86 | } |
84 | 87 | |
85 | 88 | /* BEGIN - SECURITY GROUPS */ |
89 | + |
|
90 | + /** |
|
91 | + * @param string $value |
|
92 | + */ |
|
86 | 93 | static function requireSecurityGroup($category, $value, $type='module'){ |
87 | 94 | global $current_user; |
88 | 95 | if(is_admin($current_user))return false; |
@@ -142,7 +149,7 @@ discard block |
||
142 | 149 | * Check to see if the module is available for this user. |
143 | 150 | * |
144 | 151 | * @param String $module_name |
145 | - * @return true if they are allowed. false otherwise. |
|
152 | + * @return boolean if they are allowed. false otherwise. |
|
146 | 153 | */ |
147 | 154 | static function checkModuleAllowed($module_name, $actions) |
148 | 155 | { |
@@ -158,7 +158,7 @@ |
||
158 | 158 | * returns the label associated with an access level |
159 | 159 | * these label definitions exist in the definitions in modules/ACLActions/actiondefs.php |
160 | 160 | * @param INT $access - the access level you want the color for |
161 | - * @return the access level label or false if the level does not exist |
|
161 | + * @return string|false access level label or false if the level does not exist |
|
162 | 162 | */ |
163 | 163 | protected static function AccessLabel($access){ |
164 | 164 | global $ACLActionAccessLevels; |
@@ -68,7 +68,7 @@ |
||
68 | 68 | * |
69 | 69 | * Sets the relationship between a role and an action and sets the access level of that relationship |
70 | 70 | * |
71 | - * @param GUID $role_id - the role id |
|
71 | + * @param string $role_id - the role id |
|
72 | 72 | * @param GUID $action_id - the ACL Action id |
73 | 73 | * @param int $access - the access level ACL_ALLOW_ALL ACL_ALLOW_NONE ACL_ALLOW_OWNER... |
74 | 74 | */ |
@@ -123,7 +123,7 @@ |
||
123 | 123 | * @param SugarBean $bean |
124 | 124 | * @param Administration $admin |
125 | 125 | * @param array $recipients |
126 | - * @return boolean |
|
126 | + * @return null|boolean |
|
127 | 127 | */ |
128 | 128 | public function sendReminders(SugarBean $bean, Administration $admin, $recipients) |
129 | 129 | { |
@@ -157,6 +157,10 @@ |
||
157 | 157 | $this->retrieveSettings(false, true); |
158 | 158 | } |
159 | 159 | |
160 | + /** |
|
161 | + * @param string $category |
|
162 | + * @param string $key |
|
163 | + */ |
|
160 | 164 | function saveSetting($category, $key, $value) { |
161 | 165 | $result = $this->db->query("SELECT count(*) AS the_count FROM config WHERE category = '{$category}' AND name = '{$key}'"); |
162 | 166 | $row = $this->db->fetchByAssoc($result); |
@@ -74,6 +74,7 @@ discard block |
||
74 | 74 | /** |
75 | 75 | * @return string& |
76 | 76 | * @param the_array array, language string, module string |
77 | + * @param string $old_contents |
|
77 | 78 | * @desc Returns the contents of the customized language pack. |
78 | 79 | */ |
79 | 80 | function &create_field_lang_pak_contents($old_contents, $key, $value, $language, $module) |
@@ -346,7 +347,7 @@ discard block |
||
346 | 347 | |
347 | 348 | /** |
348 | 349 | * @return bool |
349 | - * @param dropdown_name string, language string |
|
350 | + * @param dropdown_name string language string |
|
350 | 351 | * @desc Creates a new dropdown type. |
351 | 352 | */ |
352 | 353 | function create_dropdown_type($dropdown_name, $language) |
@@ -549,6 +550,9 @@ discard block |
||
549 | 550 | save_custom_app_list_strings_contents($new_contents, $language); |
550 | 551 | } |
551 | 552 | |
553 | +/** |
|
554 | + * @param string $file_contents |
|
555 | + */ |
|
552 | 556 | function replace_or_add_dropdown_type($dropdown_type, &$dropdown_array, |
553 | 557 | &$file_contents) |
554 | 558 | { |
@@ -580,6 +584,9 @@ discard block |
||
580 | 584 | return $new_contents; |
581 | 585 | } |
582 | 586 | |
587 | +/** |
|
588 | + * @param string $file_contents |
|
589 | + */ |
|
583 | 590 | function replace_or_add_app_string($name, $value, |
584 | 591 | &$file_contents) |
585 | 592 | { |
@@ -123,7 +123,6 @@ |
||
123 | 123 | * to be able to add additional parameters which are currently not supported |
124 | 124 | * in the UI (i.e. additional curl settings for elastic search for auth) |
125 | 125 | * |
126 | - * @param array $config |
|
127 | 126 | * @return array |
128 | 127 | */ |
129 | 128 | protected function mergeFtsConfig($type, $newConfig) |