@@ -199,6 +199,7 @@ |
||
199 | 199 | * Parses a string containing multiple HTTP header lines into an array |
200 | 200 | * of key => values. |
201 | 201 | * Inspired by HTTP::Daemon (CPAN). |
202 | + * @param string $header_str |
|
202 | 203 | */ |
203 | 204 | function http_parse_headers($header_str) { |
204 | 205 | $headers = array(); |
@@ -111,7 +111,6 @@ discard block |
||
111 | 111 | /** |
112 | 112 | * Get initial content |
113 | 113 | * |
114 | - * @param bool $encode To sanitizer the text? Default value should be "true"; however we have to set "false" for backward compat |
|
115 | 114 | * @return string |
116 | 115 | */ |
117 | 116 | function getValue() { |
@@ -122,7 +121,6 @@ discard block |
||
122 | 121 | /** |
123 | 122 | * Get initial content |
124 | 123 | * |
125 | - * @param bool $encode To sanitizer the text? Default value should be "true"; however we have to set "false" for backward compat |
|
126 | 124 | * @return string |
127 | 125 | */ |
128 | 126 | function renderGetValueJS() { |
@@ -133,7 +131,7 @@ discard block |
||
133 | 131 | * prepare HTML for output |
134 | 132 | * |
135 | 133 | * @param bool decode content? |
136 | - * @return sting HTML |
|
134 | + * @return string HTML |
|
137 | 135 | */ |
138 | 136 | function render($decode = true) |
139 | 137 | { |
@@ -142,7 +142,6 @@ discard block |
||
142 | 142 | /** |
143 | 143 | * Get initial content |
144 | 144 | * |
145 | - * @param bool $encode To sanitizer the text? Default value should be "true"; however we have to set "false" for backward compat |
|
146 | 145 | * @return string |
147 | 146 | */ |
148 | 147 | function getValue() { |
@@ -154,7 +153,7 @@ discard block |
||
154 | 153 | * prepare HTML for output |
155 | 154 | * |
156 | 155 | * @param bool decode content? |
157 | - * @return sting HTML |
|
156 | + * @return string HTML |
|
158 | 157 | */ |
159 | 158 | function render($decode = true) { |
160 | 159 | static $isCodemirror3JsLoaded; |
@@ -177,6 +176,11 @@ discard block |
||
177 | 176 | $css.= ".cm-tab {background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAMCAYAAAAkuj5RAAAAAXNSR0IArs4c6QAAAGFJREFUSMft1LsRQFAQheHPowAKoACx3IgEKtaEHujDjORSgWTH/ZOdnZOcM/sgk/kFFWY0qV8foQwS4MKBCS3qR6ixBJvElOobYAtivseIE120FaowJPN75GMu8j/LfMwNjh4HUpwg4LUAAAAASUVORK5CYII=); background-position: right; background-repeat: no-repeat;}\n"; // Visible tabs |
178 | 177 | $css.= ".CodeMirror-foldmarker {color: blue; text-shadow: #b9f 1px 1px 2px, #b9f -1px -1px 2px, #b9f 1px -1px 2px, #b9f -1px 1px 2px; font-family: arial;}\n"; |
179 | 178 | // Get available codemirror themes |
179 | + |
|
180 | + /** |
|
181 | + * @param string $d |
|
182 | + * @param string $x |
|
183 | + */ |
|
180 | 184 | function codemirror_filesList($d, $x){ |
181 | 185 | foreach(array_diff(scandir($d), array('.', '..')) as $f) if (is_file($d . '/' . $f) && (($x) ? preg_match('/' . $x . '$/' , $f) : 1)) $l[] = $f; |
182 | 186 | return $l; |
@@ -29,18 +29,29 @@ |
||
29 | 29 | } |
30 | 30 | |
31 | 31 | # make declarations for the text input index |
32 | +/** |
|
33 | + * @param integer $text_input_idx |
|
34 | + */ |
|
32 | 35 | function print_textindex_decl( $text_input_idx ) { |
33 | 36 | echo "words[$text_input_idx] = [];\n"; |
34 | 37 | echo "suggs[$text_input_idx] = [];\n"; |
35 | 38 | } |
36 | 39 | |
37 | 40 | # set an element of the JavaScript 'words' array to a misspelled word |
41 | +/** |
|
42 | + * @param integer $index |
|
43 | + * @param integer $text_input_idx |
|
44 | + */ |
|
38 | 45 | function print_words_elem( $word, $index, $text_input_idx ) { |
39 | 46 | echo "words[$text_input_idx][$index] = '" . escape_quote( $word ) . "';\n"; |
40 | 47 | } |
41 | 48 | |
42 | 49 | |
43 | 50 | # set an element of the JavaScript 'suggs' array to a list of suggestions |
51 | +/** |
|
52 | + * @param integer $index |
|
53 | + * @param integer $text_input_idx |
|
54 | + */ |
|
44 | 55 | function print_suggs_elem( $suggs, $index, $text_input_idx ) { |
45 | 56 | echo "suggs[$text_input_idx][$index] = ["; |
46 | 57 | foreach( $suggs as $key=>$val ) { |
@@ -28,6 +28,9 @@ |
||
28 | 28 | require('./commands.php') ; |
29 | 29 | require('./phpcompat.php') ; |
30 | 30 | |
31 | +/** |
|
32 | + * @param integer $number |
|
33 | + */ |
|
31 | 34 | function SendError( $number, $text ) |
32 | 35 | { |
33 | 36 | SendUploadResults( $number, '', '', $text ) ; |
@@ -22,12 +22,18 @@ discard block |
||
22 | 22 | * Utility functions for the File Manager Connector for PHP. |
23 | 23 | */ |
24 | 24 | |
25 | +/** |
|
26 | + * @param string $charToRemove |
|
27 | + */ |
|
25 | 28 | function RemoveFromStart( $sourceString, $charToRemove ) |
26 | 29 | { |
27 | 30 | $sPattern = '|^' . $charToRemove . '+|' ; |
28 | 31 | return preg_replace( $sPattern, '', $sourceString ) ; |
29 | 32 | } |
30 | 33 | |
34 | +/** |
|
35 | + * @param string $charToRemove |
|
36 | + */ |
|
31 | 37 | function RemoveFromEnd( $sourceString, $charToRemove ) |
32 | 38 | { |
33 | 39 | $sPattern = '|' . $charToRemove . '+$|' ; |
@@ -175,7 +181,6 @@ discard block |
||
175 | 181 | * |
176 | 182 | * @param string $filePath absolute path to file |
177 | 183 | * @param string $extension file extension |
178 | - * @param integer $detectionLevel 0 = none, 1 = use getimagesize for images, 2 = use DetectHtml for images |
|
179 | 184 | * @return boolean |
180 | 185 | */ |
181 | 186 | function IsImageValid( $filePath, $extension ) |
@@ -87,11 +87,21 @@ |
||
87 | 87 | } # END create_watermark() |
88 | 88 | |
89 | 89 | # average two colors given an alpha |
90 | + |
|
91 | + /** |
|
92 | + * @param double $alpha_level |
|
93 | + */ |
|
90 | 94 | function _get_ave_color( $color_a, $color_b, $alpha_level ) { |
91 | 95 | return round( ( ( $color_a * ( 1 - $alpha_level ) ) + ( $color_b * $alpha_level ) ) ); |
92 | 96 | } # END _get_ave_color() |
93 | 97 | |
94 | 98 | # return closest pallette-color match for RGB values |
99 | + |
|
100 | + /** |
|
101 | + * @param double $r |
|
102 | + * @param double $g |
|
103 | + * @param double $b |
|
104 | + */ |
|
95 | 105 | function _get_image_color($im, $r, $g, $b) { |
96 | 106 | $c=imagecolorexact($im, $r, $g, $b); |
97 | 107 | if ($c>0) return $c; |
@@ -103,7 +103,7 @@ discard block |
||
103 | 103 | * before drawing the text |
104 | 104 | * ) |
105 | 105 | * |
106 | - * @return none |
|
106 | + * @return boolean |
|
107 | 107 | * @see PEAR::isError() |
108 | 108 | */ |
109 | 109 | function addText($params) |
@@ -151,7 +151,7 @@ discard block |
||
151 | 151 | * 'color_mask'=>array(r,g,b), named color or #rrggbb |
152 | 152 | * ) |
153 | 153 | * @author Pierre-Alain Joye |
154 | - * @return mixed none or a PEAR error object on error |
|
154 | + * @return boolean none or a PEAR error object on error |
|
155 | 155 | * @see PEAR::isError() |
156 | 156 | */ |
157 | 157 | function rotate($angle, $options=null) |
@@ -340,7 +340,7 @@ discard block |
||
340 | 340 | * @param $new_x int new width |
341 | 341 | * @param $new_y int new height |
342 | 342 | * |
343 | - * @return true on success or pear error |
|
343 | + * @return boolean on success or pear error |
|
344 | 344 | * @see PEAR::isError() |
345 | 345 | */ |
346 | 346 | function _resize($new_x, $new_y) { |
@@ -369,10 +369,6 @@ discard block |
||
369 | 369 | /** |
370 | 370 | * Crop the image |
371 | 371 | * |
372 | - * @param int $crop_x left column of the image |
|
373 | - * @param int $crop_y top row of the image |
|
374 | - * @param int $crop_width new cropped image width |
|
375 | - * @param int $crop_height new cropped image height |
|
376 | 372 | */ |
377 | 373 | function crop($new_x, $new_y, $new_width, $new_height) |
378 | 374 | { |
@@ -242,7 +242,7 @@ |
||
242 | 242 | /** |
243 | 243 | * Destroy image handle |
244 | 244 | * |
245 | - * @return none |
|
245 | + * @return boolean |
|
246 | 246 | */ |
247 | 247 | function free() |
248 | 248 | { |