@@ -507,6 +507,10 @@ |
||
| 507 | 507 | } |
| 508 | 508 | |
| 509 | 509 | // Function to Upate the Used Units of the Service Contract. |
| 510 | + |
|
| 511 | + /** |
|
| 512 | + * @param integer $usedUnits |
|
| 513 | + */ |
|
| 510 | 514 | public function updateUsedUnits($usedUnits) |
| 511 | 515 | { |
| 512 | 516 | $this->column_fields['used_units'] = $usedUnits; |
@@ -60,6 +60,9 @@ discard block |
||
| 60 | 60 | } |
| 61 | 61 | } |
| 62 | 62 | |
| 63 | + /** |
|
| 64 | + * @param string $stage |
|
| 65 | + */ |
|
| 63 | 66 | public function updateProgress($stage, $value, $time = 0) |
| 64 | 67 | { |
| 65 | 68 | $adb = PearDatabase::getInstance(); |
@@ -240,6 +243,10 @@ discard block |
||
| 240 | 243 | $log->debug('End ' . __CLASS__ . ':' . __FUNCTION__); |
| 241 | 244 | } |
| 242 | 245 | |
| 246 | + /** |
|
| 247 | + * @param string $search |
|
| 248 | + * @param string $insert |
|
| 249 | + */ |
|
| 243 | 250 | public function strInsert($str, $search, $insert) |
| 244 | 251 | { |
| 245 | 252 | $index = strpos($str, $search); |
@@ -261,6 +268,9 @@ discard block |
||
| 261 | 268 | } |
| 262 | 269 | } |
| 263 | 270 | |
| 271 | + /** |
|
| 272 | + * @param double $time |
|
| 273 | + */ |
|
| 264 | 274 | public function updateDBPrecent($time) |
| 265 | 275 | { |
| 266 | 276 | $db = PearDatabase::getInstance(); |
@@ -503,6 +513,9 @@ discard block |
||
| 503 | 513 | $this->updateProgress('7', 100, self::getTime() - $start); |
| 504 | 514 | } |
| 505 | 515 | |
| 516 | + /** |
|
| 517 | + * @param integer $limit |
|
| 518 | + */ |
|
| 506 | 519 | public function getBackupList($offset = null, $limit = null) |
| 507 | 520 | { |
| 508 | 521 | $db = PearDatabase::getInstance(); |
@@ -570,6 +583,9 @@ discard block |
||
| 570 | 583 | return $data; |
| 571 | 584 | } |
| 572 | 585 | |
| 586 | + /** |
|
| 587 | + * @param string $type |
|
| 588 | + */ |
|
| 573 | 589 | public static function getConfig($type) |
| 574 | 590 | { |
| 575 | 591 | $db = PearDatabase::getInstance(); |
@@ -671,6 +687,9 @@ discard block |
||
| 671 | 687 | return $output; |
| 672 | 688 | } |
| 673 | 689 | |
| 690 | + /** |
|
| 691 | + * @param string $action |
|
| 692 | + */ |
|
| 674 | 693 | public function encrypt_decrypt($action, $string) |
| 675 | 694 | { |
| 676 | 695 | $output = false; |
@@ -690,6 +709,10 @@ discard block |
||
| 690 | 709 | return $output; |
| 691 | 710 | } |
| 692 | 711 | |
| 712 | + /** |
|
| 713 | + * @param boolean $status |
|
| 714 | + * @param boolean $active |
|
| 715 | + */ |
|
| 693 | 716 | public function saveFTPSettings($host, $login, $password, $status, $port, $active, $path) |
| 694 | 717 | { |
| 695 | 718 | $password = self::encrypt_decrypt('encrypt', $password); |
@@ -52,7 +52,7 @@ discard block |
||
| 52 | 52 | |
| 53 | 53 | /** |
| 54 | 54 | * Function to get CompanyDetails Menu item |
| 55 | - * @return menu item Model |
|
| 55 | + * @return Settings_Vtiger_MenuItem_Model item Model |
|
| 56 | 56 | */ |
| 57 | 57 | public function getMenuItem() |
| 58 | 58 | { |
@@ -90,6 +90,7 @@ discard block |
||
| 90 | 90 | |
| 91 | 91 | /** |
| 92 | 92 | * Function to get Logo path to display |
| 93 | + * @param string $name |
|
| 93 | 94 | * @return <String> path |
| 94 | 95 | */ |
| 95 | 96 | public function getLogoPath($name) |
@@ -110,6 +111,7 @@ discard block |
||
| 110 | 111 | |
| 111 | 112 | /** |
| 112 | 113 | * Function to save the logoinfo |
| 114 | + * @param string $name |
|
| 113 | 115 | */ |
| 114 | 116 | public function saveLogo($name) |
| 115 | 117 | { |
@@ -750,7 +750,7 @@ discard block |
||
| 750 | 750 | |
| 751 | 751 | /** |
| 752 | 752 | * Function to get the date values for the given type of Standard filter |
| 753 | - * @param <String> $type |
|
| 753 | + * @param string $type |
|
| 754 | 754 | * @return <Array> - 2 date values representing the range for the given type of Standard filter |
| 755 | 755 | */ |
| 756 | 756 | protected static function getDateForStdFilterBytype($type) |
@@ -849,7 +849,6 @@ discard block |
||
| 849 | 849 | |
| 850 | 850 | /** |
| 851 | 851 | * Function to retrieve field model for specific block and module |
| 852 | - * @param <Vtiger_Module_Model> $blockModel - block instance |
|
| 853 | 852 | * @return <array> List of field model |
| 854 | 853 | */ |
| 855 | 854 | public static function getAllForModule($moduleModel) |
@@ -120,8 +120,6 @@ discard block |
||
| 120 | 120 | |
| 121 | 121 | /** |
| 122 | 122 | * Get discount from the account |
| 123 | - * @param string $moduleName Module name |
|
| 124 | - * @param int $record Record ID |
|
| 125 | 123 | * @return array |
| 126 | 124 | */ |
| 127 | 125 | public function getAccountDiscount($relatedRecord) |
@@ -165,7 +163,6 @@ discard block |
||
| 165 | 163 | |
| 166 | 164 | /** |
| 167 | 165 | * Active inventory blocks |
| 168 | - * @param string $moduleName Module name |
|
| 169 | 166 | * @return string/false |
| 170 | 167 | */ |
| 171 | 168 | public function setInventoryTable($type) |
@@ -105,6 +105,9 @@ |
||
| 105 | 105 | return self::$moduleDescribeCache[$module]; |
| 106 | 106 | } |
| 107 | 107 | |
| 108 | + /** |
|
| 109 | + * @param string $module |
|
| 110 | + */ |
|
| 108 | 111 | static function getFieldInfo($module, $fieldname) |
| 109 | 112 | { |
| 110 | 113 | $describe = self::getModuleDescribe($module); |
@@ -280,6 +280,10 @@ discard block |
||
| 280 | 280 | } |
| 281 | 281 | |
| 282 | 282 | // Private (you should NOT call these methods): |
| 283 | + |
|
| 284 | + /** |
|
| 285 | + * @param string $content |
|
| 286 | + */ |
|
| 283 | 287 | public function uncompress($content, $mode, $uncompressedSize, $targetFileName = false) |
| 284 | 288 | { |
| 285 | 289 | switch ($mode) { |
@@ -328,6 +332,9 @@ discard block |
||
| 328 | 332 | } |
| 329 | 333 | } |
| 330 | 334 | |
| 335 | + /** |
|
| 336 | + * @param integer $level |
|
| 337 | + */ |
|
| 331 | 338 | public function debugMsg($level, $string) |
| 332 | 339 | { |
| 333 | 340 | if ($this->debug) |
@@ -80,7 +80,7 @@ discard block |
||
| 80 | 80 | var $fileName; |
| 81 | 81 | var $compressedList; // You will problably use only this one! |
| 82 | 82 | var $centralDirList; // Central dir list... It's a kind of 'extra attributes' for a set of files |
| 83 | - var $endOfCentral; // End of central dir, contains ZIP Comments |
|
| 83 | + var $endOfCentral; // End of central dir, contains ZIP Comments |
|
| 84 | 84 | var $debug; |
| 85 | 85 | // Private |
| 86 | 86 | var $fh; |
@@ -188,15 +188,13 @@ discard block |
||
| 188 | 188 | { |
| 189 | 189 | return |
| 190 | 190 | isset($this->centralDirList[$compressedFileName]) ? |
| 191 | - $this->centralDirList[$compressedFileName] : |
|
| 192 | - false; |
|
| 191 | + $this->centralDirList[$compressedFileName] : false; |
|
| 193 | 192 | } |
| 194 | 193 | |
| 195 | 194 | public function getZipInfo($detail = false) |
| 196 | 195 | { |
| 197 | 196 | return $detail ? |
| 198 | - $this->endOfCentral[$detail] : |
|
| 199 | - $this->endOfCentral; |
|
| 197 | + $this->endOfCentral[$detail] : $this->endOfCentral; |
|
| 200 | 198 | } |
| 201 | 199 | |
| 202 | 200 | public function unzip($compressedFileName, $targetFileName = false, $applyChmod = 0644) |
@@ -218,8 +216,7 @@ discard block |
||
| 218 | 216 | if (!$fdetails['uncompressed_size']) { |
| 219 | 217 | $this->debugMsg(1, "File '<b>$compressedFileName</b>' is empty."); |
| 220 | 218 | return $targetFileName ? |
| 221 | - file_put_contents($targetFileName, "") : |
|
| 222 | - ""; |
|
| 219 | + file_put_contents($targetFileName, "") : ""; |
|
| 223 | 220 | } |
| 224 | 221 | |
| 225 | 222 | fseek($this->fh, $fdetails['contents-startOffset']); |
@@ -263,8 +260,7 @@ discard block |
||
| 263 | 260 | continue; |
| 264 | 261 | |
| 265 | 262 | $maintainStructure ? |
| 266 | - $this->unzip($fileName, "$targetDir/$fileName", $applyChmod) : |
|
| 267 | - $this->unzip($fileName, "$targetDir/" . basename($fileName), $applyChmod); |
|
| 263 | + $this->unzip($fileName, "$targetDir/$fileName", $applyChmod) : $this->unzip($fileName, "$targetDir/" . basename($fileName), $applyChmod); |
|
| 268 | 264 | } |
| 269 | 265 | } |
| 270 | 266 | |
@@ -286,8 +282,7 @@ discard block |
||
| 286 | 282 | case 0: |
| 287 | 283 | // Not compressed |
| 288 | 284 | return $targetFileName ? |
| 289 | - file_put_contents($targetFileName, $content) : |
|
| 290 | - $content; |
|
| 285 | + file_put_contents($targetFileName, $content) : $content; |
|
| 291 | 286 | case 1: |
| 292 | 287 | $this->debugMsg(2, "Shrunk mode is not supported... yet?"); |
| 293 | 288 | return false; |
@@ -306,8 +301,7 @@ discard block |
||
| 306 | 301 | case 8: |
| 307 | 302 | // Deflate |
| 308 | 303 | return $targetFileName ? |
| 309 | - file_put_contents($targetFileName, gzinflate($content, $uncompressedSize)) : |
|
| 310 | - gzinflate($content, $uncompressedSize); |
|
| 304 | + file_put_contents($targetFileName, gzinflate($content, $uncompressedSize)) : gzinflate($content, $uncompressedSize); |
|
| 311 | 305 | case 9: |
| 312 | 306 | $this->debugMsg(2, "Enhanced Deflating is not supported... yet?"); |
| 313 | 307 | return false; |
@@ -317,8 +311,7 @@ discard block |
||
| 317 | 311 | case 12: |
| 318 | 312 | // Bzip2 |
| 319 | 313 | return $targetFileName ? |
| 320 | - file_put_contents($targetFileName, bzdecompress($content)) : |
|
| 321 | - bzdecompress($content); |
|
| 314 | + file_put_contents($targetFileName, bzdecompress($content)) : bzdecompress($content); |
|
| 322 | 315 | case 18: |
| 323 | 316 | $this->debugMsg(2, "IBM TERSE is not supported... yet?"); |
| 324 | 317 | return false; |
@@ -378,7 +371,7 @@ discard block |
||
| 378 | 371 | $dir['compression_method'] = unpack("v", fread($fh, 2)); // compression method |
| 379 | 372 | $dir['lastmod_time'] = unpack("v", fread($fh, 2)); // last mod file time |
| 380 | 373 | $dir['lastmod_date'] = unpack("v", fread($fh, 2)); // last mod file date |
| 381 | - $dir['crc-32'] = fread($fh, 4); // crc-32 |
|
| 374 | + $dir['crc-32'] = fread($fh, 4); // crc-32 |
|
| 382 | 375 | $dir['compressed_size'] = unpack("V", fread($fh, 4)); // compressed size |
| 383 | 376 | $dir['uncompressed_size'] = unpack("V", fread($fh, 4)); // uncompressed size |
| 384 | 377 | $fileNameLength = unpack("v", fread($fh, 2)); // filename length |
@@ -389,7 +382,7 @@ discard block |
||
| 389 | 382 | $dir['external_attributes1'] = unpack("v", fread($fh, 2)); // external file attributes-byte2 |
| 390 | 383 | $dir['external_attributes2'] = unpack("v", fread($fh, 2)); // external file attributes |
| 391 | 384 | $dir['relative_offset'] = unpack("V", fread($fh, 4)); // relative offset of local header |
| 392 | - $dir['file_name'] = fread($fh, $fileNameLength[1]); // filename |
|
| 385 | + $dir['file_name'] = fread($fh, $fileNameLength[1]); // filename |
|
| 393 | 386 | $dir['extra_field'] = $extraFieldLength[1] ? fread($fh, $extraFieldLength[1]) : ''; // extra field |
| 394 | 387 | $dir['file_comment'] = $fileCommentLength[1] ? fread($fh, $fileCommentLength[1]) : ''; // file comment |
| 395 | 388 | // Convert the date and time, from MS-DOS format to UNIX Timestamp |
@@ -489,7 +482,7 @@ discard block |
||
| 489 | 482 | $file['compression_method'] = unpack("v", fread($fh, 2)); // compression method |
| 490 | 483 | $file['lastmod_time'] = unpack("v", fread($fh, 2)); // last mod file time |
| 491 | 484 | $file['lastmod_date'] = unpack("v", fread($fh, 2)); // last mod file date |
| 492 | - $file['crc-32'] = fread($fh, 4); // crc-32 |
|
| 485 | + $file['crc-32'] = fread($fh, 4); // crc-32 |
|
| 493 | 486 | $file['compressed_size'] = unpack("V", fread($fh, 4)); // compressed size |
| 494 | 487 | $file['uncompressed_size'] = unpack("V", fread($fh, 4)); // uncompressed size |
| 495 | 488 | $fileNameLength = unpack("v", fread($fh, 2)); // filename length |
@@ -469,7 +469,7 @@ |
||
| 469 | 469 | * and return it's value. |
| 470 | 470 | * |
| 471 | 471 | * @access public |
| 472 | - * @param string $opionName The name of the option to retrieve |
|
| 472 | + * @param string $optionName The name of the option to retrieve |
|
| 473 | 473 | * @see $this->options |
| 474 | 474 | */ |
| 475 | 475 | public function getOption($optionName) |
@@ -508,6 +508,7 @@ discard block |
||
| 508 | 508 | * Removes a request header |
| 509 | 509 | * |
| 510 | 510 | * @param string Header name to remove |
| 511 | + * @param string $name |
|
| 511 | 512 | * @access public |
| 512 | 513 | */ |
| 513 | 514 | public function removeHeader($name) |
@@ -564,6 +565,7 @@ discard block |
||
| 564 | 565 | * |
| 565 | 566 | * @param mixed Callback function |
| 566 | 567 | * @param mixed Value to process |
| 568 | + * @param string $callback |
|
| 567 | 569 | * @access private |
| 568 | 570 | * @return mixed Processed value |
| 569 | 571 | */ |
@@ -620,6 +622,7 @@ discard block |
||
| 620 | 622 | * |
| 621 | 623 | * @param string The data |
| 622 | 624 | * @param bool Whether data is preencoded or not, default = already encoded |
| 625 | + * @param string $postdata |
|
| 623 | 626 | * @access public |
| 624 | 627 | * @deprecated deprecated since 1.3.0, method setBody() should be used instead |
| 625 | 628 | */ |
@@ -838,7 +841,7 @@ discard block |
||
| 838 | 841 | * Returns the response code |
| 839 | 842 | * |
| 840 | 843 | * @access public |
| 841 | - * @return mixed Response code, false if not set |
|
| 844 | + * @return string|false Response code, false if not set |
|
| 842 | 845 | */ |
| 843 | 846 | public function getResponseCode() |
| 844 | 847 | { |
@@ -849,7 +852,7 @@ discard block |
||
| 849 | 852 | * Returns the response reason phrase |
| 850 | 853 | * |
| 851 | 854 | * @access public |
| 852 | - * @return mixed Response reason phrase, false if not set |
|
| 855 | + * @return string|false Response reason phrase, false if not set |
|
| 853 | 856 | */ |
| 854 | 857 | public function getResponseReason() |
| 855 | 858 | { |
@@ -878,7 +881,7 @@ discard block |
||
| 878 | 881 | * Returns the body of the response |
| 879 | 882 | * |
| 880 | 883 | * @access public |
| 881 | - * @return mixed response body, false if not set |
|
| 884 | + * @return string|false response body, false if not set |
|
| 882 | 885 | */ |
| 883 | 886 | public function getResponseBody() |
| 884 | 887 | { |
@@ -1021,6 +1024,7 @@ discard block |
||
| 1021 | 1024 | * |
| 1022 | 1025 | * @param string name for item |
| 1023 | 1026 | * @param mixed item's values |
| 1027 | + * @param string $name |
|
| 1024 | 1028 | * @return array array with the following items: array('item name', 'item value'); |
| 1025 | 1029 | * @access private |
| 1026 | 1030 | */ |
@@ -1094,6 +1098,7 @@ discard block |
||
| 1094 | 1098 | * |
| 1095 | 1099 | * @param string Event name |
| 1096 | 1100 | * @param mixed Additional data |
| 1101 | + * @param string $event |
|
| 1097 | 1102 | * @access private |
| 1098 | 1103 | * @see HTTP_Request::attach() |
| 1099 | 1104 | */ |
@@ -1310,6 +1315,7 @@ discard block |
||
| 1310 | 1315 | * |
| 1311 | 1316 | * @access private |
| 1312 | 1317 | * @param string value of Set-Cookie header |
| 1318 | + * @param string $headervalue |
|
| 1313 | 1319 | */ |
| 1314 | 1320 | public function _parseCookie($headervalue) |
| 1315 | 1321 | { |
@@ -1390,6 +1396,7 @@ discard block |
||
| 1390 | 1396 | * |
| 1391 | 1397 | * @param string Event name |
| 1392 | 1398 | * @param mixed Additional data |
| 1399 | + * @param string $event |
|
| 1393 | 1400 | * @access private |
| 1394 | 1401 | * @see HTTP_Request::_notify() |
| 1395 | 1402 | */ |
@@ -1409,6 +1416,7 @@ discard block |
||
| 1409 | 1416 | * |
| 1410 | 1417 | * @access private |
| 1411 | 1418 | * @param string gzip-encoded data |
| 1419 | + * @param string $data |
|
| 1412 | 1420 | * @return string decoded data |
| 1413 | 1421 | */ |
| 1414 | 1422 | public function _decodeGzip($data) |