@@ -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) { |
@@ -60,6 +60,7 @@ |
||
| 60 | 60 | * |
| 61 | 61 | * Each album gets a subdirectory based on its container id |
| 62 | 62 | * |
| 63 | + * @param integer $album_guid |
|
| 63 | 64 | * @return string path to image directory |
| 64 | 65 | */ |
| 65 | 66 | function tp_get_img_dir($album_guid) { |
@@ -53,7 +53,7 @@ |
||
| 53 | 53 | * Check if there is enough memory to process this image |
| 54 | 54 | * |
| 55 | 55 | * @param string $image_lib |
| 56 | - * @param int $requiredMemory |
|
| 56 | + * @param integer $mem_required |
|
| 57 | 57 | * @return bool false = not enough memory |
| 58 | 58 | */ |
| 59 | 59 | function tp_upload_memory_check($image_lib, $mem_required) { |
@@ -333,6 +333,7 @@ |
||
| 333 | 333 | * Gets the url to authorize a user. |
| 334 | 334 | * |
| 335 | 335 | * @param string $callback The callback URL |
| 336 | + * @return string |
|
| 336 | 337 | */ |
| 337 | 338 | function twitter_api_get_authorize_url($callback = NULL, $login = true) { |
| 338 | 339 | $session = elgg_get_session(); |
@@ -164,7 +164,7 @@ |
||
| 164 | 164 | * @param string $type |
| 165 | 165 | * @param array $return_value |
| 166 | 166 | * @param array $params |
| 167 | - * @return array |
|
| 167 | + * @return string[] |
|
| 168 | 168 | */ |
| 169 | 169 | function twitter_api_public_pages($hook, $type, $return_value, $params) { |
| 170 | 170 | $return_value[] = 'twitter_api/forward'; |
@@ -58,7 +58,7 @@ |
||
| 58 | 58 | * This function deletes unvalidated user accounts that are older than specified. |
| 59 | 59 | * |
| 60 | 60 | * @param $maxage is the oldest an unvalidated user account can be before being deleted (in sec) |
| 61 | - * @param $log is the output to the log file |
|
| 61 | + * @param resource $log is the output to the log file |
|
| 62 | 62 | */ |
| 63 | 63 | function delete_unvalidated_users($maxage, $log) { |
| 64 | 64 | $ia = elgg_set_ignore_access(TRUE); |
@@ -93,7 +93,7 @@ |
||
| 93 | 93 | * Map user records |
| 94 | 94 | * |
| 95 | 95 | * @param $data |
| 96 | - * @return boolean |
|
| 96 | + * @return boolean|null |
|
| 97 | 97 | */ |
| 98 | 98 | function mapRecords($data = null) { |
| 99 | 99 | |
@@ -202,7 +202,7 @@ |
||
| 202 | 202 | |
| 203 | 203 | /** |
| 204 | 204 | * Run an upgrade script to port plugin settings to 1.8.2 format |
| 205 | - * @return boolean |
|
| 205 | + * @return boolean|null |
|
| 206 | 206 | */ |
| 207 | 207 | function upload_users_upgrade_v1_8_2() { |
| 208 | 208 | |