@@ -72,6 +72,7 @@ discard block |
||
72 | 72 | * This is a stupid function pulled from original Elgg code |
73 | 73 | * |
74 | 74 | * @param ElggEntity The entity sending the message |
75 | + * @param ElggEntity $from |
|
75 | 76 | * @return string with email address |
76 | 77 | */ |
77 | 78 | function phpmailer_extract_from_email($from) { |
@@ -98,8 +99,6 @@ discard block |
||
98 | 99 | /** |
99 | 100 | * Send an email using phpmailer |
100 | 101 | * |
101 | - * @param string $from From address |
|
102 | - * @param string $from_name From name |
|
103 | 102 | * @param string $to To address |
104 | 103 | * @param string $to_name To name |
105 | 104 | * @param string $subject The subject of the message. |
@@ -271,6 +270,9 @@ discard block |
||
271 | 270 | |
272 | 271 | |
273 | 272 | |
273 | +/** |
|
274 | + * @param string $type |
|
275 | + */ |
|
274 | 276 | function phpmailer_logging($errMess, $errStack, $type, $errType) { |
275 | 277 | // logging mechanism |
276 | 278 | if (elgg_is_active_plugin('wet4')) { |
@@ -68,7 +68,7 @@ discard block |
||
68 | 68 | * poll page handler; allows the use of fancy URLs |
69 | 69 | * |
70 | 70 | * @param array $page From the page_handler function |
71 | - * @return true|false Depending on success |
|
71 | + * @return boolean Depending on success |
|
72 | 72 | */ |
73 | 73 | function polls_page_handler($page) { |
74 | 74 | elgg_load_library('elgg:polls'); |
@@ -108,7 +108,6 @@ discard block |
||
108 | 108 | /** |
109 | 109 | * Populates the ->getUrl() method for poll objects |
110 | 110 | * |
111 | - * @param ElggEntity $pollpost poll post entity |
|
112 | 111 | * @return string poll post URL |
113 | 112 | */ |
114 | 113 | function polls_url($poll) { |
@@ -361,7 +361,7 @@ |
||
361 | 361 | * @param string $type Hook type |
362 | 362 | * @param array $value Array of custom search types |
363 | 363 | * @param array $params Search parameters |
364 | - * @return array |
|
364 | + * @return string[] |
|
365 | 365 | */ |
366 | 366 | function search_custom_types_tags_hook($hook, $type, $value, $params) { |
367 | 367 | $value[] = 'tags'; |
@@ -293,7 +293,7 @@ discard block |
||
293 | 293 | * (Unless the entire query is < ft_min_word_chars, in which case |
294 | 294 | * it's taken literally.) |
295 | 295 | * |
296 | - * @param array $query |
|
296 | + * @param string $query |
|
297 | 297 | * @param str $format Return as an array or a string |
298 | 298 | * @return mixed |
299 | 299 | */ |
@@ -330,7 +330,6 @@ discard block |
||
330 | 330 | * Passes results, and original params to the view functions for |
331 | 331 | * search type. |
332 | 332 | * |
333 | - * @param array $results |
|
334 | 333 | * @param array $params |
335 | 334 | * @param string $view_type = list, entity or layout |
336 | 335 | * @return string |
@@ -379,7 +378,7 @@ discard block |
||
379 | 378 | * Returns a where clause for a search query. |
380 | 379 | * |
381 | 380 | * @param str $table Prefix for table to search on |
382 | - * @param array $fields Fields to match against |
|
381 | + * @param string[] $fields Fields to match against |
|
383 | 382 | * @param array $params Original search params |
384 | 383 | * @return str |
385 | 384 | */ |
@@ -453,7 +453,7 @@ discard block |
||
453 | 453 | * |
454 | 454 | * @see simplesaml_generate_unique_username() |
455 | 455 | * |
456 | - * @return bool|string a unique username, false on failure |
|
456 | + * @return string|false a unique username, false on failure |
|
457 | 457 | */ |
458 | 458 | function simplesaml_generate_username_from_email($email) { |
459 | 459 | $result = false; |
@@ -476,7 +476,7 @@ discard block |
||
476 | 476 | * |
477 | 477 | * @param string $username the username to use as a base |
478 | 478 | * |
479 | - * @return bool|string a unique username, false on failure |
|
479 | + * @return string|false a unique username, false on failure |
|
480 | 480 | */ |
481 | 481 | function simplesaml_generate_unique_username($username) { |
482 | 482 | $result = false; |
@@ -11,7 +11,7 @@ |
||
11 | 11 | * @param array $return_value the default return value |
12 | 12 | * @param array $params an array with parameter to help extending the result |
13 | 13 | * |
14 | - * @return array an array with all the allowed pages |
|
14 | + * @return string[] an array with all the allowed pages |
|
15 | 15 | */ |
16 | 16 | function simplesaml_walled_garden_hook($hook, $type, $return_value, $params) { |
17 | 17 | $result = $return_value; |
@@ -22,6 +22,9 @@ |
||
22 | 22 | elgg_register_action('sphinx/configure', dirname(__FILE__) . '/actions/sphinx/configure.php', 'admin'); |
23 | 23 | } |
24 | 24 | |
25 | +/** |
|
26 | + * @param string $index |
|
27 | + */ |
|
25 | 28 | function sphinx_query($params, $index) { |
26 | 29 | $cl = new SphinxClient(); |
27 | 30 | $cl->SetServer("localhost", 9312); |
@@ -265,6 +265,8 @@ discard block |
||
265 | 265 | /** |
266 | 266 | * Grabs all user IDs with images in the files repo. |
267 | 267 | * return mixed. False on fail, array of GUIDs on success. |
268 | + * @param integer $offset |
|
269 | + * @param integer $limit |
|
268 | 270 | */ |
269 | 271 | function tidypics_get_user_guids_with_pics_in_files($offset, $limit) { |
270 | 272 | $db_prefix = elgg_get_config('dbprefix'); |
@@ -296,6 +298,7 @@ discard block |
||
296 | 298 | |
297 | 299 | /** |
298 | 300 | * Gets a list of images for a single user. |
301 | + * @param integer|null $user_guid |
|
299 | 302 | * @return array of GUIDs, false on fail. |
300 | 303 | */ |
301 | 304 | function tidypics_get_user_pics_from_files($user_guid) { |
@@ -14,6 +14,9 @@ discard block |
||
14 | 14 | * @param ElggFile holds the image that was uploaded |
15 | 15 | * @param string folder to store thumbnail in |
16 | 16 | * @param string name of the thumbnail |
17 | + * @param TidypicsImage $file |
|
18 | + * @param string $prefix |
|
19 | + * @param string $filestorename |
|
17 | 20 | * @return bool TRUE on success |
18 | 21 | */ |
19 | 22 | function tp_create_gd_thumbnails($file, $prefix, $filestorename) { |
@@ -91,7 +94,8 @@ discard block |
||
91 | 94 | * @param bool - watermark this image? |
92 | 95 | * @param int $maxwidth The maximum width of the resized image |
93 | 96 | * @param int $maxheight The maximum height of the resized image |
94 | - * @param TRUE|FALSE $square If set to TRUE, will take the smallest of maxwidth and maxheight and use it to set the dimensions on all size; the image will be cropped. |
|
97 | + * @param boolean $square If set to TRUE, will take the smallest of maxwidth and maxheight and use it to set the dimensions on all size; the image will be cropped. |
|
98 | + * @param boolean $watermark |
|
95 | 99 | * @return bool TRUE on success or FALSE on failure |
96 | 100 | */ |
97 | 101 | function tp_gd_resize($input_name, $output_name, $watermark, $maxwidth, $maxheight, $square = FALSE, $x1 = 0, $y1 = 0, $x2 = 0, $y2 = 0) { |
@@ -194,6 +198,9 @@ discard block |
||
194 | 198 | * @param ElggFile holds the image that was uploaded |
195 | 199 | * @param string folder to store thumbnail in |
196 | 200 | * @param string name of the thumbnail |
201 | + * @param TidypicsImage $file |
|
202 | + * @param string $prefix |
|
203 | + * @param string $filestorename |
|
197 | 204 | * @return bool TRUE on success |
198 | 205 | */ |
199 | 206 | function tp_create_imagick_thumbnails($file, $prefix, $filestorename) { |
@@ -269,7 +276,7 @@ discard block |
||
269 | 276 | * @param string $output_name The name of the file to be written |
270 | 277 | * @param int $maxwidth The maximum width of the resized image |
271 | 278 | * @param int $maxheight The maximum height of the resized image |
272 | - * @param TRUE|FALSE $square If set to TRUE, will take the smallest of maxwidth and maxheight and use it to set the dimensions on all size; the image will be cropped. |
|
279 | + * @param boolean $square If set to TRUE, will take the smallest of maxwidth and maxheight and use it to set the dimensions on all size; the image will be cropped. |
|
273 | 280 | * @return bool TRUE on success |
274 | 281 | */ |
275 | 282 | function tp_imagick_resize($input_name, $output_name, $maxwidth, $maxheight, $square = FALSE, $x1 = 0, $y1 = 0, $x2 = 0, $y2 = 0) { |
@@ -324,6 +331,9 @@ discard block |
||
324 | 331 | * @param ElggFile holds the image that was uploaded |
325 | 332 | * @param string folder to store thumbnail in |
326 | 333 | * @param string name of the thumbnail |
334 | + * @param TidypicsImage $file |
|
335 | + * @param string $prefix |
|
336 | + * @param string $filestorename |
|
327 | 337 | * @return bool TRUE on success |
328 | 338 | */ |
329 | 339 | function tp_create_im_cmdline_thumbnails($file, $prefix, $filestorename) { |
@@ -398,7 +408,7 @@ discard block |
||
398 | 408 | * @param string $output_name The name of the file to be written |
399 | 409 | * @param int $maxwidth The maximum width of the resized image |
400 | 410 | * @param int $maxheight The maximum height of the resized image |
401 | - * @param TRUE|FALSE $square If set to TRUE, will take the smallest of maxwidth and maxheight and use it to set the dimensions on all size; the image will be cropped. |
|
411 | + * @param boolean $square If set to TRUE, will take the smallest of maxwidth and maxheight and use it to set the dimensions on all size; the image will be cropped. |
|
402 | 412 | * @return bool |
403 | 413 | */ |
404 | 414 | function tp_im_cmdline_resize($input_name, $output_name, $maxwidth, $maxheight, $square = FALSE, $x1 = 0, $y1 = 0, $x2 = 0, $y2 = 0) { |