pods-framework / pods

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

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;

classes/PodsMigrate.php

Doc Comments +2 added lines, -2 removed lines

@@ -457,7 +457,7 @@ 
      * @param array $data Array of data
      * @param string $delimiter Delimiter for export type 'sv'
      *
-     * @return bool
+     * @return false|string
      */
     public function build_sv ( $data = null, $delimiter = null ) {
         if ( !empty( $data ) )
@@ -521,7 +521,7 @@ 
     /**
      * @param array $data Array of data
      *
-     * @return bool
+     * @return false|string
      */
     public function build_xml ( $data = null ) {
         if ( !empty( $data ) )

classes/PodsUI.php

Doc Comments +9 added lines, -10 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
@@ -1294,7 +1294,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return null|boolean
      */
     public function go () {
         $this->do_hook( 'go' );
@@ -1494,7 +1494,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 ) )
@@ -1635,7 +1635,7 @@ 
     }
 
     /**
-     * @return bool|mixed
+     * @return null|boolean
 	 * @since 2.3.10
      */
     public function view () {
@@ -1886,9 +1886,9 @@ 
     }
 
     /**
-     * @param null $id
+     * @param integer $id
      *
-     * @return bool|mixed
+     * @return null|boolean
      */
     public function delete ( $id = null ) {
         $this->do_hook( 'pre_delete', $id );
@@ -1922,7 +1922,6 @@ 
     }
 
     /**
-     * @param null $id
      *
      * @return bool|mixed
      */
@@ -2179,7 +2178,6 @@ 
     }
 
     /**
-     * @param bool $full Whether to get ALL data or use pagination
      *
      * @return bool
      */
@@ -2298,6 +2296,7 @@ 
     }
 
     /**
+     * @param string $method
      * @return array
      */
     public function get_row ( &$counter = 0, $method = null ) {
@@ -3188,7 +3187,7 @@ 
     /**
      * @param bool $reorder
      *
-     * @return bool|mixed
+     * @return null|boolean
      */
     public function table ( $reorder = false ) {
 		if ( false !== $this->callback( 'table', $reorder ) ) {
@@ -3982,7 +3981,7 @@ 
     }
 
     /**
-     * @param bool|array $exclude
+     * @param string[] $exclude
      * @param bool|array $array
      */
     public function hidden_vars ( $exclude = false, $array = false ) {

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