gravityview / GravityView

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/class-common.php

Doc Comments +4 added lines, -5 removed lines

@@ -185,7 +185,6 @@ 
 	 * Returns the list of available forms
 	 *
 	 * @access public
-	 * @param mixed $form_id
 	 * @return array Empty array if GFAPI isn't available or no forms. Otherwise, associative array with id, title keys
 	 */
 	public static function get_forms() {
@@ -206,7 +205,7 @@ 
 	 * Return array of fields' id and label, for a given Form ID
 	 *
 	 * @access public
-	 * @param string|array $form_id (default: '') or $form object
+	 * @param string|array $form (default: '') or $form object
 	 * @return array
 	 */
 	public static function get_form_fields( $form = '', $add_default_properties = false, $include_parent_field = true ) {
@@ -907,7 +906,7 @@ 
 	 *
 	 * @param array $form Gravity Forms form array
 	 * @param string $field_id ID of the field. If an input, full input ID (like `1.3`)
-	 * @param string|array $field_value Raw value of the field.
+	 * @param string $field_value Raw value of the field.
 	 * @return string
 	 */
 	public static function get_field_label( $form = array(), $field_id = '', $field_value = '' ) {
@@ -1551,9 +1550,9 @@ 
 	 * @param string $message            Message body (required)
 	 * @param string $from_name          Displayed name of the sender
 	 * @param string $message_format     If "html", sent text as `text/html`. Otherwise, `text/plain`. Default: "html".
-	 * @param string|array $attachments  Optional. Files to attach. {@see wp_mail()} for usage. Default: "".
+	 * @param string $attachments  Optional. Files to attach. {@see wp_mail()} for usage. Default: "".
 	 * @param array|false $entry         Gravity Forms entry array, related to the email. Default: false.
-	 * @param array|false $notification  Gravity Forms notification that triggered the email. {@see GFCommon::send_notification}. Default:false.
+	 * @param boolean $notification  Gravity Forms notification that triggered the email. {@see GFCommon::send_notification}. Default:false.
 	 */
 	public static function send_email( $from, $to, $bcc, $reply_to, $subject, $message, $from_name = '', $message_format = 'html', $attachments = '', $entry = false, $notification = false ) {
 

Braces +5 added lines, -5 removed lines

@@ -255,7 +255,7 @@ 
 				}
 
 
-				if( GFCommon::is_product_field( $field->type ) ){
+				if( GFCommon::is_product_field( $field->type ) ) {
 					$has_product_fields = true;
 				}
 
@@ -315,7 +315,7 @@ 
 
 		$fields = array();
 
-		foreach ( $extra_fields as $key => $field ){
+		foreach ( $extra_fields as $key => $field ) {
 			if ( ! empty( $only_default_column ) && ! empty( $field['is_default_column'] ) ) {
 				$fields[ $key ] = array( 'label' => $field['label'], 'type' => 'entry_meta' );
 			}
@@ -881,7 +881,7 @@ 
 	 * @return GF_Field|null Gravity Forms field object, or NULL: Gravity Forms GFFormsModel does not exist or field at $field_id doesn't exist.
 	 */
 	public static function get_field( $form, $field_id ) {
-		if ( class_exists( 'GFFormsModel' ) ){
+		if ( class_exists( 'GFFormsModel' ) ) {
 			return GFFormsModel::get_field( $form, $field_id );
 		} else {
 			return null;
@@ -928,7 +928,7 @@ 
 			$shortcodes = array();
 
 			preg_match_all( '/' . get_shortcode_regex() . '/s', $content, $matches, PREG_SET_ORDER );
-			if ( empty( $matches ) ){
+			if ( empty( $matches ) ) {
 				return false;
 			}
 
@@ -1408,7 +1408,7 @@ 
 	public static function array_merge_recursive_distinct( array &$array1, array &$array2 ) {
 		$merged = $array1;
 
-		foreach ( $array2 as $key => &$value )  {
+		foreach ( $array2 as $key => &$value ) {
 			if ( is_array( $value ) && isset( $merged[ $key ] ) && is_array( $merged[ $key ] ) ) {
 				$merged[ $key ] = self::array_merge_recursive_distinct( $merged[ $key ], $value );
 			} else {

includes/connector-functions.php

Doc Comments +2 added lines, -4 removed lines

@@ -41,7 +41,6 @@ 
  *
  * @see GVCommon::get_forms()
  * @access public
- * @param mixed $form_id
  * @return array Empty array if GFAPI isn't available or no forms. Otherwise, associative array with id, title keys
  */
 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
@@ -190,7 +189,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/admin/class-gravityview-admin-no-conflict.php

Braces +3 added lines, -3 removed lines

@@ -116,7 +116,7 @@ 
 
 		// Dequeue other jQuery styles even if no-conflict is off.
 		// Terrible-looking tabs help no one.
-		if( !empty( $wp_styles->registered ) )  {
+		if( !empty( $wp_styles->registered ) ) {
 			foreach ($wp_styles->registered as $key => $style) {
 				if( preg_match( '/^(?:wp\-)?jquery/ism', $key ) ) {
 					wp_dequeue_style( $key );
@@ -189,8 +189,8 @@ 
 
 		//unregistering scripts
 		$registered = array();
-		foreach( $wp_objects->registered as $handle => $script_registration ){
-			if( in_array( $handle, $required_objects ) ){
+		foreach( $wp_objects->registered as $handle => $script_registration ) {
+			if( in_array( $handle, $required_objects ) ) {
 				$registered[ $handle ] = $script_registration;
 			}
 		}

includes/fields/class-gravityview-field-password.php

Braces +1 added lines, -1 removed lines

@@ -49,7 +49,7 @@
 	 *
 	 * @return string If a custom field label isn't set, return the field label for the password field
 	 */
-	function field_label( $label = '', $field = array(), $form = array(), $entry = array() ){
+	function field_label( $label = '', $field = array(), $form = array(), $entry = array() ) {
 
 		// If using a custom label, no need to fetch the parent label
 		if( ! is_numeric( $field['id'] ) || ! empty( $field['custom_label'] ) ) {

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`
 	 */