isRequired ) { $required_inputs = array( 0, 1 ); $message = $this->complex_validation_message( $value, $required_inputs ); if ( $message ) { $this->failed_validation = true; $message_intro = empty( $this->errorMessage ) ? __( 'This field is required.', 'gravityforms' ) : $this->errorMessage; $this->validation_message = $message_intro . ' ' . $message; } } $hour = rgar( $value, 0 ); $minute = rgar( $value, 1 ); if ( empty( $hour ) && empty( $minute ) ) { return; } $is_valid_format = is_numeric( $hour ) && is_numeric( $minute ); $min_hour = $this->timeFormat == '24' ? 0 : 1; $max_hour = $this->timeFormat == '24' ? 24 : 12; $max_minute = $hour >= 24 ? 0 : 59; if ( ! $is_valid_format || $hour < $min_hour || $hour > $max_hour || $minute < 0 || $minute > $max_minute ) { $this->failed_validation = true; $this->validation_message = empty( $this->errorMessage ) ? esc_html__( 'Please enter a valid time.', 'gravityforms' ) : $this->errorMessage; } } /** * Create a validation message for a required field with multiple inputs. * * The validation message will specify which inputs need to be filled out. * * @since 2.5 * * @param array $value The value entered by the user. * @param array $required_inputs The required inputs to validate. * * @return string|void */ public function complex_validation_message( $value, $required_inputs ) { $error_inputs = array(); foreach ( $required_inputs as $input ) { if ( '' == $value[ $input ] ) { $input_id = $input + 1; $error_inputs[] = $this->get_input_property( $input_id, 'label' ); } } if ( ! empty( $error_inputs ) ) { $field_list = implode( ', ', $error_inputs ); // Translators: comma-separated list of the labels of missing fields. $message = sprintf( __( 'This field is required. Please complete the following fields: %s.', 'gravityforms' ), $field_list ); return $message; } return false; } /** * Returns the HTML tag for the field container. * * @since 2.5 * * @param array $form The current Form object. * * @return string */ public function get_field_container_tag( $form ) { if ( GFCommon::is_legacy_markup_enabled( $form ) ) { return parent::get_field_container_tag( $form ); } return 'fieldset'; } /** * Defines how the Time field input is shown. * * @since Unknown * @access public * * @used-by GFCommon::get_field_input() * @uses GF_Field::is_entry_detail() * @uses GF_Field::is_form_editor() * @uses GF_Field_Time::$subLabelPlacement * @uses GFFormsModel::get_input() * @uses GF_Field::get_input_placeholder_attribute() * @uses GF_Field::get_tabindex() * @uses GFFormsModel::is_html5_enabled() * * @param array $form The Form Object. * @param string $value The field default value. Defaults to empty string. * @param array|null $entry The Entry Object, if available. Defaults to null. * * @return string The field HTML markup. */ public function get_field_input( $form, $value = '', $entry = null ) { $is_entry_detail = $this->is_entry_detail(); $is_form_editor = $this->is_form_editor(); $form_id = absint( $form['id'] ); $id = intval( $this->id ); $field_id = $is_entry_detail || $is_form_editor || $form_id == 0 ? "input_$id" : 'input_' . $form_id . "_$id"; $form_sub_label_placement = rgar( $form, 'subLabelPlacement' ); $field_sub_label_placement = $this->subLabelPlacement; $colon_pmam_placement = empty( $field_sub_label_placement ) || $field_sub_label_placement == 'hidden_label' ? 'below' : $field_sub_label_placement; $is_sub_label_above = $field_sub_label_placement == 'above' || ( empty( $field_sub_label_placement ) && $form_sub_label_placement == 'above' ); $sub_label_class_attribute = $field_sub_label_placement == 'hidden_label' ? "class='hidden_sub_label screen-reader-text'" : ''; $disabled_text = $is_form_editor ? "disabled='disabled'" : ''; $hour = $minute = $am_selected = $pm_selected = ''; if ( ! is_array( $value ) && ! empty( $value ) ) { preg_match( '/^(\d*):(\d*) ?(.*)$/', $value, $matches ); $hour = esc_attr( $matches[1] ); $minute = esc_attr( $matches[2] ); $the_rest = strtolower( rgar( $matches, 3 ) ); $am_selected = strpos( $the_rest, 'am' ) > -1 ? "selected='selected'" : ''; $pm_selected = strpos( $the_rest, 'pm' ) > -1 ? "selected='selected'" : ''; } elseif ( is_array( $value ) ) { $value = array_values( $value ); $hour = esc_attr( $value[0] ); $minute = esc_attr( $value[1] ); $am_selected = strtolower( rgar( $value, 2 ) ) == 'am' ? "selected='selected'" : ''; $pm_selected = strtolower( rgar( $value, 2 ) ) == 'pm' ? "selected='selected'" : ''; } $hour_input = GFFormsModel::get_input( $this, $this->id . '.1' ); $minute_input = GFFormsModel::get_input( $this, $this->id . '.2' ); $hour_placeholder_attribute = $this->get_input_placeholder_attribute( $hour_input ) ? $this->get_input_placeholder_attribute( $hour_input ) : "placeholder='" . esc_attr__( 'HH', 'gravityforms' ) . "'"; $minute_placeholder_attribute = $this->get_input_placeholder_attribute( $minute_input ) ? $this->get_input_placeholder_attribute( $minute_input ) : "placeholder='" . esc_attr( _x( 'MM', 'Abbreviation: Minutes', 'gravityforms' ) ) . "'"; $hour_tabindex = $this->get_tabindex(); $minute_tabindex = $this->get_tabindex(); $ampm_tabindex = $this->get_tabindex(); $is_html5 = RGFormsModel::is_html5_enabled(); $input_type = $is_html5 ? 'number' : 'text'; $max_hour = $this->timeFormat == '24' ? 24 : 12; $hour_html5_attributes = $is_html5 ? "min='0' max='{$max_hour}' step='1'" : ''; $minute_html5_attributes = $is_html5 ? "min='0' max='59' step='1'" : ''; $clear_multi_div_open = GFCommon::is_legacy_markup_enabled( $form ) ? '
' : ''; $clear_multi_div_close = GFCommon::is_legacy_markup_enabled( $form ) ? '
' : ''; $output_shim = $is_sub_label_above && GFCommon::is_legacy_markup_enabled( $form ); $ampm_field_style = $is_form_editor && $this->timeFormat == '24' ? "style='display:none;'" : ''; if ( $is_form_editor || $this->timeFormat != '24' ) { $am_text = esc_html__( 'AM', 'gravityforms' ); $pm_text = esc_html__( 'PM', 'gravityforms' ); $aria_label = esc_attr( 'AM/PM', 'gravityforms' ); $ampm_field = "
" . ( $output_shim ? "" : "" ) . "
"; } else { $ampm_field = ''; } $hour_label_class = $minute_label_class = ''; if ( rgar( $hour_input, 'customLabel' ) !== '' ) { $hour_label = esc_html( $hour_input['customLabel'] ); } else if ( rgar( $hour_input, 'placeholder' ) ) { $hour_label = esc_html__( 'HH', 'gravityforms' ); } else { $hour_label = esc_html__( 'Hours', 'gravityforms' ); $hour_label_class = " screen-reader-text"; } if ( rgar( $minute_input, 'customLabel' ) !== '' ) { $minute_label = esc_html( $minute_input['customLabel'] ); } else if ( rgar( $minute_input, 'placeholder' ) ) { $minute_label = esc_html( _x( 'MM', 'Abbreviation: Minutes', 'gravityforms' ) ); } else { $minute_label = esc_html__( 'Minutes', 'gravityforms' ); $minute_label_class = " screen-reader-text"; } $input_values = array( $this->id . '.1' => $hour, $this->id . '.2' => $minute, ); $hour_aria_attributes = $this->get_aria_attributes( $input_values, '1' ); $minute_aria_attributes = $this->get_aria_attributes( $input_values, '2' ); $aria_describedby = $this->get_aria_describedby(); $legacy_markup_colon = GFCommon::is_legacy_markup_enabled( $form ) ? ':' : ''; $new_markup_colon = GFCommon::is_legacy_markup_enabled( $form ) ? '' : '
:
'; if ( $is_sub_label_above ) { $markup = "{$clear_multi_div_open}
{$legacy_markup_colon}
{$new_markup_colon}
{$ampm_field} {$clear_multi_div_close}"; } else { $markup = "{$clear_multi_div_open}
{$legacy_markup_colon}
{$new_markup_colon}
{$ampm_field} {$clear_multi_div_close}"; } return sprintf( '
%s
', $markup ); } /** * Whether this field expects an array during submission. * * @since 2.4 * * @return bool */ public function is_value_submission_array() { return true; } /** * Determines if any of the submission values are empty. * * @since Unknown * @access public * * @used-by GFFormDisplay::is_empty() * * @param int $form_id The form ID. * * @return bool True if empty. False otherwise. */ public function is_value_submission_empty( $form_id ) { $value = rgpost( 'input_' . $this->id ); if ( is_array( $value ) ) { // If some but not all inputs are empty, return false so that this field's validation method will be triggered. return empty( array_filter( $value ) ); } else { return strlen( trim( $value ) ) <= 0; } } /** * Determines whether the given value is considered empty for this field. * * @since 2.4 * * @param string|array $value The value. * * @return bool True if empty. False otherwise. */ public function is_value_empty( $value ) { if ( is_array( $value ) ) { foreach ( $value as $input ) { if ( strlen( trim( $input ) ) <= 0 ) { return true; } } return false; } else { return strlen( trim( $value ) ) <= 0; } } /** * Prepares the field value to be saved after an entry is submitted. * * @since Unknown * @access public * * @used-by GFFormsModel::prepare_value() * * @param string $value The value to prepare. * @param array $form The Form Object. Not used. * @param string $input_name The name of the input. Not used. * @param int $lead_id The entry ID. Not used. * @param array $lead The Entry Object. Not used. * * @return array|string The field value, prepared and stripped of tags. */ public function get_value_save_entry( $value, $form, $input_name, $lead_id, $lead ) { if ( empty( $value ) && ! is_array( $value ) ) { return ''; } // If $value is a default value and also an array, it will be an associative array; to be safe, let's convert all array $value to numeric. if ( is_array( $value ) ) { $value = array_values( $value ); } if ( ! is_array( $value ) && ! empty( $value ) ) { preg_match( '/^(\d*):(\d*) ?(.*)$/', $value, $matches ); $value = array(); $value[0] = $matches[1]; $value[1] = $matches[2]; $value[2] = rgar( $matches, 3 ); } $hour = wp_strip_all_tags( $value[0] ); $minute = wp_strip_all_tags( $value[1] ); $ampm = wp_strip_all_tags( rgar( $value, 2 ) ); if ( ! empty( $ampm ) ) { $ampm = " $ampm"; } if ( ! ( rgblank( $hour ) && rgblank( $minute ) ) ) { $value = sprintf( '%02d:%02d%s', $hour, $minute, $ampm ); } else { $value = ''; } return $value; } /** * Returns a JS script to be rendered in the front end of the form. * * @param array $form The Form Object * * @return string Returns a JS script to be processed in the front end. */ public function get_form_inline_script_on_page_render( $form ) { //Only return merge tag script if form supports JS merge tags if ( ! GFFormDisplay::has_js_merge_tag( $form ) ) { return ''; } return "gform.addFilter( 'gform_value_merge_tag_{$form['id']}_{$this->id}', function( value, input, modifier ) { if( modifier === 'label' ) { return false; } var ampm = input.length == 3 ? ' ' + jQuery(input[2]).val() : ''; return jQuery(input[0]).val() + ':' + jQuery(input[1]).val() + ' ' + ampm; } );"; } /** * Overrides GF_Field to prevent the standard input ID from being used. * * @since Unknown * @access public * * @return null */ public function get_entry_inputs() { return null; } /** * Removes the "for" attribute in the field label. Inputs are only allowed one label (a11y) and the inputs already have labels. * * @since 2.4 * @access public * * @param array $form The Form Object currently being processed. * * @return string */ public function get_first_input_id( $form ) { return ''; } /** * Sanitizes settings for the Time field. * * @since Unknown * @access public * * @used-by GFFormDetail::add_field() * @used-by GFFormsModel::sanitize_settings() * @uses GF_Field::sanitize_settings * @uses GF_Field_Time::$timeFormat * * @return void */ public function sanitize_settings() { parent::sanitize_settings(); if ( ! $this->timeFormat || ! in_array( $this->timeFormat, array( 12, 24 ) ) ) { $this->timeFormat = '12'; } } } // Register the Time field with the field framework. GF_Fields::register( new GF_Field_Time() );