@@ -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 | { |
@@ -13,6 +13,9 @@ |
||
| 13 | 13 | { |
| 14 | 14 | protected static $realm = 'YetiForceApi'; |
| 15 | 15 | |
| 16 | + /** |
|
| 17 | + * @param \Api\Controller $self |
|
| 18 | + */ |
|
| 16 | 19 | public static function init($self) |
| 17 | 20 | { |
| 18 | 21 | $method = \AppConfig::api('AUTH_METHOD'); |
@@ -61,7 +61,7 @@ |
||
| 61 | 61 | * |
| 62 | 62 | * @throws \Api\Core\Exception |
| 63 | 63 | * |
| 64 | - * @return bool |
|
| 64 | + * @return boolean|null |
|
| 65 | 65 | */ |
| 66 | 66 | public function checkPermission() |
| 67 | 67 | { |
@@ -11,6 +11,9 @@ |
||
| 11 | 11 | */ |
| 12 | 12 | class Exception extends \Exception |
| 13 | 13 | { |
| 14 | + /** |
|
| 15 | + * @param string $message |
|
| 16 | + */ |
|
| 14 | 17 | public function __construct($message, $code = 200, self $previous = null) |
| 15 | 18 | { |
| 16 | 19 | if (!empty($previous)) { |
@@ -32,7 +32,7 @@ discard block |
||
| 32 | 32 | * |
| 33 | 33 | * @throws \Api\Core\Exception |
| 34 | 34 | * |
| 35 | - * @return bool |
|
| 35 | + * @return boolean|null |
|
| 36 | 36 | */ |
| 37 | 37 | public function checkPermission() |
| 38 | 38 | { |
@@ -84,7 +84,7 @@ discard block |
||
| 84 | 84 | * @param int $parentId |
| 85 | 85 | * @param string $type |
| 86 | 86 | * |
| 87 | - * @return bool |
|
| 87 | + * @return boolean|null |
|
| 88 | 88 | */ |
| 89 | 89 | public function getRecords(\App\QueryGenerator $mainQueryGenerator, $parentId, $type = 'child') |
| 90 | 90 | { |
@@ -26,7 +26,7 @@ |
||
| 26 | 26 | /** |
| 27 | 27 | * Put method. |
| 28 | 28 | * |
| 29 | - * @return array |
|
| 29 | + * @return boolean |
|
| 30 | 30 | */ |
| 31 | 31 | public function put() |
| 32 | 32 | { |
@@ -61,7 +61,6 @@ discard block |
||
| 61 | 61 | } |
| 62 | 62 | |
| 63 | 63 | /** |
| 64 | - * @param Users $user |
|
| 65 | 64 | * |
| 66 | 65 | * @return string |
| 67 | 66 | */ |
@@ -156,7 +155,6 @@ discard block |
||
| 156 | 155 | |
| 157 | 156 | /** |
| 158 | 157 | * @param string $date |
| 159 | - * @param Users $user |
|
| 160 | 158 | * |
| 161 | 159 | * @return string |
| 162 | 160 | */ |
@@ -346,6 +344,9 @@ discard block |
||
| 346 | 344 | return $time; |
| 347 | 345 | } |
| 348 | 346 | |
| 347 | + /** |
|
| 348 | + * @param string $value |
|
| 349 | + */ |
|
| 349 | 350 | private static function sanitizeDate($value, $user) |
| 350 | 351 | { |
| 351 | 352 | if (empty($user)) { |