get_menu_icon();
}
/**
* Get form editor button.
*
* @since 1.0
*
* @return array
*/
public function get_form_editor_button() {
return array(
'group' => 'pricing_fields',
'text' => $this->get_form_editor_field_title(),
);
}
/**
* Get field settings in the form editor.
*
* @since 1.0
*
* @return array
*/
public function get_form_editor_field_settings() {
return array(
'supported_payment_methods',
'paypal_default_payment_method',
'smart_payment_buttons_settings',
'conditional_logic_field_setting',
'force_ssl_field_setting',
'error_message_setting',
'label_setting',
'label_placement_setting',
'admin_label_setting',
'rules_setting',
'description_setting',
'css_class_setting',
'sub_labels_setting',
'sub_label_placement_setting',
'input_placeholders_setting',
'credit_card_setting',
);
}
/**
* Returns the scripts to be included for this field type in the form editor.
*
* @since 1.0
*
* @return string
*/
public function get_form_editor_inline_script_on_page_render() {
$default_payment_method = self::get_choices();
$default_payment_method = $default_payment_method[0]['value'];
// Register inputs (sub-labels).
$js = sprintf( "function SetDefaultValues_%s(field) {field.label = '%s';
field.inputs = [new Input(field.id + '.1', %s), new Input(field.id + '.2', %s), new Input(field.id + '.3', %s), new Input(field.id + '.4', %s), new Input(field.id + '.5', %s), new Input(field.id + '.6', %s)];
field.methods = %s;
field.paypalPaymentButtons = '%s';
field.buttonsLayout = '%s';
field.buttonsSize = '%s';
field.buttonsShape = '%s';
field.buttonsColor = '%s';
field.displayCreditMessages = '%s';
field.defaultPaymentMethod = '%s';
field.creditCards = ['visa', 'mastercard'];
}",
$this->type,
esc_html__( 'Payment Method', 'gravityformsppcp' ),
json_encode( gf_apply_filters( array( 'gform_card_number', rgget( 'id' ) ), esc_html__( 'Card Number', 'gravityformsppcp' ), rgget( 'id' ) ) ),
json_encode( gf_apply_filters( array( 'gform_card_expiration', rgget( 'id' ) ), esc_html__( 'Expiration Date', 'gravityformsppcp' ), rgget( 'id' ) ) ),
json_encode( gf_apply_filters( array( 'gform_card_security_code', rgget( 'id' ) ), esc_html__( 'Security Code', 'gravityformsppcp' ), rgget( 'id' ) ) ),
json_encode( gf_apply_filters( array( 'gform_card_type', rgget( 'id' ) ), esc_html__( 'Card Type', 'gravityformsppcp' ), rgget( 'id' ) ) ),
json_encode( gf_apply_filters( array( 'gform_card_name', rgget( 'id' ) ), esc_html__( 'Cardholder Name', 'gravityformsppcp' ), rgget( 'id' ) ) ),
json_encode( gf_apply_filters( array( 'paypal_payment_method', rgget( 'id' ) ), esc_html__( 'Payment Method', 'gravityformsppcp' ), rgget( 'id' ) ) ),
json_encode( wp_list_pluck( self::get_choices(), 'value' ) ),
gf_ppcp()->get_smart_payment_buttons_default( 'paypalPaymentButtons' ),
gf_ppcp()->get_smart_payment_buttons_default( 'layout' ),
gf_ppcp()->get_smart_payment_buttons_default( 'size' ),
gf_ppcp()->get_smart_payment_buttons_default( 'shape' ),
gf_ppcp()->get_smart_payment_buttons_default( 'color' ),
gf_ppcp()->get_smart_payment_buttons_default( 'displayCreditMessages' ),
$default_payment_method ) . PHP_EOL;
return $js;
}
/**
* Registers the script returned by get_form_inline_script_on_page_render() for display on the front-end.
*
* @since 1.0
*
* @param array $form The Form Object currently being processed.
*
* @return string
*/
public function get_form_inline_script_on_page_render( $form ) {
if ( ! gf_ppcp()->initialize_api() ) {
return '';
}
if ( $this->forceSSL && ! GFCommon::is_ssl() && ! GFCommon::is_preview() ) {
$script = "document.location.href='" . esc_js( RGFormsModel::get_current_page_url( true ) ) . "';";
} else {
$card_rules = $this->get_credit_card_rules();
$script = "if(!window['gf_cc_rules']){window['gf_cc_rules'] = new Array(); } window['gf_cc_rules'] = " . GFCommon::json_encode( $card_rules ) . ";";
}
return $script;
}
/**
* Get credit card rules.
*
* @since 1.0
*
* @return array
*/
public function get_credit_card_rules() {
$cards = GFCommon::get_card_types();
$rules = array();
foreach ( $cards as $card ) {
if ( ! $this->is_card_supported( $card['slug'] ) ) {
continue;
}
$prefixes = explode( ',', $card['prefixes'] );
foreach ( $prefixes as $prefix ) {
$rules[ $card['slug'] ][] = $prefix;
}
}
return $rules;
}
/**
* Defines the IDs of the inputs used when preparing the complex validation message for the required validation error.
*
* The card number, expiry date, and security code are hosted by PayPal, so we can't access those input values.
*
* Input 5 is the cardholder name.
*
* @since 3.3.0
*
* @return string[]
*/
public function get_required_inputs_ids() {
return array( '5' );
}
/**
* Used to determine the required validation result.
*
* @since 1.0
*
* @param int $form_id The ID of the form currently being processed.
*
* @return bool
*/
public function is_value_submission_empty( $form_id ) {
if (
! $this->is_credit_card_submission()
// Input 5 is the cardholder name.
|| $this->get_input_property( '5', 'isHidden' )
|| rgpost( 'input_' . $this->id . '_5' )
// These inputs aren't set when the JS hides the field when the there is nothing to pay.
|| ( ! isset( $_POST['ppcp_credit_card_type'] ) && ! isset( $_POST['ppcp_order_id'] ) )
) {
return false;
}
return true;
}
/**
* Checks if the payment method used in the submission is a credit card.
*
* @since 3.5.2
*/
public function is_credit_card_submission() {
return rgpost( 'input_' . $this->id . '_6' ) === 'Credit Card';
}
/**
* Override the parent validate method.
*
* @since 1.0
*
* @param array|string $value The field value.
* @param array $form The form object.
*/
public function validate( $value, $form ) {
if ( ! $this->is_credit_card_submission() || rgpost( 'action' ) === 'gfcf_validate_field' || ! isset( $_POST['ppcp_order_id'] ) ) {
return;
}
$credit_card_name = rgpost( 'ppcp_credit_card_type' );
if ( empty( $credit_card_name ) ) {
$this->failed_validation = true;
$this->validation_message = empty( $this->errorMessage ) ? esc_html__( 'Please enter a valid credit card number.', 'gravityformsppcp' ) : $this->errorMessage;
return;
}
$card_name = strtolower( $credit_card_name );
$cards = GFCommon::get_card_types();
$card_type = '';
foreach ( $cards as $card ) {
if ( $card_name === strtolower( rgar( $card, 'name' ) ) ) {
$card_type = rgar( $card, 'slug' );
break;
}
}
if ( ! $this->is_card_supported( $card_type ) ) {
$this->failed_validation = true;
$this->validation_message = empty( $this->errorMessage ) ? esc_html__( sprintf( '%s is not supported. Please enter one of the supported credit cards.', $credit_card_name ), 'gravityformsppcp' ) : $this->errorMessage;
}
}
/**
* Get submission value.
*
* @since 1.0
*
* @param array $field_values Field values.
* @param bool $get_from_post_global_var True if get from global $_POST.
*
* @return array|string
*/
public function get_value_submission( $field_values, $get_from_post_global_var = true ) {
if ( $get_from_post_global_var ) {
$value[ $this->id . '.4' ] = $this->get_input_value_submission( 'input_' . $this->id . '_4', rgar( $this->inputs[3], 'name' ), $field_values, true );
$value[ $this->id . '.5' ] = $this->get_input_value_submission( 'input_' . $this->id . '_5', rgar( $this->inputs[4], 'name' ), $field_values, true );
$value[ $this->id . '.6' ] = $this->get_input_value_submission( 'input_' . $this->id . '_6', rgar( $this->inputs[5], 'name' ), $field_values, true );
} else {
$value = $this->get_input_value_submission( 'input_' . $this->id, $this->inputName, $field_values, $get_from_post_global_var );
}
return $value;
}
/**
* Get field messages if any should be displayed.
*
* @since 3.0
*
* @return array[]|array|string
*/
public function get_field_sidebar_messages() {
$addon = gf_ppcp();
$warning = $this->admin_field_validation_check( true );
$sidebar_warning = ! $addon->get_subscriptions_handler()->supports_form_selected_payment_methods( $addon->get_current_form() );
if ( $warning !== true ) {
return array(
'type' => 'notice',
'content' => $warning,
'icon_helper_text' => esc_html__( 'This field requires additional configuration', 'gravityformsppcp' ),
);
}
if ( $sidebar_warning ) {
return array(
'type' => 'notice',
'content' => sprintf(
'
%s
',
esc_html__( 'The Credit Card field is not supported for subscriptions and will not display on your form. Users can still pay with a credit card by using the card option in the PayPal Checkout Modal.', 'gravityformsppcp' )
),
'icon_helper_text' => esc_html__( 'This field is not supported for subscriptions', 'gravityformsppcp' ),
);
}
return '';
}
/**
* Check API Key, PayPal Checkout, and Feed Settings for admin validation.
*
* @since 3.8.0
*
* @param bool $is_editor_sidebar If the validation is for the form editor sidebar.
*
* @return bool|string True if passes validation, error string if failed.
*/
private function admin_field_validation_check( $is_editor_sidebar = false ) {
$addon = gf_ppcp();
$is_form_editor = $this->is_form_editor();
if ( ! $addon->initialize_api() ) {
$settings_url = esc_url( $addon->get_plugin_settings_url() );
/* translators: 1. Open div tag 2. Close div tag 3. Open link tag 4. Close link tag */
$message = $is_form_editor ? esc_html__( 'Configuration Required%1$sTo use the PayPal Checkout field, please configure your %3$sPayPal Checkout Settings%4$s.%2$s', 'gravityformsppcp' ) : esc_html__( '%1$sConfiguration Required: To use the PayPal Checkout field, please configure your %3$sPayPal Checkout Settings%4$s.%2$s', 'gravityformsppcp' );
return $this->get_card_error_message( $message, $settings_url, $is_editor_sidebar );
}
if ( ! ( defined( 'DOING_AJAX' ) && DOING_AJAX && rgpost( 'action' ) === 'rg_add_field' ) && ! $addon->has_feed( $this->formId ) ) {
$feed_url = add_query_arg(
array(
'page' => 'gf_edit_forms',
'view' => 'settings',
'subview' => $addon->get_slug(),
'id' => $this->formId,
),
admin_url( 'admin.php' )
);
/* translators: 1. Open div tag 2. Close div tag 3. Open link tag 4. Close link tag */
$message = $is_form_editor ? esc_html__( 'Feed Required%1$sTo use the PayPal Checkout field, please create a %3$sPayPal Checkout feed%4$s for this form.%2$s', 'gravityformsppcp' ) : esc_html__( '%1$sFeed Required: To use the PayPal Checkout field, please create a %3$sPayPal Checkout feed%4$s for this form.%2$s', 'gravityformsppcp' );
return $this->get_card_error_message( $message, $feed_url, $is_editor_sidebar );
}
return true;
}
/**
* Form editor field notice if Credit Card is enabled for the field and feed is set to Subscription as transaction type.
*
* @since 3.8.0
*
* @return string
*/
private function admin_field_card_helper_subscriptions() {
$addon = gf_ppcp();
$form = $addon->get_current_form();
$style = ! $addon->get_subscriptions_handler()->supports_form_selected_payment_methods( $form ) ? '' : ' style="display:none;"';
return sprintf(
'
%s
',
$style,
esc_html__( 'The Credit Card field is not supported for subscriptions and will not display on your form. Users can still pay with a credit card by using the card option in the PayPal Checkout Modal.', 'gravityformsppcp' )
);
}
/**
* Form editor field notice if PayPal Checkout is enabled for the field.
*
* @since 3.8.0
*
* @param array $methods The payment methods.
*
* @return string
*/
private function admin_field_card_helper_paypal_checkout( $methods ) {
$style = ! $methods || in_array( 'PayPal Checkout', $methods, true ) ? '' : ' style="display:none;"';
return sprintf(
'
%s
',
$style,
esc_html__( 'PayPal Checkout is enabled for your form. The PayPal Smart Payment Buttons will replace the Submit button of your form when it is the selected or only payment method.', 'gravityformsppcp' )
);
}
/**
* Check if Custom Card Fields is supported.
*
* @since 3.0
*
* @return bool|string Boolean or the vetting status of the product, if available.
*/
private static function is_custom_card_fields_supported() {
static $result;
if ( is_null( $result ) ) {
$result = gf_ppcp()->is_custom_card_fields_supported();
}
return $result;
}
/**
* Get field input.
*
* @since 1.0
*
* @param array $form The Form Object currently being processed.
* @param array $value The field value. From default/dynamic population, $_POST, or a resumed incomplete submission.
* @param null|array $entry Null or the Entry Object currently being edited.
*
* @return string
*/
public function get_field_input( $form, $value = array(), $entry = null ) {
$is_entry_detail = $this->is_entry_detail();
$is_form_editor = $this->is_form_editor();
$is_admin = $is_entry_detail || $is_form_editor;
$messages = $this->admin_field_validation_check();
if ( $messages !== true ) {
return $messages;
}
$form_id = $form['id'];
$id = intval( $this->id );
$field_id = $is_entry_detail || $is_form_editor || $form_id == 0 ? "input_$id" : 'input_' . $form_id . "_$id";
$form_id = ( $is_entry_detail || $is_form_editor ) && empty( $form_id ) ? rgget( 'id' ) : $form_id;
$disabled_text = $is_form_editor ? "disabled='disabled'" : '';
$class_suffix = $is_entry_detail ? '_admin' : '';
$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' );
$sub_label_class_attribute = $field_sub_label_placement == 'hidden_label' ? "class='hidden_sub_label screen-reader-text'" : " class='gform-field-label gform-field-label--type-sub'";
$card_name = '';
if ( is_array( $value ) ) {
$card_name = esc_attr( rgget( $this->id . '.5', $value ) );
}
$card_icons = '';
$cards = GFCommon::get_card_types();
$card_style = $this->creditCardStyle ? $this->creditCardStyle : 'style1';
foreach ( $cards as $card ) {
$style = '';
if ( $this->is_card_supported( $card['slug'] ) ) {
$print_card = true;
$enabled_card_names[] = rgar( $card, 'name' );
} elseif ( $is_form_editor || $is_entry_detail ) {
$print_card = true;
$style = "style='display:none;'";
} else {
$print_card = false;
}
if ( $print_card ) {
$card_icons .= "
';
return $field_input;
}
/**
* Returns the field markup; including field label, description, validation, and the form editor admin buttons.
*
* The {FIELD} placeholder will be replaced in GFFormDisplay::get_field_content with the markup returned by GF_Field::get_field_input().
*
* @since 1.0
*
* @param string|array $value The field value. From default/dynamic population, $_POST, or a resumed incomplete submission.
* @param bool $force_frontend_label Should the frontend label be displayed in the admin even if an admin label is configured.
* @param array $form The Form Object currently being processed.
*
* @return string
*/
public function get_field_content( $value, $force_frontend_label, $form ) {
// Get the default HTML markup.
$form_id = (int) rgar( $form, 'id' );
$field_label = $this->get_field_label( $force_frontend_label, $value );
$validation_message_id = 'validation_message_' . $form_id . '_' . $this->id;
$validation_message = ( $this->failed_validation && ! empty( $this->validation_message ) ) ? sprintf( "
" . esc_html__( 'This page is unsecured. Do not enter a real credit card number! Use this field only for testing purposes.', 'gravityformsppcp' ) . '
' . $field_content;
}
return $field_content;
}
/**
* Retrieve the payment methods.
*
* @since 1.0
*
* @param string $value value of field.
*
* @return array Choices for the Payment Method input.
*/
public static function get_choices( $value = '' ) {
if ( empty( self::$_choices ) ) {
$methods = array(
array(
'text' => esc_html__( 'PayPal Checkout', 'gravityformsppcp' ),
'value' => 'PayPal Checkout',
'isSelected' => $value === 'PayPal Checkout',
),
);
if ( self::is_custom_card_fields_supported() ) {
$methods[] = array(
'text' => esc_html__( 'Credit Card', 'gravityformsppcp' ),
'value' => 'Credit Card',
'isSelected' => $value === 'Credit Card',
);
}
self::$_choices = $methods;
}
return self::$_choices;
}
/**
* Get field label class.
*
* Subscriptions were introduced in 2.0, but at the time, PayPal did not yet support credit card fields
* in the subscriptions API. Thus, we have to apply the hidden visibility class on the label so functionally
* the label behaves the same as if only a single payment method was selected.
*
* @since 1.0
*
* @return string
*/
public function get_field_label_class() {
$label_classes = 'gfield_label gfield_label_before_complex gform-field-label';
if ( ! gf_ppcp()->get_subscriptions_handler()->supports_form_selected_payment_methods( gf_ppcp()->get_current_form() ) ) {
$label_classes .= ' gfield_visibility_hidden';
}
return $label_classes;
}
/**
* Get entry inputs.
*
* @since 1.0
*
* @return array|null
*/
public function get_entry_inputs() {
$inputs = array();
foreach ( $this->inputs as $input ) {
if ( in_array( $input['id'], array( $this->id . '.4' ), true ) ) {
$inputs[] = $input;
}
}
return $inputs;
}
/**
* Get the value in entry details.
*
* @since 1.0
*
* @param string|array $value The field value.
* @param string $currency The entry currency code.
* @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, $currency = '', $use_text = false, $format = 'html', $media = 'screen' ) {
if ( is_array( $value ) ) {
$card_type = trim( rgget( $this->id . '.4', $value ) );
return $card_type;
}
return '';
}
/**
* Get the value when saving to an entry.
*
* @since 1.0
*
* @param string $value The value to be saved.
* @param array $form The Form Object currently being processed.
* @param string $input_name The input name used when accessing the $_POST.
* @param int $lead_id The ID of the Entry currently being processed.
* @param array $lead The Entry Object currently being processed.
*
* @return array|string
*/
public function get_value_save_entry( $value, $form, $input_name, $lead_id, $lead ) {
list( $input_token, $field_id_token, $input_id ) = rgexplode( '_', $input_name, 3 );
if ( $input_id === '4' ) {
$value = rgpost( "input_{$field_id_token}_4" );
} else {
$value = '';
}
return $this->sanitize_entry_value( $value, $form['id'] );
}
/**
* Remove the duplicate admin button.
*
* @since 1.0
*
* @return string
*/
public function get_admin_buttons() {
add_filter( 'gform_duplicate_field_link', '__return_empty_string' );
$admin_buttons = parent::get_admin_buttons();
remove_filter( 'gform_duplicate_field_link', '__return_empty_string' );
return $admin_buttons;
}
/**
* Create the field specific settings UI.
*
* @since 1.0
*
* @param int $position The position.
*/
public static function payment_methods_standard_settings( $position ) {
if ( $position === 1350 ) {
$credit_card_supported = self::is_custom_card_fields_supported();
?>
" . esc_html( $text ) . '';
}
return $str;
}
/**
* Create the field specific settings UI.
*
* @since 1.0
*
* @param int $position The position.
*/
public static function payment_methods_appearance_settings( $position ) {
if ( $position === 50 ) { ?>
' . esc_html__( 'The PayPal Smart Payment Buttons can be customized in the Appearance settings. The PayPal logo will be displayed on the button.', 'gravityformsppcp' );
$tooltips['payment_buttons'] = sprintf(
/* translators: 1.List of funding sources. 2.Open link tag 3.Close link tag */
esc_html__( 'Enable this setting to allow PayPal to display a variety of funding sources based on a buyer’s eligibility. The available funding sources are: %1$s. %2$sLearn more.%3$s', 'gravityformsppcp' ),
gf_ppcp()->get_enabled_funding_sources_names(),
'',
''
);
$tooltips['credit_messages'] = '
' . esc_html__( 'PayPal Credit is a revolving line of credit that your buyers can use to buy now and pay over time. You can display credit messages on your website to promote special financing offers, which help increase sales.', 'gravityformsppcp' );
$tooltips['custom_card_fields'] = '
' . esc_html__( 'The credit card field is white-labeled so no PayPal branding will be displayed on the page.', 'gravityformsppcp' );
$tooltips['custom_card_fields_sub_labels'] = '
' . esc_html__( 'Enter values in this setting to override the Sub-Label for each field. You can also turn off the Cardholder Name.', 'gravityformsppcp' );
$tooltips['form_field_credit_cards'] = '
' . esc_html__( 'This provides a visual indicator to your credit card fields when users are filling in their payment details. Your payment gateway may still reject the card types they do not support. Please refer to the add-on documentation for more details.', 'gravityformsppcp' );
$tooltips['smart_payment_buttons'] = '
';
$tooltips['smart_payment_buttons'] .= sprintf(
/* translators: 1. Open paragraph tag 2. Close paragraph tag 3. Open link tag 4. Close link tag */
esc_html__( '%1$sCustomize the Smart Payment Buttons for this form. Besides the default PayPal button, you may see additional buttons for other funding sources.%2$s%1$s%3$sLearn more about funding sources%4$s.%2$s', 'gravityformsppcp' ),
'
',
'
',
'',
''
);
return $tooltips;
}
/**
* Overwrite the parent method to avoid the field upgrade from the credit card field class.
*
* @since 1.0
*/
public function post_convert_field() {
GF_Field::post_convert_field();
}
/**
* Display the PayPal Checkout error message.
*
* @since 3.8.0
*
* @param string $message The error message.
* @param string $url The error message URL.
* @param bool $is_editor_sidebar Whether the error message is displayed in the form editor sidebar.
*
* @return string
*/
private function get_card_error_message( $message, $url = '', $is_editor_sidebar = false ) {
// Form Editor Sidebar Messages
if ( $is_editor_sidebar ) {
return sprintf( $message, '
', '
', '', '' );
}
// Form Editor Messages
if ( $this->is_form_editor() ) {
return '