gravityview / GravityView

includes/class-settings.php

Doc Comments +1 added lines

@@ -301,6 +301,7 @@
 	 * Make protected public
 	 * @inheritDoc
 	 * @access public
+	 * @param string $setting_name
 	 */
 	public function get_app_setting( $setting_name ) {
 

includes/connector-functions.php

Doc Comments +3 added lines, -5 removed lines

@@ -41,7 +41,6 @@ 
  *
  * @see GVCommon::get_forms()
  * @access public
- * @param mixed $form_id
  * @return array (id, title)
  */
 function gravityview_get_forms() {
@@ -53,7 +52,7 @@ 
  *
  * @see GVCommon::get_form_fields()
  * @access public
- * @param string|array $form_id (default: '') or $form object
+ * @param string|array $form (default: '') or $form object
  * @return array
  */
 function gravityview_get_form_fields( $form = '', $add_default_properties = false, $include_parent_field = true ) {
@@ -91,6 +90,7 @@ 
  * @param int|array $form_ids The ID of the form or an array IDs of the Forms. Zero for all forms.
  * @param mixed $passed_criteria (default: null)
  * @param mixed &$total (default: null)
+ * @param integer $total
  * @return mixed False: Error fetching entries. Array: Multi-dimensional array of Gravity Forms entry arrays
  */
 function gravityview_get_entries( $form_ids = null, $passed_criteria = null, &$total = null ) {
@@ -103,7 +103,6 @@ 
  * Since 1.4, supports custom entry slugs. The way that GravityView fetches an entry based on the custom slug is by searching `gravityview_unique_id` meta. The `$entry_slug` is fetched by getting the current query var set by `is_single_entry()`
  *
  * @access public
- * @param mixed $entry_id
  * @param boolean $force_allow_ids Force the get_entry() method to allow passed entry IDs, even if the `gravityview_custom_entry_slug_allow_id` filter returns false.
  * @param boolean $check_entry_display Check whether the entry is visible for the current View configuration. Default: true {@since 1.14}
  * @return array|boolean
@@ -177,7 +176,7 @@ 
  *
  * @param int $view_id ID of the View you want the form of
  *
- * @return int
+ * @return string
  */
 function gravityview_get_form_id( $view_id ) {
 	return GVCommon::get_meta_form_id( $view_id );
@@ -188,7 +187,6 @@ 
  *
  * @see GravityView_Template::template_id
  *
- * @param int $view_id The ID of the View to get the layout of
  *
  * @return string GravityView_Template::template_id value. Empty string if not.
  */

includes/extensions/delete-entry/class-delete-entry.php

Doc Comments -1 removed lines

@@ -170,7 +170,6 @@
 	 *
 	 * @since 1.5.1
 	 * @param  array 	   $visibility_caps        Array of capabilities to display in field dropdown.
-	 * @param  string      $field_type  Type of field options to render (`field` or `widget`)
 	 * @param  string      $template_id Table slug
 	 * @param  float       $field_id    GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
 	 * @param  string      $context     What context are we in? Example: `single` or `directory`

includes/extensions/edit-entry/class-edit-entry-admin.php

Doc Comments -1 removed lines

@@ -69,7 +69,6 @@
      * Change wording for the Edit context to read Entry Creator
      *
      * @param  array 	   $visibility_caps        Array of capabilities to display in field dropdown.
-     * @param  string      $field_type  Type of field options to render (`field` or `widget`)
      * @param  string      $template_id Table slug
      * @param  float       $field_id    GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
      * @param  string      $context     What context are we in? Example: `single` or `directory`

includes/extensions/edit-entry/class-edit-entry-render.php

Doc Comments +1 added lines, -1 removed lines

@@ -1249,7 +1249,7 @@
     /**
      * Override GF Form field properties with the ones defined on the View
      * @param  GF_Field $field GF Form field object
-     * @param  array $setting  GV field options
+     * @param  array $field_setting  GV field options
      * @since  1.5
      * @return array
      */

includes/extensions/edit-entry/class-edit-entry-user-registration.php

Doc Comments +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
      * @since 1.11
      *
      * @param array $form Gravity Forms form array
-     * @param string $entry_id Gravity Forms entry ID
+     * @param integer $entry_id Gravity Forms entry ID
      * @return void
      */
     public function update_user( $form = array(), $entry_id = 0 ) {

includes/extensions/edit-entry/class-edit-entry.php

Doc Comments +4 added lines, -1 removed lines

@@ -65,6 +65,9 @@ 
     }
 
 
+    /**
+     * @param string $component
+     */
     private function load_components( $component ) {
 
         $dir = trailingslashit( self::$file );
@@ -141,7 +144,7 @@ 
      * "You can edit this post from the post page" fields, for example.
      *
      * @param $entry array Gravity Forms entry object
-     * @param $view_id int GravityView view id
+     * @param integer $view_id int GravityView view id
      * @param $post_id int GravityView Post ID where View may be embedded {@since 1.9.2}
      * @param string|array $field_values Parameters to pass in to the Edit Entry form to prefill data. Uses the same format as Gravity Forms "Allow field to be populated dynamically" {@since 1.9.2} {@see https://www.gravityhelp.com/documentation/article/allow-field-to-be-populated-dynamically/ }
      * @return string

includes/helper-functions.php

Doc Comments +3 added lines, -4 removed lines

@@ -28,7 +28,7 @@ 
  *
  * We could do this in a cleaner fashion, but this prevents a lot of code duplication, checking for URL structure, etc.
  *
- * @param int|WP_Post $id        Optional. Post ID or post object. Default current post.
+ * @param integer $id        Optional. Post ID or post object. Default current post.
  *
  * @return array URL args, if exists. Empty array if not.
  */
@@ -101,7 +101,7 @@ 
  * @since 1.15 Added $object param
  *
  * @param string $file_path Full path to a file
- * @param mixed $object Pass pseudo-global to the included file
+ * @param GravityView_Edit_Entry_Render $object Pass pseudo-global to the included file
  * @return string Included file contents
  */
 function gravityview_ob_include( $file_path, $object = NULL ) {
@@ -276,7 +276,6 @@ 
  * Do a _very_ basic match for second-level TLD domains, like `.co.uk`
  *
  * Ideally, we'd use https://github.com/jeremykendall/php-domain-parser to check for this, but it's too much work for such a basic functionality. Maybe if it's needed more in the future. So instead, we use [Basic matching regex](http://stackoverflow.com/a/12372310).
- * @param  string $domain Domain to check if it's a TLD or subdomain
  * @return string         Extracted domain if it has a subdomain
  */
 function _gravityview_strip_subdomain( $string_maybe_has_subdomain ) {
@@ -296,7 +295,7 @@ 
  * Checks whether `false`, `null`, empty string, empty array, object with no vars defined
  *
  * @since 1.15.1
- * @param  mixed  $value Check whether this is empty
+ * @param  string  $value Check whether this is empty
  * @param boolean $zero_is_empty Should the number zero be treated as an empty value?
  * @param boolean $allow_string_booleans Whether to check if 'yes', 'true' => `true` and 'no', 'false' => `false`
  * @return boolean        True: empty; false: not empty

includes/lib/EDD_SL_Plugin_Updater.php

Doc Comments +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
 	 * @uses api_request()
 	 *
 	 * @param array   $_transient_data Update array build by WordPress.
-	 * @return array Modified update array with custom plugin data.
+	 * @return stdClass Modified update array with custom plugin data.
 	 */
 	function check_update( $_transient_data ) {