@@ -213,7 +213,7 @@ |
||
213 | 213 | * Convenience function for generating HTMLPurifier_ConfigSchema_ValidatorAtom |
214 | 214 | * for validating simple member variables of objects. |
215 | 215 | * @param $obj |
216 | - * @param $member |
|
216 | + * @param string $member |
|
217 | 217 | * @return HTMLPurifier_ConfigSchema_ValidatorAtom |
218 | 218 | */ |
219 | 219 | protected function with($obj, $member) |
@@ -479,6 +479,9 @@ discard block |
||
479 | 479 | return $this->tree->save(); |
480 | 480 | } |
481 | 481 | |
482 | + /** |
|
483 | + * @return string |
|
484 | + */ |
|
482 | 485 | private function char() |
483 | 486 | { |
484 | 487 | return ($this->char < $this->EOF) |
@@ -486,6 +489,11 @@ discard block |
||
486 | 489 | : false; |
487 | 490 | } |
488 | 491 | |
492 | + /** |
|
493 | + * @param integer $s |
|
494 | + * |
|
495 | + * @return string |
|
496 | + */ |
|
489 | 497 | private function character($s, $l = 0) |
490 | 498 | { |
491 | 499 | if ($s + $l < $this->EOF) { |
@@ -497,6 +505,10 @@ discard block |
||
497 | 505 | } |
498 | 506 | } |
499 | 507 | |
508 | + /** |
|
509 | + * @param string $char_class |
|
510 | + * @param integer $start |
|
511 | + */ |
|
500 | 512 | private function characters($char_class, $start) |
501 | 513 | { |
502 | 514 | return preg_replace('#^([' . $char_class . ']+).*#s', '\\1', substr($this->data, $start)); |
@@ -4646,6 +4658,9 @@ discard block |
||
4646 | 4658 | } |
4647 | 4659 | } |
4648 | 4660 | |
4661 | + /** |
|
4662 | + * @param string[] $elements |
|
4663 | + */ |
|
4649 | 4664 | private function clearStackToTableContext($elements) |
4650 | 4665 | { |
4651 | 4666 | /* When the steps above require the UA to clear the stack back to a |
@@ -1329,6 +1329,9 @@ discard block |
||
1329 | 1329 | |
1330 | 1330 | // {{{ _copymove() |
1331 | 1331 | |
1332 | + /** |
|
1333 | + * @param string $what |
|
1334 | + */ |
|
1332 | 1335 | function _copymove($what) |
1333 | 1336 | { |
1334 | 1337 | $options = Array(); |
@@ -1657,7 +1660,7 @@ discard block |
||
1657 | 1660 | * defined in RFC 2518 section 9.4 |
1658 | 1661 | * |
1659 | 1662 | * @param void |
1660 | - * @return void |
|
1663 | + * @return boolean |
|
1661 | 1664 | */ |
1662 | 1665 | function _check_if_header_conditions() |
1663 | 1666 | { |
@@ -1721,6 +1724,7 @@ discard block |
||
1721 | 1724 | * |
1722 | 1725 | * @param string path of resource to check |
1723 | 1726 | * @param bool exclusive lock? |
1727 | + * @param string $path |
|
1724 | 1728 | */ |
1725 | 1729 | function _check_lock_status($path, $exclusive_only = false) |
1726 | 1730 | { |
@@ -1820,6 +1824,7 @@ discard block |
||
1820 | 1824 | * full urlencode() encoding confuses some clients ... |
1821 | 1825 | * |
1822 | 1826 | * @param string URL to encode |
1827 | + * @param string $url |
|
1823 | 1828 | * @return string encoded URL |
1824 | 1829 | */ |
1825 | 1830 | function _urlencode($url) |
@@ -1848,6 +1853,7 @@ discard block |
||
1848 | 1853 | * UTF-8 encode property values if not already done so |
1849 | 1854 | * |
1850 | 1855 | * @param string text to encode |
1856 | + * @param string $text |
|
1851 | 1857 | * @return string utf-8 encoded text |
1852 | 1858 | */ |
1853 | 1859 | function _prop_encode($text) |
@@ -58,6 +58,7 @@ |
||
58 | 58 | * constructor |
59 | 59 | * |
60 | 60 | * @access public |
61 | + * @param string $path |
|
61 | 62 | */ |
62 | 63 | function _parse_propfind($path) |
63 | 64 | { |
@@ -330,6 +330,9 @@ discard block |
||
330 | 330 | |
331 | 331 | } |
332 | 332 | |
333 | +/** |
|
334 | + * @param SugarBean $bean |
|
335 | + */ |
|
333 | 336 | function getDisplayValue($bean, $field, $method = "save") |
334 | 337 | { |
335 | 338 | |
@@ -471,6 +474,9 @@ discard block |
||
471 | 474 | |
472 | 475 | } |
473 | 476 | |
477 | +/** |
|
478 | + * @return string |
|
479 | + */ |
|
474 | 480 | function convertDateUserToDB($value) |
475 | 481 | { |
476 | 482 | global $timedate; |
@@ -482,6 +488,9 @@ discard block |
||
482 | 488 | return $value; |
483 | 489 | } |
484 | 490 | |
491 | +/** |
|
492 | + * @param SugarBean $bean |
|
493 | + */ |
|
485 | 494 | function checkAccess($bean){ |
486 | 495 | |
487 | 496 | if($bean->ACLAccess('EditView')) { |
@@ -71,12 +71,20 @@ discard block |
||
71 | 71 | } |
72 | 72 | } |
73 | 73 | |
74 | + /** |
|
75 | + * @param string $dispField |
|
76 | + * @param string $type |
|
77 | + * @param string $required |
|
78 | + */ |
|
74 | 79 | function addSpecialField($dispField, $realField, $type, $required, $prefix = '') { |
75 | 80 | if (isset($this->sugarbean->field_name_map[$realField]['vname'])) { |
76 | 81 | $this->addFieldGeneric($dispField, 'date', $this->sugarbean->field_name_map[$realField]['vname'], $required, $prefix ); |
77 | 82 | } |
78 | 83 | } |
79 | 84 | |
85 | + /** |
|
86 | + * @param string $required |
|
87 | + */ |
|
80 | 88 | function addField($field,$required, $prefix='', $displayField='', $translate = false){ |
81 | 89 | if ($field == "id") return; |
82 | 90 | if(isset($this->sugarbean->field_name_map[$field]['vname'])){ |
@@ -184,6 +192,10 @@ discard block |
||
184 | 192 | } |
185 | 193 | |
186 | 194 | // Bug #47961 Generator of callback validator |
195 | + |
|
196 | + /** |
|
197 | + * @param string $prefix |
|
198 | + */ |
|
187 | 199 | function addFieldCallback($field, $type, $displayName, $required, $prefix, $callback) |
188 | 200 | { |
189 | 201 | $this->script .= 'addToValidateCallback("' |
@@ -230,6 +242,11 @@ discard block |
||
230 | 242 | . $this->stripEndColon(translate($displayName,$this->sugarbean->module_dir)) . "', '$compareTo', '$allowBlank' );\n"; |
231 | 243 | } |
232 | 244 | |
245 | + /** |
|
246 | + * @param string $type |
|
247 | + * @param string $displayName |
|
248 | + * @param string $required |
|
249 | + */ |
|
233 | 250 | function addToValidateBinaryDependency($field, $type, $displayName, $required, $prefix='',$compareTo){ |
234 | 251 | $this->script .= "addToValidateBinaryDependency('".$this->formname."', '".$prefix.$field."', '".$type . "', {$this->getRequiredString($required)},'" |
235 | 252 | . $this->stripEndColon(translate($displayName,$this->sugarbean->module_dir)) . "', '$compareTo' );\n"; |
@@ -248,6 +265,9 @@ discard block |
||
248 | 265 | $this->script .= "addToValidateIsInArray('{$this->formname}', '{$name}', '{$type}', {$req}, '".$this->stripEndColon(translate($displayName,$this->sugarbean->module_dir))."', '{$arr}', '{$operator}');\n"; |
249 | 266 | } |
250 | 267 | |
268 | + /** |
|
269 | + * @param string $prefix |
|
270 | + */ |
|
251 | 271 | function addAllFields($prefix,$skip_fields=null, $translate = false){ |
252 | 272 | if (!isset($skip_fields)) |
253 | 273 | { |
@@ -59,6 +59,10 @@ |
||
59 | 59 | $this->addAlert($app_strings['ERROR_JS_ALERT_SYSTEM_CLASS'], $app_strings['ERROR_JS_ALERT_TIMEOUT_TITLE'],'', $app_strings['ERROR_JS_ALERT_TIMEOUT_MSG_2'], (session_cache_expire()) * 60 , 'index.php'); |
60 | 60 | } |
61 | 61 | } |
62 | + |
|
63 | + /** |
|
64 | + * @param string $subtitle |
|
65 | + */ |
|
62 | 66 | function addAlert($type, $name, $subtitle, $description, $countdown, $redirect='') |
63 | 67 | { |
64 | 68 | $script = 'addAlert(' . json_encode($type) .',' . json_encode($name). ',' . json_encode($subtitle). ','. json_encode(str_replace(array("\r", "\n"), array('','<br>'),$description)) . ',' . $countdown . ','.json_encode($redirect).');' . "\n"; |
@@ -53,6 +53,9 @@ |
||
53 | 53 | class json_config { |
54 | 54 | var $global_registry_var_name = 'GLOBAL_REGISTRY'; |
55 | 55 | |
56 | + /** |
|
57 | + * @param string $module |
|
58 | + */ |
|
56 | 59 | function get_static_json_server($configOnly = true, $getStrings = false, $module = null, $record = null, $scheduler = false) { |
57 | 60 | global $current_user; |
58 | 61 | $str = ''; |
@@ -105,6 +105,9 @@ discard block |
||
105 | 105 | } |
106 | 106 | |
107 | 107 | |
108 | +/** |
|
109 | + * @param string $xTemplateSection |
|
110 | + */ |
|
108 | 111 | function processListView($seed, $xTemplateSection, $html_varName) |
109 | 112 | { |
110 | 113 | global $sugar_config; |
@@ -232,8 +235,8 @@ discard block |
||
232 | 235 | /** |
233 | 236 | * @return void |
234 | 237 | * @param unknown $data |
235 | - * @param unknown $xTemplateSection |
|
236 | - * @param unknown $html_varName |
|
238 | + * @param string $xtemplateSection |
|
239 | + * @param string $html_varName |
|
237 | 240 | * @desc INTERNAL FUNCTION handles the rows |
238 | 241 | */ |
239 | 242 | function process_dynamic_listview_rows($data,$parent_data, $xtemplateSection, $html_varName, $subpanel_def) |
@@ -610,6 +613,9 @@ discard block |
||
610 | 613 | * All Rights Reserved. |
611 | 614 | * Contributor(s): ______________________________________. |
612 | 615 | */ |
616 | + /** |
|
617 | + * @param string $value |
|
618 | + */ |
|
613 | 619 | function setHeaderText($value) { |
614 | 620 | $this->header_text = $value; |
615 | 621 | } |
@@ -728,6 +734,9 @@ discard block |
||
728 | 734 | * All Rights Reserved. |
729 | 735 | * Contributor(s): ______________________________________. |
730 | 736 | */ |
737 | + /** |
|
738 | + * @param string $where |
|
739 | + */ |
|
731 | 740 | function setQuery($where, $limit, $orderBy, $varName, $allowOrderByOveride=true) { |
732 | 741 | $this->query_where = $where; |
733 | 742 | if($this->getSessionVariable("query", "where") != $where) { |
@@ -834,6 +843,9 @@ discard block |
||
834 | 843 | * All Rights Reserved. |
835 | 844 | * Contributor(s): ______________________________________. |
836 | 845 | */ |
846 | + /** |
|
847 | + * @param XTemplate $newXTemplate |
|
848 | + */ |
|
837 | 849 | function setXTemplate($newXTemplate) { |
838 | 850 | $this->xTemplate = $newXTemplate; |
839 | 851 | } |
@@ -852,6 +864,9 @@ discard block |
||
852 | 864 | * All Rights Reserved. |
853 | 865 | * Contributor(s): ______________________________________. |
854 | 866 | */ |
867 | + /** |
|
868 | + * @param string $name |
|
869 | + */ |
|
855 | 870 | function xTemplateAssign($name, $value) { |
856 | 871 | |
857 | 872 | if(!isset($this->xTemplate)) { |
@@ -906,6 +921,9 @@ discard block |
||
906 | 921 | * All Rights Reserved. |
907 | 922 | * Contributor(s): ______________________________________. |
908 | 923 | */ |
924 | + /** |
|
925 | + * @param string $varName |
|
926 | + */ |
|
909 | 927 | function getSessionVariable($localVarName,$varName) { |
910 | 928 | //Set any variables pass in through request first |
911 | 929 | if(isset($_REQUEST[$this->getSessionVariableName($localVarName, $varName)])) { |
@@ -961,7 +979,7 @@ discard block |
||
961 | 979 | |
962 | 980 | /** |
963 | 981 | |
964 | - * @return void |
|
982 | + * @return string |
|
965 | 983 | * @param unknown $localVarName |
966 | 984 | * @param unknown $varName |
967 | 985 | * @desc INTERNAL FUNCTION returns the session/query variable name |
@@ -977,7 +995,7 @@ discard block |
||
977 | 995 | |
978 | 996 | * @return void |
979 | 997 | * @param unknown $seed |
980 | - * @param unknown $xTemplateSection |
|
998 | + * @param unknown $xtemplateSection |
|
981 | 999 | * @param unknown $html_varName |
982 | 1000 | * @desc INTERNAL FUNCTION Handles List Views using seeds that extend SugarBean |
983 | 1001 | $XTemplateSection is the section in the XTemplate file that should be parsed usually main |
@@ -1169,8 +1187,7 @@ discard block |
||
1169 | 1187 | } |
1170 | 1188 | /** |
1171 | 1189 | * @return void |
1172 | - * @param unknown $data |
|
1173 | - * @param unknown $xTemplateSection |
|
1190 | + * @param unknown $xtemplateSection |
|
1174 | 1191 | * @param unknown $html_varName |
1175 | 1192 | * @desc INTERNAL FUNCTION process the List Navigation |
1176 | 1193 | * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc. |
@@ -1550,7 +1567,7 @@ discard block |
||
1550 | 1567 | /** |
1551 | 1568 | * @return void |
1552 | 1569 | * @param unknown $data |
1553 | - * @param unknown $xTemplateSection |
|
1570 | + * @param unknown $xtemplateSection |
|
1554 | 1571 | * @param unknown $html_varName |
1555 | 1572 | * @desc INTERNAL FUNCTION handles the rows |
1556 | 1573 | * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc. |
@@ -2036,6 +2053,10 @@ discard block |
||
2036 | 2053 | * All Rights Reserved. |
2037 | 2054 | * Contributor(s): ______________________________________. |
2038 | 2055 | */ |
2056 | + |
|
2057 | + /** |
|
2058 | + * @param string $varName |
|
2059 | + */ |
|
2039 | 2060 | function setLocalSessionVariable($localVarName,$varName, $value) { |
2040 | 2061 | $_SESSION[$localVarName."_".$varName] = $value; |
2041 | 2062 | } |
@@ -2046,6 +2067,12 @@ discard block |
||
2046 | 2067 | * All Rights Reserved. |
2047 | 2068 | * Contributor(s): ______________________________________. |
2048 | 2069 | */ |
2070 | + |
|
2071 | + /** |
|
2072 | + * @param string $varName |
|
2073 | + * |
|
2074 | + * @return string |
|
2075 | + */ |
|
2049 | 2076 | function getLocalSessionVariable($localVarName,$varName) { |
2050 | 2077 | if(isset($_SESSION[$localVarName."_".$varName])) { |
2051 | 2078 | return $_SESSION[$localVarName."_".$varName]; |