pods-framework / pods

classes/PodsData.php

Doc Comments +3 added lines, -3 removed lines

@@ -2019,8 +2019,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
      *
@@ -2347,7 +2347,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/PodsMeta.php

Doc Comments +9 added lines, -3 removed lines

@@ -332,6 +332,9 @@ 
         self::$settings = pods_api()->load_pods( array( 'type' => 'settings', 'refresh' => true ) );
     }
 
+    /**
+     * @param string $type
+     */
     public function register ( $type, $pod ) {
         $pod_type = $type;
 
@@ -795,7 +798,7 @@ 
     }
 
     /**
-     * @param $type
+     * @param string $type
      * @param $name
      * @param $default_fields
      *
@@ -2688,7 +2691,7 @@ 
      * @param string $meta_value
      * @param bool $unique
      *
-     * @return bool|int|null
+     * @return null|integer
      */
     public function add_meta ( $object_type, $_null = null, $object_id = 0, $meta_key = '', $meta_value = '', $unique = false ) {
         if ( pods_tableless() )
@@ -2729,7 +2732,7 @@ 
      * @param string $meta_value
      * @param string $prev_value
      *
-     * @return bool|int|null
+     * @return null|integer
      */
     public function update_meta ( $object_type, $_null = null, $object_id = 0, $meta_key = '', $meta_value = '', $prev_value = '' ) {
         if ( pods_tableless() )
@@ -2870,6 +2873,9 @@ 
         return $this->delete_object( 'media', $id );
     }
 
+    /**
+     * @param string $type
+     */
     public function delete_object ( $type, $id, $name = null ) {
         if ( empty( $name ) )
             $name = $type;

components/Helpers.php

Doc Comments +1 added lines, -1 removed lines

@@ -359,7 +359,7 @@
      * $params['name'] string Field name
      *
      * @param array $params An associative array of parameters
-     * @param null $obj
+     * @param Pods $obj
      *
      * @return mixed Anything returned by the helper
      * @since 2.0

includes/general.php

Doc Comments +3 added lines, -4 removed lines

@@ -310,7 +310,6 @@ 
 /**
  * Determine if Deprecated Mode is enabled
  *
- * @param bool $include_debug Whether to include strict mode
  *
  * @return bool Whether Deprecated Mode is enabled
  *
@@ -443,6 +442,7 @@ 
  * @param string $minimum_version Minimum version
  * @param string $comparison Comparison operator
  * @param string $maximum_version Maximum version
+ * @param string $what
  *
  * @return bool
  */
@@ -906,7 +906,7 @@ 
  * @uses get_shortcode_regex() Gets the search pattern for searching shortcodes.
  *
  * @param string $content Content to search for shortcodes
- * @param array $shortcodes Array of shortcodes to run
+ * @param string[] $shortcodes Array of shortcodes to run
  * @return string Content with shortcodes filtered out.
  */
 function pods_do_shortcode( $content, $shortcodes ) {
@@ -1446,7 +1446,7 @@ 
  * @param string|bool $key Key for the cache
  * @param string $group (optional) Key for the group
  *
- * @return bool|mixed|null|void
+ * @return boolean
  *
  * @since 2.0
  */
@@ -1654,7 +1654,6 @@ 
  *
  * @param string|array $pod The pod name or array of pod names
  * @param string $name The name of the Pod
- * @param array $object (optional) Pod array, including any 'fields' arrays
  *
  * @return array|boolean Field data or false if unsuccessful
  * @since 2.1

classes/PodsInit.php

Doc Comments +1 added lines, -1 removed lines

@@ -935,7 +935,7 @@
 	 * @param        $args
 	 * @param string $type
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public static function object_label_fix( $args, $type = 'post_type' ) {
 

classes/PodsAPI.php

Doc Comments +5 added lines, -5 removed lines

@@ -1559,7 +1559,7 @@ 
      *
      * @param array $params An associative array of parameters
      * @param bool $sanitized (optional) Decides whether the params have been sanitized before being passed, will sanitize them if false.
-     * @param bool|int $db (optional) Whether to save into the DB or just return Pod array.
+     * @param boolean $db (optional) Whether to save into the DB or just return Pod array.
      *
      * @return int Pod ID
      * @since 1.7.9
@@ -3903,7 +3903,7 @@ 
      * Save relationships
      *
      * @param int $id ID of item
-     * @param int|array $related_id ID or IDs to save
+     * @param int|array $related_ids ID or IDs to save
      * @param array $pod Pod data
      * @param array $field Field data
      */
@@ -5061,7 +5061,6 @@ 
      * Delete an object from tableless fields
      *
      * @param int $id
-     * @param string $type
      * @param string $name
      *
      * @return bool
@@ -5284,6 +5283,7 @@ 
      * $params['name'] string Pod name
      *
      * @param array $params An associative array of parameters
+     * @param string $type
      *
      * @return bool True if exists
      *
@@ -6792,7 +6792,7 @@ 
      * @param string $type Field type to look for
      * @param array $options (optional) Options of the field to pass to the schema function.
      *
-     * @return array|bool|mixed|null
+     * @return string
      *
      * @since 2.0
      */
@@ -7228,7 +7228,7 @@ 
 	 *
 	 * Load the information about an objects MySQL table
 	 *
-	 * @param $object_type
+	 * @param string $object_type
 	 * @param string $object The object to look for
 	 * @param null $name (optional) Name of the pod to load
 	 * @param array $pod (optional) Array with pod information

classes/Pods.php

Doc Comments +7 added lines, -10 removed lines

@@ -330,7 +330,7 @@ 
 	/**
 	 * Rewind Iterator
 	 *
-	 * @return void|boolean
+	 * @return null|false
 	 *
 	 * @since 2.3.4
 	 *
@@ -381,7 +381,7 @@ 
 	/**
 	 * Move onto the next Iterator row
 	 *
-	 * @return void|boolean
+	 * @return null|false
 	 *
 	 * @since 2.3.4
 	 *
@@ -476,7 +476,7 @@ 
 	 * Return field array from a Pod, a field's data, or a field option
 	 *
 	 * @param null $field
-	 * @param null $option
+	 * @param string $option
 	 *
 	 * @return bool|mixed
 	 *
@@ -1975,7 +1975,6 @@ 
 	 * Return the next item ID, loops at the first id to return the last
 	 *
 	 * @param int $id
-	 * @param array $find_params
 	 *
 	 * @return int
 	 * @since 2.0
@@ -2491,7 +2490,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 ) {
@@ -2600,7 +2599,7 @@ 
 	 * @see PodsAPI::save_pod_item
 	 *
 	 * @param string $field Field name
-	 * @param mixed $value ID(s) to add, int|float to add to number field, string for dates (+1 week), or string for text
+	 * @param string $value ID(s) to add, int|float to add to number field, string for dates (+1 week), or string for text
 	 * @param int $id (optional) ID of the pod item to update
 	 *
 	 * @return int The item ID
@@ -2711,7 +2710,7 @@ 
 	 * @see PodsAPI::save_pod_item
 	 *
 	 * @param string $field Field name
-	 * @param mixed $value ID(s) to add, int|float to add to number field, string for dates (-1 week), or string for text
+	 * @param string $value ID(s) to add, int|float to add to number field, string for dates (-1 week), or string for text
 	 * @param int $id (optional) ID of the pod item to update
 	 *
 	 * @return int The item ID
@@ -3321,7 +3320,7 @@ 
 	 *
 	 * @see Pods_Templates::template
 	 *
-	 * @param string $template The template name
+	 * @param string $template_name The template name
 	 * @param string $code Custom template code to use instead
 	 * @param bool $deprecated Whether to use deprecated functionality based on old function usage
 	 *
@@ -3607,7 +3606,6 @@ 
 	 * Replace magic tags with their values
 	 *
 	 * @param string $code The content to evaluate
-	 * @param object $obj The Pods object
 	 *
 	 * @return string Code with Magic Tags evaluated
 	 *
@@ -3621,7 +3619,6 @@ 
 	 * Replace magic tags with their values
 	 *
 	 * @param string $tag The magic tag to process
-	 * @param object $obj The Pods object
 	 *
 	 * @return string Code with Magic Tags evaluated
 	 *

components/Templates/includes/functions-view_template.php

Doc Comments +2 added lines, -2 removed lines

@@ -18,7 +18,7 @@ 
 /**
  * Return array of valid frontier type shortcode tags
  *
- * @return array
+ * @return string[]
  */
 function frontier_get_shortcodes() {
 	$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 @@ 
  * @param array attributes from template
  * @param string template to be processed
  *
- * @return null
+ * @return string
  * @since 2.4
  */
 function frontier_do_subtemplate( $atts, $content ) {

classes/PodsAdmin.php

Doc Comments +3 added lines, -3 removed lines

@@ -2555,7 +2555,7 @@ 
      *
      * @param PodsUI $ui
      *
-     * @return bool
+     * @return boolean|null
      */
     public function admin_components_toggle ( PodsUI $ui ) {
         $component = $_GET[ 'id' ];
@@ -2688,7 +2688,7 @@ 
      *
      * @param $capabilities List of extra capabilities to add
      *
-     * @return array
+     * @return string[]
      */
     public function admin_capabilities ( $capabilities ) {
         $pods = pods_api()->load_pods( array( 'type' => array( 'settings', 'post_type', 'taxonomy' ), 'fields' => false, 'table_info' => false ) );
@@ -3029,7 +3029,7 @@ 
 	 *
 	 * @param array $pod
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	protected function restable_pod( $pod ) {