Your IP : 216.73.216.138
<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
/**
* Hustle_Icontact_Form_Hooks
*
* @package Hustle
*/
/**
* Class Hustle_iContact_Form_Hooks
* Define the form hooks that are used by iContact
*
* @since 4.0
*/
class Hustle_Icontact_Form_Hooks extends Hustle_Provider_Form_Hooks_Abstract {
/**
* Add iContact 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_Icontact_Form_Settings $form_settings_instance
*/
$submitted_data = apply_filters(
'hustle_provider_icontact_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' ) );
}
$list_id = $addon_setting_values['list_id'];
$status = 'pending' === $addon_setting_values['auto_optin'] ? 'pending' : 'normal';
$confirmation_message_id = ! empty( $addon_setting_values['confirmation_message_id'] ) ? $addon_setting_values['confirmation_message_id'] : 0;
$submitted_data = $this->check_legacy( $submitted_data );
$global_multi_id = $addon_setting_values['selected_global_multi_id'];
$app_id = $addon->get_setting( 'app_id', '', $global_multi_id );
$username = $addon->get_setting( 'username', '', $global_multi_id );
$password = $addon->get_setting( 'password', '', $global_multi_id );
$is_sent = false;
$member_status = __( 'Member could not be subscribed.', 'hustle' );
$api = $addon::api( $app_id, $password, $username );
if ( is_wp_error( $api ) ) {
$details = __( 'There was an error connecting to your account. Please make sure your credentials are correct.', 'hustle' );
} else {
$email = $submitted_data['email'];
$merge_vals = array();
if ( isset( $submitted_data['first_name'] ) ) {
$merge_vals['firstName'] = $submitted_data['first_name'];
}
if ( isset( $submitted_data['last_name'] ) ) {
$merge_vals['lastName'] = $submitted_data['last_name'];
}
// Add extra fields.
$extra_data = array_diff_key(
$submitted_data,
array(
'email' => '',
'first_name' => '',
'last_name' => '',
)
);
$extra_data = array_filter( $extra_data );
if ( ! empty( $extra_data ) ) {
$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';
$custom_fields[] = array(
'name' => $key,
'type' => $type,
);
}
$addon->add_custom_fields( $custom_fields, $api );
$merge_vals = array_merge( $merge_vals, $extra_data );
}
$existing_member = $this->get_subscriber(
$addon,
array(
'api' => $api,
'list_id' => $addon_setting_values['list_id'],
'email' => $submitted_data['email'],
)
);
if ( $existing_member ) {
// ---------------------------------------------------------
// Omitting Icontact update method
// ---------------------------------------------------------
//
// Icontact api doesn't have a proper updating function.
// Supplying data to an "update" endpoint will delete all the
// previously submitted data and adds the new ones, thus
// resulting in data loss.
// We're omitting the update function here and just sending a message.
// This also means that we show a "Data not sent" message on the
// email list's log for icontact integration.
$details = __( 'This email address has already subscribed.', 'hustle' );
} else {
$subscribe_data = array(
'email' => $email,
'status' => 'normal',
);
$subscribe_data = array_merge( $subscribe_data, $merge_vals );
/**
* 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_icontact_before_add_subscriber',
$module_id,
$submitted_data,
$form_settings_instance
);
$response = $api->add_subscriber( $list_id, $subscribe_data, $status, $confirmation_message_id );
/**
* Fires after adding subscriber
*
* @since 4.0.2
*
* @param int $module_id
* @param array $submitted_data
* @param mixed $response
* @param object $form_settings_instance
*/
do_action(
'hustle_provider_icontact_after_add_subscriber',
$module_id,
$submitted_data,
$response,
$form_settings_instance
);
if ( is_wp_error( $response ) ) {
$details = $response->get_error_message();
} else {
$is_sent = true;
$details = __( 'Successfully added or updated member on iContact list', 'hustle' );
}
}
}
$utils = Hustle_Provider_Utils::get_instance();
$last_data_received = $utils->get_last_data_received( false );
// Response is a JSON so we need to pharse it first.
if ( ! empty( $last_data_received['body'] ) ) {
$last_data_received = json_decode( $last_data_received['body'], true );
// If the member is new iContact return [subscriptions] if it already exists
// than ['contacts'].
if ( ! empty( $last_data_received['subscriptions'][0]['status'] ) ) {
$member_status = $last_data_received['subscriptions'][0]['status'];
} elseif ( ! empty( $last_data_received['contacts'][0]['status'] ) ) {
$member_status = $last_data_received['contacts'][0]['status'];
}
}
$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'];
}
if ( 'pending' === $status && ! empty( $addon_setting_values['confirmation_message_name'] ) ) {
$entry_fields[0]['value']['confirmation_message_name'] = $addon_setting_values['confirmation_message_name'];
}
$entry_fields = apply_filters(
'hustle_provider_' . $addon->get_slug() . '_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'];
$app_id = $addon->get_setting( 'app_id', '', $global_multi_id );
$username = $addon->get_setting( 'username', '', $global_multi_id );
$password = $addon->get_setting( 'password', '', $global_multi_id );
try {
$api = $addon::api( $app_id, $password, $username );
$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_Icontact_Form_Settings $form_settings_instance
*/
$submitted_data = apply_filters(
'hustle_provider_icontact_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'];
$app_id = $addon->get_setting( 'app_id', '', $global_multi_id );
$username = $addon->get_setting( 'username', '', $global_multi_id );
$password = $addon->get_setting( 'password', '', $global_multi_id );
$api = $addon::api( $app_id, $password, $username );
$existing_member = $this->get_subscriber(
$addon,
array(
'api' => $api,
'list_id' => $addon_setting_values['list_id'],
'email' => $submitted_data['email'],
)
);
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_Icontact_Form_Settings $form_settings_instance
*/
$is_success = apply_filters(
'hustle_provider_icontact_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->is_subscribed( $data['api'], $data['list_id'], $data['email'] );
}
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;
}
}