Completed
Pull Request — 2.x (#4455)
by Scott Kingsley
04:54
created
includes/data.php 1 patch
Doc Comments   +2 added lines, -5 removed lines patch added patch discarded remove patch
@@ -847,7 +847,7 @@  discard block
 block discarded – undo
847 847
  *
848 848
  * @param mixed $value The value to be set
849 849
  * @param mixed $var The variable name, or URI segment position / query var name (if $type is 'url')
850
- * @param string|array|object $type (optional) Super globals, url/url-relative, constants, globals, user data, Pod field values
850
+ * @param string $type (optional) Super globals, url/url-relative, constants, globals, user data, Pod field values
851 851
  *
852 852
  * @return mixed Updated URL (if $type is 'url'), $value (if $type is 'constant'), Item ID (if $type is 'pods'), $type, or false if not set
853 853
  * @since 2.3.10
@@ -1210,7 +1210,7 @@  discard block
 block discarded – undo
1210 1210
 /**
1211 1211
  * Create a slug from an input string
1212 1212
  *
1213
- * @param $orig
1213
+ * @param string $orig
1214 1214
  *
1215 1215
  * @return string Sanitized slug
1216 1216
  *
@@ -1905,7 +1905,6 @@  discard block
 block discarded – undo
1905 1905
  *
1906 1906
  * @param array|object $list List of items
1907 1907
  * @param array $args Array of index, parent, children, id, and prefix keys to use
1908
- * @param string $children_key Key to recurse children into
1909 1908
  *
1910 1909
  * @return array|object
1911 1910
  * @since 2.3
@@ -1939,9 +1938,7 @@  discard block
 block discarded – undo
1939 1938
 /**
1940 1939
  * Recurse list of hierarchical data
1941 1940
  *
1942
- * @param array|object $list List of items
1943 1941
  * @param array $args Array of children and prefix keys to use
1944
- * @param string $children_key Key to recurse children into
1945 1942
  *
1946 1943
  * @see pods_hierarchical_select
1947 1944
  * @return array
Please login to merge, or discard this patch.
includes/general.php 1 patch
Doc Comments   +3 added lines, -4 removed lines patch added patch discarded remove patch
@@ -310,7 +310,6 @@  discard block
 block discarded – undo
310 310
 /**
311 311
  * Determine if Deprecated Mode is enabled
312 312
  *
313
- * @param bool $include_debug Whether to include strict mode
314 313
  *
315 314
  * @return bool Whether Deprecated Mode is enabled
316 315
  *
@@ -443,6 +442,7 @@  discard block
 block discarded – undo
443 442
  * @param string $minimum_version Minimum version
444 443
  * @param string $comparison Comparison operator
445 444
  * @param string $maximum_version Maximum version
445
+ * @param string $what
446 446
  *
447 447
  * @return bool
448 448
  */
@@ -906,7 +906,7 @@  discard block
 block discarded – undo
906 906
  * @uses get_shortcode_regex() Gets the search pattern for searching shortcodes.
907 907
  *
908 908
  * @param string $content Content to search for shortcodes
909
- * @param array $shortcodes Array of shortcodes to run
909
+ * @param string[] $shortcodes Array of shortcodes to run
910 910
  * @return string Content with shortcodes filtered out.
911 911
  */
912 912
 function pods_do_shortcode( $content, $shortcodes ) {
@@ -1446,7 +1446,7 @@  discard block
 block discarded – undo
1446 1446
  * @param string|bool $key Key for the cache
1447 1447
  * @param string $group (optional) Key for the group
1448 1448
  *
1449
- * @return bool|mixed|null|void
1449
+ * @return boolean
1450 1450
  *
1451 1451
  * @since 2.0
1452 1452
  */
@@ -1654,7 +1654,6 @@  discard block
 block discarded – undo
1654 1654
  *
1655 1655
  * @param string|array $pod The pod name or array of pod names
1656 1656
  * @param string $name The name of the Pod
1657
- * @param array $object (optional) Pod array, including any 'fields' arrays
1658 1657
  *
1659 1658
  * @return array|boolean Field data or false if unsuccessful
1660 1659
  * @since 2.1
Please login to merge, or discard this patch.
sql/upgrade/PodsUpgrade.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -137,7 +137,7 @@  discard block
 block discarded – undo
137 137
     }
138 138
 
139 139
     /**
140
-     * @param $method
140
+     * @param string $method
141 141
      * @param $v
142 142
      * @param null $x
143 143
      */
@@ -156,7 +156,7 @@  discard block
 block discarded – undo
156 156
     }
157 157
 
158 158
     /**
159
-     * @param $method
159
+     * @param string $method
160 160
      * @param null $x
161 161
      *
162 162
      * @return bool
Please login to merge, or discard this patch.
sql/upgrade/PodsUpgrade_2_1_0.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -16,7 +16,7 @@
 block discarded – undo
16 16
     }
17 17
 
18 18
     /**
19
-     * @return array|bool|int|mixed|null|void
19
+     * @return integer
20 20
      */
21 21
     public function prepare_relationships () {
22 22
         $relationship_fields = $this->api->load_fields( array( 'type' => 'pick' ) );
Please login to merge, or discard this patch.
classes/fields/oembed.php 1 patch
Doc Comments   +2 added lines, -3 removed lines patch added patch discarded remove patch
@@ -156,7 +156,7 @@  discard block
 block discarded – undo
156 156
 	 *
157 157
 	 * @param array $options
158 158
 	 *
159
-	 * @return array
159
+	 * @return string
160 160
 	 * @since 2.0
161 161
 	 */
162 162
 	public function schema ( $options = null ) {
@@ -168,10 +168,9 @@  discard block
 block discarded – undo
168 168
 	/**
169 169
 	 * Change the way the value of the field is displayed with Pods::get
170 170
 	 *
171
-	 * @param mixed $value
171
+	 * @param string $value
172 172
 	 * @param string $name
173 173
 	 * @param array $options
174
-	 * @param array $fields
175 174
 	 * @param array $pod
176 175
 	 * @param int $id
177 176
 	 *
Please login to merge, or discard this patch.
classes/PodsInit.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -935,7 +935,7 @@
 block discarded – undo
935 935
 	 * @param        $args
936 936
 	 * @param string $type
937 937
 	 *
938
-	 * @return array
938
+	 * @return string
939 939
 	 */
940 940
 	public static function object_label_fix( $args, $type = 'post_type' ) {
941 941
 
Please login to merge, or discard this patch.
classes/PodsAPI.php 1 patch
Doc Comments   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -1559,7 +1559,7 @@  discard block
 block discarded – undo
1559 1559
      *
1560 1560
      * @param array $params An associative array of parameters
1561 1561
      * @param bool $sanitized (optional) Decides whether the params have been sanitized before being passed, will sanitize them if false.
1562
-     * @param bool|int $db (optional) Whether to save into the DB or just return Pod array.
1562
+     * @param boolean $db (optional) Whether to save into the DB or just return Pod array.
1563 1563
      *
1564 1564
      * @return int Pod ID
1565 1565
      * @since 1.7.9
@@ -3903,7 +3903,7 @@  discard block
 block discarded – undo
3903 3903
      * Save relationships
3904 3904
      *
3905 3905
      * @param int $id ID of item
3906
-     * @param int|array $related_id ID or IDs to save
3906
+     * @param int|array $related_ids ID or IDs to save
3907 3907
      * @param array $pod Pod data
3908 3908
      * @param array $field Field data
3909 3909
      */
@@ -5061,7 +5061,6 @@  discard block
 block discarded – undo
5061 5061
      * Delete an object from tableless fields
5062 5062
      *
5063 5063
      * @param int $id
5064
-     * @param string $type
5065 5064
      * @param string $name
5066 5065
      *
5067 5066
      * @return bool
@@ -5284,6 +5283,7 @@  discard block
 block discarded – undo
5284 5283
      * $params['name'] string Pod name
5285 5284
      *
5286 5285
      * @param array $params An associative array of parameters
5286
+     * @param string $type
5287 5287
      *
5288 5288
      * @return bool True if exists
5289 5289
      *
@@ -6792,7 +6792,7 @@  discard block
 block discarded – undo
6792 6792
      * @param string $type Field type to look for
6793 6793
      * @param array $options (optional) Options of the field to pass to the schema function.
6794 6794
      *
6795
-     * @return array|bool|mixed|null
6795
+     * @return string
6796 6796
      *
6797 6797
      * @since 2.0
6798 6798
      */
@@ -7228,7 +7228,7 @@  discard block
 block discarded – undo
7228 7228
 	 *
7229 7229
 	 * Load the information about an objects MySQL table
7230 7230
 	 *
7231
-	 * @param $object_type
7231
+	 * @param string $object_type
7232 7232
 	 * @param string $object The object to look for
7233 7233
 	 * @param null $name (optional) Name of the pod to load
7234 7234
 	 * @param array $pod (optional) Array with pod information
Please login to merge, or discard this patch.
classes/PodsUI.php 1 patch
Doc Comments   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -427,7 +427,7 @@  discard block
 block discarded – undo
427 427
      * @param mixed $options Object, Array, or String containing Pod or Options to be used
428 428
      * @param bool $deprecated Set to true to support old options array from Pods UI plugin
429 429
      *
430
-     * @return \PodsUI
430
+     * @return false|null
431 431
      *
432 432
      * @license http://www.gnu.org/licenses/gpl-2.0.html
433 433
      * @since 2.0
@@ -1295,7 +1295,7 @@  discard block
 block discarded – undo
1295 1295
     }
1296 1296
 
1297 1297
     /**
1298
-     * @return mixed
1298
+     * @return null|boolean
1299 1299
      */
1300 1300
     public function go () {
1301 1301
         $this->do_hook( 'go' );
@@ -1495,7 +1495,7 @@  discard block
 block discarded – undo
1495 1495
      * @param bool $create
1496 1496
      * @param bool $duplicate
1497 1497
      *
1498
-     * @return bool|mixed
1498
+     * @return null|boolean
1499 1499
      */
1500 1500
     public function form ( $create = false, $duplicate = false ) {
1501 1501
         if ( in_array( 'duplicate', $this->actions_disabled ) )
@@ -1636,7 +1636,7 @@  discard block
 block discarded – undo
1636 1636
     }
1637 1637
 
1638 1638
     /**
1639
-     * @return bool|mixed
1639
+     * @return null|boolean
1640 1640
 	 * @since 2.3.10
1641 1641
      */
1642 1642
     public function view () {
@@ -1887,9 +1887,9 @@  discard block
 block discarded – undo
1887 1887
     }
1888 1888
 
1889 1889
     /**
1890
-     * @param null $id
1890
+     * @param integer $id
1891 1891
      *
1892
-     * @return bool|mixed
1892
+     * @return null|boolean
1893 1893
      */
1894 1894
     public function delete ( $id = null ) {
1895 1895
         $this->do_hook( 'pre_delete', $id );
@@ -2291,7 +2291,6 @@  discard block
 block discarded – undo
2291 2291
     }
2292 2292
 
2293 2293
     /**
2294
-     * @param bool $full Whether to get ALL data or use pagination
2295 2294
      *
2296 2295
      * @return bool
2297 2296
      */
@@ -2410,6 +2409,7 @@  discard block
 block discarded – undo
2410 2409
     }
2411 2410
 
2412 2411
     /**
2412
+     * @param string $method
2413 2413
      * @return array
2414 2414
      */
2415 2415
     public function get_row ( &$counter = 0, $method = null ) {
@@ -3300,7 +3300,7 @@  discard block
 block discarded – undo
3300 3300
     /**
3301 3301
      * @param bool $reorder
3302 3302
      *
3303
-     * @return bool|mixed
3303
+     * @return null|boolean
3304 3304
      */
3305 3305
     public function table ( $reorder = false ) {
3306 3306
 		if ( false !== $this->callback( 'table', $reorder ) ) {
@@ -4143,7 +4143,7 @@  discard block
 block discarded – undo
4143 4143
     }
4144 4144
 
4145 4145
     /**
4146
-     * @param bool|array $exclude
4146
+     * @param string[] $exclude
4147 4147
      * @param bool|array $array
4148 4148
      */
4149 4149
     public function hidden_vars ( $exclude = false, $array = false ) {
Please login to merge, or discard this patch.
classes/fields/password.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -64,7 +64,7 @@
 block discarded – undo
64 64
      *
65 65
      * @param array $options
66 66
      *
67
-     * @return array
67
+     * @return string
68 68
      * @since 2.0
69 69
      */
70 70
     public function schema ( $options = null ) {
Please login to merge, or discard this patch.