pods-framework / pods

classes/PodsForm.php

Doc Comments -5 removed lines

@@ -882,7 +882,6 @@ 
      * @param mixed $value
      * @param string $name
      * @param array $options
-     * @param array $fields
      * @param array $pod
      * @param int $id
      * @param array $traverse
@@ -924,7 +923,6 @@ 
      * @param mixed $value
      * @param string $name
      * @param array $options
-     * @param array $fields
      * @param array $pod
      * @param int $id
      * @param array $traverse
@@ -1295,9 +1293,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

classes/fields/link.php

Doc Comments -1 removed lines

@@ -50,7 +50,6 @@
 	/**
 	 * Add options and set defaults to
 	 *
-	 * @param array $options
 	 *
 	 * @since 2.0
 	 */

classes/fields/website.php

Doc Comments +2 added lines, -3 removed lines

@@ -50,7 +50,6 @@ 
 	/**
 	 * Add options and set defaults to
 	 *
-	 * @param array $options
 	 *
 	 * @since 2.0
 	 */
@@ -120,7 +119,7 @@ 
 	 *
 	 * @param array $options
 	 *
-	 * @return array
+	 * @return string
 	 * @since 2.0
 	 */
 	public function schema ( $options = null ) {
@@ -143,7 +142,7 @@ 
 	 * @param array $pod
 	 * @param int $id
 	 *
-	 * @return mixed|null
+	 * @return string
 	 * @since 2.0
 	 */
 	public function display ( $value = null, $name = null, $options = null, $pod = null, $id = null ) {

classes/fields/datetime.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 ) {
@@ -393,7 +393,7 @@ 
 	 * @param array $fields
 	 * @param array $pod
 	 *
-	 * @return mixed|null|string
+	 * @return false|string
 	 * @since 2.0
 	 */
 	public function ui ( $id, $value, $name = null, $options = null, $fields = null, $pod = null ) {
@@ -637,7 +637,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 ) {
 		$datetime = null;
@@ -685,7 +685,7 @@ 
 	 * Convert a date from one format to another
 	 *
 	 * @param $value
-	 * @param $new_format
+	 * @param string $new_format
 	 * @param string $original_format
 	 * @param boolean $return_timestamp Whether to return the strtotime() or createFromFormat result or not
 	 *

classes/fields/number.php

Doc Comments +4 added lines, -4 removed lines

@@ -218,7 +218,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 ) {
@@ -310,7 +310,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 ) {
@@ -348,7 +348,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 ) {
@@ -378,7 +378,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/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 ) {
 

classes/PodsUI.php

Doc Comments +11 added lines, -11 removed lines

@@ -427,7 +427,7 @@ 
      * @param mixed $options Object, Array, or String containing Pod or Options to be used
      * @param bool $deprecated Set to true to support old options array from Pods UI plugin
      *
-     * @return \PodsUI
+     * @return false|null
      *
      * @license http://www.gnu.org/licenses/gpl-2.0.html
      * @since 2.0
@@ -1315,7 +1315,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return null|boolean
      */
     public function go () {
         $this->do_hook( 'go' );
@@ -1433,7 +1433,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return null|boolean
      */
     public function add () {
 		if ( false !== $this->callback_action( 'add' ) ) {
@@ -1469,7 +1469,7 @@ 
     /**
      * @param bool $duplicate
      *
-     * @return mixed
+     * @return null|boolean
      */
     public function edit ( $duplicate = false ) {
         if ( in_array( 'duplicate', $this->actions_disabled ) )
@@ -1525,7 +1525,7 @@ 
      * @param bool $create
      * @param bool $duplicate
      *
-     * @return bool|mixed
+     * @return null|boolean
      */
     public function form ( $create = false, $duplicate = false ) {
         if ( in_array( 'duplicate', $this->actions_disabled ) )
@@ -1668,7 +1668,7 @@ 
     }
 
     /**
-     * @return bool|mixed
+     * @return null|boolean
 	 * @since 2.3.10
      */
     public function view () {
@@ -1919,9 +1919,9 @@ 
     }
 
     /**
-     * @param null $id
+     * @param integer $id
      *
-     * @return bool|mixed
+     * @return null|boolean
      */
     public function delete ( $id = null ) {
         $this->do_hook( 'pre_delete', $id );
@@ -2324,7 +2324,6 @@ 
     }
 
     /**
-     * @param bool $full Whether to get ALL data or use pagination
      *
      * @return bool
      */
@@ -2443,6 +2442,7 @@ 
     }
 
     /**
+     * @param string $method
      * @return array
      */
     public function get_row ( &$counter = 0, $method = null ) {
@@ -3343,7 +3343,7 @@ 
     /**
      * @param bool $reorder
      *
-     * @return bool|mixed
+     * @return null|boolean
      */
     public function table ( $reorder = false ) {
 		if ( false !== $this->callback( 'table', $reorder ) ) {
@@ -4214,7 +4214,7 @@ 
     }
 
     /**
-     * @param bool|array $exclude
+     * @param string[] $exclude
      * @param bool|array $array
      */
     public function hidden_vars ( $exclude = false, $array = false ) {