@@ -146,6 +146,7 @@ |
||
| 146 | 146 | /** |
| 147 | 147 | * Create this field instance |
| 148 | 148 | * @param vtlib\Block Instance of the block to use |
| 149 | + * @param boolean $blockInstance |
|
| 149 | 150 | * @access private |
| 150 | 151 | */ |
| 151 | 152 | public function __create($blockInstance) |
@@ -56,6 +56,7 @@ discard block |
||
| 56 | 56 | /** |
| 57 | 57 | * Create this instance |
| 58 | 58 | * @param Module Instance of the module to which this filter should be associated with |
| 59 | + * @param boolean $moduleInstance |
|
| 59 | 60 | * @access private |
| 60 | 61 | */ |
| 61 | 62 | public function __create($moduleInstance) |
@@ -312,6 +313,7 @@ discard block |
||
| 312 | 313 | /** |
| 313 | 314 | * Delete filter associated for module |
| 314 | 315 | * @param Module Instance of module |
| 316 | + * @param ModuleBasic $moduleInstance |
|
| 315 | 317 | */ |
| 316 | 318 | static function deleteForModule($moduleInstance) |
| 317 | 319 | { |
@@ -132,6 +132,7 @@ discard block |
||
| 132 | 132 | /** |
| 133 | 133 | * Delete all links related to module |
| 134 | 134 | * @param Integer Module ID. |
| 135 | + * @param boolean $tabid |
|
| 135 | 136 | */ |
| 136 | 137 | static function deleteAll($tabid) |
| 137 | 138 | { |
@@ -143,6 +144,7 @@ discard block |
||
| 143 | 144 | /** |
| 144 | 145 | * Get all the links related to module |
| 145 | 146 | * @param Integer Module ID. |
| 147 | + * @param boolean $tabid |
|
| 146 | 148 | */ |
| 147 | 149 | static function getAll($tabid) |
| 148 | 150 | { |
@@ -234,6 +236,7 @@ discard block |
||
| 234 | 236 | |
| 235 | 237 | /** |
| 236 | 238 | * Extract the links of module for export. |
| 239 | + * @param boolean $tabid |
|
| 237 | 240 | */ |
| 238 | 241 | static function getAllForExport($tabid) |
| 239 | 242 | { |
@@ -89,6 +89,7 @@ discard block |
||
| 89 | 89 | /** |
| 90 | 90 | * Initialize this instance using mail template |
| 91 | 91 | * @access private |
| 92 | + * @param boolean $emailtemplate |
|
| 92 | 93 | */ |
| 93 | 94 | public function initFromTemplate($emailtemplate) |
| 94 | 95 | { |
@@ -187,6 +188,7 @@ discard block |
||
| 187 | 188 | |
| 188 | 189 | /** |
| 189 | 190 | * Add this mail to queue |
| 191 | + * @param boolean $linktoid |
|
| 190 | 192 | */ |
| 191 | 193 | public function __AddToQueue($linktoid) |
| 192 | 194 | { |
@@ -225,7 +227,7 @@ discard block |
||
| 225 | 227 | |
| 226 | 228 | /** |
| 227 | 229 | * Function to prepares email as string |
| 228 | - * @return type |
|
| 230 | + * @return string |
|
| 229 | 231 | */ |
| 230 | 232 | public function getMailString() |
| 231 | 233 | { |
@@ -321,6 +321,7 @@ discard block |
||
| 321 | 321 | /** |
| 322 | 322 | * Set entity identifier field for this module |
| 323 | 323 | * @param Field Instance of field to use |
| 324 | + * @param Field $fieldInstance |
|
| 324 | 325 | */ |
| 325 | 326 | public function setEntityIdentifier($fieldInstance) |
| 326 | 327 | { |
@@ -397,6 +398,7 @@ discard block |
||
| 397 | 398 | /** |
| 398 | 399 | * Disable tools for this module |
| 399 | 400 | * @param mixed String or Array with value ['Import', 'Export', 'Merge'] |
| 401 | + * @param string $tools |
|
| 400 | 402 | */ |
| 401 | 403 | public function disableTools($tools) |
| 402 | 404 | { |
@@ -411,6 +413,7 @@ discard block |
||
| 411 | 413 | /** |
| 412 | 414 | * Add block to this module |
| 413 | 415 | * @param vtlib\Block Instance of block to add |
| 416 | + * @param Block $blockInstance |
|
| 414 | 417 | */ |
| 415 | 418 | public function addBlock($blockInstance) |
| 416 | 419 | { |
@@ -421,6 +424,7 @@ discard block |
||
| 421 | 424 | /** |
| 422 | 425 | * Add filter to this module |
| 423 | 426 | * @param vtlib\Filter Instance of filter to add |
| 427 | + * @param Filter $filterInstance |
|
| 424 | 428 | */ |
| 425 | 429 | public function addFilter($filterInstance) |
| 426 | 430 | { |
@@ -552,7 +556,6 @@ discard block |
||
| 552 | 556 | |
| 553 | 557 | /** |
| 554 | 558 | * Function to remove files related to a module |
| 555 | - * @param string $path - dir path |
|
| 556 | 559 | */ |
| 557 | 560 | public function deleteDir($moduleInstance) |
| 558 | 561 | { |
@@ -25,6 +25,7 @@ |
||
| 25 | 25 | * @param String URL of the site |
| 26 | 26 | * Example: |
| 27 | 27 | * $client = new Vtiger_New_Client('http://www.vtiger.com'); |
| 28 | + * @param string|false $url |
|
| 28 | 29 | */ |
| 29 | 30 | public function __construct($url) |
| 30 | 31 | { |
@@ -53,6 +53,7 @@ discard block |
||
| 53 | 53 | |
| 54 | 54 | /** |
| 55 | 55 | * Get type of package (as specified in manifest) |
| 56 | + * @return string |
|
| 56 | 57 | */ |
| 57 | 58 | public function type() |
| 58 | 59 | { |
@@ -393,6 +394,7 @@ discard block |
||
| 393 | 394 | /** |
| 394 | 395 | * Cache the field instance for re-use |
| 395 | 396 | * @access private |
| 397 | + * @param Field $fieldInstance |
|
| 396 | 398 | */ |
| 397 | 399 | public function __AddModuleFieldToCache($moduleInstance, $fieldname, $fieldInstance) |
| 398 | 400 | { |
@@ -674,6 +676,8 @@ discard block |
||
| 674 | 676 | /** |
| 675 | 677 | * Import Blocks of the module |
| 676 | 678 | * @access private |
| 679 | + * @param \SimpleXMLElement $modulenode |
|
| 680 | + * @param Module $moduleInstance |
|
| 677 | 681 | */ |
| 678 | 682 | public function import_Blocks($modulenode, $moduleInstance) |
| 679 | 683 | { |
@@ -717,6 +721,7 @@ discard block |
||
| 717 | 721 | /** |
| 718 | 722 | * Import Fields of the module |
| 719 | 723 | * @access private |
| 724 | + * @param Block $blockInstance |
|
| 720 | 725 | */ |
| 721 | 726 | public function import_Fields($blocknode, $blockInstance, $moduleInstance) |
| 722 | 727 | { |
@@ -807,6 +812,8 @@ discard block |
||
| 807 | 812 | /** |
| 808 | 813 | * Import Custom views of the module |
| 809 | 814 | * @access private |
| 815 | + * @param \SimpleXMLElement $modulenode |
|
| 816 | + * @param Module $moduleInstance |
|
| 810 | 817 | */ |
| 811 | 818 | public function import_CustomViews($modulenode, $moduleInstance) |
| 812 | 819 | { |
@@ -851,6 +858,8 @@ discard block |
||
| 851 | 858 | /** |
| 852 | 859 | * Import Sharing Access of the module |
| 853 | 860 | * @access private |
| 861 | + * @param \SimpleXMLElement $modulenode |
|
| 862 | + * @param Module $moduleInstance |
|
| 854 | 863 | */ |
| 855 | 864 | public function import_SharingAccess($modulenode, $moduleInstance) |
| 856 | 865 | { |
@@ -867,6 +876,8 @@ discard block |
||
| 867 | 876 | /** |
| 868 | 877 | * Import Events of the module |
| 869 | 878 | * @access private |
| 879 | + * @param \SimpleXMLElement $modulenode |
|
| 880 | + * @param Module $moduleInstance |
|
| 870 | 881 | */ |
| 871 | 882 | public function import_Events($modulenode, $moduleInstance) |
| 872 | 883 | { |
@@ -899,6 +910,8 @@ discard block |
||
| 899 | 910 | /** |
| 900 | 911 | * Import actions of the module |
| 901 | 912 | * @access private |
| 913 | + * @param \SimpleXMLElement $modulenode |
|
| 914 | + * @param Module $moduleInstance |
|
| 902 | 915 | */ |
| 903 | 916 | public function import_Actions($modulenode, $moduleInstance) |
| 904 | 917 | { |
@@ -925,6 +938,8 @@ discard block |
||
| 925 | 938 | /** |
| 926 | 939 | * Import related lists of the module |
| 927 | 940 | * @access private |
| 941 | + * @param \SimpleXMLElement $modulenode |
|
| 942 | + * @param Module $moduleInstance |
|
| 928 | 943 | */ |
| 929 | 944 | public function import_RelatedLists($modulenode, $moduleInstance) |
| 930 | 945 | { |
@@ -1004,6 +1019,7 @@ discard block |
||
| 1004 | 1019 | /** |
| 1005 | 1020 | * Import cron jobs of the module. |
| 1006 | 1021 | * @access private |
| 1022 | + * @param \SimpleXMLElement $modulenode |
|
| 1007 | 1023 | */ |
| 1008 | 1024 | public function import_CronTasks($modulenode) |
| 1009 | 1025 | { |
@@ -1022,6 +1038,9 @@ discard block |
||
| 1022 | 1038 | } |
| 1023 | 1039 | } |
| 1024 | 1040 | |
| 1041 | + /** |
|
| 1042 | + * @param \SimpleXMLElement $modulenode |
|
| 1043 | + */ |
|
| 1025 | 1044 | public function import_update($modulenode) |
| 1026 | 1045 | { |
| 1027 | 1046 | $dirName = 'cache/updates'; |
@@ -23,6 +23,7 @@ discard block |
||
| 23 | 23 | /** |
| 24 | 24 | * Initialize Update |
| 25 | 25 | * @access private |
| 26 | + * @param boolean $overwrite |
|
| 26 | 27 | */ |
| 27 | 28 | public function initUpdate($moduleInstance, $zipfile, $overwrite) |
| 28 | 29 | { |
@@ -185,6 +186,7 @@ discard block |
||
| 185 | 186 | /** |
| 186 | 187 | * Handle migration of the module |
| 187 | 188 | * @access private |
| 189 | + * @param \SimpleXMLElement $modulenode |
|
| 188 | 190 | */ |
| 189 | 191 | public function handle_Migration($modulenode, $moduleInstance) |
| 190 | 192 | { |
@@ -218,6 +220,7 @@ discard block |
||
| 218 | 220 | /** |
| 219 | 221 | * Update Tables of the module |
| 220 | 222 | * @access private |
| 223 | + * @param \SimpleXMLElement $modulenode |
|
| 221 | 224 | */ |
| 222 | 225 | public function update_Tables($modulenode) |
| 223 | 226 | { |
@@ -227,6 +230,7 @@ discard block |
||
| 227 | 230 | /** |
| 228 | 231 | * Update Blocks of the module |
| 229 | 232 | * @access private |
| 233 | + * @param \SimpleXMLElement $modulenode |
|
| 230 | 234 | */ |
| 231 | 235 | public function update_Blocks($modulenode, $moduleInstance) |
| 232 | 236 | { |
@@ -308,6 +312,7 @@ discard block |
||
| 308 | 312 | /** |
| 309 | 313 | * Update Field of the module |
| 310 | 314 | * @access private |
| 315 | + * @param Field $fieldInstance |
|
| 311 | 316 | */ |
| 312 | 317 | public function update_Field($blocknode, $blockInstance, $moduleInstance, $fieldnode, $fieldInstance) |
| 313 | 318 | { |
@@ -387,6 +392,7 @@ discard block |
||
| 387 | 392 | /** |
| 388 | 393 | * Import Custom views of the module |
| 389 | 394 | * @access private |
| 395 | + * @param \SimpleXMLElement $modulenode |
|
| 390 | 396 | */ |
| 391 | 397 | public function update_CustomViews($modulenode, $moduleInstance) |
| 392 | 398 | { |
@@ -405,6 +411,7 @@ discard block |
||
| 405 | 411 | /** |
| 406 | 412 | * Update Custom View of the module |
| 407 | 413 | * @access private |
| 414 | + * @param Filter $filterInstance |
|
| 408 | 415 | */ |
| 409 | 416 | public function update_CustomView($modulenode, $moduleInstance, $customviewnode, $filterInstance) |
| 410 | 417 | { |
@@ -416,6 +423,7 @@ discard block |
||
| 416 | 423 | /** |
| 417 | 424 | * Update Sharing Access of the module |
| 418 | 425 | * @access private |
| 426 | + * @param \SimpleXMLElement $modulenode |
|
| 419 | 427 | */ |
| 420 | 428 | public function update_SharingAccess($modulenode, $moduleInstance) |
| 421 | 429 | { |
@@ -428,6 +436,7 @@ discard block |
||
| 428 | 436 | /** |
| 429 | 437 | * Update Events of the module |
| 430 | 438 | * @access private |
| 439 | + * @param \SimpleXMLElement $modulenode |
|
| 431 | 440 | */ |
| 432 | 441 | public function update_Events($modulenode, $moduleInstance) |
| 433 | 442 | { |
@@ -460,6 +469,7 @@ discard block |
||
| 460 | 469 | /** |
| 461 | 470 | * Update actions of the module |
| 462 | 471 | * @access private |
| 472 | + * @param \SimpleXMLElement $modulenode |
|
| 463 | 473 | */ |
| 464 | 474 | public function update_Actions($modulenode, $moduleInstance) |
| 465 | 475 | { |
@@ -482,6 +492,7 @@ discard block |
||
| 482 | 492 | /** |
| 483 | 493 | * Update related lists of the module |
| 484 | 494 | * @access private |
| 495 | + * @param \SimpleXMLElement $modulenode |
|
| 485 | 496 | */ |
| 486 | 497 | public function update_RelatedLists($modulenode, $moduleInstance) |
| 487 | 498 | { |
@@ -538,6 +549,9 @@ discard block |
||
| 538 | 549 | return $inRelModuleInstance; |
| 539 | 550 | } |
| 540 | 551 | |
| 552 | + /** |
|
| 553 | + * @param \SimpleXMLElement $modulenode |
|
| 554 | + */ |
|
| 541 | 555 | public function update_CustomLinks($modulenode, $moduleInstance) |
| 542 | 556 | { |
| 543 | 557 | if (empty($modulenode->customlinks) || empty($modulenode->customlinks->customlink)) |
@@ -546,6 +560,9 @@ discard block |
||
| 546 | 560 | $this->import_CustomLinks($modulenode, $moduleInstance); |
| 547 | 561 | } |
| 548 | 562 | |
| 563 | + /** |
|
| 564 | + * @param \SimpleXMLElement $modulenode |
|
| 565 | + */ |
|
| 549 | 566 | public function update_CronTasks($modulenode) |
| 550 | 567 | { |
| 551 | 568 | if (empty($modulenode->crons) || empty($modulenode->crons->cron)) |
@@ -66,6 +66,7 @@ discard block |
||
| 66 | 66 | * Helper function to log messages |
| 67 | 67 | * @param String Message to log |
| 68 | 68 | * @param Boolean true appends linebreak, false to avoid it |
| 69 | + * @param string $message |
|
| 69 | 70 | * @access private |
| 70 | 71 | */ |
| 71 | 72 | static function log($message, $delimit = true) |
@@ -76,6 +77,7 @@ discard block |
||
| 76 | 77 | /** |
| 77 | 78 | * Initialize profile setup for Field |
| 78 | 79 | * @param Field Instance of the field |
| 80 | + * @param FieldBasic $fieldInstance |
|
| 79 | 81 | * @access private |
| 80 | 82 | */ |
| 81 | 83 | static function initForField($fieldInstance) |
@@ -94,6 +96,7 @@ discard block |
||
| 94 | 96 | /** |
| 95 | 97 | * Delete profile information related with field. |
| 96 | 98 | * @param Field Instance of the field |
| 99 | + * @param FieldBasic $fieldInstance |
|
| 97 | 100 | * @access private |
| 98 | 101 | */ |
| 99 | 102 | static function deleteForField($fieldInstance) |
@@ -122,6 +125,7 @@ discard block |
||
| 122 | 125 | /** |
| 123 | 126 | * Initialize profile setup for the module |
| 124 | 127 | * @param Module Instance of module |
| 128 | + * @param ModuleBasic $moduleInstance |
|
| 125 | 129 | * @access private |
| 126 | 130 | */ |
| 127 | 131 | static function initForModule($moduleInstance) |