eventespresso / event-espresso-core

core/domain/services/admin/events/editor/ui/PermalinkHtmlHook.php

Indentation +5 added lines, -5 removed lines

@@ -4,11 +4,11 @@
 
 abstract class PermalinkHtmlHook
 {
-    public static function addEventEditorPermalinkButton(int $priority = 10, int $accepted_args = 2)
-    {
-        add_filter('get_sample_permalink_html', [get_called_class(), 'addButton'], $priority, $accepted_args);
-    }
+	public static function addEventEditorPermalinkButton(int $priority = 10, int $accepted_args = 2)
+	{
+		add_filter('get_sample_permalink_html', [get_called_class(), 'addButton'], $priority, $accepted_args);
+	}
 
 
-    abstract public static function addButton(string $html, int $post_id): string;
+	abstract public static function addButton(string $html, int $post_id): string;
 }

core/domain/services/licensing/LicenseKeysAdminForm.php

Indentation +98 added lines, -98 removed lines

@@ -13,107 +13,107 @@
 
 class LicenseKeysAdminForm extends FormHandler
 {
-    public function __construct(EE_Registry $registry)
-    {
-        parent::__construct(
-            LICENSE_KEYS_LABEL,
-            LICENSE_KEYS_LABEL,
-            LICENSE_KEYS_PG_SLUG,
-            '',
-            FormHandler::DO_NOT_SETUP_FORM,
-            $registry
-        );
-    }
+	public function __construct(EE_Registry $registry)
+	{
+		parent::__construct(
+			LICENSE_KEYS_LABEL,
+			LICENSE_KEYS_LABEL,
+			LICENSE_KEYS_PG_SLUG,
+			'',
+			FormHandler::DO_NOT_SETUP_FORM,
+			$registry
+		);
+	}
 
 
-    /**
-     * @throws EE_Error
-     */
-    public function generate(): EE_Form_Section_Proper
-    {
-        $subsections = (array) apply_filters('FHEE__LicenseKeysAdminForm__generate__form_subsections', []);
-        ksort($subsections);
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => 'license_keys_admin_form',
-                'html_id'         => 'license_keys_admin_form',
-                'layout_strategy' => new EE_No_Layout(),
-                'subsections'     => $this->addCoreSupportLicenseKey($subsections),
-            ]
-        );
-    }
+	/**
+	 * @throws EE_Error
+	 */
+	public function generate(): EE_Form_Section_Proper
+	{
+		$subsections = (array) apply_filters('FHEE__LicenseKeysAdminForm__generate__form_subsections', []);
+		ksort($subsections);
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => 'license_keys_admin_form',
+				'html_id'         => 'license_keys_admin_form',
+				'layout_strategy' => new EE_No_Layout(),
+				'subsections'     => $this->addCoreSupportLicenseKey($subsections),
+			]
+		);
+	}
 
 
-    private function addCoreSupportLicenseKey(array $subsections): array
-    {
-        // we want to move the license key input for core to a different location,
-        // so to do that we need to copy it, delete the old location, then add re-add to the form
-        $core_license_key = $subsections['event_espresso_core'] ?? null;
-        unset($subsections['event_espresso_core']);
-        $new_subsections = [
-            'license_keys_hdr'           => new EE_Form_Section_HTML(
-                EEH_HTML::h1(
-                    esc_html__('Event Espresso Core License & Support Keys', 'event_espresso'),
-                    '',
-                    'ee-admin-settings-hdr'
-                )
-            ),
-            'event_espresso_core'        => $core_license_key,
-            'support_license_notice'     => new EE_Form_Section_HTML(
-                EEH_HTML::br()
-                . EEH_HTML::div(
-                    '<span class="dashicons dashicons-sos"></span>'
-                    . EEH_HTML::span(
-                        esc_html__(
-                            'Adding a valid Support License Key will enable automatic update notifications and backend updates.',
-                            'event_espresso'
-                        )
-                    ),
-                    'support-license-notice-dv',
-                    'ee-status-outline ee-status-outline--micro ee-status-outline--info ee-status-bg--info'
-                )
-                . EEH_HTML::br()
-                . EEH_HTML::div(
-                    EEH_HTML::span(
-                        sprintf(
-                            esc_html__(
-                                'If this is a Development or Test site, %sDO NOT%s enter your Support License Key.',
-                                'event_espresso'
-                            ),
-                            '<strong>',
-                            '</strong>'
-                        )
-                    ),
-                    '',
-                    'ee-status-outline ee-status-outline--attention'
-                )
-            ),
-            'add-on-license-keys-hdr'    => new EE_Form_Section_HTML(
-                EEH_HTML::h2(
-                    esc_html__('Add-on License Keys', 'event_espresso'),
-                    '',
-                    'ee-admin-settings-hdr'
-                )
-            ),
-            'add-on-license-keys-notice' => new EE_Form_Section_HTML(
-                EEH_HTML::div(
-                    EEH_HTML::span(
-                        esc_html__(
-                            'Please activate an Event Espresso Core support license key first in order to activate your add-on license keys',
-                            'event_espresso'
-                        )
-                    ),
-                    'add-on-license-keys-notice-dv',
-                    'ee-status-outline ee-status-outline--micro ee-status-bg--attention',
-                    'display: none;'
-                )
-            ),
-        ];
+	private function addCoreSupportLicenseKey(array $subsections): array
+	{
+		// we want to move the license key input for core to a different location,
+		// so to do that we need to copy it, delete the old location, then add re-add to the form
+		$core_license_key = $subsections['event_espresso_core'] ?? null;
+		unset($subsections['event_espresso_core']);
+		$new_subsections = [
+			'license_keys_hdr'           => new EE_Form_Section_HTML(
+				EEH_HTML::h1(
+					esc_html__('Event Espresso Core License & Support Keys', 'event_espresso'),
+					'',
+					'ee-admin-settings-hdr'
+				)
+			),
+			'event_espresso_core'        => $core_license_key,
+			'support_license_notice'     => new EE_Form_Section_HTML(
+				EEH_HTML::br()
+				. EEH_HTML::div(
+					'<span class="dashicons dashicons-sos"></span>'
+					. EEH_HTML::span(
+						esc_html__(
+							'Adding a valid Support License Key will enable automatic update notifications and backend updates.',
+							'event_espresso'
+						)
+					),
+					'support-license-notice-dv',
+					'ee-status-outline ee-status-outline--micro ee-status-outline--info ee-status-bg--info'
+				)
+				. EEH_HTML::br()
+				. EEH_HTML::div(
+					EEH_HTML::span(
+						sprintf(
+							esc_html__(
+								'If this is a Development or Test site, %sDO NOT%s enter your Support License Key.',
+								'event_espresso'
+							),
+							'<strong>',
+							'</strong>'
+						)
+					),
+					'',
+					'ee-status-outline ee-status-outline--attention'
+				)
+			),
+			'add-on-license-keys-hdr'    => new EE_Form_Section_HTML(
+				EEH_HTML::h2(
+					esc_html__('Add-on License Keys', 'event_espresso'),
+					'',
+					'ee-admin-settings-hdr'
+				)
+			),
+			'add-on-license-keys-notice' => new EE_Form_Section_HTML(
+				EEH_HTML::div(
+					EEH_HTML::span(
+						esc_html__(
+							'Please activate an Event Espresso Core support license key first in order to activate your add-on license keys',
+							'event_espresso'
+						)
+					),
+					'add-on-license-keys-notice-dv',
+					'ee-status-outline ee-status-outline--micro ee-status-bg--attention',
+					'display: none;'
+				)
+			),
+		];
 
-        if ($core_license_key instanceof LicenseKeyFormInput && $core_license_key->get_default()) {
-            unset($new_subsections['support_license_notice']);
-            unset($new_subsections['add-on-license-keys-notice']);
-        }
-        return EEH_Array::insert_into_array($subsections, $new_subsections);
-    }
+		if ($core_license_key instanceof LicenseKeyFormInput && $core_license_key->get_default()) {
+			unset($new_subsections['support_license_notice']);
+			unset($new_subsections['add-on-license-keys-notice']);
+		}
+		return EEH_Array::insert_into_array($subsections, $new_subsections);
+	}
 }

core/domain/services/licensing/LicenseStatus.php

Indentation +74 added lines, -74 removed lines

@@ -4,90 +4,90 @@
 
 class LicenseStatus
 {
-    public static function statusNotice(?string $license_status): string
-    {
-        if (empty($license_status)) {
-            return "<span class='ee-status-pill'></span>";
-        }
-        $class = self::statusClass($license_status);
-        $icon = self::statusIcon($license_status);
-        $notice = self::statusMessage($license_status);
-        return "<span class='ee-status-pill ee-status-bg--$class'><span class='ee-license-status'>$notice</span>&nbsp;&nbsp;<span class='dashicons dashicons-$icon'></span></span>";
-    }
+	public static function statusNotice(?string $license_status): string
+	{
+		if (empty($license_status)) {
+			return "<span class='ee-status-pill'></span>";
+		}
+		$class = self::statusClass($license_status);
+		$icon = self::statusIcon($license_status);
+		$notice = self::statusMessage($license_status);
+		return "<span class='ee-status-pill ee-status-bg--$class'><span class='ee-license-status'>$notice</span>&nbsp;&nbsp;<span class='dashicons dashicons-$icon'></span></span>";
+	}
 
-    public static function statusMessages(): array
-    {
-        return [
-            "deactivated"           => esc_html__("license key deactivated", 'event_espresso'),
-            "disabled"              => esc_html__("license key revoked", 'event_espresso'),
-            "expired"               => esc_html__("license has expired", 'event_espresso'),
-            "inactive"              => esc_html__("inactive license key", 'event_espresso'),
-            "invalid"               => esc_html__("invalid license key", 'event_espresso'),
-            "invalid_item_id"       => esc_html__("invalid item ID", 'event_espresso'),
-            "item_name_mismatch"    => esc_html__("invalid license for plugin", 'event_espresso'),
-            "key_mismatch"          => esc_html__("invalid license for plugin", 'event_espresso'),
-            "license_not_activable" => esc_html__("attempting to activate a bundle's parent license", 'event_espresso'),
-            "missing"               => esc_html__("no license found", 'event_espresso'),
-            "missing_url"           => esc_html__("site URL not found", 'event_espresso'),
-            "no_activations_left"   => esc_html__("no activations left", 'event_espresso'),
-            "site_inactive"         => esc_html__("site is not active for this license", 'event_espresso'),
-            "valid"                 => esc_html__("valid license key", 'event_espresso'),
-        ];
-    }
+	public static function statusMessages(): array
+	{
+		return [
+			"deactivated"           => esc_html__("license key deactivated", 'event_espresso'),
+			"disabled"              => esc_html__("license key revoked", 'event_espresso'),
+			"expired"               => esc_html__("license has expired", 'event_espresso'),
+			"inactive"              => esc_html__("inactive license key", 'event_espresso'),
+			"invalid"               => esc_html__("invalid license key", 'event_espresso'),
+			"invalid_item_id"       => esc_html__("invalid item ID", 'event_espresso'),
+			"item_name_mismatch"    => esc_html__("invalid license for plugin", 'event_espresso'),
+			"key_mismatch"          => esc_html__("invalid license for plugin", 'event_espresso'),
+			"license_not_activable" => esc_html__("attempting to activate a bundle's parent license", 'event_espresso'),
+			"missing"               => esc_html__("no license found", 'event_espresso'),
+			"missing_url"           => esc_html__("site URL not found", 'event_espresso'),
+			"no_activations_left"   => esc_html__("no activations left", 'event_espresso'),
+			"site_inactive"         => esc_html__("site is not active for this license", 'event_espresso'),
+			"valid"                 => esc_html__("valid license key", 'event_espresso'),
+		];
+	}
 
-    public static function statusMessage(?string $license_status): string
-    {
-        $license_statuses = self::statusMessages();
-        return $license_statuses[ $license_status ] ?? esc_html__("An unknown error occurred", 'event_espresso');
-    }
+	public static function statusMessage(?string $license_status): string
+	{
+		$license_statuses = self::statusMessages();
+		return $license_statuses[ $license_status ] ?? esc_html__("An unknown error occurred", 'event_espresso');
+	}
 
 
-    public static function statusClass(?string $license_status): string
-    {
-        switch ($license_status) {
-            case "valid":
-                return "active";
+	public static function statusClass(?string $license_status): string
+	{
+		switch ($license_status) {
+			case "valid":
+				return "active";
 
-            case "deactivated":
-            case "expired":
-            case "inactive":
-            case "site_inactive":
-                return "inactive";
+			case "deactivated":
+			case "expired":
+			case "inactive":
+			case "site_inactive":
+				return "inactive";
 
-            case "no_activations_left":
-                return "attention";
+			case "no_activations_left":
+				return "attention";
 
-            case "disabled":
-            case "revoked":
-            case "invalid":
-            case "item_name_mismatch":
-            case "missing":
-            default:
-                return "error";
-        }
-    }
+			case "disabled":
+			case "revoked":
+			case "invalid":
+			case "item_name_mismatch":
+			case "missing":
+			default:
+				return "error";
+		}
+	}
 
 
-    public static function statusIcon(?string $license_status): string
-    {
-        switch ($license_status) {
-            case "valid":
-                return "yes-alt";
+	public static function statusIcon(?string $license_status): string
+	{
+		switch ($license_status) {
+			case "valid":
+				return "yes-alt";
 
-            case "expired":
-            case "site_inactive":
-                return "clock";
+			case "expired":
+			case "site_inactive":
+				return "clock";
 
-            case "disabled":
-            case "revoked":
-            case "invalid":
-            case "item_name_mismatch":
-            case "no_activations_left":
-                return "warning";
+			case "disabled":
+			case "revoked":
+			case "invalid":
+			case "item_name_mismatch":
+			case "no_activations_left":
+				return "warning";
 
-            case "missing":
-            default:
-                return "editor-help";
-        }
-    }
+			case "missing":
+			default:
+				return "editor-help";
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
     public static function statusMessage(?string $license_status): string
     {
         $license_statuses = self::statusMessages();
-        return $license_statuses[ $license_status ] ?? esc_html__("An unknown error occurred", 'event_espresso');
+        return $license_statuses[$license_status] ?? esc_html__("An unknown error occurred", 'event_espresso');
     }
 
 

core/domain/services/licensing/LicenseDataEDD.php

Indentation +31 added lines, -31 removed lines

@@ -15,45 +15,45 @@
  */
 class LicenseDataEDD implements LicenseDataStrategy
 {
-    private LicenseKeyData $license_key_data;
+	private LicenseKeyData $license_key_data;
 
-    private string $status;
+	private string $status;
 
-    private string $expiry;
+	private string $expiry;
 
 
-    /**
-     * @param LicenseKeyData $license_key_data
-     */
-    public function __construct(LicenseKeyData $license_key_data)
-    {
-        $this->license_key_data = $license_key_data;
-    }
+	/**
+	 * @param LicenseKeyData $license_key_data
+	 */
+	public function __construct(LicenseKeyData $license_key_data)
+	{
+		$this->license_key_data = $license_key_data;
+	}
 
 
-    public function loadLicenseData()
-    {
-        $license_data = $this->license_key_data->getLicenseDataForPlugin(Domain::pluginSlug());
-        if (! isset($license_data->license)) {
-            $this->status = LicenseData::LICENSE_EXPIRED;
-            $this->expiry = '';
-            return;
-        }
-        $this->status = $license_data->license_key && $license_data->license === LicenseData::LICENSE_VALID
-            ? LicenseData::LICENSE_ACTIVE
-            : LicenseData::LICENSE_EXPIRED;
-        $this->expiry = $license_data->expires ?? '';
-    }
+	public function loadLicenseData()
+	{
+		$license_data = $this->license_key_data->getLicenseDataForPlugin(Domain::pluginSlug());
+		if (! isset($license_data->license)) {
+			$this->status = LicenseData::LICENSE_EXPIRED;
+			$this->expiry = '';
+			return;
+		}
+		$this->status = $license_data->license_key && $license_data->license === LicenseData::LICENSE_VALID
+			? LicenseData::LICENSE_ACTIVE
+			: LicenseData::LICENSE_EXPIRED;
+		$this->expiry = $license_data->expires ?? '';
+	}
 
 
-    public function getLicenseStatus(): string
-    {
-        return $this->status;
-    }
+	public function getLicenseStatus(): string
+	{
+		return $this->status;
+	}
 
 
-    public function getLicenseExpiry(): string
-    {
-        return $this->expiry;
-    }
+	public function getLicenseExpiry(): string
+	{
+		return $this->expiry;
+	}
 }

core/domain/services/licensing/LicenseDataStrategy.php

Indentation +3 added lines, -3 removed lines

@@ -4,11 +4,11 @@
 
 interface LicenseDataStrategy
 {
-    public function loadLicenseData();
+	public function loadLicenseData();
 
 
-    public function getLicenseStatus(): string;
+	public function getLicenseStatus(): string;
 
 
-    public function getLicenseExpiry(): string;
+	public function getLicenseExpiry(): string;
 }

core/domain/services/converters/RestApiSpoofer.php

Indentation +110 added lines, -110 removed lines

@@ -29,126 +29,126 @@
  */
 class RestApiSpoofer
 {
-    protected EED_Core_Rest_Api $rest_module;
+	protected EED_Core_Rest_Api $rest_module;
 
-    protected Read $rest_controller;
+	protected Read $rest_controller;
 
-    protected WP_REST_Server $wp_rest_server;
+	protected WP_REST_Server $wp_rest_server;
 
 
-    /**
-     * RestApiSpoofer constructor.
-     *
-     * @param WP_REST_Server    $wp_rest_server
-     * @param EED_Core_Rest_Api $rest_module
-     * @param Read              $rest_api
-     * @param string            $api_version
-     */
-    public function __construct(
-        WP_REST_Server $wp_rest_server,
-        EED_Core_Rest_Api $rest_module,
-        Read $rest_api,
-        string $api_version = '4.8.36'
-    ) {
-        $this->wp_rest_server  = $wp_rest_server;
-        $this->rest_module     = $rest_module;
-        $this->rest_controller = $rest_api;
-        $this->rest_controller->setRequestedVersion($api_version);
-        $this->setUpRestServer();
-    }
+	/**
+	 * RestApiSpoofer constructor.
+	 *
+	 * @param WP_REST_Server    $wp_rest_server
+	 * @param EED_Core_Rest_Api $rest_module
+	 * @param Read              $rest_api
+	 * @param string            $api_version
+	 */
+	public function __construct(
+		WP_REST_Server $wp_rest_server,
+		EED_Core_Rest_Api $rest_module,
+		Read $rest_api,
+		string $api_version = '4.8.36'
+	) {
+		$this->wp_rest_server  = $wp_rest_server;
+		$this->rest_module     = $rest_module;
+		$this->rest_controller = $rest_api;
+		$this->rest_controller->setRequestedVersion($api_version);
+		$this->setUpRestServer();
+	}
 
 
-    private function setUpRestServer()
-    {
-        /* @var WP_REST_Server $wp_rest_server */
-        global $wp_rest_server;
-        $wp_rest_server = $this->wp_rest_server;
-        EED_Core_Rest_Api::set_hooks_both();
-        do_action('rest_api_init', $this->wp_rest_server);
-    }
+	private function setUpRestServer()
+	{
+		/* @var WP_REST_Server $wp_rest_server */
+		global $wp_rest_server;
+		$wp_rest_server = $this->wp_rest_server;
+		EED_Core_Rest_Api::set_hooks_both();
+		do_action('rest_api_init', $this->wp_rest_server);
+	}
 
 
-    /**
-     * @param EEM_Base $model
-     * @param array    $query_params
-     * @param string   $include
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws RestPasswordIncorrectException
-     * @throws RestPasswordRequiredException
-     * @throws UnexpectedEntityException
-     * @throws DomainException
-     * @since 5.0.0.p
-     */
-    public function getOneApiResult(EEM_Base $model, array $query_params, string $include = '')
-    {
-        if (! array_key_exists('limit', $query_params)) {
-            $query_params['limit'] = 1;
-        }
-        $result = $this->getApiResults($model, $query_params, $include);
-        return $result[0] ?? [];
-    }
+	/**
+	 * @param EEM_Base $model
+	 * @param array    $query_params
+	 * @param string   $include
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws RestPasswordIncorrectException
+	 * @throws RestPasswordRequiredException
+	 * @throws UnexpectedEntityException
+	 * @throws DomainException
+	 * @since 5.0.0.p
+	 */
+	public function getOneApiResult(EEM_Base $model, array $query_params, string $include = '')
+	{
+		if (! array_key_exists('limit', $query_params)) {
+			$query_params['limit'] = 1;
+		}
+		$result = $this->getApiResults($model, $query_params, $include);
+		return $result[0] ?? [];
+	}
 
 
-    /**
-     * @param EEM_Base $model
-     * @param array    $query_params
-     * @param string   $include
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws RestPasswordIncorrectException
-     * @throws RestPasswordRequiredException
-     * @throws UnexpectedEntityException
-     * @throws DomainException
-     * @since 5.0.0.p
-     */
-    public function getApiResults(EEM_Base $model, array $query_params, string $include = ''): array
-    {
-        if (! array_key_exists('caps', $query_params)) {
-            $query_params['caps'] = EEM_Base::caps_read_admin;
-        }
-        if (! array_key_exists('default_where_conditions', $query_params)) {
-            $query_params['default_where_conditions'] = 'none';
-        }
-        /** @type array $results */
-        $results      = $model->get_all_wpdb_results($query_params);
-        $rest_request = new WP_REST_Request();
-        $rest_request->set_param('include', $include);
-        $rest_request->set_param('caps', 'edit');
-        $nice_results = [];
-        foreach ($results as $result) {
-            $nice_results[] = $this->rest_controller->createEntityFromWpdbResult(
-                $model,
-                $result,
-                $rest_request
-            );
-        }
-        return $nice_results;
-    }
+	/**
+	 * @param EEM_Base $model
+	 * @param array    $query_params
+	 * @param string   $include
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws RestPasswordIncorrectException
+	 * @throws RestPasswordRequiredException
+	 * @throws UnexpectedEntityException
+	 * @throws DomainException
+	 * @since 5.0.0.p
+	 */
+	public function getApiResults(EEM_Base $model, array $query_params, string $include = ''): array
+	{
+		if (! array_key_exists('caps', $query_params)) {
+			$query_params['caps'] = EEM_Base::caps_read_admin;
+		}
+		if (! array_key_exists('default_where_conditions', $query_params)) {
+			$query_params['default_where_conditions'] = 'none';
+		}
+		/** @type array $results */
+		$results      = $model->get_all_wpdb_results($query_params);
+		$rest_request = new WP_REST_Request();
+		$rest_request->set_param('include', $include);
+		$rest_request->set_param('caps', 'edit');
+		$nice_results = [];
+		foreach ($results as $result) {
+			$nice_results[] = $this->rest_controller->createEntityFromWpdbResult(
+				$model,
+				$result,
+				$rest_request
+			);
+		}
+		return $nice_results;
+	}
 
 
-    /**
-     * @param string $endpoint
-     * @return array
-     * @since 5.0.0.p
-     */
-    public function getModelSchema(string $endpoint)
-    {
-        $response = $this->wp_rest_server->dispatch(
-            new WP_REST_Request('OPTIONS', "/ee/v4.8.36/$endpoint")
-        );
-        return $response->get_data();
-    }
+	/**
+	 * @param string $endpoint
+	 * @return array
+	 * @since 5.0.0.p
+	 */
+	public function getModelSchema(string $endpoint)
+	{
+		$response = $this->wp_rest_server->dispatch(
+			new WP_REST_Request('OPTIONS', "/ee/v4.8.36/$endpoint")
+		);
+		return $response->get_data();
+	}
 }

core/domain/services/contexts/RequestTypeContextDetector.php

Indentation +280 added lines, -280 removed lines

@@ -18,284 +18,284 @@
  */
 class RequestTypeContextDetector
 {
-    private GraphQLEndpoint $gql_endpoint;
-
-    private RequestTypeContextFactoryInterface $factory;
-
-    private RequestInterface $request;
-
-    private array $globalRouteConditions;
-
-    private string $permalink_prefix;
-
-
-    /**
-     * RequestTypeContextDetector constructor.
-     *
-     * @param GraphQLEndpoint                    $gql_endpoint
-     * @param RequestInterface                   $request
-     * @param RequestTypeContextFactoryInterface $factory
-     * @param array                              $globalRouteConditions an array for injecting values that would
-     *                                                                  otherwise be defined as global constants
-     *                                                                  or other global variables for the current
-     *                                                                  request route such as DOING_AJAX
-     */
-    public function __construct(
-        GraphQLEndpoint $gql_endpoint,
-        RequestInterface $request,
-        RequestTypeContextFactoryInterface $factory,
-        array $globalRouteConditions = []
-    ) {
-        $this->gql_endpoint = $gql_endpoint;
-        $this->request = $request;
-        $this->factory = $factory;
-        $this->globalRouteConditions = $globalRouteConditions;
-        $permalink_structure = ltrim((string) get_option('permalink_structure'), '/');
-        $this->permalink_prefix = strpos($permalink_structure, 'index.php') === 0 ? '/index.php/' : '';
-    }
-
-
-    /**
-     * @param string $globalRouteCondition
-     * @param mixed  $default
-     * @return mixed
-     */
-    private function getGlobalRouteCondition(string $globalRouteCondition, $default = false)
-    {
-        return $this->globalRouteConditions[ $globalRouteCondition ] ?? $default;
-    }
-
-
-    /**
-     * @return RequestTypeContext
-     * @throws InvalidArgumentException
-     */
-    public function detectRequestTypeContext(): RequestTypeContext
-    {
-        // Detect error scrapes
-        if ($this->isWordPressErrorScrape()) {
-            return $this->factory->create(RequestTypeContext::WP_SCRAPE);
-        }
-        // Detect activations
-        if ($this->isWordPressActivationRequest()) {
-            return $this->factory->create(RequestTypeContext::ACTIVATION);
-        }
-        // Detect EE REST API
-        if ($this->isEspressoRestApiRequest()) {
-            return $this->factory->create(RequestTypeContext::API);
-        }
-        // Detect WP REST API
-        if ($this->isWordPressRestApiRequest()) {
-            return $this->factory->create(RequestTypeContext::WP_API);
-        }
-        // Detect EE GraphQL
-        if ($this->isEspressoGraphQLRequest()) {
-            return $this->factory->create(RequestTypeContext::GQL);
-        }
-        // Detect AJAX
-        if ($this->getGlobalRouteCondition('DOING_AJAX')) {
-            return $this->isAjaxRequest();
-        }
-        // Detect WP_Cron
-        if ($this->isCronRequest()) {
-            return $this->factory->create(RequestTypeContext::CRON);
-        }
-        // Detect command line requests
-        if ($this->getGlobalRouteCondition('WP_CLI')) {
-            return $this->factory->create(RequestTypeContext::CLI);
-        }
-        // detect WordPress admin (ie: "Dashboard")
-        if ($this->getGlobalRouteCondition('is_admin')) {
-            return $this->factory->create(RequestTypeContext::ADMIN);
-        }
-        // Detect iFrames
-        if ($this->isIframeRoute()) {
-            return $this->factory->create(RequestTypeContext::IFRAME);
-        }
-        // Detect Feeds
-        if ($this->isFeedRequest()) {
-            return $this->factory->create(RequestTypeContext::FEED);
-        }
-        // and by process of elimination...
-        return $this->factory->create(RequestTypeContext::FRONTEND);
-    }
-
-
-    /**
-     * @return RequestTypeContext
-     */
-    private function isAjaxRequest(): RequestTypeContext
-    {
-        if (
-            $this->request->getRequestParam('ee_front_ajax', false, 'bool')
-            || $this->request->getRequestParam('data[ee_front_ajax]', false, 'bool')
-        ) {
-            if (! defined('EE_FRONT_AJAX')) {
-                define('EE_FRONT_AJAX', true);
-            }
-            if (! defined('EE_ADMIN_AJAX')) {
-                define('EE_ADMIN_AJAX', false);
-            }
-            return $this->factory->create(RequestTypeContext::AJAX_FRONT);
-        }
-        if (
-            $this->request->getRequestParam('ee_admin_ajax', false, 'bool')
-            || $this->request->getRequestParam('data[ee_admin_ajax]', false, 'bool')
-        ) {
-            if (! defined('EE_ADMIN_AJAX')) {
-                define('EE_ADMIN_AJAX', true);
-            }
-            if (! defined('EE_FRONT_AJAX')) {
-                define('EE_FRONT_AJAX', false);
-            }
-            return $this->factory->create(RequestTypeContext::AJAX_ADMIN);
-        }
-        if ($this->request->getRequestParam('action') === 'heartbeat') {
-            return $this->factory->create(RequestTypeContext::AJAX_HEARTBEAT);
-        }
-        return $this->factory->create(RequestTypeContext::AJAX_OTHER);
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isWordPressErrorScrape(): bool
-    {
-        return (
-            $this->request->getRequestParam('wp_scrape_key') !== ''
-            && $this->request->getRequestParam('wp_scrape_nonce') !== ''
-        ) || (
-            $this->request->getRequestParam('action') === 'error_scrape'
-            && $this->request->getRequestParam('_wpnonce') !== ''
-        );
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isWordPressActivationRequest(): bool
-    {
-        $action = $this->request->getRequestParam('action');
-        $plugins_page_actions = [
-            'true',
-            'activate',
-            'activate-multi',
-            'activate-selected',
-            'deactivate',
-            'deactivate-multi',
-            'deactivate-selected',
-            'delete-selected',
-            'disable-auto-update-selected',
-            'enable-auto-update-selected',
-            'update-selected',
-        ];
-        return ($this->uriPathMatches('wp-admin/update.php') && $action === 'upload-plugin')
-            || ($this->uriPathMatches('wp-admin/plugins.php') && in_array($action, $plugins_page_actions, true));
-    }
-
-
-    /**
-     * @param string $extra_path
-     * @return bool
-     */
-    private function isRestApiRequest(string $extra_path = ''): bool
-    {
-        $rest_route = $this->request->getRequestParam('rest_route');
-        return (
-            $this->request->getRequestParam('rest_route') !== ''
-            && ( $extra_path === '' || strpos($rest_route, $extra_path) !== 0 )
-        )
-        || $this->uriPathMatches(trim(rest_get_url_prefix(), '/') . $extra_path);
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isEspressoRestApiRequest(): bool
-    {
-        $api_namespace = '/' . ltrim(Domain::API_NAMESPACE, '/');
-        // Check for URLs like http://mysite.com/?rest_route=/ee... and http://mysite.com/wp-json/ee/...
-        return $this->isRestApiRequest($api_namespace);
-    }
-
-
-    /**
-     * Checks for URLs like https://mysite.com/graphql
-     *
-     * @return bool
-     */
-    private function isEspressoGraphQLRequest(): bool
-    {
-        if ($this->gql_endpoint->isGraphqlRequest()) {
-            return true;
-        }
-        $gql_endpoint = $this->gql_endpoint->getEndpoint();
-        return $this->uriPathMatches($gql_endpoint) || $this->request->requestParamIsSet($gql_endpoint);
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isWordPressRestApiRequest(): bool
-    {
-        // Check for URLs like http://mysite.com/?rest_route=/.. and http://mysite.com/wp-json/...
-        return $this->isRestApiRequest();
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isCronRequest(): bool
-    {
-        return $this->uriPathMatches('wp-cron.php');
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isFeedRequest(): bool
-    {
-        return $this->uriPathMatches('feed');
-    }
-
-
-    /**
-     * returns true if the current request URI starts with the supplied $component string
-     *
-     * @param string $component
-     * @return bool
-     */
-    private function uriPathMatches(string $component): bool
-    {
-        $request_uri = $this->request->requestUri(true);
-        // remove permalink /index.php/ prefix if present
-        if (substr($request_uri, 0, strlen($this->permalink_prefix)) === $this->permalink_prefix) {
-            $request_uri = substr($request_uri, strlen($this->permalink_prefix));
-        }
-        $parts = explode('?', $request_uri);
-        $path = trim(reset($parts), '/');
-        return strpos($path, $component) === 0;
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isIframeRoute(): bool
-    {
-        $is_iframe_route = apply_filters(
-            'FHEE__EventEspresso_core_domain_services_contexts_RequestTypeContextDetector__isIframeRoute',
-            $this->request->getRequestParam('event_list', '') === 'iframe'
-            || $this->request->getRequestParam('ticket_selector', '') === 'iframe'
-            || $this->request->getRequestParam('calendar', '') === 'iframe',
-            $this
-        );
-        return filter_var($is_iframe_route, FILTER_VALIDATE_BOOLEAN);
-    }
+	private GraphQLEndpoint $gql_endpoint;
+
+	private RequestTypeContextFactoryInterface $factory;
+
+	private RequestInterface $request;
+
+	private array $globalRouteConditions;
+
+	private string $permalink_prefix;
+
+
+	/**
+	 * RequestTypeContextDetector constructor.
+	 *
+	 * @param GraphQLEndpoint                    $gql_endpoint
+	 * @param RequestInterface                   $request
+	 * @param RequestTypeContextFactoryInterface $factory
+	 * @param array                              $globalRouteConditions an array for injecting values that would
+	 *                                                                  otherwise be defined as global constants
+	 *                                                                  or other global variables for the current
+	 *                                                                  request route such as DOING_AJAX
+	 */
+	public function __construct(
+		GraphQLEndpoint $gql_endpoint,
+		RequestInterface $request,
+		RequestTypeContextFactoryInterface $factory,
+		array $globalRouteConditions = []
+	) {
+		$this->gql_endpoint = $gql_endpoint;
+		$this->request = $request;
+		$this->factory = $factory;
+		$this->globalRouteConditions = $globalRouteConditions;
+		$permalink_structure = ltrim((string) get_option('permalink_structure'), '/');
+		$this->permalink_prefix = strpos($permalink_structure, 'index.php') === 0 ? '/index.php/' : '';
+	}
+
+
+	/**
+	 * @param string $globalRouteCondition
+	 * @param mixed  $default
+	 * @return mixed
+	 */
+	private function getGlobalRouteCondition(string $globalRouteCondition, $default = false)
+	{
+		return $this->globalRouteConditions[ $globalRouteCondition ] ?? $default;
+	}
+
+
+	/**
+	 * @return RequestTypeContext
+	 * @throws InvalidArgumentException
+	 */
+	public function detectRequestTypeContext(): RequestTypeContext
+	{
+		// Detect error scrapes
+		if ($this->isWordPressErrorScrape()) {
+			return $this->factory->create(RequestTypeContext::WP_SCRAPE);
+		}
+		// Detect activations
+		if ($this->isWordPressActivationRequest()) {
+			return $this->factory->create(RequestTypeContext::ACTIVATION);
+		}
+		// Detect EE REST API
+		if ($this->isEspressoRestApiRequest()) {
+			return $this->factory->create(RequestTypeContext::API);
+		}
+		// Detect WP REST API
+		if ($this->isWordPressRestApiRequest()) {
+			return $this->factory->create(RequestTypeContext::WP_API);
+		}
+		// Detect EE GraphQL
+		if ($this->isEspressoGraphQLRequest()) {
+			return $this->factory->create(RequestTypeContext::GQL);
+		}
+		// Detect AJAX
+		if ($this->getGlobalRouteCondition('DOING_AJAX')) {
+			return $this->isAjaxRequest();
+		}
+		// Detect WP_Cron
+		if ($this->isCronRequest()) {
+			return $this->factory->create(RequestTypeContext::CRON);
+		}
+		// Detect command line requests
+		if ($this->getGlobalRouteCondition('WP_CLI')) {
+			return $this->factory->create(RequestTypeContext::CLI);
+		}
+		// detect WordPress admin (ie: "Dashboard")
+		if ($this->getGlobalRouteCondition('is_admin')) {
+			return $this->factory->create(RequestTypeContext::ADMIN);
+		}
+		// Detect iFrames
+		if ($this->isIframeRoute()) {
+			return $this->factory->create(RequestTypeContext::IFRAME);
+		}
+		// Detect Feeds
+		if ($this->isFeedRequest()) {
+			return $this->factory->create(RequestTypeContext::FEED);
+		}
+		// and by process of elimination...
+		return $this->factory->create(RequestTypeContext::FRONTEND);
+	}
+
+
+	/**
+	 * @return RequestTypeContext
+	 */
+	private function isAjaxRequest(): RequestTypeContext
+	{
+		if (
+			$this->request->getRequestParam('ee_front_ajax', false, 'bool')
+			|| $this->request->getRequestParam('data[ee_front_ajax]', false, 'bool')
+		) {
+			if (! defined('EE_FRONT_AJAX')) {
+				define('EE_FRONT_AJAX', true);
+			}
+			if (! defined('EE_ADMIN_AJAX')) {
+				define('EE_ADMIN_AJAX', false);
+			}
+			return $this->factory->create(RequestTypeContext::AJAX_FRONT);
+		}
+		if (
+			$this->request->getRequestParam('ee_admin_ajax', false, 'bool')
+			|| $this->request->getRequestParam('data[ee_admin_ajax]', false, 'bool')
+		) {
+			if (! defined('EE_ADMIN_AJAX')) {
+				define('EE_ADMIN_AJAX', true);
+			}
+			if (! defined('EE_FRONT_AJAX')) {
+				define('EE_FRONT_AJAX', false);
+			}
+			return $this->factory->create(RequestTypeContext::AJAX_ADMIN);
+		}
+		if ($this->request->getRequestParam('action') === 'heartbeat') {
+			return $this->factory->create(RequestTypeContext::AJAX_HEARTBEAT);
+		}
+		return $this->factory->create(RequestTypeContext::AJAX_OTHER);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isWordPressErrorScrape(): bool
+	{
+		return (
+			$this->request->getRequestParam('wp_scrape_key') !== ''
+			&& $this->request->getRequestParam('wp_scrape_nonce') !== ''
+		) || (
+			$this->request->getRequestParam('action') === 'error_scrape'
+			&& $this->request->getRequestParam('_wpnonce') !== ''
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isWordPressActivationRequest(): bool
+	{
+		$action = $this->request->getRequestParam('action');
+		$plugins_page_actions = [
+			'true',
+			'activate',
+			'activate-multi',
+			'activate-selected',
+			'deactivate',
+			'deactivate-multi',
+			'deactivate-selected',
+			'delete-selected',
+			'disable-auto-update-selected',
+			'enable-auto-update-selected',
+			'update-selected',
+		];
+		return ($this->uriPathMatches('wp-admin/update.php') && $action === 'upload-plugin')
+			|| ($this->uriPathMatches('wp-admin/plugins.php') && in_array($action, $plugins_page_actions, true));
+	}
+
+
+	/**
+	 * @param string $extra_path
+	 * @return bool
+	 */
+	private function isRestApiRequest(string $extra_path = ''): bool
+	{
+		$rest_route = $this->request->getRequestParam('rest_route');
+		return (
+			$this->request->getRequestParam('rest_route') !== ''
+			&& ( $extra_path === '' || strpos($rest_route, $extra_path) !== 0 )
+		)
+		|| $this->uriPathMatches(trim(rest_get_url_prefix(), '/') . $extra_path);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isEspressoRestApiRequest(): bool
+	{
+		$api_namespace = '/' . ltrim(Domain::API_NAMESPACE, '/');
+		// Check for URLs like http://mysite.com/?rest_route=/ee... and http://mysite.com/wp-json/ee/...
+		return $this->isRestApiRequest($api_namespace);
+	}
+
+
+	/**
+	 * Checks for URLs like https://mysite.com/graphql
+	 *
+	 * @return bool
+	 */
+	private function isEspressoGraphQLRequest(): bool
+	{
+		if ($this->gql_endpoint->isGraphqlRequest()) {
+			return true;
+		}
+		$gql_endpoint = $this->gql_endpoint->getEndpoint();
+		return $this->uriPathMatches($gql_endpoint) || $this->request->requestParamIsSet($gql_endpoint);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isWordPressRestApiRequest(): bool
+	{
+		// Check for URLs like http://mysite.com/?rest_route=/.. and http://mysite.com/wp-json/...
+		return $this->isRestApiRequest();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isCronRequest(): bool
+	{
+		return $this->uriPathMatches('wp-cron.php');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isFeedRequest(): bool
+	{
+		return $this->uriPathMatches('feed');
+	}
+
+
+	/**
+	 * returns true if the current request URI starts with the supplied $component string
+	 *
+	 * @param string $component
+	 * @return bool
+	 */
+	private function uriPathMatches(string $component): bool
+	{
+		$request_uri = $this->request->requestUri(true);
+		// remove permalink /index.php/ prefix if present
+		if (substr($request_uri, 0, strlen($this->permalink_prefix)) === $this->permalink_prefix) {
+			$request_uri = substr($request_uri, strlen($this->permalink_prefix));
+		}
+		$parts = explode('?', $request_uri);
+		$path = trim(reset($parts), '/');
+		return strpos($path, $component) === 0;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isIframeRoute(): bool
+	{
+		$is_iframe_route = apply_filters(
+			'FHEE__EventEspresso_core_domain_services_contexts_RequestTypeContextDetector__isIframeRoute',
+			$this->request->getRequestParam('event_list', '') === 'iframe'
+			|| $this->request->getRequestParam('ticket_selector', '') === 'iframe'
+			|| $this->request->getRequestParam('calendar', '') === 'iframe',
+			$this
+		);
+		return filter_var($is_iframe_route, FILTER_VALIDATE_BOOLEAN);
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -62,7 +62,7 @@ 
      */
     private function getGlobalRouteCondition(string $globalRouteCondition, $default = false)
     {
-        return $this->globalRouteConditions[ $globalRouteCondition ] ?? $default;
+        return $this->globalRouteConditions[$globalRouteCondition] ?? $default;
     }
 
 
@@ -130,10 +130,10 @@ 
             $this->request->getRequestParam('ee_front_ajax', false, 'bool')
             || $this->request->getRequestParam('data[ee_front_ajax]', false, 'bool')
         ) {
-            if (! defined('EE_FRONT_AJAX')) {
+            if ( ! defined('EE_FRONT_AJAX')) {
                 define('EE_FRONT_AJAX', true);
             }
-            if (! defined('EE_ADMIN_AJAX')) {
+            if ( ! defined('EE_ADMIN_AJAX')) {
                 define('EE_ADMIN_AJAX', false);
             }
             return $this->factory->create(RequestTypeContext::AJAX_FRONT);
@@ -142,10 +142,10 @@ 
             $this->request->getRequestParam('ee_admin_ajax', false, 'bool')
             || $this->request->getRequestParam('data[ee_admin_ajax]', false, 'bool')
         ) {
-            if (! defined('EE_ADMIN_AJAX')) {
+            if ( ! defined('EE_ADMIN_AJAX')) {
                 define('EE_ADMIN_AJAX', true);
             }
-            if (! defined('EE_FRONT_AJAX')) {
+            if ( ! defined('EE_FRONT_AJAX')) {
                 define('EE_FRONT_AJAX', false);
             }
             return $this->factory->create(RequestTypeContext::AJAX_ADMIN);
@@ -205,9 +205,9 @@ 
         $rest_route = $this->request->getRequestParam('rest_route');
         return (
             $this->request->getRequestParam('rest_route') !== ''
-            && ( $extra_path === '' || strpos($rest_route, $extra_path) !== 0 )
+            && ($extra_path === '' || strpos($rest_route, $extra_path) !== 0)
         )
-        || $this->uriPathMatches(trim(rest_get_url_prefix(), '/') . $extra_path);
+        || $this->uriPathMatches(trim(rest_get_url_prefix(), '/').$extra_path);
     }
 
 
@@ -216,7 +216,7 @@ 
      */
     private function isEspressoRestApiRequest(): bool
     {
-        $api_namespace = '/' . ltrim(Domain::API_NAMESPACE, '/');
+        $api_namespace = '/'.ltrim(Domain::API_NAMESPACE, '/');
         // Check for URLs like http://mysite.com/?rest_route=/ee... and http://mysite.com/wp-json/ee/...
         return $this->isRestApiRequest($api_namespace);
     }

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
+				)
+			);
+		}
+	}
 }

core/domain/services/messages/MessageTemplateRequestData.php

Indentation +214 added lines, -214 removed lines

@@ -14,262 +14,262 @@
  */
 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('messageType', $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('messageType', $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);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
  */
 class MessageTemplateRequestData
 {
-    protected ?RequestInterface $request         = null;
+    protected ?RequestInterface $request = null;
 
     protected string $context         = '';