eventespresso / event-espresso-core

core/domain/services/admin/AdminToolBar.php

Indentation +818 added lines, -818 removed lines

@@ -20,822 +20,822 @@
  */
 class AdminToolBar
 {
-    private ?WP_Admin_Bar   $admin_bar        = null;
-
-    private EE_Capabilities $capabilities;
-
-    private string          $events_admin_url = '';
-
-    private string          $menu_class       = 'espresso_menu_item_class';
-
-    private string          $reg_admin_url    = '';
-
-
-    /**
-     * AdminToolBar constructor.
-     *
-     * @param EE_Capabilities $capabilities
-     */
-    public function __construct(EE_Capabilities $capabilities)
-    {
-        $this->capabilities = $capabilities;
-        add_action('admin_bar_menu', [$this, 'espressoToolbarItems'], 100);
-        $this->enqueueAssets();
-    }
-
-
-    /**
-     *    espresso_toolbar_items
-     *
-     * @access public
-     * @param WP_Admin_Bar $admin_bar
-     * @return void
-     */
-    public function espressoToolbarItems(WP_Admin_Bar $admin_bar)
-    {
-        // if its an AJAX request, or user is NOT an admin, or in full M-Mode
-        if (
-            defined('DOING_AJAX')
-            || ! $this->capabilities->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
-            || EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
-        ) {
-            return;
-        }
-        $this->admin_bar = $admin_bar;
-        // we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
-        // because they're only defined in each of their respective constructors
-        // and this might be a frontend request, in which case they aren't available
-        $this->events_admin_url = admin_url('admin.php?page=espresso_events');
-        $this->reg_admin_url    = admin_url('admin.php?page=espresso_registrations');
-        // now let's add all of the menu items
-        $this->addTopLevelMenu();
-        $this->addEventsSubMenu();
-        $this->addEventsAddEditHeader();
-        $this->addEventsAddNew();
-        $this->addEventsEditCurrentEvent();
-        $this->addEventsViewHeader();
-        $this->addEventsViewAll();
-        $this->addEventsViewToday();
-        $this->addEventsViewThisMonth();
-        $this->addRegistrationSubMenu();
-        $this->addRegistrationOverviewToday();
-        $this->addRegistrationOverviewTodayApproved();
-        $this->addRegistrationOverviewTodayPendingPayment();
-        $this->addRegistrationOverviewTodayNotApproved();
-        $this->addRegistrationOverviewTodayCancelled();
-        $this->addRegistrationOverviewThisMonth();
-        $this->addRegistrationOverviewThisMonthApproved();
-        $this->addRegistrationOverviewThisMonthPending();
-        $this->addRegistrationOverviewThisMonthNotApproved();
-        $this->addRegistrationOverviewThisMonthCancelled();
-        $this->addExtensionsAndServices();
-        $this->addFontSizeSubMenu();
-    }
-
-
-    /**
-     * @return void
-     */
-    private function enqueueAssets()
-    {
-        wp_register_style(
-            'espresso-admin-toolbar',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
-            ['dashicons'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso-admin-toolbar');
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addTopLevelMenu()
-    {
-        $this->admin_bar->add_menu(
-            [
-                'id'    => 'espresso-toolbar',
-                'title' => '<span class="ab-icon ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
-                           . esc_html_x('Event Espresso', 'admin bar menu group label', 'event_espresso')
-                           . '</span>',
-                'href'  => $this->events_admin_url,
-                'meta'  => [
-                    'title' => esc_html__('Event Espresso', 'event_espresso'),
-                    'class' => $this->menu_class . 'first',
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsSubMenu()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-events',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Events', 'event_espresso'),
-                    'href'   => $this->events_admin_url,
-                    'meta'   => [
-                        'title'  => esc_html__('Events', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsAddEditHeader()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-view'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-events-add-edit',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => esc_html__('Add / Edit', 'event_espresso'),
-                    'href'   => '',
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsAddNew()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_edit_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-new'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-events-new',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Add New', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        ['action' => 'create_new'],
-                        $this->events_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Add New', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsEditCurrentEvent()
-    {
-        if (is_single() && (get_post_type() === 'espresso_events')) {
-            // Current post
-            global $post;
-            if (
-                $this->capabilities->current_user_can(
-                    'ee_edit_event',
-                    'ee_admin_bar_menu_espresso-toolbar-events-edit',
-                    $post->ID
-                )
-            ) {
-                $this->admin_bar->add_menu(
-                    [
-                        'id'     => 'espresso-toolbar-events-edit',
-                        'parent' => 'espresso-toolbar-events',
-                        'title'  => '<span class="ee-toolbar-icon"></span>'
-                                    . esc_html__('Edit Event', 'event_espresso'),
-                        'href'   => EEH_URL::add_query_args_and_nonce(
-                            [
-                                'action' => 'edit',
-                                'post'   => $post->ID,
-                            ],
-                            $this->events_admin_url
-                        ),
-                        'meta'   => [
-                            'title'  => esc_html__('Edit Event', 'event_espresso'),
-                            'target' => '',
-                            'class'  => $this->menu_class,
-                        ],
-                    ]
-                );
-            }
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewHeader()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-view'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-events-view',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => esc_html__('View', 'event_espresso'),
-                    'href'   => '',
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewAll()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-all'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-events-all',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('All', 'event_espresso'),
-                    'href'   => $this->events_admin_url,
-                    'meta'   => [
-                        'title'  => esc_html__('All', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewToday()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-today'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-events-today',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Today', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action' => 'default',
-                            'status' => 'today',
-                        ],
-                        $this->events_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Today', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewThisMonth()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-month'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-events-month',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('This Month', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action' => 'default',
-                            'status' => 'month',
-                        ],
-                        $this->events_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('This Month', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationSubMenu()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Registrations', 'event_espresso'),
-                    'href'   => $this->reg_admin_url,
-                    'meta'   => [
-                        'title'  => esc_html__('Registrations', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewToday()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-today'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-today',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => esc_html__('Today', 'event_espresso'),
-                    'href'   => '',
-                    'meta'   => [
-                        'title'  => esc_html__('Today', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayApproved()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-today-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_approved,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayPendingPayment()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-today-pending',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Pending', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_pending_payment,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Pending Payment', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayNotApproved()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-today-not-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Not Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_not_approved,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Not Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayCancelled()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-today-cancelled',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Cancelled', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_cancelled,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Cancelled', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonth()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-month'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-month',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => esc_html__('This Month', 'event_espresso'),
-                    'href'   => '', // EEH_URL::add_query_args_and_nonce(
-                    //     array(
-                    //         'action' => 'default',
-                    //         'status' => 'month'
-                    //     ),
-                    //     $this->reg_admin_url
-                    // ),
-                    'meta'   => [
-                        'title'  => esc_html__('This Month', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthApproved()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-month-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_approved,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthPending()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-month-pending',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Pending', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_pending_payment,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Pending', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthNotApproved()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-month-not-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Not Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_not_approved,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Not Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthCancelled()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-month-cancelled',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Cancelled', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_cancelled,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Cancelled', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addExtensionsAndServices()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_ee',
-                'ee_admin_bar_menu_espresso-toolbar-extensions-and-services'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-extensions-and-services',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Extensions & Services', 'event_espresso'),
-                    'href'   => admin_url('admin.php?page=espresso_packages'),
-                    'meta'   => [
-                        'title'  => esc_html__('Extensions & Services', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addFontSizeSubMenu()
-    {
-        $this->admin_bar->add_menu(
-            [
-                'id'     => 'espresso-toolbar-font-size',
-                'parent' => 'espresso-toolbar',
-                'title'  => '<span class="ee-toolbar-icon"></span>'
-                            . esc_html__('Set Font Size', 'event_espresso'),
-                'href'   => '',
-                'meta'   => [
-                    'title'  => esc_html__('Set Font Size', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $this->menu_class,
-                ],
-            ]
-        );
-
-        $settings_admin_url = admin_url('admin.php?page=espresso_general_settings');
-
-        $font_sizes = [
-            'tiny'    => AdminFontSize::FONT_SIZE_TINY,
-            'smaller' => AdminFontSize::FONT_SIZE_SMALLER,
-            'small'   => AdminFontSize::FONT_SIZE_SMALL,
-            'default' => AdminFontSize::FONT_SIZE_DEFAULT,
-            'big'     => AdminFontSize::FONT_SIZE_BIG,
-            'bigger'  => AdminFontSize::FONT_SIZE_BIGGER,
-        ];
-
-        foreach ($font_sizes as $font_size => $value) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => "espresso-toolbar-set-font-size-$font_size",
-                    'parent' => 'espresso-toolbar-font-size',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . sprintf(
-                                    /* translators: Font Size Small */
-                                    esc_html__('Font Size %1$s', 'event_espresso'),
-                                    ucwords($font_size)
-                                ),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        ['action' => 'set_font_size', 'font_size' => $value],
-                        $settings_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('increases or decreases the Event Espresso admin font size', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
+	private ?WP_Admin_Bar   $admin_bar        = null;
+
+	private EE_Capabilities $capabilities;
+
+	private string          $events_admin_url = '';
+
+	private string          $menu_class       = 'espresso_menu_item_class';
+
+	private string          $reg_admin_url    = '';
+
+
+	/**
+	 * AdminToolBar constructor.
+	 *
+	 * @param EE_Capabilities $capabilities
+	 */
+	public function __construct(EE_Capabilities $capabilities)
+	{
+		$this->capabilities = $capabilities;
+		add_action('admin_bar_menu', [$this, 'espressoToolbarItems'], 100);
+		$this->enqueueAssets();
+	}
+
+
+	/**
+	 *    espresso_toolbar_items
+	 *
+	 * @access public
+	 * @param WP_Admin_Bar $admin_bar
+	 * @return void
+	 */
+	public function espressoToolbarItems(WP_Admin_Bar $admin_bar)
+	{
+		// if its an AJAX request, or user is NOT an admin, or in full M-Mode
+		if (
+			defined('DOING_AJAX')
+			|| ! $this->capabilities->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
+			|| EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
+		) {
+			return;
+		}
+		$this->admin_bar = $admin_bar;
+		// we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
+		// because they're only defined in each of their respective constructors
+		// and this might be a frontend request, in which case they aren't available
+		$this->events_admin_url = admin_url('admin.php?page=espresso_events');
+		$this->reg_admin_url    = admin_url('admin.php?page=espresso_registrations');
+		// now let's add all of the menu items
+		$this->addTopLevelMenu();
+		$this->addEventsSubMenu();
+		$this->addEventsAddEditHeader();
+		$this->addEventsAddNew();
+		$this->addEventsEditCurrentEvent();
+		$this->addEventsViewHeader();
+		$this->addEventsViewAll();
+		$this->addEventsViewToday();
+		$this->addEventsViewThisMonth();
+		$this->addRegistrationSubMenu();
+		$this->addRegistrationOverviewToday();
+		$this->addRegistrationOverviewTodayApproved();
+		$this->addRegistrationOverviewTodayPendingPayment();
+		$this->addRegistrationOverviewTodayNotApproved();
+		$this->addRegistrationOverviewTodayCancelled();
+		$this->addRegistrationOverviewThisMonth();
+		$this->addRegistrationOverviewThisMonthApproved();
+		$this->addRegistrationOverviewThisMonthPending();
+		$this->addRegistrationOverviewThisMonthNotApproved();
+		$this->addRegistrationOverviewThisMonthCancelled();
+		$this->addExtensionsAndServices();
+		$this->addFontSizeSubMenu();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function enqueueAssets()
+	{
+		wp_register_style(
+			'espresso-admin-toolbar',
+			EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
+			['dashicons'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso-admin-toolbar');
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addTopLevelMenu()
+	{
+		$this->admin_bar->add_menu(
+			[
+				'id'    => 'espresso-toolbar',
+				'title' => '<span class="ab-icon ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
+						   . esc_html_x('Event Espresso', 'admin bar menu group label', 'event_espresso')
+						   . '</span>',
+				'href'  => $this->events_admin_url,
+				'meta'  => [
+					'title' => esc_html__('Event Espresso', 'event_espresso'),
+					'class' => $this->menu_class . 'first',
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsSubMenu()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-events',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Events', 'event_espresso'),
+					'href'   => $this->events_admin_url,
+					'meta'   => [
+						'title'  => esc_html__('Events', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsAddEditHeader()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-view'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-events-add-edit',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => esc_html__('Add / Edit', 'event_espresso'),
+					'href'   => '',
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsAddNew()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_edit_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-new'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-events-new',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Add New', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						['action' => 'create_new'],
+						$this->events_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Add New', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsEditCurrentEvent()
+	{
+		if (is_single() && (get_post_type() === 'espresso_events')) {
+			// Current post
+			global $post;
+			if (
+				$this->capabilities->current_user_can(
+					'ee_edit_event',
+					'ee_admin_bar_menu_espresso-toolbar-events-edit',
+					$post->ID
+				)
+			) {
+				$this->admin_bar->add_menu(
+					[
+						'id'     => 'espresso-toolbar-events-edit',
+						'parent' => 'espresso-toolbar-events',
+						'title'  => '<span class="ee-toolbar-icon"></span>'
+									. esc_html__('Edit Event', 'event_espresso'),
+						'href'   => EEH_URL::add_query_args_and_nonce(
+							[
+								'action' => 'edit',
+								'post'   => $post->ID,
+							],
+							$this->events_admin_url
+						),
+						'meta'   => [
+							'title'  => esc_html__('Edit Event', 'event_espresso'),
+							'target' => '',
+							'class'  => $this->menu_class,
+						],
+					]
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewHeader()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-view'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-events-view',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => esc_html__('View', 'event_espresso'),
+					'href'   => '',
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewAll()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-all'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-events-all',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('All', 'event_espresso'),
+					'href'   => $this->events_admin_url,
+					'meta'   => [
+						'title'  => esc_html__('All', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewToday()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-today'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-events-today',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Today', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action' => 'default',
+							'status' => 'today',
+						],
+						$this->events_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Today', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewThisMonth()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-month'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-events-month',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('This Month', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action' => 'default',
+							'status' => 'month',
+						],
+						$this->events_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('This Month', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationSubMenu()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Registrations', 'event_espresso'),
+					'href'   => $this->reg_admin_url,
+					'meta'   => [
+						'title'  => esc_html__('Registrations', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewToday()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-today'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-today',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => esc_html__('Today', 'event_espresso'),
+					'href'   => '',
+					'meta'   => [
+						'title'  => esc_html__('Today', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayApproved()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-today-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_approved,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayPendingPayment()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-today-pending',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Pending', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_pending_payment,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Pending Payment', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayNotApproved()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-today-not-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Not Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_not_approved,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Not Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayCancelled()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-today-cancelled',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Cancelled', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_cancelled,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Cancelled', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonth()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-month'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-month',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => esc_html__('This Month', 'event_espresso'),
+					'href'   => '', // EEH_URL::add_query_args_and_nonce(
+					//     array(
+					//         'action' => 'default',
+					//         'status' => 'month'
+					//     ),
+					//     $this->reg_admin_url
+					// ),
+					'meta'   => [
+						'title'  => esc_html__('This Month', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthApproved()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-month-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_approved,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthPending()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-month-pending',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Pending', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_pending_payment,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Pending', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthNotApproved()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-month-not-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Not Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_not_approved,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Not Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthCancelled()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-month-cancelled',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Cancelled', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_cancelled,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Cancelled', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addExtensionsAndServices()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_ee',
+				'ee_admin_bar_menu_espresso-toolbar-extensions-and-services'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-extensions-and-services',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Extensions & Services', 'event_espresso'),
+					'href'   => admin_url('admin.php?page=espresso_packages'),
+					'meta'   => [
+						'title'  => esc_html__('Extensions & Services', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addFontSizeSubMenu()
+	{
+		$this->admin_bar->add_menu(
+			[
+				'id'     => 'espresso-toolbar-font-size',
+				'parent' => 'espresso-toolbar',
+				'title'  => '<span class="ee-toolbar-icon"></span>'
+							. esc_html__('Set Font Size', 'event_espresso'),
+				'href'   => '',
+				'meta'   => [
+					'title'  => esc_html__('Set Font Size', 'event_espresso'),
+					'target' => '',
+					'class'  => $this->menu_class,
+				],
+			]
+		);
+
+		$settings_admin_url = admin_url('admin.php?page=espresso_general_settings');
+
+		$font_sizes = [
+			'tiny'    => AdminFontSize::FONT_SIZE_TINY,
+			'smaller' => AdminFontSize::FONT_SIZE_SMALLER,
+			'small'   => AdminFontSize::FONT_SIZE_SMALL,
+			'default' => AdminFontSize::FONT_SIZE_DEFAULT,
+			'big'     => AdminFontSize::FONT_SIZE_BIG,
+			'bigger'  => AdminFontSize::FONT_SIZE_BIGGER,
+		];
+
+		foreach ($font_sizes as $font_size => $value) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => "espresso-toolbar-set-font-size-$font_size",
+					'parent' => 'espresso-toolbar-font-size',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. sprintf(
+									/* translators: Font Size Small */
+									esc_html__('Font Size %1$s', 'event_espresso'),
+									ucwords($font_size)
+								),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						['action' => 'set_font_size', 'font_size' => $value],
+						$settings_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('increases or decreases the Event Espresso admin font size', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
 }

core/domain/services/graphql/mutators/DatetimeUpdate.php

Indentation +51 added lines, -51 removed lines

@@ -14,61 +14,61 @@
 
 class DatetimeUpdate extends EntityMutator
 {
-    /**
-     * Defines the mutation data modification closure.
-     *
-     * @param EEM_Datetime $model
-     * @param Datetime     $type
-     * @return callable
-     */
-    public static function mutateAndGetPayload(EEM_Datetime $model, Datetime $type)
-    {
-        /**
-         * Updates an entity.
-         *
-         * @param array       $input   The input for the mutation
-         * @param AppContext  $context The AppContext passed down to all resolvers
-         * @param ResolveInfo $info    The ResolveInfo passed down to all resolvers
-         * @return array
-         * @throws EE_Error
-         * @throws ReflectionException
-         */
-        return static function (array $input, AppContext $context, ResolveInfo $info) use ($model, $type): array {
-            try {
-                /** @var EE_Datetime $entity */
-                $entity = EntityMutator::getEntityFromInputData($model, $input);
-                $args = DatetimeMutation::prepareFields($input);
+	/**
+	 * Defines the mutation data modification closure.
+	 *
+	 * @param EEM_Datetime $model
+	 * @param Datetime     $type
+	 * @return callable
+	 */
+	public static function mutateAndGetPayload(EEM_Datetime $model, Datetime $type)
+	{
+		/**
+		 * Updates an entity.
+		 *
+		 * @param array       $input   The input for the mutation
+		 * @param AppContext  $context The AppContext passed down to all resolvers
+		 * @param ResolveInfo $info    The ResolveInfo passed down to all resolvers
+		 * @return array
+		 * @throws EE_Error
+		 * @throws ReflectionException
+		 */
+		return static function (array $input, AppContext $context, ResolveInfo $info) use ($model, $type): array {
+			try {
+				/** @var EE_Datetime $entity */
+				$entity = EntityMutator::getEntityFromInputData($model, $input);
+				$args = DatetimeMutation::prepareFields($input);
 
-                // extract tickets and venue from args then unset them
-                $tickets = $args['tickets'] ?? null;
-                $venue   = $args['venue'] ?? null;
-                unset($args['tickets'], $args['venue']);
+				// extract tickets and venue from args then unset them
+				$tickets = $args['tickets'] ?? null;
+				$venue   = $args['venue'] ?? null;
+				unset($args['tickets'], $args['venue']);
 
-                // Update the entity
-                $entity->save($args);
+				// Update the entity
+				$entity->save($args);
 
-                if ($tickets) {
-                    DatetimeMutation::setRelatedTickets($entity, $tickets);
-                }
+				if ($tickets) {
+					DatetimeMutation::setRelatedTickets($entity, $tickets);
+				}
 
-                if ($venue) {
-                    DatetimeMutation::setVenue($entity, $venue);
-                }
+				if ($venue) {
+					DatetimeMutation::setVenue($entity, $venue);
+				}
 
-                do_action('AHEE__EventEspresso_core_domain_services_graphql_mutators_datetime_update', $entity, $input);
-            } catch (Exception $exception) {
-                EntityMutator::handleExceptions(
-                    $exception,
-                    esc_html__(
-                        'The datetime could not be updated because of the following error(s)',
-                        'event_espresso'
-                    )
-                );
-            }
+				do_action('AHEE__EventEspresso_core_domain_services_graphql_mutators_datetime_update', $entity, $input);
+			} catch (Exception $exception) {
+				EntityMutator::handleExceptions(
+					$exception,
+					esc_html__(
+						'The datetime could not be updated because of the following error(s)',
+						'event_espresso'
+					)
+				);
+			}
 
-            return [
-                'id' => $entity->ID(),
-            ];
-        };
-    }
+			return [
+				'id' => $entity->ID(),
+			];
+		};
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
          * @throws EE_Error
          * @throws ReflectionException
          */
-        return static function (array $input, AppContext $context, ResolveInfo $info) use ($model, $type): array {
+        return static function(array $input, AppContext $context, ResolveInfo $info) use ($model, $type): array {
             try {
                 /** @var EE_Datetime $entity */
                 $entity = EntityMutator::getEntityFromInputData($model, $input);

core/domain/services/graphql/mutators/DatetimeCreate.php

Indentation +48 added lines, -48 removed lines

@@ -12,58 +12,58 @@
 
 class DatetimeCreate extends EntityMutator
 {
-    /**
-     * Defines the mutation data modification closure.
-     *
-     * @param EEM_Datetime $model
-     * @param Datetime     $type
-     * @return callable
-     */
-    public static function mutateAndGetPayload(EEM_Datetime $model, Datetime $type)
-    {
-        /**
-         * Creates an entity.
-         *
-         * @param array       $input   The input for the mutation
-         * @param AppContext  $context The AppContext passed down to all resolvers
-         * @param ResolveInfo $info    The ResolveInfo passed down to all resolvers
-         * @return array
-         */
-        return static function (array $input, AppContext $context, ResolveInfo $info) use ($model, $type): array {
-            $id = null;
-            try {
-                EntityMutator::checkPermissions($model);
-                $args = DatetimeMutation::prepareFields($input);
+	/**
+	 * Defines the mutation data modification closure.
+	 *
+	 * @param EEM_Datetime $model
+	 * @param Datetime     $type
+	 * @return callable
+	 */
+	public static function mutateAndGetPayload(EEM_Datetime $model, Datetime $type)
+	{
+		/**
+		 * Creates an entity.
+		 *
+		 * @param array       $input   The input for the mutation
+		 * @param AppContext  $context The AppContext passed down to all resolvers
+		 * @param ResolveInfo $info    The ResolveInfo passed down to all resolvers
+		 * @return array
+		 */
+		return static function (array $input, AppContext $context, ResolveInfo $info) use ($model, $type): array {
+			$id = null;
+			try {
+				EntityMutator::checkPermissions($model);
+				$args = DatetimeMutation::prepareFields($input);
 
-                // extract tickets and venue from args then unset them
-                $tickets = $args['tickets'] ?? null;
-                $venue   = $args['venue'] ?? null;
-                unset($args['tickets'], $args['venue']);
+				// extract tickets and venue from args then unset them
+				$tickets = $args['tickets'] ?? null;
+				$venue   = $args['venue'] ?? null;
+				unset($args['tickets'], $args['venue']);
 
-                $entity = EE_Datetime::new_instance($args);
-                $id = $entity->save();
-                EntityMutator::validateResults($id);
+				$entity = EE_Datetime::new_instance($args);
+				$id = $entity->save();
+				EntityMutator::validateResults($id);
 
-                if ($tickets) {
-                    DatetimeMutation::setRelatedTickets($entity, $tickets);
-                }
+				if ($tickets) {
+					DatetimeMutation::setRelatedTickets($entity, $tickets);
+				}
 
-                if ($venue) {
-                    DatetimeMutation::setVenue($entity, $venue);
-                }
+				if ($venue) {
+					DatetimeMutation::setVenue($entity, $venue);
+				}
 
-                do_action('AHEE__EventEspresso_core_domain_services_graphql_mutators_datetime_create', $entity, $input);
-            } catch (Exception $exception) {
-                EntityMutator::handleExceptions(
-                    $exception,
-                    esc_html__(
-                        'The datetime could not be created because of the following error(s)',
-                        'event_espresso'
-                    )
-                );
-            }
+				do_action('AHEE__EventEspresso_core_domain_services_graphql_mutators_datetime_create', $entity, $input);
+			} catch (Exception $exception) {
+				EntityMutator::handleExceptions(
+					$exception,
+					esc_html__(
+						'The datetime could not be created because of the following error(s)',
+						'event_espresso'
+					)
+				);
+			}
 
-            return $id ? [ 'id' => $id ] : [];
-        };
-    }
+			return $id ? [ 'id' => $id ] : [];
+		};
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
          * @param ResolveInfo $info    The ResolveInfo passed down to all resolvers
          * @return array
          */
-        return static function (array $input, AppContext $context, ResolveInfo $info) use ($model, $type): array {
+        return static function(array $input, AppContext $context, ResolveInfo $info) use ($model, $type): array {
             $id = null;
             try {
                 EntityMutator::checkPermissions($model);
@@ -63,7 +63,7 @@ 
                 );
             }
 
-            return $id ? [ 'id' => $id ] : [];
+            return $id ? ['id' => $id] : [];
         };
     }
 }

core/domain/services/graphql/data/mutations/DatetimeMutation.php

Indentation +130 added lines, -130 removed lines

@@ -20,134 +20,134 @@
  */
 class DatetimeMutation
 {
-    /**
-     * Maps the GraphQL input to a format that the model functions can use
-     *
-     * @param array $input Data coming from the GraphQL mutation query input
-     * @return array
-     * @throws Exception
-     */
-    public static function prepareFields(array $input): array
-    {
-        $args = [];
-
-        if (array_key_exists('capacity', $input)) {
-            $args['DTT_reg_limit'] = (int) $input['capacity'];
-        }
-
-        if (isset($input['description'])) {
-            $args['DTT_description'] = wp_kses_post($input['description']);
-        }
-
-        if (! empty($input['endDate'])) {
-            $args['DTT_EVT_end'] = new DateTime(sanitize_text_field($input['endDate']));
-        }
-
-        if (! empty($input['eventId'])) {
-            $args['EVT_ID'] = absint($input['eventId']);
-        } elseif (! empty($input['event'])) {
-            $parts = Relay::fromGlobalId(sanitize_text_field($input['event']));
-            $args['EVT_ID'] = ! empty($parts['id']) ? $parts['id'] : null;
-        }
-
-        if (array_key_exists('isPrimary', $input)) {
-            $args['DTT_is_primary'] = (bool) $input['isPrimary'];
-        }
-
-        if (array_key_exists('isTrashed', $input)) {
-            $args['DTT_deleted'] = (bool) $input['isTrashed'];
-        }
-
-        if (isset($input['name'])) {
-            $args['DTT_name'] = sanitize_text_field($input['name']);
-        }
-
-        if (array_key_exists('order', $input)) {
-            $args['DTT_order'] = (int) $input['order'];
-        }
-
-        if (! empty($input['parent'])) {
-            $parts = Relay::fromGlobalId(sanitize_text_field($input['parent']));
-            $args['DTT_parent'] = ! empty($parts['id']) ? $parts['id'] : null;
-        }
-
-        if (array_key_exists('reserved', $input)) {
-            $args['DTT_reserved'] = (int) $input['reserved'];
-        }
-
-        if (array_key_exists('sold', $input)) {
-            $args['DTT_sold'] = (int) $input['sold'];
-        }
-
-        if (! empty($input['startDate'])) {
-            $args['DTT_EVT_start'] = new DateTime(sanitize_text_field($input['startDate']));
-        }
-
-        if (! empty($input['tickets'])) {
-            $args['tickets'] = array_map('sanitize_text_field', (array) $input['tickets']);
-        }
-
-        if (array_key_exists('venue', $input)) {
-            $venue_id = sanitize_text_field($input['venue']);
-            $parts = Relay::fromGlobalId($venue_id);
-            $venue_id = ! empty($parts['id']) ? $parts['id'] : $venue_id;
-            $args['venue'] = absint($venue_id);
-        }
-
-        return apply_filters(
-            'FHEE__EventEspresso_core_domain_services_graphql_data_mutations__datetime_args',
-            $args,
-            $input
-        );
-    }
-
-
-    /**
-     * Sets the related tickets for the given datetime.
-     *
-     * @param EE_Datetime $entity  The datetime instance.
-     * @param array       $tickets Array of ticket IDs to relate.
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public static function setRelatedTickets(EE_Datetime $entity, array $tickets)
-    {
-        $relationName = 'Ticket';
-        // Remove all the existing related tickets
-        $entity->_remove_relations($relationName);
-
-        foreach ($tickets as $ID) {
-            $parts = Relay::fromGlobalId($ID);
-            if (! empty($parts['id']) && absint($parts['id'])) {
-                $entity->_add_relation_to(
-                    $parts['id'],
-                    $relationName
-                );
-            }
-        }
-    }
-
-
-    /**
-     * Sets the venue for the datetime.
-     *
-     * @param EE_Datetime $entity The datetime instance.
-     * @param int      $venue  The venue ID
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public static function setVenue(EE_Datetime $entity, int $venue)
-    {
-        if (empty($venue)) {
-            $entity->remove_venue($venue);
-        } else {
-            $entity->add_venue($venue);
-        }
-    }
+	/**
+	 * Maps the GraphQL input to a format that the model functions can use
+	 *
+	 * @param array $input Data coming from the GraphQL mutation query input
+	 * @return array
+	 * @throws Exception
+	 */
+	public static function prepareFields(array $input): array
+	{
+		$args = [];
+
+		if (array_key_exists('capacity', $input)) {
+			$args['DTT_reg_limit'] = (int) $input['capacity'];
+		}
+
+		if (isset($input['description'])) {
+			$args['DTT_description'] = wp_kses_post($input['description']);
+		}
+
+		if (! empty($input['endDate'])) {
+			$args['DTT_EVT_end'] = new DateTime(sanitize_text_field($input['endDate']));
+		}
+
+		if (! empty($input['eventId'])) {
+			$args['EVT_ID'] = absint($input['eventId']);
+		} elseif (! empty($input['event'])) {
+			$parts = Relay::fromGlobalId(sanitize_text_field($input['event']));
+			$args['EVT_ID'] = ! empty($parts['id']) ? $parts['id'] : null;
+		}
+
+		if (array_key_exists('isPrimary', $input)) {
+			$args['DTT_is_primary'] = (bool) $input['isPrimary'];
+		}
+
+		if (array_key_exists('isTrashed', $input)) {
+			$args['DTT_deleted'] = (bool) $input['isTrashed'];
+		}
+
+		if (isset($input['name'])) {
+			$args['DTT_name'] = sanitize_text_field($input['name']);
+		}
+
+		if (array_key_exists('order', $input)) {
+			$args['DTT_order'] = (int) $input['order'];
+		}
+
+		if (! empty($input['parent'])) {
+			$parts = Relay::fromGlobalId(sanitize_text_field($input['parent']));
+			$args['DTT_parent'] = ! empty($parts['id']) ? $parts['id'] : null;
+		}
+
+		if (array_key_exists('reserved', $input)) {
+			$args['DTT_reserved'] = (int) $input['reserved'];
+		}
+
+		if (array_key_exists('sold', $input)) {
+			$args['DTT_sold'] = (int) $input['sold'];
+		}
+
+		if (! empty($input['startDate'])) {
+			$args['DTT_EVT_start'] = new DateTime(sanitize_text_field($input['startDate']));
+		}
+
+		if (! empty($input['tickets'])) {
+			$args['tickets'] = array_map('sanitize_text_field', (array) $input['tickets']);
+		}
+
+		if (array_key_exists('venue', $input)) {
+			$venue_id = sanitize_text_field($input['venue']);
+			$parts = Relay::fromGlobalId($venue_id);
+			$venue_id = ! empty($parts['id']) ? $parts['id'] : $venue_id;
+			$args['venue'] = absint($venue_id);
+		}
+
+		return apply_filters(
+			'FHEE__EventEspresso_core_domain_services_graphql_data_mutations__datetime_args',
+			$args,
+			$input
+		);
+	}
+
+
+	/**
+	 * Sets the related tickets for the given datetime.
+	 *
+	 * @param EE_Datetime $entity  The datetime instance.
+	 * @param array       $tickets Array of ticket IDs to relate.
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public static function setRelatedTickets(EE_Datetime $entity, array $tickets)
+	{
+		$relationName = 'Ticket';
+		// Remove all the existing related tickets
+		$entity->_remove_relations($relationName);
+
+		foreach ($tickets as $ID) {
+			$parts = Relay::fromGlobalId($ID);
+			if (! empty($parts['id']) && absint($parts['id'])) {
+				$entity->_add_relation_to(
+					$parts['id'],
+					$relationName
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * Sets the venue for the datetime.
+	 *
+	 * @param EE_Datetime $entity The datetime instance.
+	 * @param int      $venue  The venue ID
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public static function setVenue(EE_Datetime $entity, int $venue)
+	{
+		if (empty($venue)) {
+			$entity->remove_venue($venue);
+		} else {
+			$entity->add_venue($venue);
+		}
+	}
 }

core/domain/services/messages/MessageTemplateRequestData.php

Indentation +212 added lines, -212 removed lines

@@ -14,260 +14,260 @@
  */
 class MessageTemplateRequestData
 {
-    protected ?RequestInterface $request         = null;
+	protected ?RequestInterface $request         = null;
 
-    protected string            $context         = '';
+	protected string            $context         = '';
 
-    protected string            $description     = '';
+	protected string            $description     = '';
 
-    protected string            $messenger       = '';
+	protected string            $messenger       = '';
 
-    protected string            $message_type    = '';
+	protected string            $message_type    = '';
 
-    protected string            $name            = '';
+	protected string            $name            = '';
 
-    protected array             $template_fields = [];
+	protected array             $template_fields = [];
 
-    protected int               $group_ID        = 0;
+	protected int               $group_ID        = 0;
 
-    protected int               $user_ID         = 0;
+	protected int               $user_ID         = 0;
 
-    protected bool              $is_active       = false;
+	protected bool              $is_active       = false;
 
-    protected bool              $is_deleted      = false;
+	protected bool              $is_deleted      = false;
 
-    protected bool              $is_global       = false;
+	protected bool              $is_global       = false;
 
-    protected bool              $is_override     = false;
+	protected bool              $is_override     = false;
 
 
-    /**
-     * @param RequestInterface|null $request
-     */
-    public function __construct(?RequestInterface $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 * @param RequestInterface|null $request
+	 */
+	public function __construct(?RequestInterface $request)
+	{
+		$this->request = $request;
+	}
 
 
-    public function setMessageTemplateRequestData()
-    {
-        $this->setContext();
-        $this->setDescription();
-        $this->setGroupID();
-        $this->setIsActive();
-        $this->setIsDeleted();
-        $this->setIsGlobal();
-        $this->setIsOverride();
-        $this->setMessenger();
-        $this->setMessageType();
-        $this->setName();
-        $this->setUserID();
-        $this->setTemplateFields();
-    }
+	public function setMessageTemplateRequestData()
+	{
+		$this->setContext();
+		$this->setDescription();
+		$this->setGroupID();
+		$this->setIsActive();
+		$this->setIsDeleted();
+		$this->setIsGlobal();
+		$this->setIsOverride();
+		$this->setMessenger();
+		$this->setMessageType();
+		$this->setName();
+		$this->setUserID();
+		$this->setTemplateFields();
+	}
 
 
-    public function context(): string
-    {
-        return $this->context;
-    }
+	public function context(): string
+	{
+		return $this->context;
+	}
 
 
-    public function description(): string
-    {
-        return $this->description;
-    }
+	public function description(): string
+	{
+		return $this->description;
+	}
 
 
-    public function messenger(): string
-    {
-        return $this->messenger;
-    }
+	public function messenger(): string
+	{
+		return $this->messenger;
+	}
 
 
-    public function messageType(): string
-    {
-        return $this->message_type;
-    }
+	public function messageType(): string
+	{
+		return $this->message_type;
+	}
 
 
-    public function name(): string
-    {
-        return $this->name;
-    }
+	public function name(): string
+	{
+		return $this->name;
+	}
 
 
-    public function templateFields(): array
-    {
-        return $this->template_fields;
-    }
+	public function templateFields(): array
+	{
+		return $this->template_fields;
+	}
 
 
-    public function groupID(): int
-    {
-        return $this->group_ID;
-    }
+	public function groupID(): int
+	{
+		return $this->group_ID;
+	}
 
 
-    public function userID(): int
-    {
-        return $this->user_ID;
-    }
+	public function userID(): int
+	{
+		return $this->user_ID;
+	}
 
 
-    public function isActive(): bool
-    {
-        return $this->is_active;
-    }
+	public function isActive(): bool
+	{
+		return $this->is_active;
+	}
 
 
-    public function isDeleted(): bool
-    {
-        return $this->is_deleted;
-    }
+	public function isDeleted(): bool
+	{
+		return $this->is_deleted;
+	}
 
 
-    public function isGlobal(): bool
-    {
-        return $this->is_global;
-    }
+	public function isGlobal(): bool
+	{
+		return $this->is_global;
+	}
 
 
-    public function isOverride(): bool
-    {
-        return $this->is_override;
-    }
+	public function isOverride(): bool
+	{
+		return $this->is_override;
+	}
 
 
-    public function setContext(?string $context = ''): void
-    {
-        $this->context = $this->request->getRequestParam('context', $context);
-        $this->context = $this->request->getRequestParam('MTP_context', $this->context);
-        $this->context = strtolower($this->context);
-    }
+	public function setContext(?string $context = ''): void
+	{
+		$this->context = $this->request->getRequestParam('context', $context);
+		$this->context = $this->request->getRequestParam('MTP_context', $this->context);
+		$this->context = strtolower($this->context);
+	}
 
 
-    public function setDescription(?string $description = ''): void
-    {
-        $this->description = $this->request->getRequestParam(
-            'ee_msg_non_global_fields[MTP_description]',
-            $description
-        );
-    }
-
-
-    public function setGroupID(?int $group_ID = 0): void
-    {
-        $this->group_ID = $this->request->getRequestParam('group_ID', $group_ID, DataType::INTEGER);
-        $this->group_ID = $this->request->getRequestParam('GRP_ID', $this->group_ID, DataType::INTEGER);
-        // we need the GRP_ID for the template being used as the base for the new template
-        if (empty($this->group_ID)) {
-            throw new RuntimeException(
-                esc_html__(
-                    'In order to create a custom message template the GRP_ID of the template being used as a base is needed',
-                    'event_espresso'
-                )
-            );
-        }
-    }
-
-
-    public function setIsActive(bool $is_active = false): void
-    {
-        $this->is_active = $this->request->getRequestParam('MTP_is_active', $is_active, DataType::BOOLEAN);
-    }
-
-
-    public function setIsDeleted(bool $is_deleted = false): void
-    {
-        $this->is_deleted = $this->request->getRequestParam('MTP_deleted', $is_deleted, DataType::BOOLEAN);
-    }
-
-
-    public function setIsGlobal(bool $is_global = false): void
-    {
-        $this->is_global = $this->request->getRequestParam('MTP_is_global', $is_global, DataType::BOOLEAN);
-    }
-
-
-    public function setIsOverride(bool $is_override = false): void
-    {
-        $this->is_override = $this->request->getRequestParam('MTP_is_override', $is_override, DataType::BOOLEAN);
-    }
-
-
-    public function setMessenger(?string $messenger = ''): void
-    {
-        // have to check for multiple params because a previouv dev used different names for the same param >:(
-        $this->messenger = $this->request->getRequestParam('msgr', $messenger);
-        $this->messenger = $this->request->getRequestParam('messenger', $this->messenger);
-        $this->messenger = $this->request->getRequestParam('MTP_messenger', $this->messenger);
-        $this->messenger = strtolower($this->messenger);
-        if (empty($this->messenger)) {
-            throw new RuntimeException(
-                esc_html__(
-                    'Sorry, but we can\'t create new templates because we\'re missing the messenger',
-                    'event_espresso'
-                )
-            );
-        }
-    }
-
-
-    public function setMessageType(?string $message_type = ''): void
-    {
-        // have to check for multiple params because a previouv dev used different names for the same param >:(
-        $this->message_type = $this->request->getRequestParam('mt', $message_type);
-        $this->message_type = $this->request->getRequestParam('message_type', $this->message_type);
-        $this->message_type = $this->request->getRequestParam('MTP_message_type', $this->message_type);
-        $this->message_type = strtolower($this->message_type);
-        if (empty($this->message_type)) {
-            throw new RuntimeException(
-                esc_html__(
-                    'Sorry, but we can\'t create new templates because we\'re missing the message type',
-                    'event_espresso'
-                )
-            );
-        }
-    }
-
-
-    public function setName(?string $name = ''): void
-    {
-        $this->name = $this->request->getRequestParam('ee_msg_non_global_fields[MTP_name]', $name);
-    }
-
-
-    public function setUserID(?int $user_ID = 0): void
-    {
-        $this->user_ID = $this->request->getRequestParam('user_id', $user_ID, DataType::INTEGER);
-        $this->user_ID = $this->request->getRequestParam('MTP_user_id', $this->user_ID, DataType::INTEGER);
-    }
-
-
-    private function setTemplateFields(): void
-    {
-        $this->template_fields = $this->request->getRequestParam(
-            'template_fields',
-            null,
-            DataType::EDITOR,
-            true
-        );
-        $this->template_fields = $this->request->getRequestParam(
-            'MTP_template_fields',
-            $this->template_fields,
-            DataType::EDITOR,
-            true
-        );
-        if (empty($this->template_fields)) {
-            throw new RuntimeException(
-                esc_html__(
-                    'There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
-                    'event_espresso'
-                )
-            );
-        }
-        // messages content is expected to be escaped
-        $this->template_fields = EEH_Array::addSlashesRecursively($this->template_fields);
-    }
+	public function setDescription(?string $description = ''): void
+	{
+		$this->description = $this->request->getRequestParam(
+			'ee_msg_non_global_fields[MTP_description]',
+			$description
+		);
+	}
+
+
+	public function setGroupID(?int $group_ID = 0): void
+	{
+		$this->group_ID = $this->request->getRequestParam('group_ID', $group_ID, DataType::INTEGER);
+		$this->group_ID = $this->request->getRequestParam('GRP_ID', $this->group_ID, DataType::INTEGER);
+		// we need the GRP_ID for the template being used as the base for the new template
+		if (empty($this->group_ID)) {
+			throw new RuntimeException(
+				esc_html__(
+					'In order to create a custom message template the GRP_ID of the template being used as a base is needed',
+					'event_espresso'
+				)
+			);
+		}
+	}
+
+
+	public function setIsActive(bool $is_active = false): void
+	{
+		$this->is_active = $this->request->getRequestParam('MTP_is_active', $is_active, DataType::BOOLEAN);
+	}
+
+
+	public function setIsDeleted(bool $is_deleted = false): void
+	{
+		$this->is_deleted = $this->request->getRequestParam('MTP_deleted', $is_deleted, DataType::BOOLEAN);
+	}
+
+
+	public function setIsGlobal(bool $is_global = false): void
+	{
+		$this->is_global = $this->request->getRequestParam('MTP_is_global', $is_global, DataType::BOOLEAN);
+	}
+
+
+	public function setIsOverride(bool $is_override = false): void
+	{
+		$this->is_override = $this->request->getRequestParam('MTP_is_override', $is_override, DataType::BOOLEAN);
+	}
+
+
+	public function setMessenger(?string $messenger = ''): void
+	{
+		// have to check for multiple params because a previouv dev used different names for the same param >:(
+		$this->messenger = $this->request->getRequestParam('msgr', $messenger);
+		$this->messenger = $this->request->getRequestParam('messenger', $this->messenger);
+		$this->messenger = $this->request->getRequestParam('MTP_messenger', $this->messenger);
+		$this->messenger = strtolower($this->messenger);
+		if (empty($this->messenger)) {
+			throw new RuntimeException(
+				esc_html__(
+					'Sorry, but we can\'t create new templates because we\'re missing the messenger',
+					'event_espresso'
+				)
+			);
+		}
+	}
+
+
+	public function setMessageType(?string $message_type = ''): void
+	{
+		// have to check for multiple params because a previouv dev used different names for the same param >:(
+		$this->message_type = $this->request->getRequestParam('mt', $message_type);
+		$this->message_type = $this->request->getRequestParam('message_type', $this->message_type);
+		$this->message_type = $this->request->getRequestParam('MTP_message_type', $this->message_type);
+		$this->message_type = strtolower($this->message_type);
+		if (empty($this->message_type)) {
+			throw new RuntimeException(
+				esc_html__(
+					'Sorry, but we can\'t create new templates because we\'re missing the message type',
+					'event_espresso'
+				)
+			);
+		}
+	}
+
+
+	public function setName(?string $name = ''): void
+	{
+		$this->name = $this->request->getRequestParam('ee_msg_non_global_fields[MTP_name]', $name);
+	}
+
+
+	public function setUserID(?int $user_ID = 0): void
+	{
+		$this->user_ID = $this->request->getRequestParam('user_id', $user_ID, DataType::INTEGER);
+		$this->user_ID = $this->request->getRequestParam('MTP_user_id', $this->user_ID, DataType::INTEGER);
+	}
+
+
+	private function setTemplateFields(): void
+	{
+		$this->template_fields = $this->request->getRequestParam(
+			'template_fields',
+			null,
+			DataType::EDITOR,
+			true
+		);
+		$this->template_fields = $this->request->getRequestParam(
+			'MTP_template_fields',
+			$this->template_fields,
+			DataType::EDITOR,
+			true
+		);
+		if (empty($this->template_fields)) {
+			throw new RuntimeException(
+				esc_html__(
+					'There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
+					'event_espresso'
+				)
+			);
+		}
+		// messages content is expected to be escaped
+		$this->template_fields = EEH_Array::addSlashesRecursively($this->template_fields);
+	}
 }

core/domain/services/messages/MessageTemplateManager.php

Indentation +335 added lines, -335 removed lines

@@ -17,339 +17,339 @@
  */
 class MessageTemplateManager
 {
-    private EEM_Message_Template         $message_template_model;
-
-    private EEM_Message_Template_Group   $message_template_group_model;
-
-    protected MessageTemplateRequestData $form_data;
-
-    protected MessageTemplateValidator   $validator;
-
-    protected RequestInterface           $request;
-
-
-    /**
-     * @param EEM_Message_Template       $message_template_model
-     * @param EEM_Message_Template_Group $message_template_group_model
-     * @param MessageTemplateRequestData $form_data
-     * @param MessageTemplateValidator   $validator
-     * @param RequestInterface           $request
-     */
-    public function __construct(
-        EEM_Message_Template $message_template_model,
-        EEM_Message_Template_Group $message_template_group_model,
-        MessageTemplateRequestData $form_data,
-        MessageTemplateValidator $validator,
-        RequestInterface $request
-    ) {
-        $this->message_template_model       = $message_template_model;
-        $this->message_template_group_model = $message_template_group_model;
-        $this->form_data                    = $form_data;
-        $this->validator                    = $validator;
-        $this->request                      = $request;
-    }
-
-
-    /**
-     * @param string|null $messenger
-     * @param string|null $message_type
-     * @param int         $GRP_ID
-     * @param bool        $global
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generateNewTemplates(
-        ?string $messenger = '',
-        ?string $message_type = '',
-        int $GRP_ID = 0,
-        bool $global = false
-    ): array {
-        $this->form_data->setMessageTemplateRequestData();
-
-        $messenger    = $messenger ?: $this->form_data->messenger();
-        $message_type = $message_type ?: $this->form_data->messageType();
-        $GRP_ID       = $GRP_ID ?: $this->form_data->groupID();
-
-        // if no $message_types are given then that's okay...
-        // this may be a messenger that just adds shortcodes,
-        // so we just don't generate any templates.
-        if (empty($message_type)) {
-            return [];
-        }
-        $new_templates = EEH_MSG_Template::generate_new_templates($messenger, [$message_type], $GRP_ID, $global);
-        return $new_templates[0];
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function updateExistingTemplates(): void
-    {
-        $this->form_data->setMessageTemplateRequestData();
-        $template_fields = $this->form_data->templateFields();
-
-        if ($template_fields) {
-            if (
-                $this->validator->validateTemplateFields(
-                    $this->form_data->messenger(),
-                    $this->form_data->messageType(),
-                    $this->form_data->context(),
-                    $template_fields
-                )
-            ) {
-                foreach ($template_fields as $template_field => $data) {
-                    $this->validateTemplateFieldData($template_field, $data);
-                    $this->updateMessageTemplate(
-                        $template_field,
-                        [
-                            'GRP_ID'             => $this->form_data->groupID(),
-                            'MTP_ID'             => $data['MTP_ID'],
-                            'MTP_template_field' => $data['name'],
-                            'MTP_context'        => $this->form_data->context(),
-                            // if they aren't allowed to use all JS, restrict them to standard allowed post tags
-                            'MTP_content'        => ! current_user_can('unfiltered_html')
-                                ? $this->sanitizeMessageTemplateContent($data['content'])
-                                : $data['content'],
-                        ]
-                    );
-                }
-                // we can use the last set_column_values for the Message Template Group update
-                // (because its the same for all of these specific MTPs)
-                $this->updateMessageTemplateGroup(
-                    [
-                        'GRP_ID'           => $this->form_data->groupID(),
-                        'MTP_user_id'      => $this->form_data->userID(),
-                        'MTP_messenger'    => $this->form_data->messenger(),
-                        'MTP_message_type' => $this->form_data->messageType(),
-                        'MTP_is_global'    => $this->form_data->isGlobal(),
-                        'MTP_is_override'  => $this->form_data->isOverride(),
-                        'MTP_deleted'      => $this->form_data->isDeleted(),
-                        'MTP_is_active'    => $this->form_data->isActive(),
-                        'MTP_name'         => $this->form_data->name(),
-                        'MTP_description'  => $this->form_data->description(),
-                    ]
-                );
-            }
-        }
-    }
-
-
-    /**
-     * @param string $template_field
-     * @param array  $message_template_fields
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateMessageTemplate(string $template_field, array $message_template_fields): void
-    {
-        $MTP_ID = $message_template_fields['MTP_ID'] ?? 0;
-        // if we have a MTP_ID for this field then update it, otherwise insert.
-        // this has already been through the template field validator and sanitized, so it will be
-        // safe to insert this field.  Why insert?  This typically happens when we introduce a new
-        // message template field in a messenger/message type and existing users don't have the
-        // default setup for it.
-        // @link https://events.codebasehq.com/projects/event-espresso/tickets/9465
-        $updated = $MTP_ID
-            ? $this->message_template_model->update($message_template_fields, [['MTP_ID' => $MTP_ID]])
-            : $this->message_template_model->insert($message_template_fields);
-
-        // updates will return 0 if the field was not changed (ie: no changes = nothing actually updated)
-        // but we won't consider that a problem, but if it returns false, then something went BOOM!
-        if ($updated === false) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('%s field was NOT updated for some reason', 'event_espresso'),
-                    $template_field
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @param array $form_data
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateMessageTemplateGroup(array $form_data): void
-    {
-        try {
-            $GRP_ID = $form_data['id'] ?? 0;
-            $GRP_ID = $form_data['GRP_ID'] ?? $GRP_ID;
-            if (! $GRP_ID) {
-                throw new RuntimeException(
-                    esc_html__(
-                        'Can not update message template group because no GRP_ID was provided',
-                        'event_espresso'
-                    )
-                );
-            }
-
-            $updated       = $this->message_template_group_model->update($form_data, [['GRP_ID' => $GRP_ID]]);
-            $error_message = esc_html__(
-                'unknown error occurred while updating message template group',
-                'event_espresso'
-            );
-
-            if ($updated !== false) {
-                $message_template_group = $this->message_template_group_model->get_one_by_ID($GRP_ID);
-                if ($message_template_group instanceof EE_Message_Template_Group) {
-                    // k now we need to ensure the template_pack and template_variation fields are set.
-                    $template_pack      = $this->request->getRequestParam('MTP_template_pack', 'default');
-                    $template_variation = $this->request->getRequestParam('MTP_template_variation', 'default');
-                    $message_template_group->set_template_pack_name($template_pack);
-                    $message_template_group->set_template_pack_variation($template_variation);
-                }
-                return;
-            }
-        } catch (RuntimeException $exception) {
-            $error_message = $exception->getMessage();
-        }
-
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'The Message Template Group (%1$d) was NOT updated for the following reason: %2$s',
-                    'event_espresso'
-                ),
-                $form_data['GRP_ID'],
-                $error_message
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-    }
-
-
-    /**
-     * recursively runs wp_kses() on message template content in a model safe manner
-     *
-     * @param array|string $content
-     * @return array|string
-     * @since   4.10.29.p
-     */
-    private function sanitizeMessageTemplateContent($content)
-    {
-        if (is_array($content)) {
-            foreach ($content as $key => $value) {
-                $content[ $key ] = $this->sanitizeMessageTemplateContent($value);
-            }
-            return $content;
-        }
-        // remove slashes so wp_kses() works properly
-        // wp_kses_stripslashes() only removes slashes from double-quotes,
-        // so attributes using single quotes always appear invalid.
-        $content = stripslashes($content);
-        $content = wp_kses($content, wp_kses_allowed_html('post'));
-        // But currently the models expect slashed data, so after wp_kses()
-        // runs we need to re-slash the data. Sheesh.
-        // See https://events.codebasehq.com/projects/event-espresso/tickets/11211#update-47321587
-        return addslashes($content);
-    }
-
-
-    /**
-     * @param int $GRP_ID
-     * @return false|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function trashMessageTemplate(int $GRP_ID)
-    {
-        return $this->message_template_group_model->delete_by_ID($GRP_ID);
-    }
-
-
-    /**
-     * @param int $GRP_ID
-     * @return bool
-     * @throws EE_Error
-     */
-    public function restoreMessageTemplate(int $GRP_ID): bool
-    {
-        return $this->message_template_group_model->restore_by_ID($GRP_ID);
-    }
-
-
-    /**
-     * @param int $GRP_ID
-     * @return EE_Message_Template_Group
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function getMessageTemplateGroup(int $GRP_ID): EE_Message_Template_Group
-    {
-        $message_template_group = $this->message_template_group_model->get_one_by_ID($GRP_ID);
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-        throw new RuntimeException(
-            esc_html__(
-                'Can not permanently delete message template group because an invalid GRP_ID was provided',
-                'event_espresso'
-            )
-        );
-    }
-
-
-    /**
-     * @param int $GRP_ID
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function permanentlyDeleteMessageTemplates(int $GRP_ID): bool
-    {
-        $message_template_group = $this->getMessageTemplateGroup($GRP_ID);
-        // permanently delete all the related Message Templates
-        $deleted = $message_template_group->delete_related_permanently('Message_Template');
-        return $deleted > 0;
-    }
-
-
-    /**
-     * @param int $GRP_ID
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function permanentlyDeleteMessageTemplateGroup(int $GRP_ID): bool
-    {
-        if ($this->permanentlyDeleteMessageTemplates($GRP_ID)) {
-            return $this->message_template_group_model->delete_permanently([['GRP_ID' => $GRP_ID]]);
-        }
-        return false;
-    }
-
-
-    private function validateTemplateFieldData(string $template_field, array $data)
-    {
-        if (
-            ! (
-                array_key_exists('MTP_ID', $data)
-                && array_key_exists('name', $data)
-                && array_key_exists('content', $data)
-            )
-        ) {
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__(
-                        'Can not update message template field %1$s because of a missing MTP_ID, name, or content.',
-                        'event_espresso'
-                    ),
-                    $template_field
-                )
-            );
-        }
-    }
+	private EEM_Message_Template         $message_template_model;
+
+	private EEM_Message_Template_Group   $message_template_group_model;
+
+	protected MessageTemplateRequestData $form_data;
+
+	protected MessageTemplateValidator   $validator;
+
+	protected RequestInterface           $request;
+
+
+	/**
+	 * @param EEM_Message_Template       $message_template_model
+	 * @param EEM_Message_Template_Group $message_template_group_model
+	 * @param MessageTemplateRequestData $form_data
+	 * @param MessageTemplateValidator   $validator
+	 * @param RequestInterface           $request
+	 */
+	public function __construct(
+		EEM_Message_Template $message_template_model,
+		EEM_Message_Template_Group $message_template_group_model,
+		MessageTemplateRequestData $form_data,
+		MessageTemplateValidator $validator,
+		RequestInterface $request
+	) {
+		$this->message_template_model       = $message_template_model;
+		$this->message_template_group_model = $message_template_group_model;
+		$this->form_data                    = $form_data;
+		$this->validator                    = $validator;
+		$this->request                      = $request;
+	}
+
+
+	/**
+	 * @param string|null $messenger
+	 * @param string|null $message_type
+	 * @param int         $GRP_ID
+	 * @param bool        $global
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generateNewTemplates(
+		?string $messenger = '',
+		?string $message_type = '',
+		int $GRP_ID = 0,
+		bool $global = false
+	): array {
+		$this->form_data->setMessageTemplateRequestData();
+
+		$messenger    = $messenger ?: $this->form_data->messenger();
+		$message_type = $message_type ?: $this->form_data->messageType();
+		$GRP_ID       = $GRP_ID ?: $this->form_data->groupID();
+
+		// if no $message_types are given then that's okay...
+		// this may be a messenger that just adds shortcodes,
+		// so we just don't generate any templates.
+		if (empty($message_type)) {
+			return [];
+		}
+		$new_templates = EEH_MSG_Template::generate_new_templates($messenger, [$message_type], $GRP_ID, $global);
+		return $new_templates[0];
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function updateExistingTemplates(): void
+	{
+		$this->form_data->setMessageTemplateRequestData();
+		$template_fields = $this->form_data->templateFields();
+
+		if ($template_fields) {
+			if (
+				$this->validator->validateTemplateFields(
+					$this->form_data->messenger(),
+					$this->form_data->messageType(),
+					$this->form_data->context(),
+					$template_fields
+				)
+			) {
+				foreach ($template_fields as $template_field => $data) {
+					$this->validateTemplateFieldData($template_field, $data);
+					$this->updateMessageTemplate(
+						$template_field,
+						[
+							'GRP_ID'             => $this->form_data->groupID(),
+							'MTP_ID'             => $data['MTP_ID'],
+							'MTP_template_field' => $data['name'],
+							'MTP_context'        => $this->form_data->context(),
+							// if they aren't allowed to use all JS, restrict them to standard allowed post tags
+							'MTP_content'        => ! current_user_can('unfiltered_html')
+								? $this->sanitizeMessageTemplateContent($data['content'])
+								: $data['content'],
+						]
+					);
+				}
+				// we can use the last set_column_values for the Message Template Group update
+				// (because its the same for all of these specific MTPs)
+				$this->updateMessageTemplateGroup(
+					[
+						'GRP_ID'           => $this->form_data->groupID(),
+						'MTP_user_id'      => $this->form_data->userID(),
+						'MTP_messenger'    => $this->form_data->messenger(),
+						'MTP_message_type' => $this->form_data->messageType(),
+						'MTP_is_global'    => $this->form_data->isGlobal(),
+						'MTP_is_override'  => $this->form_data->isOverride(),
+						'MTP_deleted'      => $this->form_data->isDeleted(),
+						'MTP_is_active'    => $this->form_data->isActive(),
+						'MTP_name'         => $this->form_data->name(),
+						'MTP_description'  => $this->form_data->description(),
+					]
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $template_field
+	 * @param array  $message_template_fields
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateMessageTemplate(string $template_field, array $message_template_fields): void
+	{
+		$MTP_ID = $message_template_fields['MTP_ID'] ?? 0;
+		// if we have a MTP_ID for this field then update it, otherwise insert.
+		// this has already been through the template field validator and sanitized, so it will be
+		// safe to insert this field.  Why insert?  This typically happens when we introduce a new
+		// message template field in a messenger/message type and existing users don't have the
+		// default setup for it.
+		// @link https://events.codebasehq.com/projects/event-espresso/tickets/9465
+		$updated = $MTP_ID
+			? $this->message_template_model->update($message_template_fields, [['MTP_ID' => $MTP_ID]])
+			: $this->message_template_model->insert($message_template_fields);
+
+		// updates will return 0 if the field was not changed (ie: no changes = nothing actually updated)
+		// but we won't consider that a problem, but if it returns false, then something went BOOM!
+		if ($updated === false) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('%s field was NOT updated for some reason', 'event_espresso'),
+					$template_field
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @param array $form_data
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateMessageTemplateGroup(array $form_data): void
+	{
+		try {
+			$GRP_ID = $form_data['id'] ?? 0;
+			$GRP_ID = $form_data['GRP_ID'] ?? $GRP_ID;
+			if (! $GRP_ID) {
+				throw new RuntimeException(
+					esc_html__(
+						'Can not update message template group because no GRP_ID was provided',
+						'event_espresso'
+					)
+				);
+			}
+
+			$updated       = $this->message_template_group_model->update($form_data, [['GRP_ID' => $GRP_ID]]);
+			$error_message = esc_html__(
+				'unknown error occurred while updating message template group',
+				'event_espresso'
+			);
+
+			if ($updated !== false) {
+				$message_template_group = $this->message_template_group_model->get_one_by_ID($GRP_ID);
+				if ($message_template_group instanceof EE_Message_Template_Group) {
+					// k now we need to ensure the template_pack and template_variation fields are set.
+					$template_pack      = $this->request->getRequestParam('MTP_template_pack', 'default');
+					$template_variation = $this->request->getRequestParam('MTP_template_variation', 'default');
+					$message_template_group->set_template_pack_name($template_pack);
+					$message_template_group->set_template_pack_variation($template_variation);
+				}
+				return;
+			}
+		} catch (RuntimeException $exception) {
+			$error_message = $exception->getMessage();
+		}
+
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'The Message Template Group (%1$d) was NOT updated for the following reason: %2$s',
+					'event_espresso'
+				),
+				$form_data['GRP_ID'],
+				$error_message
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+	}
+
+
+	/**
+	 * recursively runs wp_kses() on message template content in a model safe manner
+	 *
+	 * @param array|string $content
+	 * @return array|string
+	 * @since   4.10.29.p
+	 */
+	private function sanitizeMessageTemplateContent($content)
+	{
+		if (is_array($content)) {
+			foreach ($content as $key => $value) {
+				$content[ $key ] = $this->sanitizeMessageTemplateContent($value);
+			}
+			return $content;
+		}
+		// remove slashes so wp_kses() works properly
+		// wp_kses_stripslashes() only removes slashes from double-quotes,
+		// so attributes using single quotes always appear invalid.
+		$content = stripslashes($content);
+		$content = wp_kses($content, wp_kses_allowed_html('post'));
+		// But currently the models expect slashed data, so after wp_kses()
+		// runs we need to re-slash the data. Sheesh.
+		// See https://events.codebasehq.com/projects/event-espresso/tickets/11211#update-47321587
+		return addslashes($content);
+	}
+
+
+	/**
+	 * @param int $GRP_ID
+	 * @return false|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function trashMessageTemplate(int $GRP_ID)
+	{
+		return $this->message_template_group_model->delete_by_ID($GRP_ID);
+	}
+
+
+	/**
+	 * @param int $GRP_ID
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function restoreMessageTemplate(int $GRP_ID): bool
+	{
+		return $this->message_template_group_model->restore_by_ID($GRP_ID);
+	}
+
+
+	/**
+	 * @param int $GRP_ID
+	 * @return EE_Message_Template_Group
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function getMessageTemplateGroup(int $GRP_ID): EE_Message_Template_Group
+	{
+		$message_template_group = $this->message_template_group_model->get_one_by_ID($GRP_ID);
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+		throw new RuntimeException(
+			esc_html__(
+				'Can not permanently delete message template group because an invalid GRP_ID was provided',
+				'event_espresso'
+			)
+		);
+	}
+
+
+	/**
+	 * @param int $GRP_ID
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function permanentlyDeleteMessageTemplates(int $GRP_ID): bool
+	{
+		$message_template_group = $this->getMessageTemplateGroup($GRP_ID);
+		// permanently delete all the related Message Templates
+		$deleted = $message_template_group->delete_related_permanently('Message_Template');
+		return $deleted > 0;
+	}
+
+
+	/**
+	 * @param int $GRP_ID
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function permanentlyDeleteMessageTemplateGroup(int $GRP_ID): bool
+	{
+		if ($this->permanentlyDeleteMessageTemplates($GRP_ID)) {
+			return $this->message_template_group_model->delete_permanently([['GRP_ID' => $GRP_ID]]);
+		}
+		return false;
+	}
+
+
+	private function validateTemplateFieldData(string $template_field, array $data)
+	{
+		if (
+			! (
+				array_key_exists('MTP_ID', $data)
+				&& array_key_exists('name', $data)
+				&& array_key_exists('content', $data)
+			)
+		) {
+			throw new RuntimeException(
+				sprintf(
+					esc_html__(
+						'Can not update message template field %1$s because of a missing MTP_ID, name, or content.',
+						'event_espresso'
+					),
+					$template_field
+				)
+			);
+		}
+	}
 }
\ No newline at end of file

Spacing +2 added lines, -2 removed lines

@@ -185,7 +185,7 @@ 
         try {
             $GRP_ID = $form_data['id'] ?? 0;
             $GRP_ID = $form_data['GRP_ID'] ?? $GRP_ID;
-            if (! $GRP_ID) {
+            if ( ! $GRP_ID) {
                 throw new RuntimeException(
                     esc_html__(
                         'Can not update message template group because no GRP_ID was provided',
@@ -242,7 +242,7 @@ 
     {
         if (is_array($content)) {
             foreach ($content as $key => $value) {
-                $content[ $key ] = $this->sanitizeMessageTemplateContent($value);
+                $content[$key] = $this->sanitizeMessageTemplateContent($value);
             }
             return $content;
         }

core/domain/services/messages/MessageTemplateValidator.php

Indentation +169 added lines, -169 removed lines

@@ -14,173 +14,173 @@
  */
 class MessageTemplateValidator
 {
-    private LoaderInterface $loader;
-
-
-    /**
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
-
-
-    /**
-     * @param string $messenger
-     * @param string $message_type
-     * @param string $context
-     * @param array  $template_fields
-     * @return bool
-     * @throws DomainException
-     */
-    public function validateTemplateFields(
-        string $messenger,
-        string $message_type,
-        string $context,
-        array $template_fields
-    ): bool {
-        // first validate all fields!
-        // this filter allows client code to add its own validation to the template fields as well.
-        // returning an empty array means everything passed validation.
-        // errors in validation should be represented in an array with the following shape:
-        // array(
-        //   'fieldname' => array(
-        //          'msg' => 'error message'
-        //          'value' => 'value for field producing error'
-        // )
-        $custom_validation = (array) apply_filters(
-            'FHEE__Messages_Admin_Page___insert_or_update_message_template__validates',
-            [],
-            $template_fields,
-            $context,
-            $messenger,
-            $message_type
-        );
-
-        $fields_to_validate = $this->prepFieldsToValidate($template_fields);
-        $validator          = $this->loadValidator($messenger, $message_type, $context, $fields_to_validate);
-        $system_validation  = $validator->validate();
-        $system_validation  = ! is_array($system_validation) && $system_validation ? [] : $system_validation;
-        $validation_errors  = array_merge($custom_validation, $system_validation);
-
-        // if $validate returned error messages (i.e. is_array()) then we need to process them and setup an
-        // appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.
-        //  WE need to make sure there is no actual error messages in validates.
-        if (empty($validation_errors)) {
-            return true;
-        }
-
-        // add the transient so when the form loads we know which fields to highlight
-        $this->addTransient($validation_errors);
-        // setup notices
-        foreach ($validation_errors as $error) {
-            if (isset($error['msg'])) {
-                EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * This sends things to the validator for the given messenger and message type.
-     *
-     * @param array $message_template_fields  the incoming fields to check.
-     *                                        Note this array is in the formatted fields from the form fields setup.
-     *                                        So we need to reformat this into an array of expected field refs by the
-     *                                        validator. Note also that this is not only the fields for the Message
-     *                                        Template Group but ALSO for Message Template.
-     * @throws DomainException
-     */
-    public function prepFieldsToValidate(array $message_template_fields): array
-    {
-        $fields_to_validate = [];
-        // let's loop through all the fields and set them up in the right format
-        foreach ($message_template_fields as $message_template_field) {
-            // first let's figure out if the value['content'] in the current index is an array.
-            //  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
-            if (is_array($message_template_field['content'])) {
-                $fields_to_validate[ $message_template_field['name'] ] = $message_template_field['content']['main'];
-                // loop through the content and get the other fields.
-                foreach ($message_template_field['content'] as $name => $value) {
-                    if ($name !== 'main') {
-                        $fields_to_validate[ $name ] = $value;
-                    }
-                }
-                continue;
-            }
-
-            // okay if we're here then this is just a straight field=>$value arrangement
-            $fields_to_validate[ $message_template_field['name'] ] = $message_template_field['content'];
-        }
-        return $fields_to_validate;
-    }
-
-
-    private function loadValidator(
-        string $messenger,
-        string $message_type,
-        string $context,
-        array $fields_to_validate
-    ): ?EE_Messages_Validator {
-        // now we've got the assembled_fields.
-        // We need to setup the string for the appropriate validator class and call that.
-        $messenger_ref = ucwords(str_replace('_', ' ', $messenger));
-        $messenger_ref = str_replace(' ', '_', $messenger_ref);
-
-        $message_type_ref = ucwords(str_replace('_', ' ', $message_type));
-        $message_type_ref = str_replace(' ', '_', $message_type_ref);
-
-        $classname = "EE_Messages_{$messenger_ref}_{$message_type_ref}_Validator";
-
-        $msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
-        if (! class_exists($classname)) {
-            $msg[] = sprintf(
-                esc_html__(
-                    'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class',
-                    'event_espresso'
-                ),
-                $classname
-            );
-            throw new DomainException(implode('. ', $msg));
-        }
-
-        $validator = $this->loader->getShared($classname, [$fields_to_validate, $context]);
-        if (! $validator instanceof EE_Messages_Validator) {
-            $msg[] = sprintf(
-                esc_html__(
-                    'Failed to instantiate %s.',
-                    'event_espresso'
-                ),
-                $classname
-            );
-            throw new DomainException(implode('. ', $msg));
-        }
-        return $validator;
-    }
-
-
-    /**
-     * This makes available the WP transient system for temporarily moving data between routes
-     *
-     * @param array $data the data that gets sent
-     */
-    private function addTransient(array $data): void
-    {
-        $user_id   = get_current_user_id();
-        $transient = "rte_tx_edit_message_template_$user_id";
-        $net_admin = is_multisite() && is_network_admin();
-        // is there already a transient for this route?  If there is then let's ADD to that transient
-        $existing = $net_admin ? get_site_transient($transient) : get_transient($transient);
-        $data     = ! array_key_exists('notices', $data) ? ['notices' => $data] : $data;
-        if ($existing) {
-            $data = array_merge($data, (array) $existing);
-        }
-        if ($net_admin) {
-            set_site_transient($transient, $data, 8);
-        } else {
-            set_transient($transient, $data, 8);
-        }
-    }
+	private LoaderInterface $loader;
+
+
+	/**
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
+
+
+	/**
+	 * @param string $messenger
+	 * @param string $message_type
+	 * @param string $context
+	 * @param array  $template_fields
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public function validateTemplateFields(
+		string $messenger,
+		string $message_type,
+		string $context,
+		array $template_fields
+	): bool {
+		// first validate all fields!
+		// this filter allows client code to add its own validation to the template fields as well.
+		// returning an empty array means everything passed validation.
+		// errors in validation should be represented in an array with the following shape:
+		// array(
+		//   'fieldname' => array(
+		//          'msg' => 'error message'
+		//          'value' => 'value for field producing error'
+		// )
+		$custom_validation = (array) apply_filters(
+			'FHEE__Messages_Admin_Page___insert_or_update_message_template__validates',
+			[],
+			$template_fields,
+			$context,
+			$messenger,
+			$message_type
+		);
+
+		$fields_to_validate = $this->prepFieldsToValidate($template_fields);
+		$validator          = $this->loadValidator($messenger, $message_type, $context, $fields_to_validate);
+		$system_validation  = $validator->validate();
+		$system_validation  = ! is_array($system_validation) && $system_validation ? [] : $system_validation;
+		$validation_errors  = array_merge($custom_validation, $system_validation);
+
+		// if $validate returned error messages (i.e. is_array()) then we need to process them and setup an
+		// appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.
+		//  WE need to make sure there is no actual error messages in validates.
+		if (empty($validation_errors)) {
+			return true;
+		}
+
+		// add the transient so when the form loads we know which fields to highlight
+		$this->addTransient($validation_errors);
+		// setup notices
+		foreach ($validation_errors as $error) {
+			if (isset($error['msg'])) {
+				EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * This sends things to the validator for the given messenger and message type.
+	 *
+	 * @param array $message_template_fields  the incoming fields to check.
+	 *                                        Note this array is in the formatted fields from the form fields setup.
+	 *                                        So we need to reformat this into an array of expected field refs by the
+	 *                                        validator. Note also that this is not only the fields for the Message
+	 *                                        Template Group but ALSO for Message Template.
+	 * @throws DomainException
+	 */
+	public function prepFieldsToValidate(array $message_template_fields): array
+	{
+		$fields_to_validate = [];
+		// let's loop through all the fields and set them up in the right format
+		foreach ($message_template_fields as $message_template_field) {
+			// first let's figure out if the value['content'] in the current index is an array.
+			//  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
+			if (is_array($message_template_field['content'])) {
+				$fields_to_validate[ $message_template_field['name'] ] = $message_template_field['content']['main'];
+				// loop through the content and get the other fields.
+				foreach ($message_template_field['content'] as $name => $value) {
+					if ($name !== 'main') {
+						$fields_to_validate[ $name ] = $value;
+					}
+				}
+				continue;
+			}
+
+			// okay if we're here then this is just a straight field=>$value arrangement
+			$fields_to_validate[ $message_template_field['name'] ] = $message_template_field['content'];
+		}
+		return $fields_to_validate;
+	}
+
+
+	private function loadValidator(
+		string $messenger,
+		string $message_type,
+		string $context,
+		array $fields_to_validate
+	): ?EE_Messages_Validator {
+		// now we've got the assembled_fields.
+		// We need to setup the string for the appropriate validator class and call that.
+		$messenger_ref = ucwords(str_replace('_', ' ', $messenger));
+		$messenger_ref = str_replace(' ', '_', $messenger_ref);
+
+		$message_type_ref = ucwords(str_replace('_', ' ', $message_type));
+		$message_type_ref = str_replace(' ', '_', $message_type_ref);
+
+		$classname = "EE_Messages_{$messenger_ref}_{$message_type_ref}_Validator";
+
+		$msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
+		if (! class_exists($classname)) {
+			$msg[] = sprintf(
+				esc_html__(
+					'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class',
+					'event_espresso'
+				),
+				$classname
+			);
+			throw new DomainException(implode('. ', $msg));
+		}
+
+		$validator = $this->loader->getShared($classname, [$fields_to_validate, $context]);
+		if (! $validator instanceof EE_Messages_Validator) {
+			$msg[] = sprintf(
+				esc_html__(
+					'Failed to instantiate %s.',
+					'event_espresso'
+				),
+				$classname
+			);
+			throw new DomainException(implode('. ', $msg));
+		}
+		return $validator;
+	}
+
+
+	/**
+	 * This makes available the WP transient system for temporarily moving data between routes
+	 *
+	 * @param array $data the data that gets sent
+	 */
+	private function addTransient(array $data): void
+	{
+		$user_id   = get_current_user_id();
+		$transient = "rte_tx_edit_message_template_$user_id";
+		$net_admin = is_multisite() && is_network_admin();
+		// is there already a transient for this route?  If there is then let's ADD to that transient
+		$existing = $net_admin ? get_site_transient($transient) : get_transient($transient);
+		$data     = ! array_key_exists('notices', $data) ? ['notices' => $data] : $data;
+		if ($existing) {
+			$data = array_merge($data, (array) $existing);
+		}
+		if ($net_admin) {
+			set_site_transient($transient, $data, 8);
+		} else {
+			set_transient($transient, $data, 8);
+		}
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -101,18 +101,18 @@ 
             // first let's figure out if the value['content'] in the current index is an array.
             //  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
             if (is_array($message_template_field['content'])) {
-                $fields_to_validate[ $message_template_field['name'] ] = $message_template_field['content']['main'];
+                $fields_to_validate[$message_template_field['name']] = $message_template_field['content']['main'];
                 // loop through the content and get the other fields.
                 foreach ($message_template_field['content'] as $name => $value) {
                     if ($name !== 'main') {
-                        $fields_to_validate[ $name ] = $value;
+                        $fields_to_validate[$name] = $value;
                     }
                 }
                 continue;
             }
 
             // okay if we're here then this is just a straight field=>$value arrangement
-            $fields_to_validate[ $message_template_field['name'] ] = $message_template_field['content'];
+            $fields_to_validate[$message_template_field['name']] = $message_template_field['content'];
         }
         return $fields_to_validate;
     }
@@ -135,7 +135,7 @@ 
         $classname = "EE_Messages_{$messenger_ref}_{$message_type_ref}_Validator";
 
         $msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
-        if (! class_exists($classname)) {
+        if ( ! class_exists($classname)) {
             $msg[] = sprintf(
                 esc_html__(
                     'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class',
@@ -147,7 +147,7 @@ 
         }
 
         $validator = $this->loader->getShared($classname, [$fields_to_validate, $context]);
-        if (! $validator instanceof EE_Messages_Validator) {
+        if ( ! $validator instanceof EE_Messages_Validator) {
             $msg[] = sprintf(
                 esc_html__(
                     'Failed to instantiate %s.',

core/domain/services/validation/email/strategies/WordPress.php

Indentation +15 added lines, -15 removed lines

@@ -14,19 +14,19 @@
  */
 class WordPress extends Basic
 {
-    /**
-     * @param string $email_address
-     * @return boolean
-     * @throws EmailValidationException
-     */
-    public function validate(string $email_address): bool
-    {
-        parent::validate($email_address);
-        if (! is_email($email_address)) {
-            throw new EmailValidationException(
-                esc_html__('The email address provided is not valid.', 'event_espresso')
-            );
-        }
-        return true;
-    }
+	/**
+	 * @param string $email_address
+	 * @return boolean
+	 * @throws EmailValidationException
+	 */
+	public function validate(string $email_address): bool
+	{
+		parent::validate($email_address);
+		if (! is_email($email_address)) {
+			throw new EmailValidationException(
+				esc_html__('The email address provided is not valid.', 'event_espresso')
+			);
+		}
+		return true;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
     public function validate(string $email_address): bool
     {
         parent::validate($email_address);
-        if (! is_email($email_address)) {
+        if ( ! is_email($email_address)) {
             throw new EmailValidationException(
                 esc_html__('The email address provided is not valid.', 'event_espresso')
             );

core/domain/services/validation/email/strategies/International.php

Indentation +23 added lines, -23 removed lines

@@ -14,27 +14,27 @@
  */
 class International extends Basic
 {
-    /**
-     * @param string $email_address
-     * @return bool
-     * @throws EmailValidationException
-     */
-    public function validate(string $email_address): bool
-    {
-        parent::validate($email_address);
-        // plz see http://stackoverflow.com/a/24817336 re: the following regex
-        if (
-            ! preg_match(
-            // @codingStandardsIgnoreStart
-                '/^(?!\.)((?!.*\.{2})[a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\.!#$%&\'*+-\/=?^_`{|}~\-\d]+)@(?!\.)([a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\-\.\d]+)((\.([a-zA-Z\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}]){2,63})+)$/u',
-                // @codingStandardsIgnoreEnd
-                $email_address
-            )
-        ) {
-            throw new EmailValidationException(
-                esc_html__('Email address is invalid.', 'event_espresso')
-            );
-        }
-        return true;
-    }
+	/**
+	 * @param string $email_address
+	 * @return bool
+	 * @throws EmailValidationException
+	 */
+	public function validate(string $email_address): bool
+	{
+		parent::validate($email_address);
+		// plz see http://stackoverflow.com/a/24817336 re: the following regex
+		if (
+			! preg_match(
+			// @codingStandardsIgnoreStart
+				'/^(?!\.)((?!.*\.{2})[a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\.!#$%&\'*+-\/=?^_`{|}~\-\d]+)@(?!\.)([a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\-\.\d]+)((\.([a-zA-Z\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}]){2,63})+)$/u',
+				// @codingStandardsIgnoreEnd
+				$email_address
+			)
+		) {
+			throw new EmailValidationException(
+				esc_html__('Email address is invalid.', 'event_espresso')
+			);
+		}
+		return true;
+	}
 }