gravityview / GravityView

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

Indentation +5 added lines, -5 removed lines

@@ -40,11 +40,11 @@
 		}
 
 		$field_options['link_phone'] = array(
-	        'type' => 'checkbox',
-	        'label' => __( 'Make Phone Number Clickable', 'gravityview' ),
-	        'desc' => __( 'Allow dialing a number by clicking it?', 'gravityview'),
-	        'value' => true,
-        );
+			'type' => 'checkbox',
+			'label' => __( 'Make Phone Number Clickable', 'gravityview' ),
+			'desc' => __( 'Allow dialing a number by clicking it?', 'gravityview'),
+			'value' => true,
+		);
 
 		return $field_options;
 	}

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

Indentation +1 added lines, -1 removed lines

@@ -123,7 +123,7 @@
 	 *
 	 * Verify permissions. Check expected $_POST. Parse args, then send to process_delete_notes
 	 *
-  	 * @since 1.17
+	 * @since 1.17
 	 *
 	 * @see process_delete_notes
 	 *

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-template.php

Doc Comments +3 added lines

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

includes/class-gravityview-merge-tags.php

Indentation +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
 		$gv_modifiers = array(
 			'maxwords:(\d+)' => 'modifier_maxwords', /** @see modifier_maxwords */
 			'wpautop' => 'modifier_wpautop', /** @see modifier_wpautop */
-		    'timestamp' => 'modifier_timestamp', /** @see modifier_timestamp */
+			'timestamp' => 'modifier_timestamp', /** @see modifier_timestamp */
 		);
 		
 		$return = $value;
@@ -253,7 +253,7 @@ 
 
 		$atts = array(
 			'format' => self::get_format_from_modifiers( $exploded, false ),
-		    'human' => in_array( 'human', $exploded ), // {date_created:human}
+			'human' => in_array( 'human', $exploded ), // {date_created:human}
 			'diff' => in_array( 'diff', $exploded ), // {date_created:diff}
 			'raw' => in_array( 'raw', $exploded ), // {date_created:raw}
 			'timestamp' => in_array( 'timestamp', $exploded ), // {date_created:timestamp}

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 ) {
 

Indentation +26 added lines, -26 removed lines

@@ -236,13 +236,13 @@ 
 
 				if ( $add_default_properties && ! empty( $field->inputs ) ) {
 					foreach ( $field->inputs as $input ) {
-                        /**
-                         * @hack
-                         * In case of email/email confirmation, the input for email has the same id as the parent field
-                         */
+						/**
+						 * @hack
+						 * In case of email/email confirmation, the input for email has the same id as the parent field
+						 */
 						if( 'email' === $field->type && false === strpos( $input['id'], '.' ) ) {
-                            continue;
-                        }
+							continue;
+						}
 						$fields["{$input['id']}"] = array(
 							'label' => rgar( $input, 'label' ),
 							'customLabel' => rgar( $input, 'customLabel' ),
@@ -419,7 +419,7 @@ 
 		} elseif ( 'delete' === RGForms::get( 'action' ) ) {
 			$criteria['context_view_id'] = isset( $_GET['view_id'] ) ? intval( $_GET['view_id'] ) : null;
 		} elseif( !isset( $criteria['context_view_id'] ) ) {
-            // Prevent overriding the Context View ID: Some widgets could set the context_view_id (e.g. Recent Entries widget)
+			// Prevent overriding the Context View ID: Some widgets could set the context_view_id (e.g. Recent Entries widget)
 			$criteria['context_view_id'] = null;
 		}
 
@@ -1148,7 +1148,7 @@ 
 			),
 		);
 
-        $fields = $date_created + $fields;
+		$fields = $date_created + $fields;
 
 		$blacklist_field_types = apply_filters( 'gravityview_blacklist_field_types', $blacklist, NULL );
 
@@ -1160,13 +1160,13 @@ 
 			}
 		}
 
-        /**
-         * @filter `gravityview/common/sortable_fields` Filter the sortable fields
-         * @since 1.12
-         * @param array $fields Sub-set of GF form fields that are sortable
-         * @param int $formid The Gravity Forms form ID that the fields are from
-         */
-        $fields = apply_filters( 'gravityview/common/sortable_fields', $fields, $formid );
+		/**
+		 * @filter `gravityview/common/sortable_fields` Filter the sortable fields
+		 * @since 1.12
+		 * @param array $fields Sub-set of GF form fields that are sortable
+		 * @param int $formid The Gravity Forms form ID that the fields are from
+		 */
+		$fields = apply_filters( 'gravityview/common/sortable_fields', $fields, $formid );
 
 		return $fields;
 	}
@@ -1449,17 +1449,17 @@ 
 	}
 
 
-    /**
-     * Display updated/error notice
-     *
-     * @param string $notice text/HTML of notice
-     * @param string $class CSS class for notice (`updated` or `error`)
-     *
-     * @return string
-     */
-    public static function generate_notice( $notice, $class = '' ) {
-        return '<div class="gv-notice '.gravityview_sanitize_html_class( $class ) .'">'. $notice .'</div>';
-    }
+	/**
+	 * Display updated/error notice
+	 *
+	 * @param string $notice text/HTML of notice
+	 * @param string $class CSS class for notice (`updated` or `error`)
+	 *
+	 * @return string
+	 */
+	public static function generate_notice( $notice, $class = '' ) {
+		return '<div class="gv-notice '.gravityview_sanitize_html_class( $class ) .'">'. $notice .'</div>';
+	}
 
 	/**
 	 * Inspired on \GFCommon::encode_shortcodes, reverse the encoding by replacing the ascii characters by the shortcode brackets

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

Indentation +1 added lines, -2 removed lines

@@ -175,7 +175,7 @@ 
 			7  => sprintf(__( 'View saved. %sView on website.%s', 'gravityview' ), '<a href="'.get_permalink( $post_id ).'">', '</a>') . $new_form_text,
 			8  => __( 'View submitted.', 'gravityview' ),
 			9  => sprintf(
-		        /* translators: Date and time the View is scheduled to be published */
+				/* translators: Date and time the View is scheduled to be published */
 				__( 'View scheduled for: %1$s.', 'gravityview' ),
 				// translators: Publish box date format, see http://php.net/date
 				date_i18n( __( 'M j, Y @ G:i', 'gravityview' ), strtotime( ( isset( $post->post_date ) ? $post->post_date : NULL )  ) )
@@ -232,7 +232,6 @@ 
 	 *
 	 * @deprecated since 1.12
 	 * @see GravityView_Compatibility::get_plugin_status()
-
 	 * @return boolean|string True: plugin is active; False: plugin file doesn't exist at path; 'inactive' it's inactive
 	 */
 	static function get_plugin_status( $location = '' ) {

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