Initial Commit
This commit is contained in:
David Stone
414
inc/admin-pages/class-webhook-edit-admin-page.php
Normal file
414
inc/admin-pages/class-webhook-edit-admin-page.php
Normal file
@ -0,0 +1,414 @@
|
||||
<?php
|
||||
/**
|
||||
* WP Ultimo Webhook 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\Webhook;
|
||||
|
||||
/**
|
||||
* WP Ultimo Webhook Edit/Add New Admin Page.
|
||||
*/
|
||||
class Webhook_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-webhook';
|
||||
|
||||
/**
|
||||
* 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 = 'webhook';
|
||||
|
||||
/**
|
||||
* 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-webhooks';
|
||||
|
||||
/**
|
||||
* 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_webhooks',
|
||||
);
|
||||
|
||||
/**
|
||||
* Registers the necessary scripts and styles for this admin page.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @return void
|
||||
*/
|
||||
public function register_scripts() {
|
||||
|
||||
parent::register_scripts();
|
||||
|
||||
wp_register_script('wu-webhook-page', wu_get_asset('webhook-page.js', 'js'), array('jquery', 'wu-sweet-alert'));
|
||||
|
||||
wp_localize_script('wu-webhook-page', 'wu_webhook_page', array(
|
||||
'i18n' => array(
|
||||
'error_title' => __('Webhook Test', 'wp-ultimo'),
|
||||
'error_message' => __('An error occurred when sending the test webhook, please try again.', 'wp-ultimo'),
|
||||
'copied' => __('Copied!', 'wp-ultimo'),
|
||||
),
|
||||
));
|
||||
|
||||
wp_enqueue_script('wu-webhook-page');
|
||||
|
||||
} // end register_scripts;
|
||||
|
||||
/**
|
||||
* Register ajax forms that we use for webhook.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @return void
|
||||
*/
|
||||
public function register_forms() {
|
||||
/*
|
||||
* Delete Webhook - Confirmation modal
|
||||
*/
|
||||
add_filter('wu_data_json_success_delete_webhook_modal', fn($data_json) => array(
|
||||
'redirect_url' => wu_network_admin_url('wp-ultimo-webhooks', array('deleted' => 1))
|
||||
));
|
||||
|
||||
} // end register_forms;
|
||||
|
||||
/**
|
||||
* Allow child classes to register widgets, if they need them.
|
||||
*
|
||||
* @since 1.8.2
|
||||
* @return void
|
||||
*/
|
||||
public function register_widgets() {
|
||||
|
||||
parent::register_widgets();
|
||||
|
||||
$this->add_fields_widget('domain-url', array(
|
||||
'title' => __('Webhook URL', 'wp-ultimo'),
|
||||
'position' => 'normal',
|
||||
'fields' => array(
|
||||
'webhook_url' => array(
|
||||
'type' => 'url',
|
||||
'title' => __('Webhook URL', 'wp-ultimo'),
|
||||
'desc' => __('The URL where we will send the payload when the event triggers.', 'wp-ultimo'),
|
||||
'placeholder' => __('https://example.com', 'wp-ultimo'),
|
||||
'value' => $this->get_object()->get_webhook_url(),
|
||||
),
|
||||
'actions' => array(
|
||||
'type' => 'actions',
|
||||
'tooltip' => __('The event .', 'wp-ultimo'),
|
||||
'actions' => array(
|
||||
'send_test_event' => array(
|
||||
'title' => __('Send Test Event', 'wp-ultimo'),
|
||||
'action' => 'wu_send_test_event',
|
||||
'object_id' => $this->get_object()->get_id(),
|
||||
'loading_text' => 'Sending Test...',
|
||||
),
|
||||
),
|
||||
'html_attr' => array(
|
||||
'data-page' => 'edit',
|
||||
),
|
||||
'wrapper_classes' => 'wu-items-left wu-justify-start',
|
||||
),
|
||||
),
|
||||
));
|
||||
|
||||
add_meta_box('wp-ultimo-payload', __('Event Payload', 'wp-ultimo'), array($this, 'output_default_widget_payload'), get_current_screen()->id, 'normal');
|
||||
|
||||
$this->add_list_table_widget('events', array(
|
||||
'title' => __('Events', 'wp-ultimo'),
|
||||
'table' => new \WP_Ultimo\List_Tables\Inside_Events_List_Table(),
|
||||
'query_filter' => array($this, 'query_filter'),
|
||||
));
|
||||
|
||||
$event_list = array();
|
||||
|
||||
foreach (wu_get_event_types() as $key => $value) {
|
||||
|
||||
$event_list[$key] = $value['name'];
|
||||
|
||||
} // end foreach;
|
||||
|
||||
$this->add_save_widget('save', array(
|
||||
'fields' => array(
|
||||
'event' => array(
|
||||
'type' => 'select',
|
||||
'title' => __('Event', 'wp-ultimo'),
|
||||
'desc' => __('The event that triggers this webhook.', 'wp-ultimo'),
|
||||
'placeholder' => __('Select Event', 'wp-ultimo'),
|
||||
'options' => $event_list,
|
||||
'value' => $this->get_object()->get_event(),
|
||||
),
|
||||
),
|
||||
));
|
||||
|
||||
$this->add_fields_widget('active', array(
|
||||
'title' => __('Active', 'wp-ultimo'),
|
||||
'fields' => array(
|
||||
'active' => array(
|
||||
'type' => 'toggle',
|
||||
'title' => __('Active', 'wp-ultimo'),
|
||||
'tooltip' => __('Deactivate will end the event trigger for this webhook.', 'wp-ultimo'),
|
||||
'desc' => __('Use this option to manually enable or disable this webhook.', 'wp-ultimo'),
|
||||
'value' => $this->get_object()->is_active(),
|
||||
),
|
||||
),
|
||||
));
|
||||
|
||||
$this->add_fields_widget('options', array(
|
||||
'title' => __('Options', 'wp-ultimo'),
|
||||
'fields' => array(
|
||||
'integration' => array(
|
||||
'edit' => true,
|
||||
'title' => __('Integration', 'wp-ultimo'),
|
||||
'type' => 'text-edit',
|
||||
'placeholder' => 'manual',
|
||||
'value' => $this->get_object()->get_integration(),
|
||||
'display_value' => ucwords((string) $this->get_object()->get_integration()),
|
||||
'tooltip' => __('Name of the service responsible for creating this webhook. If you are manually creating this webhook, use the value "manual".', 'wp-ultimo'),
|
||||
),
|
||||
'event_count' => array(
|
||||
'title' => __('Run Count', 'wp-ultimo'),
|
||||
'type' => 'text-edit',
|
||||
'min' => 0,
|
||||
'placeholder' => 0,
|
||||
'edit' => true,
|
||||
'value' => $this->get_object()->get_event_count(),
|
||||
// translators: %d is the number of times that this webhook was triggered.
|
||||
'display_value' => sprintf(__('This webhook was triggered %d time(s).', 'wp-ultimo'), $this->get_object()->get_event_count()),
|
||||
'tooltip' => __('The number of times that this webhook was triggered so far. It includes test runs.', 'wp-ultimo'),
|
||||
),
|
||||
),
|
||||
));
|
||||
|
||||
} // end register_widgets;
|
||||
|
||||
/**
|
||||
* Outputs the markup for the payload widget.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @return void
|
||||
*/
|
||||
public function output_default_widget_payload() {
|
||||
|
||||
$object_event_slug = $this->get_object()->get_event();
|
||||
|
||||
$event = wu_get_event_type($object_event_slug);
|
||||
|
||||
$payload = isset($event['payload']) ? json_encode(wu_maybe_lazy_load_payload($event['payload']), JSON_PRETTY_PRINT) : '{}';
|
||||
|
||||
wu_get_template('events/widget-payload', array(
|
||||
'title' => __('Event Payload', 'wp-ultimo'),
|
||||
'loading_text' => __('Loading Payload', 'wp-ultimo'),
|
||||
'payload' => $payload,
|
||||
));
|
||||
|
||||
} // end output_default_widget_payload;
|
||||
|
||||
/**
|
||||
* 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' => 'webhook',
|
||||
'object_id' => absint($this->get_object()->get_id()),
|
||||
);
|
||||
|
||||
return array_merge($args, $extra_args);
|
||||
|
||||
} // end query_filter;
|
||||
|
||||
/**
|
||||
* Returns the title of the page.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @return string Title of the page.
|
||||
*/
|
||||
public function get_title() {
|
||||
|
||||
return $this->edit ? __('Edit Webhook', 'wp-ultimo') : __('Add new Webhook', '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 Webhook', 'wp-ultimo');
|
||||
|
||||
} // end get_menu_title;
|
||||
|
||||
/**
|
||||
* Returns the action links for that page.
|
||||
*
|
||||
* @since 1.8.2
|
||||
* @return array
|
||||
*/
|
||||
public function action_links() {
|
||||
|
||||
return array();
|
||||
|
||||
} // 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 Webhook', 'wp-ultimo'),
|
||||
'add_new_label' => __('Add new Webhook', 'wp-ultimo'),
|
||||
'updated_message' => __('Webhook updated successfully!', 'wp-ultimo'),
|
||||
'title_placeholder' => __('Enter Webhook', 'wp-ultimo'),
|
||||
'title_description' => '',
|
||||
'save_button_label' => __('Save Webhook', 'wp-ultimo'),
|
||||
'save_description' => '',
|
||||
'delete_button_label' => __('Delete Webhook', 'wp-ultimo'),
|
||||
'delete_description' => __('Be careful. This action is irreversible.', 'wp-ultimo'),
|
||||
);
|
||||
|
||||
} // end get_labels;
|
||||
|
||||
/**
|
||||
* Returns the object being edit at the moment.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @return \WP_Ultimo\Models\Webhook
|
||||
*/
|
||||
public function get_object() {
|
||||
|
||||
if (wu_request('id')) {
|
||||
|
||||
$query = new \WP_Ultimo\Database\Webhooks\Webhook_Query;
|
||||
|
||||
$item = $query->get_item_by('id', wu_request('id'));
|
||||
|
||||
if (!$item) {
|
||||
|
||||
wp_redirect(wu_network_admin_url('wp-ultimo-webhooks'));
|
||||
|
||||
exit;
|
||||
|
||||
} // end if;
|
||||
|
||||
return $item;
|
||||
|
||||
} // end if;
|
||||
|
||||
return new Webhook;
|
||||
|
||||
} // end get_object;
|
||||
/**
|
||||
* Webhooks have titles.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function has_title(): bool {
|
||||
|
||||
return true;
|
||||
|
||||
} // end has_title;
|
||||
|
||||
/**
|
||||
* Handles the save of this form.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @return void
|
||||
*/
|
||||
public function handle_save() {
|
||||
|
||||
$object = $this->get_object();
|
||||
|
||||
$object->attributes($_POST);
|
||||
|
||||
if (is_wp_error($object->save())) {
|
||||
|
||||
$errors = implode('<br>', $object->save()->get_error_messages());
|
||||
|
||||
WP_Ultimo()->notices->add($errors, 'error', 'network-admin');
|
||||
|
||||
return;
|
||||
|
||||
} else {
|
||||
|
||||
$array_params = array(
|
||||
'updated' => 1,
|
||||
);
|
||||
|
||||
if ($this->edit === false) {
|
||||
|
||||
$array_params['id'] = $object->get_id();
|
||||
|
||||
} // end if;
|
||||
|
||||
$url = add_query_arg($array_params);
|
||||
|
||||
wp_redirect($url);
|
||||
|
||||
exit;
|
||||
|
||||
} // end if;
|
||||
|
||||
} // end handle_save;
|
||||
|
||||
} // end class Webhook_Edit_Admin_Page;
|
||||
Reference in New Issue
Block a user