@@ -250,7 +250,7 @@ discard block |
||
| 250 | 250 | * |
| 251 | 251 | * @param ModuleBasic $moduleInstance |
| 252 | 252 | * |
| 253 | - * @return self |
|
| 253 | + * @return boolean |
|
| 254 | 254 | */ |
| 255 | 255 | public static function getAllForModule(ModuleBasic $moduleInstance) |
| 256 | 256 | { |
@@ -309,6 +309,7 @@ discard block |
||
| 309 | 309 | * Function to remove uitype10 fields. |
| 310 | 310 | * |
| 311 | 311 | * @param Module Instance of module |
| 312 | + * @param ModuleBasic $moduleInstance |
|
| 312 | 313 | */ |
| 313 | 314 | public static function deleteUiType10Fields($moduleInstance) |
| 314 | 315 | { |
@@ -329,6 +330,7 @@ discard block |
||
| 329 | 330 | * Function to remove picklist-type or multiple choice picklist-type table. |
| 330 | 331 | * |
| 331 | 332 | * @param Module Instance of module |
| 333 | + * @param ModuleBasic $moduleInstance |
|
| 332 | 334 | */ |
| 333 | 335 | public static function deletePickLists($moduleInstance) |
| 334 | 336 | { |
@@ -125,6 +125,7 @@ |
||
| 125 | 125 | * Create this field instance. |
| 126 | 126 | * |
| 127 | 127 | * @param vtlib\Block Instance of the block to use |
| 128 | + * @param boolean $blockInstance |
|
| 128 | 129 | */ |
| 129 | 130 | public function __create($blockInstance) |
| 130 | 131 | { |
@@ -46,6 +46,7 @@ discard block |
||
| 46 | 46 | * Create this instance. |
| 47 | 47 | * |
| 48 | 48 | * @param Module Instance of the module to which this filter should be associated with |
| 49 | + * @param boolean $moduleInstance |
|
| 49 | 50 | */ |
| 50 | 51 | public function __create($moduleInstance) |
| 51 | 52 | { |
@@ -285,7 +286,7 @@ discard block |
||
| 285 | 286 | * |
| 286 | 287 | * @param ModuleBasic $moduleInstance |
| 287 | 288 | * |
| 288 | - * @return self |
|
| 289 | + * @return boolean |
|
| 289 | 290 | */ |
| 290 | 291 | public static function getAllForModule(ModuleBasic $moduleInstance) |
| 291 | 292 | { |
@@ -229,7 +229,6 @@ discard block |
||
| 229 | 229 | /** |
| 230 | 230 | * Function get module field infos. |
| 231 | 231 | * |
| 232 | - * @param int|string $mixed |
|
| 233 | 232 | * @param bool $returnByColumn |
| 234 | 233 | * |
| 235 | 234 | * @return mixed[] |
@@ -283,6 +282,10 @@ discard block |
||
| 283 | 282 | } |
| 284 | 283 | |
| 285 | 284 | // Utility |
| 285 | + |
|
| 286 | + /** |
|
| 287 | + * @return string |
|
| 288 | + */ |
|
| 286 | 289 | public static function formatDecimal($value) |
| 287 | 290 | { |
| 288 | 291 | $fld_value = explode('.', $value); |
@@ -733,6 +736,9 @@ discard block |
||
| 733 | 736 | * @return <Date> - last working y |
| 734 | 737 | */ |
| 735 | 738 | |
| 739 | + /** |
|
| 740 | + * @param string $date |
|
| 741 | + */ |
|
| 736 | 742 | public static function getLastWorkingDay($date) |
| 737 | 743 | { |
| 738 | 744 | if (empty($date)) { |
@@ -134,6 +134,9 @@ discard block |
||
| 134 | 134 | * |
| 135 | 135 | * NOTE: $url can have variables like $MODULE (module for which link is associated), |
| 136 | 136 | * $RECORD (record on which link is dispalyed) |
| 137 | + * @param string $type |
|
| 138 | + * @param string $label |
|
| 139 | + * @param string $url |
|
| 137 | 140 | */ |
| 138 | 141 | public function addLink($type, $label, $url, $iconpath = '', $sequence = 0, $handlerInfo = null) |
| 139 | 142 | { |
@@ -231,6 +234,7 @@ discard block |
||
| 231 | 234 | * Get instance of the module class. |
| 232 | 235 | * |
| 233 | 236 | * @param string Module name |
| 237 | + * @param string $modulename |
|
| 234 | 238 | */ |
| 235 | 239 | public static function getClassInstance($modulename) |
| 236 | 240 | { |
@@ -274,6 +278,7 @@ discard block |
||
| 274 | 278 | |
| 275 | 279 | /** |
| 276 | 280 | * Toggle the module (enable/disable). |
| 281 | + * @param boolean $enableDisable |
|
| 277 | 282 | */ |
| 278 | 283 | public static function toggleModuleAccess($moduleName, $enableDisable) |
| 279 | 284 | { |
@@ -183,7 +183,7 @@ |
||
| 183 | 183 | if ($tabid === self::IGNORE_MODULE) { |
| 184 | 184 | $permittedTabIdList = \vtlib\Deprecated::getPermittedModuleIdList(); |
| 185 | 185 | if (!empty($permittedTabIdList)) { |
| 186 | - $permittedTabIdList[] = 0; // Added to support one link for all modules |
|
| 186 | + $permittedTabIdList[] = 0; // Added to support one link for all modules |
|
| 187 | 187 | foreach ($permittedTabIdList as $moduleId) { |
| 188 | 188 | foreach ($type as $typ) { |
| 189 | 189 | if (isset($rows[$moduleId][$typ])) { |
@@ -147,6 +147,7 @@ discard block |
||
| 147 | 147 | * Get all the links related to module. |
| 148 | 148 | * |
| 149 | 149 | * @param int Module ID |
| 150 | + * @param boolean $tabid |
|
| 150 | 151 | */ |
| 151 | 152 | public static function getAll($tabid) |
| 152 | 153 | { |
@@ -278,6 +279,7 @@ discard block |
||
| 278 | 279 | |
| 279 | 280 | /** |
| 280 | 281 | * Extract the links of module for export. |
| 282 | + * @param boolean $tabid |
|
| 281 | 283 | */ |
| 282 | 284 | public static function getAllForExport($tabid) |
| 283 | 285 | { |
@@ -21,6 +21,7 @@ discard block |
||
| 21 | 21 | |
| 22 | 22 | /** |
| 23 | 23 | * Initialize Update. |
| 24 | + * @param boolean $overwrite |
|
| 24 | 25 | */ |
| 25 | 26 | public function initUpdate($moduleInstance, $zipfile, $overwrite) |
| 26 | 27 | { |
@@ -167,6 +168,7 @@ discard block |
||
| 167 | 168 | |
| 168 | 169 | /** |
| 169 | 170 | * Handle migration of the module. |
| 171 | + * @param \SimpleXMLElement $modulenode |
|
| 170 | 172 | */ |
| 171 | 173 | public function handleMigration($modulenode, $moduleInstance) |
| 172 | 174 | { |
@@ -197,6 +199,7 @@ discard block |
||
| 197 | 199 | |
| 198 | 200 | /** |
| 199 | 201 | * Update Tables of the module. |
| 202 | + * @param \SimpleXMLElement $modulenode |
|
| 200 | 203 | */ |
| 201 | 204 | public function updateTables($modulenode) |
| 202 | 205 | { |
@@ -205,6 +208,7 @@ discard block |
||
| 205 | 208 | |
| 206 | 209 | /** |
| 207 | 210 | * Update Blocks of the module. |
| 211 | + * @param \SimpleXMLElement $modulenode |
|
| 208 | 212 | */ |
| 209 | 213 | public function updateBlocks($modulenode, $moduleInstance) |
| 210 | 214 | { |
@@ -234,6 +238,7 @@ discard block |
||
| 234 | 238 | |
| 235 | 239 | /** |
| 236 | 240 | * Update Block of the module. |
| 241 | + * @param Block $blockInstance |
|
| 237 | 242 | */ |
| 238 | 243 | public function updateBlock($modulenode, $moduleInstance, $blocknode, $blockInstance) |
| 239 | 244 | { |
@@ -258,6 +263,7 @@ discard block |
||
| 258 | 263 | |
| 259 | 264 | /** |
| 260 | 265 | * Update Fields of the module. |
| 266 | + * @param Block $blockInstance |
|
| 261 | 267 | */ |
| 262 | 268 | public function updateFields($blocknode, $blockInstance, $moduleInstance) |
| 263 | 269 | { |
@@ -286,6 +292,7 @@ discard block |
||
| 286 | 292 | |
| 287 | 293 | /** |
| 288 | 294 | * Update Field of the module. |
| 295 | + * @param Field $fieldInstance |
|
| 289 | 296 | */ |
| 290 | 297 | public function updateField($blocknode, $blockInstance, $moduleInstance, $fieldnode, $fieldInstance) |
| 291 | 298 | { |
@@ -368,6 +375,7 @@ discard block |
||
| 368 | 375 | |
| 369 | 376 | /** |
| 370 | 377 | * Import Custom views of the module. |
| 378 | + * @param \SimpleXMLElement $modulenode |
|
| 371 | 379 | */ |
| 372 | 380 | public function updateCustomViews($modulenode, $moduleInstance) |
| 373 | 381 | { |
@@ -386,6 +394,7 @@ discard block |
||
| 386 | 394 | |
| 387 | 395 | /** |
| 388 | 396 | * Update Custom View of the module. |
| 397 | + * @param Filter $filterInstance |
|
| 389 | 398 | */ |
| 390 | 399 | public function updateCustomView($modulenode, $moduleInstance, $customviewnode, $filterInstance) |
| 391 | 400 | { |
@@ -395,6 +404,7 @@ discard block |
||
| 395 | 404 | |
| 396 | 405 | /** |
| 397 | 406 | * Update Sharing Access of the module. |
| 407 | + * @param \SimpleXMLElement $modulenode |
|
| 398 | 408 | */ |
| 399 | 409 | public function updateSharingAccess($modulenode, $moduleInstance) |
| 400 | 410 | { |
@@ -405,6 +415,7 @@ discard block |
||
| 405 | 415 | |
| 406 | 416 | /** |
| 407 | 417 | * Update Events of the module. |
| 418 | + * @param \SimpleXMLElement $modulenode |
|
| 408 | 419 | */ |
| 409 | 420 | public function updateEvents($modulenode, $moduleInstance) |
| 410 | 421 | { |
@@ -420,6 +431,7 @@ discard block |
||
| 420 | 431 | |
| 421 | 432 | /** |
| 422 | 433 | * Update actions of the module. |
| 434 | + * @param \SimpleXMLElement $modulenode |
|
| 423 | 435 | */ |
| 424 | 436 | public function updateActions($modulenode, $moduleInstance) |
| 425 | 437 | { |
@@ -440,6 +452,7 @@ discard block |
||
| 440 | 452 | |
| 441 | 453 | /** |
| 442 | 454 | * Update related lists of the module. |
| 455 | + * @param \SimpleXMLElement $modulenode |
|
| 443 | 456 | */ |
| 444 | 457 | public function updateRelatedLists($modulenode, $moduleInstance) |
| 445 | 458 | { |
@@ -497,6 +510,9 @@ discard block |
||
| 497 | 510 | return $inRelModuleInstance; |
| 498 | 511 | } |
| 499 | 512 | |
| 513 | + /** |
|
| 514 | + * @param \SimpleXMLElement $modulenode |
|
| 515 | + */ |
|
| 500 | 516 | public function updateCustomLinks($modulenode, $moduleInstance) |
| 501 | 517 | { |
| 502 | 518 | if (empty($modulenode->customlinks) || empty($modulenode->customlinks->customlink)) { |
@@ -506,6 +522,9 @@ discard block |
||
| 506 | 522 | $this->importCustomLinks($modulenode, $moduleInstance); |
| 507 | 523 | } |
| 508 | 524 | |
| 525 | + /** |
|
| 526 | + * @param \SimpleXMLElement $modulenode |
|
| 527 | + */ |
|
| 509 | 528 | public function updateCronTasks($modulenode) |
| 510 | 529 | { |
| 511 | 530 | if (empty($modulenode->crons) || empty($modulenode->crons->cron)) { |
@@ -133,6 +133,8 @@ discard block |
||
| 133 | 133 | * @param string Optional suffix to add during table creation |
| 134 | 134 | * <br /> |
| 135 | 135 | * will be appended to CREATE TABLE $tablename SQL |
| 136 | + * @param string $tablename |
|
| 137 | + * @param string $criteria |
|
| 136 | 138 | */ |
| 137 | 139 | public static function createTable($tablename, $criteria, $suffixTableMeta = false) |
| 138 | 140 | { |
@@ -212,6 +214,7 @@ discard block |
||
| 212 | 214 | * Check if the given SQL is a CREATE statement. |
| 213 | 215 | * |
| 214 | 216 | * @param string SQL String |
| 217 | + * @param string $sql |
|
| 215 | 218 | */ |
| 216 | 219 | public static function isCreateSql($sql) |
| 217 | 220 | { |
@@ -112,6 +112,7 @@ |
||
| 112 | 112 | |
| 113 | 113 | /** |
| 114 | 114 | * Clean up the input to be used as a regex. |
| 115 | + * @param string $value |
|
| 115 | 116 | */ |
| 116 | 117 | public function __formatAsRegex($value) |
| 117 | 118 | { |