gravityview / GravityView

future/includes/class-gv-collection-field.php

Doc Comments +1 added lines, -1 removed lines

@@ -111,7 +111,7 @@
 	 * @api
 	 * @since
 	 *
-	 * @param $view \GV\View The view!
+	 * @param View $view \GV\View The view!
 	 *
 	 * @return \GV\Field_Collection A filtered collection of \GV\Fields, filtered by visibility.
 	 */

future/includes/class-gv-template-view-table.php

Doc Comments +2 added lines, -2 removed lines

@@ -158,7 +158,7 @@ 
      *
      * @see add_columns_sort_links
 	 * @param string $url Single-sort URL
-	 * @param array $sort_args Single sorting for rules, in [ field_id, dir ] format
+	 * @param string[] $sort_args Single sorting for rules, in [ field_id, dir ] format
      * @param \GV\Field $field The current field
      *
      * @return string Multisort URL, if there are multiple sorts. Otherwise, existing $url
@@ -369,7 +369,7 @@ 
 	 * Output a field cell.
 	 *
 	 * @param \GV\Field $field The field to be ouput.
-	 * @param \GV\Field $entry The entry this field is for.
+	 * @param Entry $entry The entry this field is for.
 	 *
 	 * @return void
 	 */

Indentation +88 added lines, -88 removed lines

@@ -19,8 +19,8 @@ 
 
 
 	/**
-     * Constructor. Add filters to modify output.
-     *
+	 * Constructor. Add filters to modify output.
+	 *
 	 * @since 2.0.4
 	 *
 	 * @param View $view
@@ -29,19 +29,19 @@ 
 	 */
 	public function __construct( View $view, Entry_Collection $entries, Request $request ) {
 
-	    add_filter( 'gravityview/template/field/label', array( __CLASS__, 'add_columns_sort_links' ), 100, 2 );
+		add_filter( 'gravityview/template/field/label', array( __CLASS__, 'add_columns_sort_links' ), 100, 2 );
 
 		parent::__construct( $view, $entries, $request );
 	}
 
 	/**
-     * Add sorting links to HTML columns that support sorting
-     *
-     * @since 2.0.4
-     * @since 2.0.5 Made static
-     *
-     * @static
-     *
+	 * Add sorting links to HTML columns that support sorting
+	 *
+	 * @since 2.0.4
+	 * @since 2.0.5 Made static
+	 *
+	 * @static
+	 *
 	 * @param string $column_label Label for the table column
 	 * @param \GV\Template_Context $context
 	 *
@@ -52,7 +52,7 @@ 
 		$sort_columns = $context->view->settings->get( 'sort_columns' );
 
 		if ( empty( $sort_columns ) ) {
-            return $column_label;
+			return $column_label;
 		}
 
 		if ( 'custom' === $context->field->type ) {
@@ -111,22 +111,22 @@ 
 		// If we are already sorting by the current field...
 		if ( ! empty( $sorting['key'] ) && (string) $sort_field_id === (string) $sorting['key'] ) {
 
-		    switch( $sorting['direction'] ) {
-		        // No sort
-                case '':
-	                $sort_args[1] = 'asc';
-	                $class .= ' gv-icon-caret-up-down';
-                    break;
-                case 'desc':
-	                $sort_args[1] = '';
-	                $class .= ' gv-icon-sort-asc';
-	                break;
-                case 'asc':
-                default:
-                    $sort_args[1] = 'desc';
-                    $class .= ' gv-icon-sort-desc';
-                    break;
-            }
+			switch( $sorting['direction'] ) {
+				// No sort
+				case '':
+					$sort_args[1] = 'asc';
+					$class .= ' gv-icon-caret-up-down';
+					break;
+				case 'desc':
+					$sort_args[1] = '';
+					$class .= ' gv-icon-sort-asc';
+					break;
+				case 'asc':
+				default:
+					$sort_args[1] = 'desc';
+					$class .= ' gv-icon-sort-desc';
+					break;
+			}
 
 		} else {
 			$class .= ' gv-icon-caret-up-down';
@@ -136,7 +136,7 @@ 
 		$url = remove_query_arg( 'sort', $url );
 		$multisort_url = self::_get_multisort_url( $url, $sort_args, $context->field );
 
-    	$url = add_query_arg( $sort_args[0], $sort_args[1], $url );
+		$url = add_query_arg( $sort_args[0], $sort_args[1], $url );
 
 		$return = '<a href="'. esc_url_raw( $url ) .'"';
 
@@ -150,28 +150,28 @@ 
 	}
 
 	/**
-     * Get the multi-sort URL used in the sorting links
-     *
-     * @todo Consider moving to Utils?
-     *
-     * @since 2.3
-     *
-     * @see add_columns_sort_links
+	 * Get the multi-sort URL used in the sorting links
+	 *
+	 * @todo Consider moving to Utils?
+	 *
+	 * @since 2.3
+	 *
+	 * @see add_columns_sort_links
 	 * @param string $url Single-sort URL
 	 * @param array $sort_args Single sorting for rules, in [ field_id, dir ] format
-     * @param \GV\Field $field The current field
-     *
-     * @return string Multisort URL, if there are multiple sorts. Otherwise, existing $url
+	 * @param \GV\Field $field The current field
+	 *
+	 * @return string Multisort URL, if there are multiple sorts. Otherwise, existing $url
 	 */
 	static public function _get_multisort_url( $url, $sort_args, $field ) {
 
 		$sorts = Utils::_GET( 'sort' );
 
 		if ( ! is_array( $sorts ) ) {
-            return $url;
+			return $url;
 		}
 
-        $multisort_url = $url;
+		$multisort_url = $url;
 
 		if ( 'custom' === $field->type ) {
 			$field_id = 'custom_' . $field->UID;
@@ -180,26 +180,26 @@ 
 		}
 
 		// If the field has already been sorted by, add the field to the URL
-        if ( ! in_array( $field_id, $keys = array_keys( $sorts ) ) ) {
-            if ( count( $keys ) ) {
-                $multisort_url = add_query_arg( sprintf( 'sort[%s]', end( $keys ) ), $sorts[ end( $keys ) ], $multisort_url );
-                $multisort_url = add_query_arg( $sort_args[0], $sort_args[1], $multisort_url );
-            } else {
-                $multisort_url = add_query_arg( $sort_args[0], $sort_args[1], $multisort_url );
-            }
-        }
-        // Otherwise, we are just updating the sort order
-        else {
-
-            // Pass empty value to unset
-            if( '' === $sort_args[1] ) {
-	            unset( $sorts[ $field_id ] );
-            } else {
-	            $sorts[ $field_id ] = $sort_args[1];
-            }
-
-            $multisort_url = add_query_arg( array( 'sort' => $sorts ), $multisort_url );
-        }
+		if ( ! in_array( $field_id, $keys = array_keys( $sorts ) ) ) {
+			if ( count( $keys ) ) {
+				$multisort_url = add_query_arg( sprintf( 'sort[%s]', end( $keys ) ), $sorts[ end( $keys ) ], $multisort_url );
+				$multisort_url = add_query_arg( $sort_args[0], $sort_args[1], $multisort_url );
+			} else {
+				$multisort_url = add_query_arg( $sort_args[0], $sort_args[1], $multisort_url );
+			}
+		}
+		// Otherwise, we are just updating the sort order
+		else {
+
+			// Pass empty value to unset
+			if( '' === $sort_args[1] ) {
+				unset( $sorts[ $field_id ] );
+			} else {
+				$sorts[ $field_id ] = $sort_args[1];
+			}
+
+			$multisort_url = add_query_arg( array( 'sort' => $sorts ), $multisort_url );
+		}
 
 		return $multisort_url;
 	}
@@ -229,10 +229,10 @@ 
 	}
 
 	/**
-     * Returns the label for a column, with support for all deprecated filters
-     *
-     * @since 2.1
-     *
+	 * Returns the label for a column, with support for all deprecated filters
+	 *
+	 * @since 2.1
+	 *
 	 * @param \GV\Field $field
 	 * @param \GV\Template_Context $context
 	 */
@@ -255,7 +255,7 @@ 
 		$column_label = apply_filters( 'gravityview/template/field/label', $column_label, $context );
 
 		return $column_label;
-    }
+	}
 
 	/**
 	 * Output the entry row.
@@ -324,15 +324,15 @@ 
 				 */
 				do_action( 'gravityview/template/table/cells/before', $context );
 
-                /**
-                 * @action `gravityview_table_cells_before` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
-                 * @since 1.0.7
+				/**
+				 * @action `gravityview_table_cells_before` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
+				 * @since 1.0.7
 				 * @param \GravityView_View $this Current GravityView_View object
 				 * @deprecated Use `gravityview/template/table/cells/before`
-                 */
-                do_action( 'gravityview_table_cells_before', \GravityView_View::getInstance() );
+				 */
+				do_action( 'gravityview_table_cells_before', \GravityView_View::getInstance() );
 
-                foreach ( $fields->all() as $field ) {
+				foreach ( $fields->all() as $field ) {
 					if ( isset( $this->view->unions[ $entry['form_id'] ] ) ) {
 						if ( isset( $this->view->unions[ $entry['form_id'] ][ $field->ID ] ) ) {
 							$field = $this->view->unions[ $entry['form_id'] ][ $field->ID ];
@@ -352,13 +352,13 @@ 
 				 */
 				do_action( 'gravityview/template/table/cells/after', $context );
 
-                /**
-                 * @action `gravityview_table_cells_after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
-                 * @since 1.0.7
+				/**
+				 * @action `gravityview_table_cells_after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
+				 * @since 1.0.7
 				 * @param \GravityView_View $this Current GravityView_View object
 				 * @deprecated Use `gravityview/template/table/cells/after`
-                 */
-                do_action( 'gravityview_table_cells_after', \GravityView_View::getInstance() );
+				 */
+				do_action( 'gravityview_table_cells_after', \GravityView_View::getInstance() );
 
 				?>
 			</tr>
@@ -406,9 +406,9 @@ 
 			'value' => $value,
 			'hide_empty' => false,
 			'zone_id' => 'directory_table-columns',
-            'label' => self::get_field_column_label( $field, $context ),
+			'label' => self::get_field_column_label( $field, $context ),
 			'markup' => '<td id="{{ field_id }}" class="{{ class }}" data-label="{{label_value:data-label}}">{{ value }}</td>',
-            'form' => $form,
+			'form' => $form,
 		);
 
 		/** Output. */
@@ -433,11 +433,11 @@ 
 		do_action( 'gravityview/template/table/body/before', $context );
 
 		/**
-		* @action `gravityview_table_body_before` Inside the `tbody`, before any rows are rendered. Can be used to insert additional rows.
-		* @deprecated Use `gravityview/template/table/body/before`
-		* @since 1.0.7
-		* @param \GravityView_View $gravityview_view Current GravityView_View object.
-		*/
+		 * @action `gravityview_table_body_before` Inside the `tbody`, before any rows are rendered. Can be used to insert additional rows.
+		 * @deprecated Use `gravityview/template/table/body/before`
+		 * @since 1.0.7
+		 * @param \GravityView_View $gravityview_view Current GravityView_View object.
+		 */
 		do_action( 'gravityview_table_body_before', \GravityView_View::getInstance() /** ugh! */ );
 	}
 
@@ -459,11 +459,11 @@ 
 		do_action( 'gravityview/template/table/body/after', $context );
 
 		/**
-		* @action `gravityview_table_body_after` Inside the `tbody`, after any rows are rendered. Can be used to insert additional rows.
-		* @deprecated Use `gravityview/template/table/body/after`
-		* @since 1.0.7
-		* @param \GravityView_View $gravityview_view Current GravityView_View object.
-		*/
+		 * @action `gravityview_table_body_after` Inside the `tbody`, after any rows are rendered. Can be used to insert additional rows.
+		 * @deprecated Use `gravityview/template/table/body/after`
+		 * @since 1.0.7
+		 * @param \GravityView_View $gravityview_view Current GravityView_View object.
+		 */
 		do_action( 'gravityview_table_body_after', \GravityView_View::getInstance() /** ugh! */ );
 	}
 

includes/class-common.php

Indentation +33 added lines, -33 removed lines

@@ -318,12 +318,12 @@ 
 						}
 
 						/**
-                         * @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' => \GV\Utils::get( $input, 'label' ),
 							'customLabel' => \GV\Utils::get( $input, 'customLabel' ),
@@ -1420,7 +1420,7 @@ 
 			),
 		);
 
-        $fields = $date_created + $fields;
+		$fields = $date_created + $fields;
 
 		// Are there custom content fields?
 		if ( is_admin() ) {
@@ -1459,13 +1459,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;
 	}
@@ -1757,26 +1757,26 @@ 
 	}
 
 
-    /**
-     * Display updated/error notice
-     *
-     * @since 1.19.2 Added $cap and $object_id parameters
-     *
-     * @param string $notice text/HTML of notice
-     * @param string $class CSS class for notice (`updated` or `error`)
-     * @param string $cap [Optional] Define a capability required to show a notice. If not set, displays to all caps.
-     *
-     * @return string
-     */
-    public static function generate_notice( $notice, $class = '', $cap = '', $object_id = null ) {
-
-    	// If $cap is defined, only show notice if user has capability
-    	if( $cap && ! GVCommon::has_cap( $cap, $object_id ) ) {
-    		return '';
-	    }
-
-        return '<div class="gv-notice '.gravityview_sanitize_html_class( $class ) .'">'. $notice .'</div>';
-    }
+	/**
+	 * Display updated/error notice
+	 *
+	 * @since 1.19.2 Added $cap and $object_id parameters
+	 *
+	 * @param string $notice text/HTML of notice
+	 * @param string $class CSS class for notice (`updated` or `error`)
+	 * @param string $cap [Optional] Define a capability required to show a notice. If not set, displays to all caps.
+	 *
+	 * @return string
+	 */
+	public static function generate_notice( $notice, $class = '', $cap = '', $object_id = null ) {
+
+		// If $cap is defined, only show notice if user has capability
+		if( $cap && ! GVCommon::has_cap( $cap, $object_id ) ) {
+			return '';
+		}
+
+		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/fields/class-gravityview-field.php

Doc Comments +4 added lines, -1 removed lines

@@ -249,7 +249,7 @@ 
 	 * @param bool $url_encode Whether to URL-encode output
 	 * @param bool $esc_html Whether to apply `esc_html()` to output
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public function replace_merge_tag( $matches = array(), $text = '', $form = array(), $entry = array(), $url_encode = false, $esc_html = false ) {
 
@@ -427,6 +427,9 @@ 
 		return apply_filters( 'gravityview_field_support_options', $options );
 	}
 
+	/**
+	 * @param string $key
+	 */
 	function add_field_support( $key, &$field_options ) {
 
 		$options = $this->field_support_options();