pods-framework / pods

includes/data.php

Doc Comments +2 added lines, -5 removed lines

@@ -847,7 +847,7 @@ 
  *
  * @param mixed $value The value to be set
  * @param mixed $var The variable name, or URI segment position / query var name (if $type is 'url')
- * @param string|array|object $type (optional) Super globals, url/url-relative, constants, globals, user data, Pod field values
+ * @param string $type (optional) Super globals, url/url-relative, constants, globals, user data, Pod field values
  *
  * @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
  * @since 2.3.10
@@ -1210,7 +1210,7 @@ 
 /**
  * Create a slug from an input string
  *
- * @param $orig
+ * @param string $orig
  *
  * @return string Sanitized slug
  *
@@ -1905,7 +1905,6 @@ 
  *
  * @param array|object $list List of items
  * @param array $args Array of index, parent, children, id, and prefix keys to use
- * @param string $children_key Key to recurse children into
  *
  * @return array|object
  * @since 2.3
@@ -1939,9 +1938,7 @@ 
 /**
  * Recurse list of hierarchical data
  *
- * @param array|object $list List of items
  * @param array $args Array of children and prefix keys to use
- * @param string $children_key Key to recurse children into
  *
  * @see pods_hierarchical_select
  * @return array

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

sql/upgrade/PodsUpgrade.php

Doc Comments +2 added lines, -2 removed lines

@@ -137,7 +137,7 @@ 
     }
 
     /**
-     * @param $method
+     * @param string $method
      * @param $v
      * @param null $x
      */
@@ -156,7 +156,7 @@ 
     }
 
     /**
-     * @param $method
+     * @param string $method
      * @param null $x
      *
      * @return bool

sql/upgrade/PodsUpgrade_2_1_0.php

Doc Comments +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
     }
 
     /**
-     * @return array|bool|int|mixed|null|void
+     * @return integer
      */
     public function prepare_relationships () {
         $relationship_fields = $this->api->load_fields( array( 'type' => 'pick' ) );

classes/fields/pick.php

Doc Comments +3 added lines, -4 removed lines

@@ -661,7 +661,7 @@ 
      *
      * @param array $options
      *
-     * @return array
+     * @return string|false
      * @since 2.0
      */
     public function schema ( $options = null ) {
@@ -681,7 +681,6 @@ 
      * @param mixed $value
      * @param string $name
      * @param array $options
-     * @param array $fields
      * @param array $pod
      * @param int $id
      *
@@ -797,7 +796,7 @@ 
      * @param int $id
      *
      * @param null $params
-     * @return array|bool
+     * @return string|boolean
      * @since 2.0
      */
     public function validate ( $value, $name = null, $options = null, $fields = null, $pod = null, $id = null, $params = null ) {
@@ -1302,7 +1301,7 @@ 
      *
      * @param array $object_params Object data parameters
      *
-     * @return array|bool Object data
+     * @return string Object data
      */
     public function get_object_data ( $object_params = null ) {
 

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/fields/number.php

Doc Comments +6 added lines, -6 removed lines

@@ -134,7 +134,7 @@ 
      *
      * @param array $options
      *
-     * @return array
+     * @return string
      * @since 2.0
      */
     public function schema ( $options = null ) {
@@ -163,7 +163,7 @@ 
      *
      * @param array $options
      *
-     * @return array
+     * @return string
      * @since 2.0
      */
     public function prepare ( $options = null ) {
@@ -201,7 +201,7 @@ 
      * @param array $pod
      * @param int $id
      *
-     * @return mixed|null|string
+     * @return string
      * @since 2.0
      */
     public function display ( $value = null, $name = null, $options = null, $pod = null, $id = null ) {
@@ -309,7 +309,7 @@ 
      * @param int $id
      * @param null $params
      *
-     * @return bool|mixed
+     * @return string|boolean
      * @since 2.0
      */
     public function validate ( $value, $name = null, $options = null, $fields = null, $pod = null, $id = null, $params = null ) {
@@ -368,7 +368,7 @@ 
      * @param array $pod
      * @param object $params
      *
-     * @return mixed|string
+     * @return string
      * @since 2.0
      */
     public function pre_save ( $value, $id = null, $name = null, $options = null, $fields = null, $pod = null, $params = null ) {
@@ -434,7 +434,7 @@ 
      * @param array $fields
      * @param array $pod
      *
-     * @return mixed|null|string
+     * @return string
      * @since 2.0
      */
     public function ui ( $id, $value, $name = null, $options = null, $fields = null, $pod = null ) {

classes/fields/currency.php

Doc Comments +4 added lines, -4 removed lines

@@ -267,7 +267,7 @@ 
 	 * @param array $pod
 	 * @param int $id
 	 *
-	 * @return mixed|null|string
+	 * @return string
 	 * @since 2.0
 	 */
 	public function display( $value = null, $name = null, $options = null, $pod = null, $id = null ) {
@@ -427,7 +427,7 @@ 
 	 * @param int $id
 	 * @param null $params
 	 *
-	 * @return bool|mixed
+	 * @return string|boolean
 	 * @since 2.0
 	 */
 	public function validate( $value, $name = null, $options = null, $fields = null, $pod = null, $id = null, $params = null ) {
@@ -509,7 +509,7 @@ 
 	 * @param array $pod
 	 * @param object $params
 	 *
-	 * @return mixed|string
+	 * @return string
 	 * @since 2.0
 	 */
 	public function pre_save( $value, $id = null, $name = null, $options = null, $fields = null, $pod = null, $params = null ) {
@@ -604,7 +604,7 @@ 
 	 * @param array $fields
 	 * @param array $pod
 	 *
-	 * @return mixed|null|string
+	 * @return string
 	 * @since 2.0
 	 */
 	public function ui( $id, $value, $name = null, $options = null, $fields = null, $pod = null ) {

classes/fields/datetime.php

Doc Comments +4 added lines, -4 removed lines

@@ -116,7 +116,7 @@ 
      *
      * @param array $options
      *
-     * @return array
+     * @return string
      * @since 2.0
      */
     public function schema ( $options = null ) {
@@ -283,8 +283,8 @@ 
     }
 
     /**
-     * @param $format
-     * @param $date
+     * @param string $format
+     * @param string $date
      *
      * @return DateTime
      */
@@ -314,7 +314,7 @@ 
      * Convert a date from one format to another
      *
      * @param $value
-     * @param $new_format
+     * @param string $new_format
      * @param string $original_format
      *
      * @return string