File "hustle-sendgrid-form-hooks.php"
Full Path: /home/londdqdw/public_html/06/wp-content/plugins/wordpress-popup/inc/providers/sendgrid/hustle-sendgrid-form-hooks.php
File size: 9.7 KB
MIME-type: text/x-php
Charset: utf-8
<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
/**
* Hustle_Sendgrid_Form_Hooks class
*
* @package Hustle
*/
/**
* Class Hustle_Sendgrid_Form_Hooks
* Define the form hooks that are used by Sendgrid
*
* @since 4.0
*/
class Hustle_Sendgrid_Form_Hooks extends Hustle_Provider_Form_Hooks_Abstract {
/**
* Add SendGrid data to entry.
*
* @since 4.0
*
* @param array $submitted_data Submitted data.
* @return array
* @throws Exception Required fields are missed.
*/
public function add_entry_fields( $submitted_data ) {
$addon = $this->addon;
$module_id = $this->module_id;
$form_settings_instance = $this->form_settings_instance;
/**
* Filter submitted form data to be processed
*
* @since 4.0
*
* @param array $submitted_data
* @param int $module_id current module_id
* @param Hustle_Sendgrid_Form_Settings $form_settings_instance
*/
$submitted_data = apply_filters(
'hustle_provider_sendgrid_form_submitted_data',
$submitted_data,
$module_id,
$form_settings_instance
);
$addon_setting_values = $form_settings_instance->get_form_settings_values();
try {
if ( empty( $submitted_data['email'] ) ) {
throw new Exception( __( 'Required Field "email" was not filled by the user.', 'hustle' ) );
}
$global_multi_id = $addon_setting_values['selected_global_multi_id'];
$api_key = $addon->get_setting( 'api_key', '', $global_multi_id );
$new_campaigns = $addon->get_setting( 'new_campaigns', '', $global_multi_id );
$api = $addon::api( $api_key, $new_campaigns );
$list_id = $addon_setting_values['list_id'];
$submitted_data = $this->check_legacy( $submitted_data );
$is_sent = false;
$member_status = __( 'Member could not be subscribed.', 'hustle' );
$existing_member = $this->get_subscriber(
$api,
array(
'email' => $submitted_data['email'],
'list_id' => $list_id,
)
);
// Add extra fields.
$extra_data = array_diff_key( $submitted_data, array_flip( $api->get_reserved_fields_name() ) );
$extra_data = array_filter( $extra_data );
$submitted_data = array_filter( $submitted_data );
if ( ! empty( $extra_data ) ) {
if ( 'new_campaigns' === $new_campaigns ) {
// Save Custom Fields on saving modules for Sendgrid New Campaigns.
$submitted_data['custom_fields'] = $extra_data;
} else {
$custom_fields = array();
$module = new Hustle_Module_Model( $module_id );
$form_fields = $module->get_form_fields();
foreach ( $extra_data as $key => $value ) {
$type = isset( $form_fields[ $key ] ) ? $this->get_field_type( $form_fields[ $key ]['type'] ) : 'text';
if ( 'date' === $type && 'm/d/y' !== $form_fields[ $key ]['date_format'] && ! empty( $submitted_data[ $key ] ) ) {
$submitted_data[ $key ] = date( 'm/d/Y', strtotime( $submitted_data[ $key ] ) ); // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date
}
$custom_fields[] = array(
'name' => $key,
'value' => $value,
'type' => 'text',
);
}
$api->add_custom_fields( $custom_fields );
}
}
/**
* Fires before adding subscriber
*
* @since 4.0.2
*
* @param int $module_id
* @param array $submitted_data
* @param object $form_settings_instance
*/
do_action(
'hustle_provider_sendgrid_before_add_subscriber',
$module_id,
$submitted_data,
$form_settings_instance
);
if ( $existing_member ) {
if ( 'new_campaigns' === $new_campaigns ) {
$submitted_data['id'] = $existing_member;
}
$res = $api->update_recipient( $list_id, $submitted_data );
} else {
$res = $api->create_and_add_recipient_to_list( $list_id, $submitted_data );
}
/**
* Fires before adding subscriber
*
* @since 4.0.2
*
* @param int $module_id
* @param array $submitted_data
* @param mixed $res
* @param object $form_settings_instance
*/
do_action(
'hustle_provider_sendgrid_after_add_subscriber',
$module_id,
$submitted_data,
$res,
$form_settings_instance
);
if ( is_wp_error( $res ) ) {
$details = $res->get_error_message();
} else {
$is_sent = true;
$details = __( 'Successfully added or updated member on SendGrid list', 'hustle' );
$member_status = __( 'OK', 'hustle' );
}
$entry_fields = array(
array(
'name' => 'status',
'value' => array(
'is_sent' => $is_sent,
'description' => $details,
'member_status' => $member_status,
),
),
);
} catch ( Exception $e ) {
$entry_fields = $this->exception( $e );
}
if ( ! empty( $addon_setting_values['list_name'] ) ) {
$entry_fields[0]['value']['list_name'] = $addon_setting_values['list_name'];
}
$entry_fields = apply_filters(
'hustle_provider_sendgrid_entry_fields',
$entry_fields,
$module_id,
$submitted_data,
$form_settings_instance
);
return $entry_fields;
}
/**
* Unsubscribe
*
* @param string $email Email.
*/
public function unsubscribe( $email ) {
$addon = $this->addon;
$form_settings_instance = $this->form_settings_instance;
$addon_setting_values = $form_settings_instance->get_form_settings_values();
$list_id = $addon_setting_values['list_id'];
$global_multi_id = $addon_setting_values['selected_global_multi_id'];
$api_key = $addon->get_setting( 'api_key', '', $global_multi_id );
$new_campaigns = $addon->get_setting( 'new_campaigns', '', $global_multi_id );
try {
$api = $addon::api( $api_key, $new_campaigns );
$api->delete_email( $list_id, $email );
} catch ( Exception $e ) {
Opt_In_Utils::maybe_log( $addon->get_slug(), 'unsubscribtion is failed', $e->getMessage() );
}
}
/**
* Check whether the email is already subscribed.
*
* @since 4.0
*
* @param array $submitted_data Submitted data.
* @param bool $allow_subscribed Allow already subscribed.
* @return bool
*/
public function on_form_submit( $submitted_data, $allow_subscribed = true ) {
$is_success = true;
$module_id = $this->module_id;
$form_settings_instance = $this->form_settings_instance;
$addon = $this->addon;
$addon_setting_values = $form_settings_instance->get_form_settings_values();
if ( empty( $submitted_data['email'] ) ) {
return __( 'Required Field "email" was not filled by the user.', 'hustle' );
}
if ( ! $allow_subscribed ) {
/**
* Filter submitted form data to be processed
*
* @since 4.0
*
* @param array $submitted_data
* @param int $module_id current module_id
* @param Hustle_Sendgrid_Form_Settings $form_settings_instance
*/
$submitted_data = apply_filters(
'hustle_provider_sendgrid_form_submitted_data_before_validation',
$submitted_data,
$module_id,
$form_settings_instance
);
// triggers exception if not found.
$global_multi_id = $addon_setting_values['selected_global_multi_id'];
$api_key = $addon->get_setting( 'api_key', '', $global_multi_id );
$new_campaigns = $addon->get_setting( 'new_campaigns', '', $global_multi_id );
$api = $addon::api( $api_key, $new_campaigns );
$list_id = $addon_setting_values['list_id'];
$existing_member = $this->get_subscriber(
$api,
array(
'email' => $submitted_data['email'],
'list_id' => $list_id,
)
);
if ( $existing_member ) {
$is_success = self::ALREADY_SUBSCRIBED_ERROR;
}
}
/**
* Return `true` if success, or **(string) error message** on fail
*
* @since 4.0
*
* @param bool $is_success
* @param int $module_id current module_id
* @param array $submitted_data
* @param Hustle_Sendgrid_Form_Settings $form_settings_instance
*/
$is_success = apply_filters(
'hustle_provider_sendgrid_form_submitted_data_after_validation',
$is_success,
$module_id,
$submitted_data,
$form_settings_instance
);
// process filter.
if ( true !== $is_success ) {
// only update `submit_form_error_message` when not empty.
if ( ! empty( $is_success ) ) {
$this->submit_form_error_message = (string) $is_success;
}
return $is_success;
}
return true;
}
/**
* Get subscriber for providers
*
* This method is to be inherited
* And extended by child classes.
*
* Make use of the property `$subscriber`
* Method to omit double api calls
*
* @since 4.0.2
*
* @param object $api Api.
* @param mixed $data Data.
* @return mixed array/object API response on queried subscriber
*/
protected function get_subscriber( $api, $data ) {
if ( empty( $this->subscriber ) && ! isset( $this->subscriber[ md5( $data['email'] ) ] ) ) {
$this->subscriber[ md5( $data['email'] ) ] = $api->email_exists( $data['email'], $data['list_id'] );
}
return $this->subscriber[ md5( $data['email'] ) ];
}
/**
* Get supported fields
*
* This method is to be inherited
* and extended by child classes.
*
* List the fields supported by the
* provider
*
* @since 4.1
*
* @param string $type hustle field type.
* @return string Api field type
*/
protected function get_field_type( $type ) {
switch ( $type ) {
case 'datepicker':
$type = 'date';
break;
case 'number':
case 'phone':
$type = 'number';
break;
default:
$type = 'text';
break;
}
return $type;
}
}