Completed
Pull Request — 2.x (#4455)
by Scott Kingsley
04:54
created
classes/fields/text.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -161,7 +161,7 @@  discard block
 block discarded – undo
161 161
      *
162 162
      * @param array $options
163 163
      *
164
-     * @return array
164
+     * @return string
165 165
      * @since 2.0
166 166
      */
167 167
     public function schema ( $options = null ) {
@@ -261,7 +261,7 @@  discard block
 block discarded – undo
261 261
      * @param array $pod
262 262
      * @param object $params
263 263
      *
264
-     * @return mixed|string
264
+     * @return string
265 265
      * @since 2.0
266 266
      */
267 267
     public function pre_save ( $value, $id = null, $name = null, $options = null, $fields = null, $pod = null, $params = null ) {
Please login to merge, or discard this patch.
classes/PodsForm.php 1 patch
Doc Comments   -5 removed lines patch added patch discarded remove patch
@@ -882,7 +882,6 @@  discard block
 block discarded – undo
882 882
      * @param mixed $value
883 883
      * @param string $name
884 884
      * @param array $options
885
-     * @param array $fields
886 885
      * @param array $pod
887 886
      * @param int $id
888 887
      * @param array $traverse
@@ -924,7 +923,6 @@  discard block
 block discarded – undo
924 923
      * @param mixed $value
925 924
      * @param string $name
926 925
      * @param array $options
927
-     * @param array $fields
928 926
      * @param array $pod
929 927
      * @param int $id
930 928
      * @param array $traverse
@@ -1295,9 +1293,6 @@  discard block
 block discarded – undo
1295 1293
     /**
1296 1294
      * Run a method from a Field Type's class
1297 1295
      *
1298
-     * @param string $field_type Field Type indentifier
1299
-     * @param string $method Method name
1300
-     * @param mixed $arg More arguments
1301 1296
      *
1302 1297
      * @return mixed
1303 1298
      * @access public
Please login to merge, or discard this patch.
classes/fields/link.php 1 patch
Doc Comments   -1 removed lines patch added patch discarded remove patch
@@ -50,7 +50,6 @@
 block discarded – undo
50 50
 	/**
51 51
 	 * Add options and set defaults to
52 52
 	 *
53
-	 * @param array $options
54 53
 	 *
55 54
 	 * @since 2.0
56 55
 	 */
Please login to merge, or discard this patch.
classes/fields/website.php 1 patch
Doc Comments   +2 added lines, -3 removed lines patch added patch discarded remove patch
@@ -50,7 +50,6 @@  discard block
 block discarded – undo
50 50
 	/**
51 51
 	 * Add options and set defaults to
52 52
 	 *
53
-	 * @param array $options
54 53
 	 *
55 54
 	 * @since 2.0
56 55
 	 */
@@ -120,7 +119,7 @@  discard block
 block discarded – undo
120 119
 	 *
121 120
 	 * @param array $options
122 121
 	 *
123
-	 * @return array
122
+	 * @return string
124 123
 	 * @since 2.0
125 124
 	 */
126 125
 	public function schema ( $options = null ) {
@@ -143,7 +142,7 @@  discard block
 block discarded – undo
143 142
 	 * @param array $pod
144 143
 	 * @param int $id
145 144
 	 *
146
-	 * @return mixed|null
145
+	 * @return string
147 146
 	 * @since 2.0
148 147
 	 */
149 148
 	public function display ( $value = null, $name = null, $options = null, $pod = null, $id = null ) {
Please login to merge, or discard this patch.
classes/fields/datetime.php 1 patch
Doc Comments   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -267,7 +267,7 @@  discard block
 block discarded – undo
267 267
 	 * @param array $pod
268 268
 	 * @param int $id
269 269
 	 *
270
-	 * @return mixed|null|string
270
+	 * @return string
271 271
 	 * @since 2.0
272 272
 	 */
273 273
 	public function display ( $value = null, $name = null, $options = null, $pod = null, $id = null ) {
@@ -393,7 +393,7 @@  discard block
 block discarded – undo
393 393
 	 * @param array $fields
394 394
 	 * @param array $pod
395 395
 	 *
396
-	 * @return mixed|null|string
396
+	 * @return false|string
397 397
 	 * @since 2.0
398 398
 	 */
399 399
 	public function ui ( $id, $value, $name = null, $options = null, $fields = null, $pod = null ) {
@@ -637,7 +637,7 @@  discard block
 block discarded – undo
637 637
 	 * @param string $date Defaults to time() if empty.
638 638
 	 * @param boolean $return_timestamp Whether to return the strtotime() or createFromFormat result or not
639 639
 	 *
640
-	 * @return DateTime|null|int|false
640
+	 * @return string
641 641
 	 */
642 642
 	public function createFromFormat ( $format, $date, $return_timestamp = false ) {
643 643
 		$datetime = null;
@@ -685,7 +685,7 @@  discard block
 block discarded – undo
685 685
 	 * Convert a date from one format to another
686 686
 	 *
687 687
 	 * @param $value
688
-	 * @param $new_format
688
+	 * @param string $new_format
689 689
 	 * @param string $original_format
690 690
 	 * @param boolean $return_timestamp Whether to return the strtotime() or createFromFormat result or not
691 691
 	 *
Please login to merge, or discard this patch.
classes/fields/number.php 1 patch
Doc Comments   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -218,7 +218,7 @@  discard block
 block discarded – undo
218 218
      * @param array $pod
219 219
      * @param int $id
220 220
      *
221
-     * @return mixed|null|string
221
+     * @return string
222 222
      * @since 2.0
223 223
      */
224 224
     public function display ( $value = null, $name = null, $options = null, $pod = null, $id = null ) {
@@ -310,7 +310,7 @@  discard block
 block discarded – undo
310 310
      * @param int $id
311 311
      * @param null $params
312 312
      *
313
-     * @return bool|mixed
313
+     * @return string|boolean
314 314
      * @since 2.0
315 315
      */
316 316
     public function validate ( $value, $name = null, $options = null, $fields = null, $pod = null, $id = null, $params = null ) {
@@ -348,7 +348,7 @@  discard block
 block discarded – undo
348 348
      * @param array $pod
349 349
      * @param object $params
350 350
      *
351
-     * @return mixed|string
351
+     * @return string
352 352
      * @since 2.0
353 353
      */
354 354
     public function pre_save ( $value, $id = null, $name = null, $options = null, $fields = null, $pod = null, $params = null ) {
@@ -378,7 +378,7 @@  discard block
 block discarded – undo
378 378
      * @param array $fields
379 379
      * @param array $pod
380 380
      *
381
-     * @return mixed|null|string
381
+     * @return string
382 382
      * @since 2.0
383 383
      */
384 384
     public function ui ( $id, $value, $name = null, $options = null, $fields = null, $pod = null ) {
Please login to merge, or discard this patch.
classes/Pods.php 1 patch
Doc Comments   +7 added lines, -10 removed lines patch added patch discarded remove patch
@@ -330,7 +330,7 @@  discard block
 block discarded – undo
330 330
 	/**
331 331
 	 * Rewind Iterator
332 332
 	 *
333
-	 * @return void|boolean
333
+	 * @return null|false
334 334
 	 *
335 335
 	 * @since 2.3.4
336 336
 	 *
@@ -381,7 +381,7 @@  discard block
 block discarded – undo
381 381
 	/**
382 382
 	 * Move onto the next Iterator row
383 383
 	 *
384
-	 * @return void|boolean
384
+	 * @return null|false
385 385
 	 *
386 386
 	 * @since 2.3.4
387 387
 	 *
@@ -476,7 +476,7 @@  discard block
 block discarded – undo
476 476
 	 * Return field array from a Pod, a field's data, or a field option
477 477
 	 *
478 478
 	 * @param null $field
479
-	 * @param null $option
479
+	 * @param string $option
480 480
 	 *
481 481
 	 * @return bool|mixed
482 482
 	 *
@@ -1975,7 +1975,6 @@  discard block
 block discarded – undo
1975 1975
 	 * Return the next item ID, loops at the first id to return the last
1976 1976
 	 *
1977 1977
 	 * @param int $id
1978
-	 * @param array $find_params
1979 1978
 	 *
1980 1979
 	 * @return int
1981 1980
 	 * @since 2.0
@@ -2491,7 +2490,7 @@  discard block
 block discarded – undo
2491 2490
 	 * @param null|int $offset Offset of rows
2492 2491
 	 * @param null|int $total Total rows
2493 2492
 	 *
2494
-	 * @return int Number of pages
2493
+	 * @return double Number of pages
2495 2494
 	 * @since 2.3.10
2496 2495
 	 */
2497 2496
 	public function total_pages( $limit = null, $offset = null, $total = null ) {
@@ -2600,7 +2599,7 @@  discard block
 block discarded – undo
2600 2599
 	 * @see PodsAPI::save_pod_item
2601 2600
 	 *
2602 2601
 	 * @param string $field Field name
2603
-	 * @param mixed $value ID(s) to add, int|float to add to number field, string for dates (+1 week), or string for text
2602
+	 * @param string $value ID(s) to add, int|float to add to number field, string for dates (+1 week), or string for text
2604 2603
 	 * @param int $id (optional) ID of the pod item to update
2605 2604
 	 *
2606 2605
 	 * @return int The item ID
@@ -2711,7 +2710,7 @@  discard block
 block discarded – undo
2711 2710
 	 * @see PodsAPI::save_pod_item
2712 2711
 	 *
2713 2712
 	 * @param string $field Field name
2714
-	 * @param mixed $value ID(s) to add, int|float to add to number field, string for dates (-1 week), or string for text
2713
+	 * @param string $value ID(s) to add, int|float to add to number field, string for dates (-1 week), or string for text
2715 2714
 	 * @param int $id (optional) ID of the pod item to update
2716 2715
 	 *
2717 2716
 	 * @return int The item ID
@@ -3321,7 +3320,7 @@  discard block
 block discarded – undo
3321 3320
 	 *
3322 3321
 	 * @see Pods_Templates::template
3323 3322
 	 *
3324
-	 * @param string $template The template name
3323
+	 * @param string $template_name The template name
3325 3324
 	 * @param string $code Custom template code to use instead
3326 3325
 	 * @param bool $deprecated Whether to use deprecated functionality based on old function usage
3327 3326
 	 *
@@ -3607,7 +3606,6 @@  discard block
 block discarded – undo
3607 3606
 	 * Replace magic tags with their values
3608 3607
 	 *
3609 3608
 	 * @param string $code The content to evaluate
3610
-	 * @param object $obj The Pods object
3611 3609
 	 *
3612 3610
 	 * @return string Code with Magic Tags evaluated
3613 3611
 	 *
@@ -3621,7 +3619,6 @@  discard block
 block discarded – undo
3621 3619
 	 * Replace magic tags with their values
3622 3620
 	 *
3623 3621
 	 * @param string $tag The magic tag to process
3624
-	 * @param object $obj The Pods object
3625 3622
 	 *
3626 3623
 	 * @return string Code with Magic Tags evaluated
3627 3624
 	 *
Please login to merge, or discard this patch.
components/Templates/includes/functions-view_template.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -18,7 +18,7 @@  discard block
 block discarded – undo
18 18
 /**
19 19
  * Return array of valid frontier type shortcode tags
20 20
  *
21
- * @return array
21
+ * @return string[]
22 22
  */
23 23
 function frontier_get_shortcodes() {
24 24
 	$shortcodes = array( 'each', 'pod_sub_template', 'once', 'pod_once_template', 'before', 'pod_before_template', 'after', 'pod_after_template', 'if', 'pod_if_field' );
@@ -239,7 +239,7 @@  discard block
 block discarded – undo
239 239
  * @param array attributes from template
240 240
  * @param string template to be processed
241 241
  *
242
- * @return null
242
+ * @return string
243 243
  * @since 2.4
244 244
  */
245 245
 function frontier_do_subtemplate( $atts, $content ) {
Please login to merge, or discard this patch.
classes/PodsAdmin.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -2555,7 +2555,7 @@  discard block
 block discarded – undo
2555 2555
      *
2556 2556
      * @param PodsUI $ui
2557 2557
      *
2558
-     * @return bool
2558
+     * @return boolean|null
2559 2559
      */
2560 2560
     public function admin_components_toggle ( PodsUI $ui ) {
2561 2561
         $component = $_GET[ 'id' ];
@@ -2688,7 +2688,7 @@  discard block
 block discarded – undo
2688 2688
      *
2689 2689
      * @param $capabilities List of extra capabilities to add
2690 2690
      *
2691
-     * @return array
2691
+     * @return string[]
2692 2692
      */
2693 2693
     public function admin_capabilities ( $capabilities ) {
2694 2694
         $pods = pods_api()->load_pods( array( 'type' => array( 'settings', 'post_type', 'taxonomy' ), 'fields' => false, 'table_info' => false ) );
@@ -3029,7 +3029,7 @@  discard block
 block discarded – undo
3029 3029
 	 *
3030 3030
 	 * @param array $pod
3031 3031
 	 *
3032
-	 * @return bool
3032
+	 * @return boolean|null
3033 3033
 	 */
3034 3034
 	protected function restable_pod( $pod ) {
3035 3035
 
Please login to merge, or discard this patch.