@@ -328,6 +328,9 @@ |
||
328 | 328 | return build_query( array( 'value' => urlencode($post[$column]), 'id' => $post['ID'] ) ); |
329 | 329 | } |
330 | 330 | |
331 | + /** |
|
332 | + * @param string $column |
|
333 | + */ |
|
331 | 334 | function _build_date_range_query( $column, $range, $where ) { |
332 | 335 | global $wpdb; |
333 | 336 |
@@ -297,6 +297,7 @@ discard block |
||
297 | 297 | * @param array $items item tree |
298 | 298 | * @param array &$items_list output flat list of items |
299 | 299 | * @param int &$counter for creating temporary IDs |
300 | + * @param integer $counter |
|
300 | 301 | */ |
301 | 302 | protected function untreeify_items( $items, &$items_list, &$counter ) { |
302 | 303 | foreach( $items as $index => $item ) { |
@@ -546,6 +547,7 @@ discard block |
||
546 | 547 | * This function will create items that have a 'tmp_id' set, and |
547 | 548 | * update any items with a 'tmp_parent' to use the |
548 | 549 | * newly created item as a parent. |
550 | + * @param integer $menu_id |
|
549 | 551 | */ |
550 | 552 | function create_new_items( $data, $menu_id ) { |
551 | 553 | $tmp_to_actual_ids = array(); |
@@ -571,6 +573,7 @@ discard block |
||
571 | 573 | /** |
572 | 574 | * remove any existing menu items not present in the supplied array. |
573 | 575 | * returns wp_error if an item cannot be deleted. |
576 | + * @param integer $menu_id |
|
574 | 577 | */ |
575 | 578 | function delete_items_not_present( $menu_id, $menu_items ) { |
576 | 579 |
@@ -35,6 +35,12 @@ discard block |
||
35 | 35 | |
36 | 36 | // /sites/%s/posts/%d/replies/new -> $blog_id, $post_id |
37 | 37 | // /sites/%s/comments/%d/replies/new -> $blog_id, $comment_id |
38 | + |
|
39 | + /** |
|
40 | + * @param string $path |
|
41 | + * @param integer $post_id |
|
42 | + * @param integer $comment_parent_id |
|
43 | + */ |
|
38 | 44 | function new_comment( $path, $blog_id, $post_id, $comment_parent_id ) { |
39 | 45 | if ( !$post_id ) { |
40 | 46 | $comment_parent = get_comment( $comment_parent_id ); |
@@ -146,6 +152,11 @@ discard block |
||
146 | 152 | } |
147 | 153 | |
148 | 154 | // /sites/%s/comments/%d -> $blog_id, $comment_id |
155 | + |
|
156 | + /** |
|
157 | + * @param string $path |
|
158 | + * @param integer $comment_id |
|
159 | + */ |
|
149 | 160 | function update_comment( $path, $blog_id, $comment_id ) { |
150 | 161 | $comment = get_comment( $comment_id ); |
151 | 162 | if ( !$comment || is_wp_error( $comment ) ) { |
@@ -235,6 +246,11 @@ discard block |
||
235 | 246 | } |
236 | 247 | |
237 | 248 | // /sites/%s/comments/%d/delete -> $blog_id, $comment_id |
249 | + |
|
250 | + /** |
|
251 | + * @param string $path |
|
252 | + * @param integer $comment_id |
|
253 | + */ |
|
238 | 254 | function delete_comment( $path, $blog_id, $comment_id ) { |
239 | 255 | $comment = get_comment( $comment_id ); |
240 | 256 | if ( !$comment || is_wp_error( $comment ) ) { |
@@ -28,6 +28,11 @@ discard block |
||
28 | 28 | |
29 | 29 | // /sites/%s/posts/new -> $blog_id |
30 | 30 | // /sites/%s/posts/%d -> $blog_id, $post_id |
31 | + |
|
32 | + /** |
|
33 | + * @param string $path |
|
34 | + * @param integer $post_id |
|
35 | + */ |
|
31 | 36 | function write_post( $path, $blog_id, $post_id ) { |
32 | 37 | $new = $this->api->ends_with( $path, '/new' ); |
33 | 38 | $args = $this->query_args(); |
@@ -610,6 +615,11 @@ discard block |
||
610 | 615 | } |
611 | 616 | |
612 | 617 | // /sites/%s/posts/%d/delete -> $blog_id, $post_id |
618 | + |
|
619 | + /** |
|
620 | + * @param string $path |
|
621 | + * @param integer $post_id |
|
622 | + */ |
|
613 | 623 | function delete_post( $path, $blog_id, $post_id ) { |
614 | 624 | $post = get_post( $post_id ); |
615 | 625 | if ( !$post || is_wp_error( $post ) ) { |
@@ -645,6 +655,11 @@ discard block |
||
645 | 655 | } |
646 | 656 | |
647 | 657 | // /sites/%s/posts/%d/restore -> $blog_id, $post_id |
658 | + |
|
659 | + /** |
|
660 | + * @param string $path |
|
661 | + * @param integer $post_id |
|
662 | + */ |
|
648 | 663 | function restore_post( $path, $blog_id, $post_id ) { |
649 | 664 | $args = $this->query_args(); |
650 | 665 | $post = get_post( $post_id ); |
@@ -665,6 +680,10 @@ discard block |
||
665 | 680 | return $this->get_post_by( 'ID', $post->ID, $args['context'] ); |
666 | 681 | } |
667 | 682 | |
683 | + /** |
|
684 | + * @param boolean $delete_featured_image |
|
685 | + * @param string $featured_image |
|
686 | + */ |
|
668 | 687 | private function parse_and_set_featured_image( $post_id, $delete_featured_image, $featured_image ) { |
669 | 688 | if ( $delete_featured_image ) { |
670 | 689 | delete_post_thumbnail( $post_id ); |
@@ -26,6 +26,11 @@ discard block |
||
26 | 26 | } |
27 | 27 | |
28 | 28 | // /sites/%s/tags|categories/new -> $blog_id |
29 | + |
|
30 | + /** |
|
31 | + * @param string $path |
|
32 | + * @param string $taxonomy_type |
|
33 | + */ |
|
29 | 34 | function new_taxonomy( $path, $blog_id, $taxonomy_type ) { |
30 | 35 | $args = $this->query_args(); |
31 | 36 | $input = $this->input(); |
@@ -77,6 +82,12 @@ discard block |
||
77 | 82 | } |
78 | 83 | |
79 | 84 | // /sites/%s/tags|categories/slug:%s -> $blog_id, $taxonomy_id |
85 | + |
|
86 | + /** |
|
87 | + * @param string $path |
|
88 | + * @param integer $object_id |
|
89 | + * @param string $taxonomy_type |
|
90 | + */ |
|
80 | 91 | function update_taxonomy( $path, $blog_id, $object_id, $taxonomy_type ) { |
81 | 92 | $taxonomy = get_term_by( 'slug', $object_id, $taxonomy_type ); |
82 | 93 | $tax = get_taxonomy( $taxonomy_type ); |
@@ -122,6 +133,12 @@ discard block |
||
122 | 133 | } |
123 | 134 | |
124 | 135 | // /sites/%s/tags|categories/%s/delete -> $blog_id, $taxonomy_id |
136 | + |
|
137 | + /** |
|
138 | + * @param string $path |
|
139 | + * @param integer $object_id |
|
140 | + * @param string $taxonomy_type |
|
141 | + */ |
|
125 | 142 | function delete_taxonomy( $path, $blog_id, $object_id, $taxonomy_type ) { |
126 | 143 | $taxonomy = get_term_by( 'slug', $object_id, $taxonomy_type ); |
127 | 144 | $tax = get_taxonomy( $taxonomy_type ); |
@@ -289,7 +289,7 @@ discard block |
||
289 | 289 | * Get the value of a setting. |
290 | 290 | * @param string $setting |
291 | 291 | * @access public |
292 | - * @return mixed |
|
292 | + * @return string |
|
293 | 293 | * @version 1.0 |
294 | 294 | */ |
295 | 295 | function get_cfg($setting) { |
@@ -358,7 +358,7 @@ discard block |
||
358 | 358 | |
359 | 359 | /** |
360 | 360 | * Adds a token to $this->tokens |
361 | - * @param mixed $type |
|
361 | + * @param integer $type |
|
362 | 362 | * @param string $data |
363 | 363 | * @param bool $do add a token even if preserve_css is off |
364 | 364 | * @access private |
@@ -1189,6 +1189,7 @@ discard block |
||
1189 | 1189 | * format("abc, def, ghi") => format("abc, def, ghi") |
1190 | 1190 | * |
1191 | 1191 | * @param string |
1192 | + * @param string $value |
|
1192 | 1193 | * @return array |
1193 | 1194 | */ |
1194 | 1195 |
@@ -38,6 +38,9 @@ |
||
38 | 38 | /* ctype_alpha Check for alphabetic character(s) */ |
39 | 39 | if (!function_exists('ctype_alpha')) { |
40 | 40 | |
41 | + /** |
|
42 | + * @param string $text |
|
43 | + */ |
|
41 | 44 | function ctype_alpha($text) { |
42 | 45 | return preg_match("/[a-zA-Z]/", $text); |
43 | 46 | } |
@@ -77,6 +77,9 @@ discard block |
||
77 | 77 | return null; |
78 | 78 | } |
79 | 79 | |
80 | + /** |
|
81 | + * @param string $name |
|
82 | + */ |
|
80 | 83 | protected function fileExists($name) { |
81 | 84 | return is_file($name); |
82 | 85 | } |
@@ -260,6 +263,9 @@ discard block |
||
260 | 263 | return $scope; |
261 | 264 | } |
262 | 265 | |
266 | + /** |
|
267 | + * @param string[] $selectors |
|
268 | + */ |
|
263 | 269 | protected function compileNestedBlock($block, $selectors) { |
264 | 270 | $this->pushEnv($block); |
265 | 271 | $this->scope = $this->makeOutputBlock($block->type, $selectors); |
@@ -278,6 +284,9 @@ discard block |
||
278 | 284 | $this->popEnv(); |
279 | 285 | } |
280 | 286 | |
287 | + /** |
|
288 | + * @param stdClass $out |
|
289 | + */ |
|
281 | 290 | protected function compileProps($block, $out) { |
282 | 291 | foreach ($this->sortProps($block->props) as $prop) { |
283 | 292 | $this->compileProp($prop, $block, $out); |
@@ -388,6 +397,9 @@ discard block |
||
388 | 397 | return $out; |
389 | 398 | } |
390 | 399 | |
400 | + /** |
|
401 | + * @param stdClass $env |
|
402 | + */ |
|
391 | 403 | protected function multiplyMedia($env, $childQueries = null) { |
392 | 404 | if (is_null($env) || |
393 | 405 | !empty($env->block->type) && $env->block->type != "media") |
@@ -1288,6 +1300,9 @@ discard block |
||
1288 | 1300 | $this->throwError($error); |
1289 | 1301 | } |
1290 | 1302 | |
1303 | + /** |
|
1304 | + * @param integer $expectedArgs |
|
1305 | + */ |
|
1291 | 1306 | public function assertArgs($value, $expectedArgs, $name="") { |
1292 | 1307 | if ($expectedArgs == 1) { |
1293 | 1308 | return $value; |
@@ -1342,6 +1357,11 @@ discard block |
||
1342 | 1357 | return $out; |
1343 | 1358 | } |
1344 | 1359 | |
1360 | + /** |
|
1361 | + * @param double $comp |
|
1362 | + * @param double $temp1 |
|
1363 | + * @param double $temp2 |
|
1364 | + */ |
|
1345 | 1365 | protected function toRGB_helper($comp, $temp1, $temp2) { |
1346 | 1366 | if ($comp < 0) $comp += 1.0; |
1347 | 1367 | elseif ($comp > 1) $comp -= 1.0; |
@@ -2317,6 +2337,9 @@ discard block |
||
2317 | 2337 | // caches preg escaped literals |
2318 | 2338 | static protected $literalCache = array(); |
2319 | 2339 | |
2340 | + /** |
|
2341 | + * @param lessc $lessc |
|
2342 | + */ |
|
2320 | 2343 | public function __construct($lessc, $sourceName = null) { |
2321 | 2344 | $this->eatWhiteDefault = true; |
2322 | 2345 | // reference to less needed for vPrefix, mPrefix, and parentSelector |
@@ -2617,6 +2640,7 @@ discard block |
||
2617 | 2640 | |
2618 | 2641 | /** |
2619 | 2642 | * recursively parse infix equation with $lhs at precedence $minP |
2643 | + * @param integer $minP |
|
2620 | 2644 | */ |
2621 | 2645 | protected function expHelper($lhs, $minP) { |
2622 | 2646 | $this->inExp = true; |
@@ -2843,6 +2867,11 @@ discard block |
||
2843 | 2867 | } |
2844 | 2868 | |
2845 | 2869 | // an unbounded string stopped by $end |
2870 | + |
|
2871 | + /** |
|
2872 | + * @param string $end |
|
2873 | + * @param string[] $rejectStrs |
|
2874 | + */ |
|
2846 | 2875 | protected function openString($end, &$out, $nestingOpen=null, $rejectStrs = null) { |
2847 | 2876 | $oldWhite = $this->eatWhiteDefault; |
2848 | 2877 | $this->eatWhiteDefault = false; |
@@ -3423,6 +3452,9 @@ discard block |
||
3423 | 3452 | |
3424 | 3453 | /* raw parsing functions */ |
3425 | 3454 | |
3455 | + /** |
|
3456 | + * @param boolean $eatWhitespace |
|
3457 | + */ |
|
3426 | 3458 | protected function literal($what, $eatWhitespace = null) { |
3427 | 3459 | if ($eatWhitespace === null) $eatWhitespace = $this->eatWhiteDefault; |
3428 | 3460 | |
@@ -3446,6 +3478,9 @@ discard block |
||
3446 | 3478 | return $this->match(self::$literalCache[$what], $m, $eatWhitespace); |
3447 | 3479 | } |
3448 | 3480 | |
3481 | + /** |
|
3482 | + * @param string $parseItem |
|
3483 | + */ |
|
3449 | 3484 | protected function genericList(&$out, $parseItem, $delim="", $flatten=true) { |
3450 | 3485 | $s = $this->seek(); |
3451 | 3486 | $items = array(); |
@@ -3519,6 +3554,10 @@ discard block |
||
3519 | 3554 | } |
3520 | 3555 | |
3521 | 3556 | // match something without consuming it |
3557 | + |
|
3558 | + /** |
|
3559 | + * @param string $regex |
|
3560 | + */ |
|
3522 | 3561 | protected function peek($regex, &$out = null, $from=null) { |
3523 | 3562 | if (is_null($from)) $from = $this->count; |
3524 | 3563 | $r = '/'.$regex.'/Ais'; |
@@ -3574,6 +3613,10 @@ discard block |
||
3574 | 3613 | } |
3575 | 3614 | |
3576 | 3615 | // push a block that doesn't multiply tags |
3616 | + |
|
3617 | + /** |
|
3618 | + * @param string $type |
|
3619 | + */ |
|
3577 | 3620 | protected function pushSpecialBlock($type) { |
3578 | 3621 | return $this->pushBlock(null, $type); |
3579 | 3622 | } |
@@ -139,7 +139,7 @@ |
||
139 | 139 | * @param string $avatar The <img/> element of the avatar. |
140 | 140 | * @param mixed $author User ID, email address, user login, comment object, user object, post object |
141 | 141 | * |
142 | - * @return The <img/> element of the avatar. |
|
142 | + * @return string <img/> element of the avatar. |
|
143 | 143 | */ |
144 | 144 | function grofiles_get_avatar( $avatar, $author ) { |
145 | 145 | if ( is_numeric( $author ) ) { |