GravityView_Field_Date

Complexity

Total Complexity

10

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

53.33%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	field_options()	0	10	2
A	apply_format_date_modifiers()	0	8	2
A	date_display()	0	34	5

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 11 and the first side effect is on line 114.

/**
 * @file class-gravityview-field-date.php
 * @package GravityView
 * @subpackage includes\fields
 */

/**
 * Add custom options for date fields
 */
class GravityView_Field_Date extends GravityView_Field {

	var $name = 'date';

The visibility should be declared for property $name.

	var $_gf_field_class_name = 'GF_Field_Date';

The visibility should be declared for property $_gf_field_class_name.

	var $is_searchable = true;

The visibility should be declared for property $is_searchable.

	var $search_operators = array( 'less_than', 'greater_than', 'is', 'isnot' );

The visibility should be declared for property $search_operators.

	var $group = 'advanced';

The visibility should be declared for property $group.

	public function __construct() {

		$this->label = esc_html__( 'Date', 'gravityview' );

		add_filter( 'gravityview/merge_tags/modifiers/value', array( $this, 'apply_format_date_modifiers' ), 10, 6 );

		parent::__construct();
	}

	function field_options( $field_options, $template_id = '', $field_id = '', $context = '', $input_type = '' ) {

It is generally recommended to explicitly declare the visibility for methods.

		if( 'edit' === $context ) {
			return $field_options;
		}

		$this->add_field_support('date_display', $field_options );

Expected 1 spaces after opening bracket; 0 found

		return $field_options;
	}

	/**
	 * Allow Date fields to take advantage of the GV date modifiers
	 *
	 * @since 2.0
	 * @uses  GravityView_Merge_Tags::format_date
	 *
	 * @param string $return The current merge tag value to be filtered.
	 * @param string $raw_value The raw value submitted for this field. May be CSV or JSON-encoded.
	 * @param string $value The original merge tag value, passed from Gravity Forms
	 * @param string $merge_tag If the merge tag being executed is an individual field merge tag (i.e. {Name:3}), this variable will contain the field's ID. If not, this variable will contain the name of the merge tag (i.e. all_fields).
	 * @param string $modifier The string containing any modifiers for this merge tag. For example, "maxwords:10" would be the modifiers for the following merge tag: `{Text:2:maxwords:10}`.
	 * @param GF_Field $field The current field.
	 *
	 * @return string If Date field, run it through GravityView_Merge_Tags::format_date; otherwise, return the original value
	 */
	public function apply_format_date_modifiers( $return, $raw_value = '', $value = '', $merge_tag = '', $modifier = '', $field = null ) {

		if ( 'date' === $field->type ) {
			$return = GravityView_Merge_Tags::format_date( $raw_value, $modifier );
		}

		return $return;
	}

	/**
	 * Get the default date format for a field based on the field ID and the time format setting
	 *
	 * @since 1.16.4

	 * @param string $date_format The Gravity Forms date format for the field. Default: "mdy"
	 * @param int $field_id The ID of the field. Used to figure out full date/day/month/year
	 *
	 * @return string PHP date format for the date
	 */
	static public function date_display( $value = '', $date_format = 'mdy', $field_id = 0 ) {

As per PSR2, the static declaration should come after the visibility declaration.

		// Let Gravity Forms figure out, based on the date format, what day/month/year values are.
		$parsed_date = GFCommon::parse_date( $value, $date_format );

		// Are we displaying an input or the whole field?
		$field_input_id = gravityview_get_input_id_from_id( $field_id );

		$date_field_output = '';
		switch( $field_input_id ) {
			case 1:
				$date_field_output = \GV\Utils::get( $parsed_date, 'month' );
				break;
			case 2:
				$date_field_output = \GV\Utils::get( $parsed_date, 'day' );
				break;
			case 3:
				$date_field_output = \GV\Utils::get( $parsed_date, 'year' );
				break;
		}

		/**
		 * @filter `gravityview_date_format` Whether to override the Gravity Forms date format with a PHP date format
		 * @see https://codex.wordpress.org/Formatting_Date_and_Time
		 * @param null|string Date Format (default: $field->dateFormat)
		 */
		$full_date_format = apply_filters( 'gravityview_date_format', $date_format );

		$full_date = GFCommon::date_display( $value, $full_date_format );

		// If the field output is empty, use the full date.
		// Note: The output might be empty because $parsed_date didn't parse correctly.
		return ( '' === $date_field_output ) ? $full_date : $date_field_output;
	}

}

new GravityView_Field_Date;