pods-framework / pods

deprecated/classes/Pods.php

Doc Comments +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
 	/**
 	 * Constructor - Pods Deprecated functionality (pre 2.0)
 	 *
-	 * @param object $obj The Pods object
+	 * @param Pods $obj The Pods object
 	 *
 	 * @license http://www.gnu.org/licenses/gpl-2.0.html
 	 * @since   2.0

deprecated/classes/PodsAPI.php

Doc Comments +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
 	/**
 	 * Constructor - PodsAPI Deprecated functionality (pre 2.0)
 	 *
-	 * @param object $obj The PodsAPI object
+	 * @param PodsAPI $obj The PodsAPI object
 	 *
 	 * @license http://www.gnu.org/licenses/gpl-2.0.html
 	 * @since   2.0

deprecated/deprecated.php

Doc Comments +3 added lines, -3 removed lines

@@ -442,7 +442,7 @@ 
  * @param string $message
  * @param bool   $error Whether or not it is an error message
  *
- * @return bool
+ * @return boolean|null
  *
  * @since     1.12
  * @deprcated 2.3
@@ -459,7 +459,7 @@ 
  *
  * @param string $message
  *
- * @return bool
+ * @return boolean|null
  *
  * @since     1.12
  * @deprcated 2.3
@@ -516,7 +516,7 @@ 
  *
  * @param $version
  *
- * @return array|string
+ * @return string
  */
 function pods_version_to_point( $version ) {
 

sql/upgrade/PodsUpgrade_2_1_0.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
 	}
 
 	/**
-	 * @return array|bool|int|mixed|null|void
+	 * @return integer
 	 */
 	public function prepare_relationships() {
 

classes/fields/datetime.php

Doc Comments +1 added lines, -1 removed lines

@@ -619,7 +619,7 @@
 	 * @param string  $date             Defaults to time() if empty.
 	 * @param boolean $return_timestamp Whether to return the strtotime() or createFromFormat result or not.
 	 *
-	 * @return DateTime|null|int|false
+	 * @return string
 	 */
 	public function createFromFormat( $format, $date, $return_timestamp = false ) {
 

classes/PodsAdmin.php

Doc Comments +4 added lines, -4 removed lines

@@ -2564,7 +2564,7 @@ 
 	 * @param PodsUI     $obj PodsUI object.
 	 * @param int|string $id  Item ID.
 	 *
-	 * @return mixed
+	 * @return boolean|null
 	 */
 	public function admin_setup_reset( $obj, $id ) {
 
@@ -2613,7 +2613,7 @@ 
 	 * @param int|string $id  Item ID.
 	 * @param PodsUI     $obj PodsUI object.
 	 *
-	 * @return mixed
+	 * @return boolean|null
 	 */
 	public function admin_setup_delete( $id, $obj ) {
 
@@ -2838,7 +2838,7 @@ 
 	 *
 	 * @param PodsUI $ui PodsUI object
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function admin_components_toggle( $ui ) {
 
@@ -2982,7 +2982,7 @@ 
 	 *
 	 * @param array $capabilities List of extra capabilities to add.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function admin_capabilities( $capabilities ) {
 

classes/PodsData.php

Doc Comments +3 added lines, -3 removed lines

@@ -2238,8 +2238,8 @@ 
 	 *
 	 * @param string|array $sql              The SQL to execute.
 	 * @param string       $error            Error to throw on problems.
-	 * @param null         $results_error    (optional).
-	 * @param null         $no_results_error (optional).
+	 * @param string|null         $results_error    (optional).
+	 * @param string|null         $no_results_error (optional).
 	 *
 	 * @return array|bool|mixed|null|void Result of the query
 	 *
@@ -2586,7 +2586,7 @@ 
 	/**
 	 * Get the string to use in a query for matching, uses WP_Query meta_query arguments
 	 *
-	 * @param string|int   $field  Field name or array index.
+	 * @param string   $field  Field name or array index.
 	 * @param array|string $q      Query array (meta_query) or string for matching.
 	 * @param array        $pod    Related Pod.
 	 * @param object       $params Parameters passed from select().

classes/Pods.php

Doc Comments +6 added lines, -6 removed lines

@@ -580,7 +580,7 @@ 
 	 * Return field array from a Pod, a field's data, or a field option
 	 *
 	 * @param null $field  Field name.
-	 * @param null $option Option name.
+	 * @param string $option Option name.
 	 *
 	 * @return bool|mixed
 	 *
@@ -663,7 +663,7 @@ 
 	 * list of text such as "Rick, John, and Gary"
 	 *
 	 * @param string|array|object  $name   The field name, or an associative array of parameters.
-	 * @param boolean|array|object $single (optional) For tableless fields, to return an array or the first.
+	 * @param boolean $single (optional) For tableless fields, to return an array or the first.
 	 *
 	 * @return string|null|false The output from the field, null if the field doesn't exist, false if no value returned
 	 *                           for tableless fields
@@ -723,7 +723,7 @@ 
 	 * list of text such as "Rick, John, and Gary"
 	 *
 	 * @param string|array|object  $name   The field name, or an associative array of parameters.
-	 * @param boolean|array|object $single (optional) For tableless fields, to return an array or the first.
+	 * @param boolean $single (optional) For tableless fields, to return an array or the first.
 	 *
 	 * @return string|null|false The output from the field, null if the field doesn't exist, false if no value returned
 	 *                           for tableless fields
@@ -2803,7 +2803,7 @@ 
 	 * @param null|int $offset Offset of rows.
 	 * @param null|int $total  Total rows.
 	 *
-	 * @return int Number of pages
+	 * @return double Number of pages
 	 * @since 2.3.10
 	 */
 	public function total_pages( $limit = null, $offset = null, $total = null ) {
@@ -2917,7 +2917,7 @@ 
 	 * @see   PodsAPI::save_pod_item
 	 *
 	 * @param string $field Field name.
-	 * @param mixed  $value IDs to add, int|float to add to number field, string for dates (+1 day), or string for text.
+	 * @param string  $value IDs to add, int|float to add to number field, string for dates (+1 day), or string for text.
 	 * @param int    $id    (optional) ID of the pod item to update.
 	 *
 	 * @return int The item ID
@@ -3033,7 +3033,7 @@ 
 	 * @see   PodsAPI::save_pod_item
 	 *
 	 * @param string $field Field name.
-	 * @param mixed  $value IDs to add, int|float to add to number field, string for dates (-1 day), or string for text.
+	 * @param string  $value IDs to add, int|float to add to number field, string for dates (-1 day), or string for text.
 	 * @param int    $id    (optional) ID of the pod item to update.
 	 *
 	 * @return int The item ID