gravityview / GravityView

includes/admin/class.field.type.php

Doc Comments +1 added lines

@@ -158,6 +158,7 @@
     /**
      * important! Override this class if needed
      * outputs the field setting html
+     * @param string $override_input
      */
     function render_setting( $override_input = NULL ) {
 

Indentation +140 added lines, -140 removed lines

@@ -10,159 +10,159 @@ 
 	 *
 	 * @var string
 	 */
-    protected $name;
+	protected $name;
 
 	/**
 	 * Field settings
 	 *
 	 * @var array
 	 */
-    protected $field;
+	protected $field;
 
 	/**
 	 * Field current value
 	 *
 	 * @var mixed
 	 */
-    protected $value;
-
-    function __construct( $name = '', $field = array(), $curr_value = NULL ) {
-
-        $this->name = $name;
-
-        $defaults = self::get_field_defaults();
-
-        // Backward compatibility
-        if( !empty( $field['choices'] ) ) {
-        	$field['options'] = $field['choices'];
-        	unset( $field['choices'] );
-        }
-
-        $this->field =  wp_parse_args( $field, $defaults );
-
-        $this->value = is_null( $curr_value ) ? $this->field['value'] : $curr_value;
-
-    }
-
-    /**
-     * Returns the default details for a field option
-     *
-     * - default    // default option value, in case nothing is defined (@deprecated)
-     * - desc       // option description
-     * - value      // the option default value
-     * - label      // the option label
-     * - left_label // In case of checkboxes, left label will appear on the left of the checkbox
-     * - id         // the field id
-     * - type       // the option type ( text, checkbox, select, ... )
-     * - options    // when type is select, define the select options ('choices' is @deprecated)
-     * - merge_tags // if the option supports merge tags feature
-     * - class      // (new) define extra classes for the field
-     * - tooltip    //
-     *
-     * @return array
-     */
-    public static function get_field_defaults() {
-        return array(
-            'desc' => '',
-            'value' => NULL,
-            'label' => '',
-            'left_label' => NULL,
-            'id' => NULL,
-            'type'  => 'text',
-            'options' => NULL,
-            'merge_tags' => true,
-            'class' => '',
-            'tooltip' => NULL
-        );
-    }
-
-
-    function get_tooltip() {
-        if( !function_exists('gform_tooltip') ) {
-            return NULL;
-        }
-
-        return !empty( $this->field['tooltip'] ) ? ' '.gform_tooltip( $this->field['tooltip'] , false, true ) : NULL;
-    }
-
-    /**
-     * Build input id based on the name
-     * @return string
-     */
-    function get_field_id() {
-        if( isset( $this->field['id'] ) ) {
-            return esc_attr( $this->field['id'] );
-        }
-        return esc_attr( sanitize_html_class( $this->name ) );
-    }
-
-    /**
-     * Retrieve field label
-     * @return string
-     */
-    function get_field_label() {
-        return esc_html( trim( $this->field['label'] ) );
-    }
+	protected $value;
+
+	function __construct( $name = '', $field = array(), $curr_value = NULL ) {
+
+		$this->name = $name;
+
+		$defaults = self::get_field_defaults();
+
+		// Backward compatibility
+		if( !empty( $field['choices'] ) ) {
+			$field['options'] = $field['choices'];
+			unset( $field['choices'] );
+		}
+
+		$this->field =  wp_parse_args( $field, $defaults );
+
+		$this->value = is_null( $curr_value ) ? $this->field['value'] : $curr_value;
+
+	}
+
+	/**
+	 * Returns the default details for a field option
+	 *
+	 * - default    // default option value, in case nothing is defined (@deprecated)
+	 * - desc       // option description
+	 * - value      // the option default value
+	 * - label      // the option label
+	 * - left_label // In case of checkboxes, left label will appear on the left of the checkbox
+	 * - id         // the field id
+	 * - type       // the option type ( text, checkbox, select, ... )
+	 * - options    // when type is select, define the select options ('choices' is @deprecated)
+	 * - merge_tags // if the option supports merge tags feature
+	 * - class      // (new) define extra classes for the field
+	 * - tooltip    //
+	 *
+	 * @return array
+	 */
+	public static function get_field_defaults() {
+		return array(
+			'desc' => '',
+			'value' => NULL,
+			'label' => '',
+			'left_label' => NULL,
+			'id' => NULL,
+			'type'  => 'text',
+			'options' => NULL,
+			'merge_tags' => true,
+			'class' => '',
+			'tooltip' => NULL
+		);
+	}
+
+
+	function get_tooltip() {
+		if( !function_exists('gform_tooltip') ) {
+			return NULL;
+		}
+
+		return !empty( $this->field['tooltip'] ) ? ' '.gform_tooltip( $this->field['tooltip'] , false, true ) : NULL;
+	}
+
+	/**
+	 * Build input id based on the name
+	 * @return string
+	 */
+	function get_field_id() {
+		if( isset( $this->field['id'] ) ) {
+			return esc_attr( $this->field['id'] );
+		}
+		return esc_attr( sanitize_html_class( $this->name ) );
+	}
+
+	/**
+	 * Retrieve field label
+	 * @return string
+	 */
+	function get_field_label() {
+		return esc_html( trim( $this->field['label'] ) );
+	}
 
 	/**
 	 * Retrieve field left label
-     *
-     * @since 1.7
-     *
+	 *
+	 * @since 1.7
+	 *
 	 * @return string
 	 */
 	function get_field_left_label() {
 		return ! empty( $this->field['left_label'] ) ? esc_html( trim( $this->field['left_label'] ) ) : NULL;
 	}
 
-    /**
-     * Retrieve field label class
-     * @return string
-     */
-    function get_label_class() {
-        return 'gv-label-'. sanitize_html_class( $this->field['type'] );
-    }
-
-
-    /**
-     * Retrieve field description
-     * @return string
-     */
-    function get_field_desc() {
-        return !empty( $this->field['desc'] ) ? '<span class="howto">'. $this->field['desc'] .'</span>' : '';
-    }
-
-
-    /**
-     * Verify if field should have merge tags
-     * @return boolean
-     */
-    function show_merge_tags() {
-        // Show the merge tags if the field is a list view
-        $is_list = preg_match( '/_list-/ism', $this->name );
-        // Or is a single entry view
-        $is_single = preg_match( '/single_/ism', $this->name );
-
-        return ( $is_single || $is_list );
-    }
-
-
-
-    /**
-     * important! Override this class
-     * outputs the field option html
-     */
-    function render_option() {
-        // to replace on each field
-    }
-
-    /**
-     * important! Override this class if needed
-     * outputs the field setting html
-     */
-    function render_setting( $override_input = NULL ) {
-
-        if( !empty( $this->field['full_width'] ) ) { ?>
+	/**
+	 * Retrieve field label class
+	 * @return string
+	 */
+	function get_label_class() {
+		return 'gv-label-'. sanitize_html_class( $this->field['type'] );
+	}
+
+
+	/**
+	 * Retrieve field description
+	 * @return string
+	 */
+	function get_field_desc() {
+		return !empty( $this->field['desc'] ) ? '<span class="howto">'. $this->field['desc'] .'</span>' : '';
+	}
+
+
+	/**
+	 * Verify if field should have merge tags
+	 * @return boolean
+	 */
+	function show_merge_tags() {
+		// Show the merge tags if the field is a list view
+		$is_list = preg_match( '/_list-/ism', $this->name );
+		// Or is a single entry view
+		$is_single = preg_match( '/single_/ism', $this->name );
+
+		return ( $is_single || $is_list );
+	}
+
+
+
+	/**
+	 * important! Override this class
+	 * outputs the field option html
+	 */
+	function render_option() {
+		// to replace on each field
+	}
+
+	/**
+	 * important! Override this class if needed
+	 * outputs the field setting html
+	 */
+	function render_setting( $override_input = NULL ) {
+
+		if( !empty( $this->field['full_width'] ) ) { ?>
             <th scope="row" colspan="2">
                 <div>
                     <label for="<?php echo $this->get_field_id(); ?>">
@@ -182,14 +182,14 @@ 
             </td>
         <?php }
 
-    }
+	}
 
-    /**
-     * important! Override this class
-     * outputs the input html part
-     */
-    function render_input( $override_input ) {
-        echo '';
-    }
+	/**
+	 * important! Override this class
+	 * outputs the input html part
+	 */
+	function render_input( $override_input ) {
+		echo '';
+	}
 
 }

includes/class-api.php

Doc Comments +1 added lines, -2 removed lines

@@ -214,7 +214,6 @@ 
 	 *
 	 * @access public
 	 * @param array $entry
-	 * @param integer $field
 	 * @return null|string
 	 */
 	public static function field_value( $entry, $field_settings, $format = 'html' ) {
@@ -967,7 +966,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();

Indentation +33 added lines, -33 removed lines

@@ -146,20 +146,20 @@ 
 
 		if( !empty( $field['custom_class'] ) ) {
 
-            $custom_class = $field['custom_class'];
+			$custom_class = $field['custom_class'];
 
-            if( !empty( $entry ) ) {
+			if( !empty( $entry ) ) {
 
-                // We want the merge tag to be formatted as a class. The merge tag may be
-                // replaced by a multiple-word value that should be output as a single class.
-                // "Office Manager" will be formatted as `.OfficeManager`, not `.Office` and `.Manager`
-                add_filter('gform_merge_tag_filter', 'sanitize_html_class');
+				// We want the merge tag to be formatted as a class. The merge tag may be
+				// replaced by a multiple-word value that should be output as a single class.
+				// "Office Manager" will be formatted as `.OfficeManager`, not `.Office` and `.Manager`
+				add_filter('gform_merge_tag_filter', 'sanitize_html_class');
 
-                $custom_class = self::replace_variables( $custom_class, $form, $entry);
+				$custom_class = self::replace_variables( $custom_class, $form, $entry);
 
-                // And then we want life to return to normal
-                remove_filter('gform_merge_tag_filter', 'sanitize_html_class');
-            }
+				// And then we want life to return to normal
+				remove_filter('gform_merge_tag_filter', 'sanitize_html_class');
+			}
 
 			// And now we want the spaces to be handled nicely.
 			$classes[] = gravityview_sanitize_html_class( $custom_class );
@@ -292,7 +292,7 @@ 
 			'format' => $format,
 			'entry' => $entry,
 			'field_type' => $field_type, /** {@since 1.6} */
-		    'field_path' => $field_path, /** {@since 1.16} */
+			'field_path' => $field_path, /** {@since 1.16} */
 		));
 
 		if( ! empty( $field_path ) ) {
@@ -603,29 +603,29 @@ 
 		return sanitize_title( $slug );
 	}
 
-    /**
-     * If using the entry custom slug feature, make sure the new entries have the custom slug created and saved as meta
-     *
-     * Triggered by add_action( 'gform_entry_created', array( 'GravityView_API', 'entry_create_custom_slug' ), 10, 2 );
-     *
-     * @param $entry array Gravity Forms entry object
-     * @param $form array Gravity Forms form object
-     */
-    public static function entry_create_custom_slug( $entry, $form ) {
-        /**
-         * @filter `gravityview_custom_entry_slug` On entry creation, check if we are using the custom entry slug feature and update the meta
-         * @param boolean $custom Should we process the custom entry slug?
-         */
-        $custom = apply_filters( 'gravityview_custom_entry_slug', false );
-        if( $custom ) {
-            // create the gravityview_unique_id and save it
+	/**
+	 * If using the entry custom slug feature, make sure the new entries have the custom slug created and saved as meta
+	 *
+	 * Triggered by add_action( 'gform_entry_created', array( 'GravityView_API', 'entry_create_custom_slug' ), 10, 2 );
+	 *
+	 * @param $entry array Gravity Forms entry object
+	 * @param $form array Gravity Forms form object
+	 */
+	public static function entry_create_custom_slug( $entry, $form ) {
+		/**
+		 * @filter `gravityview_custom_entry_slug` On entry creation, check if we are using the custom entry slug feature and update the meta
+		 * @param boolean $custom Should we process the custom entry slug?
+		 */
+		$custom = apply_filters( 'gravityview_custom_entry_slug', false );
+		if( $custom ) {
+			// create the gravityview_unique_id and save it
 
-            // Get the entry hash
-            $hash = self::get_custom_entry_slug( $entry['id'], $entry );
-            gform_update_meta( $entry['id'], 'gravityview_unique_id', $hash );
+			// Get the entry hash
+			$hash = self::get_custom_entry_slug( $entry['id'], $entry );
+			gform_update_meta( $entry['id'], 'gravityview_unique_id', $hash );
 
-        }
-    }
+		}
+	}
 
 
 
@@ -889,7 +889,7 @@ 
 
 			// If there was an error, continue to the next term.
 			if ( is_wp_error( $term_link ) ) {
-			    continue;
+				continue;
 			}
 
 			$output[] = gravityview_get_link( $term_link, esc_html( $term->name ) );

templates/fields/date_created.php

Indentation +5 added lines, -5 removed lines

@@ -1,10 +1,10 @@
 <?php
 /**
- * Display the date_created field type
- *
- * @package GravityView
- * @subpackage GravityView/templates/fields
- */
+	 * Display the date_created field type
+	 *
+	 * @package GravityView
+	 * @subpackage GravityView/templates/fields
+	 */
 
 $gravityview_view = GravityView_View::getInstance();
 

includes/class-common.php

Doc Comments +1 added lines, -2 removed lines

@@ -167,7 +167,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() {
@@ -188,7 +187,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 ) {

includes/fields/class-gravityview-field.php

Doc Comments +6 added lines, -6 removed lines

@@ -175,7 +175,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 ) {
 
@@ -202,7 +202,7 @@ 
 	 *
 	 * @since 1.8.4
 	 *
-	 * @param array $existing_merge_tags
+	 * @param array $custom_merge_tags
 	 * @param int $form_id GF Form ID
 	 * @param GF_Field[] $fields Array of fields in the form
 	 * @param string $element_id The ID of the input that Merge Tags are being used on
@@ -341,10 +341,10 @@ 
 	 * </pre>
 	 *
 	 * @param  [type]      $field_options [description]
-	 * @param  [type]      $template_id   [description]
-	 * @param  [type]      $field_id      [description]
-	 * @param  [type]      $context       [description]
-	 * @param  [type]      $input_type    [description]
+	 * @param  string      $template_id   [description]
+	 * @param  string      $field_id      [description]
+	 * @param  string      $context       [description]
+	 * @param  string      $input_type    [description]
 	 * @return [type]                     [description]
 	 */
 	function field_options( $field_options, $template_id, $field_id, $context, $input_type ) {

includes/fields/class-gravityview-fields.php

Doc Comments +1 added lines, -1 removed lines

@@ -77,7 +77,7 @@
 	/**
 	 * Alias for get_instance()
 	 *
-	 * @param $field_name
+	 * @param string $field_name
 	 *
 	 * @return GravityView_Field
 	 */

includes/fields/class-gravityview-field-transaction-type.php

Doc Comments +1 added lines, -1 removed lines

@@ -69,7 +69,7 @@
 	 *
 	 * @since 1.16
 	 *
-	 * @param int|string $value Number value for the field
+	 * @param string $value Number value for the field
 	 *
 	 * @return string Based on $value; `1`: "One-Time Payment"; `2`: "Subscription"
 	 */

includes/helper-functions.php

Doc Comments +2 added lines, -3 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.
  */
@@ -135,7 +135,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 ) {
@@ -310,7 +310,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 ) {

includes/class-gravityview-merge-tags.php

Indentation +1 added lines, -1 removed lines

@@ -122,7 +122,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}