pods-framework / pods

classes/fields/website.php

Doc Comments +1 added lines, -2 removed lines

@@ -48,7 +48,6 @@ 
     /**
      * Add options and set defaults to
      *
-     * @param array $options
      *
      * @since 2.0
      */
@@ -106,7 +105,7 @@ 
      *
      * @param array $options
      *
-     * @return array
+     * @return string
      * @since 2.0
      */
     public function schema ( $options = null ) {

classes/fields/wysiwyg.php

Doc Comments -1 removed lines

@@ -193,7 +193,6 @@
      * @param mixed $value
      * @param string $name
      * @param array $options
-     * @param array $fields
      * @param array $pod
      * @param int $id
      *

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
 	 *
@@ -475,7 +475,7 @@ 
 	/**
 	 * Return field array from a Pod, a field's data, or a field option
 	 *
-	 * @param null $field
+	 * @param string $field
 	 * @param null $option
 	 *
 	 * @return bool|mixed
@@ -1927,7 +1927,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
@@ -2443,7 +2442,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 ) {
@@ -2552,7 +2551,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
@@ -2658,7 +2657,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
@@ -3261,7 +3260,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
 	 *
@@ -3547,7 +3546,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
 	 *
@@ -3561,7 +3559,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
 	 *

classes/PodsAPI.php

Doc Comments +6 added lines, -6 removed lines

@@ -1564,7 +1564,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
@@ -3901,7 +3901,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
      */
@@ -4995,7 +4995,6 @@ 
      * Delete an object from tableless fields
      *
      * @param int $id
-     * @param string $type
      * @param string $name
      *
      * @return bool
@@ -5218,6 +5217,7 @@ 
      * $params['name'] string Pod name
      *
      * @param array $params An associative array of parameters
+     * @param string $type
      *
      * @return bool True if exists
      *
@@ -6682,7 +6682,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
      */
@@ -7118,7 +7118,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
@@ -7759,7 +7759,7 @@ 
      * @param array|string $data (optional) An associative array containing a package, or the json encoded package
      * @param bool $output (optional)
      *
-     * @return array|bool
+     * @return boolean
      *
      * @since 1.9.0
      * @deprecated 2.0

classes/PodsArray.php

Doc Comments +1 added lines, -1 removed lines

@@ -92,7 +92,7 @@
     /**
      * Validate value on a specific type and set default (if empty)
      *
-     * @param mixed $offset Used to get value of Array or Variable on Object
+     * @param string $offset Used to get value of Array or Variable on Object
      * @param mixed $default Used to set default value if it doesn't exist
      * @param string $type Used to force a specific type of variable (allowed: array, object, integer, absint, boolean)
      * @param mixed $extra Used in advanced types of variables

classes/PodsComponents.php

Doc Comments +4 added lines, -1 removed lines

@@ -493,6 +493,9 @@ 
         }
     }
 
+    /**
+     * @param string $settings
+     */
     public function admin ( $options, $settings, $component ) {
         if ( !isset( $this->components[ $component ] ) )
             wp_die( 'Invalid Component' );
@@ -507,7 +510,7 @@ 
      *
      * @param string $component The component name to toggle
      *
-     * @return bool
+     * @return boolean|null
      *
      * @since 2.0
      */

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/PodsField.php

Doc Comments +1 added lines, -1 removed lines

@@ -144,7 +144,7 @@
      *
      * @param array $options
      *
-     * @return array
+     * @return string
      * @since 2.0
      */
     public function prepare ( $options = null ) {

classes/PodsForm.php

Doc Comments +2 added lines, -5 removed lines

@@ -414,6 +414,8 @@ 
      * Merge attributes and handle classes
      *
      * @since 2.0
+     * @param string $name
+     * @param string $type
      */
     public static function merge_attributes( $attributes, $name = null, $type = null, $options = null, $classes = '' ) {
         $options = (array) $options;
@@ -832,7 +834,6 @@ 
      * @param mixed $value
      * @param string $name
      * @param array $options
-     * @param array $fields
      * @param array $pod
      * @param int $id
      * @param array $traverse
@@ -874,7 +875,6 @@ 
      * @param mixed $value
      * @param string $name
      * @param array $options
-     * @param array $fields
      * @param array $pod
      * @param int $id
      * @param array $traverse
@@ -1225,9 +1225,6 @@ 
     /**
      * Run a method from a Field Type's class
      *
-     * @param string $field_type Field Type indentifier
-     * @param string $method Method name
-     * @param mixed $arg More arguments
      *
      * @return mixed
      * @access public