gravityview / GravityView

includes/class-api.php

Doc Comments +1 added lines, -2 removed lines

@@ -214,7 +214,6 @@ 
 	 *
 	 * @access public
 	 * @param array $entry
-	 * @param array $field
 	 * @return null|string
 	 */
 	public static function field_value( $entry, $field_settings, $format = 'html' ) {
@@ -1000,7 +999,7 @@ 
  * Get the current View ID being rendered
  *
  * @global GravityView_View $gravityview_view
- * @return string View context "directory" or "single"
+ * @return integer View context "directory" or "single"
  */
 function gravityview_get_view_id() {
 	return GravityView_View::getInstance()->getViewId();

includes/class-template.php

Doc Comments +3 added lines

@@ -220,6 +220,9 @@
 
 	}
 
+	/**
+	 * @param string $key
+	 */
 	public function getCurrentFieldSetting( $key ) {
 		$settings = $this->getCurrentField('field_settings');
 

includes/extensions/entry-notes/class-gravityview-field-notes.php

Doc Comments +3 added lines, -3 removed lines

@@ -316,7 +316,7 @@ 
 	 *
 	 * @param array $file_paths List of template paths ordered
 	 *
-	 * @return array File paths with `./` and `./partials/` paths added
+	 * @return string[] File paths with `./` and `./partials/` paths added
 	 */
 	public function add_template_path( $file_paths ) {
 
@@ -485,7 +485,7 @@ 
 	 * @param array $entry
 	 * @param array $data Note details array
 	 *
-	 * @return int|WP_Error
+	 * @return integer
 	 */
 	private function add_note( $entry, $data ) {
 		global $current_user, $wpdb;
@@ -584,7 +584,7 @@ 
 	 *
 	 * @since 1.17
 	 *
-	 * @param int|string $entry_slug Current entry unique ID
+	 * @param string $entry_slug Current entry unique ID
 	 *
 	 * @return string HTML output
 	 */

includes/wordpress-widgets/class-gravityview-recent-entries-widget.php

Doc Comments +1 added lines

@@ -176,6 +176,7 @@
 	 * Get the entries that will be shown in the current widget
 	 *
 	 * @param  array $instance Settings for the current widget
+	 * @param false|string $form_id
 	 *
 	 * @return array $entries Multidimensional array of Gravity Forms entries
 	 */

includes/widgets/search-widget/class-search-widget.php

Doc Comments +4 added lines, -4 removed lines

@@ -201,7 +201,7 @@ 
 	/**
 	 * Add admin script to the no-conflict scripts whitelist
 	 * @param array $allowed Scripts allowed in no-conflict mode
-	 * @return array Scripts allowed in no-conflict mode, plus the search widget script
+	 * @return string[] Scripts allowed in no-conflict mode, plus the search widget script
 	 */
 	public function register_no_conflict( $allowed ) {
 		$allowed[] = 'gravityview_searchwidget_admin';
@@ -889,7 +889,7 @@ 
 	/**
 	 * Get the label for a search form field
 	 * @param  array $field      Field setting as sent by the GV configuration - has `field`, `input` (input type), and `label` keys
-	 * @param  array $form_field Form field data, as fetched by `gravityview_get_field()`
+	 * @param  GF_Field|null $form_field Form field data, as fetched by `gravityview_get_field()`
 	 * @return string             Label for the search form
 	 */
 	private static function get_field_label( $field, $form_field = array() ) {
@@ -1058,7 +1058,7 @@ 
 	/**
 	 * Require the datepicker script for the frontend GV script
 	 * @param array $js_dependencies Array of existing required scripts for the fe-views.js script
-	 * @return array Array required scripts, with `jquery-ui-datepicker` added
+	 * @return string[] Array required scripts, with `jquery-ui-datepicker` added
 	 */
 	public function add_datepicker_js_dependency( $js_dependencies ) {
 
@@ -1070,7 +1070,7 @@ 
 	/**
 	 * Modify the array passed to wp_localize_script()
 	 *
-	 * @param array $js_localization The data padded to the Javascript file
+	 * @param array $localizations The data padded to the Javascript file
 	 * @param array $view_data View data array with View settings
 	 *
 	 * @return array

includes/plugin-and-theme-hooks/class-gravityview-plugin-hooks-gravity-forms-survey.php

Doc Comments -1 removed lines

@@ -36,7 +36,6 @@
 	 * @since 1.16.4
 	 * @since 1.17 Moved to GravityView_Plugin_Hooks_Gravity_Forms_Survey class
 	 *
-	 * @param array $form
 	 *
 	 * @return array Form, with all fields set to `allowsPrepopulate => true`
 	 */

includes/connector-functions.php

Doc Comments +2 added lines, -3 removed lines

@@ -56,7 +56,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 ) {
@@ -94,6 +94,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 ) {
@@ -106,7 +107,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
@@ -193,7 +193,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/class-admin-approve-entries.php

Doc Comments +2 added lines, -2 removed lines

@@ -265,7 +265,7 @@ 
 	 *
 	 * @uses  GravityView_frontend::get_search_criteria() Convert the $_POST search request into a properly formatted request.
 	 * @access public
-	 * @return void|boolean
+	 * @return false|null
 	 */
 	public function process_bulk_action() {
 
@@ -362,7 +362,7 @@ 
      * @since 1.18 Moved to GravityView_Entry_Approval::get_approved_column
      * @see GravityView_Entry_Approval::get_approved_column
      *
-	 * @param mixed $form GF Form or Form ID
+	 * @param integer $form GF Form or Form ID
 	 * @return false|null|string Returns the input ID of the approved field. Returns NULL if no approved fields were found. Returns false if $form_id wasn't set.
 	 */
 	static public function get_approved_column( $form ) {

includes/fields/class-gravityview-field-is-approved.php

Doc Comments -1 removed lines

@@ -59,7 +59,6 @@
 	 *
 	 * @param string $output HTML value output
 	 * @param array  $entry The GF entry array
-	 * @param array  $field_settings Settings for the particular GV field
 	 * @param array  $field Field array, as fetched from GravityView_View::getCurrentField()
 	 *
 	 * @return string The field setting label for the current status. Uses defaults, if not configured.