eventespresso / event-espresso-core

core/libraries/plugin_api/EE_Register_Widget.lib.php

Indentation +90 added lines, -90 removed lines

@@ -14,106 +14,106 @@
  */
 class EE_Register_Widget implements EEI_Plugin_API
 {
-    /**
-     * Holds values for registered widgets
-     *
-     * @var array
-     */
-    protected static $_settings = [];
+	/**
+	 * Holds values for registered widgets
+	 *
+	 * @var array
+	 */
+	protected static $_settings = [];
 
 
-    /**
-     *    Method for registering new EED_Widgets
-     *
-     * @param string $addon_name a unique identifier for this set of widgets
-     * @param array  $setup_args an array of arguments provided for registering widgets
-     * @type array widget_paths        an array of full server paths to folders containing any EED_Widgets, or to the
-     *                           EED_Widget files themselves
-     * @return bool
-     * @throws EE_Error
-     * @since    4.3.0
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
+	/**
+	 *    Method for registering new EED_Widgets
+	 *
+	 * @param string $addon_name a unique identifier for this set of widgets
+	 * @param array  $setup_args an array of arguments provided for registering widgets
+	 * @type array widget_paths        an array of full server paths to folders containing any EED_Widgets, or to the
+	 *                           EED_Widget files themselves
+	 * @return bool
+	 * @throws EE_Error
+	 * @since    4.3.0
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
 
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['widget_paths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Widgets with EE_Register_Widget::register(), you must include a "widget_id" (a unique identifier for this set of widgets), and an array containing the following keys: "widget_paths" (an array of full server paths to folders that contain widgets, or to the widget files themselves)',
-                    'event_espresso'
-                )
-            );
-        }
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['widget_paths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Widgets with EE_Register_Widget::register(), you must include a "widget_id" (a unique identifier for this set of widgets), and an array containing the following keys: "widget_paths" (an array of full server paths to folders that contain widgets, or to the widget files themselves)',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
-            return true;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $addon_name ])) {
+			return true;
+		}
 
 
-        // make sure this was called in the right place!
-        if (
-            ! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                esc_html__(
-                    'An attempt to register widgets has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register widgets.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = [
-            // array of full server paths to any EED_Widgets used by the widget
-            'widget_paths' => isset($setup_args['widget_paths']) ? (array) $setup_args['widget_paths'] : [],
-        ];
-        // add to list of widgets to be registered
-        add_filter(
-            'FHEE__EE_Config__register_widgets__widgets_to_register',
-            ['EE_Register_Widget', 'add_widgets']
-        );
-        return true;
-    }
+		// make sure this was called in the right place!
+		if (
+			! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				esc_html__(
+					'An attempt to register widgets has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register widgets.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		// setup $_settings array from incoming values.
+		self::$_settings[ $addon_name ] = [
+			// array of full server paths to any EED_Widgets used by the widget
+			'widget_paths' => isset($setup_args['widget_paths']) ? (array) $setup_args['widget_paths'] : [],
+		];
+		// add to list of widgets to be registered
+		add_filter(
+			'FHEE__EE_Config__register_widgets__widgets_to_register',
+			['EE_Register_Widget', 'add_widgets']
+		);
+		return true;
+	}
 
 
-    /**
-     * Filters the list of widgets to add ours.
-     * and they're just full filepaths to FOLDERS containing a shortcode class file. Eg.
-     * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/widgets/espresso_monkey'...)
-     *
-     * @param array $widgets_to_register array of paths to all widgets that require registering
-     * @return array
-     */
-    public static function add_widgets(array $widgets_to_register = []): array
-    {
-        $widget_paths = [];
-        foreach (self::$_settings as $settings) {
-            $widget_paths[] = $settings['widget_paths'];
-        }
-        return array_merge($widgets_to_register, ...$widget_paths);
-    }
+	/**
+	 * Filters the list of widgets to add ours.
+	 * and they're just full filepaths to FOLDERS containing a shortcode class file. Eg.
+	 * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/widgets/espresso_monkey'...)
+	 *
+	 * @param array $widgets_to_register array of paths to all widgets that require registering
+	 * @return array
+	 */
+	public static function add_widgets(array $widgets_to_register = []): array
+	{
+		$widget_paths = [];
+		foreach (self::$_settings as $settings) {
+			$widget_paths[] = $settings['widget_paths'];
+		}
+		return array_merge($widgets_to_register, ...$widget_paths);
+	}
 
 
-    /**
-     * This deregisters a widget that was previously registered with a specific $addon_name.
-     *
-     * @param string $addon_name the name for the widget that was previously registered
-     * @return void
-     * @since    4.3.0
-     *
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_settings[ $addon_name ]);
-    }
+	/**
+	 * This deregisters a widget that was previously registered with a specific $addon_name.
+	 *
+	 * @param string $addon_name the name for the widget that was previously registered
+	 * @return void
+	 * @since    4.3.0
+	 *
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_settings[ $addon_name ]);
+	}
 
 
-    public static function reset(): void
-    {
-        self::$_settings = [];
-    }
+	public static function reset(): void
+	{
+		self::$_settings = [];
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -47,7 +47,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
+        if (isset(self::$_settings[$addon_name])) {
             return true;
         }
 
@@ -67,7 +67,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = [
+        self::$_settings[$addon_name] = [
             // array of full server paths to any EED_Widgets used by the widget
             'widget_paths' => isset($setup_args['widget_paths']) ? (array) $setup_args['widget_paths'] : [],
         ];
@@ -108,7 +108,7 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_settings[ $addon_name ]);
+        unset(self::$_settings[$addon_name]);
     }
 
 

core/libraries/plugin_api/EE_Register_Privacy_Policy.lib.php

Indentation +43 added lines, -43 removed lines

@@ -12,57 +12,57 @@
  */
 class EE_Register_Privacy_Policy implements EEI_Plugin_API
 {
-    /**
-     * FQCN for all privacy policy generators
-     *
-     * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
-     */
-    protected static $privacy_policies = [];
+	/**
+	 * FQCN for all privacy policy generators
+	 *
+	 * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
+	 */
+	protected static $privacy_policies = [];
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
-     *                           OR fully qualified class names of privacy policies
-     * @return bool
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        self::$privacy_policies[ $addon_name ] = $setup_args;
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
-            ['EE_Register_Privacy_Policy', 'addPrivacyPolicies']
-        );
-        return true;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
+	 *                           OR fully qualified class names of privacy policies
+	 * @return bool
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		self::$privacy_policies[ $addon_name ] = $setup_args;
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
+			['EE_Register_Privacy_Policy', 'addPrivacyPolicies']
+		);
+		return true;
+	}
 
 
-    /**
-     * @param string $addon_name
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$privacy_policies[ $addon_name ]);
-    }
+	/**
+	 * @param string $addon_name
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$privacy_policies[ $addon_name ]);
+	}
 
 
-    /**
-     * Adds our privacy policy generators registered by add-ons
-     *
-     * @param string[] $privacy_policies
-     * @return string[]
-     */
-    public static function addPrivacyPolicies(array $privacy_policies): array
-    {
-        return array_merge($privacy_policies, ...self::$privacy_policies);
-    }
+	/**
+	 * Adds our privacy policy generators registered by add-ons
+	 *
+	 * @param string[] $privacy_policies
+	 * @return string[]
+	 */
+	public static function addPrivacyPolicies(array $privacy_policies): array
+	{
+		return array_merge($privacy_policies, ...self::$privacy_policies);
+	}
 
 
-    public static function reset(): void
-    {
-        self::$privacy_policies = [];
-    }
+	public static function reset(): void
+	{
+		self::$privacy_policies = [];
+	}
 }
 // End of file EE_Register_Privacy_Policy.lib.php
 // Location: ${NAMESPACE}/EE_Register_Privacy_Policy.lib.php

core/libraries/plugin_api/EE_Register_Config.lib.php

Indentation +107 added lines, -107 removed lines

@@ -11,124 +11,124 @@
  */
 class EE_Register_Config implements EEI_Plugin_API
 {
-    /**
-     * Holds registered EE_Config items
-     *
-     * @var array
-     */
-    protected static $_ee_config_registry = [];
+	/**
+	 * Holds registered EE_Config items
+	 *
+	 * @var array
+	 */
+	protected static $_ee_config_registry = [];
 
 
-    /**
-     * Handles registering the new config with the EE_Config::instance()->addons property
-     *
-     * @param string $addon_name    The name of the Config class being registered.
-     *                              Note this class must extend EE_Config Base and must have
-     *                              already been registered with an autoloader.
-     * @param array  $setup_args    {
-     *
-     * @type  string $config_name       Optional.  by default the new config will be registered to
-     *                                  EE_Config::instance()->addons->{config_class},
-     *                                  but supplying a "config_name" will set the property name
-     *                                  that this variable is accessible by.
-     *                                  ie: EE_Config::instance()->addons->{config_name}
-     *                              }
-     * @return bool
-     * @throws EE_Error
-     *
-     * @since    4.3.0
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
+	/**
+	 * Handles registering the new config with the EE_Config::instance()->addons property
+	 *
+	 * @param string $addon_name    The name of the Config class being registered.
+	 *                              Note this class must extend EE_Config Base and must have
+	 *                              already been registered with an autoloader.
+	 * @param array  $setup_args    {
+	 *
+	 * @type  string $config_name       Optional.  by default the new config will be registered to
+	 *                                  EE_Config::instance()->addons->{config_class},
+	 *                                  but supplying a "config_name" will set the property name
+	 *                                  that this variable is accessible by.
+	 *                                  ie: EE_Config::instance()->addons->{config_name}
+	 *                              }
+	 * @return bool
+	 * @throws EE_Error
+	 *
+	 * @since    4.3.0
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
 
-        $setup_args['config_name']    = isset($setup_args['config_name']) && ! empty($setup_args['config_name'])
-            ? $setup_args['config_name'] : $addon_name;
-        $setup_args['config_section'] = isset($setup_args['config_section']) && ! empty($setup_args['config_section'])
-            ? $setup_args['config_section'] : 'addons';
+		$setup_args['config_name']    = isset($setup_args['config_name']) && ! empty($setup_args['config_name'])
+			? $setup_args['config_name'] : $addon_name;
+		$setup_args['config_section'] = isset($setup_args['config_section']) && ! empty($setup_args['config_section'])
+			? $setup_args['config_section'] : 'addons';
 
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['config_name'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register a Config Class with EE_Register_Config::register(), you must include a "config_class" (the actual class name for this config class). As well, you can supply an array containing the following keys: "config_section" the main section of the config object the settings will be saved under (by default the new config will be registered under EE_Config::instance()->modules or EE_Config::instance()->addons depending on what type of class is calling this), "config_name" (by default the new config will be registered to EE_Config::instance()->{config_section}->{config_class}, but supplying a "config_name" will set the property name that this variable is accessible by. ie: EE_Config::instance()->{config_section}->{config_name})',
-                    'event_espresso'
-                )
-            );
-        }
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['config_name'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register a Config Class with EE_Register_Config::register(), you must include a "config_class" (the actual class name for this config class). As well, you can supply an array containing the following keys: "config_section" the main section of the config object the settings will be saved under (by default the new config will be registered under EE_Config::instance()->modules or EE_Config::instance()->addons depending on what type of class is calling this), "config_name" (by default the new config will be registered to EE_Config::instance()->{config_section}->{config_class}, but supplying a "config_name" will set the property name that this variable is accessible by. ie: EE_Config::instance()->{config_section}->{config_name})',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_ee_config_registry[ $addon_name ])) {
-            return true;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_ee_config_registry[ $addon_name ])) {
+			return true;
+		}
 
 
-        // first find out if this happened too late.
-        if (did_action('AHEE__EE_System__load_core_configuration__begin')) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'An attempt to register "%s" as an EE_Config object has failed because it was not registered at the correct hookpoint.  Please register before the "AHEE__EE_System__load_core_configuration__begin" hook has fired',
-                        'event_espresso'
-                    ),
-                    $setup_args['config_name']
-                ),
-                '4.3'
-            );
-        }
-        // add incoming stuff to our registry property
-        self::$_ee_config_registry[ $addon_name ] = [
-            'section' => $setup_args['config_section'],
-            'name'    => $setup_args['config_name'],
-        ];
+		// first find out if this happened too late.
+		if (did_action('AHEE__EE_System__load_core_configuration__begin')) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'An attempt to register "%s" as an EE_Config object has failed because it was not registered at the correct hookpoint.  Please register before the "AHEE__EE_System__load_core_configuration__begin" hook has fired',
+						'event_espresso'
+					),
+					$setup_args['config_name']
+				),
+				'4.3'
+			);
+		}
+		// add incoming stuff to our registry property
+		self::$_ee_config_registry[ $addon_name ] = [
+			'section' => $setup_args['config_section'],
+			'name'    => $setup_args['config_name'],
+		];
 
-        add_action('AHEE__EE_Config___load_core_config__end', ['EE_Register_Config', 'set_config'], 15, 1);
-        add_action('AHEE__EE_Config__update_espresso_config__end', ['EE_Register_Config', 'set_config'], 15, 1);
-        return true;
-    }
+		add_action('AHEE__EE_Config___load_core_config__end', ['EE_Register_Config', 'set_config'], 15, 1);
+		add_action('AHEE__EE_Config__update_espresso_config__end', ['EE_Register_Config', 'set_config'], 15, 1);
+		return true;
+	}
 
 
-    /**
-     * Callback for the AHEE__EE_Config___load_core_config__end hook.
-     * basically just calls EE_Config->get_config()
-     * which will take care of loading or creating our config object for us
-     *
-     * @param EE_Config $EE_Config
-     * @return void
-     * @throws EE_Error
-     * @since    4.3.0
-     */
-    public static function set_config(EE_Config $EE_Config)
-    {
-        foreach (self::$_ee_config_registry as $addon_name => $settings) {
-            // first some validation of our incoming class_name.
-            //  We'll throw an error early if its' not registered correctly
-            if (! class_exists($addon_name)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The "%s" config class can not be registered with EE_Config because it does not exist.  Verify that an autoloader has been set for this class',
-                            'event_espresso'
-                        ),
-                        $addon_name
-                    )
-                );
-            }
-            $EE_Config->get_config($settings['section'], $settings['name'], $addon_name);
-        }
-    }
+	/**
+	 * Callback for the AHEE__EE_Config___load_core_config__end hook.
+	 * basically just calls EE_Config->get_config()
+	 * which will take care of loading or creating our config object for us
+	 *
+	 * @param EE_Config $EE_Config
+	 * @return void
+	 * @throws EE_Error
+	 * @since    4.3.0
+	 */
+	public static function set_config(EE_Config $EE_Config)
+	{
+		foreach (self::$_ee_config_registry as $addon_name => $settings) {
+			// first some validation of our incoming class_name.
+			//  We'll throw an error early if its' not registered correctly
+			if (! class_exists($addon_name)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The "%s" config class can not be registered with EE_Config because it does not exist.  Verify that an autoloader has been set for this class',
+							'event_espresso'
+						),
+						$addon_name
+					)
+				);
+			}
+			$EE_Config->get_config($settings['section'], $settings['name'], $addon_name);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_ee_config_registry[ $addon_name ]);
-    }
+	/**
+	 * @param string $addon_name
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_ee_config_registry[ $addon_name ]);
+	}
 
-    public static function reset(): void
-    {
-        self::$_ee_config_registry = [];
-    }
+	public static function reset(): void
+	{
+		self::$_ee_config_registry = [];
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -57,7 +57,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_ee_config_registry[ $addon_name ])) {
+        if (isset(self::$_ee_config_registry[$addon_name])) {
             return true;
         }
 
@@ -77,7 +77,7 @@ 
             );
         }
         // add incoming stuff to our registry property
-        self::$_ee_config_registry[ $addon_name ] = [
+        self::$_ee_config_registry[$addon_name] = [
             'section' => $setup_args['config_section'],
             'name'    => $setup_args['config_name'],
         ];
@@ -103,7 +103,7 @@ 
         foreach (self::$_ee_config_registry as $addon_name => $settings) {
             // first some validation of our incoming class_name.
             //  We'll throw an error early if its' not registered correctly
-            if (! class_exists($addon_name)) {
+            if ( ! class_exists($addon_name)) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -124,7 +124,7 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_ee_config_registry[ $addon_name ]);
+        unset(self::$_ee_config_registry[$addon_name]);
     }
 
     public static function reset(): void

core/libraries/plugin_api/EE_Register_Messages_Template_Pack.lib.php

Indentation +204 added lines, -204 removed lines

@@ -10,208 +10,208 @@
  */
 class EE_Register_Messages_Template_Pack implements EEI_Plugin_API
 {
-    /**
-     * Holds values for registered template pack
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    protected static $_registry = [];
-
-
-    /**
-     * Used to register a new template pack with the messages system.
-     *
-     * Template packs are primarily defined via class extending EE_Messages_Template_Pack and are typically used to
-     * change entire layouts for a set of message templates.  This method is used to register the new template pack and
-     * automatically have it loaded in the appropriate places.
-     *
-     * This registry also verifies that there isn't already a template pack registered with the same name and if there
-     * is then it will add an EE_Error notice.
-     *
-     * Note that this only handles registering the your Template Pack class with the message template pack system.
-     * However, there is also a naming schema you must follow for templates you are providing with your template pack.
-     *
-     * @param string $addon_name The internal reference used to refer to this template pack.  Note, this is first come,
-     *                           first serve.  If there is already a template pack registered with this name then the
-     *                           registry will assign a unique reference for it so it can still be activated (but this
-     *                           makes it harder to deregister as it will be unique per load - so its best to try to
-     *                           make this a unique string!)
-     * @param array  $setup_args array {
-     *                           An array of required values for registering the template pack.
-     * @type string  $path       The path for the new template pack class.
-     * @type string  $classname  The name of the new Template Pack Class.
-     *                           }
-     * @return bool
-     * @throws EE_Error
-     *
-     * @see    core/libraries/messages/defaults/default/* for all the example templates the default template pack
-     *         supports.
-     *
-     *
-     * @since  4.5.0
-     * @see    EE_Messages_Template_Pack_Default for an example class
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-
-        // check for required params
-        if (empty($addon_name) || empty($setup_args['path']) || empty($setup_args['classname'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register a new template pack for the EE Messages system, you must include a value to reference the template pack being registered and the setup_args must have the path for the new template pack class as well as the classname for the new Template Pack Class. ',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $addon_name ])) {
-            return true;
-        }
-
-        // check that incoming $addon_name doesn't already exist. If it does then we'll create a unique reference for this template pack.
-        if (isset(self::$_registry[ $addon_name ])) {
-            $addon_name = uniqid() . '_' . $addon_name;
-        }
-
-
-        // make sure this was called in the right place!
-        if (
-            ! did_action('EE_Brewing_Regular___messages_caf')
-            || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'A EE Messages Template Pack given the reference "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular__messages_caf" hook.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                ),
-                '4.5.0'
-            );
-        }
-
-        if (self::_verify_class_not_exist($setup_args['classname'])) {
-            self::$_registry[ $addon_name ] = [
-                'path'      => (string) $setup_args['path'],
-                'classname' => (string) $setup_args['classname'],
-            ];
-        }
-
-        // hook into the system
-        add_filter(
-            'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-            ['EE_Register_Messages_Template_Pack', 'set_template_pack_path'],
-            10
-        );
-        add_filter(
-            'FHEE__EED_Messages__get_template_packs__template_packs',
-            ['EE_Register_Messages_Template_Pack', 'set_template_pack'],
-            10
-        );
-        return true;
-    }
-
-
-    /**
-     * Callback for the FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.  This adds this template packs path
-     * to the messages autoloader paths.
-     *
-     * @param array $paths Array of paths already registered with the messages autoloader
-     *
-     * @return array
-     * @since  4.5.0
-     *
-     */
-    public static function set_template_pack_path(array $paths): array
-    {
-        foreach (self::$_registry as $args) {
-            $paths[] = $args['path'];
-        }
-        return $paths;
-    }
-
-
-    /**
-     * Callback for the FHEE__EED_Messages__get_template_packs__template_packs filter. This adds the instantiated,
-     * registered template pack to the template packs array when requested by client code.
-     *
-     * @param EE_Messages_Template_Pack[] $template_packs
-     * @return EE_Messages_Template_Pack[]
-     * @since 4.5.0
-     *
-     */
-    public static function set_template_pack(array $template_packs): array
-    {
-        foreach (self::$_registry as $args) {
-            // verify class_exists
-            if (! class_exists($args['classname'])) {
-                require_once($args['path'] . '/' . $args['classname'] . '.class.php');
-            }
-
-            // check again!
-            if (class_exists($args['classname'])) {
-                $template_pack                           = new $args['classname']();
-                $template_packs[ $template_pack->dbref ] = $template_pack;
-            }
-        }
-
-        return $template_packs;
-    }
-
-
-    /**
-     * This verifies that the classes for each registered template pack are unique  names.
-     *
-     * @param string $classname The classname being checked
-     *
-     * @return bool
-     */
-    private static function _verify_class_not_exist(string $classname): bool
-    {
-        // loop through the existing registry and see if the classname is already present.
-        foreach (self::$_registry as $args) {
-            if ($args['classname'] == $classname) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The %s template pack that you just activated cannot be registered with the messages system because there is already a template pack active using the same classname.  Contact the author of this template pack to let them know of the conflict.  To stop seeing this message you will need to deactivate this template pack.',
-                            'event_espresso'
-                        ),
-                        $classname
-                    ),
-                    __FILE__,
-                    __LINE__,
-                    __FUNCTION__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This deregisters a variation set that was previously registered with the given slug.
-     *
-     * @param string $addon_name The name for the variation set that was previously registered.
-     *
-     * @return void
-     * @since 4.5.0
-     *
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_registry[ $addon_name ]);
-    }
-
-
-    public static function reset(): void
-    {
-        self::$_registry = [];
-    }
+	/**
+	 * Holds values for registered template pack
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	protected static $_registry = [];
+
+
+	/**
+	 * Used to register a new template pack with the messages system.
+	 *
+	 * Template packs are primarily defined via class extending EE_Messages_Template_Pack and are typically used to
+	 * change entire layouts for a set of message templates.  This method is used to register the new template pack and
+	 * automatically have it loaded in the appropriate places.
+	 *
+	 * This registry also verifies that there isn't already a template pack registered with the same name and if there
+	 * is then it will add an EE_Error notice.
+	 *
+	 * Note that this only handles registering the your Template Pack class with the message template pack system.
+	 * However, there is also a naming schema you must follow for templates you are providing with your template pack.
+	 *
+	 * @param string $addon_name The internal reference used to refer to this template pack.  Note, this is first come,
+	 *                           first serve.  If there is already a template pack registered with this name then the
+	 *                           registry will assign a unique reference for it so it can still be activated (but this
+	 *                           makes it harder to deregister as it will be unique per load - so its best to try to
+	 *                           make this a unique string!)
+	 * @param array  $setup_args array {
+	 *                           An array of required values for registering the template pack.
+	 * @type string  $path       The path for the new template pack class.
+	 * @type string  $classname  The name of the new Template Pack Class.
+	 *                           }
+	 * @return bool
+	 * @throws EE_Error
+	 *
+	 * @see    core/libraries/messages/defaults/default/* for all the example templates the default template pack
+	 *         supports.
+	 *
+	 *
+	 * @since  4.5.0
+	 * @see    EE_Messages_Template_Pack_Default for an example class
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+
+		// check for required params
+		if (empty($addon_name) || empty($setup_args['path']) || empty($setup_args['classname'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register a new template pack for the EE Messages system, you must include a value to reference the template pack being registered and the setup_args must have the path for the new template pack class as well as the classname for the new Template Pack Class. ',
+					'event_espresso'
+				)
+			);
+		}
+
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $addon_name ])) {
+			return true;
+		}
+
+		// check that incoming $addon_name doesn't already exist. If it does then we'll create a unique reference for this template pack.
+		if (isset(self::$_registry[ $addon_name ])) {
+			$addon_name = uniqid() . '_' . $addon_name;
+		}
+
+
+		// make sure this was called in the right place!
+		if (
+			! did_action('EE_Brewing_Regular___messages_caf')
+			|| did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'A EE Messages Template Pack given the reference "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular__messages_caf" hook.',
+						'event_espresso'
+					),
+					$addon_name
+				),
+				'4.5.0'
+			);
+		}
+
+		if (self::_verify_class_not_exist($setup_args['classname'])) {
+			self::$_registry[ $addon_name ] = [
+				'path'      => (string) $setup_args['path'],
+				'classname' => (string) $setup_args['classname'],
+			];
+		}
+
+		// hook into the system
+		add_filter(
+			'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+			['EE_Register_Messages_Template_Pack', 'set_template_pack_path'],
+			10
+		);
+		add_filter(
+			'FHEE__EED_Messages__get_template_packs__template_packs',
+			['EE_Register_Messages_Template_Pack', 'set_template_pack'],
+			10
+		);
+		return true;
+	}
+
+
+	/**
+	 * Callback for the FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.  This adds this template packs path
+	 * to the messages autoloader paths.
+	 *
+	 * @param array $paths Array of paths already registered with the messages autoloader
+	 *
+	 * @return array
+	 * @since  4.5.0
+	 *
+	 */
+	public static function set_template_pack_path(array $paths): array
+	{
+		foreach (self::$_registry as $args) {
+			$paths[] = $args['path'];
+		}
+		return $paths;
+	}
+
+
+	/**
+	 * Callback for the FHEE__EED_Messages__get_template_packs__template_packs filter. This adds the instantiated,
+	 * registered template pack to the template packs array when requested by client code.
+	 *
+	 * @param EE_Messages_Template_Pack[] $template_packs
+	 * @return EE_Messages_Template_Pack[]
+	 * @since 4.5.0
+	 *
+	 */
+	public static function set_template_pack(array $template_packs): array
+	{
+		foreach (self::$_registry as $args) {
+			// verify class_exists
+			if (! class_exists($args['classname'])) {
+				require_once($args['path'] . '/' . $args['classname'] . '.class.php');
+			}
+
+			// check again!
+			if (class_exists($args['classname'])) {
+				$template_pack                           = new $args['classname']();
+				$template_packs[ $template_pack->dbref ] = $template_pack;
+			}
+		}
+
+		return $template_packs;
+	}
+
+
+	/**
+	 * This verifies that the classes for each registered template pack are unique  names.
+	 *
+	 * @param string $classname The classname being checked
+	 *
+	 * @return bool
+	 */
+	private static function _verify_class_not_exist(string $classname): bool
+	{
+		// loop through the existing registry and see if the classname is already present.
+		foreach (self::$_registry as $args) {
+			if ($args['classname'] == $classname) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The %s template pack that you just activated cannot be registered with the messages system because there is already a template pack active using the same classname.  Contact the author of this template pack to let them know of the conflict.  To stop seeing this message you will need to deactivate this template pack.',
+							'event_espresso'
+						),
+						$classname
+					),
+					__FILE__,
+					__LINE__,
+					__FUNCTION__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This deregisters a variation set that was previously registered with the given slug.
+	 *
+	 * @param string $addon_name The name for the variation set that was previously registered.
+	 *
+	 * @return void
+	 * @since 4.5.0
+	 *
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_registry[ $addon_name ]);
+	}
+
+
+	public static function reset(): void
+	{
+		self::$_registry = [];
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -67,13 +67,13 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $addon_name ])) {
+        if (isset(self::$_registry[$addon_name])) {
             return true;
         }
 
         // check that incoming $addon_name doesn't already exist. If it does then we'll create a unique reference for this template pack.
-        if (isset(self::$_registry[ $addon_name ])) {
-            $addon_name = uniqid() . '_' . $addon_name;
+        if (isset(self::$_registry[$addon_name])) {
+            $addon_name = uniqid().'_'.$addon_name;
         }
 
 
@@ -96,7 +96,7 @@ 
         }
 
         if (self::_verify_class_not_exist($setup_args['classname'])) {
-            self::$_registry[ $addon_name ] = [
+            self::$_registry[$addon_name] = [
                 'path'      => (string) $setup_args['path'],
                 'classname' => (string) $setup_args['classname'],
             ];
@@ -149,14 +149,14 @@ 
     {
         foreach (self::$_registry as $args) {
             // verify class_exists
-            if (! class_exists($args['classname'])) {
-                require_once($args['path'] . '/' . $args['classname'] . '.class.php');
+            if ( ! class_exists($args['classname'])) {
+                require_once($args['path'].'/'.$args['classname'].'.class.php');
             }
 
             // check again!
             if (class_exists($args['classname'])) {
                 $template_pack                           = new $args['classname']();
-                $template_packs[ $template_pack->dbref ] = $template_pack;
+                $template_packs[$template_pack->dbref] = $template_pack;
             }
         }
 
@@ -206,7 +206,7 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_registry[ $addon_name ]);
+        unset(self::$_registry[$addon_name]);
     }
 
 

core/libraries/plugin_api/EE_Register_Messages_Shortcode_Library.lib.php

Indentation +176 added lines, -176 removed lines

@@ -10,180 +10,180 @@
  */
 class EE_Register_Messages_Shortcode_Library implements EEI_Plugin_API
 {
-    /**
-     * holds values for registered messages shortcode libraries
-     *
-     * @var array
-     */
-    protected static $_ee_messages_shortcode_registry = [];
-
-
-    /**
-     * Helper method for registering a new shortcodes library class for the messages system.
-     *
-     * Note this is not used for adding shortcodes to existing libraries.  It's for registering anything
-     * related to registering a new EE_{shortcode_library_name}_Shortcodes.lib.php class.
-     *
-     * @param string $addon_name    What is the name of this shortcode library (e.g. 'question_list');
-     * @param array  $setup_args    An array of arguments provided for registering the new messages shortcode library.
-     *                              {
-     *
-     * @type array $autoloadpaths                       An array of paths to add to the messages autoloader
-     *                                                  for the new shortcode library class file.
-     * @type string $msgr_validator_callback            Callback for a method that will register the library with the
-     *                                                  messenger _validator_config. Optional.
-     * @type string  $msgr_template_fields_callback     Callback for changing adding the _template_fields property for
-     *                                                  messenger. For example, the shortcode library may add a new
-     *                                                  field to the message templates. Optional.
-     * @type string  $valid_shortcodes_callback         Callback for message types _valid_shortcodes array setup.
-     *                                                  Optional.
-     * @type array $list_type_shortcodes                If there are any specific shortcodes with this message
-     *                                                  shortcode library that should be considered "list type"
-     *                                                  then include them in an array.
-     *                                                  List Type shortcodes are shortcodes that have a corresponding
-     *                                                  field that indicates how they are parsed. Optional.
-     *                              }
-     * @return bool
-     * @throws EE_Error
-     * @throws EE_Error
-     * @since    4.3.0
-     *
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['autoloadpaths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register a messages shortcode library with EE_Register_Messages_Shortcode_Library::register, you must include a "name" (a unique identifier for this set of message shortcodes), and an array containing the following keys: : "autoload_paths"',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // make sure we don't register twice
-        if (isset(self::$_ee_messages_shortcode_registry[ $addon_name ])) {
-            return true;
-        }
-
-        // make sure this was called in the right place!
-        if (
-            ! did_action('EE_Brewing_Regular___messages_caf')
-            || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'Should be only called on the "EE_Brewing_Regular___messages_caf" hook (Trying to register a library named %s).',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                ),
-                '4.3.0'
-            );
-        }
-
-        self::$_ee_messages_shortcode_registry[ $addon_name ] = [
-            'autoloadpaths'        => (array) $setup_args['autoloadpaths'],
-            'list_type_shortcodes' => ! empty($setup_args['list_type_shortcodes'])
-                ? (array) $setup_args['list_type_shortcodes'] : [],
-        ];
-
-        // add filters
-        add_filter(
-            'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-            ['EE_Register_Messages_Shortcode_Library', 'register_msgs_autoload_paths'],
-            10
-        );
-
-        // add below filters if the required callback is provided.
-        if (! empty($setup_args['msgr_validator_callback'])) {
-            add_filter('FHEE__EE_messenger__get_validator_config', $setup_args['msgr_validator_callback'], 10, 2);
-        }
-
-        if (! empty($setup_args['msgr_template_fields_callback'])) {
-            add_filter('FHEE__EE_messenger__get_template_fields', $setup_args['msgr_template_fields_callback'], 10, 2);
-        }
-
-        if (! empty($setup_args['valid_shortcodes_callback'])) {
-            add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', $setup_args['valid_shortcodes_callback'], 10, 2);
-        }
-
-        if (! empty($setup_args['list_type_shortcodes'])) {
-            add_filter(
-                'FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
-                ['EE_Register_Messages_Shortcode_Library', 'register_list_type_shortcodes'],
-                10
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * This deregisters any messages shortcode library previously registered with the given name.
-     *
-     * @param string $addon_name name used to register the shortcode library.
-     * @return  void
-     * @since    4.3.0
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_ee_messages_shortcode_registry[ $addon_name ]);
-    }
-
-
-    /**
-     * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
-     *
-     * @param array $paths array of paths to be checked by EE_messages autoloader.
-     * @return array
-     * @since    4.3.0
-     *
-     */
-    public static function register_msgs_autoload_paths(array $paths): array
-    {
-        $autoload_paths = [];
-        if (! empty(self::$_ee_messages_shortcode_registry)) {
-            foreach (self::$_ee_messages_shortcode_registry as $st_reg) {
-                if (empty($st_reg['autoloadpaths'])) {
-                    continue;
-                }
-                $autoload_paths[] = $st_reg['autoloadpaths'];
-            }
-        }
-        return array_merge($paths, ...$autoload_paths);
-    }
-
-
-    /**
-     * This is the callback for the FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes
-     * filter which is used to add additional list type shortcodes.
-     *
-     * @param array $original_shortcodes
-     * @return  array                                   Modifications to original shortcodes.
-     * @since 4.3.0
-     *
-     */
-    public static function register_list_type_shortcodes(array $original_shortcodes): array
-    {
-        if (empty(self::$_ee_messages_shortcode_registry)) {
-            return $original_shortcodes;
-        }
-        $shortcodes = [];
-        foreach (self::$_ee_messages_shortcode_registry as $sc_reg) {
-            if (! empty($sc_reg['list_type_shortcodes'])) {
-                $shortcodes[] = $sc_reg['list_type_shortcodes'];
-            }
-        }
-        return array_merge($original_shortcodes, ...$shortcodes);
-    }
-
-
-    public static function reset(): void
-    {
-        self::$_ee_messages_shortcode_registry = [];
-    }
+	/**
+	 * holds values for registered messages shortcode libraries
+	 *
+	 * @var array
+	 */
+	protected static $_ee_messages_shortcode_registry = [];
+
+
+	/**
+	 * Helper method for registering a new shortcodes library class for the messages system.
+	 *
+	 * Note this is not used for adding shortcodes to existing libraries.  It's for registering anything
+	 * related to registering a new EE_{shortcode_library_name}_Shortcodes.lib.php class.
+	 *
+	 * @param string $addon_name    What is the name of this shortcode library (e.g. 'question_list');
+	 * @param array  $setup_args    An array of arguments provided for registering the new messages shortcode library.
+	 *                              {
+	 *
+	 * @type array $autoloadpaths                       An array of paths to add to the messages autoloader
+	 *                                                  for the new shortcode library class file.
+	 * @type string $msgr_validator_callback            Callback for a method that will register the library with the
+	 *                                                  messenger _validator_config. Optional.
+	 * @type string  $msgr_template_fields_callback     Callback for changing adding the _template_fields property for
+	 *                                                  messenger. For example, the shortcode library may add a new
+	 *                                                  field to the message templates. Optional.
+	 * @type string  $valid_shortcodes_callback         Callback for message types _valid_shortcodes array setup.
+	 *                                                  Optional.
+	 * @type array $list_type_shortcodes                If there are any specific shortcodes with this message
+	 *                                                  shortcode library that should be considered "list type"
+	 *                                                  then include them in an array.
+	 *                                                  List Type shortcodes are shortcodes that have a corresponding
+	 *                                                  field that indicates how they are parsed. Optional.
+	 *                              }
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @since    4.3.0
+	 *
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['autoloadpaths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register a messages shortcode library with EE_Register_Messages_Shortcode_Library::register, you must include a "name" (a unique identifier for this set of message shortcodes), and an array containing the following keys: : "autoload_paths"',
+					'event_espresso'
+				)
+			);
+		}
+
+		// make sure we don't register twice
+		if (isset(self::$_ee_messages_shortcode_registry[ $addon_name ])) {
+			return true;
+		}
+
+		// make sure this was called in the right place!
+		if (
+			! did_action('EE_Brewing_Regular___messages_caf')
+			|| did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'Should be only called on the "EE_Brewing_Regular___messages_caf" hook (Trying to register a library named %s).',
+						'event_espresso'
+					),
+					$addon_name
+				),
+				'4.3.0'
+			);
+		}
+
+		self::$_ee_messages_shortcode_registry[ $addon_name ] = [
+			'autoloadpaths'        => (array) $setup_args['autoloadpaths'],
+			'list_type_shortcodes' => ! empty($setup_args['list_type_shortcodes'])
+				? (array) $setup_args['list_type_shortcodes'] : [],
+		];
+
+		// add filters
+		add_filter(
+			'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+			['EE_Register_Messages_Shortcode_Library', 'register_msgs_autoload_paths'],
+			10
+		);
+
+		// add below filters if the required callback is provided.
+		if (! empty($setup_args['msgr_validator_callback'])) {
+			add_filter('FHEE__EE_messenger__get_validator_config', $setup_args['msgr_validator_callback'], 10, 2);
+		}
+
+		if (! empty($setup_args['msgr_template_fields_callback'])) {
+			add_filter('FHEE__EE_messenger__get_template_fields', $setup_args['msgr_template_fields_callback'], 10, 2);
+		}
+
+		if (! empty($setup_args['valid_shortcodes_callback'])) {
+			add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', $setup_args['valid_shortcodes_callback'], 10, 2);
+		}
+
+		if (! empty($setup_args['list_type_shortcodes'])) {
+			add_filter(
+				'FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
+				['EE_Register_Messages_Shortcode_Library', 'register_list_type_shortcodes'],
+				10
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * This deregisters any messages shortcode library previously registered with the given name.
+	 *
+	 * @param string $addon_name name used to register the shortcode library.
+	 * @return  void
+	 * @since    4.3.0
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_ee_messages_shortcode_registry[ $addon_name ]);
+	}
+
+
+	/**
+	 * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
+	 *
+	 * @param array $paths array of paths to be checked by EE_messages autoloader.
+	 * @return array
+	 * @since    4.3.0
+	 *
+	 */
+	public static function register_msgs_autoload_paths(array $paths): array
+	{
+		$autoload_paths = [];
+		if (! empty(self::$_ee_messages_shortcode_registry)) {
+			foreach (self::$_ee_messages_shortcode_registry as $st_reg) {
+				if (empty($st_reg['autoloadpaths'])) {
+					continue;
+				}
+				$autoload_paths[] = $st_reg['autoloadpaths'];
+			}
+		}
+		return array_merge($paths, ...$autoload_paths);
+	}
+
+
+	/**
+	 * This is the callback for the FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes
+	 * filter which is used to add additional list type shortcodes.
+	 *
+	 * @param array $original_shortcodes
+	 * @return  array                                   Modifications to original shortcodes.
+	 * @since 4.3.0
+	 *
+	 */
+	public static function register_list_type_shortcodes(array $original_shortcodes): array
+	{
+		if (empty(self::$_ee_messages_shortcode_registry)) {
+			return $original_shortcodes;
+		}
+		$shortcodes = [];
+		foreach (self::$_ee_messages_shortcode_registry as $sc_reg) {
+			if (! empty($sc_reg['list_type_shortcodes'])) {
+				$shortcodes[] = $sc_reg['list_type_shortcodes'];
+			}
+		}
+		return array_merge($original_shortcodes, ...$shortcodes);
+	}
+
+
+	public static function reset(): void
+	{
+		self::$_ee_messages_shortcode_registry = [];
+	}
 }

core/libraries/shortcodes/EE_Primary_Registration_Details_Shortcodes.lib.php

Indentation +181 added lines, -181 removed lines

@@ -17,186 +17,186 @@
  */
 class EE_Primary_Registration_Details_Shortcodes extends EE_Shortcodes
 {
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Primary_Registration Details Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific primary registrant data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[PRIMARY_REGISTRANT_FNAME]'                  => esc_html__(
-                'Parses to the first name of the primary registration for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_LNAME]'                  => esc_html__(
-                'Parses to the last name of the primary registration for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_EMAIL]'                  => esc_html__(
-                'Parses to the email address of the primary registration for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_REGISTRATION_ID]'        => esc_html__(
-                'Parses to the registration ID of the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_REGISTRATION_CODE]'      => esc_html__(
-                'Parses to the registration code of the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_PHONE_NUMBER]'           => esc_html__(
-                'The Phone Number for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_ADDRESS]'                => esc_html__(
-                'The Address for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_ADDRESS2]'               => esc_html__(
-                'Whatever was in the address 2 field for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_CITY]'                   => esc_html__(
-                'The city for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_ZIP_PC]'                 => esc_html__(
-                'The ZIP (or Postal) Code for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_ADDRESS_STATE]'          => esc_html__(
-                'The state/province for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_COUNTRY]'                => esc_html__(
-                'The country for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_REGISTRATION_DATE]'      => esc_html__(
-                'The date the registration occured for the primary registration.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_FRONTEND_EDIT_REG_LINK]' => esc_html__(
-                'Generates a link for the given registration to edit this registration details on the frontend.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_ANSWER_*]'               => esc_html__(
-                'This is a special dynamic shortcode.  After the "*", add the exact text of an existing question, and if there is an answer for that question for this primary registrant, then it will be output in place of this shortcode.',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-        // make sure we end up with a copy of the EE_Messages_Addressee object
-        $primary_registration = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $primary_registration = ! $primary_registration instanceof EE_Messages_Addressee && is_array(
-            $this->_data
-        ) && isset($this->_data['data']) && $this->_data['data'] instanceof EE_Messages_Addressee ? $this->_data['data']
-            : $primary_registration;
-        $primary_registration = ! $primary_registration instanceof EE_Messages_Addressee && ! empty($this->_extra_data['data']) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_extra_data['data'] : $primary_registration;
-
-        if (! $primary_registration instanceof EE_Messages_Addressee) {
-            return '';
-        }
-
-        $attendee = $primary_registration->primary_att_obj;
-        $primary_reg = $primary_registration->primary_reg_obj;
-
-        if (! $attendee instanceof EE_Attendee || ! $primary_reg instanceof EE_Registration) {
-            return '';
-        }
-
-        switch ($shortcode) {
-            case '[PRIMARY_REGISTRANT_FNAME]':
-                return $attendee->fname();
-
-            case '[PRIMARY_REGISTRANT_LNAME]':
-                return $attendee->lname();
-
-            case '[PRIMARY_REGISTRANT_EMAIL]':
-                return $attendee->email();
-
-            case '[PRIMARY_REGISTRANT_REGISTRATION_ID]':
-                return $primary_reg->ID();
-
-            case '[PRIMARY_REGISTRANT_REGISTRATION_CODE]':
-                return $primary_reg->reg_code();
-
-            case '[PRIMARY_REGISTRANT_PHONE_NUMBER]':
-                return $attendee->phone();
-
-            case '[PRIMARY_REGISTRANT_ADDRESS]':
-                return $attendee->address();
-
-            case '[PRIMARY_REGISTRANT_ADDRESS2]':
-                return $attendee->address2();
-
-            case '[PRIMARY_REGISTRANT_CITY]':
-                return $attendee->city();
-
-            case '[PRIMARY_REGISTRANT_ZIP_PC]':
-                return $attendee->zip();
-
-            case '[PRIMARY_REGISTRANT_ADDRESS_STATE]':
-                $state_obj = $attendee->state_obj();
-                return $state_obj instanceof EE_State ? $state_obj->name() : '';
-
-            case '[PRIMARY_REGISTRANT_COUNTRY]':
-                $country_obj = $attendee->country_obj();
-                return $country_obj instanceof EE_Country ? $country_obj->name() : '';
-
-            case '[PRIMARY_REGISTRANT_REGISTRATION_DATE]':
-                if (! $primary_registration->primary_reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                return $primary_registration->primary_reg_obj->get_i18n_datetime('REG_date', get_option('date_format'));
-
-            case '[PRIMARY_REGISTRANT_FRONTEND_EDIT_REG_LINK]':
-                return $primary_reg->edit_attendee_information_url();
-        }
-
-        if (strpos($shortcode, '[PRIMARY_REGISTRANT_ANSWER_*') !== false) {
-            $shortcode = str_replace('[PRIMARY_REGISTRANT_ANSWER_*', '', $shortcode);
-            $shortcode = trim(str_replace(']', '', $shortcode));
-
-
-            // now let's figure out what question has this text
-            if (empty($primary_registration->questions)) {
-                return '';
-            }
-
-            foreach ($primary_registration->questions as $ansid => $question) {
-                if (
-                    $question instanceof EE_Question
-                    && trim($question->get('QST_display_text')) === trim($shortcode)
-                    && isset($primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ])
-                ) {
-                    $primary_reg_ansid = $primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ];
-
-                    // what we show for the answer depends on the question type!
-                    switch ($question->get('QST_type')) {
-                        case EEM_Question::QST_type_state:
-                            $state = EEM_State::instance()->get_one_by_ID($primary_reg_ansid->get('ANS_value'));
-                            $answer = $state instanceof EE_State ? $state->name() : '';
-                            break;
-
-                        case EEM_Question::QST_type_country:
-                            $country = EEM_Country::instance()->get_one_by_ID($primary_reg_ansid->get('ANS_value'));
-                            $answer = $country instanceof EE_Country ? $country->name() : '';
-                            break;
-
-                        default:
-                            $answer = $primary_reg_ansid->get_pretty('ANS_value', 'no_wpautop');
-                            break;
-                    }
-
-                    return $answer;
-                }
-            }
-        }
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Primary_Registration Details Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific primary registrant data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[PRIMARY_REGISTRANT_FNAME]'                  => esc_html__(
+				'Parses to the first name of the primary registration for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_LNAME]'                  => esc_html__(
+				'Parses to the last name of the primary registration for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_EMAIL]'                  => esc_html__(
+				'Parses to the email address of the primary registration for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_REGISTRATION_ID]'        => esc_html__(
+				'Parses to the registration ID of the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_REGISTRATION_CODE]'      => esc_html__(
+				'Parses to the registration code of the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_PHONE_NUMBER]'           => esc_html__(
+				'The Phone Number for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_ADDRESS]'                => esc_html__(
+				'The Address for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_ADDRESS2]'               => esc_html__(
+				'Whatever was in the address 2 field for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_CITY]'                   => esc_html__(
+				'The city for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_ZIP_PC]'                 => esc_html__(
+				'The ZIP (or Postal) Code for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_ADDRESS_STATE]'          => esc_html__(
+				'The state/province for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_COUNTRY]'                => esc_html__(
+				'The country for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_REGISTRATION_DATE]'      => esc_html__(
+				'The date the registration occured for the primary registration.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_FRONTEND_EDIT_REG_LINK]' => esc_html__(
+				'Generates a link for the given registration to edit this registration details on the frontend.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_ANSWER_*]'               => esc_html__(
+				'This is a special dynamic shortcode.  After the "*", add the exact text of an existing question, and if there is an answer for that question for this primary registrant, then it will be output in place of this shortcode.',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+		// make sure we end up with a copy of the EE_Messages_Addressee object
+		$primary_registration = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$primary_registration = ! $primary_registration instanceof EE_Messages_Addressee && is_array(
+			$this->_data
+		) && isset($this->_data['data']) && $this->_data['data'] instanceof EE_Messages_Addressee ? $this->_data['data']
+			: $primary_registration;
+		$primary_registration = ! $primary_registration instanceof EE_Messages_Addressee && ! empty($this->_extra_data['data']) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
+			? $this->_extra_data['data'] : $primary_registration;
+
+		if (! $primary_registration instanceof EE_Messages_Addressee) {
+			return '';
+		}
+
+		$attendee = $primary_registration->primary_att_obj;
+		$primary_reg = $primary_registration->primary_reg_obj;
+
+		if (! $attendee instanceof EE_Attendee || ! $primary_reg instanceof EE_Registration) {
+			return '';
+		}
+
+		switch ($shortcode) {
+			case '[PRIMARY_REGISTRANT_FNAME]':
+				return $attendee->fname();
+
+			case '[PRIMARY_REGISTRANT_LNAME]':
+				return $attendee->lname();
+
+			case '[PRIMARY_REGISTRANT_EMAIL]':
+				return $attendee->email();
+
+			case '[PRIMARY_REGISTRANT_REGISTRATION_ID]':
+				return $primary_reg->ID();
+
+			case '[PRIMARY_REGISTRANT_REGISTRATION_CODE]':
+				return $primary_reg->reg_code();
+
+			case '[PRIMARY_REGISTRANT_PHONE_NUMBER]':
+				return $attendee->phone();
+
+			case '[PRIMARY_REGISTRANT_ADDRESS]':
+				return $attendee->address();
+
+			case '[PRIMARY_REGISTRANT_ADDRESS2]':
+				return $attendee->address2();
+
+			case '[PRIMARY_REGISTRANT_CITY]':
+				return $attendee->city();
+
+			case '[PRIMARY_REGISTRANT_ZIP_PC]':
+				return $attendee->zip();
+
+			case '[PRIMARY_REGISTRANT_ADDRESS_STATE]':
+				$state_obj = $attendee->state_obj();
+				return $state_obj instanceof EE_State ? $state_obj->name() : '';
+
+			case '[PRIMARY_REGISTRANT_COUNTRY]':
+				$country_obj = $attendee->country_obj();
+				return $country_obj instanceof EE_Country ? $country_obj->name() : '';
+
+			case '[PRIMARY_REGISTRANT_REGISTRATION_DATE]':
+				if (! $primary_registration->primary_reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				return $primary_registration->primary_reg_obj->get_i18n_datetime('REG_date', get_option('date_format'));
+
+			case '[PRIMARY_REGISTRANT_FRONTEND_EDIT_REG_LINK]':
+				return $primary_reg->edit_attendee_information_url();
+		}
+
+		if (strpos($shortcode, '[PRIMARY_REGISTRANT_ANSWER_*') !== false) {
+			$shortcode = str_replace('[PRIMARY_REGISTRANT_ANSWER_*', '', $shortcode);
+			$shortcode = trim(str_replace(']', '', $shortcode));
+
+
+			// now let's figure out what question has this text
+			if (empty($primary_registration->questions)) {
+				return '';
+			}
+
+			foreach ($primary_registration->questions as $ansid => $question) {
+				if (
+					$question instanceof EE_Question
+					&& trim($question->get('QST_display_text')) === trim($shortcode)
+					&& isset($primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ])
+				) {
+					$primary_reg_ansid = $primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ];
+
+					// what we show for the answer depends on the question type!
+					switch ($question->get('QST_type')) {
+						case EEM_Question::QST_type_state:
+							$state = EEM_State::instance()->get_one_by_ID($primary_reg_ansid->get('ANS_value'));
+							$answer = $state instanceof EE_State ? $state->name() : '';
+							break;
+
+						case EEM_Question::QST_type_country:
+							$country = EEM_Country::instance()->get_one_by_ID($primary_reg_ansid->get('ANS_value'));
+							$answer = $country instanceof EE_Country ? $country->name() : '';
+							break;
+
+						default:
+							$answer = $primary_reg_ansid->get_pretty('ANS_value', 'no_wpautop');
+							break;
+					}
+
+					return $answer;
+				}
+			}
+		}
 
-        return '';
-    }
+		return '';
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -97,14 +97,14 @@ 
         $primary_registration = ! $primary_registration instanceof EE_Messages_Addressee && ! empty($this->_extra_data['data']) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
             ? $this->_extra_data['data'] : $primary_registration;
 
-        if (! $primary_registration instanceof EE_Messages_Addressee) {
+        if ( ! $primary_registration instanceof EE_Messages_Addressee) {
             return '';
         }
 
         $attendee = $primary_registration->primary_att_obj;
         $primary_reg = $primary_registration->primary_reg_obj;
 
-        if (! $attendee instanceof EE_Attendee || ! $primary_reg instanceof EE_Registration) {
+        if ( ! $attendee instanceof EE_Attendee || ! $primary_reg instanceof EE_Registration) {
             return '';
         }
 
@@ -148,7 +148,7 @@ 
                 return $country_obj instanceof EE_Country ? $country_obj->name() : '';
 
             case '[PRIMARY_REGISTRANT_REGISTRATION_DATE]':
-                if (! $primary_registration->primary_reg_obj instanceof EE_Registration) {
+                if ( ! $primary_registration->primary_reg_obj instanceof EE_Registration) {
                     return '';
                 }
                 return $primary_registration->primary_reg_obj->get_i18n_datetime('REG_date', get_option('date_format'));
@@ -171,9 +171,9 @@ 
                 if (
                     $question instanceof EE_Question
                     && trim($question->get('QST_display_text')) === trim($shortcode)
-                    && isset($primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ])
+                    && isset($primary_registration->registrations[$primary_reg->ID()]['ans_objs'][$ansid])
                 ) {
-                    $primary_reg_ansid = $primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ];
+                    $primary_reg_ansid = $primary_registration->registrations[$primary_reg->ID()]['ans_objs'][$ansid];
 
                     // what we show for the answer depends on the question type!
                     switch ($question->get('QST_type')) {

core/libraries/shortcodes/EE_Transaction_Shortcodes.lib.php

Indentation +778 added lines, -778 removed lines

@@ -16,786 +16,786 @@
  */
 class EE_Transaction_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * @var EE_Payment_Method $_invoice_pm the invoice payment method for use in invoices etc
-     */
-    protected $_invoice_pm;
-
-
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Transaction Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to transaction related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[TXN_ID]'                          => esc_html__('The transaction id for the purchase.', 'event_espresso'),
-            '[PAYMENT_URL]'                     => esc_html__(
-                'This is a link to make a payment for the event',
-                'event_espresso'
-            ),
-            '[PAYMENT_LINK_IF_NEEDED_*]'        => esc_html__(
-                'This is a special dynamic shortcode that allows one to insert a payment link conditional on there being amount owing on the transaction. Three params are available on this shortcode:',
-                'event_espresso'
-            )
-                                                   . '<ul>'
-                                                   . '<li>'
-                                                   . sprintf(
-                                                       esc_html__(
-                                                           '%sclass:%s This can be used to indicate css class is given to the containing css element (default is "callout").',
-                                                           'event_espresso'
-                                                       ),
-                                                       '<strong>',
-                                                       '</strong>'
-                                                   )
-                                                   . '</li>'
-                                                   . '<li>'
-                                                   . sprintf(
-                                                       esc_html__(
-                                                           '%scustom_text:%s This should be a sprintf format text string (with %%s for where the hyperlink tags go) that is used for the generated link text (The default is "You can %%smake a payment here »%%s.)',
-                                                           'event_espresso'
-                                                       ),
-                                                       '<strong>',
-                                                       '</strong>'
-                                                   )
-                                                   . '</li>'
-                                                   . '<li>'
-                                                   . sprintf(
-                                                       esc_html__(
-                                                           '%scontainer_tag:%s Use this to indicate what container tag you want surrounding the payment link (default is "p").',
-                                                           'event_espresso'
-                                                       ),
-                                                       '<strong>',
-                                                       '</strong>'
-                                                   )
-                                                   . '</li>'
-                                                   . '</ul>',
-            '[PAYMENT_DUE_DATE_*]'              => esc_html__(
-                'This is a special dynamic shortcode that allows one to output a payment due date.  It will only result in a date shown if there is money owing.  Three parameters are available on this shortcode:',
-                'event_espresso'
-            )
-                                                   . '<ul>'
-                                                   . '<li>'
-                                                   . sprintf(
-                                                       esc_html__(
-                                                           '%sformat:%s This is used to indicate what format the date is in.  Default is whatever is set as date formats for your website.',
-                                                           'event_espresso'
-                                                       ),
-                                                       '<strong>',
-                                                       '</strong>'
-                                                   )
-                                                   . '</li>'
-                                                   . '<li>'
-                                                   . sprintf(
-                                                       esc_html__(
-                                                           '%sdays_until_due:%s This is the number of days form the transaction creation date that the payment is due.  Defaults to 30.',
-                                                           'event_espresso'
-                                                       ),
-                                                       '<strong>',
-                                                       '</strong>'
-                                                   )
-                                                   . '</li>'
-                                                   . '<li>'
-                                                   . sprintf(
-                                                       esc_html__(
-                                                           '%sprefix_text:%s You can use this to indicate what text will prefix the date string.  Defaults to "Payment in full due by:"',
-                                                           'event_espresso'
-                                                       ),
-                                                       '<strong>',
-                                                       '</strong>'
-                                                   )
-                                                   . '</li>',
-            '[INVOICE_LINK]'                    => esc_html__(
-                'This is a full html link to the invoice',
-                'event_espresso'
-            ),
-            '[INVOICE_URL]'                     => esc_html__(
-                'This is just the url for the invoice',
-                'event_espresso'
-            ),
-            '[INVOICE_LOGO_URL]'                => esc_html__(
-                'This returns the url for the logo uploaded via the invoice settings page.',
-                'event_espresso'
-            ),
-            '[INVOICE_LOGO]'                    => esc_html__(
-                'This returns the logo uploaded via the invoice settings page wrapped in img_tags and with a "logo screen" classes. The image size is also set in the img tags automatically to match the uploaded logo.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_NAME]'              => esc_html__(
-                'This will parse to either: the value of the "Company Name" field in the invoice payment method settings; if that is blank, then the value of the Company Name in the "Your Organization Settings", if that is blank then an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_ADDRESS]'           => esc_html__(
-                'This will parse to either: the value of the "Company Address" field in the invoice payment method settings; if that is blank, then the value of the Company Address in the "Your Organization Settings", if that is blank then an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYMENT_INSTRUCTIONS]'    => esc_html__(
-                'This will parse to the value of the "Payment Instructions" field found on the Invoice payment methods settings page',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_EMAIL]'             => esc_html__(
-                'This will parse to either: the value of the "Company Email" field in the invoice payment method settings; if that is blank, then the value of the Company Email in the "Your Organization Settings", if that is blank then an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_TAX_NUMBER_*]'      => sprintf(
-                esc_html__(
-                    'This will parse to either: the value of the "Company Tax Number" field in the invoice payment method settings; if that is blank, then the value of the Company Tax Number in the "Your Organization Settings", if that is blank then an empty string. Note this is also a special dynamic shortcode. You can use the "prefix" parameter to indicate what text you want to use as a prefix before this tax number.  It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: %1$s[INVOICE_PAYEE_TAX_NUMBER_* prefix="GST:"]%2$s and that will output: GST: 12345t56.  If you have no tax number in your settings, then no prefix will be output either.',
-                    'event_espresso'
-                ),
-                '<code>',
-                '</code>'
-            ),
-            '[TOTAL_COST]'                      => esc_html__('The total cost for the transaction', 'event_espresso'),
-            '[TXN_STATUS]'                      => esc_html__(
-                'The transaction status for the transaction.',
-                'event_espresso'
-            ),
-            '[TXN_STATUS_ID]'                   => esc_html__(
-                'The ID representing the transaction status as saved in the db.  This tends to be useful for including with css classes for styling certain statuses differently from others.',
-                'event_espresso'
-            ),
-            '[PAYMENT_STATUS]'                  => esc_html__(
-                'The transaction status for the transaction. This parses to the same value as the [TXN_STATUS] shortcode and still remains here for legacy support.',
-                'event_espresso'
-            ),
-            '[PAYMENT_GATEWAY]'                 => esc_html__(
-                'The payment gateway used for the transaction',
-                'event_espresso'
-            ),
-            '[AMOUNT_PAID]'                     => esc_html__(
-                'The amount paid or refunded.  This will only have a value if there was a payment or refund at the time of generating the message.',
-                'event_espresso'
-            ),
-            '[LAST_AMOUNT_PAID]'                => esc_html__(
-                'This is the last payment or refund made on the transaction related to the message being generated.',
-                'event_espresso'
-            ),
-            '[TOTAL_AMOUNT_PAID]'               => esc_html__(
-                'This parses to the total amount paid over all payments',
-                'event_espresso'
-            ),
-            '[TOTAL_OWING]'                     => esc_html__(
-                'The total owing on a transaction with no attributes.',
-                'event_espresso'
-            ),
-            '[TXN_SUBTOTAL]'                    => esc_html__('The subtotal for all txn line items.', 'event_espresso'),
-            '[TXN_TAX_SUBTOTAL]'                => esc_html__('The subtotal for all tax line items.', 'event_espresso'),
-            '[OWING_STATUS_MESSAGE_*]'          => esc_html__(
-                'A dynamic shortcode for adjusting how total owing gets shown. The acceptable attributes on the shortcode are:',
-                'event_espresso'
-            )
-                                                   . '<p></ul>'
-                                                   . '<li><strong>still_owing</strong>:'
-                                                   . esc_html__(
-                                                       'If the transaction is not paid in full, then whatever is set for this attribute is shown (otherwise its just the amount owing). The default is:',
-                                                       'event_espresso'
-                                                   )
-                                                   . sprintf(
-                                                       esc_html__('%sPlease make a payment.%s', 'event_espresso'),
-                                                       '<a href="[PAYMENT_URL]" class="noPrint">',
-                                                       '</a>'
-                                                   )
-                                                   . '</li>'
-                                                   .
-                                                   '<li><strong>none_owing</strong>:'
-                                                   . esc_html__(
-                                                       'If the transaction is paid in full, then you can indicate how this gets displayed.  Note, that it defaults to just be the total owing.',
-                                                       'event_espresso'
-                                                   )
-                                                   . '</li></ul></p>',
-            '[TXN_TOTAL_TICKETS]'               => esc_html__(
-                'The total number of all tickets purchased in a transaction',
-                'event_espresso'
-            ),
-            '[TKT_QTY_PURCHASED]'               => sprintf(
-                esc_html__(
-                    'The total number of all tickets purchased in a transaction. %1$sNOTE: This shortcode is good to use in the "[TICKET_LIST]" field but has been deprecated from all other contexts in favor of the more explicit [TXN_TOTAL_TICKETS] shortcode.%2$s',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>'
-            ),
-            '[TRANSACTION_ADMIN_URL]'           => esc_html__(
-                'The url to the admin page for this transaction',
-                'event_espresso'
-            ),
-            '[RECEIPT_URL]'                     => esc_html__(
-                'This parses to the generated url for retrieving the receipt for the transaction',
-                'event_espresso'
-            ),
-            '[INVOICE_RECEIPT_SWITCHER_URL]'    => esc_html__(
-                'This parses to the url that will switch to the receipt if an invoice is displayed, and switch to the invoice if receipt is displayed. If a message type OTHER than invoice or receipt is displayed then this will just return the url for the invoice. If the related message type is not active  then will parse to an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_RECEIPT_SWITCHER_BUTTON]' => sprintf(
-                esc_html__(
-                    'The same as %1$s%2$s except this returns the html for a button linked to the invoice or receipt.',
-                    'event_espresso'
-                ),
-                '<code>[INVOICE_RECEIPT_SWITCHER_URL]',
-                '</code>'
-            ),
-            '[LAST_PAYMENT_TRANSACTION_ID]'     => esc_html__(
-                'This will output the value of the payment transaction id for the last payment made on the transaction. Note, if a specific payment was included for message generation, that will be used when parsing the shortcode.',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    /**
-     * @param  string $shortcode the shortcode to be parsed.
-     * @return string parsed shortcode
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _parser($shortcode)
-    {
-        // attempt to get the transaction.  Since this is potentially used in more fields, we may have to look in the
-        // _extra_data for the transaction.
-        $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
-        $transaction = ! $transaction instanceof EE_Transaction
-                       && is_array($this->_extra_data)
-                       && isset($this->_extra_data['data'])
-                       && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_extra_data['data']->txn
-            : $transaction;
-        // payment
-        $payment = $this->_data->payment instanceof EE_Payment ? $this->_data->payment : null;
-        $payment = ! $payment instanceof EE_Payment
-                   && is_array($this->_extra_data)
-                   && isset($this->_extra_data['data'])
-                   && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment
-            : $payment;
-        if (! $transaction instanceof EE_Transaction) {
-            return '';
-        }
-        switch ($shortcode) {
-            case '[TXN_ID]':
-                return $transaction->ID();
-                break;
-            case '[PAYMENT_URL]':
-                $payment_url = $transaction->payment_overview_url();
-                return empty($payment_url)
-                    ? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso')
-                    : $payment_url;
-                break;
-            case '[INVOICE_LINK]':
-                $invoice_url = $transaction->invoice_url();
-                $invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
-                return sprintf(
-                    esc_html__('%sClick here for Invoice%s', 'event_espresso'),
-                    '<a href="' . $invoice_url . '">',
-                    '</a>'
-                );
-                break;
-            case '[INVOICE_URL]':
-                $invoice_url = $transaction->invoice_url();
-                return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
-                break;
-            case '[INVOICE_LOGO_URL]':
-                return $this->_get_invoice_logo();
-                break;
-            case '[INVOICE_LOGO]':
-                return $this->_get_invoice_logo(true);
-                break;
-            case '[INVOICE_PAYEE_NAME]':
-                return $this->_get_invoice_payee_name();
-                break;
-            case '[INVOICE_PAYEE_ADDRESS]':
-                return $this->_get_invoice_payee_address();
-                break;
-            case '[INVOICE_PAYMENT_INSTRUCTIONS]':
-                return $this->_get_invoice_payment_instructions();
-                break;
-            case '[INVOICE_PAYEE_EMAIL]':
-                return $this->_get_invoice_payee_email();
-                break;
-            case '[TOTAL_COST]':
-                $total = $transaction->total();
-                return ! empty($total) ? EEH_Template::format_currency($total) : '';
-                break;
-            case '[PAYMENT_STATUS]':
-                $status = $transaction->pretty_status();
-                return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
-                break; /**/
-            // note the [payment_status] shortcode is kind of misleading because payment status might be different
-            // from txn status so I'm adding this here for clarity.
-            case '[TXN_STATUS]':
-                $status = $transaction->pretty_status();
-                return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
-                break;
-            case '[TXN_STATUS_ID]':
-                return $transaction->status_ID();
-                break;
-            case '[PAYMENT_GATEWAY]':
-                return $this->_get_payment_gateway($transaction);
-                break;
-            case '[AMOUNT_PAID]':
-                return $payment instanceof EE_Payment
-                    ? EEH_Template::format_currency($payment->amount())
-                    : EEH_Template::format_currency(0);
-                break;
-            case '[LAST_AMOUNT_PAID]':
-                $last_payment = $transaction->last_payment();
-                return $last_payment instanceof EE_Payment
-                    ? EEH_Template::format_currency($last_payment->amount())
-                    : EEH_Template::format_currency(0);
-            case '[TOTAL_AMOUNT_PAID]':
-                return EEH_Template::format_currency($transaction->paid());
-                break;
-            case '[TOTAL_OWING]':
-                $total_owing = $transaction->remaining();
-                return EEH_Template::format_currency($total_owing);
-                break;
-            case '[TXN_SUBTOTAL]':
-                return EEH_Template::format_currency($this->_get_subtotal());
-                break;
-            case '[TXN_TAX_SUBTOTAL]':
-                return EEH_Template::format_currency($this->_get_subtotal(true));
-                break;
-            case '[TKT_QTY_PURCHASED]':
-            case '[TXN_TOTAL_TICKETS]':
-                return $this->_data->total_ticket_count;
-                break;
-            case '[TRANSACTION_ADMIN_URL]':
-                require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
-                $query_args = array(
-                    'page'   => 'espresso_transactions',
-                    'action' => 'view_transaction',
-                    'TXN_ID' => $transaction->ID(),
-                );
-                $url = EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php'));
-                return $url;
-                break;
-            case '[RECEIPT_URL]':
-                // get primary_registration
-                $reg = $this->_data->primary_reg_obj;
-                if (! $reg instanceof EE_Registration) {
-                    return '';
-                }
-                return $reg->receipt_url();
-                break;
-            case '[INVOICE_RECEIPT_SWITCHER_URL]':
-                return $this->_get_invoice_receipt_switcher(false);
-                break;
-            case '[INVOICE_RECEIPT_SWITCHER_BUTTON]':
-                return $this->_get_invoice_receipt_switcher();
-                break;
-            case '[LAST_PAYMENT_TRANSACTION_ID]':
-                $id = '';
-                $payment = $payment instanceof EE_Payment && $payment->ID() !== 0
-                    ? $payment
-                    : $transaction->last_payment();
-                if ($payment instanceof EE_Payment) {
-                    $id = $payment->txn_id_chq_nmbr();
-                }
-                return $id;
-                break;
-        }
-        if (strpos($shortcode, '[OWING_STATUS_MESSAGE_*') !== false) {
-            return $this->_get_custom_total_owing($shortcode);
-        }
-        if (strpos($shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*') !== false) {
-            return $this->_get_invoice_payee_tax_number($shortcode);
-        }
-        if (strpos($shortcode, '[PAYMENT_LINK_IF_NEEDED_*') !== false) {
-            return $this->_get_payment_link_if_needed($shortcode);
-        }
-        if (strpos($shortcode, '[PAYMENT_DUE_DATE_*') !== false) {
-            return $this->_get_payment_due_date($shortcode, $transaction);
-        }
-        return '';
-    }
-
-
-    /**
-     * parser for the [OWING_STATUS_MESSAGE_*] attribute type shortcode
-     *
-     * @since 4.5.0
-     * @param string $shortcode the incoming shortcode
-     * @return string parsed.
-     * @throws EE_Error
-     */
-    private function _get_custom_total_owing($shortcode)
-    {
-        $valid_shortcodes = array('transaction');
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        // ensure default is set.
-        $addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
-            ? $addressee->txn->remaining() : 0;
-        if ($total_owing > 0) {
-            $owing_content = ! empty($attrs['still_owing'])
-                ? $attrs['still_owing']
-                : sprintf(
-                    esc_html__('%sPlease make a payment.%s', 'event_espresso'),
-                    '<a href="[PAYMENT_URL]" class="noPrint">',
-                    '</a>'
-                );
-            $owing_content = $this->_shortcode_helper->parse_message_template(
-                $owing_content,
-                $addressee,
-                $valid_shortcodes,
-                $this->_message_type,
-                $this->_messenger,
-                $this->_message
-            );
-        } else {
-            $owing_content = ! empty($attrs['none_owing']) ? $attrs['none_owing'] : '';
-        }
-        return $owing_content;
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    private function _get_payment_gateway($transaction)
-    {
-        if ($transaction instanceof EE_Transaction) {
-            $pm = $transaction->payment_method();
-        } else {
-            $pm = null;
-        }
-        return $pm instanceof EE_Payment_Method ? $pm->name() : '';
-    }
-
-
-    /**
-     * This retrieves a logo to be used for the invoice from whatever is set on the invoice logo settings page.  If its
-     * not present then the organization logo is used if its found (set on the organization settings page).
-     *
-     * @param bool $img_tags TRUE means to return with the img tag wrappers.  False just returns the url to the image.
-     * @return string url or html
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    private function _get_invoice_logo(bool $img_tags = false): string
-    {
-        $invoice_logo_url = '';
-        // try to get the invoice payment method's logo for this transaction image first
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $invoice_logo_url = $pm->get_extra_meta('pdf_logo_image', true);
-        }
-        if (empty($invoice_logo_url)) {
-            $invoice_logo_url = EE_Registry::instance()->CFG->organization->logo_url;
-        }
-        if (empty($invoice_logo_url)) {
-            return '';
-        }
-        if (! $img_tags) {
-            return $invoice_logo_url;
-        }
-        $invoice_logo_url = esc_url_raw($invoice_logo_url);
-        // image tags have been requested.
-        $image_size = @getimagesize($invoice_logo_url);
-        $image_width_attr = '';
-        // if image is wider than 300px, set the width to 300
-        if ($image_size !== false) {
-            $image_width = min($image_size[0], 300);
-            $image_width = esc_attr($image_width);
-            $image_width_attr = " width='$image_width'";
-        }
-        return '<img class="logo screen" src="' . $invoice_logo_url . '"' . $image_width_attr . ' alt="logo" />';
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee name shortcode
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_name()
-    {
-        $payee_name = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_name = $pm->get_extra_meta('pdf_payee_name', true);
-        }
-        $payee_name = empty($payee_name) ? EE_Registry::instance()->CFG->organization->get_pretty('name') : $payee_name;
-        return $payee_name;
-    }
-
-
-    /**
-     * gets the default invoice payment method, but has a filter so it can be overridden
-     *
-     * @return EE_Payment_Method|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payment_method()
-    {
-        if (! $this->_invoice_pm instanceof EE_Payment_Method) {
-            $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
-            $transaction = ! $transaction instanceof EE_Transaction
-                           && is_array($this->_extra_data)
-                           && isset($this->_extra_data['data'])
-                           && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->txn : $transaction;
-            // get the invoice payment method, and remember it for the next call too
-            $this->_invoice_pm = apply_filters(
-                'FHEE__EE_Transaction_Shortcodes__get_payment_method__default',
-                EEM_Payment_Method::instance()->get_one_of_type('Invoice'),
-                $transaction
-            );
-        }
-        return $this->_invoice_pm;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee email shortcode
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_email()
-    {
-        $payee_email = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_email = $pm->get_extra_meta('pdf_payee_email', true);
-        }
-        $payee_email = empty($payee_email) ? EE_Registry::instance()->CFG->organization->get_pretty('email')
-            : $payee_email;
-        return $payee_email;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee tax number shortcode
-     *
-     * @since 4.5.0
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_tax_number($shortcode)
-    {
-        $payee_tax_number = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_tax_number = $pm->get_extra_meta('pdf_payee_tax_number', true);
-        }
-        $payee_tax_number = empty($payee_tax_number) ? EE_Registry::instance()->CFG->organization->vat
-            : $payee_tax_number;
-        if (empty($payee_tax_number)) {
-            return '';
-        }
-        // any attributes?
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        // prefix?
-        $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso');
-        return $prefix . $payee_tax_number;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee address shortcode.
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_address()
-    {
-        $payee_address = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_address = $pm->get_extra_meta('pdf_payee_address', true);
-        }
-        if (empty($payee_address)) {
-            $organization = EE_Registry::instance()->CFG->organization;
-            $payee_address = $organization->get_pretty('address_1') . '<br>';
-            $payee_address .= ! empty($organization->address_2)
-                ? $organization->get_pretty('address_2') . '<br>'
-                : '';
-            $payee_address .= $organization->get_pretty('city') . '<br>';
-            // state
-            $state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
-            $payee_address .= $state instanceof EE_State ? $state->name() : '';
-            // Country
-            $payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : '';
-            $payee_address .= ! empty($organization->zip) ? $organization->zip : '';
-        }
-        return $payee_address;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payment instructions shortcode.
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payment_instructions()
-    {
-        $instructions = null;
-        $pm = $this->_get_invoice_payment_method();
-        return ($pm instanceof EE_Payment_Method) ? $pm->get_extra_meta('pdf_instructions', true) : '';
-    }
-
-
-    /**
-     * get invoice/receipt switch button or url.
-     *
-     * @param bool $button true (default) returns the html for a button, false just returns the url.
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_invoice_receipt_switcher($button = true)
-    {
-        $reg = $this->_data->primary_reg_obj;
-        $message_type = isset($this->_extra_data['message_type']) ? $this->_extra_data['message_type'] : '';
-        if (! $reg instanceof EE_Registration || empty($message_type)) {
-            return '';
-        }
-        $switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type ? true : false;
-        $switch_to_label = $switch_to_invoice && ! $message_type instanceof EE_Receipt_message_type
-            ? esc_html__('View Invoice', 'event_espresso') : esc_html__('Switch to Invoice', 'event_espresso');
-        $switch_to_label = ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label;
-        $switch_to_url = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url();
-        if (! $button) {
-            return $switch_to_url;
-        }
-        if (! empty($switch_to_url)) {
-            return '
+	/**
+	 * @var EE_Payment_Method $_invoice_pm the invoice payment method for use in invoices etc
+	 */
+	protected $_invoice_pm;
+
+
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Transaction Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to transaction related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[TXN_ID]'                          => esc_html__('The transaction id for the purchase.', 'event_espresso'),
+			'[PAYMENT_URL]'                     => esc_html__(
+				'This is a link to make a payment for the event',
+				'event_espresso'
+			),
+			'[PAYMENT_LINK_IF_NEEDED_*]'        => esc_html__(
+				'This is a special dynamic shortcode that allows one to insert a payment link conditional on there being amount owing on the transaction. Three params are available on this shortcode:',
+				'event_espresso'
+			)
+												   . '<ul>'
+												   . '<li>'
+												   . sprintf(
+													   esc_html__(
+														   '%sclass:%s This can be used to indicate css class is given to the containing css element (default is "callout").',
+														   'event_espresso'
+													   ),
+													   '<strong>',
+													   '</strong>'
+												   )
+												   . '</li>'
+												   . '<li>'
+												   . sprintf(
+													   esc_html__(
+														   '%scustom_text:%s This should be a sprintf format text string (with %%s for where the hyperlink tags go) that is used for the generated link text (The default is "You can %%smake a payment here »%%s.)',
+														   'event_espresso'
+													   ),
+													   '<strong>',
+													   '</strong>'
+												   )
+												   . '</li>'
+												   . '<li>'
+												   . sprintf(
+													   esc_html__(
+														   '%scontainer_tag:%s Use this to indicate what container tag you want surrounding the payment link (default is "p").',
+														   'event_espresso'
+													   ),
+													   '<strong>',
+													   '</strong>'
+												   )
+												   . '</li>'
+												   . '</ul>',
+			'[PAYMENT_DUE_DATE_*]'              => esc_html__(
+				'This is a special dynamic shortcode that allows one to output a payment due date.  It will only result in a date shown if there is money owing.  Three parameters are available on this shortcode:',
+				'event_espresso'
+			)
+												   . '<ul>'
+												   . '<li>'
+												   . sprintf(
+													   esc_html__(
+														   '%sformat:%s This is used to indicate what format the date is in.  Default is whatever is set as date formats for your website.',
+														   'event_espresso'
+													   ),
+													   '<strong>',
+													   '</strong>'
+												   )
+												   . '</li>'
+												   . '<li>'
+												   . sprintf(
+													   esc_html__(
+														   '%sdays_until_due:%s This is the number of days form the transaction creation date that the payment is due.  Defaults to 30.',
+														   'event_espresso'
+													   ),
+													   '<strong>',
+													   '</strong>'
+												   )
+												   . '</li>'
+												   . '<li>'
+												   . sprintf(
+													   esc_html__(
+														   '%sprefix_text:%s You can use this to indicate what text will prefix the date string.  Defaults to "Payment in full due by:"',
+														   'event_espresso'
+													   ),
+													   '<strong>',
+													   '</strong>'
+												   )
+												   . '</li>',
+			'[INVOICE_LINK]'                    => esc_html__(
+				'This is a full html link to the invoice',
+				'event_espresso'
+			),
+			'[INVOICE_URL]'                     => esc_html__(
+				'This is just the url for the invoice',
+				'event_espresso'
+			),
+			'[INVOICE_LOGO_URL]'                => esc_html__(
+				'This returns the url for the logo uploaded via the invoice settings page.',
+				'event_espresso'
+			),
+			'[INVOICE_LOGO]'                    => esc_html__(
+				'This returns the logo uploaded via the invoice settings page wrapped in img_tags and with a "logo screen" classes. The image size is also set in the img tags automatically to match the uploaded logo.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_NAME]'              => esc_html__(
+				'This will parse to either: the value of the "Company Name" field in the invoice payment method settings; if that is blank, then the value of the Company Name in the "Your Organization Settings", if that is blank then an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_ADDRESS]'           => esc_html__(
+				'This will parse to either: the value of the "Company Address" field in the invoice payment method settings; if that is blank, then the value of the Company Address in the "Your Organization Settings", if that is blank then an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYMENT_INSTRUCTIONS]'    => esc_html__(
+				'This will parse to the value of the "Payment Instructions" field found on the Invoice payment methods settings page',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_EMAIL]'             => esc_html__(
+				'This will parse to either: the value of the "Company Email" field in the invoice payment method settings; if that is blank, then the value of the Company Email in the "Your Organization Settings", if that is blank then an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_TAX_NUMBER_*]'      => sprintf(
+				esc_html__(
+					'This will parse to either: the value of the "Company Tax Number" field in the invoice payment method settings; if that is blank, then the value of the Company Tax Number in the "Your Organization Settings", if that is blank then an empty string. Note this is also a special dynamic shortcode. You can use the "prefix" parameter to indicate what text you want to use as a prefix before this tax number.  It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: %1$s[INVOICE_PAYEE_TAX_NUMBER_* prefix="GST:"]%2$s and that will output: GST: 12345t56.  If you have no tax number in your settings, then no prefix will be output either.',
+					'event_espresso'
+				),
+				'<code>',
+				'</code>'
+			),
+			'[TOTAL_COST]'                      => esc_html__('The total cost for the transaction', 'event_espresso'),
+			'[TXN_STATUS]'                      => esc_html__(
+				'The transaction status for the transaction.',
+				'event_espresso'
+			),
+			'[TXN_STATUS_ID]'                   => esc_html__(
+				'The ID representing the transaction status as saved in the db.  This tends to be useful for including with css classes for styling certain statuses differently from others.',
+				'event_espresso'
+			),
+			'[PAYMENT_STATUS]'                  => esc_html__(
+				'The transaction status for the transaction. This parses to the same value as the [TXN_STATUS] shortcode and still remains here for legacy support.',
+				'event_espresso'
+			),
+			'[PAYMENT_GATEWAY]'                 => esc_html__(
+				'The payment gateway used for the transaction',
+				'event_espresso'
+			),
+			'[AMOUNT_PAID]'                     => esc_html__(
+				'The amount paid or refunded.  This will only have a value if there was a payment or refund at the time of generating the message.',
+				'event_espresso'
+			),
+			'[LAST_AMOUNT_PAID]'                => esc_html__(
+				'This is the last payment or refund made on the transaction related to the message being generated.',
+				'event_espresso'
+			),
+			'[TOTAL_AMOUNT_PAID]'               => esc_html__(
+				'This parses to the total amount paid over all payments',
+				'event_espresso'
+			),
+			'[TOTAL_OWING]'                     => esc_html__(
+				'The total owing on a transaction with no attributes.',
+				'event_espresso'
+			),
+			'[TXN_SUBTOTAL]'                    => esc_html__('The subtotal for all txn line items.', 'event_espresso'),
+			'[TXN_TAX_SUBTOTAL]'                => esc_html__('The subtotal for all tax line items.', 'event_espresso'),
+			'[OWING_STATUS_MESSAGE_*]'          => esc_html__(
+				'A dynamic shortcode for adjusting how total owing gets shown. The acceptable attributes on the shortcode are:',
+				'event_espresso'
+			)
+												   . '<p></ul>'
+												   . '<li><strong>still_owing</strong>:'
+												   . esc_html__(
+													   'If the transaction is not paid in full, then whatever is set for this attribute is shown (otherwise its just the amount owing). The default is:',
+													   'event_espresso'
+												   )
+												   . sprintf(
+													   esc_html__('%sPlease make a payment.%s', 'event_espresso'),
+													   '<a href="[PAYMENT_URL]" class="noPrint">',
+													   '</a>'
+												   )
+												   . '</li>'
+												   .
+												   '<li><strong>none_owing</strong>:'
+												   . esc_html__(
+													   'If the transaction is paid in full, then you can indicate how this gets displayed.  Note, that it defaults to just be the total owing.',
+													   'event_espresso'
+												   )
+												   . '</li></ul></p>',
+			'[TXN_TOTAL_TICKETS]'               => esc_html__(
+				'The total number of all tickets purchased in a transaction',
+				'event_espresso'
+			),
+			'[TKT_QTY_PURCHASED]'               => sprintf(
+				esc_html__(
+					'The total number of all tickets purchased in a transaction. %1$sNOTE: This shortcode is good to use in the "[TICKET_LIST]" field but has been deprecated from all other contexts in favor of the more explicit [TXN_TOTAL_TICKETS] shortcode.%2$s',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>'
+			),
+			'[TRANSACTION_ADMIN_URL]'           => esc_html__(
+				'The url to the admin page for this transaction',
+				'event_espresso'
+			),
+			'[RECEIPT_URL]'                     => esc_html__(
+				'This parses to the generated url for retrieving the receipt for the transaction',
+				'event_espresso'
+			),
+			'[INVOICE_RECEIPT_SWITCHER_URL]'    => esc_html__(
+				'This parses to the url that will switch to the receipt if an invoice is displayed, and switch to the invoice if receipt is displayed. If a message type OTHER than invoice or receipt is displayed then this will just return the url for the invoice. If the related message type is not active  then will parse to an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_RECEIPT_SWITCHER_BUTTON]' => sprintf(
+				esc_html__(
+					'The same as %1$s%2$s except this returns the html for a button linked to the invoice or receipt.',
+					'event_espresso'
+				),
+				'<code>[INVOICE_RECEIPT_SWITCHER_URL]',
+				'</code>'
+			),
+			'[LAST_PAYMENT_TRANSACTION_ID]'     => esc_html__(
+				'This will output the value of the payment transaction id for the last payment made on the transaction. Note, if a specific payment was included for message generation, that will be used when parsing the shortcode.',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	/**
+	 * @param  string $shortcode the shortcode to be parsed.
+	 * @return string parsed shortcode
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _parser($shortcode)
+	{
+		// attempt to get the transaction.  Since this is potentially used in more fields, we may have to look in the
+		// _extra_data for the transaction.
+		$transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
+		$transaction = ! $transaction instanceof EE_Transaction
+					   && is_array($this->_extra_data)
+					   && isset($this->_extra_data['data'])
+					   && $this->_extra_data['data'] instanceof EE_Messages_Addressee
+			? $this->_extra_data['data']->txn
+			: $transaction;
+		// payment
+		$payment = $this->_data->payment instanceof EE_Payment ? $this->_data->payment : null;
+		$payment = ! $payment instanceof EE_Payment
+				   && is_array($this->_extra_data)
+				   && isset($this->_extra_data['data'])
+				   && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment
+			: $payment;
+		if (! $transaction instanceof EE_Transaction) {
+			return '';
+		}
+		switch ($shortcode) {
+			case '[TXN_ID]':
+				return $transaction->ID();
+				break;
+			case '[PAYMENT_URL]':
+				$payment_url = $transaction->payment_overview_url();
+				return empty($payment_url)
+					? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso')
+					: $payment_url;
+				break;
+			case '[INVOICE_LINK]':
+				$invoice_url = $transaction->invoice_url();
+				$invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
+				return sprintf(
+					esc_html__('%sClick here for Invoice%s', 'event_espresso'),
+					'<a href="' . $invoice_url . '">',
+					'</a>'
+				);
+				break;
+			case '[INVOICE_URL]':
+				$invoice_url = $transaction->invoice_url();
+				return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
+				break;
+			case '[INVOICE_LOGO_URL]':
+				return $this->_get_invoice_logo();
+				break;
+			case '[INVOICE_LOGO]':
+				return $this->_get_invoice_logo(true);
+				break;
+			case '[INVOICE_PAYEE_NAME]':
+				return $this->_get_invoice_payee_name();
+				break;
+			case '[INVOICE_PAYEE_ADDRESS]':
+				return $this->_get_invoice_payee_address();
+				break;
+			case '[INVOICE_PAYMENT_INSTRUCTIONS]':
+				return $this->_get_invoice_payment_instructions();
+				break;
+			case '[INVOICE_PAYEE_EMAIL]':
+				return $this->_get_invoice_payee_email();
+				break;
+			case '[TOTAL_COST]':
+				$total = $transaction->total();
+				return ! empty($total) ? EEH_Template::format_currency($total) : '';
+				break;
+			case '[PAYMENT_STATUS]':
+				$status = $transaction->pretty_status();
+				return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
+				break; /**/
+			// note the [payment_status] shortcode is kind of misleading because payment status might be different
+			// from txn status so I'm adding this here for clarity.
+			case '[TXN_STATUS]':
+				$status = $transaction->pretty_status();
+				return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
+				break;
+			case '[TXN_STATUS_ID]':
+				return $transaction->status_ID();
+				break;
+			case '[PAYMENT_GATEWAY]':
+				return $this->_get_payment_gateway($transaction);
+				break;
+			case '[AMOUNT_PAID]':
+				return $payment instanceof EE_Payment
+					? EEH_Template::format_currency($payment->amount())
+					: EEH_Template::format_currency(0);
+				break;
+			case '[LAST_AMOUNT_PAID]':
+				$last_payment = $transaction->last_payment();
+				return $last_payment instanceof EE_Payment
+					? EEH_Template::format_currency($last_payment->amount())
+					: EEH_Template::format_currency(0);
+			case '[TOTAL_AMOUNT_PAID]':
+				return EEH_Template::format_currency($transaction->paid());
+				break;
+			case '[TOTAL_OWING]':
+				$total_owing = $transaction->remaining();
+				return EEH_Template::format_currency($total_owing);
+				break;
+			case '[TXN_SUBTOTAL]':
+				return EEH_Template::format_currency($this->_get_subtotal());
+				break;
+			case '[TXN_TAX_SUBTOTAL]':
+				return EEH_Template::format_currency($this->_get_subtotal(true));
+				break;
+			case '[TKT_QTY_PURCHASED]':
+			case '[TXN_TOTAL_TICKETS]':
+				return $this->_data->total_ticket_count;
+				break;
+			case '[TRANSACTION_ADMIN_URL]':
+				require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
+				$query_args = array(
+					'page'   => 'espresso_transactions',
+					'action' => 'view_transaction',
+					'TXN_ID' => $transaction->ID(),
+				);
+				$url = EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php'));
+				return $url;
+				break;
+			case '[RECEIPT_URL]':
+				// get primary_registration
+				$reg = $this->_data->primary_reg_obj;
+				if (! $reg instanceof EE_Registration) {
+					return '';
+				}
+				return $reg->receipt_url();
+				break;
+			case '[INVOICE_RECEIPT_SWITCHER_URL]':
+				return $this->_get_invoice_receipt_switcher(false);
+				break;
+			case '[INVOICE_RECEIPT_SWITCHER_BUTTON]':
+				return $this->_get_invoice_receipt_switcher();
+				break;
+			case '[LAST_PAYMENT_TRANSACTION_ID]':
+				$id = '';
+				$payment = $payment instanceof EE_Payment && $payment->ID() !== 0
+					? $payment
+					: $transaction->last_payment();
+				if ($payment instanceof EE_Payment) {
+					$id = $payment->txn_id_chq_nmbr();
+				}
+				return $id;
+				break;
+		}
+		if (strpos($shortcode, '[OWING_STATUS_MESSAGE_*') !== false) {
+			return $this->_get_custom_total_owing($shortcode);
+		}
+		if (strpos($shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*') !== false) {
+			return $this->_get_invoice_payee_tax_number($shortcode);
+		}
+		if (strpos($shortcode, '[PAYMENT_LINK_IF_NEEDED_*') !== false) {
+			return $this->_get_payment_link_if_needed($shortcode);
+		}
+		if (strpos($shortcode, '[PAYMENT_DUE_DATE_*') !== false) {
+			return $this->_get_payment_due_date($shortcode, $transaction);
+		}
+		return '';
+	}
+
+
+	/**
+	 * parser for the [OWING_STATUS_MESSAGE_*] attribute type shortcode
+	 *
+	 * @since 4.5.0
+	 * @param string $shortcode the incoming shortcode
+	 * @return string parsed.
+	 * @throws EE_Error
+	 */
+	private function _get_custom_total_owing($shortcode)
+	{
+		$valid_shortcodes = array('transaction');
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		// ensure default is set.
+		$addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
+			? $addressee->txn->remaining() : 0;
+		if ($total_owing > 0) {
+			$owing_content = ! empty($attrs['still_owing'])
+				? $attrs['still_owing']
+				: sprintf(
+					esc_html__('%sPlease make a payment.%s', 'event_espresso'),
+					'<a href="[PAYMENT_URL]" class="noPrint">',
+					'</a>'
+				);
+			$owing_content = $this->_shortcode_helper->parse_message_template(
+				$owing_content,
+				$addressee,
+				$valid_shortcodes,
+				$this->_message_type,
+				$this->_messenger,
+				$this->_message
+			);
+		} else {
+			$owing_content = ! empty($attrs['none_owing']) ? $attrs['none_owing'] : '';
+		}
+		return $owing_content;
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function _get_payment_gateway($transaction)
+	{
+		if ($transaction instanceof EE_Transaction) {
+			$pm = $transaction->payment_method();
+		} else {
+			$pm = null;
+		}
+		return $pm instanceof EE_Payment_Method ? $pm->name() : '';
+	}
+
+
+	/**
+	 * This retrieves a logo to be used for the invoice from whatever is set on the invoice logo settings page.  If its
+	 * not present then the organization logo is used if its found (set on the organization settings page).
+	 *
+	 * @param bool $img_tags TRUE means to return with the img tag wrappers.  False just returns the url to the image.
+	 * @return string url or html
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	private function _get_invoice_logo(bool $img_tags = false): string
+	{
+		$invoice_logo_url = '';
+		// try to get the invoice payment method's logo for this transaction image first
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$invoice_logo_url = $pm->get_extra_meta('pdf_logo_image', true);
+		}
+		if (empty($invoice_logo_url)) {
+			$invoice_logo_url = EE_Registry::instance()->CFG->organization->logo_url;
+		}
+		if (empty($invoice_logo_url)) {
+			return '';
+		}
+		if (! $img_tags) {
+			return $invoice_logo_url;
+		}
+		$invoice_logo_url = esc_url_raw($invoice_logo_url);
+		// image tags have been requested.
+		$image_size = @getimagesize($invoice_logo_url);
+		$image_width_attr = '';
+		// if image is wider than 300px, set the width to 300
+		if ($image_size !== false) {
+			$image_width = min($image_size[0], 300);
+			$image_width = esc_attr($image_width);
+			$image_width_attr = " width='$image_width'";
+		}
+		return '<img class="logo screen" src="' . $invoice_logo_url . '"' . $image_width_attr . ' alt="logo" />';
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee name shortcode
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_name()
+	{
+		$payee_name = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_name = $pm->get_extra_meta('pdf_payee_name', true);
+		}
+		$payee_name = empty($payee_name) ? EE_Registry::instance()->CFG->organization->get_pretty('name') : $payee_name;
+		return $payee_name;
+	}
+
+
+	/**
+	 * gets the default invoice payment method, but has a filter so it can be overridden
+	 *
+	 * @return EE_Payment_Method|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payment_method()
+	{
+		if (! $this->_invoice_pm instanceof EE_Payment_Method) {
+			$transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
+			$transaction = ! $transaction instanceof EE_Transaction
+						   && is_array($this->_extra_data)
+						   && isset($this->_extra_data['data'])
+						   && $this->_extra_data['data'] instanceof EE_Messages_Addressee
+				? $this->_extra_data['data']->txn : $transaction;
+			// get the invoice payment method, and remember it for the next call too
+			$this->_invoice_pm = apply_filters(
+				'FHEE__EE_Transaction_Shortcodes__get_payment_method__default',
+				EEM_Payment_Method::instance()->get_one_of_type('Invoice'),
+				$transaction
+			);
+		}
+		return $this->_invoice_pm;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee email shortcode
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_email()
+	{
+		$payee_email = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_email = $pm->get_extra_meta('pdf_payee_email', true);
+		}
+		$payee_email = empty($payee_email) ? EE_Registry::instance()->CFG->organization->get_pretty('email')
+			: $payee_email;
+		return $payee_email;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee tax number shortcode
+	 *
+	 * @since 4.5.0
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_tax_number($shortcode)
+	{
+		$payee_tax_number = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_tax_number = $pm->get_extra_meta('pdf_payee_tax_number', true);
+		}
+		$payee_tax_number = empty($payee_tax_number) ? EE_Registry::instance()->CFG->organization->vat
+			: $payee_tax_number;
+		if (empty($payee_tax_number)) {
+			return '';
+		}
+		// any attributes?
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		// prefix?
+		$prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso');
+		return $prefix . $payee_tax_number;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee address shortcode.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_address()
+	{
+		$payee_address = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_address = $pm->get_extra_meta('pdf_payee_address', true);
+		}
+		if (empty($payee_address)) {
+			$organization = EE_Registry::instance()->CFG->organization;
+			$payee_address = $organization->get_pretty('address_1') . '<br>';
+			$payee_address .= ! empty($organization->address_2)
+				? $organization->get_pretty('address_2') . '<br>'
+				: '';
+			$payee_address .= $organization->get_pretty('city') . '<br>';
+			// state
+			$state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
+			$payee_address .= $state instanceof EE_State ? $state->name() : '';
+			// Country
+			$payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : '';
+			$payee_address .= ! empty($organization->zip) ? $organization->zip : '';
+		}
+		return $payee_address;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payment instructions shortcode.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payment_instructions()
+	{
+		$instructions = null;
+		$pm = $this->_get_invoice_payment_method();
+		return ($pm instanceof EE_Payment_Method) ? $pm->get_extra_meta('pdf_instructions', true) : '';
+	}
+
+
+	/**
+	 * get invoice/receipt switch button or url.
+	 *
+	 * @param bool $button true (default) returns the html for a button, false just returns the url.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_invoice_receipt_switcher($button = true)
+	{
+		$reg = $this->_data->primary_reg_obj;
+		$message_type = isset($this->_extra_data['message_type']) ? $this->_extra_data['message_type'] : '';
+		if (! $reg instanceof EE_Registration || empty($message_type)) {
+			return '';
+		}
+		$switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type ? true : false;
+		$switch_to_label = $switch_to_invoice && ! $message_type instanceof EE_Receipt_message_type
+			? esc_html__('View Invoice', 'event_espresso') : esc_html__('Switch to Invoice', 'event_espresso');
+		$switch_to_label = ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label;
+		$switch_to_url = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url();
+		if (! $button) {
+			return $switch_to_url;
+		}
+		if (! empty($switch_to_url)) {
+			return '
 	<form method="post" action="' . $switch_to_url . '" >
 		<input class="print_button" type="submit" value="' . $switch_to_label . '" />
 	</form>
 			';
-        }
-        return '';
-    }
-
-
-    /**
-     * This returns a subtotal.
-     *
-     * @param bool $tax if true then return the subtotal for tax otherwise return subtotal.
-     * @return int
-     * @throws EE_Error
-     */
-    private function _get_subtotal($tax = false)
-    {
-        $grand_total = isset($this->_data->grand_total_line_item) ? $this->_data->grand_total_line_item : null;
-        if (! $grand_total instanceof EE_Line_Item) {
-            return 0;
-        }
-        return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total();
-    }
-
-
-    /**
-     * parser for the [PAYMENT_LINK_IF_NEEDED_*] attribute type shortcode
-     *
-     * @since 4.7.0
-     * @param string $shortcode the incoming shortcode
-     * @return string parsed.
-     * @throws EE_Error
-     */
-    private function _get_payment_link_if_needed($shortcode)
-    {
-        $valid_shortcodes = array('transaction');
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        // ensure default is set.
-        $addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
-            ? $addressee->txn->remaining() : 0;
-        if ($total_owing > 0) {
-            $class = isset($attrs['class']) ? $attrs['class'] : 'callout';
-            $custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
-            $container_tag = isset($attrs['container_tag']) ? $attrs['container_tag'] : 'p';
-            $opening_tag = ! empty($container_tag) ? '<' . $container_tag : '';
-            $opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag;
-            $opening_tag .= ! empty($opening_tag) ? '>' : $opening_tag;
-            $closing_tag = ! empty($container_tag) ? '</' . $container_tag . '>' : '';
-            $content = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag;
-            // we need to re run this string through the parser to catch any shortcodes that are in it.
-            $owing_content = $this->_shortcode_helper->parse_message_template(
-                $content,
-                $addressee,
-                $valid_shortcodes,
-                $this->_message_type,
-                $this->_messenger,
-                $this->_message
-            );
-        } else {
-            return '';
-        }
-        return $owing_content;
-    }
-
-
-    /**
-     * Parser for the [PAYMENT_DUE_DATE_*] attribute type shortcode
-     *
-     * @since 4.8.28.rc.011
-     * @param string         $shortcode The shortcode being parsed.
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_payment_due_date($shortcode, EE_Transaction $transaction)
-    {
-        // if transaction is paid in full then we can just return an empty string
-        if ($transaction->remaining() === 0) {
-            return '';
-        }
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        $format = isset($attrs['format']) ? $attrs['format'] : get_option('date_format');
-        $days_until_due = isset($attrs['days_until_due']) ? (int) $attrs['days_until_due'] : 30;
-        $prefix_text = isset($attrs['prefix_text']) ? $attrs['prefix_text']
-            : esc_html__('Payment in full due by: ', 'event_espresso');
-        $transaction_created = $transaction->get_DateTime_object('TXN_timestamp');
-        // setup date due:
-        try {
-            if ($transaction_created instanceof DateTime) {
-                $date_due = $transaction_created->add(
-                    new DateInterval('P' . $days_until_due . 'D')
-                )->format($format);
-            } else {
-                throw new Exception();
-            }
-        } catch (Exception $e) {
-            // format was likely invalid.
-            $date_due = esc_html__(
-                'Unable to calculate date due, likely the format string is invalid.',
-                'event_espresso'
-            );
-        }
-        return $prefix_text . $date_due;
-    }
+		}
+		return '';
+	}
+
+
+	/**
+	 * This returns a subtotal.
+	 *
+	 * @param bool $tax if true then return the subtotal for tax otherwise return subtotal.
+	 * @return int
+	 * @throws EE_Error
+	 */
+	private function _get_subtotal($tax = false)
+	{
+		$grand_total = isset($this->_data->grand_total_line_item) ? $this->_data->grand_total_line_item : null;
+		if (! $grand_total instanceof EE_Line_Item) {
+			return 0;
+		}
+		return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total();
+	}
+
+
+	/**
+	 * parser for the [PAYMENT_LINK_IF_NEEDED_*] attribute type shortcode
+	 *
+	 * @since 4.7.0
+	 * @param string $shortcode the incoming shortcode
+	 * @return string parsed.
+	 * @throws EE_Error
+	 */
+	private function _get_payment_link_if_needed($shortcode)
+	{
+		$valid_shortcodes = array('transaction');
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		// ensure default is set.
+		$addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
+			? $addressee->txn->remaining() : 0;
+		if ($total_owing > 0) {
+			$class = isset($attrs['class']) ? $attrs['class'] : 'callout';
+			$custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
+			$container_tag = isset($attrs['container_tag']) ? $attrs['container_tag'] : 'p';
+			$opening_tag = ! empty($container_tag) ? '<' . $container_tag : '';
+			$opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag;
+			$opening_tag .= ! empty($opening_tag) ? '>' : $opening_tag;
+			$closing_tag = ! empty($container_tag) ? '</' . $container_tag . '>' : '';
+			$content = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag;
+			// we need to re run this string through the parser to catch any shortcodes that are in it.
+			$owing_content = $this->_shortcode_helper->parse_message_template(
+				$content,
+				$addressee,
+				$valid_shortcodes,
+				$this->_message_type,
+				$this->_messenger,
+				$this->_message
+			);
+		} else {
+			return '';
+		}
+		return $owing_content;
+	}
+
+
+	/**
+	 * Parser for the [PAYMENT_DUE_DATE_*] attribute type shortcode
+	 *
+	 * @since 4.8.28.rc.011
+	 * @param string         $shortcode The shortcode being parsed.
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_payment_due_date($shortcode, EE_Transaction $transaction)
+	{
+		// if transaction is paid in full then we can just return an empty string
+		if ($transaction->remaining() === 0) {
+			return '';
+		}
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		$format = isset($attrs['format']) ? $attrs['format'] : get_option('date_format');
+		$days_until_due = isset($attrs['days_until_due']) ? (int) $attrs['days_until_due'] : 30;
+		$prefix_text = isset($attrs['prefix_text']) ? $attrs['prefix_text']
+			: esc_html__('Payment in full due by: ', 'event_espresso');
+		$transaction_created = $transaction->get_DateTime_object('TXN_timestamp');
+		// setup date due:
+		try {
+			if ($transaction_created instanceof DateTime) {
+				$date_due = $transaction_created->add(
+					new DateInterval('P' . $days_until_due . 'D')
+				)->format($format);
+			} else {
+				throw new Exception();
+			}
+		} catch (Exception $e) {
+			// format was likely invalid.
+			$date_due = esc_html__(
+				'Unable to calculate date due, likely the format string is invalid.',
+				'event_espresso'
+			);
+		}
+		return $prefix_text . $date_due;
+	}
 }

core/libraries/shortcodes/EE_Datetime_Shortcodes.lib.php

Indentation +73 added lines, -73 removed lines

@@ -15,77 +15,77 @@
  */
 class EE_Datetime_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * @return void
-     */
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Datetime Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to datetime related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[DATETIME_START]' => esc_html__('The start date and time.', 'event_espresso'),
-            '[DATETIME_END]' => esc_html__('The end date and time.', 'event_espresso'),
-            '[DATETIME_TIMEZONE]' => esc_html__('The timezone for the date and time', 'event_espresso'),
-            '[DATE_START]' => esc_html__('The datetime start date.', 'event_espresso'),
-            '[DATE_END]' => esc_html__('The datetime end date.', 'event_espresso'),
-            '[TIME_START]' => esc_html__('The datetime start time.', 'event_espresso'),
-            '[TIME_END]' => esc_html__('The datetime end time.', 'event_espresso'),
-            '[ICAL_LINK_*]' => esc_html__(
-                'The datetime iCal link. The optional "link_text" attribute can be used to set custom text within the link (Default is "Add to iCal Calendar").',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    /**
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-
-        if (! $this->_data instanceof EE_Datetime) {
-            return ''; // get out cause we can only parse with the datetime object.
-        }
-
-        switch ($shortcode) {
-            case '[DATETIME_START]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_start');
-
-            case '[DATETIME_END]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_end');
-
-            case '[DATETIME_TIMEZONE]':
-                return $this->_data->get_timezone();
-
-            case '[DATE_START]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('date_format'));
-
-            case '[DATE_END]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('date_format'));
-
-            case '[TIME_START]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('time_format'));
-
-            case '[TIME_END]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('time_format'));
-
-        }
-
-        if (strpos($shortcode, '[ICAL_LINK_*') !== false) {
-            $attrs = $this->_get_shortcode_attrs($shortcode);
-
-            $link_text = empty($attrs['link_text']) ? esc_html__('Add to iCal Calendar', 'event_espresso')
-                : $attrs['link_text'];
-
-            $URL = add_query_arg(array('ee' => 'download_ics_file', 'ics_id' => $this->_data->ID()), site_url());
-
-            return '<a class="ee-ical" href="' . $URL . '">' . $link_text . '</a>';
-        }
-
-        return '';
-    }
+	/**
+	 * @return void
+	 */
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Datetime Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to datetime related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[DATETIME_START]' => esc_html__('The start date and time.', 'event_espresso'),
+			'[DATETIME_END]' => esc_html__('The end date and time.', 'event_espresso'),
+			'[DATETIME_TIMEZONE]' => esc_html__('The timezone for the date and time', 'event_espresso'),
+			'[DATE_START]' => esc_html__('The datetime start date.', 'event_espresso'),
+			'[DATE_END]' => esc_html__('The datetime end date.', 'event_espresso'),
+			'[TIME_START]' => esc_html__('The datetime start time.', 'event_espresso'),
+			'[TIME_END]' => esc_html__('The datetime end time.', 'event_espresso'),
+			'[ICAL_LINK_*]' => esc_html__(
+				'The datetime iCal link. The optional "link_text" attribute can be used to set custom text within the link (Default is "Add to iCal Calendar").',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	/**
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+
+		if (! $this->_data instanceof EE_Datetime) {
+			return ''; // get out cause we can only parse with the datetime object.
+		}
+
+		switch ($shortcode) {
+			case '[DATETIME_START]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_start');
+
+			case '[DATETIME_END]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_end');
+
+			case '[DATETIME_TIMEZONE]':
+				return $this->_data->get_timezone();
+
+			case '[DATE_START]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('date_format'));
+
+			case '[DATE_END]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('date_format'));
+
+			case '[TIME_START]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('time_format'));
+
+			case '[TIME_END]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('time_format'));
+
+		}
+
+		if (strpos($shortcode, '[ICAL_LINK_*') !== false) {
+			$attrs = $this->_get_shortcode_attrs($shortcode);
+
+			$link_text = empty($attrs['link_text']) ? esc_html__('Add to iCal Calendar', 'event_espresso')
+				: $attrs['link_text'];
+
+			$URL = add_query_arg(array('ee' => 'download_ics_file', 'ics_id' => $this->_data->ID()), site_url());
+
+			return '<a class="ee-ical" href="' . $URL . '">' . $link_text . '</a>';
+		}
+
+		return '';
+	}
 }

core/libraries/batch/JobHandlers/DatetimeOffsetFix.php

Indentation +473 added lines, -473 removed lines

@@ -23,477 +23,477 @@
 
 class DatetimeOffsetFix extends JobHandler
 {
-    /**
-     * Key for the option used to track which models have been processed when doing the batches.
-     */
-    const MODELS_TO_PROCESS_OPTION_KEY = 'ee_models_processed_for_datetime_offset_fix';
-
-
-    const COUNT_OF_MODELS_PROCESSED = 'ee_count_of_ee_models_processed_for_datetime_offset_fixed';
-
-    /**
-     * Key for the option used to track what the current offset is that will be applied when this tool is executed.
-     */
-    const OFFSET_TO_APPLY_OPTION_KEY = 'ee_datetime_offset_fix_offset_to_apply';
-
-
-    const OPTION_KEY_OFFSET_RANGE_START_DATE = 'ee_datetime_offset_start_date_range';
-
-
-    const OPTION_KEY_OFFSET_RANGE_END_DATE = 'ee_datetime_offset_end_date_range';
-
-
-    /**
-     * String labelling the datetime offset fix type for change-log entries.
-     */
-    const DATETIME_OFFSET_FIX_CHANGELOG_TYPE = 'datetime_offset_fix';
-
-
-    /**
-     * String labelling a datetime offset fix error for change-log entries.
-     */
-    const DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE = 'datetime_offset_fix_error';
-
-    /**
-     * @var EEM_Base[]
-     */
-    protected $models_with_datetime_fields = array();
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to setup the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function create_job(JobParameters $job_parameters): JobStepResponse
-    {
-        $models_with_datetime_fields = $this->getModelsWithDatetimeFields();
-        // we'll be doing each model as a batch.
-        $job_parameters->set_job_size(count($models_with_datetime_fields));
-        return new JobStepResponse(
-            $job_parameters,
-            esc_html__('Starting Datetime Offset Fix', 'event_espresso')
-        );
-    }
-
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
-    {
-        $models_to_process = $this->getModelsWithDatetimeFields();
-        // let's pop off the a model and do the query to apply the offset.
-        $model_to_process = array_pop($models_to_process);
-        // update our record
-        $this->setModelsToProcess($models_to_process);
-        $this->processModel($model_to_process);
-        $this->updateCountOfModelsProcessed();
-        $job_parameters->set_units_processed($this->getCountOfModelsProcessed());
-        if (count($models_to_process) > 0) {
-            $job_parameters->set_status(JobParameters::status_continue);
-        } else {
-            $job_parameters->set_status(JobParameters::status_complete);
-        }
-        return new JobStepResponse(
-            $job_parameters,
-            sprintf(
-                esc_html__('Updated the offset for all datetime fields on the %s model.', 'event_espresso'),
-                $model_to_process
-            )
-        );
-    }
-
-    /**
-     * Performs any clean-up logic when we know the job is completed
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function cleanup_job(JobParameters $job_parameters): JobStepResponse
-    {
-        // delete important saved options.
-        delete_option(self::MODELS_TO_PROCESS_OPTION_KEY);
-        delete_option(self::COUNT_OF_MODELS_PROCESSED);
-        delete_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE);
-        delete_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE);
-        return new JobStepResponse($job_parameters, esc_html__(
-            'Offset has been applied to all affected fields.',
-            'event_espresso'
-        ));
-    }
-
-
-    /**
-     * Contains the logic for processing a model and applying the datetime offset to affected fields on that model.
-     *
-     * @param string $model_class_name
-     * @throws EE_Error
-     */
-    protected function processModel($model_class_name)
-    {
-        global $wpdb;
-        /** @var EEM_Base $model */
-        $model = $model_class_name::instance();
-        $original_offset = self::getOffset();
-        $start_date_range = self::getStartDateRange();
-        $end_date_range = self::getEndDateRange();
-        $sql_date_function = $original_offset > 0 ? 'DATE_ADD' : 'DATE_SUB';
-        $offset = abs($original_offset) * 60;
-        $date_ranges = array();
-        // since some affected models might have two tables, we have to get our tables and set up a query for each table.
-        foreach ($model->get_tables() as $table) {
-            $query = 'UPDATE ' . $table->get_table_name();
-            $fields_affected = array();
-            $inner_query = array();
-            foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) {
-                if ($model_field instanceof EE_Datetime_Field) {
-                    $inner_query[ $model_field->get_table_column() ] = $model_field->get_table_column() . ' = '
-                                                                       . $sql_date_function . '('
-                                                                       . $model_field->get_table_column()
-                                                                       . ", INTERVAL {$offset} MINUTE)";
-                    $fields_affected[] = $model_field;
-                }
-            }
-            if (! $fields_affected) {
-                continue;
-            }
-            // do we do one query per column/field or one query for all fields on the model? It all depends on whether
-            // there is a date range applied or not.
-            if ($start_date_range instanceof DbSafeDateTime || $end_date_range instanceof DbSafeDateTime) {
-                $result = $this->doQueryForEachField($query, $inner_query, $start_date_range, $end_date_range);
-            } else {
-                $result = $this->doQueryForAllFields($query, $inner_query);
-            }
-
-            // record appropriate logs for the query
-            switch (true) {
-                case $result === false:
-                    // record error.
-                    $error_message = $wpdb->last_error;
-                    // handle the edge cases where last_error might be empty.
-                    if (! $error_message) {
-                        $error_message = esc_html__('Unknown mysql error occurred.', 'event_espresso');
-                    }
-                    $this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
-                    break;
-                case is_array($result) && ! empty($result):
-                    foreach ($result as $field_name => $error_message) {
-                        $this->recordChangeLog($model, $original_offset, $table, array($field_name), $error_message);
-                    }
-                    break;
-                default:
-                    $this->recordChangeLog($model, $original_offset, $table, $fields_affected);
-            }
-        }
-    }
-
-
-    /**
-     * Does the query on each $inner_query individually.
-     *
-     * @param string              $query
-     * @param array               $inner_query
-     * @param DbSafeDateTime|null $start_date_range
-     * @param DbSafeDateTime|null $end_date_range
-     * @return array  An array of any errors encountered and the fields they were for.
-     */
-    private function doQueryForEachField($query, array $inner_query, $start_date_range, $end_date_range)
-    {
-        global $wpdb;
-        $errors = array();
-        foreach ($inner_query as $field_name => $field_query) {
-            $query_to_run = $query;
-            $where_conditions = array();
-            $query_to_run .= ' SET ' . $field_query;
-            if ($start_date_range instanceof DbSafeDateTime) {
-                $start_date = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
-                $where_conditions[] = "{$field_name} > '{$start_date}'";
-            }
-            if ($end_date_range instanceof DbSafeDateTime) {
-                $end_date = $end_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
-                $where_conditions[] = "{$field_name} < '{$end_date}'";
-            }
-            if ($where_conditions) {
-                $query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions);
-            }
-            $result = $wpdb->query($query_to_run);
-            if ($result === false) {
-                // record error.
-                $error_message = $wpdb->last_error;
-                // handle the edgecases where last_error might be empty.
-                if (! $error_message) {
-                    $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
-                }
-                $errors[ $field_name ] = $error_message;
-            }
-        }
-        return $errors;
-    }
-
-
-    /**
-     * Performs the query for all fields within the inner_query
-     *
-     * @param string $query
-     * @param array  $inner_query
-     * @return false|int
-     */
-    private function doQueryForAllFields($query, array $inner_query)
-    {
-        global $wpdb;
-        $query .= ' SET ' . implode(',', $inner_query);
-        return $wpdb->query($query);
-    }
-
-
-    /**
-     * Records a changelog entry using the given information.
-     *
-     * @param EEM_Base              $model
-     * @param float                 $offset
-     * @param EE_Table_Base         $table
-     * @param EE_Model_Field_Base[] $model_fields_affected
-     * @param string                $error_message If present then there was an error so let's record that instead.
-     * @throws EE_Error
-     */
-    private function recordChangeLog(
-        EEM_Base $model,
-        $offset,
-        EE_Table_Base $table,
-        $model_fields_affected,
-        $error_message = ''
-    ) {
-        // setup $fields list.
-        $fields = array();
-        /** @var EE_Datetime_Field $model_field */
-        foreach ($model_fields_affected as $model_field) {
-            if (! $model_field instanceof EE_Datetime_Field) {
-                continue;
-            }
-            $fields[] = $model_field->get_name();
-        }
-        // setup the message for the changelog entry.
-        $message = $error_message
-            ? sprintf(
-                esc_html__(
-                    'The %1$s table for the %2$s model did not have the offset of %3$f applied to its fields (%4$s), because of the following error:%5$s',
-                    'event_espresso'
-                ),
-                $table->get_table_name(),
-                $model->get_this_model_name(),
-                $offset,
-                implode(',', $fields),
-                $error_message
-            )
-            : sprintf(
-                esc_html__(
-                    'The %1$s table for the %2$s model has had the offset of %3$f applied to its following fields: %4$s',
-                    'event_espresso'
-                ),
-                $table->get_table_name(),
-                $model->get_this_model_name(),
-                $offset,
-                implode(',', $fields)
-            );
-        // write to the log
-        $changelog = EE_Change_Log::new_instance(array(
-            'LOG_type'    => $error_message
-                ? self::DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE
-                : self::DATETIME_OFFSET_FIX_CHANGELOG_TYPE,
-            'LOG_message' => $message,
-        ));
-        $changelog->save();
-    }
-
-
-    /**
-     * Returns an array of models that have datetime fields.
-     * This array is added to a short lived transient cache to keep having to build this list to a minimum.
-     *
-     * @return array an array of model class names.
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function getModelsWithDatetimeFields()
-    {
-        $this->getModelsToProcess();
-        if (! empty($this->models_with_datetime_fields)) {
-            return $this->models_with_datetime_fields;
-        }
-
-        $all_non_abstract_models = EE_Registry::instance()->non_abstract_db_models;
-        foreach ($all_non_abstract_models as $non_abstract_model) {
-            // get model instance
-            /** @var EEM_Base $non_abstract_model */
-            $non_abstract_model = $non_abstract_model::instance();
-            if ($non_abstract_model->get_a_field_of_type('EE_Datetime_Field') instanceof EE_Datetime_Field) {
-                $this->models_with_datetime_fields[] = get_class($non_abstract_model);
-            }
-        }
-        $this->setModelsToProcess($this->models_with_datetime_fields);
-        return $this->models_with_datetime_fields;
-    }
-
-
-    /**
-     * This simply records the models that have been processed with our tracking option.
-     *
-     * @param array $models_to_set array of model class names.
-     */
-    private function setModelsToProcess($models_to_set)
-    {
-        update_option(self::MODELS_TO_PROCESS_OPTION_KEY, $models_to_set);
-    }
-
-
-    /**
-     * Used to keep track of how many models have been processed for the batch
-     *
-     * @param $count
-     */
-    private function updateCountOfModelsProcessed($count = 1)
-    {
-        $count = $this->getCountOfModelsProcessed() + (int) $count;
-        update_option(self::COUNT_OF_MODELS_PROCESSED, $count);
-    }
-
-
-    /**
-     * Retrieve the tracked number of models processed between requests.
-     *
-     * @return int
-     */
-    private function getCountOfModelsProcessed()
-    {
-        return (int) get_option(self::COUNT_OF_MODELS_PROCESSED, 0);
-    }
-
-
-    /**
-     * Returns the models that are left to process.
-     *
-     * @return array  an array of model class names.
-     */
-    private function getModelsToProcess()
-    {
-        if (empty($this->models_with_datetime_fields)) {
-            $this->models_with_datetime_fields = get_option(self::MODELS_TO_PROCESS_OPTION_KEY, array());
-        }
-        return $this->models_with_datetime_fields;
-    }
-
-
-    /**
-     * Used to record the offset that will be applied to dates and times for EE_Datetime_Field columns.
-     *
-     * @param float $offset
-     */
-    public static function updateOffset($offset)
-    {
-        update_option(self::OFFSET_TO_APPLY_OPTION_KEY, $offset);
-    }
-
-
-    /**
-     * Used to retrieve the saved offset that will be applied to dates and times for EE_Datetime_Field columns.
-     *
-     * @return float
-     */
-    public static function getOffset()
-    {
-        return (float) get_option(self::OFFSET_TO_APPLY_OPTION_KEY, 0);
-    }
-
-
-    /**
-     * Used to set the saved offset range start date.
-     *
-     * @param DbSafeDateTime|null $start_date
-     */
-    public static function updateStartDateRange(DbSafeDateTime $start_date = null)
-    {
-        $date_to_save = $start_date instanceof DbSafeDateTime
-            ? $start_date->format('U')
-            : '';
-        update_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, $date_to_save);
-    }
-
-
-    /**
-     * Used to get the saved offset range start date.
-     *
-     * @return DbSafeDateTime|null
-     */
-    public static function getStartDateRange(): ?DbSafeDateTime
-    {
-        $start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, null);
-        if (! $start_date) {
-            return null;
-        }
-        try {
-            $datetime = DateTime::createFromFormat('U', $start_date, new DateTimeZone('UTC'));
-            $start_date = $datetime instanceof DateTime
-                ? DbSafeDateTime::createFromDateTime($datetime)
-                : null;
-        } catch (Exception $e) {
-            $start_date = null;
-        }
-        return $start_date;
-    }
-
-
-    /**
-     * Used to set the saved offset range end date.
-     *
-     * @param DbSafeDateTime|null $end_date
-     */
-    public static function updateEndDateRange(DbSafeDateTime $end_date = null)
-    {
-        $date_to_save = $end_date instanceof DbSafeDateTime
-            ? $end_date->format('U')
-            : '';
-        update_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, $date_to_save);
-    }
-
-
-    /**
-     * Used to get the saved offset range end date.
-     *
-     * @return DbSafeDateTime|null
-     */
-    public static function getEndDateRange(): ?DbSafeDateTime
-    {
-        $end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, null);
-        if (! $end_date) {
-            return null;
-        }
-        try {
-            $datetime = DateTime::createFromFormat('U', $end_date, new DateTimeZone('UTC'));
-            $end_date = $datetime instanceof Datetime
-                ? DbSafeDateTime::createFromDateTime($datetime)
-                : null;
-        } catch (Exception $e) {
-            $end_date = null;
-        }
-        return $end_date;
-    }
+	/**
+	 * Key for the option used to track which models have been processed when doing the batches.
+	 */
+	const MODELS_TO_PROCESS_OPTION_KEY = 'ee_models_processed_for_datetime_offset_fix';
+
+
+	const COUNT_OF_MODELS_PROCESSED = 'ee_count_of_ee_models_processed_for_datetime_offset_fixed';
+
+	/**
+	 * Key for the option used to track what the current offset is that will be applied when this tool is executed.
+	 */
+	const OFFSET_TO_APPLY_OPTION_KEY = 'ee_datetime_offset_fix_offset_to_apply';
+
+
+	const OPTION_KEY_OFFSET_RANGE_START_DATE = 'ee_datetime_offset_start_date_range';
+
+
+	const OPTION_KEY_OFFSET_RANGE_END_DATE = 'ee_datetime_offset_end_date_range';
+
+
+	/**
+	 * String labelling the datetime offset fix type for change-log entries.
+	 */
+	const DATETIME_OFFSET_FIX_CHANGELOG_TYPE = 'datetime_offset_fix';
+
+
+	/**
+	 * String labelling a datetime offset fix error for change-log entries.
+	 */
+	const DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE = 'datetime_offset_fix_error';
+
+	/**
+	 * @var EEM_Base[]
+	 */
+	protected $models_with_datetime_fields = array();
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to setup the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function create_job(JobParameters $job_parameters): JobStepResponse
+	{
+		$models_with_datetime_fields = $this->getModelsWithDatetimeFields();
+		// we'll be doing each model as a batch.
+		$job_parameters->set_job_size(count($models_with_datetime_fields));
+		return new JobStepResponse(
+			$job_parameters,
+			esc_html__('Starting Datetime Offset Fix', 'event_espresso')
+		);
+	}
+
+	/**
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
+	{
+		$models_to_process = $this->getModelsWithDatetimeFields();
+		// let's pop off the a model and do the query to apply the offset.
+		$model_to_process = array_pop($models_to_process);
+		// update our record
+		$this->setModelsToProcess($models_to_process);
+		$this->processModel($model_to_process);
+		$this->updateCountOfModelsProcessed();
+		$job_parameters->set_units_processed($this->getCountOfModelsProcessed());
+		if (count($models_to_process) > 0) {
+			$job_parameters->set_status(JobParameters::status_continue);
+		} else {
+			$job_parameters->set_status(JobParameters::status_complete);
+		}
+		return new JobStepResponse(
+			$job_parameters,
+			sprintf(
+				esc_html__('Updated the offset for all datetime fields on the %s model.', 'event_espresso'),
+				$model_to_process
+			)
+		);
+	}
+
+	/**
+	 * Performs any clean-up logic when we know the job is completed
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function cleanup_job(JobParameters $job_parameters): JobStepResponse
+	{
+		// delete important saved options.
+		delete_option(self::MODELS_TO_PROCESS_OPTION_KEY);
+		delete_option(self::COUNT_OF_MODELS_PROCESSED);
+		delete_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE);
+		delete_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE);
+		return new JobStepResponse($job_parameters, esc_html__(
+			'Offset has been applied to all affected fields.',
+			'event_espresso'
+		));
+	}
+
+
+	/**
+	 * Contains the logic for processing a model and applying the datetime offset to affected fields on that model.
+	 *
+	 * @param string $model_class_name
+	 * @throws EE_Error
+	 */
+	protected function processModel($model_class_name)
+	{
+		global $wpdb;
+		/** @var EEM_Base $model */
+		$model = $model_class_name::instance();
+		$original_offset = self::getOffset();
+		$start_date_range = self::getStartDateRange();
+		$end_date_range = self::getEndDateRange();
+		$sql_date_function = $original_offset > 0 ? 'DATE_ADD' : 'DATE_SUB';
+		$offset = abs($original_offset) * 60;
+		$date_ranges = array();
+		// since some affected models might have two tables, we have to get our tables and set up a query for each table.
+		foreach ($model->get_tables() as $table) {
+			$query = 'UPDATE ' . $table->get_table_name();
+			$fields_affected = array();
+			$inner_query = array();
+			foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) {
+				if ($model_field instanceof EE_Datetime_Field) {
+					$inner_query[ $model_field->get_table_column() ] = $model_field->get_table_column() . ' = '
+																	   . $sql_date_function . '('
+																	   . $model_field->get_table_column()
+																	   . ", INTERVAL {$offset} MINUTE)";
+					$fields_affected[] = $model_field;
+				}
+			}
+			if (! $fields_affected) {
+				continue;
+			}
+			// do we do one query per column/field or one query for all fields on the model? It all depends on whether
+			// there is a date range applied or not.
+			if ($start_date_range instanceof DbSafeDateTime || $end_date_range instanceof DbSafeDateTime) {
+				$result = $this->doQueryForEachField($query, $inner_query, $start_date_range, $end_date_range);
+			} else {
+				$result = $this->doQueryForAllFields($query, $inner_query);
+			}
+
+			// record appropriate logs for the query
+			switch (true) {
+				case $result === false:
+					// record error.
+					$error_message = $wpdb->last_error;
+					// handle the edge cases where last_error might be empty.
+					if (! $error_message) {
+						$error_message = esc_html__('Unknown mysql error occurred.', 'event_espresso');
+					}
+					$this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
+					break;
+				case is_array($result) && ! empty($result):
+					foreach ($result as $field_name => $error_message) {
+						$this->recordChangeLog($model, $original_offset, $table, array($field_name), $error_message);
+					}
+					break;
+				default:
+					$this->recordChangeLog($model, $original_offset, $table, $fields_affected);
+			}
+		}
+	}
+
+
+	/**
+	 * Does the query on each $inner_query individually.
+	 *
+	 * @param string              $query
+	 * @param array               $inner_query
+	 * @param DbSafeDateTime|null $start_date_range
+	 * @param DbSafeDateTime|null $end_date_range
+	 * @return array  An array of any errors encountered and the fields they were for.
+	 */
+	private function doQueryForEachField($query, array $inner_query, $start_date_range, $end_date_range)
+	{
+		global $wpdb;
+		$errors = array();
+		foreach ($inner_query as $field_name => $field_query) {
+			$query_to_run = $query;
+			$where_conditions = array();
+			$query_to_run .= ' SET ' . $field_query;
+			if ($start_date_range instanceof DbSafeDateTime) {
+				$start_date = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
+				$where_conditions[] = "{$field_name} > '{$start_date}'";
+			}
+			if ($end_date_range instanceof DbSafeDateTime) {
+				$end_date = $end_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
+				$where_conditions[] = "{$field_name} < '{$end_date}'";
+			}
+			if ($where_conditions) {
+				$query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions);
+			}
+			$result = $wpdb->query($query_to_run);
+			if ($result === false) {
+				// record error.
+				$error_message = $wpdb->last_error;
+				// handle the edgecases where last_error might be empty.
+				if (! $error_message) {
+					$error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
+				}
+				$errors[ $field_name ] = $error_message;
+			}
+		}
+		return $errors;
+	}
+
+
+	/**
+	 * Performs the query for all fields within the inner_query
+	 *
+	 * @param string $query
+	 * @param array  $inner_query
+	 * @return false|int
+	 */
+	private function doQueryForAllFields($query, array $inner_query)
+	{
+		global $wpdb;
+		$query .= ' SET ' . implode(',', $inner_query);
+		return $wpdb->query($query);
+	}
+
+
+	/**
+	 * Records a changelog entry using the given information.
+	 *
+	 * @param EEM_Base              $model
+	 * @param float                 $offset
+	 * @param EE_Table_Base         $table
+	 * @param EE_Model_Field_Base[] $model_fields_affected
+	 * @param string                $error_message If present then there was an error so let's record that instead.
+	 * @throws EE_Error
+	 */
+	private function recordChangeLog(
+		EEM_Base $model,
+		$offset,
+		EE_Table_Base $table,
+		$model_fields_affected,
+		$error_message = ''
+	) {
+		// setup $fields list.
+		$fields = array();
+		/** @var EE_Datetime_Field $model_field */
+		foreach ($model_fields_affected as $model_field) {
+			if (! $model_field instanceof EE_Datetime_Field) {
+				continue;
+			}
+			$fields[] = $model_field->get_name();
+		}
+		// setup the message for the changelog entry.
+		$message = $error_message
+			? sprintf(
+				esc_html__(
+					'The %1$s table for the %2$s model did not have the offset of %3$f applied to its fields (%4$s), because of the following error:%5$s',
+					'event_espresso'
+				),
+				$table->get_table_name(),
+				$model->get_this_model_name(),
+				$offset,
+				implode(',', $fields),
+				$error_message
+			)
+			: sprintf(
+				esc_html__(
+					'The %1$s table for the %2$s model has had the offset of %3$f applied to its following fields: %4$s',
+					'event_espresso'
+				),
+				$table->get_table_name(),
+				$model->get_this_model_name(),
+				$offset,
+				implode(',', $fields)
+			);
+		// write to the log
+		$changelog = EE_Change_Log::new_instance(array(
+			'LOG_type'    => $error_message
+				? self::DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE
+				: self::DATETIME_OFFSET_FIX_CHANGELOG_TYPE,
+			'LOG_message' => $message,
+		));
+		$changelog->save();
+	}
+
+
+	/**
+	 * Returns an array of models that have datetime fields.
+	 * This array is added to a short lived transient cache to keep having to build this list to a minimum.
+	 *
+	 * @return array an array of model class names.
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function getModelsWithDatetimeFields()
+	{
+		$this->getModelsToProcess();
+		if (! empty($this->models_with_datetime_fields)) {
+			return $this->models_with_datetime_fields;
+		}
+
+		$all_non_abstract_models = EE_Registry::instance()->non_abstract_db_models;
+		foreach ($all_non_abstract_models as $non_abstract_model) {
+			// get model instance
+			/** @var EEM_Base $non_abstract_model */
+			$non_abstract_model = $non_abstract_model::instance();
+			if ($non_abstract_model->get_a_field_of_type('EE_Datetime_Field') instanceof EE_Datetime_Field) {
+				$this->models_with_datetime_fields[] = get_class($non_abstract_model);
+			}
+		}
+		$this->setModelsToProcess($this->models_with_datetime_fields);
+		return $this->models_with_datetime_fields;
+	}
+
+
+	/**
+	 * This simply records the models that have been processed with our tracking option.
+	 *
+	 * @param array $models_to_set array of model class names.
+	 */
+	private function setModelsToProcess($models_to_set)
+	{
+		update_option(self::MODELS_TO_PROCESS_OPTION_KEY, $models_to_set);
+	}
+
+
+	/**
+	 * Used to keep track of how many models have been processed for the batch
+	 *
+	 * @param $count
+	 */
+	private function updateCountOfModelsProcessed($count = 1)
+	{
+		$count = $this->getCountOfModelsProcessed() + (int) $count;
+		update_option(self::COUNT_OF_MODELS_PROCESSED, $count);
+	}
+
+
+	/**
+	 * Retrieve the tracked number of models processed between requests.
+	 *
+	 * @return int
+	 */
+	private function getCountOfModelsProcessed()
+	{
+		return (int) get_option(self::COUNT_OF_MODELS_PROCESSED, 0);
+	}
+
+
+	/**
+	 * Returns the models that are left to process.
+	 *
+	 * @return array  an array of model class names.
+	 */
+	private function getModelsToProcess()
+	{
+		if (empty($this->models_with_datetime_fields)) {
+			$this->models_with_datetime_fields = get_option(self::MODELS_TO_PROCESS_OPTION_KEY, array());
+		}
+		return $this->models_with_datetime_fields;
+	}
+
+
+	/**
+	 * Used to record the offset that will be applied to dates and times for EE_Datetime_Field columns.
+	 *
+	 * @param float $offset
+	 */
+	public static function updateOffset($offset)
+	{
+		update_option(self::OFFSET_TO_APPLY_OPTION_KEY, $offset);
+	}
+
+
+	/**
+	 * Used to retrieve the saved offset that will be applied to dates and times for EE_Datetime_Field columns.
+	 *
+	 * @return float
+	 */
+	public static function getOffset()
+	{
+		return (float) get_option(self::OFFSET_TO_APPLY_OPTION_KEY, 0);
+	}
+
+
+	/**
+	 * Used to set the saved offset range start date.
+	 *
+	 * @param DbSafeDateTime|null $start_date
+	 */
+	public static function updateStartDateRange(DbSafeDateTime $start_date = null)
+	{
+		$date_to_save = $start_date instanceof DbSafeDateTime
+			? $start_date->format('U')
+			: '';
+		update_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, $date_to_save);
+	}
+
+
+	/**
+	 * Used to get the saved offset range start date.
+	 *
+	 * @return DbSafeDateTime|null
+	 */
+	public static function getStartDateRange(): ?DbSafeDateTime
+	{
+		$start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, null);
+		if (! $start_date) {
+			return null;
+		}
+		try {
+			$datetime = DateTime::createFromFormat('U', $start_date, new DateTimeZone('UTC'));
+			$start_date = $datetime instanceof DateTime
+				? DbSafeDateTime::createFromDateTime($datetime)
+				: null;
+		} catch (Exception $e) {
+			$start_date = null;
+		}
+		return $start_date;
+	}
+
+
+	/**
+	 * Used to set the saved offset range end date.
+	 *
+	 * @param DbSafeDateTime|null $end_date
+	 */
+	public static function updateEndDateRange(DbSafeDateTime $end_date = null)
+	{
+		$date_to_save = $end_date instanceof DbSafeDateTime
+			? $end_date->format('U')
+			: '';
+		update_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, $date_to_save);
+	}
+
+
+	/**
+	 * Used to get the saved offset range end date.
+	 *
+	 * @return DbSafeDateTime|null
+	 */
+	public static function getEndDateRange(): ?DbSafeDateTime
+	{
+		$end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, null);
+		if (! $end_date) {
+			return null;
+		}
+		try {
+			$datetime = DateTime::createFromFormat('U', $end_date, new DateTimeZone('UTC'));
+			$end_date = $datetime instanceof Datetime
+				? DbSafeDateTime::createFromDateTime($datetime)
+				: null;
+		} catch (Exception $e) {
+			$end_date = null;
+		}
+		return $end_date;
+	}
 }

Spacing +14 added lines, -14 removed lines

@@ -159,19 +159,19 @@ 
         $date_ranges = array();
         // since some affected models might have two tables, we have to get our tables and set up a query for each table.
         foreach ($model->get_tables() as $table) {
-            $query = 'UPDATE ' . $table->get_table_name();
+            $query = 'UPDATE '.$table->get_table_name();
             $fields_affected = array();
             $inner_query = array();
             foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) {
                 if ($model_field instanceof EE_Datetime_Field) {
-                    $inner_query[ $model_field->get_table_column() ] = $model_field->get_table_column() . ' = '
-                                                                       . $sql_date_function . '('
+                    $inner_query[$model_field->get_table_column()] = $model_field->get_table_column().' = '
+                                                                       . $sql_date_function.'('
                                                                        . $model_field->get_table_column()
                                                                        . ", INTERVAL {$offset} MINUTE)";
                     $fields_affected[] = $model_field;
                 }
             }
-            if (! $fields_affected) {
+            if ( ! $fields_affected) {
                 continue;
             }
             // do we do one query per column/field or one query for all fields on the model? It all depends on whether
@@ -188,7 +188,7 @@ 
                     // record error.
                     $error_message = $wpdb->last_error;
                     // handle the edge cases where last_error might be empty.
-                    if (! $error_message) {
+                    if ( ! $error_message) {
                         $error_message = esc_html__('Unknown mysql error occurred.', 'event_espresso');
                     }
                     $this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
@@ -221,7 +221,7 @@ 
         foreach ($inner_query as $field_name => $field_query) {
             $query_to_run = $query;
             $where_conditions = array();
-            $query_to_run .= ' SET ' . $field_query;
+            $query_to_run .= ' SET '.$field_query;
             if ($start_date_range instanceof DbSafeDateTime) {
                 $start_date = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
                 $where_conditions[] = "{$field_name} > '{$start_date}'";
@@ -231,17 +231,17 @@ 
                 $where_conditions[] = "{$field_name} < '{$end_date}'";
             }
             if ($where_conditions) {
-                $query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions);
+                $query_to_run .= ' WHERE '.implode(' AND ', $where_conditions);
             }
             $result = $wpdb->query($query_to_run);
             if ($result === false) {
                 // record error.
                 $error_message = $wpdb->last_error;
                 // handle the edgecases where last_error might be empty.
-                if (! $error_message) {
+                if ( ! $error_message) {
                     $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
                 }
-                $errors[ $field_name ] = $error_message;
+                $errors[$field_name] = $error_message;
             }
         }
         return $errors;
@@ -258,7 +258,7 @@ 
     private function doQueryForAllFields($query, array $inner_query)
     {
         global $wpdb;
-        $query .= ' SET ' . implode(',', $inner_query);
+        $query .= ' SET '.implode(',', $inner_query);
         return $wpdb->query($query);
     }
 
@@ -284,7 +284,7 @@ 
         $fields = array();
         /** @var EE_Datetime_Field $model_field */
         foreach ($model_fields_affected as $model_field) {
-            if (! $model_field instanceof EE_Datetime_Field) {
+            if ( ! $model_field instanceof EE_Datetime_Field) {
                 continue;
             }
             $fields[] = $model_field->get_name();
@@ -336,7 +336,7 @@ 
     private function getModelsWithDatetimeFields()
     {
         $this->getModelsToProcess();
-        if (! empty($this->models_with_datetime_fields)) {
+        if ( ! empty($this->models_with_datetime_fields)) {
             return $this->models_with_datetime_fields;
         }
 
@@ -446,7 +446,7 @@ 
     public static function getStartDateRange(): ?DbSafeDateTime
     {
         $start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, null);
-        if (! $start_date) {
+        if ( ! $start_date) {
             return null;
         }
         try {
@@ -483,7 +483,7 @@ 
     public static function getEndDateRange(): ?DbSafeDateTime
     {
         $end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, null);
-        if (! $end_date) {
+        if ( ! $end_date) {
             return null;
         }
         try {