@@ -16,6 +16,9 @@ |
||
16 | 16 | |
17 | 17 | define('OSC_CATALOG_SESSION_ID', 'osCsid'); |
18 | 18 | |
19 | + /** |
|
20 | + * @param integer $length |
|
21 | + */ |
|
19 | 22 | function tep_create_random_value($length, $type = 'mixed') { |
20 | 23 | if ( ($type != 'mixed') && ($type != 'chars') && ($type != 'digits')) return false; |
21 | 24 |
@@ -35,6 +35,10 @@ discard block |
||
35 | 35 | var $portable_hashes; |
36 | 36 | var $random_state; |
37 | 37 | |
38 | + /** |
|
39 | + * @param integer $iteration_count_log2 |
|
40 | + * @param boolean $portable_hashes |
|
41 | + */ |
|
38 | 42 | function PasswordHash($iteration_count_log2, $portable_hashes) |
39 | 43 | { |
40 | 44 | $this->itoa64 = './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'; |
@@ -84,6 +88,9 @@ discard block |
||
84 | 88 | return $output; |
85 | 89 | } |
86 | 90 | |
91 | + /** |
|
92 | + * @param integer $count |
|
93 | + */ |
|
87 | 94 | function encode64($input, $count) |
88 | 95 | { |
89 | 96 | $output = ''; |
@@ -107,6 +114,9 @@ discard block |
||
107 | 114 | return $output; |
108 | 115 | } |
109 | 116 | |
117 | + /** |
|
118 | + * @param string $input |
|
119 | + */ |
|
110 | 120 | function gensalt_private($input) |
111 | 121 | { |
112 | 122 | $output = '$P$'; |
@@ -155,6 +165,9 @@ discard block |
||
155 | 165 | return $output; |
156 | 166 | } |
157 | 167 | |
168 | + /** |
|
169 | + * @param string $input |
|
170 | + */ |
|
158 | 171 | function gensalt_extended($input) |
159 | 172 | { |
160 | 173 | $count_log2 = min($this->iteration_count_log2 + 8, 24); |
@@ -173,6 +186,9 @@ discard block |
||
173 | 186 | return $output; |
174 | 187 | } |
175 | 188 | |
189 | + /** |
|
190 | + * @param string $input |
|
191 | + */ |
|
176 | 192 | function gensalt_blowfish($input) |
177 | 193 | { |
178 | 194 | # This one needs to use a different order of characters and a |
@@ -301,6 +301,9 @@ discard block |
||
301 | 301 | } |
302 | 302 | } |
303 | 303 | |
304 | + /** |
|
305 | + * @param string $which_input_file |
|
306 | + */ |
|
304 | 307 | function SetInputFile($which_input_file) { |
305 | 308 | //$this->SetFileFormat($which_frmt); |
306 | 309 | $size = GetImageSize($which_input_file); |
@@ -343,6 +346,9 @@ discard block |
||
343 | 346 | |
344 | 347 | } |
345 | 348 | |
349 | + /** |
|
350 | + * @param string $which_output_file |
|
351 | + */ |
|
346 | 352 | function SetOutputFile($which_output_file) { |
347 | 353 | $this->output_file = $which_output_file; |
348 | 354 | return true; |
@@ -719,11 +725,18 @@ discard block |
||
719 | 725 | $this->ndx_plot_bg_color); |
720 | 726 | } |
721 | 727 | |
728 | + /** |
|
729 | + * @param integer[] $which_color |
|
730 | + */ |
|
722 | 731 | function SetBackgroundColor($which_color) { |
723 | 732 | $this->bg_color= $which_color; |
724 | 733 | $this->ndx_bg_color= $this->SetIndexColor($which_color); |
725 | 734 | return true; |
726 | 735 | } |
736 | + |
|
737 | + /** |
|
738 | + * @param integer[] $which_color |
|
739 | + */ |
|
727 | 740 | function SetPlotBgColor($which_color) { |
728 | 741 | $this->plot_bg_color= $which_color; |
729 | 742 | $this->ndx_plot_bg_color= $this->SetIndexColor($which_color); |
@@ -735,36 +748,54 @@ discard block |
||
735 | 748 | return true; |
736 | 749 | } |
737 | 750 | |
751 | + /** |
|
752 | + * @param integer[] $which_color |
|
753 | + */ |
|
738 | 754 | function SetTitleColor($which_color) { |
739 | 755 | $this->title_color= $which_color; |
740 | 756 | $this->ndx_title_color= $this->SetIndexColor($which_color); |
741 | 757 | return true; |
742 | 758 | } |
743 | 759 | |
760 | + /** |
|
761 | + * @param string $which_color |
|
762 | + */ |
|
744 | 763 | function SetTickColor ($which_color) { |
745 | 764 | $this->tick_color= $which_color; |
746 | 765 | $this->ndx_tick_color= $this->SetIndexColor($which_color); |
747 | 766 | return true; |
748 | 767 | } |
749 | 768 | |
769 | + /** |
|
770 | + * @param string $which_color |
|
771 | + */ |
|
750 | 772 | function SetLabelColor ($which_color) { |
751 | 773 | $this->label_color= $which_color; |
752 | 774 | $this->ndx_label_color= $this->SetIndexColor($which_color); |
753 | 775 | return true; |
754 | 776 | } |
755 | 777 | |
778 | + /** |
|
779 | + * @param string $which_color |
|
780 | + */ |
|
756 | 781 | function SetTextColor ($which_color) { |
757 | 782 | $this->text_color= $which_color; |
758 | 783 | $this->ndx_text_color= $this->SetIndexColor($which_color); |
759 | 784 | return true; |
760 | 785 | } |
761 | 786 | |
787 | + /** |
|
788 | + * @param integer[] $which_color |
|
789 | + */ |
|
762 | 790 | function SetLightGridColor ($which_color) { |
763 | 791 | $this->light_grid_color= $which_color; |
764 | 792 | $this->ndx_light_grid_color= $this->SetIndexColor($which_color); |
765 | 793 | return true; |
766 | 794 | } |
767 | 795 | |
796 | + /** |
|
797 | + * @param string $which_color |
|
798 | + */ |
|
768 | 799 | function SetGridColor ($which_color) { |
769 | 800 | $this->grid_color = $which_color; |
770 | 801 | $this->ndx_grid_color= $this->SetIndexColor($which_color); |
@@ -997,6 +1028,12 @@ discard block |
||
997 | 1028 | return true; |
998 | 1029 | } |
999 | 1030 | |
1031 | + /** |
|
1032 | + * @param string $x1 |
|
1033 | + * @param string $y1 |
|
1034 | + * @param string $x2 |
|
1035 | + * @param string $y2 |
|
1036 | + */ |
|
1000 | 1037 | function SetPlotAreaPixels($x1,$y1,$x2,$y2) { |
1001 | 1038 | //Like in GD 0,0 is upper left |
1002 | 1039 | if (!$this->x_tot_margin) { |
@@ -1017,6 +1054,12 @@ discard block |
||
1017 | 1054 | |
1018 | 1055 | } |
1019 | 1056 | |
1057 | + /** |
|
1058 | + * @param string $xmin |
|
1059 | + * @param string $ymin |
|
1060 | + * @param string $xmax |
|
1061 | + * @param string $ymax |
|
1062 | + */ |
|
1020 | 1063 | function SetPlotAreaWorld($xmin,$ymin,$xmax,$ymax) { |
1021 | 1064 | if (($xmin == "") && ($xmax == "")) { |
1022 | 1065 | //For automatic setting of data we need $this->max_x |
@@ -1081,6 +1124,9 @@ discard block |
||
1081 | 1124 | die; |
1082 | 1125 | } |
1083 | 1126 | |
1127 | + /** |
|
1128 | + * @param string $error_message |
|
1129 | + */ |
|
1084 | 1130 | function DrawError($error_message) { |
1085 | 1131 | // prints the error message inline into |
1086 | 1132 | // the generated image |
@@ -1208,6 +1254,9 @@ discard block |
||
1208 | 1254 | return true; |
1209 | 1255 | } |
1210 | 1256 | |
1257 | + /** |
|
1258 | + * @param integer $which_ps |
|
1259 | + */ |
|
1211 | 1260 | function SetPointSize($which_ps) { |
1212 | 1261 | //in pixels |
1213 | 1262 | SetType($which_ps,'integer'); |
@@ -1238,6 +1287,9 @@ discard block |
||
1238 | 1287 | } |
1239 | 1288 | |
1240 | 1289 | //////////////COLORS |
1290 | + /** |
|
1291 | + * @param string $which_color_array |
|
1292 | + */ |
|
1241 | 1293 | function SetRGBArray ($which_color_array) { |
1242 | 1294 | if ( is_array($which_color_array) ) { |
1243 | 1295 | //User Defined Array |
@@ -1333,6 +1385,10 @@ discard block |
||
1333 | 1385 | return $ret_val; |
1334 | 1386 | } |
1335 | 1387 | |
1388 | + /** |
|
1389 | + * @param string[] $which_data |
|
1390 | + * @param string[] $which_border |
|
1391 | + */ |
|
1336 | 1392 | function SetDataColors($which_data,$which_border) { |
1337 | 1393 | //Set the data to be displayed in a particular color |
1338 | 1394 | if (!$which_data) { |
@@ -1833,6 +1889,9 @@ discard block |
||
1833 | 1889 | |
1834 | 1890 | } |
1835 | 1891 | |
1892 | + /** |
|
1893 | + * @param double $xpos |
|
1894 | + */ |
|
1836 | 1895 | function DrawXDataLabel($xlab,$xpos) { |
1837 | 1896 | //xpos comes in in PIXELS not in world coordinates. |
1838 | 1897 | //Draw an x data label centered at xlab |
@@ -2083,6 +2142,9 @@ discard block |
||
2083 | 2142 | |
2084 | 2143 | } //function DrawThinBarLines |
2085 | 2144 | |
2145 | + /** |
|
2146 | + * @param string $error_bar_type |
|
2147 | + */ |
|
2086 | 2148 | function DrawYErrorBar($x_world,$y_world,$error_height,$error_bar_type,$color) { |
2087 | 2149 | $x1 = $this->xtr($x_world); |
2088 | 2150 | $y1 = $this->ytr($y_world); |
@@ -2105,6 +2167,9 @@ discard block |
||
2105 | 2167 | return true; |
2106 | 2168 | } |
2107 | 2169 | |
2170 | + /** |
|
2171 | + * @param string $dot_type |
|
2172 | + */ |
|
2108 | 2173 | function DrawDot($x_world,$y_world,$dot_type,$color) { |
2109 | 2174 | $half_point = $this->point_size / 2; |
2110 | 2175 | $x1 = $this->xtr($x_world) - $half_point; |
@@ -2344,6 +2409,14 @@ discard block |
||
2344 | 2409 | return false; |
2345 | 2410 | } //function DrawLineSeries |
2346 | 2411 | |
2412 | + /** |
|
2413 | + * @param double $x1pix |
|
2414 | + * @param double $y1pix |
|
2415 | + * @param double $x2pix |
|
2416 | + * @param double $y2pix |
|
2417 | + * @param integer $dash_length |
|
2418 | + * @param integer $dash_space |
|
2419 | + */ |
|
2347 | 2420 | function DrawDashedLine($x1pix,$y1pix,$x2pix,$y2pix,$dash_length,$dash_space,$color) { |
2348 | 2421 | //Code based on work by Ariel Garza and James Pine |
2349 | 2422 | //I've decided to have this be in pixels only as a replacement for ImageLine |
@@ -2434,6 +2507,11 @@ discard block |
||
2434 | 2507 | } |
2435 | 2508 | } //function DrawBars |
2436 | 2509 | |
2510 | + /** |
|
2511 | + * @param string $which_x1 |
|
2512 | + * @param string $which_y1 |
|
2513 | + * @param string $which_boxtype |
|
2514 | + */ |
|
2437 | 2515 | function DrawLegend($which_x1,$which_y1,$which_boxtype) { |
2438 | 2516 | //Base code submitted by Marlin Viss |
2439 | 2517 | $max_legend_length=0; |
@@ -53,6 +53,10 @@ discard block |
||
53 | 53 | // ------------------------------------------------------------------- |
54 | 54 | // Parse RSS file and returns associative array. |
55 | 55 | // ------------------------------------------------------------------- |
56 | + |
|
57 | + /** |
|
58 | + * @param string $rss_url |
|
59 | + */ |
|
56 | 60 | function Get ($rss_url) { |
57 | 61 | // If CACHE ENABLED |
58 | 62 | if ($this->cache_dir != '') { |
@@ -114,6 +118,10 @@ discard block |
||
114 | 118 | // ------------------------------------------------------------------- |
115 | 119 | // Replace HTML entities &something; by real characters |
116 | 120 | // ------------------------------------------------------------------- |
121 | + |
|
122 | + /** |
|
123 | + * @param string $string |
|
124 | + */ |
|
117 | 125 | function unhtmlentities ($string) { |
118 | 126 | // Get HTML entities table |
119 | 127 | $trans_tbl = get_html_translation_table (HTML_ENTITIES, ENT_QUOTES); |
@@ -108,10 +108,16 @@ discard block |
||
108 | 108 | $this->file = $file; |
109 | 109 | } |
110 | 110 | |
111 | + /** |
|
112 | + * @param string $destination |
|
113 | + */ |
|
111 | 114 | function set_destination($destination) { |
112 | 115 | $this->destination = $destination; |
113 | 116 | } |
114 | 117 | |
118 | + /** |
|
119 | + * @param string $permissions |
|
120 | + */ |
|
115 | 121 | function set_permissions($permissions) { |
116 | 122 | $this->permissions = octdec($permissions); |
117 | 123 | } |
@@ -124,6 +130,9 @@ discard block |
||
124 | 130 | $this->tmp_filename = $filename; |
125 | 131 | } |
126 | 132 | |
133 | + /** |
|
134 | + * @param string $extensions |
|
135 | + */ |
|
127 | 136 | function set_extensions($extensions) { |
128 | 137 | if (tep_not_null($extensions)) { |
129 | 138 | if (is_array($extensions)) { |
@@ -160,6 +169,9 @@ discard block |
||
160 | 169 | } |
161 | 170 | } |
162 | 171 | |
172 | + /** |
|
173 | + * @param string $location |
|
174 | + */ |
|
163 | 175 | function set_output_messages($location) { |
164 | 176 | switch ($location) { |
165 | 177 | case 'session': |
@@ -231,6 +231,10 @@ discard block |
||
231 | 231 | |
232 | 232 | //// |
233 | 233 | // prints out the actual data for the double horizontal chart |
234 | + /** |
|
235 | + * @param integer $dvalues |
|
236 | + * @param integer $dbars |
|
237 | + */ |
|
234 | 238 | function double_horizontal_graph($names, $values, $bars, $vals, $dvalues, $dbars) { |
235 | 239 | $double_horizontal_graph_string = ''; |
236 | 240 | for($i = 0, $n = sizeof($values); $i < $n; $i++) { |
@@ -291,6 +295,10 @@ discard block |
||
291 | 295 | |
292 | 296 | //// |
293 | 297 | // prints out the actual data for the double vertical chart |
298 | + /** |
|
299 | + * @param integer $dvalues |
|
300 | + * @param integer $dbars |
|
301 | + */ |
|
294 | 302 | function double_vertical_graph($names, $values, $bars, $vals, $dvalues, $dbars) { |
295 | 303 | $double_vertical_graph_string = ' <tr>' . "\n"; |
296 | 304 | for ($i = 0, $n = sizeof($values); $i < $n; $i++) { |
@@ -32,6 +32,9 @@ |
||
32 | 32 | return MODULE_SECURITY_CHECK_EXTENDED_EXT_DIRECTORY_LISTING_HTTP_200; |
33 | 33 | } |
34 | 34 | |
35 | + /** |
|
36 | + * @param null|string $url |
|
37 | + */ |
|
35 | 38 | function getHttpRequest($url) { |
36 | 39 | $server = parse_url($url); |
37 | 40 |
@@ -23,6 +23,9 @@ |
||
23 | 23 | $this->validate_cfg(); |
24 | 24 | } |
25 | 25 | |
26 | + /** |
|
27 | + * @param string $msg |
|
28 | + */ |
|
26 | 29 | function complain($msg){ |
27 | 30 | echo '<div style="position:absolute;left:0;top:0;width:100%;font-size:24px;text-align:center;background:#CCCCCC;color:#660000">MC360 Module: '.$msg.'</div><br />'; |
28 | 31 | } |
@@ -1572,6 +1572,7 @@ |
||
1572 | 1572 | /** |
1573 | 1573 | * Actually connect to the server and call the requested methods, parsing the result |
1574 | 1574 | * You should never have to call this function manually |
1575 | + * @param string $method |
|
1575 | 1576 | */ |
1576 | 1577 | function callServer($method, $params) { |
1577 | 1578 | //Always include the apikey if we are not logging in |