366 lines
18 KiB
PHP
366 lines
18 KiB
PHP
<?php
|
|
|
|
if ( ! class_exists( 'GFForms' ) ) {
|
|
die();
|
|
}
|
|
|
|
|
|
class GF_Field_Post_Image extends GF_Field_Fileupload {
|
|
|
|
public $type = 'post_image';
|
|
|
|
/**
|
|
* 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 'div';
|
|
|
|
}
|
|
|
|
public function get_form_editor_field_title() {
|
|
return esc_attr__( 'Post Image', 'gravityforms' );
|
|
}
|
|
|
|
/**
|
|
* Returns the field's form editor description.
|
|
*
|
|
* @since 2.5
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_form_editor_field_description() {
|
|
return esc_attr__( 'Allows users to upload an image that is added to the Media Library and Gallery for the post that is created.', 'gravityforms' );
|
|
}
|
|
|
|
/**
|
|
* Returns the field's form editor icon.
|
|
*
|
|
* This could be an icon url or a gform-icon class.
|
|
*
|
|
* @since 2.5
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_form_editor_field_icon() {
|
|
return 'gform-icon--post-image';
|
|
}
|
|
|
|
function get_form_editor_field_settings() {
|
|
return array(
|
|
'conditional_logic_field_setting',
|
|
'error_message_setting',
|
|
'label_setting',
|
|
'label_placement_setting',
|
|
'sub_label_placement_setting',
|
|
'admin_label_setting',
|
|
'post_image_setting',
|
|
'rules_setting',
|
|
'description_setting',
|
|
'css_class_setting',
|
|
'post_image_featured_image',
|
|
);
|
|
}
|
|
|
|
public function get_field_input( $form, $value = '', $entry = null ) {
|
|
|
|
$form_id = $form['id'];
|
|
$is_entry_detail = $this->is_entry_detail();
|
|
$is_form_editor = $this->is_form_editor();
|
|
$is_admin = $is_entry_detail || $is_form_editor;
|
|
|
|
$id = (int) $this->id;
|
|
$field_id = $is_entry_detail || $is_form_editor || $form_id == 0 ? "input_$id" : 'input_' . $form_id . "_$id";
|
|
|
|
$size = $this->size;
|
|
$class_suffix = $is_entry_detail ? '_admin' : '';
|
|
$class = $size . $class_suffix;
|
|
$class = esc_attr( $class );
|
|
|
|
$disabled_text = $is_form_editor ? 'disabled="disabled"' : '';
|
|
|
|
$alt = esc_attr( rgget( $this->id . '.2', $value ) );
|
|
$title = esc_attr( rgget( $this->id . '.1', $value ) );
|
|
$caption = esc_attr( rgget( $this->id . '.4', $value ) );
|
|
$description = esc_attr( rgget( $this->id . '.7', $value ) );
|
|
|
|
//hiding meta fields for admin
|
|
$hidden_style = "style='display:none;'";
|
|
$alt_style = ! $this->displayAlt && $is_admin ? $hidden_style : '';
|
|
$title_style = ! $this->displayTitle && $is_admin ? $hidden_style : '';
|
|
$caption_style = ! $this->displayCaption && $is_admin ? $hidden_style : '';
|
|
$description_style = ! $this->displayDescription && $is_admin ? $hidden_style : '';
|
|
$file_label_style = $is_admin && ! ( $this->displayAlt || $this->displayTitle || $this->displayCaption || $this->displayDescription ) ? $hidden_style : '';
|
|
|
|
$form_sub_label_placement = rgar( $form, 'subLabelPlacement' );
|
|
$field_sub_label_placement = $this->subLabelPlacement;
|
|
$is_sub_label_above = $field_sub_label_placement == 'above' || ( empty( $field_sub_label_placement ) && $form_sub_label_placement == 'above' );
|
|
|
|
// Prepare accepted extensions message.
|
|
$extensions_message_id = 'gfield_upload_rules_' . $form_id . '_' . $id;
|
|
$extensions_message = sprintf(
|
|
"<span id='%s' class='gfield_description gform_fileupload_rules'>%s</span>",
|
|
$extensions_message_id,
|
|
esc_attr( sprintf( __( 'Accepted file types: %s.', 'gravityforms' ), implode( ', ', $this->get_clean_allowed_extensions() ) ) )
|
|
);
|
|
|
|
// Aria attributes.
|
|
$required_attribute = $this->isRequired ? 'aria-required="true"' : '';
|
|
$invalid_attribute = $this->failed_validation ? 'aria-invalid="true"' : 'aria-invalid="false"';
|
|
$aria_describedby = $this->get_aria_describedby( array( $extensions_message_id ) );
|
|
|
|
$preview = '';
|
|
$file_info = rgar( $this->get_submission_files_for_preview(), 0 );
|
|
|
|
if ( ! empty( $file_info ) ) {
|
|
$file_label_style = $hidden_style;
|
|
$file_preview = $this->get_file_preview_markup( $file_info, $form );
|
|
// Escape the progress percentages before the string is used in the sprintf.
|
|
$file_preview = str_replace( '100%', '100%%', $file_preview );
|
|
$preview = sprintf( "<div id='gform_preview_%d_%d' class='ginput_preview_list'>%s</div>", $form_id, $id, $file_preview );
|
|
}
|
|
|
|
//in admin, render all meta fields to allow for immediate feedback, but hide the ones not selected
|
|
$file_label = ( $is_admin && ( $this->displayAlt || $this->displayTitle || $this->displayCaption || $this->displayDescription ) ) ? "<label for='$field_id' class='gform-field-label gform-field-label--type-sub ginput_post_image_file' $file_label_style>" . gf_apply_filters( array( 'gform_postimage_file', $form_id ), esc_html__( 'File', 'gravityforms' ), $form_id ) . '</label>' : '';
|
|
|
|
$tabindex = $this->get_tabindex();
|
|
|
|
if ( $is_sub_label_above ) {
|
|
$upload = sprintf( "<span class='ginput_full$class_suffix gform-grid-col'>$file_label<input name='input_%d' id='%s' type='file' class='%s' $tabindex $required_attribute $invalid_attribute $aria_describedby %s/>{$extensions_message}{$preview}</span>", $id, $field_id, esc_attr( $class ), $disabled_text );
|
|
} else {
|
|
$upload = sprintf( "<span class='ginput_full$class_suffix gform-grid-col'><input name='input_%d' id='%s' type='file' class='%s' $tabindex $required_attribute $invalid_attribute $aria_describedby %s/>{$extensions_message}$file_label{$preview}</span>", $id, $field_id, esc_attr( $class ), $disabled_text );
|
|
}
|
|
|
|
$tabindex = $this->get_tabindex();
|
|
|
|
if ( $is_sub_label_above ) {
|
|
$alt_field = $this->displayAlt || $is_admin ? sprintf( "<span class='ginput_full$class_suffix ginput_post_image_alt gform-grid-col' $alt_style><label for='%s_2' class='gform-field-label gform-field-label--type-sub'>" . gf_apply_filters( array( 'gform_postimage_alt', $form_id ), __( 'Alternative Text', 'gravityforms' ), $form_id ) . "</label><input type='text' name='input_%d.2' id='%s_2' value='%s' $tabindex %s/></span>", $field_id, $id, $field_id, $alt, $disabled_text ) : '';
|
|
} else {
|
|
$alt_field = $this->displayAlt || $is_admin ? sprintf( "<span class='ginput_full$class_suffix ginput_post_image_alt gform-grid-col' $alt_style><input type='text' name='input_%d.2' id='%s_2' value='%s' $tabindex %s/><label for='%s_2' class='gform-field-label gform-field-label--type-sub'>" . gf_apply_filters( array( 'gform_postimage_alt', $form_id ), __( 'Alternative Text', 'gravityforms' ), $form_id ) . '</label></span>', $id, $field_id, $alt, $disabled_text, $field_id ) : '';
|
|
}
|
|
|
|
$tabindex = $this->get_tabindex();
|
|
|
|
if ( $is_sub_label_above ) {
|
|
$title_field = $this->displayTitle || $is_admin ? sprintf( "<span class='ginput_full$class_suffix ginput_post_image_title gform-grid-col' $title_style><label for='%s_1' class='gform-field-label gform-field-label--type-sub'>" . gf_apply_filters( array( 'gform_postimage_title', $form_id ), __( 'Title', 'gravityforms' ), $form_id ) . "</label><input type='text' name='input_%d.1' id='%s_1' value='%s' $tabindex %s/></span>", $field_id, $id, $field_id, $title, $disabled_text ) : '';
|
|
} else {
|
|
$title_field = $this->displayTitle || $is_admin ? sprintf( "<span class='ginput_full$class_suffix ginput_post_image_title gform-grid-col' $title_style><input type='text' name='input_%d.1' id='%s_1' value='%s' $tabindex %s/><label for='%s_1' class='gform-field-label gform-field-label--type-sub'>" . gf_apply_filters( array( 'gform_postimage_title', $form_id ), __( 'Title', 'gravityforms' ), $form_id ) . '</label></span>', $id, $field_id, $title, $disabled_text, $field_id ) : '';
|
|
}
|
|
|
|
$tabindex = $this->get_tabindex();
|
|
|
|
if ( $is_sub_label_above ) {
|
|
$caption_field = $this->displayCaption || $is_admin ? sprintf( "<span class='ginput_full$class_suffix ginput_post_image_caption gform-grid-col' $caption_style><label for='%s_4' class='gform-field-label gform-field-label--type-sub'>" . gf_apply_filters( array( 'gform_postimage_caption', $form_id ), __( 'Caption', 'gravityforms' ), $form_id ) . "</label><input type='text' name='input_%d.4' id='%s_4' value='%s' $tabindex %s/></span>", $field_id, $id, $field_id, $caption, $disabled_text ) : '';
|
|
} else {
|
|
$caption_field = $this->displayCaption || $is_admin ? sprintf( "<span class='ginput_full$class_suffix ginput_post_image_caption gform-grid-col' $caption_style><input type='text' name='input_%d.4' id='%s_4' value='%s' $tabindex %s/><label for='%s_4' class='gform-field-label gform-field-label--type-sub'>" . gf_apply_filters( array( 'gform_postimage_caption', $form_id ), __( 'Caption', 'gravityforms' ), $form_id ) . '</label></span>', $id, $field_id, $caption, $disabled_text, $field_id ) : '';
|
|
}
|
|
|
|
$tabindex = $this->get_tabindex();
|
|
|
|
if ( $is_sub_label_above ) {
|
|
$description_field = $this->displayDescription || $is_admin ? sprintf( "<span class='ginput_full$class_suffix ginput_post_image_description gform-grid-col' $description_style><label for='%s_7' class='gform-field-label gform-field-label--type-sub'>" . gf_apply_filters( array( 'gform_postimage_description', $form_id ), __( 'Description', 'gravityforms' ), $form_id ) . "</label><input type='text' name='input_%d.7' id='%s_7' value='%s' $tabindex %s/></span>", $field_id, $id, $field_id, $description, $disabled_text ) : '';
|
|
} else {
|
|
$description_field = $this->displayDescription || $is_admin ? sprintf( "<span class='ginput_full$class_suffix ginput_post_image_description gform-grid-col' $description_style><input type='text' name='input_%d.7' id='%s_7' value='%s' $tabindex %s/><label for='%s_7' class='gform-field-label gform-field-label--type-sub'>" . gf_apply_filters( array( 'gform_postimage_description', $form_id ), __( 'Description', 'gravityforms' ), $form_id ) . '</label></span>', $id, $field_id, $description, $disabled_text, $field_id ) : '';
|
|
}
|
|
|
|
return "<div class='ginput_complex$class_suffix ginput_container ginput_container_post_image gform-grid-row'>" . $upload . $alt_field . $title_field . $caption_field . $description_field . '</div>';
|
|
}
|
|
|
|
public function get_value_save_entry( $value, $form, $input_name, $lead_id, $lead ) {
|
|
$form_id = $form['id'];
|
|
$url = $this->get_single_file_value( $form_id, $input_name );
|
|
|
|
if ( empty( $url ) ) {
|
|
return '';
|
|
}
|
|
|
|
if ( ! GFCommon::is_valid_url( $url ) ) {
|
|
GFCommon::log_debug( __METHOD__ . '(): aborting; File URL invalid.' );
|
|
|
|
return '';
|
|
}
|
|
|
|
$image_alt = isset( $_POST["{$input_name}_2"] ) ? wp_strip_all_tags( $_POST["{$input_name}_2"] ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing, WordPress.Security.ValidatedSanitizedInput.MissingUnslash
|
|
$image_title = isset( $_POST["{$input_name}_1"] ) ? wp_strip_all_tags( $_POST["{$input_name}_1"] ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing, WordPress.Security.ValidatedSanitizedInput.MissingUnslash
|
|
$image_caption = isset( $_POST["{$input_name}_4"] ) ? wp_strip_all_tags( $_POST["{$input_name}_4"] ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing, WordPress.Security.ValidatedSanitizedInput.MissingUnslash
|
|
$image_description = isset( $_POST["{$input_name}_7"] ) ? wp_strip_all_tags( $_POST["{$input_name}_7"] ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing, WordPress.Security.ValidatedSanitizedInput.MissingUnslash
|
|
|
|
return $url . '|:|' . $image_title . '|:|' . $image_caption . '|:|' . $image_description . '|:|' . $image_alt;
|
|
}
|
|
|
|
public function get_value_entry_list( $value, $entry, $field_id, $columns, $form ) {
|
|
list( $url, $title, $caption, $description, $alt ) = rgexplode( '|:|', $value, 5 );
|
|
if ( empty( $url ) ) {
|
|
return '';
|
|
}
|
|
|
|
// Displaying thumbnail (if file is an image) or an icon based on the extension.
|
|
return sprintf(
|
|
'<a href="%s" target="_blank">'
|
|
.'<span class="screen-reader-text">%s</span>'
|
|
.'<span class="screen-reader-text">%s</span>'
|
|
.'<img src="%s" alt="%s">'
|
|
.'</a>',
|
|
esc_url( $url ),
|
|
esc_html__( 'View the image', 'gravityforms' ),
|
|
esc_html__( '(opens in a new tab)', 'gravityforms' ),
|
|
esc_url( GFEntryList::get_icon_url( $url ) ),
|
|
esc_attr( $alt )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Format the entry value for display on the entry detail page and for the {all_fields} merge tag.
|
|
*
|
|
* @since 1.9
|
|
* @since 2.9.29 Changed the second parameter $currency (string) to $entry (array).
|
|
*
|
|
* @param string|array $value The field value.
|
|
* @param array $entry The entry.
|
|
* @param bool|false $use_text When processing choice based fields should the choice text be returned instead of the value.
|
|
* @param string $format The format requested for the location the merge is being used. Possible values: html, text or url.
|
|
* @param string $media The location where the value will be displayed. Possible values: screen or email.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_value_entry_detail( $value, $entry = array(), $use_text = false, $format = 'html', $media = 'screen' ) {
|
|
$ary = explode( '|:|', $value );
|
|
$url = count( $ary ) > 0 ? $ary[0] : '';
|
|
$title = count( $ary ) > 1 ? $ary[1] : '';
|
|
$caption = count( $ary ) > 2 ? $ary[2] : '';
|
|
$description = count( $ary ) > 3 ? $ary[3] : '';
|
|
$alt = count( $ary ) > 4 ? $ary[4] : '';
|
|
|
|
if ( ! empty( $url ) ) {
|
|
$url = str_replace( ' ', '%20', $url );
|
|
|
|
switch ( $format ) {
|
|
case 'text' :
|
|
$value = $url;
|
|
$value .= ! empty( $alt ) ? "\n\n" . $this->label . ' (' . __( 'Alternative Text', 'gravityforms' ) . '): ' . $alt : '';
|
|
$value .= ! empty( $title ) ? "\n\n" . $this->label . ' (' . __( 'Title', 'gravityforms' ) . '): ' . $title : '';
|
|
$value .= ! empty( $caption ) ? "\n\n" . $this->label . ' (' . __( 'Caption', 'gravityforms' ) . '): ' . $caption : '';
|
|
$value .= ! empty( $description ) ? "\n\n" . $this->label . ' (' . __( 'Description', 'gravityforms' ) . '): ' . $description : '';
|
|
break;
|
|
|
|
default :
|
|
$value = sprintf( '<a href="%1$s" target="_blank" aria-label="%2$s"><img src="%1$s" width="100" alt="%3$s"></a>', esc_url( $url ), esc_attr__( 'View the image (opens in a new tab)', 'gravityforms' ), esc_attr( $alt ) );
|
|
$format = '<div>%s: %s</div>';
|
|
$value .= ! empty( $alt ) ? sprintf( $format, esc_html__( 'Alternative Text', 'gravityforms' ), esc_html( $alt ) ) : '';
|
|
$value .= ! empty( $title ) ? sprintf( $format, esc_html__( 'Title', 'gravityforms' ), esc_html( $title ) ) : '';
|
|
$value .= ! empty( $caption ) ? sprintf( $format, esc_html__( 'Caption', 'gravityforms' ), esc_html( $caption ) ) : '';
|
|
$value .= ! empty( $description ) ? sprintf( $format, esc_html__( 'Description', 'gravityforms' ), esc_html( $description ) ) : '';
|
|
|
|
break;
|
|
}
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
public function get_value_submission( $field_values, $get_from_post_global_var = true ) {
|
|
|
|
$value[ $this->id . '.2' ] = $this->get_input_value_submission( 'input_' . $this->id . '_2', $get_from_post_global_var );
|
|
$value[ $this->id . '.1' ] = $this->get_input_value_submission( 'input_' . $this->id . '_1', $get_from_post_global_var );
|
|
$value[ $this->id . '.4' ] = $this->get_input_value_submission( 'input_' . $this->id . '_4', $get_from_post_global_var );
|
|
$value[ $this->id . '.7' ] = $this->get_input_value_submission( 'input_' . $this->id . '_7', $get_from_post_global_var );
|
|
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Gets merge tag values.
|
|
*
|
|
* @since Unknown
|
|
* @since 2.5 Add alt text.
|
|
* @access public
|
|
*
|
|
* @param array|string $value The value of the input.
|
|
* @param string $input_id The input ID to use.
|
|
* @param array $entry The Entry Object.
|
|
* @param array $form The Form Object
|
|
* @param string $modifier The modifier passed.
|
|
* @param array|string $raw_value The raw value of the input.
|
|
* @param bool $url_encode If the result should be URL encoded.
|
|
* @param bool $esc_html If the HTML should be escaped.
|
|
* @param string $format The format that the value should be.
|
|
* @param bool $nl2br If the nl2br function should be used.
|
|
*
|
|
* @return string The processed merge tag.
|
|
*/
|
|
public function get_value_merge_tag( $value, $input_id, $entry, $form, $modifier, $raw_value, $url_encode, $esc_html, $format, $nl2br ) {
|
|
list( $url, $title, $caption, $description, $alt ) = array_pad( explode( '|:|', $value ), 5, false );
|
|
switch ( $modifier ) {
|
|
case 'alt' :
|
|
return $alt;
|
|
|
|
case 'title' :
|
|
return $title;
|
|
|
|
case 'caption' :
|
|
return $caption;
|
|
|
|
case 'description' :
|
|
return $description;
|
|
|
|
default :
|
|
return str_replace( ' ', '%20', $url );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Stores the physical file paths as extra entry meta data.
|
|
*
|
|
* @since 2.5.16
|
|
*
|
|
* @param array $form The form object being saved.
|
|
* @param array $entry The entry object being saved.
|
|
*
|
|
* @return array The array that contains the file URLs and their corresponding physical paths.
|
|
*/
|
|
public function get_extra_entry_metadata( $form, $entry ) {
|
|
|
|
// Leave only the file URL in the entry value so when parent saves the file path information the URL is a valid file URL.
|
|
$ary = explode( '|:|', $entry[ $this->id ] );
|
|
$entry[ $this->id ] = rgar( $ary, 0 );
|
|
|
|
return parent::get_extra_entry_metadata( $form, $entry );
|
|
|
|
}
|
|
|
|
/**
|
|
* Forces settings into expected values while saving the form object.
|
|
*
|
|
* @since 2.10.0 Added storageType property.
|
|
*/
|
|
public function sanitize_settings() {
|
|
parent::sanitize_settings();
|
|
$this->storageType = null;
|
|
}
|
|
|
|
/**
|
|
* Actions to be performed after the field has been converted to an object.
|
|
*
|
|
* @since 2.10.0
|
|
*/
|
|
public function post_convert_field() {
|
|
parent::post_convert_field();
|
|
$this->storageType = null;
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
GF_Fields::register( new GF_Field_Post_Image() );
|