## ✅ Template Editor + Push Notifications ### Backend (PHP) **1. TemplateProvider** (`includes/Core/Notifications/TemplateProvider.php`) - Manages notification templates in wp_options - Default templates for all events x channels - Variable system (order, product, customer, store) - Template CRUD operations - Variable replacement engine **2. PushNotificationHandler** (`includes/Core/Notifications/PushNotificationHandler.php`) - VAPID keys generation and storage - Push subscription management - Queue system for push notifications - User-specific subscriptions - Service worker integration ready **3. NotificationsController** - Extended with: - GET /notifications/templates - List all templates - GET /notifications/templates/:eventId/:channelId - Get template - POST /notifications/templates - Save template - DELETE /notifications/templates/:eventId/:channelId - Reset to default - GET /notifications/push/vapid-key - Get VAPID public key - POST /notifications/push/subscribe - Subscribe to push - POST /notifications/push/unsubscribe - Unsubscribe **4. Push channel added to built-in channels** ### Frontend (React) **1. TemplateEditor Component** (`TemplateEditor.tsx`) - Modal dialog for editing templates - Subject + Body text editors - Variable insertion with dropdown - Click-to-insert variables - Live preview - Save and reset to default - Per event + channel customization **2. Templates Page** - Completely rewritten: - Lists all events x channels - Shows "Custom" badge for customized templates - Edit button opens template editor - Fetches templates from API - Variable reference guide - Organized by channel ### Key Features ✅ **Simple Text Editor** (not HTML builder) - Subject line - Body text with variables - Variable picker - Preview mode ✅ **Variable System** - Order variables: {order_number}, {order_total}, etc. - Customer variables: {customer_name}, {customer_email}, etc. - Product variables: {product_name}, {stock_quantity}, etc. - Store variables: {store_name}, {store_url}, etc. - Click to insert at cursor position ✅ **Push Notifications Ready** - VAPID key generation - Subscription management - Queue system - PWA integration ready - Built-in channel (alongside email) ✅ **Template Management** - Default templates for all events - Per-event, per-channel customization - Reset to default functionality - Custom badge indicator ### Default Templates Included **Email:** - Order Placed, Processing, Completed, Cancelled, Refunded - Low Stock, Out of Stock - New Customer, Customer Note **Push:** - Order Placed, Processing, Completed - Low Stock Alert ### Next Steps 1. ✅ Service worker for push notifications 2. ✅ Push subscription UI in Channels page 3. ✅ Test push notifications 4. ✅ Addon integration examples --- **Ready for testing!** 🚀
277 lines
9.6 KiB
PHP
277 lines
9.6 KiB
PHP
<?php
|
|
/**
|
|
* Notification Template Provider
|
|
*
|
|
* Manages notification templates for all channels.
|
|
*
|
|
* @package WooNooW\Core\Notifications
|
|
*/
|
|
|
|
namespace WooNooW\Core\Notifications;
|
|
|
|
class TemplateProvider {
|
|
|
|
/**
|
|
* Option key for storing templates
|
|
*/
|
|
const OPTION_KEY = 'woonoow_notification_templates';
|
|
|
|
/**
|
|
* Get all templates
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function get_templates() {
|
|
$templates = get_option(self::OPTION_KEY, []);
|
|
|
|
// Merge with defaults
|
|
$defaults = self::get_default_templates();
|
|
|
|
return array_merge($defaults, $templates);
|
|
}
|
|
|
|
/**
|
|
* Get template for specific event and channel
|
|
*
|
|
* @param string $event_id Event ID
|
|
* @param string $channel_id Channel ID
|
|
* @return array|null
|
|
*/
|
|
public static function get_template($event_id, $channel_id) {
|
|
$templates = self::get_templates();
|
|
|
|
$key = "{$event_id}_{$channel_id}";
|
|
|
|
if (isset($templates[$key])) {
|
|
return $templates[$key];
|
|
}
|
|
|
|
// Return default if exists
|
|
$defaults = self::get_default_templates();
|
|
return $defaults[$key] ?? null;
|
|
}
|
|
|
|
/**
|
|
* Save template
|
|
*
|
|
* @param string $event_id Event ID
|
|
* @param string $channel_id Channel ID
|
|
* @param array $template Template data
|
|
* @return bool
|
|
*/
|
|
public static function save_template($event_id, $channel_id, $template) {
|
|
$templates = get_option(self::OPTION_KEY, []);
|
|
|
|
$key = "{$event_id}_{$channel_id}";
|
|
|
|
$templates[$key] = [
|
|
'event_id' => $event_id,
|
|
'channel_id' => $channel_id,
|
|
'subject' => $template['subject'] ?? '',
|
|
'body' => $template['body'] ?? '',
|
|
'variables' => $template['variables'] ?? [],
|
|
'updated_at' => current_time('mysql'),
|
|
];
|
|
|
|
return update_option(self::OPTION_KEY, $templates);
|
|
}
|
|
|
|
/**
|
|
* Delete template (revert to default)
|
|
*
|
|
* @param string $event_id Event ID
|
|
* @param string $channel_id Channel ID
|
|
* @return bool
|
|
*/
|
|
public static function delete_template($event_id, $channel_id) {
|
|
$templates = get_option(self::OPTION_KEY, []);
|
|
|
|
$key = "{$event_id}_{$channel_id}";
|
|
|
|
if (isset($templates[$key])) {
|
|
unset($templates[$key]);
|
|
return update_option(self::OPTION_KEY, $templates);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Get default templates
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function get_default_templates() {
|
|
return [
|
|
// Email templates
|
|
'order_placed_email' => [
|
|
'event_id' => 'order_placed',
|
|
'channel_id' => 'email',
|
|
'subject' => __('New Order #{order_number}', 'woonoow'),
|
|
'body' => __("Hi Admin,\n\nYou have received a new order.\n\nOrder Number: {order_number}\nOrder Total: {order_total}\nCustomer: {customer_name}\nEmail: {customer_email}\n\nView order: {order_url}", 'woonoow'),
|
|
'variables' => self::get_order_variables(),
|
|
],
|
|
'order_processing_email' => [
|
|
'event_id' => 'order_processing',
|
|
'channel_id' => 'email',
|
|
'subject' => __('Your order #{order_number} is being processed', 'woonoow'),
|
|
'body' => __("Hi {customer_name},\n\nThank you for your order! We're now processing it.\n\nOrder Number: {order_number}\nOrder Total: {order_total}\nPayment Method: {payment_method}\n\nYou can track your order here: {order_url}\n\nBest regards,\n{store_name}", 'woonoow'),
|
|
'variables' => self::get_order_variables(),
|
|
],
|
|
'order_completed_email' => [
|
|
'event_id' => 'order_completed',
|
|
'channel_id' => 'email',
|
|
'subject' => __('Your order #{order_number} is complete', 'woonoow'),
|
|
'body' => __("Hi {customer_name},\n\nYour order has been completed and shipped!\n\nOrder Number: {order_number}\nOrder Total: {order_total}\nTracking Number: {tracking_number}\n\nThank you for shopping with us!\n\nBest regards,\n{store_name}", 'woonoow'),
|
|
'variables' => self::get_order_variables(),
|
|
],
|
|
'order_cancelled_email' => [
|
|
'event_id' => 'order_cancelled',
|
|
'channel_id' => 'email',
|
|
'subject' => __('Order #{order_number} has been cancelled', 'woonoow'),
|
|
'body' => __("Hi Admin,\n\nOrder #{order_number} has been cancelled.\n\nOrder Number: {order_number}\nOrder Total: {order_total}\nCustomer: {customer_name}\n\nView order: {order_url}", 'woonoow'),
|
|
'variables' => self::get_order_variables(),
|
|
],
|
|
'order_refunded_email' => [
|
|
'event_id' => 'order_refunded',
|
|
'channel_id' => 'email',
|
|
'subject' => __('Your order #{order_number} has been refunded', 'woonoow'),
|
|
'body' => __("Hi {customer_name},\n\nYour order has been refunded.\n\nOrder Number: {order_number}\nRefund Amount: {refund_amount}\n\nThe refund will be processed within 5-7 business days.\n\nBest regards,\n{store_name}", 'woonoow'),
|
|
'variables' => self::get_order_variables(),
|
|
],
|
|
'low_stock_email' => [
|
|
'event_id' => 'low_stock',
|
|
'channel_id' => 'email',
|
|
'subject' => __('Low Stock Alert: {product_name}', 'woonoow'),
|
|
'body' => __("Hi Admin,\n\nThe following product is running low on stock:\n\nProduct: {product_name}\nSKU: {product_sku}\nCurrent Stock: {stock_quantity}\n\nPlease restock soon.\n\nView product: {product_url}", 'woonoow'),
|
|
'variables' => self::get_product_variables(),
|
|
],
|
|
'out_of_stock_email' => [
|
|
'event_id' => 'out_of_stock',
|
|
'channel_id' => 'email',
|
|
'subject' => __('Out of Stock Alert: {product_name}', 'woonoow'),
|
|
'body' => __("Hi Admin,\n\nThe following product is now out of stock:\n\nProduct: {product_name}\nSKU: {product_sku}\n\nPlease restock immediately.\n\nView product: {product_url}", 'woonoow'),
|
|
'variables' => self::get_product_variables(),
|
|
],
|
|
'new_customer_email' => [
|
|
'event_id' => 'new_customer',
|
|
'channel_id' => 'email',
|
|
'subject' => __('Welcome to {store_name}!', 'woonoow'),
|
|
'body' => __("Hi {customer_name},\n\nWelcome to {store_name}!\n\nYour account has been created successfully.\n\nEmail: {customer_email}\n\nYou can now browse our products and place orders.\n\nVisit our store: {store_url}\n\nBest regards,\n{store_name}", 'woonoow'),
|
|
'variables' => self::get_customer_variables(),
|
|
],
|
|
'customer_note_email' => [
|
|
'event_id' => 'customer_note',
|
|
'channel_id' => 'email',
|
|
'subject' => __('Note added to your order #{order_number}', 'woonoow'),
|
|
'body' => __("Hi {customer_name},\n\nA note has been added to your order:\n\nOrder Number: {order_number}\nNote: {note_content}\n\nView order: {order_url}\n\nBest regards,\n{store_name}", 'woonoow'),
|
|
'variables' => self::get_order_variables(),
|
|
],
|
|
|
|
// Push notification templates
|
|
'order_placed_push' => [
|
|
'event_id' => 'order_placed',
|
|
'channel_id' => 'push',
|
|
'subject' => __('New Order #{order_number}', 'woonoow'),
|
|
'body' => __('New order from {customer_name} - {order_total}', 'woonoow'),
|
|
'variables' => self::get_order_variables(),
|
|
],
|
|
'order_processing_push' => [
|
|
'event_id' => 'order_processing',
|
|
'channel_id' => 'push',
|
|
'subject' => __('Order Processing', 'woonoow'),
|
|
'body' => __('Your order #{order_number} is being processed', 'woonoow'),
|
|
'variables' => self::get_order_variables(),
|
|
],
|
|
'order_completed_push' => [
|
|
'event_id' => 'order_completed',
|
|
'channel_id' => 'push',
|
|
'subject' => __('Order Completed', 'woonoow'),
|
|
'body' => __('Your order #{order_number} has been completed!', 'woonoow'),
|
|
'variables' => self::get_order_variables(),
|
|
],
|
|
'low_stock_push' => [
|
|
'event_id' => 'low_stock',
|
|
'channel_id' => 'push',
|
|
'subject' => __('Low Stock Alert', 'woonoow'),
|
|
'body' => __('{product_name} is running low on stock', 'woonoow'),
|
|
'variables' => self::get_product_variables(),
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Get available order variables
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function get_order_variables() {
|
|
return [
|
|
'order_number' => __('Order Number', 'woonoow'),
|
|
'order_total' => __('Order Total', 'woonoow'),
|
|
'order_status' => __('Order Status', 'woonoow'),
|
|
'order_date' => __('Order Date', 'woonoow'),
|
|
'order_url' => __('Order URL', 'woonoow'),
|
|
'payment_method' => __('Payment Method', 'woonoow'),
|
|
'shipping_method' => __('Shipping Method', 'woonoow'),
|
|
'tracking_number' => __('Tracking Number', 'woonoow'),
|
|
'refund_amount' => __('Refund Amount', 'woonoow'),
|
|
'customer_name' => __('Customer Name', 'woonoow'),
|
|
'customer_email' => __('Customer Email', 'woonoow'),
|
|
'customer_phone' => __('Customer Phone', 'woonoow'),
|
|
'billing_address' => __('Billing Address', 'woonoow'),
|
|
'shipping_address' => __('Shipping Address', 'woonoow'),
|
|
'store_name' => __('Store Name', 'woonoow'),
|
|
'store_url' => __('Store URL', 'woonoow'),
|
|
'store_email' => __('Store Email', 'woonoow'),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Get available product variables
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function get_product_variables() {
|
|
return [
|
|
'product_name' => __('Product Name', 'woonoow'),
|
|
'product_sku' => __('Product SKU', 'woonoow'),
|
|
'product_url' => __('Product URL', 'woonoow'),
|
|
'stock_quantity' => __('Stock Quantity', 'woonoow'),
|
|
'store_name' => __('Store Name', 'woonoow'),
|
|
'store_url' => __('Store URL', 'woonoow'),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Get available customer variables
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function get_customer_variables() {
|
|
return [
|
|
'customer_name' => __('Customer Name', 'woonoow'),
|
|
'customer_email' => __('Customer Email', 'woonoow'),
|
|
'customer_phone' => __('Customer Phone', 'woonoow'),
|
|
'store_name' => __('Store Name', 'woonoow'),
|
|
'store_url' => __('Store URL', 'woonoow'),
|
|
'store_email' => __('Store Email', 'woonoow'),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Replace variables in template
|
|
*
|
|
* @param string $content Content with variables
|
|
* @param array $data Data to replace variables
|
|
* @return string
|
|
*/
|
|
public static function replace_variables($content, $data) {
|
|
foreach ($data as $key => $value) {
|
|
$content = str_replace('{' . $key . '}', $value, $content);
|
|
}
|
|
|
|
return $content;
|
|
}
|
|
}
|