585 lines
16 KiB
PHP
585 lines
16 KiB
PHP
<?php
|
|
/**
|
|
* WP Ultimo Email Edit/Add New Admin Page.
|
|
*
|
|
* @package WP_Ultimo
|
|
* @subpackage Admin_Pages
|
|
* @since 2.0.0
|
|
*/
|
|
|
|
namespace WP_Ultimo\Admin_Pages;
|
|
|
|
// Exit if accessed directly
|
|
defined('ABSPATH') || exit;
|
|
|
|
use \WP_Ultimo\Models\Email;
|
|
use \WP_Ultimo\Managers\Email_Manager;
|
|
|
|
/**
|
|
* WP Ultimo Email Edit/Add New Admin Page.
|
|
*/
|
|
class Email_Edit_Admin_Page extends Edit_Admin_Page {
|
|
|
|
/**
|
|
* Holds the ID for this page, this is also used as the page slug.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $id = 'wp-ultimo-edit-email';
|
|
|
|
/**
|
|
* Is this a top-level menu or a submenu?
|
|
*
|
|
* @since 1.8.2
|
|
* @var string
|
|
*/
|
|
protected $type = 'submenu';
|
|
|
|
/**
|
|
* Object ID being edited.
|
|
*
|
|
* @since 1.8.2
|
|
* @var string
|
|
*/
|
|
public $object_id = 'system_email';
|
|
|
|
|
|
/**
|
|
* Is this a top-level menu or a submenu?
|
|
*
|
|
* @since 1.8.2
|
|
* @var string
|
|
*/
|
|
protected $parent = 'none';
|
|
|
|
/**
|
|
* This page has no parent, so we need to highlight another sub-menu.
|
|
*
|
|
* @since 2.0.0
|
|
* @var string
|
|
*/
|
|
protected $highlight_menu_slug = 'wp-ultimo-broadcasts';
|
|
|
|
/**
|
|
* If this number is greater than 0, a badge with the number will be displayed alongside the menu title
|
|
*
|
|
* @since 1.8.2
|
|
* @var integer
|
|
*/
|
|
protected $badge_count = 0;
|
|
|
|
/**
|
|
* Holds the admin panels where this page should be displayed, as well as which capability to require.
|
|
*
|
|
* To add a page to the regular admin (wp-admin/), use: 'admin_menu' => 'capability_here'
|
|
* To add a page to the network admin (wp-admin/network), use: 'network_admin_menu' => 'capability_here'
|
|
* To add a page to the user (wp-admin/user) admin, use: 'user_admin_menu' => 'capability_here'
|
|
*
|
|
* @since 2.0.0
|
|
* @var array
|
|
*/
|
|
protected $supported_panels = array(
|
|
'network_admin_menu' => 'wu_edit_emails',
|
|
);
|
|
|
|
/**
|
|
* Initializes the class
|
|
*
|
|
* @since 1.8.2
|
|
* @return void
|
|
*/
|
|
public function init() {
|
|
|
|
/**
|
|
* Runs the parent init functions
|
|
*/
|
|
parent::init();
|
|
|
|
add_action('wu_page_edit_redirect_handlers', array($this, 'handle_page_redirect'), 10);
|
|
|
|
} // end init;
|
|
|
|
/**
|
|
* Registers the necessary scripts.
|
|
*
|
|
* @since 2.0.0
|
|
* @return void
|
|
*/
|
|
public function register_scripts() {
|
|
|
|
parent::register_scripts();
|
|
|
|
wp_enqueue_script('wu-email-edit-page', wu_get_asset('email-edit-page.js', 'js'), array('jquery', 'clipboard'));
|
|
|
|
} // end register_scripts;
|
|
|
|
/**
|
|
* Allow child classes to register widgets, if they need them.
|
|
*
|
|
* @since 1.8.2
|
|
* @return void
|
|
*/
|
|
public function register_widgets() {
|
|
|
|
parent::register_widgets();
|
|
|
|
$object = $this->get_object();
|
|
|
|
// translators: %s is replaced with the number of days.
|
|
$days_text = sprintf(__('Send %s day(s) after the event.', 'wp-ultimo'), '{{ days }}');
|
|
|
|
// translators: %1$s is replaced with the number of hours, %2$s is replaced with the number of minutes.
|
|
$hour_text = sprintf(__('Send %1$s hour(s) and %2$s minute(s) after the event.', 'wp-ultimo'), '{{ hours.split(":").shift() }}', '{{ hours.split(":").pop() }}');
|
|
|
|
$desc = sprintf('
|
|
<span v-show="schedule && schedule_type == \'days\'">%s</span>
|
|
<span v-show="schedule && schedule_type == \'hours\'">%s</span>
|
|
', $days_text, $hour_text);
|
|
|
|
$this->add_save_widget('save', array(
|
|
'html_attr' => array(
|
|
'data-wu-app' => 'email_edit_save',
|
|
'data-state' => wu_convert_to_state(array(
|
|
'slug' => $this->edit ? $object->get_slug() : '',
|
|
'target' => $this->edit ? $object->get_target() : 'admin',
|
|
'schedule' => $this->edit ? $object->has_schedule() : false,
|
|
'schedule_type' => $this->edit ? $object->get_schedule_type() : 'days',
|
|
'days' => $this->edit ? $object->get_send_days() : 1,
|
|
'hours' => $this->edit ? $object->get_send_hours() : '12:00',
|
|
)),
|
|
),
|
|
'fields' => array(
|
|
'slug' => array(
|
|
'type' => 'text',
|
|
'title' => __('Slug', 'wp-ultimo'),
|
|
'desc' => __('An unique identifier for this system email.', 'wp-ultimo'),
|
|
'value' => $this->edit ? $object->get_slug() : '',
|
|
'html_attr' => array(
|
|
'required' => 'required',
|
|
'v-on:input' => 'slug = $event.target.value.toLowerCase().replace(/[^a-z0-9-_]+/g, "")',
|
|
'v-bind:value' => 'slug',
|
|
),
|
|
),
|
|
'event' => array(
|
|
'type' => 'select',
|
|
'title' => __('Event', 'wp-ultimo'),
|
|
'desc' => __('The event that will trigger the sending of this email.', 'wp-ultimo'),
|
|
'placeholder' => __('Event', 'wp-ultimo'),
|
|
'options' => 'wu_get_event_types_as_options',
|
|
'value' => $this->edit ? $object->get_event() : 0,
|
|
'html_attr' => array(
|
|
'name' => ''
|
|
),
|
|
),
|
|
'target' => array(
|
|
'type' => 'select',
|
|
'title' => __('Target', 'wp-ultimo'),
|
|
'desc' => __('To whom this email should be sent.', 'wp-ultimo'),
|
|
'placeholder' => __('Network Administrators', 'wp-ultimo'),
|
|
'value' => $this->edit ? $object->get_target() : 'admin',
|
|
'options' => array(
|
|
'admin' => __('Network Administrators', 'wp-ultimo'),
|
|
'customer' => __('Customer', 'wp-ultimo'),
|
|
),
|
|
'html_attr' => array(
|
|
'v-model' => 'target',
|
|
),
|
|
),
|
|
'send_copy_to_admin' => array(
|
|
'type' => 'toggle',
|
|
'title' => __('Send Copy to Admins?', 'wp-ultimo'),
|
|
'desc' => __('Checking this options will add the network admins as bcc every time this email is sent to a customer.', 'wp-ultimo'),
|
|
'value' => $this->edit ? $object->get_send_copy_to_admin() : false,
|
|
'wrapper_html_attr' => array(
|
|
'v-show' => 'target == "customer"',
|
|
'v-cloak' => 1,
|
|
),
|
|
),
|
|
'schedule' => array(
|
|
'type' => 'toggle',
|
|
'title' => __('Schedule?', 'wp-ultimo'),
|
|
'desc' => __('You can define when the email is sent after the event triggers.', 'wp-ultimo'),
|
|
'value' => $this->edit ? $this->get_object()->has_schedule() : 0,
|
|
'html_attr' => array(
|
|
'v-model' => 'schedule',
|
|
),
|
|
),
|
|
'send_date' => array(
|
|
'type' => 'group',
|
|
'title' => __('Scheduling Options', 'wp-ultimo'),
|
|
'tooltip' => __('When this email will be sent after the event?', 'wp-ultimo'),
|
|
'desc' => $desc,
|
|
'desc_id' => 'send_date_desc',
|
|
'wrapper_html_attr' => array(
|
|
'v-show' => 'schedule',
|
|
'v-cloak' => 1,
|
|
),
|
|
'fields' => array(
|
|
'schedule_type' => array(
|
|
'type' => 'select',
|
|
'default' => 'days',
|
|
'wrapper_classes' => 'wu-w-2/3',
|
|
'value' => $this->edit ? $object->get_schedule_type() : 'days',
|
|
'options' => array(
|
|
'hours' => __('Delay for hours', 'wp-ultimo'),
|
|
'days' => __('Delay for days', 'wp-ultimo'),
|
|
),
|
|
'html_attr' => array(
|
|
'v-model' => 'schedule_type',
|
|
),
|
|
),
|
|
'send_days' => array(
|
|
'type' => 'number',
|
|
'value' => $this->edit && $object->get_send_days() ? $object->get_send_days() : 1,
|
|
'placeholder' => 1,
|
|
'min' => 0,
|
|
'wrapper_classes' => 'wu-ml-2 wu-w-1/3',
|
|
'wrapper_html_attr' => array(
|
|
'v-show' => "schedule_type == 'days'",
|
|
'v-cloak' => '1',
|
|
),
|
|
'html_attr' => array(
|
|
'v-model' => 'days',
|
|
),
|
|
),
|
|
'send_hours' => array(
|
|
'type' => 'text',
|
|
'date' => true,
|
|
'placeholder' => $this->edit ? $object->get_send_hours() : '12:00',
|
|
'value' => $this->edit ? $object->get_send_hours() : '',
|
|
'wrapper_classes' => 'wu-ml-2 wu-w-1/3',
|
|
'html_attr' => array(
|
|
'data-no-calendar' => 'true',
|
|
'wu-datepicker' => 'true',
|
|
'data-format' => 'H:i',
|
|
'data-allow-time' => 'true',
|
|
'v-model' => 'hours',
|
|
),
|
|
'wrapper_html_attr' => array(
|
|
'v-show' => "schedule_type == 'hours'",
|
|
'v-cloak' => '1',
|
|
),
|
|
),
|
|
),
|
|
),
|
|
|
|
),
|
|
));
|
|
|
|
add_meta_box('wp-ultimo-placeholders', __('Placeholders', 'wp-ultimo'), array($this, 'output_default_widget_placeholders'), get_current_screen()->id, 'normal', null, array());
|
|
|
|
$this->add_fields_widget('active', array(
|
|
'title' => __('Active', 'wp-ultimo'),
|
|
'fields' => array(
|
|
'active' => array(
|
|
'type' => 'toggle',
|
|
'title' => __('Active', 'wp-ultimo'),
|
|
'desc' => __('Use this option to manually enable or disable this email.', 'wp-ultimo'),
|
|
'value' => $this->get_object()->is_active(),
|
|
),
|
|
),
|
|
));
|
|
|
|
$this->add_tabs_widget('email_edit_options', array(
|
|
'title' => __('Advanced Options', 'wp-ultimo'),
|
|
'position' => 'normal',
|
|
'sections' => array(
|
|
'general' => array(
|
|
'title' => __('General', 'wp-ultimo'),
|
|
'icon' => 'dashicons-wu-lock',
|
|
'desc' => __('Rules and limitations to the applicability of this discount code.', 'wp-ultimo'),
|
|
'state' => array(
|
|
'sender' => $this->edit ? $object->get_custom_sender() : 0,
|
|
),
|
|
'fields' => array(
|
|
'style' => array(
|
|
'type' => 'select',
|
|
'title' => __('Email Style', 'wp-ultimo'),
|
|
'desc' => __('Choose if email body will be sent using the HTML template or in plain text.', 'wp-ultimo'),
|
|
'placeholder' => __('Style', 'wp-ultimo'),
|
|
'options' => array(
|
|
'default' => __('Use Default', 'wp-ultimo'),
|
|
'html' => __('HTML Emails', 'wp-ultimo'),
|
|
'plain' => __('Plain Emails', 'wp-ultimo'),
|
|
),
|
|
'value' => $this->edit ? $object->get_style() : 'html',
|
|
),
|
|
),
|
|
),
|
|
'sender' => array(
|
|
'title' => __('Custom Sender', 'wp-ultimo'),
|
|
'icon' => 'dashicons-wu-mail',
|
|
'desc' => __('You can define an email and a name that will only be used when this email is sent.', 'wp-ultimo'),
|
|
'fields' => array(
|
|
'custom_sender' => array(
|
|
'type' => 'toggle',
|
|
'title' => __('Use a custom sender?', 'wp-ultimo'),
|
|
'desc' => __('You can define an email and a name that will only be used when this email is sent.', 'wp-ultimo'),
|
|
'value' => $this->edit ? $object->get_custom_sender() : 0,
|
|
'html_attr' => array(
|
|
'v-model' => 'sender',
|
|
),
|
|
),
|
|
'custom_sender_name' => array(
|
|
'type' => 'text',
|
|
'title' => __('From "Name"', 'wp-ultimo'),
|
|
'desc' => __('Override the global from name for this particular email.', 'wp-ultimo'),
|
|
'wrapper_classes' => 'wu-full',
|
|
'value' => $this->edit ? $object->get_custom_sender_name() : '',
|
|
'wrapper_html_attr' => array(
|
|
'v-show' => 'sender',
|
|
'v-cloak' => 1,
|
|
),
|
|
),
|
|
'custom_sender_email' => array(
|
|
'type' => 'email',
|
|
'title' => __('From "Email"', 'wp-ultimo'),
|
|
'desc' => __('Override the global from email for this particular email.', 'wp-ultimo'),
|
|
'wrapper_classes' => 'wu-full',
|
|
'value' => $this->edit ? $object->get_custom_sender_email() : '',
|
|
'wrapper_html_attr' => array(
|
|
'v-show' => 'sender',
|
|
'v-cloak' => 1,
|
|
),
|
|
),
|
|
),
|
|
)
|
|
)
|
|
));
|
|
|
|
} // end register_widgets;
|
|
|
|
/**
|
|
* Outputs the block that shows the event payload placeholders.
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @param mixed $unused Not sure.
|
|
* @param array $data Arguments passed by add_meta_box.
|
|
* @return void
|
|
*/
|
|
public function output_default_widget_placeholders($unused, $data) {
|
|
|
|
wu_get_template('email/widget-placeholders', array(
|
|
'title' => __('Event Payload', 'wp-ultimo'),
|
|
'loading_text' => __('Loading Payload', 'wp-ultimo'),
|
|
));
|
|
|
|
} // end output_default_widget_placeholders;
|
|
|
|
/**
|
|
* Returns the title of the page.
|
|
*
|
|
* @since 2.0.0
|
|
* @return string Title of the page.
|
|
*/
|
|
public function get_title() {
|
|
|
|
return $this->edit ? __('Edit Email', 'wp-ultimo') : __('Add new Email', 'wp-ultimo');
|
|
|
|
} // end get_title;
|
|
|
|
/**
|
|
* Returns the title of menu for this page.
|
|
*
|
|
* @since 2.0.0
|
|
* @return string Menu label of the page.
|
|
*/
|
|
public function get_menu_title() {
|
|
|
|
return __('Edit Email', 'wp-ultimo');
|
|
|
|
} // end get_menu_title;
|
|
|
|
/**
|
|
* Returns the action links for that page.
|
|
*
|
|
* @since 1.8.2
|
|
* @return array
|
|
*/
|
|
public function action_links() {
|
|
|
|
$url_atts = array(
|
|
'id' => $this->get_object()->get_id(),
|
|
'model' => 'email',
|
|
'page' => 'edit'
|
|
);
|
|
|
|
$send_test_link = wu_get_form_url('send_new_test', $url_atts);
|
|
|
|
return array(
|
|
array(
|
|
'url' => wu_network_admin_url('wp-ultimo-emails'),
|
|
'label' => __('Go Back', 'wp-ultimo'),
|
|
'icon' => 'wu-reply',
|
|
),
|
|
array(
|
|
'url' => $send_test_link,
|
|
'label' => __('Send Test Email', 'wp-ultimo'),
|
|
'icon' => 'wu-mail',
|
|
'classes' => 'wubox'
|
|
),
|
|
);
|
|
|
|
} // end action_links;
|
|
|
|
/**
|
|
* Returns the labels to be used on the admin page.
|
|
*
|
|
* @since 2.0.0
|
|
* @return array
|
|
*/
|
|
public function get_labels() {
|
|
|
|
return array(
|
|
'edit_label' => __('Edit Email', 'wp-ultimo'),
|
|
'add_new_label' => __('Add new Email', 'wp-ultimo'),
|
|
'updated_message' => __('Email updated with success!', 'wp-ultimo'),
|
|
'title_placeholder' => __('Enter Email Subject', 'wp-ultimo'),
|
|
'title_description' => __('This will be used as the email subject line.', 'wp-ultimo'),
|
|
'save_button_label' => __('Save Email', 'wp-ultimo'),
|
|
'save_description' => '',
|
|
'delete_button_label' => __('Delete Email', 'wp-ultimo'),
|
|
'delete_description' => __('Be careful. This action is irreversible.', 'wp-ultimo'),
|
|
);
|
|
|
|
} // end get_labels;
|
|
|
|
/**
|
|
* Filters the list table to return only relevant events.
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @param array $args Query args passed to the list table.
|
|
* @return array Modified query args.
|
|
*/
|
|
public function query_filter($args) {
|
|
|
|
$extra_args = array(
|
|
'object_type' => 'system_email',
|
|
'object_id' => absint($this->get_object()->get_id()),
|
|
);
|
|
|
|
return array_merge($args, $extra_args);
|
|
|
|
} // end query_filter;
|
|
|
|
/**
|
|
* Handles the toggles.
|
|
*
|
|
* @since 2.0.0
|
|
* @return void
|
|
*/
|
|
public function handle_save() {
|
|
|
|
$_POST['schedule'] = wu_request('schedule');
|
|
|
|
$_POST['send_copy_to_admin'] = wu_request('send_copy_to_admin');
|
|
|
|
$_POST['custom_sender'] = wu_request('custom_sender');
|
|
|
|
parent::handle_save();
|
|
|
|
} // end handle_save;
|
|
|
|
/**
|
|
* Handles the redirect notice from sent new test modal.
|
|
*
|
|
* @param WP_Ultimo\Admin_Pages\Base_Admin_Page $page The page object.
|
|
* @return void
|
|
*/
|
|
public function handle_page_redirect($page) {
|
|
|
|
if ($page->get_id() === 'wp-ultimo-edit-email') {
|
|
|
|
if (wu_request('test_notice')) {
|
|
|
|
$test_notice = wu_request('test_notice');
|
|
|
|
?>
|
|
|
|
<div id="message" class="updated notice notice-success is-dismissible below-h2">
|
|
|
|
<p><?php echo esc_html($test_notice); ?></p>
|
|
|
|
</div>
|
|
|
|
<?php
|
|
|
|
} // end if;
|
|
|
|
} // end if;
|
|
|
|
} // end handle_page_redirect;
|
|
|
|
/**
|
|
* Returns the object being edit at the moment.
|
|
*
|
|
* @since 2.0.0
|
|
* @return \WP_Ultimo\Models\Email
|
|
*/
|
|
public function get_object() {
|
|
|
|
if (isset($_GET['id'])) {
|
|
|
|
$query = new \WP_Ultimo\Database\Emails\Email_Query;
|
|
|
|
$item = $query->get_item_by('id', $_GET['id']);
|
|
|
|
if (!$item) {
|
|
|
|
wp_redirect(wu_network_admin_url('wp-ultimo-emails'));
|
|
|
|
exit;
|
|
|
|
} // end if;
|
|
|
|
return $item;
|
|
|
|
} // end if;
|
|
|
|
return new Email;
|
|
|
|
} // end get_object;
|
|
/**
|
|
* Emails have titles.
|
|
*
|
|
* @since 2.0.0
|
|
*/
|
|
public function has_title(): bool {
|
|
|
|
return true;
|
|
|
|
} // end has_title;
|
|
/**
|
|
* Wether or not this pages should have an editor field.
|
|
*
|
|
* @since 2.0.0
|
|
*/
|
|
public function has_editor(): bool {
|
|
|
|
return true;
|
|
|
|
} // end has_editor;
|
|
|
|
/**
|
|
* Filters the list table to return only relevant events.
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @param array $args Query args passed to the list table.
|
|
* @return array Modified query args.
|
|
*/
|
|
public function events_query_filter($args) {
|
|
|
|
$extra_args = array(
|
|
'object_type' => 'email',
|
|
'object_id' => absint($this->get_object()->get_id()),
|
|
);
|
|
|
|
return array_merge($args, $extra_args);
|
|
|
|
} // end events_query_filter;
|
|
|
|
} // end class Email_Edit_Admin_Page;
|