eventespresso / event-espresso-core

core/business/EE_Registration_Processor.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -734,7 +734,7 @@
      * @since 4.9.1
      * @param int                   $att_nmbr
      * @param EE_Line_Item | string $item
-     * @return string
+     * @return RegUrlLink
      * @throws InvalidArgumentException
      */
     public function generate_reg_url_link($att_nmbr, $item)

Indentation +766 added lines, -766 removed lines

@@ -24,771 +24,771 @@
 class EE_Registration_Processor extends EE_Processor_Base
 {
 
-    /**
-     * @var EE_Registration_Processor $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * initial reg status at the beginning of this request.
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected $_old_reg_status = array();
-
-    /**
-     * reg status at the end of the request after all processing.
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected $_new_reg_status = array();
-
-    /**
-     * amounts paid at the end of the request after all processing.
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected static $_amount_paid = array();
-
-    /**
-     * Cache of the reg final price for registrations corresponding to a ticket line item
-     *
-     * @deprecated
-     * @var array @see EEH_Line_Item::calculate_reg_final_prices_per_line_item()'s return value
-     */
-    protected $_reg_final_price_per_tkt_line_item;
-
-    /**
-     * @var EE_Request $request
-     */
-    protected $request;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Request|null $request
-     * @return EE_Registration_Processor instance
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public static function instance(EE_Request $request = null)
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registration_Processor) {
-            if (! $request instanceof EE_Request) {
-                $request = LoaderFactory::getLoader()->getShared('EE_Request');
-            }
-            self::$_instance = new self($request);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * EE_Registration_Processor constructor.
-     *
-     * @param EE_Request $request
-     */
-    public function __construct(EE_Request $request)
-    {
-        $this->request = $request;
-    }
-
-
-    /**
-     * @param int $REG_ID
-     * @return string
-     */
-    public function old_reg_status($REG_ID)
-    {
-        return isset($this->_old_reg_status[ $REG_ID ]) ? $this->_old_reg_status[ $REG_ID ] : null;
-    }
-
-
-    /**
-     * @param int    $REG_ID
-     * @param string $old_reg_status
-     */
-    public function set_old_reg_status($REG_ID, $old_reg_status)
-    {
-        // only set the first time
-        if (! isset($this->_old_reg_status[ $REG_ID ])) {
-            $this->_old_reg_status[ $REG_ID ] = $old_reg_status;
-        }
-    }
-
-
-    /**
-     * @param int $REG_ID
-     * @return string
-     */
-    public function new_reg_status($REG_ID)
-    {
-        return isset($this->_new_reg_status[ $REG_ID ]) ? $this->_new_reg_status[ $REG_ID ] : null;
-    }
-
-
-    /**
-     * @param int    $REG_ID
-     * @param string $new_reg_status
-     */
-    public function set_new_reg_status($REG_ID, $new_reg_status)
-    {
-        $this->_new_reg_status[ $REG_ID ] = $new_reg_status;
-    }
-
-
-    /**
-     * reg_status_updated
-     *
-     * @param int $REG_ID
-     * @return bool
-     */
-    public function reg_status_updated($REG_ID)
-    {
-        return $this->new_reg_status($REG_ID) !== $this->old_reg_status($REG_ID);
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function update_registration_status_and_trigger_notifications(EE_Registration $registration)
-    {
-        $this->toggle_incomplete_registration_status_to_default($registration, false);
-        $this->toggle_registration_status_for_default_approved_events($registration, false);
-        $this->toggle_registration_status_if_no_monies_owing($registration, false);
-        $registration->save();
-        // trigger notifications
-        $this->trigger_registration_update_notifications($registration);
-    }
-
-
-    /**
-     *    manually_update_registration_status
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param string          $new_reg_status
-     * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
-     *                              to client code
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function manually_update_registration_status(
-        EE_Registration $registration,
-        $new_reg_status = '',
-        $save = true
-    ) {
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $registration->status_ID());
-        // set incoming REG_Status
-        $this->set_new_reg_status($registration->ID(), $new_reg_status);
-        // toggle reg status but only if it has changed and the user can do so
-        if (
-            $this->reg_status_updated($registration->ID())
-            && (
-                (! $this->request->isAdmin() || $this->request->isFrontAjax())
-                || EE_Registry::instance()->CAP->current_user_can(
-                    'ee_edit_registration',
-                    'toggle_registration_status',
-                    $registration->ID()
-                )
-            )
-        ) {
-            // change status to new value
-            $updated = $registration->set_status($this->new_reg_status($registration->ID()));
-            if ($updated && $save) {
-                $registration->save();
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     *    toggle_incomplete_registration_status_to_default
-     *        changes any incomplete registrations to either the event or global default registration status
-     *
-     * @access public
-     * @param EE_Registration       $registration
-     * @param bool                  $save TRUE will save the registration if the status is updated, FALSE will leave
-     *                                    that up to client code
-     * @param ContextInterface|null $context
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function toggle_incomplete_registration_status_to_default(
-        EE_Registration $registration,
-        $save = true,
-        ContextInterface $context = null
-    ) {
-        $existing_reg_status = $registration->status_ID();
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $existing_reg_status);
-        // is the registration currently incomplete ?
-        if ($registration->status_ID() === EEM_Registration::status_id_incomplete) {
-            // grab default reg status for the event, if set
-            $event_default_registration_status = $registration->event()->default_registration_status();
-            // if no default reg status is set for the event, then use the global value
-            $STS_ID = ! empty($event_default_registration_status)
-                ? $event_default_registration_status
-                : EE_Registry::instance()->CFG->registration->default_STS_ID;
-            // if the event default reg status is approved, then downgrade temporarily to payment pending to ensure that payments are triggered
-            $STS_ID = $STS_ID === EEM_Registration::status_id_approved ? EEM_Registration::status_id_pending_payment
-                : $STS_ID;
-            // set incoming REG_Status
-            $this->set_new_reg_status($registration->ID(), $STS_ID);
-            $registration->set_status($STS_ID, false, $context);
-            if ($save) {
-                $registration->save();
-            }
-            // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
-                // otherwise, send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
-            }
-            // DEBUG LOG
-            // $this->log(
-            //     __CLASS__,
-            //     __FUNCTION__,
-            //     __LINE__,
-            //     $registration->transaction(),
-            //     array(
-            //         'IPN' => EE_Processor_Base::$IPN,
-            //         'deliver_notifications' => has_filter(
-            //             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-            //         ),
-            //     )
-            // );
-        }
-    }
-
-
-    /**
-     *    toggle_registration_status_for_default_approved_events
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
-     *                              to client code
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function toggle_registration_status_for_default_approved_events(EE_Registration $registration, $save = true)
-    {
-        $reg_status = $registration->status_ID();
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $reg_status);
-        // if not already, toggle reg status to approved IF the event default reg status is approved
-        // ( as long as the registration wasn't cancelled or declined at some point )
-        if (
-            $reg_status !== EEM_Registration::status_id_cancelled
-            && $reg_status
-               !== EEM_Registration::status_id_declined
-            && $reg_status !== EEM_Registration::status_id_approved
-            && $registration->event()->default_registration_status() === EEM_Registration::status_id_approved
-        ) {
-            // set incoming REG_Status
-            $this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
-            // toggle status to approved
-            $registration->set_status(EEM_Registration::status_id_approved);
-            if ($save) {
-                $registration->save();
-            }
-            // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
-                // otherwise, send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
-            }
-            // DEBUG LOG
-            // $this->log(
-            //     __CLASS__,
-            //     __FUNCTION__,
-            //     __LINE__,
-            //     $registration->transaction(),
-            //     array(
-            //         'IPN' => EE_Processor_Base::$IPN,
-            //         'deliver_notifications' => has_filter(
-            //             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-            //         ),
-            //     )
-            // );
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     *    toggle_registration_statuses_if_no_monies_owing
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
-     *                              to client code
-     * @param array           $additional_details
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function toggle_registration_status_if_no_monies_owing(
-        EE_Registration $registration,
-        $save = true,
-        array $additional_details = array()
-    ) {
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $registration->status_ID());
-        // was a payment just made ?
-        $payment = isset($additional_details['payment_updates'], $additional_details['last_payment'])
-                   && $additional_details['payment_updates']
-                   && $additional_details['last_payment'] instanceof EE_Payment
-            ? $additional_details['last_payment']
-            : null;
-        $total_paid = array_sum(self::$_amount_paid);
-        // toggle reg status to approved IF
-        if (
+	/**
+	 * @var EE_Registration_Processor $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * initial reg status at the beginning of this request.
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected $_old_reg_status = array();
+
+	/**
+	 * reg status at the end of the request after all processing.
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected $_new_reg_status = array();
+
+	/**
+	 * amounts paid at the end of the request after all processing.
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected static $_amount_paid = array();
+
+	/**
+	 * Cache of the reg final price for registrations corresponding to a ticket line item
+	 *
+	 * @deprecated
+	 * @var array @see EEH_Line_Item::calculate_reg_final_prices_per_line_item()'s return value
+	 */
+	protected $_reg_final_price_per_tkt_line_item;
+
+	/**
+	 * @var EE_Request $request
+	 */
+	protected $request;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Request|null $request
+	 * @return EE_Registration_Processor instance
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public static function instance(EE_Request $request = null)
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Registration_Processor) {
+			if (! $request instanceof EE_Request) {
+				$request = LoaderFactory::getLoader()->getShared('EE_Request');
+			}
+			self::$_instance = new self($request);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * EE_Registration_Processor constructor.
+	 *
+	 * @param EE_Request $request
+	 */
+	public function __construct(EE_Request $request)
+	{
+		$this->request = $request;
+	}
+
+
+	/**
+	 * @param int $REG_ID
+	 * @return string
+	 */
+	public function old_reg_status($REG_ID)
+	{
+		return isset($this->_old_reg_status[ $REG_ID ]) ? $this->_old_reg_status[ $REG_ID ] : null;
+	}
+
+
+	/**
+	 * @param int    $REG_ID
+	 * @param string $old_reg_status
+	 */
+	public function set_old_reg_status($REG_ID, $old_reg_status)
+	{
+		// only set the first time
+		if (! isset($this->_old_reg_status[ $REG_ID ])) {
+			$this->_old_reg_status[ $REG_ID ] = $old_reg_status;
+		}
+	}
+
+
+	/**
+	 * @param int $REG_ID
+	 * @return string
+	 */
+	public function new_reg_status($REG_ID)
+	{
+		return isset($this->_new_reg_status[ $REG_ID ]) ? $this->_new_reg_status[ $REG_ID ] : null;
+	}
+
+
+	/**
+	 * @param int    $REG_ID
+	 * @param string $new_reg_status
+	 */
+	public function set_new_reg_status($REG_ID, $new_reg_status)
+	{
+		$this->_new_reg_status[ $REG_ID ] = $new_reg_status;
+	}
+
+
+	/**
+	 * reg_status_updated
+	 *
+	 * @param int $REG_ID
+	 * @return bool
+	 */
+	public function reg_status_updated($REG_ID)
+	{
+		return $this->new_reg_status($REG_ID) !== $this->old_reg_status($REG_ID);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function update_registration_status_and_trigger_notifications(EE_Registration $registration)
+	{
+		$this->toggle_incomplete_registration_status_to_default($registration, false);
+		$this->toggle_registration_status_for_default_approved_events($registration, false);
+		$this->toggle_registration_status_if_no_monies_owing($registration, false);
+		$registration->save();
+		// trigger notifications
+		$this->trigger_registration_update_notifications($registration);
+	}
+
+
+	/**
+	 *    manually_update_registration_status
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param string          $new_reg_status
+	 * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
+	 *                              to client code
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function manually_update_registration_status(
+		EE_Registration $registration,
+		$new_reg_status = '',
+		$save = true
+	) {
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
+		// set incoming REG_Status
+		$this->set_new_reg_status($registration->ID(), $new_reg_status);
+		// toggle reg status but only if it has changed and the user can do so
+		if (
+			$this->reg_status_updated($registration->ID())
+			&& (
+				(! $this->request->isAdmin() || $this->request->isFrontAjax())
+				|| EE_Registry::instance()->CAP->current_user_can(
+					'ee_edit_registration',
+					'toggle_registration_status',
+					$registration->ID()
+				)
+			)
+		) {
+			// change status to new value
+			$updated = $registration->set_status($this->new_reg_status($registration->ID()));
+			if ($updated && $save) {
+				$registration->save();
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 *    toggle_incomplete_registration_status_to_default
+	 *        changes any incomplete registrations to either the event or global default registration status
+	 *
+	 * @access public
+	 * @param EE_Registration       $registration
+	 * @param bool                  $save TRUE will save the registration if the status is updated, FALSE will leave
+	 *                                    that up to client code
+	 * @param ContextInterface|null $context
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function toggle_incomplete_registration_status_to_default(
+		EE_Registration $registration,
+		$save = true,
+		ContextInterface $context = null
+	) {
+		$existing_reg_status = $registration->status_ID();
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $existing_reg_status);
+		// is the registration currently incomplete ?
+		if ($registration->status_ID() === EEM_Registration::status_id_incomplete) {
+			// grab default reg status for the event, if set
+			$event_default_registration_status = $registration->event()->default_registration_status();
+			// if no default reg status is set for the event, then use the global value
+			$STS_ID = ! empty($event_default_registration_status)
+				? $event_default_registration_status
+				: EE_Registry::instance()->CFG->registration->default_STS_ID;
+			// if the event default reg status is approved, then downgrade temporarily to payment pending to ensure that payments are triggered
+			$STS_ID = $STS_ID === EEM_Registration::status_id_approved ? EEM_Registration::status_id_pending_payment
+				: $STS_ID;
+			// set incoming REG_Status
+			$this->set_new_reg_status($registration->ID(), $STS_ID);
+			$registration->set_status($STS_ID, false, $context);
+			if ($save) {
+				$registration->save();
+			}
+			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
+			if (! EE_Processor_Base::$IPN) {
+				// otherwise, send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
+			}
+			// DEBUG LOG
+			// $this->log(
+			//     __CLASS__,
+			//     __FUNCTION__,
+			//     __LINE__,
+			//     $registration->transaction(),
+			//     array(
+			//         'IPN' => EE_Processor_Base::$IPN,
+			//         'deliver_notifications' => has_filter(
+			//             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+			//         ),
+			//     )
+			// );
+		}
+	}
+
+
+	/**
+	 *    toggle_registration_status_for_default_approved_events
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
+	 *                              to client code
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function toggle_registration_status_for_default_approved_events(EE_Registration $registration, $save = true)
+	{
+		$reg_status = $registration->status_ID();
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $reg_status);
+		// if not already, toggle reg status to approved IF the event default reg status is approved
+		// ( as long as the registration wasn't cancelled or declined at some point )
+		if (
+			$reg_status !== EEM_Registration::status_id_cancelled
+			&& $reg_status
+			   !== EEM_Registration::status_id_declined
+			&& $reg_status !== EEM_Registration::status_id_approved
+			&& $registration->event()->default_registration_status() === EEM_Registration::status_id_approved
+		) {
+			// set incoming REG_Status
+			$this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
+			// toggle status to approved
+			$registration->set_status(EEM_Registration::status_id_approved);
+			if ($save) {
+				$registration->save();
+			}
+			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
+			if (! EE_Processor_Base::$IPN) {
+				// otherwise, send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
+			}
+			// DEBUG LOG
+			// $this->log(
+			//     __CLASS__,
+			//     __FUNCTION__,
+			//     __LINE__,
+			//     $registration->transaction(),
+			//     array(
+			//         'IPN' => EE_Processor_Base::$IPN,
+			//         'deliver_notifications' => has_filter(
+			//             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+			//         ),
+			//     )
+			// );
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 *    toggle_registration_statuses_if_no_monies_owing
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
+	 *                              to client code
+	 * @param array           $additional_details
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function toggle_registration_status_if_no_monies_owing(
+		EE_Registration $registration,
+		$save = true,
+		array $additional_details = array()
+	) {
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
+		// was a payment just made ?
+		$payment = isset($additional_details['payment_updates'], $additional_details['last_payment'])
+				   && $additional_details['payment_updates']
+				   && $additional_details['last_payment'] instanceof EE_Payment
+			? $additional_details['last_payment']
+			: null;
+		$total_paid = array_sum(self::$_amount_paid);
+		// toggle reg status to approved IF
+		if (
 // REG status is pending payment
-            $registration->status_ID() === EEM_Registration::status_id_pending_payment
-            // AND no monies are owing
-            && (
-                (
-                    $registration->transaction()->is_completed()
-                    || $registration->transaction()->is_overpaid()
-                    || $registration->transaction()->is_free()
-                    || apply_filters(
-                        'FHEE__EE_Registration_Processor__toggle_registration_status_if_no_monies_owing',
-                        false,
-                        $registration
-                    )
-                )
-                || (
-                    $payment instanceof EE_Payment && $payment->is_approved()
-                    && // this specific registration has not yet been paid for
-                    ! isset(self::$_amount_paid[ $registration->ID() ])
-                    && // payment amount, less what we have already attributed to other registrations, is greater than this reg's final price
-                    $payment->amount() - $total_paid >= $registration->final_price()
-                )
-            )
-        ) {
-            // mark as paid
-            self::$_amount_paid[ $registration->ID() ] = $registration->final_price();
-            // track new REG_Status
-            $this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
-            // toggle status to approved
-            $registration->set_status(EEM_Registration::status_id_approved);
-            if ($save) {
-                $registration->save();
-            }
-            // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
-                // otherwise, send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
-            }
-            // DEBUG LOG
-            // $this->log(
-            //     __CLASS__,
-            //     __FUNCTION__,
-            //     __LINE__,
-            //     $registration->transaction(),
-            //     array(
-            //         'IPN' => EE_Processor_Base::$IPN,
-            //         'deliver_notifications' => has_filter(
-            //             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-            //         ),
-            //     )
-            // );
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     *    registration_status_changed
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param array           $additional_details
-     * @return void
-     */
-    public function trigger_registration_update_notifications($registration, array $additional_details = array())
-    {
-        try {
-            if (! $registration instanceof EE_Registration) {
-                throw new EE_Error(
-                    esc_html__('An invalid registration was received.', 'event_espresso')
-                );
-            }
-            // EE_Registry::instance()->load_helper('Debug_Tools');
-            // EEH_Debug_Tools::log(
-            //     __CLASS__,
-            //     __FUNCTION__,
-            //     __LINE__,
-            //     array($registration->transaction(), $additional_details),
-            //     false,
-            //     'EE_Transaction: ' . $registration->transaction()->ID()
-            // );
-            if (! $registration->is_primary_registrant()) {
-                return;
-            }
-            do_action(
-                'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-                $registration,
-                $additional_details
-            );
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), $e->getFile(), 'unknown_function_from_exception', $e->getLine());
-        }
-    }
-
-
-    /**
-     * sets reg status based either on passed param or on transaction status and event pre-approval setting
-     *
-     * @param EE_Registration $registration
-     * @param array           $additional_details
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function update_registration_after_checkout_or_payment(
-        EE_Registration $registration,
-        array $additional_details = array()
-    ) {
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $registration->status_ID());
-        // if the registration status gets updated, then save the registration
-        if (
-            $this->toggle_registration_status_for_default_approved_events($registration, false)
-            || $this->toggle_registration_status_if_no_monies_owing(
-                $registration,
-                false,
-                $additional_details
-            )
-        ) {
-            $registration->save();
-        }
-        // set new  REG_Status
-        $this->set_new_reg_status($registration->ID(), $registration->status_ID());
-        return $this->reg_status_updated($registration->ID())
-               && $this->new_reg_status($registration->ID()) === EEM_Registration::status_id_approved;
-    }
-
-
-    /**
-     * Updates the registration' final prices based on the current line item tree (taking into account
-     * discounts, taxes, and other line items unrelated to tickets.)
-     *
-     * @param EE_Transaction $transaction
-     * @param boolean        $save_regs whether to immediately save registrations in this function or not
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     */
-    public function update_registration_final_prices($transaction, $save_regs = true)
-    {
-        $reg_final_price_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item(
-            $transaction->total_line_item()
-        );
-        foreach ($transaction->registrations() as $registration) {
-            /** @var EE_Line_Item $line_item */
-            $line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration);
-            if (isset($reg_final_price_per_ticket_line_item[ $line_item->ID() ])) {
-                $registration->set_final_price($reg_final_price_per_ticket_line_item[ $line_item->ID() ]);
-                if ($save_regs) {
-                    $registration->save();
-                }
-            }
-        }
-        // and make sure there's no rounding problem
-        $this->fix_reg_final_price_rounding_issue($transaction);
-    }
-
-
-    /**
-     * Makes sure there is no rounding errors for the REG_final_prices.
-     * Eg, if we have 3 registrations for $1, and there is a $0.01 discount between the three of them,
-     * they will each be for $0.99333333, which gets rounded to $1 again.
-     * So the transaction total will be $2.99, but each registration will be for $1,
-     * so if each registrant paid individually they will have overpaid by $0.01.
-     * So in order to overcome this, we check for any difference, and if there is a difference
-     * we just grab one registrant at random and make them responsible for it.
-     * This should be used after setting REG_final_prices (it's done automatically as part of
-     * EE_Registration_Processor::update_registration_final_prices())
-     *
-     * @param EE_Transaction $transaction
-     * @return bool success verifying that there is NO difference after this method is done
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function fix_reg_final_price_rounding_issue($transaction)
-    {
-        $reg_final_price_sum = EEM_Registration::instance()->sum(
-            array(
-                array(
-                    'TXN_ID' => $transaction->ID(),
-                ),
-            ),
-            'REG_final_price'
-        );
-        $diff = $transaction->total() - $reg_final_price_sum;
-        // ok then, just grab one of the registrations
-        if ($diff !== 0) {
-            $a_reg = EEM_Registration::instance()->get_one(
-                array(
-                    array(
-                        'TXN_ID' => $transaction->ID(),
-                    ),
-                )
-            );
-            return $a_reg instanceof EE_Registration
-                ? (bool) $a_reg->save(array('REG_final_price' => $a_reg->final_price() + $diff))
-                : false;
-        }
-        return true;
-    }
-
-
-    /**
-     * update_registration_after_being_canceled_or_declined
-     *
-     * @param EE_Registration $registration
-     * @param array           $closed_reg_statuses
-     * @param bool            $update_reg
-     * @return bool
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function update_registration_after_being_canceled_or_declined(
-        EE_Registration $registration,
-        array $closed_reg_statuses = array(),
-        $update_reg = true
-    ) {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses)
-            ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        // release a reserved ticket by decrementing ticket and datetime reserved values
-        $registration->release_reserved_ticket(true, 'RegProcessor:' . __LINE__);
-        $registration->set_final_price(0);
-        if ($update_reg) {
-            $registration->save();
-        }
-        return true;
-    }
-
-
-    /**
-     * update_canceled_or_declined_registration_after_being_reinstated
-     *
-     * @param EE_Registration $registration
-     * @param array           $closed_reg_statuses
-     * @param bool            $update_reg
-     * @return bool
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function update_canceled_or_declined_registration_after_being_reinstated(
-        EE_Registration $registration,
-        array $closed_reg_statuses = array(),
-        $update_reg = true
-    ) {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        $ticket = $registration->ticket();
-        if (! $ticket instanceof EE_Ticket) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The Ticket for Registration %1$d was not found or is invalid.',
-                        'event_espresso'
-                    ),
-                    $registration->ticket_ID()
-                )
-            );
-        }
-        $registration->set_final_price($ticket->price());
-        if ($update_reg) {
-            $registration->save();
-        }
-        return true;
-    }
-
-
-    /**
-     * generate_ONE_registration_from_line_item
-     * Although a ticket line item may have a quantity greater than 1,
-     * this method will ONLY CREATE ONE REGISTRATION !!!
-     * Regardless of the ticket line item quantity.
-     * This means that any code calling this method is responsible for ensuring
-     * that the final registration count matches the ticket line item quantity.
-     * This was done to make it easier to match the number of registrations
-     * to the number of tickets in the cart, when the cart has been edited
-     * after SPCO has already been initialized. So if an additional ticket was added to the cart, you can simply pass
-     * the line item to this method to add a second ticket, and in this case, you would not want to add 2 tickets.
-     *
-     * @deprecated
-     * @since 4.9.1
-     * @param EE_Line_Item    $line_item
-     * @param \EE_Transaction $transaction
-     * @param int             $att_nmbr
-     * @param int             $total_ticket_count
-     * @return EE_Registration | null
-     * @throws \OutOfRangeException
-     * @throws \EventEspresso\core\exceptions\UnexpectedEntityException
-     * @throws \EE_Error
-     */
-    public function generate_ONE_registration_from_line_item(
-        EE_Line_Item $line_item,
-        EE_Transaction $transaction,
-        $att_nmbr = 1,
-        $total_ticket_count = 1
-    ) {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                '\EventEspresso\core\domain\services\registration\CreateRegistrationService::create()'
-            ),
-            '4.9.1',
-            '5.0.0'
-        );
-        // grab the related ticket object for this line_item
-        $ticket = $line_item->ticket();
-        if (! $ticket instanceof EE_Ticket) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'),
-                    $line_item->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $registration_service = new CreateRegistrationService();
-        // then generate a new registration from that
-        return $registration_service->create(
-            $ticket->get_related_event(),
-            $transaction,
-            $ticket,
-            $line_item,
-            $att_nmbr,
-            $total_ticket_count
-        );
-    }
-
-
-    /**
-     * generates reg_url_link
-     *
-     * @deprecated
-     * @since 4.9.1
-     * @param int                   $att_nmbr
-     * @param EE_Line_Item | string $item
-     * @return string
-     * @throws InvalidArgumentException
-     */
-    public function generate_reg_url_link($att_nmbr, $item)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EventEspresso\core\domain\entities\RegUrlLink'
-            ),
-            '4.9.1',
-            '5.0.0'
-        );
-        return new RegUrlLink($att_nmbr, $item);
-    }
-
-
-    /**
-     * generates reg code
-     *
-     * @deprecated
-     * @since 4.9.1
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     */
-    public function generate_reg_code(EE_Registration $registration)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EventEspresso\core\domain\entities\RegCode'
-            ),
-            '4.9.1',
-            '5.0.0'
-        );
-        return apply_filters(
-            'FHEE__EE_Registration_Processor___generate_reg_code__new_reg_code',
-            new RegCode(
-                RegUrlLink::fromRegistration($registration),
-                $registration->transaction(),
-                $registration->ticket()
-            ),
-            $registration
-        );
-    }
+			$registration->status_ID() === EEM_Registration::status_id_pending_payment
+			// AND no monies are owing
+			&& (
+				(
+					$registration->transaction()->is_completed()
+					|| $registration->transaction()->is_overpaid()
+					|| $registration->transaction()->is_free()
+					|| apply_filters(
+						'FHEE__EE_Registration_Processor__toggle_registration_status_if_no_monies_owing',
+						false,
+						$registration
+					)
+				)
+				|| (
+					$payment instanceof EE_Payment && $payment->is_approved()
+					&& // this specific registration has not yet been paid for
+					! isset(self::$_amount_paid[ $registration->ID() ])
+					&& // payment amount, less what we have already attributed to other registrations, is greater than this reg's final price
+					$payment->amount() - $total_paid >= $registration->final_price()
+				)
+			)
+		) {
+			// mark as paid
+			self::$_amount_paid[ $registration->ID() ] = $registration->final_price();
+			// track new REG_Status
+			$this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
+			// toggle status to approved
+			$registration->set_status(EEM_Registration::status_id_approved);
+			if ($save) {
+				$registration->save();
+			}
+			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
+			if (! EE_Processor_Base::$IPN) {
+				// otherwise, send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
+			}
+			// DEBUG LOG
+			// $this->log(
+			//     __CLASS__,
+			//     __FUNCTION__,
+			//     __LINE__,
+			//     $registration->transaction(),
+			//     array(
+			//         'IPN' => EE_Processor_Base::$IPN,
+			//         'deliver_notifications' => has_filter(
+			//             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+			//         ),
+			//     )
+			// );
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 *    registration_status_changed
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param array           $additional_details
+	 * @return void
+	 */
+	public function trigger_registration_update_notifications($registration, array $additional_details = array())
+	{
+		try {
+			if (! $registration instanceof EE_Registration) {
+				throw new EE_Error(
+					esc_html__('An invalid registration was received.', 'event_espresso')
+				);
+			}
+			// EE_Registry::instance()->load_helper('Debug_Tools');
+			// EEH_Debug_Tools::log(
+			//     __CLASS__,
+			//     __FUNCTION__,
+			//     __LINE__,
+			//     array($registration->transaction(), $additional_details),
+			//     false,
+			//     'EE_Transaction: ' . $registration->transaction()->ID()
+			// );
+			if (! $registration->is_primary_registrant()) {
+				return;
+			}
+			do_action(
+				'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+				$registration,
+				$additional_details
+			);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), $e->getFile(), 'unknown_function_from_exception', $e->getLine());
+		}
+	}
+
+
+	/**
+	 * sets reg status based either on passed param or on transaction status and event pre-approval setting
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $additional_details
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function update_registration_after_checkout_or_payment(
+		EE_Registration $registration,
+		array $additional_details = array()
+	) {
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
+		// if the registration status gets updated, then save the registration
+		if (
+			$this->toggle_registration_status_for_default_approved_events($registration, false)
+			|| $this->toggle_registration_status_if_no_monies_owing(
+				$registration,
+				false,
+				$additional_details
+			)
+		) {
+			$registration->save();
+		}
+		// set new  REG_Status
+		$this->set_new_reg_status($registration->ID(), $registration->status_ID());
+		return $this->reg_status_updated($registration->ID())
+			   && $this->new_reg_status($registration->ID()) === EEM_Registration::status_id_approved;
+	}
+
+
+	/**
+	 * Updates the registration' final prices based on the current line item tree (taking into account
+	 * discounts, taxes, and other line items unrelated to tickets.)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param boolean        $save_regs whether to immediately save registrations in this function or not
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 */
+	public function update_registration_final_prices($transaction, $save_regs = true)
+	{
+		$reg_final_price_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item(
+			$transaction->total_line_item()
+		);
+		foreach ($transaction->registrations() as $registration) {
+			/** @var EE_Line_Item $line_item */
+			$line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration);
+			if (isset($reg_final_price_per_ticket_line_item[ $line_item->ID() ])) {
+				$registration->set_final_price($reg_final_price_per_ticket_line_item[ $line_item->ID() ]);
+				if ($save_regs) {
+					$registration->save();
+				}
+			}
+		}
+		// and make sure there's no rounding problem
+		$this->fix_reg_final_price_rounding_issue($transaction);
+	}
+
+
+	/**
+	 * Makes sure there is no rounding errors for the REG_final_prices.
+	 * Eg, if we have 3 registrations for $1, and there is a $0.01 discount between the three of them,
+	 * they will each be for $0.99333333, which gets rounded to $1 again.
+	 * So the transaction total will be $2.99, but each registration will be for $1,
+	 * so if each registrant paid individually they will have overpaid by $0.01.
+	 * So in order to overcome this, we check for any difference, and if there is a difference
+	 * we just grab one registrant at random and make them responsible for it.
+	 * This should be used after setting REG_final_prices (it's done automatically as part of
+	 * EE_Registration_Processor::update_registration_final_prices())
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return bool success verifying that there is NO difference after this method is done
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function fix_reg_final_price_rounding_issue($transaction)
+	{
+		$reg_final_price_sum = EEM_Registration::instance()->sum(
+			array(
+				array(
+					'TXN_ID' => $transaction->ID(),
+				),
+			),
+			'REG_final_price'
+		);
+		$diff = $transaction->total() - $reg_final_price_sum;
+		// ok then, just grab one of the registrations
+		if ($diff !== 0) {
+			$a_reg = EEM_Registration::instance()->get_one(
+				array(
+					array(
+						'TXN_ID' => $transaction->ID(),
+					),
+				)
+			);
+			return $a_reg instanceof EE_Registration
+				? (bool) $a_reg->save(array('REG_final_price' => $a_reg->final_price() + $diff))
+				: false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * update_registration_after_being_canceled_or_declined
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $closed_reg_statuses
+	 * @param bool            $update_reg
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function update_registration_after_being_canceled_or_declined(
+		EE_Registration $registration,
+		array $closed_reg_statuses = array(),
+		$update_reg = true
+	) {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses)
+			? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		// release a reserved ticket by decrementing ticket and datetime reserved values
+		$registration->release_reserved_ticket(true, 'RegProcessor:' . __LINE__);
+		$registration->set_final_price(0);
+		if ($update_reg) {
+			$registration->save();
+		}
+		return true;
+	}
+
+
+	/**
+	 * update_canceled_or_declined_registration_after_being_reinstated
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $closed_reg_statuses
+	 * @param bool            $update_reg
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function update_canceled_or_declined_registration_after_being_reinstated(
+		EE_Registration $registration,
+		array $closed_reg_statuses = array(),
+		$update_reg = true
+	) {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		$ticket = $registration->ticket();
+		if (! $ticket instanceof EE_Ticket) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The Ticket for Registration %1$d was not found or is invalid.',
+						'event_espresso'
+					),
+					$registration->ticket_ID()
+				)
+			);
+		}
+		$registration->set_final_price($ticket->price());
+		if ($update_reg) {
+			$registration->save();
+		}
+		return true;
+	}
+
+
+	/**
+	 * generate_ONE_registration_from_line_item
+	 * Although a ticket line item may have a quantity greater than 1,
+	 * this method will ONLY CREATE ONE REGISTRATION !!!
+	 * Regardless of the ticket line item quantity.
+	 * This means that any code calling this method is responsible for ensuring
+	 * that the final registration count matches the ticket line item quantity.
+	 * This was done to make it easier to match the number of registrations
+	 * to the number of tickets in the cart, when the cart has been edited
+	 * after SPCO has already been initialized. So if an additional ticket was added to the cart, you can simply pass
+	 * the line item to this method to add a second ticket, and in this case, you would not want to add 2 tickets.
+	 *
+	 * @deprecated
+	 * @since 4.9.1
+	 * @param EE_Line_Item    $line_item
+	 * @param \EE_Transaction $transaction
+	 * @param int             $att_nmbr
+	 * @param int             $total_ticket_count
+	 * @return EE_Registration | null
+	 * @throws \OutOfRangeException
+	 * @throws \EventEspresso\core\exceptions\UnexpectedEntityException
+	 * @throws \EE_Error
+	 */
+	public function generate_ONE_registration_from_line_item(
+		EE_Line_Item $line_item,
+		EE_Transaction $transaction,
+		$att_nmbr = 1,
+		$total_ticket_count = 1
+	) {
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'\EventEspresso\core\domain\services\registration\CreateRegistrationService::create()'
+			),
+			'4.9.1',
+			'5.0.0'
+		);
+		// grab the related ticket object for this line_item
+		$ticket = $line_item->ticket();
+		if (! $ticket instanceof EE_Ticket) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'),
+					$line_item->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$registration_service = new CreateRegistrationService();
+		// then generate a new registration from that
+		return $registration_service->create(
+			$ticket->get_related_event(),
+			$transaction,
+			$ticket,
+			$line_item,
+			$att_nmbr,
+			$total_ticket_count
+		);
+	}
+
+
+	/**
+	 * generates reg_url_link
+	 *
+	 * @deprecated
+	 * @since 4.9.1
+	 * @param int                   $att_nmbr
+	 * @param EE_Line_Item | string $item
+	 * @return string
+	 * @throws InvalidArgumentException
+	 */
+	public function generate_reg_url_link($att_nmbr, $item)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EventEspresso\core\domain\entities\RegUrlLink'
+			),
+			'4.9.1',
+			'5.0.0'
+		);
+		return new RegUrlLink($att_nmbr, $item);
+	}
+
+
+	/**
+	 * generates reg code
+	 *
+	 * @deprecated
+	 * @since 4.9.1
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 */
+	public function generate_reg_code(EE_Registration $registration)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EventEspresso\core\domain\entities\RegCode'
+			),
+			'4.9.1',
+			'5.0.0'
+		);
+		return apply_filters(
+			'FHEE__EE_Registration_Processor___generate_reg_code__new_reg_code',
+			new RegCode(
+				RegUrlLink::fromRegistration($registration),
+				$registration->transaction(),
+				$registration->ticket()
+			),
+			$registration
+		);
+	}
 }

Spacing +24 added lines, -24 removed lines

@@ -79,8 +79,8 @@ 
     public static function instance(EE_Request $request = null)
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registration_Processor) {
-            if (! $request instanceof EE_Request) {
+        if ( ! self::$_instance instanceof EE_Registration_Processor) {
+            if ( ! $request instanceof EE_Request) {
                 $request = LoaderFactory::getLoader()->getShared('EE_Request');
             }
             self::$_instance = new self($request);
@@ -106,7 +106,7 @@ 
      */
     public function old_reg_status($REG_ID)
     {
-        return isset($this->_old_reg_status[ $REG_ID ]) ? $this->_old_reg_status[ $REG_ID ] : null;
+        return isset($this->_old_reg_status[$REG_ID]) ? $this->_old_reg_status[$REG_ID] : null;
     }
 
 
@@ -117,8 +117,8 @@ 
     public function set_old_reg_status($REG_ID, $old_reg_status)
     {
         // only set the first time
-        if (! isset($this->_old_reg_status[ $REG_ID ])) {
-            $this->_old_reg_status[ $REG_ID ] = $old_reg_status;
+        if ( ! isset($this->_old_reg_status[$REG_ID])) {
+            $this->_old_reg_status[$REG_ID] = $old_reg_status;
         }
     }
 
@@ -129,7 +129,7 @@ 
      */
     public function new_reg_status($REG_ID)
     {
-        return isset($this->_new_reg_status[ $REG_ID ]) ? $this->_new_reg_status[ $REG_ID ] : null;
+        return isset($this->_new_reg_status[$REG_ID]) ? $this->_new_reg_status[$REG_ID] : null;
     }
 
 
@@ -139,7 +139,7 @@ 
      */
     public function set_new_reg_status($REG_ID, $new_reg_status)
     {
-        $this->_new_reg_status[ $REG_ID ] = $new_reg_status;
+        $this->_new_reg_status[$REG_ID] = $new_reg_status;
     }
 
 
@@ -206,7 +206,7 @@ 
         if (
             $this->reg_status_updated($registration->ID())
             && (
-                (! $this->request->isAdmin() || $this->request->isFrontAjax())
+                ( ! $this->request->isAdmin() || $this->request->isFrontAjax())
                 || EE_Registry::instance()->CAP->current_user_can(
                     'ee_edit_registration',
                     'toggle_registration_status',
@@ -269,7 +269,7 @@ 
                 $registration->save();
             }
             // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
+            if ( ! EE_Processor_Base::$IPN) {
                 // otherwise, send out notifications
                 add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
             }
@@ -328,7 +328,7 @@ 
                 $registration->save();
             }
             // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
+            if ( ! EE_Processor_Base::$IPN) {
                 // otherwise, send out notifications
                 add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
             }
@@ -401,14 +401,14 @@ 
                 || (
                     $payment instanceof EE_Payment && $payment->is_approved()
                     && // this specific registration has not yet been paid for
-                    ! isset(self::$_amount_paid[ $registration->ID() ])
+                    ! isset(self::$_amount_paid[$registration->ID()])
                     && // payment amount, less what we have already attributed to other registrations, is greater than this reg's final price
                     $payment->amount() - $total_paid >= $registration->final_price()
                 )
             )
         ) {
             // mark as paid
-            self::$_amount_paid[ $registration->ID() ] = $registration->final_price();
+            self::$_amount_paid[$registration->ID()] = $registration->final_price();
             // track new REG_Status
             $this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
             // toggle status to approved
@@ -417,7 +417,7 @@ 
                 $registration->save();
             }
             // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
+            if ( ! EE_Processor_Base::$IPN) {
                 // otherwise, send out notifications
                 add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
             }
@@ -451,7 +451,7 @@ 
     public function trigger_registration_update_notifications($registration, array $additional_details = array())
     {
         try {
-            if (! $registration instanceof EE_Registration) {
+            if ( ! $registration instanceof EE_Registration) {
                 throw new EE_Error(
                     esc_html__('An invalid registration was received.', 'event_espresso')
                 );
@@ -465,7 +465,7 @@ 
             //     false,
             //     'EE_Transaction: ' . $registration->transaction()->ID()
             // );
-            if (! $registration->is_primary_registrant()) {
+            if ( ! $registration->is_primary_registrant()) {
                 return;
             }
             do_action(
@@ -538,8 +538,8 @@ 
         foreach ($transaction->registrations() as $registration) {
             /** @var EE_Line_Item $line_item */
             $line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration);
-            if (isset($reg_final_price_per_ticket_line_item[ $line_item->ID() ])) {
-                $registration->set_final_price($reg_final_price_per_ticket_line_item[ $line_item->ID() ]);
+            if (isset($reg_final_price_per_ticket_line_item[$line_item->ID()])) {
+                $registration->set_final_price($reg_final_price_per_ticket_line_item[$line_item->ID()]);
                 if ($save_regs) {
                     $registration->save();
                 }
@@ -615,11 +615,11 @@ 
         $closed_reg_statuses = ! empty($closed_reg_statuses)
             ? $closed_reg_statuses
             : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+        if ( ! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
             return false;
         }
         // release a reserved ticket by decrementing ticket and datetime reserved values
-        $registration->release_reserved_ticket(true, 'RegProcessor:' . __LINE__);
+        $registration->release_reserved_ticket(true, 'RegProcessor:'.__LINE__);
         $registration->set_final_price(0);
         if ($update_reg) {
             $registration->save();
@@ -650,7 +650,7 @@ 
             return false;
         }
         $ticket = $registration->ticket();
-        if (! $ticket instanceof EE_Ticket) {
+        if ( ! $ticket instanceof EE_Ticket) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -699,7 +699,7 @@ 
         $total_ticket_count = 1
     ) {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 '\EventEspresso\core\domain\services\registration\CreateRegistrationService::create()'
@@ -709,7 +709,7 @@ 
         );
         // grab the related ticket object for this line_item
         $ticket = $line_item->ticket();
-        if (! $ticket instanceof EE_Ticket) {
+        if ( ! $ticket instanceof EE_Ticket) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'),
@@ -747,7 +747,7 @@ 
     public function generate_reg_url_link($att_nmbr, $item)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EventEspresso\core\domain\entities\RegUrlLink'
@@ -773,7 +773,7 @@ 
     public function generate_reg_code(EE_Registration $registration)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EventEspresso\core\domain\entities\RegCode'

core/admin/EE_Admin_Hooks.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -222,7 +222,7 @@
     /**
      * constructor
      *
-     * @param EE_Admin_Page $admin_page the calling admin_page_object
+     * @param EE_Admin_Page $adminpage the calling admin_page_object
      */
     public function __construct(EE_Admin_Page $adminpage)
     {

Indentation +715 added lines, -715 removed lines

@@ -13,719 +13,719 @@
 {
 
 
-    /**
-     * we're just going to use this to hold the name of the caller class (child class name)
-     *
-     * @var string
-     */
-    public $caller;
-
-
-    /**
-     * this is just a flag set automatically to indicate whether we've got an extended hook class running (i.e.
-     * espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks).  This flag is
-     * used later to make sure we require the needed files.
-     *
-     * @var bool
-     */
-    protected $_extend;
-
-
-    /**
-     * child classes MUST set this property so that the page object can be loaded correctly
-     *
-     * @var string
-     */
-    protected $_name;
-
-
-    /**
-     * This is set by child classes and is an associative array of ajax hooks in the format:
-     * array(
-     *    'ajax_action_ref' => 'executing_method'; //must be public
-     * )
-     *
-     * @var array
-     */
-    protected $_ajax_func;
-
-
-    /**
-     * This is an array of methods that get executed on a page routes admin_init hook. Use the following format:
-     * array(
-     *    'page_route' => 'executing_method' //must be public
-     * )
-     *
-     * @var array
-     */
-    protected $_init_func;
-
-
-    /**
-     * This is an array of methods that output metabox content for the given page route.  Use the following format:
-     * array(
-     *    0 => array(
-     *        'page_route' => 'string_for_page_route', //must correspond to a page route in the class being connected
-     *        with (i.e. "edit_event") If this is in an array then the same params below will be used but the metabox
-     *        will be added to each route.
-     *        'func' =>  'executing_method',  //must be public (i.e. public function executing_method($post,
-     *        $callback_args){} ).  Note if you include callback args in the array then you need to declare them in the
-     *        method arguments.
-     *        'id' => 'identifier_for_metabox', //so it can be removed by addons (optional, class will set it
-     *        automatically)
-     *        'priority' => 'default', //default 'default' (optional)
-     *        'label' => __('Localized Title', 'event_espresso'),
-     *        'context' => 'advanced' //advanced is default (optional),
-     *    'callback_args' => array() //any callback args to include (optional)
-     * )
-     * Why are we indexing numerically?  Because it's possible there may be more than one metabox per page_route.
-     *
-     * @var array
-     */
-    protected $_metaboxes;
-
-
-    /**
-     * This is an array of values that indicate any metaboxes we want removed from a given page route.  Usually this is
-     * used when caffeinated functionality is replacing decaffeinated functionality.  Use the following format for the
-     * array: array(
-     *    0 => array(
-     *        'page_route' => 'string_for_page_route' //can be string or array of strings that match a page_route(s)
-     *        that are in the class being connected with (i.e. 'edit', or 'create_new').
-     *        'id' => 'identifier_for_metabox', //what the id is of the metabox being removed
-     *        'context' => 'normal', //the context for the metabox being removed (has to match)
-     *        'screen' => 'screen_id', //(optional), if not included then this class will attempt to remove the metabox
-     *        using the currently loaded screen object->id  however, there may be cases where you have to specify the
-     *        id for the screen the metabox is on.
-     *    )
-     * )
-     *
-     * @var array
-     */
-    protected $_remove_metaboxes;
-
-
-    /**
-     * This parent class takes care of loading the scripts and styles if the child class has set the properties for
-     * them in the following format.  Note, the first array index ('register') is for defining all the registers.  The
-     * second array index is for indicating what routes each script/style loads on. array(
-     * 'registers' => array(
-     *        'script_ref' => array( // if more than one script is to be loaded its best to use the 'dependency'
-     *        argument to link scripts together.
-     *            'type' => 'js' // 'js' or 'css' (defaults to js).  This tells us what type of wp_function to use
-     *            'url' => 'http://urltoscript.css.js',
-     *            'depends' => array('jquery'), //an array of dependencies for the scripts. REMEMBER, if a script has
-     *            already been registered elsewhere in the system.  You can just use the depends array to make sure it
-     *            gets loaded before the one you are setting here.
-     *            'footer' => TRUE //defaults to true (styles don't use this parameter)
-     *        ),
-     *    'enqueues' => array( //this time each key corresponds to the script ref followed by an array of page routes
-     *    the script gets enqueued on.
-     *        'script_ref' => array('route_one', 'route_two')
-     *    ),
-     *    'localize' => array( //this allows you to set a localize object.  Indicate which script the object is being
-     *    attached to and then include an array indexed by the name of the object and the array of key/value pairs for
-     *    the object.
-     *        'scrip_ref' => array(
-     *            'NAME_OF_JS_OBJECT' => array(
-     *                'translate_ref' => __('localized_string', 'event_espresso'),
-     *                'some_data' => 5
-     *            )
-     *        )
-     *    )
-     * )
-     *
-     * @var array
-     */
-    protected $_scripts_styles;
-
-
-    /**
-     * This is a property that will contain the current route.
-     *
-     * @var string;
-     */
-    protected $_current_route;
-
-
-    /**
-     * this optional property can be set by child classes to override the priority for the automatic action/filter hook
-     * loading in the `_load_routed_hooks()` method.  Please follow this format: array(
-     *    'wp_hook_reference' => 1
-     *    )
-     * )
-     *
-     * @var array
-     */
-    protected $_wp_action_filters_priority;
-
-
-    /**
-     * This just holds a merged array of the $_POST and $_GET vars in favor of $_POST
-     *
-     * @var array
-     */
-    protected $_req_data;
-
-
-    /**
-     * This just holds an instance of the page object for this hook
-     *
-     * @var EE_Admin_Page
-     */
-    protected $_page_object;
-
-
-    /**
-     * This holds the EE_Admin_Page object from the calling admin page that this object hooks into.
-     *
-     * @var EE_Admin_Page|EE_Admin_Page_CPT
-     */
-    protected $_adminpage_obj;
-
-
-    /**
-     * Holds EE_Registry object
-     *
-     * @var EE_Registry
-     */
-    protected $EE = null;
-
-
-    /**
-     * constructor
-     *
-     * @param EE_Admin_Page $admin_page the calling admin_page_object
-     */
-    public function __construct(EE_Admin_Page $adminpage)
-    {
-        $this->_adminpage_obj = $adminpage;
-        $this->_req_data = array_merge($_GET, $_POST);
-        $this->_set_defaults();
-        $this->_set_hooks_properties();
-        // first let's verify we're on the right page
-        if (
-            ! isset($this->_req_data['page'])
-            || (isset($this->_req_data['page'])
-                && $this->_adminpage_obj->page_slug
-                   != $this->_req_data['page'])
-        ) {
-            return;
-        } //get out nothing more to be done here.
-        // allow for extends to modify properties
-        if (method_exists($this, '_extend_properties')) {
-            $this->_extend_properties();
-        }
-        $this->_set_page_object();
-        $this->_init_hooks();
-        $this->_load_custom_methods();
-        $this->_load_routed_hooks();
-        add_action('admin_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
-        add_action('admin_enqueue_scripts', array($this, 'add_metaboxes'), 20);
-        add_action('admin_enqueue_scripts', array($this, 'remove_metaboxes'), 15);
-        $this->_ajax_hooks();
-    }
-
-
-    /**
-     * used by child classes to set the following properties:
-     * $_ajax_func (optional)
-     * $_init_func (optional)
-     * $_metaboxes (optional)
-     * $_scripts (optional)
-     * $_styles (optional)
-     * $_name (required)
-     * Also in this method will be registered any scripts or styles loaded on the targeted page (as indicated in the
-     * _scripts/_styles properties) Also children should place in this method any filters/actions that have to happen
-     * really early on page load (just after admin_init) if they want to have them registered for handling early.
-     *
-     * @access protected
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_hooks_properties();
-
-
-    /**
-     * The hooks for enqueue_scripts and enqueue_styles will be run in here.  Child classes need to define their
-     * scripts and styles in the relevant $_scripts and $_styles properties.  Child classes must have also already
-     * registered the scripts and styles using wp_register_script and wp_register_style functions.
-     *
-     * @access public
-     * @return void
-     */
-    public function enqueue_scripts_styles()
-    {
-        if (! empty($this->_scripts_styles)) {
-            // first let's do all the registrations
-            if (! isset($this->_scripts_styles['registers'])) {
-                $msg[] = __(
-                    'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
-                    'event_espresso'
-                );
-                $msg[] = sprintf(
-                    __(
-                        'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
-                        'event_espresso'
-                    ),
-                    '<strong>' . $this->caller . '</strong>'
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            foreach ($this->_scripts_styles['registers'] as $ref => $details) {
-                $defaults = array(
-                    'type'    => 'js',
-                    'url'     => '',
-                    'depends' => array(),
-                    'version' => EVENT_ESPRESSO_VERSION,
-                    'footer'  => true,
-                );
-                $details = wp_parse_args($details, $defaults);
-                extract($details);
-                // let's make sure that we set the 'registers' type if it's not set! We need it later to determine whhich enqueu we do
-                $this->_scripts_styles['registers'][ $ref ]['type'] = $type;
-                // let's make sure we're not missing any REQUIRED parameters
-                if (empty($url)) {
-                    $msg[] = sprintf(
-                        __('Missing the url for the requested %s', 'event_espresso'),
-                        $type == 'js' ? 'script' : 'stylesheet'
-                    );
-                    $msg[] = sprintf(
-                        __(
-                            'Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
-                            'event_espresso'
-                        ),
-                        '<strong>' . $this->caller . '</strong>',
-                        $ref
-                    );
-                    throw new EE_Error(implode('||', $msg));
-                }
-                // made it here so let's do the appropriate registration
-                $type == 'js'
-                    ? wp_register_script($ref, $url, $depends, $version, $footer)
-                    : wp_register_style(
-                        $ref,
-                        $url,
-                        $depends,
-                        $version
-                    );
-            }
-            // k now lets do the enqueues
-            if (! isset($this->_scripts_styles['enqueues'])) {
-                return;
-            }  //not sure if we should throw an error here or not.
-
-            foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
-                // make sure $routes is an array
-                $routes = (array) $routes;
-                if (in_array($this->_current_route, $routes)) {
-                    $this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
-                        : wp_enqueue_style($ref);
-                    // if we have a localization for the script let's do that too.
-                    if (isset($this->_scripts_styles['localize'][ $ref ])) {
-                        foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
-                            wp_localize_script(
-                                $ref,
-                                $object_name,
-                                $this->_scripts_styles['localize'][ $ref ][ $object_name ]
-                            );
-                        }
-                    }
-                }
-            }
-            // let's do the deregisters
-            if (! isset($this->_scripts_styles['deregisters'])) {
-                return;
-            }
-            foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
-                $defaults = array(
-                    'type' => 'js',
-                );
-                $details = wp_parse_args($details, $defaults);
-                extract($details);
-                $type == 'js' ? wp_deregister_script($ref) : wp_deregister_style($ref);
-            }
-        }
-    }
-
-
-    /**
-     * just set the defaults for the hooks properties.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_defaults()
-    {
-        $this->_ajax_func = $this->_init_func = $this->_metaboxes = $this->_scripts = $this->_styles = $this->_wp_action_filters_priority = array();
-        $this->_current_route = $this->getCurrentRoute();
-        $this->caller = get_class($this);
-        $this->_extend = stripos($this->caller, 'Extend') ? true : false;
-    }
-
-
-    /**
-     * A helper for determining the current route.
-     * @return string
-     */
-    private function getCurrentRoute()
-    {
-        // list tables do something else with 'action' for bulk actions.
-        $action = ! empty($_REQUEST['action']) && $_REQUEST['action'] !== '-1' ? $_REQUEST['action'] : 'default';
-        // we set a 'route' variable in some cases where action is being used by something else.
-        $action = $action === 'default' && isset($_REQUEST['route']) ? $_REQUEST['route'] : $action;
-        return sanitize_key($action);
-    }
-
-
-    /**
-     * this sets the _page_object property
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_page_object()
-    {
-        // first make sure $this->_name is set
-        if (empty($this->_name)) {
-            $msg[] = __('We can\'t load the page object', 'event_espresso');
-            $msg[] = sprintf(
-                __("This is because the %s child class has not set the '_name' property", 'event_espresso'),
-                $this->caller
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        $ref = str_replace('_', ' ', $this->_name); // take the_message -> the message
-        $ref = str_replace(' ', '_', ucwords($ref)) . '_Admin_Page'; // take the message -> The_Message
-        // first default file (if exists)
-        $decaf_file = EE_ADMIN_PAGES . $this->_name . '/' . $ref . '.core.php';
-        if (is_readable($decaf_file)) {
-            require_once($decaf_file);
-        }
-        // now we have to do require for extended file (if needed)
-        if ($this->_extend) {
-            require_once(EE_CORE_CAF_ADMIN_EXTEND . $this->_name . '/Extend_' . $ref . '.core.php');
-        }
-        // if we've got an extended class we use that!
-        $ref = $this->_extend ? 'Extend_' . $ref : $ref;
-        // let's make sure the class exists
-        if (! class_exists($ref)) {
-            $msg[] = __('We can\'t load the page object', 'event_espresso');
-            $msg[] = sprintf(
-                __(
-                    'The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class',
-                    'event_espresso'
-                ),
-                $ref
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        $a = new ReflectionClass($ref);
-        $this->_page_object = $a->newInstance(false);
-    }
-
-
-    /**
-     * Child "hook" classes can declare any methods that they want executed when a specific page route is loaded.  The
-     * advantage of this is when doing things like running our own db interactions on saves etc.  Remember that
-     * $this->_req_data (all the _POST and _GET data) is available to your methods.
-     *
-     * @access private
-     * @return void
-     */
-    private function _load_custom_methods()
-    {
-        /**
-         * method cannot be named 'default' (@see http://us3.php
-         * .net/manual/en/reserved.keywords.php) so need to
-         * handle routes that are "default"
-         *
-         * @since 4.3.0
-         */
-        $method_callback = $this->_current_route == 'default' ? 'default_callback' : $this->_current_route;
-        // these run before the Admin_Page route executes.
-        if (method_exists($this, $method_callback)) {
-            call_user_func(array($this, $method_callback));
-        }
-        // these run via the _redirect_after_action method in EE_Admin_Page which usually happens after non_UI methods in EE_Admin_Page classes.  There are two redirect actions, the first fires before $query_args might be manipulated by "save and close" actions and the seond fires right before the actual redirect happens.
-        // first the actions
-        // note that these action hooks will have the $query_args value available.
-        $admin_class_name = get_class($this->_adminpage_obj);
-        if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
-            add_action(
-                'AHEE__'
-                . $admin_class_name
-                . '___redirect_after_action__before_redirect_modification_'
-                . $this->_current_route,
-                array($this, '_redirect_action_early_' . $this->_current_route),
-                10
-            );
-        }
-        if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
-            add_action(
-                'AHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_action_' . $this->_current_route),
-                10
-            );
-        }
-        // let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
-        if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
-            add_filter(
-                'FHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_filter_' . $this->_current_route),
-                10,
-                2
-            );
-        }
-    }
-
-
-    /**
-     * This method will search for a corresponding method with a name matching the route and the wp_hook to run.  This
-     * allows child hook classes to target hooking into a specific wp action or filter hook ONLY on a certain route.
-     * just remember, methods MUST be public Future hooks should be added in here to be access by child classes.
-     *
-     * @return void
-     */
-    private function _load_routed_hooks()
-    {
-
-        // this array provides the hook action names that will be referenced.  Key is the action. Value is an array with the type (action or filter) and the number of parameters for the hook.  We'll default all priorities for automatic hooks to 10.
-        $hook_filter_array = array(
-            'admin_footer'                                                                            => array(
-                'type'     => 'action',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => array(
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => array(
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'FHEE_list_table_views'                                                                   => array(
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes'                              => array(
-                'type'     => 'action',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-        );
-        foreach ($hook_filter_array as $hook => $args) {
-            if (method_exists($this, $this->_current_route . '_' . $hook)) {
-                if (isset($this->_wp_action_filters_priority[ $hook ])) {
-                    $args['priority'] = $this->_wp_action_filters_priority[ $hook ];
-                }
-                if ($args['type'] == 'action') {
-                    add_action(
-                        $hook,
-                        array($this, $this->_current_route . '_' . $hook),
-                        $args['priority'],
-                        $args['argnum']
-                    );
-                } else {
-                    add_filter(
-                        $hook,
-                        array($this, $this->_current_route . '_' . $hook),
-                        $args['priority'],
-                        $args['argnum']
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Loop throught the $_ajax_func array and add_actions for the array.
-     *
-     * @return void
-     */
-    private function _ajax_hooks()
-    {
-        if (empty($this->_ajax_func)) {
-            return;
-        } //get out there's nothing to take care of.
-        foreach ($this->_ajax_func as $action => $method) {
-            // make sure method exists
-            if (! method_exists($this, $method)) {
-                $msg[] = __(
-                    'There is no corresponding method for the hook labeled in the _ajax_func array',
-                    'event_espresso'
-                ) . '<br />';
-                $msg[] = sprintf(
-                    __(
-                        'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                        'event_espresso'
-                    ),
-                    $method,
-                    $this->caller
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            add_action('wp_ajax_' . $action, array($this, $method));
-        }
-    }
-
-
-    /**
-     * Loop throught the $_init_func array and add_actions for the array.
-     *
-     * @return void
-     */
-    protected function _init_hooks()
-    {
-        if (empty($this->_init_func)) {
-            return;
-        } //get out there's nothing to take care of.
-        // We need to determine what page_route we are on!
-        $current_route = isset($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
-        foreach ($this->_init_func as $route => $method) {
-            // make sure method exists
-            if (! method_exists($this, $method)) {
-                $msg[] = __(
-                    'There is no corresponding method for the hook labeled in the _init_func array',
-                    'event_espresso'
-                ) . '<br />';
-                $msg[] = sprintf(
-                    __(
-                        'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                        'event_espresso'
-                    ),
-                    $method,
-                    $this->caller
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            if ($route == $this->_current_route) {
-                add_action('admin_init', array($this, $method));
-            }
-        }
-    }
-
-
-    /**
-     * Loop through the _metaboxes property and add_metaboxes accordingly
-     * //todo we could eventually make this a config component class (i.e. new EE_Metabox);
-     *
-     * @access public
-     * @return void
-     */
-    public function add_metaboxes()
-    {
-        if (empty($this->_metaboxes)) {
-            return;
-        } //get out we don't have any metaboxes to set for this connection
-        $this->_handle_metabox_array($this->_metaboxes);
-    }
-
-
-    private function _handle_metabox_array($boxes, $add = true)
-    {
-        foreach ($boxes as $box) {
-            if (! isset($box['page_route'])) {
-                continue;
-            } //we dont' have a valid array
-            // let's make sure $box['page_route'] is an array so the "foreach" will work.
-            $box['page_route'] = (array) $box['page_route'];
-            foreach ($box['page_route'] as $route) {
-                if ($route != $this->_current_route) {
-                    continue;
-                } //get out we only add metaboxes for set route.
-                if ($add) {
-                    $this->_add_metabox($box);
-                } else {
-                    $this->_remove_metabox($box);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Loop through the _remove_metaboxes property and remove metaboxes accordingly.
-     *
-     * @access public
-     * @return void
-     */
-    public function remove_metaboxes()
-    {
-        if (empty($this->_remove_metaboxes)) {
-            return;
-        } //get out there are no metaboxes to remove
-        $this->_handle_metabox_array($this->_remove_metaboxes, false);
-    }
-
-
-    /**
-     * This just handles adding a metabox
-     *
-     * @access private
-     * @param array $args an array of args that have been set for this metabox by the child class
-     */
-    private function _add_metabox($args)
-    {
-        $current_screen = get_current_screen();
-        $screen_id = is_object($current_screen) ? $current_screen->id : null;
-        $func = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
-        // set defaults
-        $defaults = array(
-            'func'          => $func,
-            'id'            => $this->caller . '_' . $func . '_metabox',
-            'priority'      => 'default',
-            'label'         => $this->caller,
-            'context'       => 'advanced',
-            'callback_args' => array(),
-            'page'          => isset($args['page']) ? $args['page'] : $screen_id,
-        );
-        $args = wp_parse_args($args, $defaults);
-        extract($args);
-        // make sure method exists
-        if (! method_exists($this, $func)) {
-            $msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso') . '<br />';
-            $msg[] = sprintf(
-                __(
-                    'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                    'event_espresso'
-                ),
-                $func,
-                $this->caller
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        // everything checks out so lets add the metabox
-        add_meta_box($id, $label, array($this, $func), $page, $context, $priority, $callback_args);
-    }
-
-
-    private function _remove_metabox($args)
-    {
-        $current_screen = get_current_screen();
-        $screen_id = is_object($current_screen) ? $current_screen->id : null;
-        $func = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
-        // set defaults
-        $defaults = array(
-            'id'      => isset($args['id'])
-                ? $args['id']
-                : $this->_current_route
-                  . '_'
-                  . $this->caller
-                  . '_'
-                  . $func
-                  . '_metabox',
-            'context' => 'default',
-            'screen'  => isset($args['screen']) ? $args['screen'] : $screen_id,
-        );
-        $args = wp_parse_args($args, $defaults);
-        extract($args);
-        // everything checks out so lets remove the box!
-        remove_meta_box($id, $screen, $context);
-    }
+	/**
+	 * we're just going to use this to hold the name of the caller class (child class name)
+	 *
+	 * @var string
+	 */
+	public $caller;
+
+
+	/**
+	 * this is just a flag set automatically to indicate whether we've got an extended hook class running (i.e.
+	 * espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks).  This flag is
+	 * used later to make sure we require the needed files.
+	 *
+	 * @var bool
+	 */
+	protected $_extend;
+
+
+	/**
+	 * child classes MUST set this property so that the page object can be loaded correctly
+	 *
+	 * @var string
+	 */
+	protected $_name;
+
+
+	/**
+	 * This is set by child classes and is an associative array of ajax hooks in the format:
+	 * array(
+	 *    'ajax_action_ref' => 'executing_method'; //must be public
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_ajax_func;
+
+
+	/**
+	 * This is an array of methods that get executed on a page routes admin_init hook. Use the following format:
+	 * array(
+	 *    'page_route' => 'executing_method' //must be public
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_init_func;
+
+
+	/**
+	 * This is an array of methods that output metabox content for the given page route.  Use the following format:
+	 * array(
+	 *    0 => array(
+	 *        'page_route' => 'string_for_page_route', //must correspond to a page route in the class being connected
+	 *        with (i.e. "edit_event") If this is in an array then the same params below will be used but the metabox
+	 *        will be added to each route.
+	 *        'func' =>  'executing_method',  //must be public (i.e. public function executing_method($post,
+	 *        $callback_args){} ).  Note if you include callback args in the array then you need to declare them in the
+	 *        method arguments.
+	 *        'id' => 'identifier_for_metabox', //so it can be removed by addons (optional, class will set it
+	 *        automatically)
+	 *        'priority' => 'default', //default 'default' (optional)
+	 *        'label' => __('Localized Title', 'event_espresso'),
+	 *        'context' => 'advanced' //advanced is default (optional),
+	 *    'callback_args' => array() //any callback args to include (optional)
+	 * )
+	 * Why are we indexing numerically?  Because it's possible there may be more than one metabox per page_route.
+	 *
+	 * @var array
+	 */
+	protected $_metaboxes;
+
+
+	/**
+	 * This is an array of values that indicate any metaboxes we want removed from a given page route.  Usually this is
+	 * used when caffeinated functionality is replacing decaffeinated functionality.  Use the following format for the
+	 * array: array(
+	 *    0 => array(
+	 *        'page_route' => 'string_for_page_route' //can be string or array of strings that match a page_route(s)
+	 *        that are in the class being connected with (i.e. 'edit', or 'create_new').
+	 *        'id' => 'identifier_for_metabox', //what the id is of the metabox being removed
+	 *        'context' => 'normal', //the context for the metabox being removed (has to match)
+	 *        'screen' => 'screen_id', //(optional), if not included then this class will attempt to remove the metabox
+	 *        using the currently loaded screen object->id  however, there may be cases where you have to specify the
+	 *        id for the screen the metabox is on.
+	 *    )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_remove_metaboxes;
+
+
+	/**
+	 * This parent class takes care of loading the scripts and styles if the child class has set the properties for
+	 * them in the following format.  Note, the first array index ('register') is for defining all the registers.  The
+	 * second array index is for indicating what routes each script/style loads on. array(
+	 * 'registers' => array(
+	 *        'script_ref' => array( // if more than one script is to be loaded its best to use the 'dependency'
+	 *        argument to link scripts together.
+	 *            'type' => 'js' // 'js' or 'css' (defaults to js).  This tells us what type of wp_function to use
+	 *            'url' => 'http://urltoscript.css.js',
+	 *            'depends' => array('jquery'), //an array of dependencies for the scripts. REMEMBER, if a script has
+	 *            already been registered elsewhere in the system.  You can just use the depends array to make sure it
+	 *            gets loaded before the one you are setting here.
+	 *            'footer' => TRUE //defaults to true (styles don't use this parameter)
+	 *        ),
+	 *    'enqueues' => array( //this time each key corresponds to the script ref followed by an array of page routes
+	 *    the script gets enqueued on.
+	 *        'script_ref' => array('route_one', 'route_two')
+	 *    ),
+	 *    'localize' => array( //this allows you to set a localize object.  Indicate which script the object is being
+	 *    attached to and then include an array indexed by the name of the object and the array of key/value pairs for
+	 *    the object.
+	 *        'scrip_ref' => array(
+	 *            'NAME_OF_JS_OBJECT' => array(
+	 *                'translate_ref' => __('localized_string', 'event_espresso'),
+	 *                'some_data' => 5
+	 *            )
+	 *        )
+	 *    )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_scripts_styles;
+
+
+	/**
+	 * This is a property that will contain the current route.
+	 *
+	 * @var string;
+	 */
+	protected $_current_route;
+
+
+	/**
+	 * this optional property can be set by child classes to override the priority for the automatic action/filter hook
+	 * loading in the `_load_routed_hooks()` method.  Please follow this format: array(
+	 *    'wp_hook_reference' => 1
+	 *    )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_wp_action_filters_priority;
+
+
+	/**
+	 * This just holds a merged array of the $_POST and $_GET vars in favor of $_POST
+	 *
+	 * @var array
+	 */
+	protected $_req_data;
+
+
+	/**
+	 * This just holds an instance of the page object for this hook
+	 *
+	 * @var EE_Admin_Page
+	 */
+	protected $_page_object;
+
+
+	/**
+	 * This holds the EE_Admin_Page object from the calling admin page that this object hooks into.
+	 *
+	 * @var EE_Admin_Page|EE_Admin_Page_CPT
+	 */
+	protected $_adminpage_obj;
+
+
+	/**
+	 * Holds EE_Registry object
+	 *
+	 * @var EE_Registry
+	 */
+	protected $EE = null;
+
+
+	/**
+	 * constructor
+	 *
+	 * @param EE_Admin_Page $admin_page the calling admin_page_object
+	 */
+	public function __construct(EE_Admin_Page $adminpage)
+	{
+		$this->_adminpage_obj = $adminpage;
+		$this->_req_data = array_merge($_GET, $_POST);
+		$this->_set_defaults();
+		$this->_set_hooks_properties();
+		// first let's verify we're on the right page
+		if (
+			! isset($this->_req_data['page'])
+			|| (isset($this->_req_data['page'])
+				&& $this->_adminpage_obj->page_slug
+				   != $this->_req_data['page'])
+		) {
+			return;
+		} //get out nothing more to be done here.
+		// allow for extends to modify properties
+		if (method_exists($this, '_extend_properties')) {
+			$this->_extend_properties();
+		}
+		$this->_set_page_object();
+		$this->_init_hooks();
+		$this->_load_custom_methods();
+		$this->_load_routed_hooks();
+		add_action('admin_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
+		add_action('admin_enqueue_scripts', array($this, 'add_metaboxes'), 20);
+		add_action('admin_enqueue_scripts', array($this, 'remove_metaboxes'), 15);
+		$this->_ajax_hooks();
+	}
+
+
+	/**
+	 * used by child classes to set the following properties:
+	 * $_ajax_func (optional)
+	 * $_init_func (optional)
+	 * $_metaboxes (optional)
+	 * $_scripts (optional)
+	 * $_styles (optional)
+	 * $_name (required)
+	 * Also in this method will be registered any scripts or styles loaded on the targeted page (as indicated in the
+	 * _scripts/_styles properties) Also children should place in this method any filters/actions that have to happen
+	 * really early on page load (just after admin_init) if they want to have them registered for handling early.
+	 *
+	 * @access protected
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_hooks_properties();
+
+
+	/**
+	 * The hooks for enqueue_scripts and enqueue_styles will be run in here.  Child classes need to define their
+	 * scripts and styles in the relevant $_scripts and $_styles properties.  Child classes must have also already
+	 * registered the scripts and styles using wp_register_script and wp_register_style functions.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function enqueue_scripts_styles()
+	{
+		if (! empty($this->_scripts_styles)) {
+			// first let's do all the registrations
+			if (! isset($this->_scripts_styles['registers'])) {
+				$msg[] = __(
+					'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
+					'event_espresso'
+				);
+				$msg[] = sprintf(
+					__(
+						'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
+						'event_espresso'
+					),
+					'<strong>' . $this->caller . '</strong>'
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			foreach ($this->_scripts_styles['registers'] as $ref => $details) {
+				$defaults = array(
+					'type'    => 'js',
+					'url'     => '',
+					'depends' => array(),
+					'version' => EVENT_ESPRESSO_VERSION,
+					'footer'  => true,
+				);
+				$details = wp_parse_args($details, $defaults);
+				extract($details);
+				// let's make sure that we set the 'registers' type if it's not set! We need it later to determine whhich enqueu we do
+				$this->_scripts_styles['registers'][ $ref ]['type'] = $type;
+				// let's make sure we're not missing any REQUIRED parameters
+				if (empty($url)) {
+					$msg[] = sprintf(
+						__('Missing the url for the requested %s', 'event_espresso'),
+						$type == 'js' ? 'script' : 'stylesheet'
+					);
+					$msg[] = sprintf(
+						__(
+							'Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
+							'event_espresso'
+						),
+						'<strong>' . $this->caller . '</strong>',
+						$ref
+					);
+					throw new EE_Error(implode('||', $msg));
+				}
+				// made it here so let's do the appropriate registration
+				$type == 'js'
+					? wp_register_script($ref, $url, $depends, $version, $footer)
+					: wp_register_style(
+						$ref,
+						$url,
+						$depends,
+						$version
+					);
+			}
+			// k now lets do the enqueues
+			if (! isset($this->_scripts_styles['enqueues'])) {
+				return;
+			}  //not sure if we should throw an error here or not.
+
+			foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
+				// make sure $routes is an array
+				$routes = (array) $routes;
+				if (in_array($this->_current_route, $routes)) {
+					$this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
+						: wp_enqueue_style($ref);
+					// if we have a localization for the script let's do that too.
+					if (isset($this->_scripts_styles['localize'][ $ref ])) {
+						foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
+							wp_localize_script(
+								$ref,
+								$object_name,
+								$this->_scripts_styles['localize'][ $ref ][ $object_name ]
+							);
+						}
+					}
+				}
+			}
+			// let's do the deregisters
+			if (! isset($this->_scripts_styles['deregisters'])) {
+				return;
+			}
+			foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
+				$defaults = array(
+					'type' => 'js',
+				);
+				$details = wp_parse_args($details, $defaults);
+				extract($details);
+				$type == 'js' ? wp_deregister_script($ref) : wp_deregister_style($ref);
+			}
+		}
+	}
+
+
+	/**
+	 * just set the defaults for the hooks properties.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_defaults()
+	{
+		$this->_ajax_func = $this->_init_func = $this->_metaboxes = $this->_scripts = $this->_styles = $this->_wp_action_filters_priority = array();
+		$this->_current_route = $this->getCurrentRoute();
+		$this->caller = get_class($this);
+		$this->_extend = stripos($this->caller, 'Extend') ? true : false;
+	}
+
+
+	/**
+	 * A helper for determining the current route.
+	 * @return string
+	 */
+	private function getCurrentRoute()
+	{
+		// list tables do something else with 'action' for bulk actions.
+		$action = ! empty($_REQUEST['action']) && $_REQUEST['action'] !== '-1' ? $_REQUEST['action'] : 'default';
+		// we set a 'route' variable in some cases where action is being used by something else.
+		$action = $action === 'default' && isset($_REQUEST['route']) ? $_REQUEST['route'] : $action;
+		return sanitize_key($action);
+	}
+
+
+	/**
+	 * this sets the _page_object property
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_page_object()
+	{
+		// first make sure $this->_name is set
+		if (empty($this->_name)) {
+			$msg[] = __('We can\'t load the page object', 'event_espresso');
+			$msg[] = sprintf(
+				__("This is because the %s child class has not set the '_name' property", 'event_espresso'),
+				$this->caller
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		$ref = str_replace('_', ' ', $this->_name); // take the_message -> the message
+		$ref = str_replace(' ', '_', ucwords($ref)) . '_Admin_Page'; // take the message -> The_Message
+		// first default file (if exists)
+		$decaf_file = EE_ADMIN_PAGES . $this->_name . '/' . $ref . '.core.php';
+		if (is_readable($decaf_file)) {
+			require_once($decaf_file);
+		}
+		// now we have to do require for extended file (if needed)
+		if ($this->_extend) {
+			require_once(EE_CORE_CAF_ADMIN_EXTEND . $this->_name . '/Extend_' . $ref . '.core.php');
+		}
+		// if we've got an extended class we use that!
+		$ref = $this->_extend ? 'Extend_' . $ref : $ref;
+		// let's make sure the class exists
+		if (! class_exists($ref)) {
+			$msg[] = __('We can\'t load the page object', 'event_espresso');
+			$msg[] = sprintf(
+				__(
+					'The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class',
+					'event_espresso'
+				),
+				$ref
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		$a = new ReflectionClass($ref);
+		$this->_page_object = $a->newInstance(false);
+	}
+
+
+	/**
+	 * Child "hook" classes can declare any methods that they want executed when a specific page route is loaded.  The
+	 * advantage of this is when doing things like running our own db interactions on saves etc.  Remember that
+	 * $this->_req_data (all the _POST and _GET data) is available to your methods.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _load_custom_methods()
+	{
+		/**
+		 * method cannot be named 'default' (@see http://us3.php
+		 * .net/manual/en/reserved.keywords.php) so need to
+		 * handle routes that are "default"
+		 *
+		 * @since 4.3.0
+		 */
+		$method_callback = $this->_current_route == 'default' ? 'default_callback' : $this->_current_route;
+		// these run before the Admin_Page route executes.
+		if (method_exists($this, $method_callback)) {
+			call_user_func(array($this, $method_callback));
+		}
+		// these run via the _redirect_after_action method in EE_Admin_Page which usually happens after non_UI methods in EE_Admin_Page classes.  There are two redirect actions, the first fires before $query_args might be manipulated by "save and close" actions and the seond fires right before the actual redirect happens.
+		// first the actions
+		// note that these action hooks will have the $query_args value available.
+		$admin_class_name = get_class($this->_adminpage_obj);
+		if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
+			add_action(
+				'AHEE__'
+				. $admin_class_name
+				. '___redirect_after_action__before_redirect_modification_'
+				. $this->_current_route,
+				array($this, '_redirect_action_early_' . $this->_current_route),
+				10
+			);
+		}
+		if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
+			add_action(
+				'AHEE_redirect_' . $admin_class_name . $this->_current_route,
+				array($this, '_redirect_action_' . $this->_current_route),
+				10
+			);
+		}
+		// let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
+		if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
+			add_filter(
+				'FHEE_redirect_' . $admin_class_name . $this->_current_route,
+				array($this, '_redirect_filter_' . $this->_current_route),
+				10,
+				2
+			);
+		}
+	}
+
+
+	/**
+	 * This method will search for a corresponding method with a name matching the route and the wp_hook to run.  This
+	 * allows child hook classes to target hooking into a specific wp action or filter hook ONLY on a certain route.
+	 * just remember, methods MUST be public Future hooks should be added in here to be access by child classes.
+	 *
+	 * @return void
+	 */
+	private function _load_routed_hooks()
+	{
+
+		// this array provides the hook action names that will be referenced.  Key is the action. Value is an array with the type (action or filter) and the number of parameters for the hook.  We'll default all priorities for automatic hooks to 10.
+		$hook_filter_array = array(
+			'admin_footer'                                                                            => array(
+				'type'     => 'action',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => array(
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => array(
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'FHEE_list_table_views'                                                                   => array(
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes'                              => array(
+				'type'     => 'action',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+		);
+		foreach ($hook_filter_array as $hook => $args) {
+			if (method_exists($this, $this->_current_route . '_' . $hook)) {
+				if (isset($this->_wp_action_filters_priority[ $hook ])) {
+					$args['priority'] = $this->_wp_action_filters_priority[ $hook ];
+				}
+				if ($args['type'] == 'action') {
+					add_action(
+						$hook,
+						array($this, $this->_current_route . '_' . $hook),
+						$args['priority'],
+						$args['argnum']
+					);
+				} else {
+					add_filter(
+						$hook,
+						array($this, $this->_current_route . '_' . $hook),
+						$args['priority'],
+						$args['argnum']
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Loop throught the $_ajax_func array and add_actions for the array.
+	 *
+	 * @return void
+	 */
+	private function _ajax_hooks()
+	{
+		if (empty($this->_ajax_func)) {
+			return;
+		} //get out there's nothing to take care of.
+		foreach ($this->_ajax_func as $action => $method) {
+			// make sure method exists
+			if (! method_exists($this, $method)) {
+				$msg[] = __(
+					'There is no corresponding method for the hook labeled in the _ajax_func array',
+					'event_espresso'
+				) . '<br />';
+				$msg[] = sprintf(
+					__(
+						'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+						'event_espresso'
+					),
+					$method,
+					$this->caller
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			add_action('wp_ajax_' . $action, array($this, $method));
+		}
+	}
+
+
+	/**
+	 * Loop throught the $_init_func array and add_actions for the array.
+	 *
+	 * @return void
+	 */
+	protected function _init_hooks()
+	{
+		if (empty($this->_init_func)) {
+			return;
+		} //get out there's nothing to take care of.
+		// We need to determine what page_route we are on!
+		$current_route = isset($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
+		foreach ($this->_init_func as $route => $method) {
+			// make sure method exists
+			if (! method_exists($this, $method)) {
+				$msg[] = __(
+					'There is no corresponding method for the hook labeled in the _init_func array',
+					'event_espresso'
+				) . '<br />';
+				$msg[] = sprintf(
+					__(
+						'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+						'event_espresso'
+					),
+					$method,
+					$this->caller
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			if ($route == $this->_current_route) {
+				add_action('admin_init', array($this, $method));
+			}
+		}
+	}
+
+
+	/**
+	 * Loop through the _metaboxes property and add_metaboxes accordingly
+	 * //todo we could eventually make this a config component class (i.e. new EE_Metabox);
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function add_metaboxes()
+	{
+		if (empty($this->_metaboxes)) {
+			return;
+		} //get out we don't have any metaboxes to set for this connection
+		$this->_handle_metabox_array($this->_metaboxes);
+	}
+
+
+	private function _handle_metabox_array($boxes, $add = true)
+	{
+		foreach ($boxes as $box) {
+			if (! isset($box['page_route'])) {
+				continue;
+			} //we dont' have a valid array
+			// let's make sure $box['page_route'] is an array so the "foreach" will work.
+			$box['page_route'] = (array) $box['page_route'];
+			foreach ($box['page_route'] as $route) {
+				if ($route != $this->_current_route) {
+					continue;
+				} //get out we only add metaboxes for set route.
+				if ($add) {
+					$this->_add_metabox($box);
+				} else {
+					$this->_remove_metabox($box);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Loop through the _remove_metaboxes property and remove metaboxes accordingly.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function remove_metaboxes()
+	{
+		if (empty($this->_remove_metaboxes)) {
+			return;
+		} //get out there are no metaboxes to remove
+		$this->_handle_metabox_array($this->_remove_metaboxes, false);
+	}
+
+
+	/**
+	 * This just handles adding a metabox
+	 *
+	 * @access private
+	 * @param array $args an array of args that have been set for this metabox by the child class
+	 */
+	private function _add_metabox($args)
+	{
+		$current_screen = get_current_screen();
+		$screen_id = is_object($current_screen) ? $current_screen->id : null;
+		$func = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
+		// set defaults
+		$defaults = array(
+			'func'          => $func,
+			'id'            => $this->caller . '_' . $func . '_metabox',
+			'priority'      => 'default',
+			'label'         => $this->caller,
+			'context'       => 'advanced',
+			'callback_args' => array(),
+			'page'          => isset($args['page']) ? $args['page'] : $screen_id,
+		);
+		$args = wp_parse_args($args, $defaults);
+		extract($args);
+		// make sure method exists
+		if (! method_exists($this, $func)) {
+			$msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso') . '<br />';
+			$msg[] = sprintf(
+				__(
+					'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+					'event_espresso'
+				),
+				$func,
+				$this->caller
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		// everything checks out so lets add the metabox
+		add_meta_box($id, $label, array($this, $func), $page, $context, $priority, $callback_args);
+	}
+
+
+	private function _remove_metabox($args)
+	{
+		$current_screen = get_current_screen();
+		$screen_id = is_object($current_screen) ? $current_screen->id : null;
+		$func = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
+		// set defaults
+		$defaults = array(
+			'id'      => isset($args['id'])
+				? $args['id']
+				: $this->_current_route
+				  . '_'
+				  . $this->caller
+				  . '_'
+				  . $func
+				  . '_metabox',
+			'context' => 'default',
+			'screen'  => isset($args['screen']) ? $args['screen'] : $screen_id,
+		);
+		$args = wp_parse_args($args, $defaults);
+		extract($args);
+		// everything checks out so lets remove the box!
+		remove_meta_box($id, $screen, $context);
+	}
 }

Spacing +40 added lines, -40 removed lines

@@ -256,9 +256,9 @@ 
      */
     public function enqueue_scripts_styles()
     {
-        if (! empty($this->_scripts_styles)) {
+        if ( ! empty($this->_scripts_styles)) {
             // first let's do all the registrations
-            if (! isset($this->_scripts_styles['registers'])) {
+            if ( ! isset($this->_scripts_styles['registers'])) {
                 $msg[] = __(
                     'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
                     'event_espresso'
@@ -268,7 +268,7 @@ 
                         'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
                         'event_espresso'
                     ),
-                    '<strong>' . $this->caller . '</strong>'
+                    '<strong>'.$this->caller.'</strong>'
                 );
                 throw new EE_Error(implode('||', $msg));
             }
@@ -283,7 +283,7 @@ 
                 $details = wp_parse_args($details, $defaults);
                 extract($details);
                 // let's make sure that we set the 'registers' type if it's not set! We need it later to determine whhich enqueu we do
-                $this->_scripts_styles['registers'][ $ref ]['type'] = $type;
+                $this->_scripts_styles['registers'][$ref]['type'] = $type;
                 // let's make sure we're not missing any REQUIRED parameters
                 if (empty($url)) {
                     $msg[] = sprintf(
@@ -295,7 +295,7 @@ 
                             'Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
                             'event_espresso'
                         ),
-                        '<strong>' . $this->caller . '</strong>',
+                        '<strong>'.$this->caller.'</strong>',
                         $ref
                     );
                     throw new EE_Error(implode('||', $msg));
@@ -311,7 +311,7 @@ 
                     );
             }
             // k now lets do the enqueues
-            if (! isset($this->_scripts_styles['enqueues'])) {
+            if ( ! isset($this->_scripts_styles['enqueues'])) {
                 return;
             }  //not sure if we should throw an error here or not.
 
@@ -319,22 +319,22 @@ 
                 // make sure $routes is an array
                 $routes = (array) $routes;
                 if (in_array($this->_current_route, $routes)) {
-                    $this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
+                    $this->_scripts_styles['registers'][$ref]['type'] == 'js' ? wp_enqueue_script($ref)
                         : wp_enqueue_style($ref);
                     // if we have a localization for the script let's do that too.
-                    if (isset($this->_scripts_styles['localize'][ $ref ])) {
-                        foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
+                    if (isset($this->_scripts_styles['localize'][$ref])) {
+                        foreach ($this->_scripts_styles['localize'][$ref] as $object_name => $indexes) {
                             wp_localize_script(
                                 $ref,
                                 $object_name,
-                                $this->_scripts_styles['localize'][ $ref ][ $object_name ]
+                                $this->_scripts_styles['localize'][$ref][$object_name]
                             );
                         }
                     }
                 }
             }
             // let's do the deregisters
-            if (! isset($this->_scripts_styles['deregisters'])) {
+            if ( ! isset($this->_scripts_styles['deregisters'])) {
                 return;
             }
             foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
@@ -396,20 +396,20 @@ 
             throw new EE_Error(implode('||', $msg));
         }
         $ref = str_replace('_', ' ', $this->_name); // take the_message -> the message
-        $ref = str_replace(' ', '_', ucwords($ref)) . '_Admin_Page'; // take the message -> The_Message
+        $ref = str_replace(' ', '_', ucwords($ref)).'_Admin_Page'; // take the message -> The_Message
         // first default file (if exists)
-        $decaf_file = EE_ADMIN_PAGES . $this->_name . '/' . $ref . '.core.php';
+        $decaf_file = EE_ADMIN_PAGES.$this->_name.'/'.$ref.'.core.php';
         if (is_readable($decaf_file)) {
             require_once($decaf_file);
         }
         // now we have to do require for extended file (if needed)
         if ($this->_extend) {
-            require_once(EE_CORE_CAF_ADMIN_EXTEND . $this->_name . '/Extend_' . $ref . '.core.php');
+            require_once(EE_CORE_CAF_ADMIN_EXTEND.$this->_name.'/Extend_'.$ref.'.core.php');
         }
         // if we've got an extended class we use that!
-        $ref = $this->_extend ? 'Extend_' . $ref : $ref;
+        $ref = $this->_extend ? 'Extend_'.$ref : $ref;
         // let's make sure the class exists
-        if (! class_exists($ref)) {
+        if ( ! class_exists($ref)) {
             $msg[] = __('We can\'t load the page object', 'event_espresso');
             $msg[] = sprintf(
                 __(
@@ -451,28 +451,28 @@ 
         // first the actions
         // note that these action hooks will have the $query_args value available.
         $admin_class_name = get_class($this->_adminpage_obj);
-        if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_action_early_'.$this->_current_route)) {
             add_action(
                 'AHEE__'
                 . $admin_class_name
                 . '___redirect_after_action__before_redirect_modification_'
                 . $this->_current_route,
-                array($this, '_redirect_action_early_' . $this->_current_route),
+                array($this, '_redirect_action_early_'.$this->_current_route),
                 10
             );
         }
-        if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_action_'.$this->_current_route)) {
             add_action(
-                'AHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_action_' . $this->_current_route),
+                'AHEE_redirect_'.$admin_class_name.$this->_current_route,
+                array($this, '_redirect_action_'.$this->_current_route),
                 10
             );
         }
         // let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
-        if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_filter_'.$this->_current_route)) {
             add_filter(
-                'FHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_filter_' . $this->_current_route),
+                'FHEE_redirect_'.$admin_class_name.$this->_current_route,
+                array($this, '_redirect_filter_'.$this->_current_route),
                 10,
                 2
             );
@@ -497,12 +497,12 @@ 
                 'argnum'   => 1,
                 'priority' => 10,
             ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => array(
+            'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug.'_'.$this->_current_route => array(
                 'type'     => 'filter',
                 'argnum'   => 1,
                 'priority' => 10,
             ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => array(
+            'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug                               => array(
                 'type'     => 'filter',
                 'argnum'   => 1,
                 'priority' => 10,
@@ -519,21 +519,21 @@ 
             ),
         );
         foreach ($hook_filter_array as $hook => $args) {
-            if (method_exists($this, $this->_current_route . '_' . $hook)) {
-                if (isset($this->_wp_action_filters_priority[ $hook ])) {
-                    $args['priority'] = $this->_wp_action_filters_priority[ $hook ];
+            if (method_exists($this, $this->_current_route.'_'.$hook)) {
+                if (isset($this->_wp_action_filters_priority[$hook])) {
+                    $args['priority'] = $this->_wp_action_filters_priority[$hook];
                 }
                 if ($args['type'] == 'action') {
                     add_action(
                         $hook,
-                        array($this, $this->_current_route . '_' . $hook),
+                        array($this, $this->_current_route.'_'.$hook),
                         $args['priority'],
                         $args['argnum']
                     );
                 } else {
                     add_filter(
                         $hook,
-                        array($this, $this->_current_route . '_' . $hook),
+                        array($this, $this->_current_route.'_'.$hook),
                         $args['priority'],
                         $args['argnum']
                     );
@@ -555,11 +555,11 @@ 
         } //get out there's nothing to take care of.
         foreach ($this->_ajax_func as $action => $method) {
             // make sure method exists
-            if (! method_exists($this, $method)) {
+            if ( ! method_exists($this, $method)) {
                 $msg[] = __(
                     'There is no corresponding method for the hook labeled in the _ajax_func array',
                     'event_espresso'
-                ) . '<br />';
+                ).'<br />';
                 $msg[] = sprintf(
                     __(
                         'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
@@ -570,7 +570,7 @@ 
                 );
                 throw new EE_Error(implode('||', $msg));
             }
-            add_action('wp_ajax_' . $action, array($this, $method));
+            add_action('wp_ajax_'.$action, array($this, $method));
         }
     }
 
@@ -589,11 +589,11 @@ 
         $current_route = isset($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
         foreach ($this->_init_func as $route => $method) {
             // make sure method exists
-            if (! method_exists($this, $method)) {
+            if ( ! method_exists($this, $method)) {
                 $msg[] = __(
                     'There is no corresponding method for the hook labeled in the _init_func array',
                     'event_espresso'
-                ) . '<br />';
+                ).'<br />';
                 $msg[] = sprintf(
                     __(
                         'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
@@ -630,7 +630,7 @@ 
     private function _handle_metabox_array($boxes, $add = true)
     {
         foreach ($boxes as $box) {
-            if (! isset($box['page_route'])) {
+            if ( ! isset($box['page_route'])) {
                 continue;
             } //we dont' have a valid array
             // let's make sure $box['page_route'] is an array so the "foreach" will work.
@@ -678,7 +678,7 @@ 
         // set defaults
         $defaults = array(
             'func'          => $func,
-            'id'            => $this->caller . '_' . $func . '_metabox',
+            'id'            => $this->caller.'_'.$func.'_metabox',
             'priority'      => 'default',
             'label'         => $this->caller,
             'context'       => 'advanced',
@@ -688,8 +688,8 @@ 
         $args = wp_parse_args($args, $defaults);
         extract($args);
         // make sure method exists
-        if (! method_exists($this, $func)) {
-            $msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso') . '<br />';
+        if ( ! method_exists($this, $func)) {
+            $msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso').'<br />';
             $msg[] = sprintf(
                 __(
                     'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',

core/libraries/messages/EE_message_type.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -832,7 +832,7 @@
      * Takes care of setting up the addressee object(s) for the primary attendee.
      *
      * @access protected
-     * @return array of EE_Addressee objects
+     * @return EE_Messages_Addressee[] of EE_Addressee objects
      * @throws EE_Error
      */
     protected function _primary_attendee_addressees()

Spacing +29 added lines, -29 removed lines

@@ -408,7 +408,7 @@ 
     {
         // validate context
         // valid context?
-        if (! isset($this->_contexts[ $context ])) {
+        if ( ! isset($this->_contexts[$context])) {
             throw new EE_Error(
                 sprintf(
                     __('The context %s is not a valid context for %s.', 'event_espresso'),
@@ -464,7 +464,7 @@ 
     public function get_data_for_context($context, EE_Registration $registration, $id = 0)
     {
         // valid context?
-        if (! isset($this->_contexts[ $context ])) {
+        if ( ! isset($this->_contexts[$context])) {
             throw new EE_Error(
                 sprintf(
                     __('The context %s is not a valid context for %s.', 'event_espresso'),
@@ -479,7 +479,7 @@ 
             $this->_get_data_for_context($context, $registration, $id),
             $this
         );
-        $data = apply_filters('FHEE__' . get_class($this) . '__get_data_for_context__data', $data, $this);
+        $data = apply_filters('FHEE__'.get_class($this).'__get_data_for_context__data', $data, $this);
         // if empty then something went wrong!
         if (empty($data)) {
             throw new EE_Error(
@@ -539,7 +539,7 @@ 
     public function with_messengers()
     {
         return apply_filters(
-            'FHEE__EE_message_type__get_with_messengers__with_messengers__' . get_class($this),
+            'FHEE__EE_message_type__get_with_messengers__with_messengers__'.get_class($this),
             $this->_with_messengers
         );
     }
@@ -600,7 +600,7 @@ 
     {
         // first class specific filter then filter that by the global filter.
         $master_templates = apply_filters(
-            'FHEE__' . get_class($this) . '__get_master_templates',
+            'FHEE__'.get_class($this).'__get_master_templates',
             $this->_master_templates
         );
         return apply_filters('FHEE__EE_message_type__get_master_templates', $master_templates, $this);
@@ -624,11 +624,11 @@ 
         $addressees        = array();
         $original_contexts = $this->_contexts;
         // if incoming context then limit to that context
-        if (! empty($context)) {
-            $cntxt = ! empty($this->_contexts[ $context ]) ? $this->_contexts[ $context ] : '';
-            if (! empty($cntxt)) {
-                $this->_contexts           = array();
-                $this->_contexts[ $context ] = $cntxt;
+        if ( ! empty($context)) {
+            $cntxt = ! empty($this->_contexts[$context]) ? $this->_contexts[$context] : '';
+            if ( ! empty($cntxt)) {
+                $this->_contexts = array();
+                $this->_contexts[$context] = $cntxt;
             }
         }
         $this->_set_default_addressee_data();
@@ -653,13 +653,13 @@ 
     {
         // at a minimum, we NEED EE_Attendee objects.
         if (empty($this->_data->attendees)) {
-            return false;  // there's no data to process!
+            return false; // there's no data to process!
         }
         // process addressees for each context.  Child classes will have to have methods for
         // each context defined to handle the processing of the data object within them
         foreach ($this->_contexts as $context => $details) {
-            $xpctd_method = '_' . $context . '_addressees';
-            if (! method_exists($this, $xpctd_method)) {
+            $xpctd_method = '_'.$context.'_addressees';
+            if ( ! method_exists($this, $xpctd_method)) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -671,7 +671,7 @@ 
                     )
                 );
             }
-            $this->_addressees[ $context ] = call_user_func(array($this, $xpctd_method));
+            $this->_addressees[$context] = call_user_func(array($this, $xpctd_method));
         }
         return true; // data was processed successfully.
     }
@@ -707,7 +707,7 @@ 
             'total_ticket_count'       => $this->_data->total_ticket_count,
         );
         if (is_array($this->_data->primary_attendee_data)) {
-            $this->_default_addressee_data                    = array_merge(
+            $this->_default_addressee_data = array_merge(
                 $this->_default_addressee_data,
                 $this->_data->primary_attendee_data
             );
@@ -750,25 +750,25 @@ 
             'email',
             'messenger',
         );
-        $contexts       = $this->get_contexts();
+        $contexts = $this->get_contexts();
         foreach ($contexts as $context => $details) {
-            $this->_valid_shortcodes[ $context ] = $all_shortcodes;
+            $this->_valid_shortcodes[$context] = $all_shortcodes;
             // make sure non admin context does not include the event_author shortcodes
             if ($context != 'admin') {
-                if (($key = array_search('event_author', $this->_valid_shortcodes[ $context ])) !== false) {
-                    unset($this->_valid_shortcodes[ $context ][ $key ]);
+                if (($key = array_search('event_author', $this->_valid_shortcodes[$context])) !== false) {
+                    unset($this->_valid_shortcodes[$context][$key]);
                 }
             }
         }
         // make sure admin context does not include the recipient_details shortcodes
         // IF we have admin context hooked in message types might not have that context.
-        if (! empty($this->_valid_shortcodes['admin'])) {
+        if ( ! empty($this->_valid_shortcodes['admin'])) {
             if (($key = array_search('recipient_details', $this->_valid_shortcodes['admin'])) !== false) {
-                unset($this->_valid_shortcodes['admin'][ $key ]);
+                unset($this->_valid_shortcodes['admin'][$key]);
             }
             // make sure admin context does not include the recipient_details shortcodes
             if (($key = array_search('recipient_list', $this->_valid_shortcodes['admin'])) !== false) {
-                unset($this->_valid_shortcodes['admin'][ $key ]);
+                unset($this->_valid_shortcodes['admin'][$key]);
             }
         }
     }
@@ -783,7 +783,7 @@ 
     public function reset_valid_shortcodes_config($new_config)
     {
         foreach ($new_config as $context => $shortcodes) {
-            $this->_valid_shortcodes[ $context ] = $shortcodes;
+            $this->_valid_shortcodes[$context] = $shortcodes;
         }
     }
 
@@ -807,11 +807,11 @@ 
         foreach ($this->_data->events as $line_ref => $event) {
             $admin_id = $this->_get_event_admin_id($event['ID']);
             // make sure we are just including the events that belong to this admin!
-            $admin_events[ $admin_id ][ $line_ref ] = $event;
+            $admin_events[$admin_id][$line_ref] = $event;
         }
         // k now we can loop through the event_admins and setup the addressee data.
         foreach ($admin_events as $admin_id => $event_details) {
-            $aee          = array(
+            $aee = array(
                 'user_id'        => $admin_id,
                 'events'         => $event_details,
                 'attendees'      => $this->_data->attendees,
@@ -868,7 +868,7 @@ 
             }
             // is $this->_regs_for_sending present?
             // If so, let's make sure we ONLY generate addressee for registrations in that array.
-            if (! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
+            if ( ! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
                 $regs_allowed = array_intersect_key(array_flip($this->_regs_for_sending), $details['reg_objs']);
                 if (empty($regs_allowed)) {
                     continue;
@@ -886,10 +886,10 @@ 
             }
             $already_processed[] = $att_id;
             foreach ($details as $item => $value) {
-                $aee[ $item ] = $value;
+                $aee[$item] = $value;
                 if ($item === 'line_ref') {
                     foreach ($value as $event_id) {
-                        $aee['events'][ $event_id ] = $this->_data->events[ $event_id ];
+                        $aee['events'][$event_id] = $this->_data->events[$event_id];
                     }
                 }
                 if ($item === 'attendee_email') {
@@ -901,7 +901,7 @@ 
             }
             // note the FIRST reg object in this array is the one
             // we'll use for this attendee as the primary registration for this attendee.
-            $aee['reg_obj']        = reset($this->_data->attendees[ $att_id ]['reg_objs']);
+            $aee['reg_obj']        = reset($this->_data->attendees[$att_id]['reg_objs']);
             $aee['attendees']      = $this->_data->attendees;
             $aee['recipient_id']   = $att_id;
             $aee['recipient_type'] = 'Attendee';

Indentation +905 added lines, -905 removed lines

@@ -17,915 +17,915 @@
 {
 
 
-    /**
-     * message type child classes will set what contexts are associated with the message type via this array.
-     * format:
-     * array(
-     * 'context' => array(
-     *        'label' => __('Context Label', 'event_espresso'),
-     *        'description' => __('Context description (for help popups)', 'event_espresso')
-     *    ));
-     *
-     * @var array
-     */
-    protected $_contexts = array();
-
-
-    /**
-     * This property is used to define what the display label will be for contexts (eg. "Recipients", "Themes" etc.)
-     * Format:
-     * array( 'label' => 'something', 'plural' => 'somethings', 'description' => 'something' );
-     *
-     * @var array
-     */
-    protected $_context_label;
-
-
-    /** MESSAGE ASSEMBLING PROPERTIES **/
-    /**
-     * This parameter simply holds all the message objects for retrieval by the controller and sending to the messenger.
-     *
-     * @var array of message objects.
-     */
-    public $messages = array();
-
-    /**
-     * The following holds the templates that will be used to assemble the message object for the messenger.
-     *
-     * @var array
-     */
-    protected $_templates;
-
-
-    /**
-     * If a specific template is being parsed, this will hold the message template group GRP_ID for that template.
-     *
-     * @var int.
-     */
-    protected $_GRP_ID;
-
-
-    /** OTHER INFO PROPERTIES **/
-    /**
-     * This will hold the count of the message objects in the messages array. This could be used for determining if
-     * batching/queueing is needed.
-     *
-     * @var int
-     */
-    public $count = 0;
-
-
-    /**
-     * This is set via the `do_messenger_hooks` method and contains the messenger being used to send the message of
-     * this message type at time of sending.
-     *
-     * @var EE_messenger
-     */
-    protected $_active_messenger;
-
-
-    /**
-     * This will hold the shortcode_replace instance for handling replacement of shortcodes in the various templates
-     *
-     * @var object
-     */
-    protected $_shortcode_replace;
-
-
-    /**
-     * The purpose for this property is to simply allow message types to indicate if the message generated is intended
-     * for only single context.  Child message types should redefine this variable (if necessary) in the
-     * _set_data_Handler() method.
-     *
-     * @var boolean
-     */
-    protected $_single_message = false;
-
-
-    /**
-     * This will hold an array of specific reg_ids that are receiving messages.
-     *
-     * @since 4.7.x
-     * @var array
-     */
-    protected $_regs_for_sending = array();
-
-
-    /**
-     * This holds the data passed to this class from the controller and also the final processed data.
-     *
-     * @var object
-     */
-    protected $_data;
-
-
-    /**
-     * this is just a flag indicating whether we're in preview mode or not.
-     *
-     * @var bool
-     */
-    protected $_preview = false;
-
-
-    /**
-     * This just holds defaults for addressee data that children merge with their data array setup
-     *
-     * @var array
-     */
-    protected $_default_addressee_data;
-
-
-    /**
-     * Child classes declare through this property what handler they want to use for the incoming data and this string
-     * is used to instantiate the EE_Messages_incoming_data child class for that handler.
-     *
-     * @var string
-     */
-    protected $_data_handler;
-
-
-    /**
-     * This holds any specific fields for holding any settings related to a message type (if any needed)
-     *
-     * @var array
-     */
-    protected $_admin_settings_fields = array();
-
-    /**
-     * this property will hold any existing setting that may have been set in the admin.
-     *
-     * @var array
-     */
-    protected $_existing_admin_settings = array();
-
-
-    /**
-     * This is used to designate the generating and alternative sending messengers for a message type.  It is set via
-     * set_with_messengers() on construct. Note, generating messenger also acts as a sending messenger for this message
-     * type.  However ONLY the generating messengers are used for creating templates for this message type. Should be
-     * in this format:
-     * {
-     *
-     * @type string $generating_messenger the name of the generating messenger.  Generating
-     *                                          messengers are used for generating templates,
-     *                                          doing validation and defining valid shortcodes.
-     *      {
-     * @type string $sending_messenger    values are the name(s) for the sending
-     *                                              messengers.  sending messengers are
-     *                                              just valid delivery vehicles that will utilize
-     *                                              the templates (and generated EE_message
-     *                                              objects from the generating messengers).
-     *      }
-     * }
-     * @since                             4.5.0
-     * @var array
-     */
-    protected $_with_messengers = array();
-
-
-    /**
-     * This holds the addressees in an array indexed by context for later retrieval when assembling the message objects.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_addressees = array();
-
-
-    /**
-     * This allows each message type to set what alternate messenger&message type combination can be used for fallback
-     * default templates if there are no specific ones defined for this messenger and message type.  Should be in the
-     * format:
-     * array(
-     *      'messenger' => 'message_type',
-     *      'another_messenger' => another_message_type
-     * );
-     * This is set in the message type constructor.
-     *
-     * @var array
-     */
-    protected $_master_templates = array();
-
-
-    /**
-     * This holds whatever the set template pack is for a message template group when generating messages.
-     *
-     * @since 4.5.0
-     * @var EE_Messages_Template_Pack
-     */
-    protected $_template_pack;
-
-
-    /**
-     * This holds whatever the set variation is for a message template group when generating messages.
-     *
-     * @since 4.5.0
-     * @var string
-     */
-    protected $_variation;
-
-
-    /**
-     * EE_message_type constructor.
-     */
-    public function __construct()
-    {
-        $this->_messages_item_type = 'message_type';
-        $this->_set_contexts();
-        $this->_set_with_messengers();
-        parent::__construct();
-    }
-
-
-    /**
-     * This sets the data handler for the message type.  It must be used to define the _data_handler property.  It is
-     * called when messages are setup.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_data_handler();
-
-
-    /**
-     * This method should return a EE_Base_Class object (or array of EE_Base_Class objects) for the given context and
-     * ID (which should be the primary key id for the base class).  Client code doesn't have to know what a message
-     * type's data handler is.
-     *
-     * @since 4.5.0
-     * @param string          $context      This should be a string matching a valid context for the message type.
-     * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
-     *                                      guessing a url).
-     * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
-     *                                      EE_Base_Class_Object
-     * @return mixed ( EE_Base_Class||EE_Base_Class[] )
-     */
-    abstract protected function _get_data_for_context($context, EE_Registration $registration, $id);
-
-
-    /**
-     * _set_contexts
-     * This sets up the contexts associated with the message_type
-     *
-     * @abstract
-     * @access  protected
-     * @return  void
-     */
-    abstract protected function _set_contexts();
-
-
-    /**
-     * This is used to get the "id" value fo the msg_trigger_url generated by get_url_trigger().
-     * In most cases, child classes don't need anything, (hence the default of 0), however if there is a specific
-     * EE_Base_Class that is required in generating a message for a message type recipient then the message
-     * type should override this method and use the given params to generate the correct ID.
-     *
-     * @param string          $context      The message type context.
-     * @param EE_Registration $registration Registration object
-     * @deprecated 4.9.0
-     * @return int
-     */
-    protected function _get_id_for_msg_url($context, EE_Registration $registration)
-    {
-        return 0;
-    }
-
-
-    /**
-     * This sets up any action/filter hooks this message type puts in place for a specific messenger.  Note that by
-     * default this does nothing.  Child classes will need to override if they want to add specific hooks for a
-     * messenger.
-     *
-     * @since 1.0.0
-     * @return void
-     */
-    protected function _do_messenger_hooks()
-    {
-        return;
-    }
-
-
-    /**
-     * This is a public wrapper for the protected _do_messenger_hooks() method.
-     * For backward compat reasons, this was done rather than making the protected method public.
-     *
-     * @param   EE_messenger $messenger This is used to set the $_active_messenger property, so message types are able
-     *                                  to know what messenger is being used to send the message at the time of
-     *                                  sending.
-     * @since 4.9.0
-     */
-    public function do_messenger_hooks($messenger = null)
-    {
-        $this->_active_messenger = $messenger;
-        $this->_do_messenger_hooks();
-    }
-
-
-    /**
-     * This method returns whether this message type should always generate a new copy
-     * when requested, or if links can be to the already generated copy.
-     * Note: this does NOT affect viewing/resending already generated messages in the EE_Message list table.
-     * Child classes should override this if different from the default of false.
-     *
-     * @return bool     false means can link to generated EE_Message.  true must regenerate.
-     */
-    public function always_generate()
-    {
-        return false;
-    }
-
-
-    /**
-     * Returns the priority for the message type.
-     * Priorities are defined as constants on EEM_Message.  Currently there are three priorities:
-     * - EEM_Message::priority_high
-     * - EEM_Message::priority_medium
-     * - EEM_Message::priority_low
-     * Priority is used to determine the weight the message type is given when queuing for generation and/or sending.
-     *
-     * @see    EEM_Message for more phpdocs on priority.
-     *         The default priority for all message_types is EEM_Message::priority_low.  Message Types wanting to give
-     *         a higher priority must override this method. Also note, messengers are able to override priorities
-     *         queuing instructions if their "send_now" flag is set to true. An example of this is the HTML messenger
-     *         which displays things in the browser.
-     * @since  4.9.0
-     * @return int
-     */
-    public function get_priority()
-    {
-        return EEM_Message::priority_low;
-    }
-
-
-    /**
-     * This runs the _set_data_handler() method for message types and then returns what got set.
-     *
-     * @param mixed $data This sets the data property for the message type with the incoming data used for generating.
-     * @return string (the reference for the data handler) (will be an empty string if could not be determined).
-     */
-    public function get_data_handler($data)
-    {
-        $this->_data = $data;
-        $this->_set_data_handler();
-        return apply_filters('FHEE__EE_message_type__get_data_handler', $this->_data_handler, $this);
-    }
-
-
-    /**
-     * This is called externally to reset the value of the $_data property for the message type.
-     * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
-     * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called
-     * (and for back compat reasons). This particular method is used in
-     * EE_Messages_Generator::_reset_current_properties to ensure that the internal _data on the message type is
-     * cleaned before subsequent EE_Message generation in the same request.
-     *
-     * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
-     *            ensure that there is no manipulation of the _data property during run time so there's a clear
-     *            expectation of what it is.  Likely we need to ensure that _data is not persisted IN the message type
-     *            at all.
-     * @internal  Plugin authors, do not implement this method, it is subject to change.
-     * @since     4.9
-     */
-    public function reset_data()
-    {
-        $this->_data = null;
-    }
-
-
-    /**
-     * This does some validation of incoming params gets the url trigger from the defined method in the specific child
-     * class and then filters the results.
-     *
-     * @param string          $context           The message type context
-     * @param string          $sending_messenger The sending messenger
-     * @param EE_Registration $registration      Registration object
-     * @throws EE_Error
-     * @deprecated  4.9.0  Likely 4.9.10 or 4.10.0 will remove this method completely
-     * @return string          generated url
-     */
-    public function get_url_trigger($context, $sending_messenger, EE_Registration $registration)
-    {
-        // validate context
-        // valid context?
-        if (! isset($this->_contexts[ $context ])) {
-            throw new EE_Error(
-                sprintf(
-                    __('The context %s is not a valid context for %s.', 'event_espresso'),
-                    $context,
-                    get_class($this)
-                )
-            );
-        }
-        // valid sending_messenger?
-        $not_valid_msgr = false;
-        foreach ($this->_with_messengers as $generating => $sendings) {
-            if (empty($sendings) || array_search($sending_messenger, $sendings) === false) {
-                $not_valid_msgr = true;
-            }
-        }
-        if ($not_valid_msgr) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The given sending messenger string (%s) does not match a valid sending messenger with the %s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
-                        'event_espresso'
-                    ),
-                    $sending_messenger,
-                    get_class($this)
-                )
-            );
-        }
-        return EEH_MSG_Template::generate_url_trigger(
-            $sending_messenger,
-            $this->_active_messenger->name,
-            $context,
-            $this->name,
-            $registration,
-            $this->_GRP_ID,
-            $this->_get_id_for_msg_url($context, $registration)
-        );
-    }
-
-
-    /**
-     * Wrapper for _get_data_for_context() that handles some validation before calling the main class and also allows
-     * for filtering. This is (currently) called by the EED_Messages module.
-     *
-     * @since 4.5.0
-     * @throws EE_Error
-     * @param string          $context      This should be a string matching a valid context for the message type.
-     * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
-     *                                      guessing a url).
-     * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
-     *                                      EE_Base_Class_Object
-     * @return mixed (EE_Base_Class||EE_Base_Class[])
-     */
-    public function get_data_for_context($context, EE_Registration $registration, $id = 0)
-    {
-        // valid context?
-        if (! isset($this->_contexts[ $context ])) {
-            throw new EE_Error(
-                sprintf(
-                    __('The context %s is not a valid context for %s.', 'event_espresso'),
-                    $context,
-                    get_class($this)
-                )
-            );
-        }
-        // get data and apply global and class specific filters on it.
-        $data = apply_filters(
-            'FHEE__EE_message_type__get_data_for_context__data',
-            $this->_get_data_for_context($context, $registration, $id),
-            $this
-        );
-        $data = apply_filters('FHEE__' . get_class($this) . '__get_data_for_context__data', $data, $this);
-        // if empty then something went wrong!
-        if (empty($data)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'There is no data retrieved, it is possible that the id given (%d) does not match any value in the database for the corresponding EE_Base_Class used by the data handler for the %s message type.',
-                        'event_espresso'
-                    ),
-                    $id,
-                    $this->name
-                )
-            );
-        }
-        return $data;
-    }
-
-
-    /**
-     * This returns the contents of the _data property.
-     * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
-     * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called.
-     *
-     * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
-     *            ensure that there is no manipulation of the _data property during run time so there's a clear
-     *            expectation of what it is.
-     * @internal  Plugin authors, do not implement this method, it is subject to change.
-     * @return mixed
-     */
-    public function get_data()
-    {
-        return $this->_data;
-    }
-
-
-    /**
-     * used to set the $_with_messengers property. (this is a default, child classes SHOULD override)
-     *
-     * @see   property definition for description of setup.
-     * @since 4.5.0
-     * @abstract
-     * @return void
-     */
-    protected function _set_with_messengers()
-    {
-        $this->_with_messengers = array(
-            'email' => array('html'),
-        );
-    }
-
-
-    /**
-     * Return the value of the _with_messengers property
-     *
-     * @since 4.5.0
-     * @return array
-     */
-    public function with_messengers()
-    {
-        return apply_filters(
-            'FHEE__EE_message_type__get_with_messengers__with_messengers__' . get_class($this),
-            $this->_with_messengers
-        );
-    }
-
-
-    /**
-     * this public method accepts a page slug (for an EE_admin page) and will return the response from the child class
-     * callback function if that page is registered via the `_admin_registered_page` property set by the child class.
-     * *
-     *
-     * @param string $page       the slug of the EE admin page
-     * @param array  $messengers an array of active messenger objects
-     * @param string $action     the page action (to allow for more specific handling - i.e. edit vs. add pages)
-     * @param array  $extra      This is just an extra argument that can be used to pass additional data for setting up
-     *                           page content.
-     * @access public
-     * @return string
-     */
-    public function get_message_type_admin_page_content(
-        $page,
-        $action = null,
-        $extra = array(),
-        $messengers = array()
-    ) {
-        // we can also further refine the context by action (if present).
-        return $this->_get_admin_page_content($page, $action, $extra, $messengers);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_contexts()
-    {
-        return $this->_contexts;
-    }
-
-
-    /**
-     * This just returns the context label for a given context (as set in $_context_label property)
-     *
-     * @access public
-     * @return array
-     */
-    public function get_context_label()
-    {
-        return $this->_context_label;
-    }
-
-
-    /**
-     * This just returns the (filtered) _master_templates property.
-     *
-     * @see property definition for documentation.
-     * @return array
-     */
-    public function get_master_templates()
-    {
-        // first class specific filter then filter that by the global filter.
-        $master_templates = apply_filters(
-            'FHEE__' . get_class($this) . '__get_master_templates',
-            $this->_master_templates
-        );
-        return apply_filters('FHEE__EE_message_type__get_master_templates', $master_templates, $this);
-    }
-
-
-    /**
-     * Accepts an incoming data handler which contains data for processing, and returns an array of
-     * EE_Messages_Addressee objects.
-     *
-     * @param EE_Messages_incoming_data $data
-     * @param string                    $context Limit addressees to specific context.
-     * @return array An array indexed by context where each context is an array of EE_Messages_Addressee objects for
-     *                                           that context
-     * @throws EE_Error
-     */
-    public function get_addressees(EE_Messages_incoming_data $data, $context = '')
-    {
-        // override _data
-        $this->_data       = $data;
-        $addressees        = array();
-        $original_contexts = $this->_contexts;
-        // if incoming context then limit to that context
-        if (! empty($context)) {
-            $cntxt = ! empty($this->_contexts[ $context ]) ? $this->_contexts[ $context ] : '';
-            if (! empty($cntxt)) {
-                $this->_contexts           = array();
-                $this->_contexts[ $context ] = $cntxt;
-            }
-        }
-        $this->_set_default_addressee_data();
-        if ($this->_process_data()) {
-            $addressees = $this->_addressees;
-        }
-
-        // reset contexts and addressees
-        $this->_contexts   = $original_contexts;
-        $this->_addressees = array();
-        return $addressees;
-    }
-
-
-    /**
-     * processes the data object so we get
-     *
-     * @throws EE_Error
-     * @return bool  true means data was processed successfully, false means not.
-     */
-    protected function _process_data()
-    {
-        // at a minimum, we NEED EE_Attendee objects.
-        if (empty($this->_data->attendees)) {
-            return false;  // there's no data to process!
-        }
-        // process addressees for each context.  Child classes will have to have methods for
-        // each context defined to handle the processing of the data object within them
-        foreach ($this->_contexts as $context => $details) {
-            $xpctd_method = '_' . $context . '_addressees';
-            if (! method_exists($this, $xpctd_method)) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'The data for %1$s message type cannot be prepared because there is no set method for doing so.  The expected method name is "%2$s" please doublecheck the %1$s message type class and make sure that method is present',
-                            'event_espresso'
-                        ),
-                        $this->label['singular'],
-                        $xpctd_method
-                    )
-                );
-            }
-            $this->_addressees[ $context ] = call_user_func(array($this, $xpctd_method));
-        }
-        return true; // data was processed successfully.
-    }
-
-
-    /**
-     * sets the default_addressee_data property,
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_default_addressee_data()
-    {
-        $this->_default_addressee_data = array(
-            'billing'                  => $this->_data->billing,
-            'taxes'                    => $this->_data->taxes,
-            'tax_line_items'           => $this->_data->tax_line_items,
-            'additional_line_items'    => $this->_data->additional_line_items,
-            'grand_total_line_item'    => $this->_data->grand_total_line_item,
-            'txn'                      => $this->_data->txn,
-            'payments'                 => $this->_data->payments,
-            'payment'                  => isset($this->_data->payment) && $this->_data->payment instanceof EE_Payment
-                ? $this->_data->payment
-                : null,
-            'reg_objs'                 => $this->_data->reg_objs,
-            'registrations'            => $this->_data->registrations,
-            'datetimes'                => $this->_data->datetimes,
-            'tickets'                  => $this->_data->tickets,
-            'line_items_with_children' => $this->_data->line_items_with_children,
-            'questions'                => $this->_data->questions,
-            'answers'                  => $this->_data->answers,
-            'txn_status'               => $this->_data->txn_status,
-            'total_ticket_count'       => $this->_data->total_ticket_count,
-        );
-        if (is_array($this->_data->primary_attendee_data)) {
-            $this->_default_addressee_data                    = array_merge(
-                $this->_default_addressee_data,
-                $this->_data->primary_attendee_data
-            );
-            $this->_default_addressee_data['primary_att_obj'] = $this->_data->primary_attendee_data['att_obj'];
-            $this->_default_addressee_data['primary_reg_obj'] = $this->_data->primary_attendee_data['reg_obj'];
-        }
-    }
-
-
-
-    /********************
+	/**
+	 * message type child classes will set what contexts are associated with the message type via this array.
+	 * format:
+	 * array(
+	 * 'context' => array(
+	 *        'label' => __('Context Label', 'event_espresso'),
+	 *        'description' => __('Context description (for help popups)', 'event_espresso')
+	 *    ));
+	 *
+	 * @var array
+	 */
+	protected $_contexts = array();
+
+
+	/**
+	 * This property is used to define what the display label will be for contexts (eg. "Recipients", "Themes" etc.)
+	 * Format:
+	 * array( 'label' => 'something', 'plural' => 'somethings', 'description' => 'something' );
+	 *
+	 * @var array
+	 */
+	protected $_context_label;
+
+
+	/** MESSAGE ASSEMBLING PROPERTIES **/
+	/**
+	 * This parameter simply holds all the message objects for retrieval by the controller and sending to the messenger.
+	 *
+	 * @var array of message objects.
+	 */
+	public $messages = array();
+
+	/**
+	 * The following holds the templates that will be used to assemble the message object for the messenger.
+	 *
+	 * @var array
+	 */
+	protected $_templates;
+
+
+	/**
+	 * If a specific template is being parsed, this will hold the message template group GRP_ID for that template.
+	 *
+	 * @var int.
+	 */
+	protected $_GRP_ID;
+
+
+	/** OTHER INFO PROPERTIES **/
+	/**
+	 * This will hold the count of the message objects in the messages array. This could be used for determining if
+	 * batching/queueing is needed.
+	 *
+	 * @var int
+	 */
+	public $count = 0;
+
+
+	/**
+	 * This is set via the `do_messenger_hooks` method and contains the messenger being used to send the message of
+	 * this message type at time of sending.
+	 *
+	 * @var EE_messenger
+	 */
+	protected $_active_messenger;
+
+
+	/**
+	 * This will hold the shortcode_replace instance for handling replacement of shortcodes in the various templates
+	 *
+	 * @var object
+	 */
+	protected $_shortcode_replace;
+
+
+	/**
+	 * The purpose for this property is to simply allow message types to indicate if the message generated is intended
+	 * for only single context.  Child message types should redefine this variable (if necessary) in the
+	 * _set_data_Handler() method.
+	 *
+	 * @var boolean
+	 */
+	protected $_single_message = false;
+
+
+	/**
+	 * This will hold an array of specific reg_ids that are receiving messages.
+	 *
+	 * @since 4.7.x
+	 * @var array
+	 */
+	protected $_regs_for_sending = array();
+
+
+	/**
+	 * This holds the data passed to this class from the controller and also the final processed data.
+	 *
+	 * @var object
+	 */
+	protected $_data;
+
+
+	/**
+	 * this is just a flag indicating whether we're in preview mode or not.
+	 *
+	 * @var bool
+	 */
+	protected $_preview = false;
+
+
+	/**
+	 * This just holds defaults for addressee data that children merge with their data array setup
+	 *
+	 * @var array
+	 */
+	protected $_default_addressee_data;
+
+
+	/**
+	 * Child classes declare through this property what handler they want to use for the incoming data and this string
+	 * is used to instantiate the EE_Messages_incoming_data child class for that handler.
+	 *
+	 * @var string
+	 */
+	protected $_data_handler;
+
+
+	/**
+	 * This holds any specific fields for holding any settings related to a message type (if any needed)
+	 *
+	 * @var array
+	 */
+	protected $_admin_settings_fields = array();
+
+	/**
+	 * this property will hold any existing setting that may have been set in the admin.
+	 *
+	 * @var array
+	 */
+	protected $_existing_admin_settings = array();
+
+
+	/**
+	 * This is used to designate the generating and alternative sending messengers for a message type.  It is set via
+	 * set_with_messengers() on construct. Note, generating messenger also acts as a sending messenger for this message
+	 * type.  However ONLY the generating messengers are used for creating templates for this message type. Should be
+	 * in this format:
+	 * {
+	 *
+	 * @type string $generating_messenger the name of the generating messenger.  Generating
+	 *                                          messengers are used for generating templates,
+	 *                                          doing validation and defining valid shortcodes.
+	 *      {
+	 * @type string $sending_messenger    values are the name(s) for the sending
+	 *                                              messengers.  sending messengers are
+	 *                                              just valid delivery vehicles that will utilize
+	 *                                              the templates (and generated EE_message
+	 *                                              objects from the generating messengers).
+	 *      }
+	 * }
+	 * @since                             4.5.0
+	 * @var array
+	 */
+	protected $_with_messengers = array();
+
+
+	/**
+	 * This holds the addressees in an array indexed by context for later retrieval when assembling the message objects.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_addressees = array();
+
+
+	/**
+	 * This allows each message type to set what alternate messenger&message type combination can be used for fallback
+	 * default templates if there are no specific ones defined for this messenger and message type.  Should be in the
+	 * format:
+	 * array(
+	 *      'messenger' => 'message_type',
+	 *      'another_messenger' => another_message_type
+	 * );
+	 * This is set in the message type constructor.
+	 *
+	 * @var array
+	 */
+	protected $_master_templates = array();
+
+
+	/**
+	 * This holds whatever the set template pack is for a message template group when generating messages.
+	 *
+	 * @since 4.5.0
+	 * @var EE_Messages_Template_Pack
+	 */
+	protected $_template_pack;
+
+
+	/**
+	 * This holds whatever the set variation is for a message template group when generating messages.
+	 *
+	 * @since 4.5.0
+	 * @var string
+	 */
+	protected $_variation;
+
+
+	/**
+	 * EE_message_type constructor.
+	 */
+	public function __construct()
+	{
+		$this->_messages_item_type = 'message_type';
+		$this->_set_contexts();
+		$this->_set_with_messengers();
+		parent::__construct();
+	}
+
+
+	/**
+	 * This sets the data handler for the message type.  It must be used to define the _data_handler property.  It is
+	 * called when messages are setup.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_data_handler();
+
+
+	/**
+	 * This method should return a EE_Base_Class object (or array of EE_Base_Class objects) for the given context and
+	 * ID (which should be the primary key id for the base class).  Client code doesn't have to know what a message
+	 * type's data handler is.
+	 *
+	 * @since 4.5.0
+	 * @param string          $context      This should be a string matching a valid context for the message type.
+	 * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
+	 *                                      guessing a url).
+	 * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
+	 *                                      EE_Base_Class_Object
+	 * @return mixed ( EE_Base_Class||EE_Base_Class[] )
+	 */
+	abstract protected function _get_data_for_context($context, EE_Registration $registration, $id);
+
+
+	/**
+	 * _set_contexts
+	 * This sets up the contexts associated with the message_type
+	 *
+	 * @abstract
+	 * @access  protected
+	 * @return  void
+	 */
+	abstract protected function _set_contexts();
+
+
+	/**
+	 * This is used to get the "id" value fo the msg_trigger_url generated by get_url_trigger().
+	 * In most cases, child classes don't need anything, (hence the default of 0), however if there is a specific
+	 * EE_Base_Class that is required in generating a message for a message type recipient then the message
+	 * type should override this method and use the given params to generate the correct ID.
+	 *
+	 * @param string          $context      The message type context.
+	 * @param EE_Registration $registration Registration object
+	 * @deprecated 4.9.0
+	 * @return int
+	 */
+	protected function _get_id_for_msg_url($context, EE_Registration $registration)
+	{
+		return 0;
+	}
+
+
+	/**
+	 * This sets up any action/filter hooks this message type puts in place for a specific messenger.  Note that by
+	 * default this does nothing.  Child classes will need to override if they want to add specific hooks for a
+	 * messenger.
+	 *
+	 * @since 1.0.0
+	 * @return void
+	 */
+	protected function _do_messenger_hooks()
+	{
+		return;
+	}
+
+
+	/**
+	 * This is a public wrapper for the protected _do_messenger_hooks() method.
+	 * For backward compat reasons, this was done rather than making the protected method public.
+	 *
+	 * @param   EE_messenger $messenger This is used to set the $_active_messenger property, so message types are able
+	 *                                  to know what messenger is being used to send the message at the time of
+	 *                                  sending.
+	 * @since 4.9.0
+	 */
+	public function do_messenger_hooks($messenger = null)
+	{
+		$this->_active_messenger = $messenger;
+		$this->_do_messenger_hooks();
+	}
+
+
+	/**
+	 * This method returns whether this message type should always generate a new copy
+	 * when requested, or if links can be to the already generated copy.
+	 * Note: this does NOT affect viewing/resending already generated messages in the EE_Message list table.
+	 * Child classes should override this if different from the default of false.
+	 *
+	 * @return bool     false means can link to generated EE_Message.  true must regenerate.
+	 */
+	public function always_generate()
+	{
+		return false;
+	}
+
+
+	/**
+	 * Returns the priority for the message type.
+	 * Priorities are defined as constants on EEM_Message.  Currently there are three priorities:
+	 * - EEM_Message::priority_high
+	 * - EEM_Message::priority_medium
+	 * - EEM_Message::priority_low
+	 * Priority is used to determine the weight the message type is given when queuing for generation and/or sending.
+	 *
+	 * @see    EEM_Message for more phpdocs on priority.
+	 *         The default priority for all message_types is EEM_Message::priority_low.  Message Types wanting to give
+	 *         a higher priority must override this method. Also note, messengers are able to override priorities
+	 *         queuing instructions if their "send_now" flag is set to true. An example of this is the HTML messenger
+	 *         which displays things in the browser.
+	 * @since  4.9.0
+	 * @return int
+	 */
+	public function get_priority()
+	{
+		return EEM_Message::priority_low;
+	}
+
+
+	/**
+	 * This runs the _set_data_handler() method for message types and then returns what got set.
+	 *
+	 * @param mixed $data This sets the data property for the message type with the incoming data used for generating.
+	 * @return string (the reference for the data handler) (will be an empty string if could not be determined).
+	 */
+	public function get_data_handler($data)
+	{
+		$this->_data = $data;
+		$this->_set_data_handler();
+		return apply_filters('FHEE__EE_message_type__get_data_handler', $this->_data_handler, $this);
+	}
+
+
+	/**
+	 * This is called externally to reset the value of the $_data property for the message type.
+	 * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
+	 * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called
+	 * (and for back compat reasons). This particular method is used in
+	 * EE_Messages_Generator::_reset_current_properties to ensure that the internal _data on the message type is
+	 * cleaned before subsequent EE_Message generation in the same request.
+	 *
+	 * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
+	 *            ensure that there is no manipulation of the _data property during run time so there's a clear
+	 *            expectation of what it is.  Likely we need to ensure that _data is not persisted IN the message type
+	 *            at all.
+	 * @internal  Plugin authors, do not implement this method, it is subject to change.
+	 * @since     4.9
+	 */
+	public function reset_data()
+	{
+		$this->_data = null;
+	}
+
+
+	/**
+	 * This does some validation of incoming params gets the url trigger from the defined method in the specific child
+	 * class and then filters the results.
+	 *
+	 * @param string          $context           The message type context
+	 * @param string          $sending_messenger The sending messenger
+	 * @param EE_Registration $registration      Registration object
+	 * @throws EE_Error
+	 * @deprecated  4.9.0  Likely 4.9.10 or 4.10.0 will remove this method completely
+	 * @return string          generated url
+	 */
+	public function get_url_trigger($context, $sending_messenger, EE_Registration $registration)
+	{
+		// validate context
+		// valid context?
+		if (! isset($this->_contexts[ $context ])) {
+			throw new EE_Error(
+				sprintf(
+					__('The context %s is not a valid context for %s.', 'event_espresso'),
+					$context,
+					get_class($this)
+				)
+			);
+		}
+		// valid sending_messenger?
+		$not_valid_msgr = false;
+		foreach ($this->_with_messengers as $generating => $sendings) {
+			if (empty($sendings) || array_search($sending_messenger, $sendings) === false) {
+				$not_valid_msgr = true;
+			}
+		}
+		if ($not_valid_msgr) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The given sending messenger string (%s) does not match a valid sending messenger with the %s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
+						'event_espresso'
+					),
+					$sending_messenger,
+					get_class($this)
+				)
+			);
+		}
+		return EEH_MSG_Template::generate_url_trigger(
+			$sending_messenger,
+			$this->_active_messenger->name,
+			$context,
+			$this->name,
+			$registration,
+			$this->_GRP_ID,
+			$this->_get_id_for_msg_url($context, $registration)
+		);
+	}
+
+
+	/**
+	 * Wrapper for _get_data_for_context() that handles some validation before calling the main class and also allows
+	 * for filtering. This is (currently) called by the EED_Messages module.
+	 *
+	 * @since 4.5.0
+	 * @throws EE_Error
+	 * @param string          $context      This should be a string matching a valid context for the message type.
+	 * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
+	 *                                      guessing a url).
+	 * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
+	 *                                      EE_Base_Class_Object
+	 * @return mixed (EE_Base_Class||EE_Base_Class[])
+	 */
+	public function get_data_for_context($context, EE_Registration $registration, $id = 0)
+	{
+		// valid context?
+		if (! isset($this->_contexts[ $context ])) {
+			throw new EE_Error(
+				sprintf(
+					__('The context %s is not a valid context for %s.', 'event_espresso'),
+					$context,
+					get_class($this)
+				)
+			);
+		}
+		// get data and apply global and class specific filters on it.
+		$data = apply_filters(
+			'FHEE__EE_message_type__get_data_for_context__data',
+			$this->_get_data_for_context($context, $registration, $id),
+			$this
+		);
+		$data = apply_filters('FHEE__' . get_class($this) . '__get_data_for_context__data', $data, $this);
+		// if empty then something went wrong!
+		if (empty($data)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'There is no data retrieved, it is possible that the id given (%d) does not match any value in the database for the corresponding EE_Base_Class used by the data handler for the %s message type.',
+						'event_espresso'
+					),
+					$id,
+					$this->name
+				)
+			);
+		}
+		return $data;
+	}
+
+
+	/**
+	 * This returns the contents of the _data property.
+	 * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
+	 * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called.
+	 *
+	 * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
+	 *            ensure that there is no manipulation of the _data property during run time so there's a clear
+	 *            expectation of what it is.
+	 * @internal  Plugin authors, do not implement this method, it is subject to change.
+	 * @return mixed
+	 */
+	public function get_data()
+	{
+		return $this->_data;
+	}
+
+
+	/**
+	 * used to set the $_with_messengers property. (this is a default, child classes SHOULD override)
+	 *
+	 * @see   property definition for description of setup.
+	 * @since 4.5.0
+	 * @abstract
+	 * @return void
+	 */
+	protected function _set_with_messengers()
+	{
+		$this->_with_messengers = array(
+			'email' => array('html'),
+		);
+	}
+
+
+	/**
+	 * Return the value of the _with_messengers property
+	 *
+	 * @since 4.5.0
+	 * @return array
+	 */
+	public function with_messengers()
+	{
+		return apply_filters(
+			'FHEE__EE_message_type__get_with_messengers__with_messengers__' . get_class($this),
+			$this->_with_messengers
+		);
+	}
+
+
+	/**
+	 * this public method accepts a page slug (for an EE_admin page) and will return the response from the child class
+	 * callback function if that page is registered via the `_admin_registered_page` property set by the child class.
+	 * *
+	 *
+	 * @param string $page       the slug of the EE admin page
+	 * @param array  $messengers an array of active messenger objects
+	 * @param string $action     the page action (to allow for more specific handling - i.e. edit vs. add pages)
+	 * @param array  $extra      This is just an extra argument that can be used to pass additional data for setting up
+	 *                           page content.
+	 * @access public
+	 * @return string
+	 */
+	public function get_message_type_admin_page_content(
+		$page,
+		$action = null,
+		$extra = array(),
+		$messengers = array()
+	) {
+		// we can also further refine the context by action (if present).
+		return $this->_get_admin_page_content($page, $action, $extra, $messengers);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_contexts()
+	{
+		return $this->_contexts;
+	}
+
+
+	/**
+	 * This just returns the context label for a given context (as set in $_context_label property)
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_context_label()
+	{
+		return $this->_context_label;
+	}
+
+
+	/**
+	 * This just returns the (filtered) _master_templates property.
+	 *
+	 * @see property definition for documentation.
+	 * @return array
+	 */
+	public function get_master_templates()
+	{
+		// first class specific filter then filter that by the global filter.
+		$master_templates = apply_filters(
+			'FHEE__' . get_class($this) . '__get_master_templates',
+			$this->_master_templates
+		);
+		return apply_filters('FHEE__EE_message_type__get_master_templates', $master_templates, $this);
+	}
+
+
+	/**
+	 * Accepts an incoming data handler which contains data for processing, and returns an array of
+	 * EE_Messages_Addressee objects.
+	 *
+	 * @param EE_Messages_incoming_data $data
+	 * @param string                    $context Limit addressees to specific context.
+	 * @return array An array indexed by context where each context is an array of EE_Messages_Addressee objects for
+	 *                                           that context
+	 * @throws EE_Error
+	 */
+	public function get_addressees(EE_Messages_incoming_data $data, $context = '')
+	{
+		// override _data
+		$this->_data       = $data;
+		$addressees        = array();
+		$original_contexts = $this->_contexts;
+		// if incoming context then limit to that context
+		if (! empty($context)) {
+			$cntxt = ! empty($this->_contexts[ $context ]) ? $this->_contexts[ $context ] : '';
+			if (! empty($cntxt)) {
+				$this->_contexts           = array();
+				$this->_contexts[ $context ] = $cntxt;
+			}
+		}
+		$this->_set_default_addressee_data();
+		if ($this->_process_data()) {
+			$addressees = $this->_addressees;
+		}
+
+		// reset contexts and addressees
+		$this->_contexts   = $original_contexts;
+		$this->_addressees = array();
+		return $addressees;
+	}
+
+
+	/**
+	 * processes the data object so we get
+	 *
+	 * @throws EE_Error
+	 * @return bool  true means data was processed successfully, false means not.
+	 */
+	protected function _process_data()
+	{
+		// at a minimum, we NEED EE_Attendee objects.
+		if (empty($this->_data->attendees)) {
+			return false;  // there's no data to process!
+		}
+		// process addressees for each context.  Child classes will have to have methods for
+		// each context defined to handle the processing of the data object within them
+		foreach ($this->_contexts as $context => $details) {
+			$xpctd_method = '_' . $context . '_addressees';
+			if (! method_exists($this, $xpctd_method)) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'The data for %1$s message type cannot be prepared because there is no set method for doing so.  The expected method name is "%2$s" please doublecheck the %1$s message type class and make sure that method is present',
+							'event_espresso'
+						),
+						$this->label['singular'],
+						$xpctd_method
+					)
+				);
+			}
+			$this->_addressees[ $context ] = call_user_func(array($this, $xpctd_method));
+		}
+		return true; // data was processed successfully.
+	}
+
+
+	/**
+	 * sets the default_addressee_data property,
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_default_addressee_data()
+	{
+		$this->_default_addressee_data = array(
+			'billing'                  => $this->_data->billing,
+			'taxes'                    => $this->_data->taxes,
+			'tax_line_items'           => $this->_data->tax_line_items,
+			'additional_line_items'    => $this->_data->additional_line_items,
+			'grand_total_line_item'    => $this->_data->grand_total_line_item,
+			'txn'                      => $this->_data->txn,
+			'payments'                 => $this->_data->payments,
+			'payment'                  => isset($this->_data->payment) && $this->_data->payment instanceof EE_Payment
+				? $this->_data->payment
+				: null,
+			'reg_objs'                 => $this->_data->reg_objs,
+			'registrations'            => $this->_data->registrations,
+			'datetimes'                => $this->_data->datetimes,
+			'tickets'                  => $this->_data->tickets,
+			'line_items_with_children' => $this->_data->line_items_with_children,
+			'questions'                => $this->_data->questions,
+			'answers'                  => $this->_data->answers,
+			'txn_status'               => $this->_data->txn_status,
+			'total_ticket_count'       => $this->_data->total_ticket_count,
+		);
+		if (is_array($this->_data->primary_attendee_data)) {
+			$this->_default_addressee_data                    = array_merge(
+				$this->_default_addressee_data,
+				$this->_data->primary_attendee_data
+			);
+			$this->_default_addressee_data['primary_att_obj'] = $this->_data->primary_attendee_data['att_obj'];
+			$this->_default_addressee_data['primary_reg_obj'] = $this->_data->primary_attendee_data['reg_obj'];
+		}
+	}
+
+
+
+	/********************
      * setup default shared addressee object/contexts
      * These can be utilized simply by defining the context in the child message type.
      * They can also be overridden if a specific message type needs to do something different for that context.
      ****************/
-    /**
-     * see abstract declaration in parent class for details, children message types can
-     * override these valid shortcodes if desired (we include all for all contexts by default).
-     */
-    protected function _set_valid_shortcodes()
-    {
-        $all_shortcodes = array(
-            'attendee_list',
-            'attendee',
-            'datetime_list',
-            'datetime',
-            'event_list',
-            'event_meta',
-            'event',
-            'organization',
-            'recipient_details',
-            'recipient_list',
-            'ticket_list',
-            'ticket',
-            'transaction',
-            'venue',
-            'primary_registration_details',
-            'primary_registration_list',
-            'event_author',
-            'email',
-            'messenger',
-        );
-        $contexts       = $this->get_contexts();
-        foreach ($contexts as $context => $details) {
-            $this->_valid_shortcodes[ $context ] = $all_shortcodes;
-            // make sure non admin context does not include the event_author shortcodes
-            if ($context != 'admin') {
-                if (($key = array_search('event_author', $this->_valid_shortcodes[ $context ])) !== false) {
-                    unset($this->_valid_shortcodes[ $context ][ $key ]);
-                }
-            }
-        }
-        // make sure admin context does not include the recipient_details shortcodes
-        // IF we have admin context hooked in message types might not have that context.
-        if (! empty($this->_valid_shortcodes['admin'])) {
-            if (($key = array_search('recipient_details', $this->_valid_shortcodes['admin'])) !== false) {
-                unset($this->_valid_shortcodes['admin'][ $key ]);
-            }
-            // make sure admin context does not include the recipient_details shortcodes
-            if (($key = array_search('recipient_list', $this->_valid_shortcodes['admin'])) !== false) {
-                unset($this->_valid_shortcodes['admin'][ $key ]);
-            }
-        }
-    }
-
-
-    /**
-     * Used by Validators to modify the valid shortcodes.
-     *
-     * @param  array $new_config array of valid shortcodes (by context)
-     * @return void               sets valid_shortcodes property
-     */
-    public function reset_valid_shortcodes_config($new_config)
-    {
-        foreach ($new_config as $context => $shortcodes) {
-            $this->_valid_shortcodes[ $context ] = $shortcodes;
-        }
-    }
-
-
-    /**
-     * returns an array of addressee objects for event_admins
-     *
-     * @access protected
-     * @return array array of EE_Messages_Addressee objects
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _admin_addressees()
-    {
-        $admin_events = array();
-        $addressees   = array();
-        // first we need to get the event admin user id for all the events
-        // and setup an addressee object for each unique admin user.
-        foreach ($this->_data->events as $line_ref => $event) {
-            $admin_id = $this->_get_event_admin_id($event['ID']);
-            // make sure we are just including the events that belong to this admin!
-            $admin_events[ $admin_id ][ $line_ref ] = $event;
-        }
-        // k now we can loop through the event_admins and setup the addressee data.
-        foreach ($admin_events as $admin_id => $event_details) {
-            $aee          = array(
-                'user_id'        => $admin_id,
-                'events'         => $event_details,
-                'attendees'      => $this->_data->attendees,
-                'recipient_id'   => $admin_id,
-                'recipient_type' => 'WP_User',
-            );
-            $aee          = array_merge($this->_default_addressee_data, $aee);
-            $addressees[] = new EE_Messages_Addressee($aee);
-        }
-        return $addressees;
-    }
-
-
-    /**
-     * Takes care of setting up the addressee object(s) for the primary attendee.
-     *
-     * @access protected
-     * @return array of EE_Addressee objects
-     * @throws EE_Error
-     */
-    protected function _primary_attendee_addressees()
-    {
-        $aee                   = $this->_default_addressee_data;
-        $aee['events']         = $this->_data->events;
-        $aee['attendees']      = $this->_data->attendees;
-        $aee['recipient_id']   = $aee['primary_att_obj'] instanceof EE_Attendee ? $aee['primary_att_obj']->ID() : 0;
-        $aee['recipient_type'] = 'Attendee';
-        // great now we can instantiate the $addressee object and return (as an array);
-        $add[] = new EE_Messages_Addressee($aee);
-        return $add;
-    }
-
-
-    /**
-     * Takes care of setting up the addressee object(s) for the registered attendees
-     *
-     * @access protected
-     * @return array of EE_Addressee objects
-     */
-    protected function _attendee_addressees()
-    {
-        $add = array();
-        // we just have to loop through the attendees.  We'll also set the attached events for each attendee.
-        // use to verify unique attendee emails... we don't want to sent multiple copies to the same attendee do we?
-        $already_processed = array();
-        foreach ($this->_data->attendees as $att_id => $details) {
-            // set the attendee array to blank on each loop;
-            $aee = array();
-            if (
-                isset($this->_data->reg_obj)
-                && ($this->_data->reg_obj->attendee_ID() != $att_id)
-                && $this->_single_message
-            ) {
-                continue;
-            }
-            // is $this->_regs_for_sending present?
-            // If so, let's make sure we ONLY generate addressee for registrations in that array.
-            if (! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
-                $regs_allowed = array_intersect_key(array_flip($this->_regs_for_sending), $details['reg_objs']);
-                if (empty($regs_allowed)) {
-                    continue;
-                }
-            }
-            if (
-                apply_filters(
-                    'FHEE__EE_message_type___attendee_addressees__prevent_duplicate_email_sends',
-                    true,
-                    $this->_data,
-                    $this
-                )
-                && in_array($att_id, $already_processed, true)
-            ) {
-                continue;
-            }
-            $already_processed[] = $att_id;
-            foreach ($details as $item => $value) {
-                $aee[ $item ] = $value;
-                if ($item === 'line_ref') {
-                    foreach ($value as $event_id) {
-                        $aee['events'][ $event_id ] = $this->_data->events[ $event_id ];
-                    }
-                }
-                if ($item === 'attendee_email') {
-                    $aee['attendee_email'] = $value;
-                }
-                /*if ( $item == 'registration_id' ) {
+	/**
+	 * see abstract declaration in parent class for details, children message types can
+	 * override these valid shortcodes if desired (we include all for all contexts by default).
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		$all_shortcodes = array(
+			'attendee_list',
+			'attendee',
+			'datetime_list',
+			'datetime',
+			'event_list',
+			'event_meta',
+			'event',
+			'organization',
+			'recipient_details',
+			'recipient_list',
+			'ticket_list',
+			'ticket',
+			'transaction',
+			'venue',
+			'primary_registration_details',
+			'primary_registration_list',
+			'event_author',
+			'email',
+			'messenger',
+		);
+		$contexts       = $this->get_contexts();
+		foreach ($contexts as $context => $details) {
+			$this->_valid_shortcodes[ $context ] = $all_shortcodes;
+			// make sure non admin context does not include the event_author shortcodes
+			if ($context != 'admin') {
+				if (($key = array_search('event_author', $this->_valid_shortcodes[ $context ])) !== false) {
+					unset($this->_valid_shortcodes[ $context ][ $key ]);
+				}
+			}
+		}
+		// make sure admin context does not include the recipient_details shortcodes
+		// IF we have admin context hooked in message types might not have that context.
+		if (! empty($this->_valid_shortcodes['admin'])) {
+			if (($key = array_search('recipient_details', $this->_valid_shortcodes['admin'])) !== false) {
+				unset($this->_valid_shortcodes['admin'][ $key ]);
+			}
+			// make sure admin context does not include the recipient_details shortcodes
+			if (($key = array_search('recipient_list', $this->_valid_shortcodes['admin'])) !== false) {
+				unset($this->_valid_shortcodes['admin'][ $key ]);
+			}
+		}
+	}
+
+
+	/**
+	 * Used by Validators to modify the valid shortcodes.
+	 *
+	 * @param  array $new_config array of valid shortcodes (by context)
+	 * @return void               sets valid_shortcodes property
+	 */
+	public function reset_valid_shortcodes_config($new_config)
+	{
+		foreach ($new_config as $context => $shortcodes) {
+			$this->_valid_shortcodes[ $context ] = $shortcodes;
+		}
+	}
+
+
+	/**
+	 * returns an array of addressee objects for event_admins
+	 *
+	 * @access protected
+	 * @return array array of EE_Messages_Addressee objects
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _admin_addressees()
+	{
+		$admin_events = array();
+		$addressees   = array();
+		// first we need to get the event admin user id for all the events
+		// and setup an addressee object for each unique admin user.
+		foreach ($this->_data->events as $line_ref => $event) {
+			$admin_id = $this->_get_event_admin_id($event['ID']);
+			// make sure we are just including the events that belong to this admin!
+			$admin_events[ $admin_id ][ $line_ref ] = $event;
+		}
+		// k now we can loop through the event_admins and setup the addressee data.
+		foreach ($admin_events as $admin_id => $event_details) {
+			$aee          = array(
+				'user_id'        => $admin_id,
+				'events'         => $event_details,
+				'attendees'      => $this->_data->attendees,
+				'recipient_id'   => $admin_id,
+				'recipient_type' => 'WP_User',
+			);
+			$aee          = array_merge($this->_default_addressee_data, $aee);
+			$addressees[] = new EE_Messages_Addressee($aee);
+		}
+		return $addressees;
+	}
+
+
+	/**
+	 * Takes care of setting up the addressee object(s) for the primary attendee.
+	 *
+	 * @access protected
+	 * @return array of EE_Addressee objects
+	 * @throws EE_Error
+	 */
+	protected function _primary_attendee_addressees()
+	{
+		$aee                   = $this->_default_addressee_data;
+		$aee['events']         = $this->_data->events;
+		$aee['attendees']      = $this->_data->attendees;
+		$aee['recipient_id']   = $aee['primary_att_obj'] instanceof EE_Attendee ? $aee['primary_att_obj']->ID() : 0;
+		$aee['recipient_type'] = 'Attendee';
+		// great now we can instantiate the $addressee object and return (as an array);
+		$add[] = new EE_Messages_Addressee($aee);
+		return $add;
+	}
+
+
+	/**
+	 * Takes care of setting up the addressee object(s) for the registered attendees
+	 *
+	 * @access protected
+	 * @return array of EE_Addressee objects
+	 */
+	protected function _attendee_addressees()
+	{
+		$add = array();
+		// we just have to loop through the attendees.  We'll also set the attached events for each attendee.
+		// use to verify unique attendee emails... we don't want to sent multiple copies to the same attendee do we?
+		$already_processed = array();
+		foreach ($this->_data->attendees as $att_id => $details) {
+			// set the attendee array to blank on each loop;
+			$aee = array();
+			if (
+				isset($this->_data->reg_obj)
+				&& ($this->_data->reg_obj->attendee_ID() != $att_id)
+				&& $this->_single_message
+			) {
+				continue;
+			}
+			// is $this->_regs_for_sending present?
+			// If so, let's make sure we ONLY generate addressee for registrations in that array.
+			if (! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
+				$regs_allowed = array_intersect_key(array_flip($this->_regs_for_sending), $details['reg_objs']);
+				if (empty($regs_allowed)) {
+					continue;
+				}
+			}
+			if (
+				apply_filters(
+					'FHEE__EE_message_type___attendee_addressees__prevent_duplicate_email_sends',
+					true,
+					$this->_data,
+					$this
+				)
+				&& in_array($att_id, $already_processed, true)
+			) {
+				continue;
+			}
+			$already_processed[] = $att_id;
+			foreach ($details as $item => $value) {
+				$aee[ $item ] = $value;
+				if ($item === 'line_ref') {
+					foreach ($value as $event_id) {
+						$aee['events'][ $event_id ] = $this->_data->events[ $event_id ];
+					}
+				}
+				if ($item === 'attendee_email') {
+					$aee['attendee_email'] = $value;
+				}
+				/*if ( $item == 'registration_id' ) {
                     $aee['attendee_registration_id'] = $value;
                 }/**/
-            }
-            // note the FIRST reg object in this array is the one
-            // we'll use for this attendee as the primary registration for this attendee.
-            $aee['reg_obj']        = reset($this->_data->attendees[ $att_id ]['reg_objs']);
-            $aee['attendees']      = $this->_data->attendees;
-            $aee['recipient_id']   = $att_id;
-            $aee['recipient_type'] = 'Attendee';
-            // merge in the primary attendee data
-            $aee   = array_merge($this->_default_addressee_data, $aee);
-            $add[] = new EE_Messages_Addressee($aee);
-        }
-        return $add;
-    }
-
-
-    /**
-     * @param $event_id
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_event_admin_id($event_id)
-    {
-        $event = EEM_Event::instance()->get_one_by_ID($event_id);
-        return $event instanceof EE_Event ? $event->wp_user() : 0;
-    }
+			}
+			// note the FIRST reg object in this array is the one
+			// we'll use for this attendee as the primary registration for this attendee.
+			$aee['reg_obj']        = reset($this->_data->attendees[ $att_id ]['reg_objs']);
+			$aee['attendees']      = $this->_data->attendees;
+			$aee['recipient_id']   = $att_id;
+			$aee['recipient_type'] = 'Attendee';
+			// merge in the primary attendee data
+			$aee   = array_merge($this->_default_addressee_data, $aee);
+			$add[] = new EE_Messages_Addressee($aee);
+		}
+		return $add;
+	}
+
+
+	/**
+	 * @param $event_id
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_event_admin_id($event_id)
+	{
+		$event = EEM_Event::instance()->get_one_by_ID($event_id);
+		return $event instanceof EE_Event ? $event->wp_user() : 0;
+	}
 }

modules/messages/EED_Messages.module.php

Doc Comments +1 added lines, -1 removed lines

@@ -632,7 +632,7 @@
      * @deprecated 4.9.0 Use EEH_MSG_Template::payment_status_to_message_type_array
      *                   or EEH_MSG_Template::convert_payment_status_to_message_type
      * @param string $payment_status The payment status being matched.
-     * @return bool|string The payment message type slug matching the status or false if no match.
+     * @return string|false The payment message type slug matching the status or false if no match.
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws ReflectionException

Indentation +1328 added lines, -1328 removed lines

@@ -16,1341 +16,1341 @@
 class EED_Messages extends EED_Module
 {
 
-    /**
-     * This holds the EE_messages controller
-     *
-     * @deprecated 4.9.0
-     * @var EE_messages $_EEMSG
-     */
-    protected static $_EEMSG;
-
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected static $_message_resource_manager;
-
-    /**
-     * This holds the EE_Messages_Processor business class.
-     *
-     * @type EE_Messages_Processor
-     */
-    protected static $_MSG_PROCESSOR;
-
-    /**
-     * holds all the paths for various messages components.
-     * Utilized by autoloader registry
-     *
-     * @var array
-     */
-    protected static $_MSG_PATHS;
-
-
-    /**
-     * This will hold an array of messages template packs that are registered in the messages system.
-     * Format is:
-     * array(
-     *    'template_pack_dbref' => EE_Messages_Template_Pack (instance)
-     * )
-     *
-     * @var EE_Messages_Template_Pack[]
-     */
-    protected static $_TMP_PACKS = array();
-
-
-    /**
-     * @return EED_Messages
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     *  set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @since 4.5.0
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        // actions
-        add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
-        add_action(
-            'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-            array('EED_Messages', 'maybe_registration'),
-            10,
-            2
-        );
-        // filters
-        add_filter(
-            'FHEE__EE_Registration__receipt_url__receipt_url',
-            array('EED_Messages', 'registration_message_trigger_url'),
-            10,
-            4
-        );
-        add_filter(
-            'FHEE__EE_Registration__invoice_url__invoice_url',
-            array('EED_Messages', 'registration_message_trigger_url'),
-            10,
-            4
-        );
-        // register routes
-        self::_register_routes();
-    }
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        // actions
-        add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
-        add_action(
-            'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
-            array('EED_Messages', 'payment_reminder'),
-            10
-        );
-        add_action(
-            'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-            array('EED_Messages', 'maybe_registration'),
-            10,
-            3
-        );
-        add_action(
-            'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
-            array('EED_Messages', 'send_newsletter_message'),
-            10,
-            2
-        );
-        add_action(
-            'AHEE__EES_Espresso_Cancelled__process_shortcode__transaction',
-            array('EED_Messages', 'cancelled_registration'),
-            10
-        );
-        add_action(
-            'AHEE__EE_Admin_Page___process_admin_payment_notification',
-            array('EED_Messages', 'process_admin_payment'),
-            10,
-            1
-        );
-        // filters
-        add_filter(
-            'FHEE__EE_Admin_Page___process_resend_registration__success',
-            array('EED_Messages', 'process_resend'),
-            10,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Registration__receipt_url__receipt_url',
-            array('EED_Messages', 'registration_message_trigger_url'),
-            10,
-            4
-        );
-        add_filter(
-            'FHEE__EE_Registration__invoice_url__invoice_url',
-            array('EED_Messages', 'registration_message_trigger_url'),
-            10,
-            4
-        );
-    }
-
-
-    /**
-     * All the message triggers done by route go in here.
-     *
-     * @since 4.5.0
-     * @return void
-     */
-    protected static function _register_routes()
-    {
-        EE_Config::register_route('msg_url_trigger', 'Messages', 'run');
-        EE_Config::register_route('msg_cron_trigger', 'Messages', 'execute_batch_request');
-        EE_Config::register_route('msg_browser_trigger', 'Messages', 'browser_trigger');
-        EE_Config::register_route('msg_browser_error_trigger', 'Messages', 'browser_error_trigger');
-        do_action('AHEE__EED_Messages___register_routes');
-    }
-
-
-    /**
-     * This is called when a browser display trigger is executed.
-     * The browser display trigger is typically used when a already generated message is displayed directly in the
-     * browser.
-     *
-     * @since 4.9.0
-     * @param WP $WP
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function browser_trigger($WP)
-    {
-        // ensure controller is loaded
-        self::_load_controller();
-        $token = EE_Registry::instance()->REQ->get('token');
-        try {
-            $mtg = new EE_Message_Generated_From_Token($token, 'html', self::$_message_resource_manager);
-            self::$_MSG_PROCESSOR->generate_and_send_now($mtg);
-        } catch (EE_Error $e) {
-            $error_msg = __(
-                'Please note that a system message failed to send due to a technical issue.',
-                'event_espresso'
-            );
-            // add specific message for developers if WP_DEBUG in on
-            $error_msg .= '||' . $e->getMessage();
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-    /**
-     * This is called when a browser error trigger is executed.
-     * When triggered this will grab the EE_Message matching the token in the request and use that to get the error
-     * message and display it.
-     *
-     * @since 4.9.0
-     * @param $WP
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function browser_error_trigger($WP)
-    {
-        $token = EE_Registry::instance()->REQ->get('token');
-        if ($token) {
-            $message = EEM_Message::instance()->get_one_by_token($token);
-            if ($message instanceof EE_Message) {
-                header('HTTP/1.1 200 OK');
-                $error_msg = nl2br($message->error_message());
-                ?>
+	/**
+	 * This holds the EE_messages controller
+	 *
+	 * @deprecated 4.9.0
+	 * @var EE_messages $_EEMSG
+	 */
+	protected static $_EEMSG;
+
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected static $_message_resource_manager;
+
+	/**
+	 * This holds the EE_Messages_Processor business class.
+	 *
+	 * @type EE_Messages_Processor
+	 */
+	protected static $_MSG_PROCESSOR;
+
+	/**
+	 * holds all the paths for various messages components.
+	 * Utilized by autoloader registry
+	 *
+	 * @var array
+	 */
+	protected static $_MSG_PATHS;
+
+
+	/**
+	 * This will hold an array of messages template packs that are registered in the messages system.
+	 * Format is:
+	 * array(
+	 *    'template_pack_dbref' => EE_Messages_Template_Pack (instance)
+	 * )
+	 *
+	 * @var EE_Messages_Template_Pack[]
+	 */
+	protected static $_TMP_PACKS = array();
+
+
+	/**
+	 * @return EED_Messages
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 *  set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @since 4.5.0
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		// actions
+		add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
+		add_action(
+			'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+			array('EED_Messages', 'maybe_registration'),
+			10,
+			2
+		);
+		// filters
+		add_filter(
+			'FHEE__EE_Registration__receipt_url__receipt_url',
+			array('EED_Messages', 'registration_message_trigger_url'),
+			10,
+			4
+		);
+		add_filter(
+			'FHEE__EE_Registration__invoice_url__invoice_url',
+			array('EED_Messages', 'registration_message_trigger_url'),
+			10,
+			4
+		);
+		// register routes
+		self::_register_routes();
+	}
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		// actions
+		add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
+		add_action(
+			'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
+			array('EED_Messages', 'payment_reminder'),
+			10
+		);
+		add_action(
+			'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+			array('EED_Messages', 'maybe_registration'),
+			10,
+			3
+		);
+		add_action(
+			'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
+			array('EED_Messages', 'send_newsletter_message'),
+			10,
+			2
+		);
+		add_action(
+			'AHEE__EES_Espresso_Cancelled__process_shortcode__transaction',
+			array('EED_Messages', 'cancelled_registration'),
+			10
+		);
+		add_action(
+			'AHEE__EE_Admin_Page___process_admin_payment_notification',
+			array('EED_Messages', 'process_admin_payment'),
+			10,
+			1
+		);
+		// filters
+		add_filter(
+			'FHEE__EE_Admin_Page___process_resend_registration__success',
+			array('EED_Messages', 'process_resend'),
+			10,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Registration__receipt_url__receipt_url',
+			array('EED_Messages', 'registration_message_trigger_url'),
+			10,
+			4
+		);
+		add_filter(
+			'FHEE__EE_Registration__invoice_url__invoice_url',
+			array('EED_Messages', 'registration_message_trigger_url'),
+			10,
+			4
+		);
+	}
+
+
+	/**
+	 * All the message triggers done by route go in here.
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 */
+	protected static function _register_routes()
+	{
+		EE_Config::register_route('msg_url_trigger', 'Messages', 'run');
+		EE_Config::register_route('msg_cron_trigger', 'Messages', 'execute_batch_request');
+		EE_Config::register_route('msg_browser_trigger', 'Messages', 'browser_trigger');
+		EE_Config::register_route('msg_browser_error_trigger', 'Messages', 'browser_error_trigger');
+		do_action('AHEE__EED_Messages___register_routes');
+	}
+
+
+	/**
+	 * This is called when a browser display trigger is executed.
+	 * The browser display trigger is typically used when a already generated message is displayed directly in the
+	 * browser.
+	 *
+	 * @since 4.9.0
+	 * @param WP $WP
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function browser_trigger($WP)
+	{
+		// ensure controller is loaded
+		self::_load_controller();
+		$token = EE_Registry::instance()->REQ->get('token');
+		try {
+			$mtg = new EE_Message_Generated_From_Token($token, 'html', self::$_message_resource_manager);
+			self::$_MSG_PROCESSOR->generate_and_send_now($mtg);
+		} catch (EE_Error $e) {
+			$error_msg = __(
+				'Please note that a system message failed to send due to a technical issue.',
+				'event_espresso'
+			);
+			// add specific message for developers if WP_DEBUG in on
+			$error_msg .= '||' . $e->getMessage();
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+	/**
+	 * This is called when a browser error trigger is executed.
+	 * When triggered this will grab the EE_Message matching the token in the request and use that to get the error
+	 * message and display it.
+	 *
+	 * @since 4.9.0
+	 * @param $WP
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function browser_error_trigger($WP)
+	{
+		$token = EE_Registry::instance()->REQ->get('token');
+		if ($token) {
+			$message = EEM_Message::instance()->get_one_by_token($token);
+			if ($message instanceof EE_Message) {
+				header('HTTP/1.1 200 OK');
+				$error_msg = nl2br($message->error_message());
+				?>
                 <!DOCTYPE html>
                 <html>
                 <head></head>
                 <body>
                 <?php echo empty($error_msg)
-                    ? esc_html__(
-                        'Unfortunately, we were unable to capture the error message for this message.',
-                        'event_espresso'
-                    )
-                    : wp_kses(
-                        $error_msg,
-                        array(
-                            'a'      => array(
-                                'href'  => array(),
-                                'title' => array(),
-                            ),
-                            'span'   => array(),
-                            'div'    => array(),
-                            'p'      => array(),
-                            'strong' => array(),
-                            'em'     => array(),
-                            'br'     => array(),
-                        )
-                    ); ?>
+					? esc_html__(
+						'Unfortunately, we were unable to capture the error message for this message.',
+						'event_espresso'
+					)
+					: wp_kses(
+						$error_msg,
+						array(
+							'a'      => array(
+								'href'  => array(),
+								'title' => array(),
+							),
+							'span'   => array(),
+							'div'    => array(),
+							'p'      => array(),
+							'strong' => array(),
+							'em'     => array(),
+							'br'     => array(),
+						)
+					); ?>
                 </body>
                 </html>
                 <?php
-                exit;
-            }
-        }
-        return;
-    }
-
-
-    /**
-     *  This runs when the msg_url_trigger route has initiated.
-     *
-     * @since 4.5.0
-     * @param WP $WP
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function run($WP)
-    {
-        // ensure controller is loaded
-        self::_load_controller();
-        // attempt to process message
-        try {
-            /** @type EE_Message_To_Generate_From_Request $message_to_generate */
-            $message_to_generate = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
-            self::$_MSG_PROCESSOR->generate_and_send_now($message_to_generate);
-        } catch (EE_Error $e) {
-            $error_msg = __(
-                'Please note that a system message failed to send due to a technical issue.',
-                'event_espresso'
-            );
-            // add specific message for developers if WP_DEBUG in on
-            $error_msg .= '||' . $e->getMessage();
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-    /**
-     * This is triggered by the 'msg_cron_trigger' route.
-     *
-     * @param WP $WP
-     */
-    public function execute_batch_request($WP)
-    {
-        $this->run_cron();
-        header('HTTP/1.1 200 OK');
-        exit();
-    }
-
-
-    /**
-     * This gets executed on wp_cron jobs or when a batch request is initiated on its own separate non regular wp
-     * request.
-     */
-    public function run_cron()
-    {
-        self::_load_controller();
-        // get required vars
-        $cron_type = EE_Registry::instance()->REQ->get('type');
-        $transient_key = EE_Registry::instance()->REQ->get('key');
-
-        // now let's verify transient, if not valid exit immediately
-        if (! get_transient($transient_key)) {
-            /**
-             * trigger error so this gets in the error logs.  This is important because it happens on a non-user
-             * request.
-             */
-            trigger_error(esc_attr__('Invalid Request (Transient does not exist)', 'event_espresso'));
-        }
-
-        // if made it here, lets' delete the transient to keep the db clean
-        delete_transient($transient_key);
-
-        if (apply_filters('FHEE__EED_Messages__run_cron__use_wp_cron', true)) {
-            $method = 'batch_' . $cron_type . '_from_queue';
-            if (method_exists(self::$_MSG_PROCESSOR, $method)) {
-                self::$_MSG_PROCESSOR->$method();
-            } else {
-                // no matching task
-                /**
-                 * trigger error so this gets in the error logs.  This is important because it happens on a non user
-                 * request.
-                 */
-                trigger_error(
-                    esc_attr(
-                        sprintf(
-                            __('There is no task corresponding to this route %s', 'event_espresso'),
-                            $cron_type
-                        )
-                    )
-                );
-            }
-        }
-
-        do_action('FHEE__EED_Messages__run_cron__end');
-    }
-
-
-    /**
-     * This is used to retrieve the template pack for the given name.
-     * Retrieved packs are cached on the static $_TMP_PACKS array.  If there is no class matching the given name then
-     * the default template pack is returned.
-     *
-     * @deprecated 4.9.0  @see EEH_MSG_Template::get_template_pack()
-     * @param string $template_pack_name This should correspond to the dbref of the template pack (which is also used
-     *                                   in generating the Pack class name).
-     * @return EE_Messages_Template_Pack
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_template_pack($template_pack_name)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::get_template_pack($template_pack_name);
-    }
-
-
-    /**
-     * Retrieves an array of all template packs.
-     * Array is in the format array( 'dbref' => EE_Messages_Template_Pack )
-     *
-     * @deprecated 4.9.0  @see EEH_MSG_Template_Pack::get_template_pack_collection
-     * @return EE_Messages_Template_Pack[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_template_packs()
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-
-        // for backward compat, let's make sure this returns in the same format as originally.
-        $template_pack_collection = EEH_MSG_Template::get_template_pack_collection();
-        $template_pack_collection->rewind();
-        $template_packs = array();
-        while ($template_pack_collection->valid()) {
-            $template_packs[ $template_pack_collection->current()->dbref ] = $template_pack_collection->current();
-            $template_pack_collection->next();
-        }
-        return $template_packs;
-    }
-
-
-    /**
-     * This simply makes sure the autoloaders are registered for the EE_messages system.
-     *
-     * @since 4.5.0
-     * @return void
-     * @throws EE_Error
-     */
-    public static function set_autoloaders()
-    {
-        if (empty(self::$_MSG_PATHS)) {
-            self::_set_messages_paths();
-            foreach (self::$_MSG_PATHS as $path) {
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($path);
-            }
-            // add aliases
-            EEH_Autoloader::add_alias('EE_messages', 'EE_messages');
-            EEH_Autoloader::add_alias('EE_messenger', 'EE_messenger');
-        }
-    }
-
-
-    /**
-     * Take care of adding all the paths for the messages components to the $_MSG_PATHS property
-     * for use by the Messages Autoloaders
-     *
-     * @since 4.5.0
-     * @return void.
-     */
-    protected static function _set_messages_paths()
-    {
-        self::$_MSG_PATHS = apply_filters(
-            'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-            [
-                EE_LIBRARIES . 'messages/message_type',
-                EE_LIBRARIES . 'messages/messenger',
-                EE_LIBRARIES . 'messages/defaults',
-                EE_LIBRARIES . 'messages/defaults/email',
-                EE_LIBRARIES . 'messages/data_class',
-                EE_LIBRARIES . 'messages/validators',
-                EE_LIBRARIES . 'messages/validators/email',
-                EE_LIBRARIES . 'messages/validators/html',
-                EE_LIBRARIES . 'shortcodes',
-            ]
-        );
-    }
-
-
-    /**
-     * Takes care of loading dependencies
-     *
-     * @since 4.5.0
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _load_controller()
-    {
-        if (! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
-            EE_Registry::instance()->load_core('Request_Handler');
-            self::set_autoloaders();
-            self::$_EEMSG = EE_Registry::instance()->load_lib('messages');
-            self::$_MSG_PROCESSOR = EE_Registry::instance()->load_lib('Messages_Processor');
-            self::$_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        }
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function payment_reminder(EE_Transaction $transaction)
-    {
-        self::_load_controller();
-        $data = array($transaction, null);
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers('payment_reminder', $data);
-    }
-
-
-    /**
-     * Any messages triggers for after successful gateway payments should go in here.
-     *
-     * @param EE_Transaction  $transaction object
-     * @param EE_Payment|null $payment     object
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function payment(EE_Transaction $transaction, EE_Payment $payment = null)
-    {
-        // if there's no payment object, then we cannot do a payment type message!
-        if (! $payment instanceof EE_Payment) {
-            return;
-        }
-        self::_load_controller();
-        $data = array($transaction, $payment);
-        EE_Registry::instance()->load_helper('MSG_Template');
-        $message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
-        // if payment amount is less than 0 then switch to payment_refund message type.
-        $message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function cancelled_registration(EE_Transaction $transaction)
-    {
-        self::_load_controller();
-        $data = array($transaction, null);
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers('cancelled_registration', $data);
-    }
-
-
-    /**
-     * Trigger for Registration messages
-     * Note that what registration message type is sent depends on what the reg status is for the registrations on the
-     * incoming transaction.
-     *
-     * @param EE_Registration $registration
-     * @param array           $extra_details
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     */
-    public static function maybe_registration(EE_Registration $registration, $extra_details = array())
-    {
-
-        if (! self::_verify_registration_notification_send($registration, $extra_details)) {
-            // no messages please
-            return;
-        }
-
-        // get all non-trashed registrations so we make sure we send messages for the right status.
-        $all_registrations = $registration->transaction()->registrations(
-            array(
-                array('REG_deleted' => false),
-                'order_by' => array(
-                    'Event.EVT_name'     => 'ASC',
-                    'Attendee.ATT_lname' => 'ASC',
-                    'Attendee.ATT_fname' => 'ASC',
-                ),
-            )
-        );
-        // cached array of statuses so we only trigger messages once per status.
-        $statuses_sent = array();
-        self::_load_controller();
-        $mtgs = array();
-
-        // loop through registrations and trigger messages once per status.
-        foreach ($all_registrations as $reg) {
-            // already triggered?
-            if (in_array($reg->status_ID(), $statuses_sent)) {
-                continue;
-            }
-
-            $message_type = EEH_MSG_Template::convert_reg_status_to_message_type($reg->status_ID());
-            $mtgs = array_merge(
-                $mtgs,
-                self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
-                    $message_type,
-                    array($registration->transaction(), null, $reg->status_ID())
-                )
-            );
-            $statuses_sent[] = $reg->status_ID();
-        }
-
-        if (count($statuses_sent) > 1) {
-            $mtgs = array_merge(
-                $mtgs,
-                self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
-                    'registration_summary',
-                    array($registration->transaction(), null)
-                )
-            );
-        }
-
-        // batch queue and initiate request
-        self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($mtgs);
-        self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
-    }
-
-
-    /**
-     * This is a helper method used to very whether a registration notification should be sent or
-     * not.  Prevents duplicate notifications going out for registration context notifications.
-     *
-     * @param EE_Registration $registration  [description]
-     * @param array           $extra_details [description]
-     * @return bool          true = send away, false = nope halt the presses.
-     */
-    protected static function _verify_registration_notification_send(
-        EE_Registration $registration,
-        $extra_details = array()
-    ) {
-        if (! $registration->is_primary_registrant()) {
-            return false;
-        }
-        // first we check if we're in admin and not doing front ajax
-        if (is_admin() && ! EE_FRONT_AJAX) {
-            // make sure appropriate admin params are set for sending messages
-            if (
-                empty($_REQUEST['txn_reg_status_change']['send_notifications'])
-                || ! absint($_REQUEST['txn_reg_status_change']['send_notifications'])
-            ) {
-                // no messages sent please.
-                return false;
-            }
-        } else {
-            // frontend request (either regular or via AJAX)
-            // TXN is NOT finalized ?
-            if (! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
-                return false;
-            }
-            // return visit but nothing changed ???
-            if (
-                isset($extra_details['revisit'], $extra_details['status_updates']) &&
-                $extra_details['revisit'] && ! $extra_details['status_updates']
-            ) {
-                return false;
-            }
-            // NOT sending messages && reg status is something other than "Not-Approved"
-            if (
-                ! apply_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications', false) &&
-                $registration->status_ID() !== EEM_Registration::status_id_not_approved
-            ) {
-                return false;
-            }
-        }
-        // release the kraken
-        return true;
-    }
-
-
-    /**
-     * Simply returns an array indexed by Registration Status ID and the related message_type name associated with that
-     * status id.
-     *
-     * @deprecated 4.9.0  Use EEH_MSG_Template::reg_status_to_message_type_array()
-     *                    or EEH_MSG_Template::convert_reg_status_to_message_type
-     * @param string $reg_status
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _get_reg_status_array($reg_status = '')
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
-            ? EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
-            : EEH_MSG_Template::reg_status_to_message_type_array();
-    }
-
-
-    /**
-     * Simply returns the payment message type for the given payment status.
-     *
-     * @deprecated 4.9.0 Use EEH_MSG_Template::payment_status_to_message_type_array
-     *                   or EEH_MSG_Template::convert_payment_status_to_message_type
-     * @param string $payment_status The payment status being matched.
-     * @return bool|string The payment message type slug matching the status or false if no match.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _get_payment_message_type($payment_status)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
-            ? EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
-            : false;
-    }
-
-
-    /**
-     * Message triggers for a resending already sent message(s) (via EE_Message list table)
-     *
-     * @access public
-     * @param array $req_data This is the $_POST & $_GET data sent from EE_Admin Pages
-     * @return bool success/fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function process_resend($req_data)
-    {
-        self::_load_controller();
-
-        // if $msgID in this request then skip to the new resend_message
-        if (EE_Registry::instance()->REQ->get('MSG_ID')) {
-            return self::resend_message();
-        }
-
-        // make sure any incoming request data is set on the REQ so that it gets picked up later.
-        $req_data = (array) $req_data;
-        foreach ($req_data as $request_key => $request_value) {
-            EE_Registry::instance()->REQ->set($request_key, $request_value);
-        }
-
-        if (
-            ! $messages_to_send = self::$_MSG_PROCESSOR->setup_messages_to_generate_from_registration_ids_in_request(
-            )
-        ) {
-            return false;
-        }
-
-        try {
-            self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($messages_to_send);
-            self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
-        } catch (EE_Error $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Error::add_success(
-            __('Messages have been successfully queued for generation and sending.', 'event_espresso')
-        );
-        return true; // everything got queued.
-    }
-
-
-    /**
-     * Message triggers for a resending already sent message(s) (via EE_Message list table)
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function resend_message()
-    {
-        self::_load_controller();
-
-        $msgID = EE_Registry::instance()->REQ->get('MSG_ID');
-        if (! $msgID) {
-            EE_Error::add_error(
-                __(
-                    'Something went wrong because there is no "MSG_ID" value in the request',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-
-        self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send((array) $msgID);
-
-        // setup success message.
-        $count_ready_for_resend = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
-        EE_Error::add_success(
-            sprintf(
-                _n(
-                    'There was %d message queued for resending.',
-                    'There were %d messages queued for resending.',
-                    $count_ready_for_resend,
-                    'event_espresso'
-                ),
-                $count_ready_for_resend
-            )
-        );
-        return true;
-    }
-
-
-    /**
-     * Message triggers for manual payment applied by admin
-     *
-     * @param  EE_Payment $payment EE_payment object
-     * @return bool success/fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function process_admin_payment(EE_Payment $payment)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        // we need to get the transaction object
-        $transaction = $payment->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            $data = array($transaction, $payment);
-            $message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
-
-            // if payment amount is less than 0 then switch to payment_refund message type.
-            $message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
-
-            // if payment_refund is selected, but the status is NOT accepted.  Then change message type to false so NO message notification goes out.
-            $message_type = $message_type == 'payment_refund' && $payment->STS_ID() != EEM_Payment::status_id_approved
-                ? false : $message_type;
-
-            self::_load_controller();
-
-            self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
-
-            // get count of queued for generation
-            $count_to_generate = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(
-                array(
-                    EEM_Message::status_incomplete,
-                    EEM_Message::status_idle,
-                )
-            );
-
-            if ($count_to_generate > 0 && self::$_MSG_PROCESSOR->get_queue()->get_message_repository()->count() !== 0) {
-                add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
-                return true;
-            } else {
-                $count_failed = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(
-                    EEM_Message::instance()->stati_indicating_failed_sending()
-                );
-                /**
-                 * Verify that there are actually errors.  If not then we return a success message because the queue might have been emptied due to successful
-                 * IMMEDIATE generation.
-                 */
-                if ($count_failed > 0) {
-                    EE_Error::add_error(
-                        sprintf(
-                            _n(
-                                'The payment notification generation failed.',
-                                '%d payment notifications failed being sent.',
-                                $count_failed,
-                                'event_espresso'
-                            ),
-                            $count_failed
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-
-                    return false;
-                } else {
-                    add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
-                    return true;
-                }
-            }
-        } else {
-            EE_Error::add_error(
-                'Unable to generate the payment notification because the given value for the transaction is invalid.',
-                'event_espresso'
-            );
-            return false;
-        }
-    }
-
-
-    /**
-     * Callback for AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send_with_registrations trigger
-     *
-     * @since   4.3.0
-     * @param  EE_Registration[] $registrations an array of EE_Registration objects
-     * @param  int               $grp_id        a specific message template group id.
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function send_newsletter_message($registrations, $grp_id)
-    {
-        // make sure mtp is id and set it in the EE_Request Handler later messages setup.
-        EE_Registry::instance()->REQ->set('GRP_ID', (int) $grp_id);
-        self::_load_controller();
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers('newsletter', $registrations);
-    }
-
-
-    /**
-     * Callback for FHEE__EE_Registration__invoice_url__invoice_url or FHEE__EE_Registration__receipt_url__receipt_url
-     *
-     * @since   4.3.0
-     * @param    string          $registration_message_trigger_url
-     * @param    EE_Registration $registration
-     * @param string             $messenger
-     * @param string             $message_type
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function registration_message_trigger_url(
-        $registration_message_trigger_url,
-        EE_Registration $registration,
-        $messenger = 'html',
-        $message_type = 'invoice'
-    ) {
-        // whitelist $messenger
-        switch ($messenger) {
-            case 'pdf':
-                $sending_messenger = 'pdf';
-                $generating_messenger = 'html';
-                break;
-            case 'html':
-            default:
-                $sending_messenger = 'html';
-                $generating_messenger = 'html';
-                break;
-        }
-        // whitelist $message_type
-        switch ($message_type) {
-            case 'receipt':
-                $message_type = 'receipt';
-                break;
-            case 'invoice':
-            default:
-                $message_type = 'invoice';
-                break;
-        }
-        // verify that both the messenger AND the message type are active
-        if (
-            EEH_MSG_Template::is_messenger_active($sending_messenger)
-            && EEH_MSG_Template::is_mt_active($message_type)
-        ) {
-            // need to get the correct message template group for this (i.e. is there a custom invoice for the event this registration is registered for?)
-            $template_query_params = array(
-                'MTP_is_active'    => true,
-                'MTP_messenger'    => $generating_messenger,
-                'MTP_message_type' => $message_type,
-                'Event.EVT_ID'     => $registration->event_ID(),
-            );
-            // get the message template group.
-            $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
-            // if we don't have an EE_Message_Template_Group then return
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
-                // remove EVT_ID from query params so that global templates get picked up
-                unset($template_query_params['Event.EVT_ID']);
-                // get global template as the fallback
-                $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
-            }
-            // if we don't have an EE_Message_Template_Group then return
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
-                return '';
-            }
-            // generate the URL
-            $registration_message_trigger_url = EEH_MSG_Template::generate_url_trigger(
-                $sending_messenger,
-                $generating_messenger,
-                'purchaser',
-                $message_type,
-                $registration,
-                $msg_template_group->ID(),
-                $registration->transaction_ID()
-            );
-        }
-        return $registration_message_trigger_url;
-    }
-
-
-    /**
-     * Use to generate and return a message preview!
-     *
-     * @param  string $type      This should correspond with a valid message type
-     * @param  string $context   This should correspond with a valid context for the message type
-     * @param  string $messenger This should correspond with a valid messenger.
-     * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
-     *                           preview
-     * @return bool|string The body of the message or if send is requested, sends.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function preview_message($type, $context, $messenger, $send = false)
-    {
-        self::_load_controller();
-        $mtg = new EE_Message_To_Generate(
-            $messenger,
-            $type,
-            array(),
-            $context,
-            true
-        );
-        $generated_preview_queue = self::$_MSG_PROCESSOR->generate_for_preview($mtg, $send);
-        if ($generated_preview_queue instanceof EE_Messages_Queue) {
-            // loop through all content for the preview and remove any persisted records.
-            $content = '';
-            foreach ($generated_preview_queue->get_message_repository() as $message) {
-                $content = $message->content();
-                if ($message->ID() > 0 && $message->STS_ID() !== EEM_Message::status_failed) {
-                    $message->delete();
-                }
-            }
-            return $content;
-        } else {
-            return $generated_preview_queue;
-        }
-    }
-
-
-    /**
-     * This is a method that allows for sending a message using a messenger matching the string given and the provided
-     * EE_Message_Queue object.  The EE_Message_Queue object is used to create a single aggregate EE_Message via the
-     * content found in the EE_Message objects in the queue.
-     *
-     * @since 4.9.0
-     * @param string            $messenger            a string matching a valid active messenger in the system
-     * @param string            $message_type         Although it seems contrary to the name of the method, a message
-     *                                                type name is still required to send along the message type to the
-     *                                                messenger because this is used for determining what specific
-     *                                                variations might be loaded for the generated message.
-     * @param EE_Messages_Queue $queue
-     * @param string            $custom_subject       Can be used to set what the custom subject string will be on the
-     *                                                aggregate EE_Message object.
-     * @return bool success or fail.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function send_message_with_messenger_only(
-        $messenger,
-        $message_type,
-        EE_Messages_Queue $queue,
-        $custom_subject = ''
-    ) {
-        self::_load_controller();
-        /** @type EE_Message_To_Generate_From_Queue $message_to_generate */
-        $message_to_generate = EE_Registry::instance()->load_lib(
-            'Message_To_Generate_From_Queue',
-            array(
-                $messenger,
-                $message_type,
-                $queue,
-                $custom_subject,
-            )
-        );
-        return self::$_MSG_PROCESSOR->queue_for_sending($message_to_generate);
-    }
-
-
-    /**
-     * Generates Messages immediately for EE_Message IDs (but only for the correct status for generation)
-     *
-     * @since 4.9.0
-     * @param array $message_ids An array of message ids
-     * @return bool|EE_Messages_Queue false if nothing was generated, EE_Messages_Queue containing generated
-     *                           messages.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function generate_now($message_ids)
-    {
-        self::_load_controller();
-        $messages = EEM_Message::instance()->get_all(
-            array(
-                0 => array(
-                    'MSG_ID' => array('IN', $message_ids),
-                    'STS_ID' => EEM_Message::status_incomplete,
-                ),
-            )
-        );
-        $generated_queue = false;
-        if ($messages) {
-            $generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue($messages);
-        }
-
-        if (! $generated_queue instanceof EE_Messages_Queue) {
-            EE_Error::add_error(
-                __(
-                    'The messages were not generated. This could mean there is already a batch being generated on a separate request, or because the selected messages are not ready for generation. Please wait a minute or two and try again.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $generated_queue;
-    }
-
-
-    /**
-     * Sends messages immediately for the incoming message_ids that have the status of EEM_Message::status_resend or,
-     * EEM_Message::status_idle
-     *
-     * @since 4.9.0
-     * @param $message_ids
-     * @return bool|EE_Messages_Queue false if no messages sent.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function send_now($message_ids)
-    {
-        self::_load_controller();
-        $messages = EEM_Message::instance()->get_all(
-            array(
-                0 => array(
-                    'MSG_ID' => array('IN', $message_ids),
-                    'STS_ID' => array(
-                        'IN',
-                        array(EEM_Message::status_idle, EEM_Message::status_resend, EEM_Message::status_retry),
-                    ),
-                ),
-            )
-        );
-        $sent_queue = false;
-        if ($messages) {
-            $sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue($messages);
-        }
-
-        if (! $sent_queue instanceof EE_Messages_Queue) {
-            EE_Error::add_error(
-                __(
-                    'The messages were not sent. This could mean there is already a batch being sent on a separate request, or because the selected messages are not sendable. Please wait a minute or two and try again.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            // can count how many sent by using the messages in the queue
-            $sent_count = $sent_queue->count_STS_in_queue(EEM_Message::instance()->stati_indicating_sent());
-            if ($sent_count > 0) {
-                EE_Error::add_success(
-                    sprintf(
-                        _n(
-                            'There was %d message successfully sent.',
-                            'There were %d messages successfully sent.',
-                            $sent_count,
-                            'event_espresso'
-                        ),
-                        $sent_count
-                    )
-                );
-            } else {
-                EE_Error::overwrite_errors();
-                EE_Error::add_error(
-                    __(
-                        'No message was sent because of problems with sending. Either all the messages you selected were not a sendable message, they were ALREADY sent on a different scheduled task, or there was an error.
+				exit;
+			}
+		}
+		return;
+	}
+
+
+	/**
+	 *  This runs when the msg_url_trigger route has initiated.
+	 *
+	 * @since 4.5.0
+	 * @param WP $WP
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function run($WP)
+	{
+		// ensure controller is loaded
+		self::_load_controller();
+		// attempt to process message
+		try {
+			/** @type EE_Message_To_Generate_From_Request $message_to_generate */
+			$message_to_generate = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
+			self::$_MSG_PROCESSOR->generate_and_send_now($message_to_generate);
+		} catch (EE_Error $e) {
+			$error_msg = __(
+				'Please note that a system message failed to send due to a technical issue.',
+				'event_espresso'
+			);
+			// add specific message for developers if WP_DEBUG in on
+			$error_msg .= '||' . $e->getMessage();
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+	/**
+	 * This is triggered by the 'msg_cron_trigger' route.
+	 *
+	 * @param WP $WP
+	 */
+	public function execute_batch_request($WP)
+	{
+		$this->run_cron();
+		header('HTTP/1.1 200 OK');
+		exit();
+	}
+
+
+	/**
+	 * This gets executed on wp_cron jobs or when a batch request is initiated on its own separate non regular wp
+	 * request.
+	 */
+	public function run_cron()
+	{
+		self::_load_controller();
+		// get required vars
+		$cron_type = EE_Registry::instance()->REQ->get('type');
+		$transient_key = EE_Registry::instance()->REQ->get('key');
+
+		// now let's verify transient, if not valid exit immediately
+		if (! get_transient($transient_key)) {
+			/**
+			 * trigger error so this gets in the error logs.  This is important because it happens on a non-user
+			 * request.
+			 */
+			trigger_error(esc_attr__('Invalid Request (Transient does not exist)', 'event_espresso'));
+		}
+
+		// if made it here, lets' delete the transient to keep the db clean
+		delete_transient($transient_key);
+
+		if (apply_filters('FHEE__EED_Messages__run_cron__use_wp_cron', true)) {
+			$method = 'batch_' . $cron_type . '_from_queue';
+			if (method_exists(self::$_MSG_PROCESSOR, $method)) {
+				self::$_MSG_PROCESSOR->$method();
+			} else {
+				// no matching task
+				/**
+				 * trigger error so this gets in the error logs.  This is important because it happens on a non user
+				 * request.
+				 */
+				trigger_error(
+					esc_attr(
+						sprintf(
+							__('There is no task corresponding to this route %s', 'event_espresso'),
+							$cron_type
+						)
+					)
+				);
+			}
+		}
+
+		do_action('FHEE__EED_Messages__run_cron__end');
+	}
+
+
+	/**
+	 * This is used to retrieve the template pack for the given name.
+	 * Retrieved packs are cached on the static $_TMP_PACKS array.  If there is no class matching the given name then
+	 * the default template pack is returned.
+	 *
+	 * @deprecated 4.9.0  @see EEH_MSG_Template::get_template_pack()
+	 * @param string $template_pack_name This should correspond to the dbref of the template pack (which is also used
+	 *                                   in generating the Pack class name).
+	 * @return EE_Messages_Template_Pack
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_template_pack($template_pack_name)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_template_pack($template_pack_name);
+	}
+
+
+	/**
+	 * Retrieves an array of all template packs.
+	 * Array is in the format array( 'dbref' => EE_Messages_Template_Pack )
+	 *
+	 * @deprecated 4.9.0  @see EEH_MSG_Template_Pack::get_template_pack_collection
+	 * @return EE_Messages_Template_Pack[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_template_packs()
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+
+		// for backward compat, let's make sure this returns in the same format as originally.
+		$template_pack_collection = EEH_MSG_Template::get_template_pack_collection();
+		$template_pack_collection->rewind();
+		$template_packs = array();
+		while ($template_pack_collection->valid()) {
+			$template_packs[ $template_pack_collection->current()->dbref ] = $template_pack_collection->current();
+			$template_pack_collection->next();
+		}
+		return $template_packs;
+	}
+
+
+	/**
+	 * This simply makes sure the autoloaders are registered for the EE_messages system.
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function set_autoloaders()
+	{
+		if (empty(self::$_MSG_PATHS)) {
+			self::_set_messages_paths();
+			foreach (self::$_MSG_PATHS as $path) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($path);
+			}
+			// add aliases
+			EEH_Autoloader::add_alias('EE_messages', 'EE_messages');
+			EEH_Autoloader::add_alias('EE_messenger', 'EE_messenger');
+		}
+	}
+
+
+	/**
+	 * Take care of adding all the paths for the messages components to the $_MSG_PATHS property
+	 * for use by the Messages Autoloaders
+	 *
+	 * @since 4.5.0
+	 * @return void.
+	 */
+	protected static function _set_messages_paths()
+	{
+		self::$_MSG_PATHS = apply_filters(
+			'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+			[
+				EE_LIBRARIES . 'messages/message_type',
+				EE_LIBRARIES . 'messages/messenger',
+				EE_LIBRARIES . 'messages/defaults',
+				EE_LIBRARIES . 'messages/defaults/email',
+				EE_LIBRARIES . 'messages/data_class',
+				EE_LIBRARIES . 'messages/validators',
+				EE_LIBRARIES . 'messages/validators/email',
+				EE_LIBRARIES . 'messages/validators/html',
+				EE_LIBRARIES . 'shortcodes',
+			]
+		);
+	}
+
+
+	/**
+	 * Takes care of loading dependencies
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _load_controller()
+	{
+		if (! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
+			EE_Registry::instance()->load_core('Request_Handler');
+			self::set_autoloaders();
+			self::$_EEMSG = EE_Registry::instance()->load_lib('messages');
+			self::$_MSG_PROCESSOR = EE_Registry::instance()->load_lib('Messages_Processor');
+			self::$_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		}
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function payment_reminder(EE_Transaction $transaction)
+	{
+		self::_load_controller();
+		$data = array($transaction, null);
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('payment_reminder', $data);
+	}
+
+
+	/**
+	 * Any messages triggers for after successful gateway payments should go in here.
+	 *
+	 * @param EE_Transaction  $transaction object
+	 * @param EE_Payment|null $payment     object
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function payment(EE_Transaction $transaction, EE_Payment $payment = null)
+	{
+		// if there's no payment object, then we cannot do a payment type message!
+		if (! $payment instanceof EE_Payment) {
+			return;
+		}
+		self::_load_controller();
+		$data = array($transaction, $payment);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
+		// if payment amount is less than 0 then switch to payment_refund message type.
+		$message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function cancelled_registration(EE_Transaction $transaction)
+	{
+		self::_load_controller();
+		$data = array($transaction, null);
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('cancelled_registration', $data);
+	}
+
+
+	/**
+	 * Trigger for Registration messages
+	 * Note that what registration message type is sent depends on what the reg status is for the registrations on the
+	 * incoming transaction.
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $extra_details
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 */
+	public static function maybe_registration(EE_Registration $registration, $extra_details = array())
+	{
+
+		if (! self::_verify_registration_notification_send($registration, $extra_details)) {
+			// no messages please
+			return;
+		}
+
+		// get all non-trashed registrations so we make sure we send messages for the right status.
+		$all_registrations = $registration->transaction()->registrations(
+			array(
+				array('REG_deleted' => false),
+				'order_by' => array(
+					'Event.EVT_name'     => 'ASC',
+					'Attendee.ATT_lname' => 'ASC',
+					'Attendee.ATT_fname' => 'ASC',
+				),
+			)
+		);
+		// cached array of statuses so we only trigger messages once per status.
+		$statuses_sent = array();
+		self::_load_controller();
+		$mtgs = array();
+
+		// loop through registrations and trigger messages once per status.
+		foreach ($all_registrations as $reg) {
+			// already triggered?
+			if (in_array($reg->status_ID(), $statuses_sent)) {
+				continue;
+			}
+
+			$message_type = EEH_MSG_Template::convert_reg_status_to_message_type($reg->status_ID());
+			$mtgs = array_merge(
+				$mtgs,
+				self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
+					$message_type,
+					array($registration->transaction(), null, $reg->status_ID())
+				)
+			);
+			$statuses_sent[] = $reg->status_ID();
+		}
+
+		if (count($statuses_sent) > 1) {
+			$mtgs = array_merge(
+				$mtgs,
+				self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
+					'registration_summary',
+					array($registration->transaction(), null)
+				)
+			);
+		}
+
+		// batch queue and initiate request
+		self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($mtgs);
+		self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
+	}
+
+
+	/**
+	 * This is a helper method used to very whether a registration notification should be sent or
+	 * not.  Prevents duplicate notifications going out for registration context notifications.
+	 *
+	 * @param EE_Registration $registration  [description]
+	 * @param array           $extra_details [description]
+	 * @return bool          true = send away, false = nope halt the presses.
+	 */
+	protected static function _verify_registration_notification_send(
+		EE_Registration $registration,
+		$extra_details = array()
+	) {
+		if (! $registration->is_primary_registrant()) {
+			return false;
+		}
+		// first we check if we're in admin and not doing front ajax
+		if (is_admin() && ! EE_FRONT_AJAX) {
+			// make sure appropriate admin params are set for sending messages
+			if (
+				empty($_REQUEST['txn_reg_status_change']['send_notifications'])
+				|| ! absint($_REQUEST['txn_reg_status_change']['send_notifications'])
+			) {
+				// no messages sent please.
+				return false;
+			}
+		} else {
+			// frontend request (either regular or via AJAX)
+			// TXN is NOT finalized ?
+			if (! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
+				return false;
+			}
+			// return visit but nothing changed ???
+			if (
+				isset($extra_details['revisit'], $extra_details['status_updates']) &&
+				$extra_details['revisit'] && ! $extra_details['status_updates']
+			) {
+				return false;
+			}
+			// NOT sending messages && reg status is something other than "Not-Approved"
+			if (
+				! apply_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications', false) &&
+				$registration->status_ID() !== EEM_Registration::status_id_not_approved
+			) {
+				return false;
+			}
+		}
+		// release the kraken
+		return true;
+	}
+
+
+	/**
+	 * Simply returns an array indexed by Registration Status ID and the related message_type name associated with that
+	 * status id.
+	 *
+	 * @deprecated 4.9.0  Use EEH_MSG_Template::reg_status_to_message_type_array()
+	 *                    or EEH_MSG_Template::convert_reg_status_to_message_type
+	 * @param string $reg_status
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _get_reg_status_array($reg_status = '')
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
+			? EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
+			: EEH_MSG_Template::reg_status_to_message_type_array();
+	}
+
+
+	/**
+	 * Simply returns the payment message type for the given payment status.
+	 *
+	 * @deprecated 4.9.0 Use EEH_MSG_Template::payment_status_to_message_type_array
+	 *                   or EEH_MSG_Template::convert_payment_status_to_message_type
+	 * @param string $payment_status The payment status being matched.
+	 * @return bool|string The payment message type slug matching the status or false if no match.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _get_payment_message_type($payment_status)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
+			? EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
+			: false;
+	}
+
+
+	/**
+	 * Message triggers for a resending already sent message(s) (via EE_Message list table)
+	 *
+	 * @access public
+	 * @param array $req_data This is the $_POST & $_GET data sent from EE_Admin Pages
+	 * @return bool success/fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function process_resend($req_data)
+	{
+		self::_load_controller();
+
+		// if $msgID in this request then skip to the new resend_message
+		if (EE_Registry::instance()->REQ->get('MSG_ID')) {
+			return self::resend_message();
+		}
+
+		// make sure any incoming request data is set on the REQ so that it gets picked up later.
+		$req_data = (array) $req_data;
+		foreach ($req_data as $request_key => $request_value) {
+			EE_Registry::instance()->REQ->set($request_key, $request_value);
+		}
+
+		if (
+			! $messages_to_send = self::$_MSG_PROCESSOR->setup_messages_to_generate_from_registration_ids_in_request(
+			)
+		) {
+			return false;
+		}
+
+		try {
+			self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($messages_to_send);
+			self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
+		} catch (EE_Error $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Error::add_success(
+			__('Messages have been successfully queued for generation and sending.', 'event_espresso')
+		);
+		return true; // everything got queued.
+	}
+
+
+	/**
+	 * Message triggers for a resending already sent message(s) (via EE_Message list table)
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function resend_message()
+	{
+		self::_load_controller();
+
+		$msgID = EE_Registry::instance()->REQ->get('MSG_ID');
+		if (! $msgID) {
+			EE_Error::add_error(
+				__(
+					'Something went wrong because there is no "MSG_ID" value in the request',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+
+		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send((array) $msgID);
+
+		// setup success message.
+		$count_ready_for_resend = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
+		EE_Error::add_success(
+			sprintf(
+				_n(
+					'There was %d message queued for resending.',
+					'There were %d messages queued for resending.',
+					$count_ready_for_resend,
+					'event_espresso'
+				),
+				$count_ready_for_resend
+			)
+		);
+		return true;
+	}
+
+
+	/**
+	 * Message triggers for manual payment applied by admin
+	 *
+	 * @param  EE_Payment $payment EE_payment object
+	 * @return bool success/fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function process_admin_payment(EE_Payment $payment)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		// we need to get the transaction object
+		$transaction = $payment->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			$data = array($transaction, $payment);
+			$message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
+
+			// if payment amount is less than 0 then switch to payment_refund message type.
+			$message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
+
+			// if payment_refund is selected, but the status is NOT accepted.  Then change message type to false so NO message notification goes out.
+			$message_type = $message_type == 'payment_refund' && $payment->STS_ID() != EEM_Payment::status_id_approved
+				? false : $message_type;
+
+			self::_load_controller();
+
+			self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
+
+			// get count of queued for generation
+			$count_to_generate = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(
+				array(
+					EEM_Message::status_incomplete,
+					EEM_Message::status_idle,
+				)
+			);
+
+			if ($count_to_generate > 0 && self::$_MSG_PROCESSOR->get_queue()->get_message_repository()->count() !== 0) {
+				add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
+				return true;
+			} else {
+				$count_failed = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(
+					EEM_Message::instance()->stati_indicating_failed_sending()
+				);
+				/**
+				 * Verify that there are actually errors.  If not then we return a success message because the queue might have been emptied due to successful
+				 * IMMEDIATE generation.
+				 */
+				if ($count_failed > 0) {
+					EE_Error::add_error(
+						sprintf(
+							_n(
+								'The payment notification generation failed.',
+								'%d payment notifications failed being sent.',
+								$count_failed,
+								'event_espresso'
+							),
+							$count_failed
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+
+					return false;
+				} else {
+					add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
+					return true;
+				}
+			}
+		} else {
+			EE_Error::add_error(
+				'Unable to generate the payment notification because the given value for the transaction is invalid.',
+				'event_espresso'
+			);
+			return false;
+		}
+	}
+
+
+	/**
+	 * Callback for AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send_with_registrations trigger
+	 *
+	 * @since   4.3.0
+	 * @param  EE_Registration[] $registrations an array of EE_Registration objects
+	 * @param  int               $grp_id        a specific message template group id.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function send_newsletter_message($registrations, $grp_id)
+	{
+		// make sure mtp is id and set it in the EE_Request Handler later messages setup.
+		EE_Registry::instance()->REQ->set('GRP_ID', (int) $grp_id);
+		self::_load_controller();
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('newsletter', $registrations);
+	}
+
+
+	/**
+	 * Callback for FHEE__EE_Registration__invoice_url__invoice_url or FHEE__EE_Registration__receipt_url__receipt_url
+	 *
+	 * @since   4.3.0
+	 * @param    string          $registration_message_trigger_url
+	 * @param    EE_Registration $registration
+	 * @param string             $messenger
+	 * @param string             $message_type
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function registration_message_trigger_url(
+		$registration_message_trigger_url,
+		EE_Registration $registration,
+		$messenger = 'html',
+		$message_type = 'invoice'
+	) {
+		// whitelist $messenger
+		switch ($messenger) {
+			case 'pdf':
+				$sending_messenger = 'pdf';
+				$generating_messenger = 'html';
+				break;
+			case 'html':
+			default:
+				$sending_messenger = 'html';
+				$generating_messenger = 'html';
+				break;
+		}
+		// whitelist $message_type
+		switch ($message_type) {
+			case 'receipt':
+				$message_type = 'receipt';
+				break;
+			case 'invoice':
+			default:
+				$message_type = 'invoice';
+				break;
+		}
+		// verify that both the messenger AND the message type are active
+		if (
+			EEH_MSG_Template::is_messenger_active($sending_messenger)
+			&& EEH_MSG_Template::is_mt_active($message_type)
+		) {
+			// need to get the correct message template group for this (i.e. is there a custom invoice for the event this registration is registered for?)
+			$template_query_params = array(
+				'MTP_is_active'    => true,
+				'MTP_messenger'    => $generating_messenger,
+				'MTP_message_type' => $message_type,
+				'Event.EVT_ID'     => $registration->event_ID(),
+			);
+			// get the message template group.
+			$msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
+			// if we don't have an EE_Message_Template_Group then return
+			if (! $msg_template_group instanceof EE_Message_Template_Group) {
+				// remove EVT_ID from query params so that global templates get picked up
+				unset($template_query_params['Event.EVT_ID']);
+				// get global template as the fallback
+				$msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
+			}
+			// if we don't have an EE_Message_Template_Group then return
+			if (! $msg_template_group instanceof EE_Message_Template_Group) {
+				return '';
+			}
+			// generate the URL
+			$registration_message_trigger_url = EEH_MSG_Template::generate_url_trigger(
+				$sending_messenger,
+				$generating_messenger,
+				'purchaser',
+				$message_type,
+				$registration,
+				$msg_template_group->ID(),
+				$registration->transaction_ID()
+			);
+		}
+		return $registration_message_trigger_url;
+	}
+
+
+	/**
+	 * Use to generate and return a message preview!
+	 *
+	 * @param  string $type      This should correspond with a valid message type
+	 * @param  string $context   This should correspond with a valid context for the message type
+	 * @param  string $messenger This should correspond with a valid messenger.
+	 * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
+	 *                           preview
+	 * @return bool|string The body of the message or if send is requested, sends.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function preview_message($type, $context, $messenger, $send = false)
+	{
+		self::_load_controller();
+		$mtg = new EE_Message_To_Generate(
+			$messenger,
+			$type,
+			array(),
+			$context,
+			true
+		);
+		$generated_preview_queue = self::$_MSG_PROCESSOR->generate_for_preview($mtg, $send);
+		if ($generated_preview_queue instanceof EE_Messages_Queue) {
+			// loop through all content for the preview and remove any persisted records.
+			$content = '';
+			foreach ($generated_preview_queue->get_message_repository() as $message) {
+				$content = $message->content();
+				if ($message->ID() > 0 && $message->STS_ID() !== EEM_Message::status_failed) {
+					$message->delete();
+				}
+			}
+			return $content;
+		} else {
+			return $generated_preview_queue;
+		}
+	}
+
+
+	/**
+	 * This is a method that allows for sending a message using a messenger matching the string given and the provided
+	 * EE_Message_Queue object.  The EE_Message_Queue object is used to create a single aggregate EE_Message via the
+	 * content found in the EE_Message objects in the queue.
+	 *
+	 * @since 4.9.0
+	 * @param string            $messenger            a string matching a valid active messenger in the system
+	 * @param string            $message_type         Although it seems contrary to the name of the method, a message
+	 *                                                type name is still required to send along the message type to the
+	 *                                                messenger because this is used for determining what specific
+	 *                                                variations might be loaded for the generated message.
+	 * @param EE_Messages_Queue $queue
+	 * @param string            $custom_subject       Can be used to set what the custom subject string will be on the
+	 *                                                aggregate EE_Message object.
+	 * @return bool success or fail.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function send_message_with_messenger_only(
+		$messenger,
+		$message_type,
+		EE_Messages_Queue $queue,
+		$custom_subject = ''
+	) {
+		self::_load_controller();
+		/** @type EE_Message_To_Generate_From_Queue $message_to_generate */
+		$message_to_generate = EE_Registry::instance()->load_lib(
+			'Message_To_Generate_From_Queue',
+			array(
+				$messenger,
+				$message_type,
+				$queue,
+				$custom_subject,
+			)
+		);
+		return self::$_MSG_PROCESSOR->queue_for_sending($message_to_generate);
+	}
+
+
+	/**
+	 * Generates Messages immediately for EE_Message IDs (but only for the correct status for generation)
+	 *
+	 * @since 4.9.0
+	 * @param array $message_ids An array of message ids
+	 * @return bool|EE_Messages_Queue false if nothing was generated, EE_Messages_Queue containing generated
+	 *                           messages.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function generate_now($message_ids)
+	{
+		self::_load_controller();
+		$messages = EEM_Message::instance()->get_all(
+			array(
+				0 => array(
+					'MSG_ID' => array('IN', $message_ids),
+					'STS_ID' => EEM_Message::status_incomplete,
+				),
+			)
+		);
+		$generated_queue = false;
+		if ($messages) {
+			$generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue($messages);
+		}
+
+		if (! $generated_queue instanceof EE_Messages_Queue) {
+			EE_Error::add_error(
+				__(
+					'The messages were not generated. This could mean there is already a batch being generated on a separate request, or because the selected messages are not ready for generation. Please wait a minute or two and try again.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $generated_queue;
+	}
+
+
+	/**
+	 * Sends messages immediately for the incoming message_ids that have the status of EEM_Message::status_resend or,
+	 * EEM_Message::status_idle
+	 *
+	 * @since 4.9.0
+	 * @param $message_ids
+	 * @return bool|EE_Messages_Queue false if no messages sent.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function send_now($message_ids)
+	{
+		self::_load_controller();
+		$messages = EEM_Message::instance()->get_all(
+			array(
+				0 => array(
+					'MSG_ID' => array('IN', $message_ids),
+					'STS_ID' => array(
+						'IN',
+						array(EEM_Message::status_idle, EEM_Message::status_resend, EEM_Message::status_retry),
+					),
+				),
+			)
+		);
+		$sent_queue = false;
+		if ($messages) {
+			$sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue($messages);
+		}
+
+		if (! $sent_queue instanceof EE_Messages_Queue) {
+			EE_Error::add_error(
+				__(
+					'The messages were not sent. This could mean there is already a batch being sent on a separate request, or because the selected messages are not sendable. Please wait a minute or two and try again.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			// can count how many sent by using the messages in the queue
+			$sent_count = $sent_queue->count_STS_in_queue(EEM_Message::instance()->stati_indicating_sent());
+			if ($sent_count > 0) {
+				EE_Error::add_success(
+					sprintf(
+						_n(
+							'There was %d message successfully sent.',
+							'There were %d messages successfully sent.',
+							$sent_count,
+							'event_espresso'
+						),
+						$sent_count
+					)
+				);
+			} else {
+				EE_Error::overwrite_errors();
+				EE_Error::add_error(
+					__(
+						'No message was sent because of problems with sending. Either all the messages you selected were not a sendable message, they were ALREADY sent on a different scheduled task, or there was an error.
 					If there was an error, you can look at the messages in the message activity list table for any error messages.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return $sent_queue;
-    }
-
-
-    /**
-     * Generate and send immediately from the given $message_ids
-     *
-     * @param array $message_ids EE_Message entity ids.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function generate_and_send_now(array $message_ids)
-    {
-        $generated_queue = self::generate_now($message_ids);
-        // now let's just trigger sending immediately from this queue.
-        $messages_sent = $generated_queue instanceof EE_Messages_Queue
-            ? $generated_queue->execute()
-            : 0;
-        if ($messages_sent) {
-            EE_Error::add_success(
-                esc_html(
-                    sprintf(
-                        _n(
-                            'There was %d message successfully generated and sent.',
-                            'There were %d messages successfully generated and sent.',
-                            $messages_sent,
-                            'event_espresso'
-                        ),
-                        $messages_sent
-                    )
-                )
-            );
-            // errors would be added via the generate_now method.
-        }
-    }
-
-
-    /**
-     * This will queue the incoming message ids for resending.
-     * Note, only message_ids corresponding to messages with the status of EEM_Message::sent will be queued.
-     *
-     * @since 4.9.0
-     * @param array $message_ids An array of EE_Message IDs
-     * @return bool true means messages were successfully queued for resending, false means none were queued for
-     *                           resending.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function queue_for_resending($message_ids)
-    {
-        self::_load_controller();
-        self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send($message_ids);
-
-        // get queue and count
-        $queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
-
-        if (
-            $queue_count > 0
-        ) {
-            EE_Error::add_success(
-                sprintf(
-                    _n(
-                        '%d message successfully queued for resending.',
-                        '%d messages successfully queued for resending.',
-                        $queue_count,
-                        'event_espresso'
-                    ),
-                    $queue_count
-                )
-            );
-            /**
-             * @see filter usage in EE_Messages_Queue::initiate_request_by_priority
-             */
-        } elseif (
-            apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', true)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_sent);
-            if ($queue_count > 0) {
-                EE_Error::add_success(
-                    sprintf(
-                        _n(
-                            '%d message successfully sent.',
-                            '%d messages successfully sent.',
-                            $queue_count,
-                            'event_espresso'
-                        ),
-                        $queue_count
-                    )
-                );
-            } else {
-                EE_Error::add_error(
-                    __(
-                        'No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            EE_Error::add_error(
-                __(
-                    'No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return (bool) $queue_count;
-    }
-
-
-    /**
-     * debug
-     *
-     * @param string          $class
-     * @param string          $func
-     * @param string          $line
-     * @param \EE_Transaction $transaction
-     * @param array           $info
-     * @param bool            $display_request
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    protected static function log(
-        $class = '',
-        $func = '',
-        $line = '',
-        EE_Transaction $transaction,
-        $info = array(),
-        $display_request = false
-    ) {
-        if (defined('EE_DEBUG') && EE_DEBUG) {
-            if ($transaction instanceof EE_Transaction) {
-                // don't serialize objects
-                $info = EEH_Debug_Tools::strip_objects($info);
-                $info['TXN_status'] = $transaction->status_ID();
-                $info['TXN_reg_steps'] = $transaction->reg_steps();
-                if ($transaction->ID()) {
-                    $index = 'EE_Transaction: ' . $transaction->ID();
-                    EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
-                }
-            }
-        }
-    }
-
-
-    /**
-     *  Resets all the static properties in this class when called.
-     */
-    public static function reset()
-    {
-        self::$_EEMSG = null;
-        self::$_message_resource_manager = null;
-        self::$_MSG_PROCESSOR = null;
-        self::$_MSG_PATHS = null;
-        self::$_TMP_PACKS = array();
-    }
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return $sent_queue;
+	}
+
+
+	/**
+	 * Generate and send immediately from the given $message_ids
+	 *
+	 * @param array $message_ids EE_Message entity ids.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function generate_and_send_now(array $message_ids)
+	{
+		$generated_queue = self::generate_now($message_ids);
+		// now let's just trigger sending immediately from this queue.
+		$messages_sent = $generated_queue instanceof EE_Messages_Queue
+			? $generated_queue->execute()
+			: 0;
+		if ($messages_sent) {
+			EE_Error::add_success(
+				esc_html(
+					sprintf(
+						_n(
+							'There was %d message successfully generated and sent.',
+							'There were %d messages successfully generated and sent.',
+							$messages_sent,
+							'event_espresso'
+						),
+						$messages_sent
+					)
+				)
+			);
+			// errors would be added via the generate_now method.
+		}
+	}
+
+
+	/**
+	 * This will queue the incoming message ids for resending.
+	 * Note, only message_ids corresponding to messages with the status of EEM_Message::sent will be queued.
+	 *
+	 * @since 4.9.0
+	 * @param array $message_ids An array of EE_Message IDs
+	 * @return bool true means messages were successfully queued for resending, false means none were queued for
+	 *                           resending.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function queue_for_resending($message_ids)
+	{
+		self::_load_controller();
+		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send($message_ids);
+
+		// get queue and count
+		$queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
+
+		if (
+			$queue_count > 0
+		) {
+			EE_Error::add_success(
+				sprintf(
+					_n(
+						'%d message successfully queued for resending.',
+						'%d messages successfully queued for resending.',
+						$queue_count,
+						'event_espresso'
+					),
+					$queue_count
+				)
+			);
+			/**
+			 * @see filter usage in EE_Messages_Queue::initiate_request_by_priority
+			 */
+		} elseif (
+			apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', true)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_sent);
+			if ($queue_count > 0) {
+				EE_Error::add_success(
+					sprintf(
+						_n(
+							'%d message successfully sent.',
+							'%d messages successfully sent.',
+							$queue_count,
+							'event_espresso'
+						),
+						$queue_count
+					)
+				);
+			} else {
+				EE_Error::add_error(
+					__(
+						'No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			EE_Error::add_error(
+				__(
+					'No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return (bool) $queue_count;
+	}
+
+
+	/**
+	 * debug
+	 *
+	 * @param string          $class
+	 * @param string          $func
+	 * @param string          $line
+	 * @param \EE_Transaction $transaction
+	 * @param array           $info
+	 * @param bool            $display_request
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	protected static function log(
+		$class = '',
+		$func = '',
+		$line = '',
+		EE_Transaction $transaction,
+		$info = array(),
+		$display_request = false
+	) {
+		if (defined('EE_DEBUG') && EE_DEBUG) {
+			if ($transaction instanceof EE_Transaction) {
+				// don't serialize objects
+				$info = EEH_Debug_Tools::strip_objects($info);
+				$info['TXN_status'] = $transaction->status_ID();
+				$info['TXN_reg_steps'] = $transaction->reg_steps();
+				if ($transaction->ID()) {
+					$index = 'EE_Transaction: ' . $transaction->ID();
+					EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *  Resets all the static properties in this class when called.
+	 */
+	public static function reset()
+	{
+		self::$_EEMSG = null;
+		self::$_message_resource_manager = null;
+		self::$_MSG_PROCESSOR = null;
+		self::$_MSG_PATHS = null;
+		self::$_TMP_PACKS = array();
+	}
 }

Spacing +25 added lines, -25 removed lines

@@ -202,7 +202,7 @@ 
                 'event_espresso'
             );
             // add specific message for developers if WP_DEBUG in on
-            $error_msg .= '||' . $e->getMessage();
+            $error_msg .= '||'.$e->getMessage();
             EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
         }
     }
@@ -289,7 +289,7 @@ 
                 'event_espresso'
             );
             // add specific message for developers if WP_DEBUG in on
-            $error_msg .= '||' . $e->getMessage();
+            $error_msg .= '||'.$e->getMessage();
             EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
         }
     }
@@ -320,7 +320,7 @@ 
         $transient_key = EE_Registry::instance()->REQ->get('key');
 
         // now let's verify transient, if not valid exit immediately
-        if (! get_transient($transient_key)) {
+        if ( ! get_transient($transient_key)) {
             /**
              * trigger error so this gets in the error logs.  This is important because it happens on a non-user
              * request.
@@ -332,7 +332,7 @@ 
         delete_transient($transient_key);
 
         if (apply_filters('FHEE__EED_Messages__run_cron__use_wp_cron', true)) {
-            $method = 'batch_' . $cron_type . '_from_queue';
+            $method = 'batch_'.$cron_type.'_from_queue';
             if (method_exists(self::$_MSG_PROCESSOR, $method)) {
                 self::$_MSG_PROCESSOR->$method();
             } else {
@@ -399,7 +399,7 @@ 
         $template_pack_collection->rewind();
         $template_packs = array();
         while ($template_pack_collection->valid()) {
-            $template_packs[ $template_pack_collection->current()->dbref ] = $template_pack_collection->current();
+            $template_packs[$template_pack_collection->current()->dbref] = $template_pack_collection->current();
             $template_pack_collection->next();
         }
         return $template_packs;
@@ -439,15 +439,15 @@ 
         self::$_MSG_PATHS = apply_filters(
             'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
             [
-                EE_LIBRARIES . 'messages/message_type',
-                EE_LIBRARIES . 'messages/messenger',
-                EE_LIBRARIES . 'messages/defaults',
-                EE_LIBRARIES . 'messages/defaults/email',
-                EE_LIBRARIES . 'messages/data_class',
-                EE_LIBRARIES . 'messages/validators',
-                EE_LIBRARIES . 'messages/validators/email',
-                EE_LIBRARIES . 'messages/validators/html',
-                EE_LIBRARIES . 'shortcodes',
+                EE_LIBRARIES.'messages/message_type',
+                EE_LIBRARIES.'messages/messenger',
+                EE_LIBRARIES.'messages/defaults',
+                EE_LIBRARIES.'messages/defaults/email',
+                EE_LIBRARIES.'messages/data_class',
+                EE_LIBRARIES.'messages/validators',
+                EE_LIBRARIES.'messages/validators/email',
+                EE_LIBRARIES.'messages/validators/html',
+                EE_LIBRARIES.'shortcodes',
             ]
         );
     }
@@ -466,7 +466,7 @@ 
      */
     protected static function _load_controller()
     {
-        if (! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
+        if ( ! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
             EE_Registry::instance()->load_core('Request_Handler');
             self::set_autoloaders();
             self::$_EEMSG = EE_Registry::instance()->load_lib('messages');
@@ -507,7 +507,7 @@ 
     public static function payment(EE_Transaction $transaction, EE_Payment $payment = null)
     {
         // if there's no payment object, then we cannot do a payment type message!
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             return;
         }
         self::_load_controller();
@@ -554,7 +554,7 @@ 
     public static function maybe_registration(EE_Registration $registration, $extra_details = array())
     {
 
-        if (! self::_verify_registration_notification_send($registration, $extra_details)) {
+        if ( ! self::_verify_registration_notification_send($registration, $extra_details)) {
             // no messages please
             return;
         }
@@ -621,7 +621,7 @@ 
         EE_Registration $registration,
         $extra_details = array()
     ) {
-        if (! $registration->is_primary_registrant()) {
+        if ( ! $registration->is_primary_registrant()) {
             return false;
         }
         // first we check if we're in admin and not doing front ajax
@@ -637,7 +637,7 @@ 
         } else {
             // frontend request (either regular or via AJAX)
             // TXN is NOT finalized ?
-            if (! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
+            if ( ! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
                 return false;
             }
             // return visit but nothing changed ???
@@ -768,7 +768,7 @@ 
         self::_load_controller();
 
         $msgID = EE_Registry::instance()->REQ->get('MSG_ID');
-        if (! $msgID) {
+        if ( ! $msgID) {
             EE_Error::add_error(
                 __(
                     'Something went wrong because there is no "MSG_ID" value in the request',
@@ -961,14 +961,14 @@ 
             // get the message template group.
             $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
             // if we don't have an EE_Message_Template_Group then return
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
+            if ( ! $msg_template_group instanceof EE_Message_Template_Group) {
                 // remove EVT_ID from query params so that global templates get picked up
                 unset($template_query_params['Event.EVT_ID']);
                 // get global template as the fallback
                 $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
             }
             // if we don't have an EE_Message_Template_Group then return
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
+            if ( ! $msg_template_group instanceof EE_Message_Template_Group) {
                 return '';
             }
             // generate the URL
@@ -1099,7 +1099,7 @@ 
             $generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue($messages);
         }
 
-        if (! $generated_queue instanceof EE_Messages_Queue) {
+        if ( ! $generated_queue instanceof EE_Messages_Queue) {
             EE_Error::add_error(
                 __(
                     'The messages were not generated. This could mean there is already a batch being generated on a separate request, or because the selected messages are not ready for generation. Please wait a minute or two and try again.',
@@ -1146,7 +1146,7 @@ 
             $sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue($messages);
         }
 
-        if (! $sent_queue instanceof EE_Messages_Queue) {
+        if ( ! $sent_queue instanceof EE_Messages_Queue) {
             EE_Error::add_error(
                 __(
                     'The messages were not sent. This could mean there is already a batch being sent on a separate request, or because the selected messages are not sendable. Please wait a minute or two and try again.',
@@ -1334,7 +1334,7 @@ 
                 $info['TXN_status'] = $transaction->status_ID();
                 $info['TXN_reg_steps'] = $transaction->reg_steps();
                 if ($transaction->ID()) {
-                    $index = 'EE_Transaction: ' . $transaction->ID();
+                    $index = 'EE_Transaction: '.$transaction->ID();
                     EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
                 }
             }

core/services/notices/NoticesContainerInterface.php

Indentation +81 added lines, -81 removed lines

@@ -16,129 +16,129 @@
 interface NoticesContainerInterface
 {
 
-    /**
-     * @param string $notice
-     * @param bool   $dismissible
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     */
-    public function addInformation($notice, $dismissible = true, $file = '', $func = '', $line = '');
+	/**
+	 * @param string $notice
+	 * @param bool   $dismissible
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 */
+	public function addInformation($notice, $dismissible = true, $file = '', $func = '', $line = '');
 
 
-    /**
-     * @param string $notice
-     * @param bool   $dismissible
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @return
-     */
-    public function addAttention($notice, $dismissible = true, $file = '', $func = '', $line = '');
+	/**
+	 * @param string $notice
+	 * @param bool   $dismissible
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @return
+	 */
+	public function addAttention($notice, $dismissible = true, $file = '', $func = '', $line = '');
 
 
 
-    /**
-     * @param string $notice
-     * @param bool   $dismissible
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     */
-    public function addError($notice, $dismissible = true, $file, $func, $line);
+	/**
+	 * @param string $notice
+	 * @param bool   $dismissible
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 */
+	public function addError($notice, $dismissible = true, $file, $func, $line);
 
 
 
-    /**
-     * @param string $notice
-     * @param bool   $dismissible
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     */
-    public function addSuccess($notice, $dismissible = true, $file = '', $func = '', $line = '');
+	/**
+	 * @param string $notice
+	 * @param bool   $dismissible
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 */
+	public function addSuccess($notice, $dismissible = true, $file = '', $func = '', $line = '');
 
 
 
-    /**
-     * @return boolean
-     */
-    public function hasInformation();
+	/**
+	 * @return boolean
+	 */
+	public function hasInformation();
 
 
 
-    /**
-     * @return boolean
-     */
-    public function hasAttention();
+	/**
+	 * @return boolean
+	 */
+	public function hasAttention();
 
 
 
-    /**
-     * @return boolean
-     */
-    public function hasError();
+	/**
+	 * @return boolean
+	 */
+	public function hasError();
 
 
 
-    /**
-     * @return boolean
-     */
-    public function hasSuccess();
+	/**
+	 * @return boolean
+	 */
+	public function hasSuccess();
 
 
 
-    /**
-     * @return int
-     */
-    public function countInformation();
+	/**
+	 * @return int
+	 */
+	public function countInformation();
 
 
 
-    /**
-     * @return int
-     */
-    public function countAttention();
+	/**
+	 * @return int
+	 */
+	public function countAttention();
 
 
 
-    /**
-     * @return int
-     */
-    public function countError();
+	/**
+	 * @return int
+	 */
+	public function countError();
 
 
 
-    /**
-     * @return int
-     */
-    public function countSuccess();
+	/**
+	 * @return int
+	 */
+	public function countSuccess();
 
 
 
-    /**
-     * @return NoticeInterface[]
-     */
-    public function getInformation();
+	/**
+	 * @return NoticeInterface[]
+	 */
+	public function getInformation();
 
 
 
-    /**
-     * @return NoticeInterface[]
-     */
-    public function getAttention();
+	/**
+	 * @return NoticeInterface[]
+	 */
+	public function getAttention();
 
 
 
-    /**
-     * @return NoticeInterface[]
-     */
-    public function getError();
+	/**
+	 * @return NoticeInterface[]
+	 */
+	public function getError();
 
 
 
-    /**
-     * @return NoticeInterface[]
-     */
-    public function getSuccess();
+	/**
+	 * @return NoticeInterface[]
+	 */
+	public function getSuccess();
 }

core/services/notices/ConvertNoticesToAdminNotices.php

Spacing +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
             $error_string = esc_html__('The following errors occurred:', 'event_espresso');
             foreach ($notices->getError() as $notice) {
                 if ($this->getThrowExceptions()) {
-                    $error_string .= '<br />' . $notice->message();
+                    $error_string .= '<br />'.$notice->message();
                 } else {
                     new AdminNotice($notice);
                 }

Indentation +38 added lines, -38 removed lines

@@ -14,42 +14,42 @@
 class ConvertNoticesToAdminNotices extends NoticeConverter
 {
 
-    /**
-     * Converts Notice objects into AdminNotice notifications
-     *
-     * @param NoticesContainerInterface $notices
-     * @throws DomainException
-     */
-    public function process(NoticesContainerInterface $notices)
-    {
-        if ($notices->hasAttention()) {
-            foreach ($notices->getAttention() as $notice) {
-                new AdminNotice($notice);
-            }
-        }
-        if ($notices->hasError()) {
-            $error_string = esc_html__('The following errors occurred:', 'event_espresso');
-            foreach ($notices->getError() as $notice) {
-                if ($this->getThrowExceptions()) {
-                    $error_string .= '<br />' . $notice->message();
-                } else {
-                    new AdminNotice($notice);
-                }
-            }
-            if ($this->getThrowExceptions()) {
-                throw new DomainException($error_string);
-            }
-        }
-        if ($notices->hasSuccess()) {
-            foreach ($notices->getSuccess() as $notice) {
-                new AdminNotice($notice);
-            }
-        }
-        if ($notices->hasInformation()) {
-            foreach ($notices->getInformation() as $notice) {
-                new AdminNotice($notice);
-            }
-        }
-        $this->clearNotices();
-    }
+	/**
+	 * Converts Notice objects into AdminNotice notifications
+	 *
+	 * @param NoticesContainerInterface $notices
+	 * @throws DomainException
+	 */
+	public function process(NoticesContainerInterface $notices)
+	{
+		if ($notices->hasAttention()) {
+			foreach ($notices->getAttention() as $notice) {
+				new AdminNotice($notice);
+			}
+		}
+		if ($notices->hasError()) {
+			$error_string = esc_html__('The following errors occurred:', 'event_espresso');
+			foreach ($notices->getError() as $notice) {
+				if ($this->getThrowExceptions()) {
+					$error_string .= '<br />' . $notice->message();
+				} else {
+					new AdminNotice($notice);
+				}
+			}
+			if ($this->getThrowExceptions()) {
+				throw new DomainException($error_string);
+			}
+		}
+		if ($notices->hasSuccess()) {
+			foreach ($notices->getSuccess() as $notice) {
+				new AdminNotice($notice);
+			}
+		}
+		if ($notices->hasInformation()) {
+			foreach ($notices->getInformation() as $notice) {
+				new AdminNotice($notice);
+			}
+		}
+		$this->clearNotices();
+	}
 }

modules/events_archive/EED_Events_Archive.module.php

Doc Comments +2 added lines, -2 removed lines

@@ -274,7 +274,7 @@ 
 
     /**
      * @access public
-     * @return string
+     * @return boolean
      */
     public static function is_iframe()
     {
@@ -892,7 +892,7 @@ 
      *    display_description
      *
      * @access    public
-     * @param $value
+     * @param integer $value
      * @return    bool
      */
     public static function display_description($value)

Indentation +1113 added lines, -1113 removed lines

@@ -16,1108 +16,1108 @@ 
 class EED_Events_Archive extends EED_Module
 {
 
-    const EVENT_DETAILS_PRIORITY = 100;
-
-    const EVENT_DATETIMES_PRIORITY = 110;
-
-    const EVENT_TICKETS_PRIORITY = 120;
-
-    const EVENT_VENUES_PRIORITY = 130;
-
-
-    public static $espresso_event_list_ID = 0;
-
-    public static $espresso_grid_event_lists = array();
-
-    /**
-     * @type bool $using_get_the_excerpt
-     */
-    protected static $using_get_the_excerpt = false;
-
-    /**
-     * Used to flag when the event list is being called from an external iframe.
-     *
-     * @var bool $iframe
-     */
-    protected static $iframe = false;
-
-    /**
-     * @var EventListIframeEmbedButton $_iframe_embed_button
-     */
-    private static $_iframe_embed_button;
-
-    /**
-     * @type EE_Template_Part_Manager $template_parts
-     */
-    protected $template_parts;
-
-
-    /**
-     * @return EED_Events_Archive
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function set_hooks()
-    {
-        /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
-        $custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-        );
-        $custom_post_types = $custom_post_type_definitions->getDefinitions();
-        EE_Config::register_route(
-            $custom_post_types['espresso_events']['plural_slug'],
-            'Events_Archive',
-            'run'
-        );
-        EE_Config::register_route(
-            'event_list',
-            'Events_Archive',
-            'event_list'
-        );
-        EE_Config::register_route(
-            'iframe',
-            'Events_Archive',
-            'event_list_iframe',
-            'event_list'
-        );
-        add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
-        // hook into the end of the \EE_Admin_Page::_load_page_dependencies()
-        // to load assets for "espresso_events" page on the "default" route (action)
-        add_action(
-            'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__default',
-            array('EED_Events_Archive', 'event_list_iframe_embed_button'),
-            10
-        );
-    }
-
-
-    /**
-     *    set_definitions
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_definitions()
-    {
-        define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
-    }
-
-
-    /**
-     * set up EE_Events_Archive_Config
-     */
-    protected function set_config()
-    {
-        $this->set_config_section('template_settings');
-        $this->set_config_class('EE_Events_Archive_Config');
-        $this->set_config_name('EED_Events_Archive');
-    }
-
-
-    /**
-     * @return EventListIframeEmbedButton
-     */
-    public static function get_iframe_embed_button()
-    {
-        if (! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
-            self::$_iframe_embed_button = new EventListIframeEmbedButton();
-        }
-        return self::$_iframe_embed_button;
-    }
-
-
-    /**
-     * event_list_iframe_embed_button
-     *
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function event_list_iframe_embed_button()
-    {
-        $iframe_embed_button = EED_Events_Archive::get_iframe_embed_button();
-        $iframe_embed_button->addEmbedButton();
-    }
-
-
-    /**
-     *    initialize_template_parts
-     *
-     * @access    public
-     * @param EE_Events_Archive_Config $config
-     * @return EE_Template_Part_Manager
-     * @throws EE_Error
-     */
-    public function initialize_template_parts(EE_Events_Archive_Config $config = null)
-    {
-        $config = $config instanceof EE_Events_Archive_Config ? $config : $this->config();
-        EEH_Autoloader::register_template_part_autoloaders();
-        $template_parts = new EE_Template_Part_Manager();
-        $template_parts->add_template_part(
-            'tickets',
-            __('Ticket Selector', 'event_espresso'),
-            'content-espresso_events-tickets.php',
-            $config->display_order_tickets
-        );
-        $template_parts->add_template_part(
-            'datetimes',
-            __('Dates and Times', 'event_espresso'),
-            'content-espresso_events-datetimes.php',
-            $config->display_order_datetimes
-        );
-        $template_parts->add_template_part(
-            'event',
-            __('Event Description', 'event_espresso'),
-            'content-espresso_events-details.php',
-            $config->display_order_event
-        );
-        $template_parts->add_template_part(
-            'venue',
-            __('Venue Information', 'event_espresso'),
-            'content-espresso_events-venues.php',
-            $config->display_order_venue
-        );
-        do_action('AHEE__EED_Event_Archive__initialize_template_parts', $template_parts);
-        return $template_parts;
-    }
-
-
-    /**
-     *    run - initial module setup - this gets called by the EE_Front_Controller if the module route is found in the
-     *    incoming request
-     *
-     * @access    public
-     * @param WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-        do_action('AHEE__EED_Events_Archive__before_run');
-        // ensure valid EE_Events_Archive_Config() object exists
-        $this->set_config();
-        /** @type EE_Events_Archive_Config $config */
-        $config = $this->config();
-        // load other required components
-        $this->load_event_list_assets();
-        // filter the WP posts_join, posts_where, and posts_orderby SQL clauses
-        // add query filters
-        EEH_Event_Query::add_query_filters();
-        // set params that will get used by the filters
-        EEH_Event_Query::set_query_params(
-            '',    // month
-            '',    // category
-            $config->display_expired_events,    // show_expired
-            'start_date',    // orderby
-            'ASC'    // sort
-        );
-        // check what template is loaded
-        add_filter('template_include', array($this, 'template_include'), 999, 1);
-    }
-
-
-    /**
-     * most likely called by the ESPRESSO_EVENTS shortcode which uses this module to do some of it's lifting
-     *
-     * @return    void
-     */
-    public function event_list()
-    {
-        // ensure valid EE_Events_Archive_Config() object exists
-        $this->set_config();
-        // load other required components
-        $this->load_event_list_assets();
-    }
-
-
-    /**
-     * @access    public
-     * @return    void
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function event_list_iframe()
-    {
-        EED_Events_Archive::$iframe = true;
-        $event_list_iframe = new EventsArchiveIframe($this);
-        $event_list_iframe->display();
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public static function is_iframe()
-    {
-        return EED_Events_Archive::$iframe;
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public static function link_target()
-    {
-        return EED_Events_Archive::$iframe ? ' target="_blank"' : '';
-    }
-
-
-    /**
-     *    template_include
-     *
-     * @access    public
-     * @param string $template
-     * @return    string
-     */
-    public function template_include($template = '')
-    {
-        // don't add content filter for dedicated EE child themes or private posts
-        if (! EEH_Template::is_espresso_theme()) {
-            /** @type EE_Events_Archive_Config $config */
-            $config = $this->config();
-            // add status banner ?
-            if ($config->display_status_banner) {
-                add_filter('the_title', array('EED_Events_Archive', 'the_title'), 100, 2);
-            }
-            // if NOT a custom template
-            if (
-                apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false)
-                || EE_Registry::instance()
-                              ->load_core('Front_Controller')
-                              ->get_selected_template() !== 'archive-espresso_events.php'
-            ) {
-                // don't display entry meta because the existing theme will take care of that
-                add_filter('FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true');
-                // load functions.php file for the theme (loaded by WP if using child theme)
-                EEH_Template::load_espresso_theme_functions();
-                // because we don't know if the theme is using the_excerpt()
-                add_filter(
-                    'the_excerpt',
-                    array('EED_Events_Archive', 'event_details'),
-                    EED_Events_Archive::EVENT_DETAILS_PRIORITY
-                );
-                // or the_content
-                add_filter(
-                    'the_content',
-                    array('EED_Events_Archive', 'event_details'),
-                    EED_Events_Archive::EVENT_DETAILS_PRIORITY
-                );
-                // and just in case they are running get_the_excerpt() which DESTROYS things
-                add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
-                // don't display entry meta because the existing theme will take care of that
-                add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
-            }
-        }
-        return $template;
-    }
-
-
-    /**
-     *    get_the_excerpt - kinda hacky, but if a theme is using get_the_excerpt(), then we need to remove our filters
-     *    on the_content()
-     *
-     * @access    public
-     * @param        string $excerpt
-     * @return        string
-     */
-    public static function get_the_excerpt($excerpt = '')
-    {
-        if (post_password_required()) {
-            return $excerpt;
-        }
-        if (apply_filters('FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false)) {
-            remove_filter(
-                'the_excerpt',
-                array('EED_Events_Archive', 'event_details'),
-                EED_Events_Archive::EVENT_DETAILS_PRIORITY
-            );
-            remove_filter(
-                'the_content',
-                array('EED_Events_Archive', 'event_details'),
-                EED_Events_Archive::EVENT_DETAILS_PRIORITY
-            );
-            $excerpt = EED_Events_Archive::event_details($excerpt);
-        } else {
-            EED_Events_Archive::$using_get_the_excerpt = true;
-            add_filter('wp_trim_excerpt', array('EED_Events_Archive', 'end_get_the_excerpt'), 999, 1);
-        }
-        return $excerpt;
-    }
-
-
-    /**
-     * end_get_the_excerpt
-     *
-     * @access public
-     * @param  string $text
-     * @return string
-     */
-    public static function end_get_the_excerpt($text = '')
-    {
-        EED_Events_Archive::$using_get_the_excerpt = false;
-        return $text;
-    }
-
-
-    /**
-     *    the_title
-     *
-     * @access        public
-     * @param        string $title
-     * @param        string $id
-     * @return        string
-     */
-    public static function the_title($title = '', $id = '')
-    {
-        global $post;
-        if ($post instanceof WP_Post) {
-            return in_the_loop() && $post->ID == $id ? espresso_event_status_banner($post->ID) . $title : $title;
-        }
-        return $title;
-    }
-
-
-    /**
-     *    event_details
-     *
-     * @access    public
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_details($content)
-    {
-        global $post;
-        static $current_post_ID = 0;
-        if (
-            $current_post_ID !== $post->ID
-            && $post->post_type === 'espresso_events'
-            && ! EED_Events_Archive::$using_get_the_excerpt
-            && ! post_password_required()
-            && (
-                apply_filters('FHEE__EES_Espresso_Events__process_shortcode__true', false)
-                || ! apply_filters('FHEE__content_espresso_events__template_loaded', false)
-            )
-        ) {
-            // Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
-            // Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
-            // BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
-            // We want to allow those plugins to still do their thing and have access to our content, but depending on
-            // how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
-            // so the following allows this filter to be applied multiple times, but only once for real
-            $current_post_ID = did_action('loop_start') ? $post->ID : 0;
-            if (EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order) {
-                $content = EED_Events_Archive::use_sortable_display_order();
-            } else {
-                $content = EED_Events_Archive::use_filterable_display_order();
-            }
-        }
-        return $content;
-    }
-
-
-    /**
-     *    use_sortable_display_order
-     *
-     * @access    protected
-     * @return string
-     */
-    protected static function use_sortable_display_order()
-    {
-        // no further password checks required atm
-        add_filter('FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true');
-        // we need to first remove this callback from being applied to the_content() or the_excerpt()
-        // (otherwise it will recurse and blow up the interweb)
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
-        // now add additional content depending on whether event is using the_excerpt() or the_content()
-        EED_Events_Archive::instance()->template_parts = EED_Events_Archive::instance()->initialize_template_parts();
-        $content = EEH_Template::locate_template('content-espresso_events-details.php');
-        $content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters($content);
-        // re-add our main filters (or else the next event won't have them)
-        add_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
-        remove_filter(
-            'FHEE__EED_Events_Archive__event_details__no_post_password_required',
-            '__return_true'
-        );
-        return $content;
-    }
-
-
-    /**
-     *    use_filterable_display_order
-     *
-     * @access    protected
-     * @return    string
-     */
-    protected static function use_filterable_display_order()
-    {
-        // we need to first remove this callback from being applied to the_content()
-        // (otherwise it will recurse and blow up the interweb)
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
-        // now add additional content depending on whether event is using the_excerpt() or the_content()
-        EED_Events_Archive::_add_additional_excerpt_filters();
-        EED_Events_Archive::_add_additional_content_filters();
-        do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters');
-        // now load our template
-        $content = EEH_Template::locate_template('content-espresso_events-details.php');
-        // re-add our main filters (or else the next event won't have them)
-        add_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
-        // but remove the other filters so that they don't get applied to the next post
-        EED_Events_Archive::_remove_additional_events_archive_filters();
-        do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters');
-        // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
-        // return ! empty( $template ) ? $template : $content;
-        return $content;
-    }
-
-
-    /**
-     *    event_datetimes - adds datetimes ABOVE content
-     *
-     * @access    public
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_datetimes($content)
-    {
-        if (post_password_required()) {
-            return $content;
-        }
-        return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
-    }
-
-
-    /**
-     *    event_tickets - adds tickets ABOVE content (which includes datetimes)
-     *
-     * @access    public
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_tickets($content)
-    {
-        if (post_password_required()) {
-            return $content;
-        }
-        return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
-    }
-
-
-    /**
-     *    event_venues - adds venues BELOW content
-     *
-     * @access    public
-     * @param    string $content
-     * @return    string
-     */
-    public static function event_venue($content)
-    {
-        return EED_Events_Archive::event_venues($content);
-    }
-
-
-    /**
-     *    event_venues - adds venues BELOW content
-     *
-     * @access    public
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_venues($content)
-    {
-        if (post_password_required()) {
-            return $content;
-        }
-        return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
-    }
-
-
-    /**
-     *    _add_additional_content_filters
-     *
-     * @access    private
-     * @return        void
-     */
-    private static function _add_additional_excerpt_filters()
-    {
-        add_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        add_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        add_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-    }
-
-
-    /**
-     *    _add_additional_content_filters
-     *
-     * @access    private
-     * @return        void
-     */
-    private static function _add_additional_content_filters()
-    {
-        add_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-    }
-
-
-    /**
-     *    _remove_additional_events_archive_filters
-     *
-     * @access    private
-     * @return        void
-     */
-    private static function _remove_additional_events_archive_filters()
-    {
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-    }
-
-
-    /**
-     *    remove_all_events_archive_filters
-     *
-     * @access    public
-     * @return        void
-     */
-    public static function remove_all_events_archive_filters()
-    {
-        // remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
-        remove_filter('the_title', array('EED_Events_Archive', 'the_title'), 1);
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-        // don't display entry meta because the existing theme will take care of that
-        remove_filter(
-            'FHEE__content_espresso_events_details_template__display_entry_meta',
-            '__return_false'
-        );
-    }
-
-
-    /**
-     *    load_event_list_assets
-     *
-     * @access    public
-     * @return    void
-     */
-    public function load_event_list_assets()
-    {
-        do_action('AHEE__EED_Events_Archive__before_load_assets');
-        add_filter('FHEE_load_EE_Session', '__return_true');
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
-        if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
-            add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
-        }
-    }
-
-
-    /**
-     *    wp_enqueue_scripts
-     *
-     * @access    public
-     * @return    void
-     * @throws EE_Error
-     */
-    public function wp_enqueue_scripts()
-    {
-        // get some style
-        if (apply_filters('FHEE_enable_default_espresso_css', false)) {
-            // first check uploads folder
-            if (EEH_File::is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
-                wp_register_style(
-                    $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
-                    array('dashicons', 'espresso_default')
-                );
-            } else {
-            }
-            wp_enqueue_style($this->theme);
-        }
-    }
-
-
-    /**
-     *    template_settings_form
-     *
-     * @access    public
-     * @static
-     * @return    string
-     */
-    public static function template_settings_form()
-    {
-        $template_settings = EE_Registry::instance()->CFG->template_settings;
-        $template_settings->EED_Events_Archive = isset($template_settings->EED_Events_Archive)
-            ? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config();
-        $template_settings->EED_Events_Archive = apply_filters(
-            'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
-            $template_settings->EED_Events_Archive
-        );
-        $events_archive_settings = array(
-            'display_status_banner' => 0,
-            'display_description' => 1,
-            'display_ticket_selector' => 0,
-            'display_datetimes' => 1,
-            'display_venue' => 0,
-            'display_expired_events' => 0,
-        );
-        $events_archive_settings = array_merge(
-            $events_archive_settings,
-            (array) $template_settings->EED_Events_Archive
-        );
-        EEH_Template::display_template(
-            EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
-            $events_archive_settings
-        );
-    }
-
-
-    /**
-     *    update_template_settings
-     *
-     * @access    public
-     * @param    EE_Template_Config $CFG
-     * @param    EE_Request_Handler $REQ
-     * @return    EE_Template_Config
-     */
-    public static function update_template_settings($CFG, $REQ)
-    {
-        $CFG->EED_Events_Archive = new EE_Events_Archive_Config();
-        // unless we are resetting the config...
-        if (
-            ! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
-            || absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
-        ) {
-            $CFG->EED_Events_Archive->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner'])
-                ? absint($REQ['EED_Events_Archive_display_status_banner']) : 0;
-            $CFG->EED_Events_Archive->display_description = isset($REQ['EED_Events_Archive_display_description'])
-                ? absint($REQ['EED_Events_Archive_display_description']) : 1;
-            $CFG->EED_Events_Archive->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
-                ? absint($REQ['EED_Events_Archive_display_ticket_selector']) : 0;
-            $CFG->EED_Events_Archive->display_datetimes = isset($REQ['EED_Events_Archive_display_datetimes']) ? absint(
-                $REQ['EED_Events_Archive_display_datetimes']
-            ) : 1;
-            $CFG->EED_Events_Archive->display_venue = isset($REQ['EED_Events_Archive_display_venue']) ? absint(
-                $REQ['EED_Events_Archive_display_venue']
-            ) : 0;
-            $CFG->EED_Events_Archive->display_expired_events = isset($REQ['EED_Events_Archive_display_expired_events'])
-                ? absint($REQ['EED_Events_Archive_display_expired_events']) : 0;
-        }
-        return $CFG;
-    }
-
-
-    /**
-     *    event_list_css
-     *
-     * @access    public
-     * @param string $extra_class
-     * @return    string
-     */
-    public static function event_list_css($extra_class = '')
-    {
-        $event_list_css = ! empty($extra_class) ? array($extra_class) : array();
-        $event_list_css[] = 'espresso-event-list-event';
-        return implode(' ', $event_list_css);
-    }
-
-
-    /**
-     *    event_categories
-     *
-     * @access    public
-     * @return    array
-     */
-    public static function event_categories()
-    {
-        return EE_Registry::instance()->load_model('Term')->get_all_ee_categories();
-    }
-
-
-    /**
-     *    display_description
-     *
-     * @access    public
-     * @param $value
-     * @return    bool
-     */
-    public static function display_description($value)
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        $display_description = isset($config->display_description) ? $config->display_description : 1;
-        return $display_description === $value ? true : false;
-    }
-
-
-    /**
-     *    display_ticket_selector
-     *
-     * @access    public
-     * @return    bool
-     */
-    public static function display_ticket_selector()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        return isset($config->display_ticket_selector) && $config->display_ticket_selector ? true : false;
-    }
-
-
-    /**
-     *    display_venue
-     *
-     * @access    public
-     * @return    bool
-     */
-    public static function display_venue()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        return isset($config->display_venue) && $config->display_venue && EEH_Venue_View::venue_name() ? true : false;
-    }
-
-
-    /**
-     *    display_datetimes
-     *
-     * @access    public
-     * @return    bool
-     */
-    public static function display_datetimes()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        return isset($config->display_datetimes) && $config->display_datetimes ? true : false;
-    }
-
-
-    /**
-     *    event_list_title
-     *
-     * @access    public
-     * @return    string
-     */
-    public static function event_list_title()
-    {
-        return apply_filters(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            __('Upcoming Events', 'event_espresso')
-        );
-    }
-
-
-    // GRAVEYARD
-
-
-    /**
-     * @since 4.4.0
-     */
-    public static function _doing_it_wrong_notice($function = '')
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            sprintf(
-                __(
-                    'EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s',
-                    'event_espresso'
-                ),
-                $function,
-                '<br />',
-                '4.6.0'
-            ),
-            '4.4.0'
-        );
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public function get_post_data()
-    {
-        EEH_Event_Query::set_query_params();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public function posts_fields($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_fields($SQL, $wp_query);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public static function posts_fields_sql_for_orderby($orderby_params = array())
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_fields_sql_for_orderby($orderby_params);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public function posts_join($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_join($SQL, $wp_query);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_join_sql_for_terms($join_terms = null)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_join_sql_for_terms($join_terms);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public static function posts_join_for_orderby($orderby_params = array())
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_join_for_orderby($orderby_params);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public function posts_where($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where($SQL, $wp_query);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public static function posts_where_sql_for_show_expired($show_expired = false)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where_sql_for_show_expired($show_expired);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where_sql_for_event_category_slug($event_category_slug);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public static function posts_where_sql_for_event_list_month($month = null)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where_sql_for_event_list_month($month);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public function posts_orderby($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_orderby($SQL, $wp_query);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public static function posts_orderby_sql($orderby_params = array(), $sort = 'ASC')
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_orderby_sql($orderby_params, $sort);
-    }
+	const EVENT_DETAILS_PRIORITY = 100;
+
+	const EVENT_DATETIMES_PRIORITY = 110;
+
+	const EVENT_TICKETS_PRIORITY = 120;
+
+	const EVENT_VENUES_PRIORITY = 130;
+
+
+	public static $espresso_event_list_ID = 0;
+
+	public static $espresso_grid_event_lists = array();
+
+	/**
+	 * @type bool $using_get_the_excerpt
+	 */
+	protected static $using_get_the_excerpt = false;
+
+	/**
+	 * Used to flag when the event list is being called from an external iframe.
+	 *
+	 * @var bool $iframe
+	 */
+	protected static $iframe = false;
+
+	/**
+	 * @var EventListIframeEmbedButton $_iframe_embed_button
+	 */
+	private static $_iframe_embed_button;
+
+	/**
+	 * @type EE_Template_Part_Manager $template_parts
+	 */
+	protected $template_parts;
+
+
+	/**
+	 * @return EED_Events_Archive
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function set_hooks()
+	{
+		/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
+		$custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+		);
+		$custom_post_types = $custom_post_type_definitions->getDefinitions();
+		EE_Config::register_route(
+			$custom_post_types['espresso_events']['plural_slug'],
+			'Events_Archive',
+			'run'
+		);
+		EE_Config::register_route(
+			'event_list',
+			'Events_Archive',
+			'event_list'
+		);
+		EE_Config::register_route(
+			'iframe',
+			'Events_Archive',
+			'event_list_iframe',
+			'event_list'
+		);
+		add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
+		// hook into the end of the \EE_Admin_Page::_load_page_dependencies()
+		// to load assets for "espresso_events" page on the "default" route (action)
+		add_action(
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__default',
+			array('EED_Events_Archive', 'event_list_iframe_embed_button'),
+			10
+		);
+	}
+
+
+	/**
+	 *    set_definitions
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_definitions()
+	{
+		define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
+	}
+
+
+	/**
+	 * set up EE_Events_Archive_Config
+	 */
+	protected function set_config()
+	{
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Events_Archive_Config');
+		$this->set_config_name('EED_Events_Archive');
+	}
+
+
+	/**
+	 * @return EventListIframeEmbedButton
+	 */
+	public static function get_iframe_embed_button()
+	{
+		if (! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
+			self::$_iframe_embed_button = new EventListIframeEmbedButton();
+		}
+		return self::$_iframe_embed_button;
+	}
+
+
+	/**
+	 * event_list_iframe_embed_button
+	 *
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function event_list_iframe_embed_button()
+	{
+		$iframe_embed_button = EED_Events_Archive::get_iframe_embed_button();
+		$iframe_embed_button->addEmbedButton();
+	}
+
+
+	/**
+	 *    initialize_template_parts
+	 *
+	 * @access    public
+	 * @param EE_Events_Archive_Config $config
+	 * @return EE_Template_Part_Manager
+	 * @throws EE_Error
+	 */
+	public function initialize_template_parts(EE_Events_Archive_Config $config = null)
+	{
+		$config = $config instanceof EE_Events_Archive_Config ? $config : $this->config();
+		EEH_Autoloader::register_template_part_autoloaders();
+		$template_parts = new EE_Template_Part_Manager();
+		$template_parts->add_template_part(
+			'tickets',
+			__('Ticket Selector', 'event_espresso'),
+			'content-espresso_events-tickets.php',
+			$config->display_order_tickets
+		);
+		$template_parts->add_template_part(
+			'datetimes',
+			__('Dates and Times', 'event_espresso'),
+			'content-espresso_events-datetimes.php',
+			$config->display_order_datetimes
+		);
+		$template_parts->add_template_part(
+			'event',
+			__('Event Description', 'event_espresso'),
+			'content-espresso_events-details.php',
+			$config->display_order_event
+		);
+		$template_parts->add_template_part(
+			'venue',
+			__('Venue Information', 'event_espresso'),
+			'content-espresso_events-venues.php',
+			$config->display_order_venue
+		);
+		do_action('AHEE__EED_Event_Archive__initialize_template_parts', $template_parts);
+		return $template_parts;
+	}
+
+
+	/**
+	 *    run - initial module setup - this gets called by the EE_Front_Controller if the module route is found in the
+	 *    incoming request
+	 *
+	 * @access    public
+	 * @param WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+		do_action('AHEE__EED_Events_Archive__before_run');
+		// ensure valid EE_Events_Archive_Config() object exists
+		$this->set_config();
+		/** @type EE_Events_Archive_Config $config */
+		$config = $this->config();
+		// load other required components
+		$this->load_event_list_assets();
+		// filter the WP posts_join, posts_where, and posts_orderby SQL clauses
+		// add query filters
+		EEH_Event_Query::add_query_filters();
+		// set params that will get used by the filters
+		EEH_Event_Query::set_query_params(
+			'',    // month
+			'',    // category
+			$config->display_expired_events,    // show_expired
+			'start_date',    // orderby
+			'ASC'    // sort
+		);
+		// check what template is loaded
+		add_filter('template_include', array($this, 'template_include'), 999, 1);
+	}
+
+
+	/**
+	 * most likely called by the ESPRESSO_EVENTS shortcode which uses this module to do some of it's lifting
+	 *
+	 * @return    void
+	 */
+	public function event_list()
+	{
+		// ensure valid EE_Events_Archive_Config() object exists
+		$this->set_config();
+		// load other required components
+		$this->load_event_list_assets();
+	}
+
+
+	/**
+	 * @access    public
+	 * @return    void
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function event_list_iframe()
+	{
+		EED_Events_Archive::$iframe = true;
+		$event_list_iframe = new EventsArchiveIframe($this);
+		$event_list_iframe->display();
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public static function is_iframe()
+	{
+		return EED_Events_Archive::$iframe;
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public static function link_target()
+	{
+		return EED_Events_Archive::$iframe ? ' target="_blank"' : '';
+	}
+
+
+	/**
+	 *    template_include
+	 *
+	 * @access    public
+	 * @param string $template
+	 * @return    string
+	 */
+	public function template_include($template = '')
+	{
+		// don't add content filter for dedicated EE child themes or private posts
+		if (! EEH_Template::is_espresso_theme()) {
+			/** @type EE_Events_Archive_Config $config */
+			$config = $this->config();
+			// add status banner ?
+			if ($config->display_status_banner) {
+				add_filter('the_title', array('EED_Events_Archive', 'the_title'), 100, 2);
+			}
+			// if NOT a custom template
+			if (
+				apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false)
+				|| EE_Registry::instance()
+							  ->load_core('Front_Controller')
+							  ->get_selected_template() !== 'archive-espresso_events.php'
+			) {
+				// don't display entry meta because the existing theme will take care of that
+				add_filter('FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true');
+				// load functions.php file for the theme (loaded by WP if using child theme)
+				EEH_Template::load_espresso_theme_functions();
+				// because we don't know if the theme is using the_excerpt()
+				add_filter(
+					'the_excerpt',
+					array('EED_Events_Archive', 'event_details'),
+					EED_Events_Archive::EVENT_DETAILS_PRIORITY
+				);
+				// or the_content
+				add_filter(
+					'the_content',
+					array('EED_Events_Archive', 'event_details'),
+					EED_Events_Archive::EVENT_DETAILS_PRIORITY
+				);
+				// and just in case they are running get_the_excerpt() which DESTROYS things
+				add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
+				// don't display entry meta because the existing theme will take care of that
+				add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
+			}
+		}
+		return $template;
+	}
+
+
+	/**
+	 *    get_the_excerpt - kinda hacky, but if a theme is using get_the_excerpt(), then we need to remove our filters
+	 *    on the_content()
+	 *
+	 * @access    public
+	 * @param        string $excerpt
+	 * @return        string
+	 */
+	public static function get_the_excerpt($excerpt = '')
+	{
+		if (post_password_required()) {
+			return $excerpt;
+		}
+		if (apply_filters('FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false)) {
+			remove_filter(
+				'the_excerpt',
+				array('EED_Events_Archive', 'event_details'),
+				EED_Events_Archive::EVENT_DETAILS_PRIORITY
+			);
+			remove_filter(
+				'the_content',
+				array('EED_Events_Archive', 'event_details'),
+				EED_Events_Archive::EVENT_DETAILS_PRIORITY
+			);
+			$excerpt = EED_Events_Archive::event_details($excerpt);
+		} else {
+			EED_Events_Archive::$using_get_the_excerpt = true;
+			add_filter('wp_trim_excerpt', array('EED_Events_Archive', 'end_get_the_excerpt'), 999, 1);
+		}
+		return $excerpt;
+	}
+
+
+	/**
+	 * end_get_the_excerpt
+	 *
+	 * @access public
+	 * @param  string $text
+	 * @return string
+	 */
+	public static function end_get_the_excerpt($text = '')
+	{
+		EED_Events_Archive::$using_get_the_excerpt = false;
+		return $text;
+	}
+
+
+	/**
+	 *    the_title
+	 *
+	 * @access        public
+	 * @param        string $title
+	 * @param        string $id
+	 * @return        string
+	 */
+	public static function the_title($title = '', $id = '')
+	{
+		global $post;
+		if ($post instanceof WP_Post) {
+			return in_the_loop() && $post->ID == $id ? espresso_event_status_banner($post->ID) . $title : $title;
+		}
+		return $title;
+	}
+
+
+	/**
+	 *    event_details
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_details($content)
+	{
+		global $post;
+		static $current_post_ID = 0;
+		if (
+			$current_post_ID !== $post->ID
+			&& $post->post_type === 'espresso_events'
+			&& ! EED_Events_Archive::$using_get_the_excerpt
+			&& ! post_password_required()
+			&& (
+				apply_filters('FHEE__EES_Espresso_Events__process_shortcode__true', false)
+				|| ! apply_filters('FHEE__content_espresso_events__template_loaded', false)
+			)
+		) {
+			// Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
+			// Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
+			// BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
+			// We want to allow those plugins to still do their thing and have access to our content, but depending on
+			// how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
+			// so the following allows this filter to be applied multiple times, but only once for real
+			$current_post_ID = did_action('loop_start') ? $post->ID : 0;
+			if (EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order) {
+				$content = EED_Events_Archive::use_sortable_display_order();
+			} else {
+				$content = EED_Events_Archive::use_filterable_display_order();
+			}
+		}
+		return $content;
+	}
+
+
+	/**
+	 *    use_sortable_display_order
+	 *
+	 * @access    protected
+	 * @return string
+	 */
+	protected static function use_sortable_display_order()
+	{
+		// no further password checks required atm
+		add_filter('FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true');
+		// we need to first remove this callback from being applied to the_content() or the_excerpt()
+		// (otherwise it will recurse and blow up the interweb)
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
+		// now add additional content depending on whether event is using the_excerpt() or the_content()
+		EED_Events_Archive::instance()->template_parts = EED_Events_Archive::instance()->initialize_template_parts();
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
+		$content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters($content);
+		// re-add our main filters (or else the next event won't have them)
+		add_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
+		remove_filter(
+			'FHEE__EED_Events_Archive__event_details__no_post_password_required',
+			'__return_true'
+		);
+		return $content;
+	}
+
+
+	/**
+	 *    use_filterable_display_order
+	 *
+	 * @access    protected
+	 * @return    string
+	 */
+	protected static function use_filterable_display_order()
+	{
+		// we need to first remove this callback from being applied to the_content()
+		// (otherwise it will recurse and blow up the interweb)
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
+		// now add additional content depending on whether event is using the_excerpt() or the_content()
+		EED_Events_Archive::_add_additional_excerpt_filters();
+		EED_Events_Archive::_add_additional_content_filters();
+		do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters');
+		// now load our template
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
+		// re-add our main filters (or else the next event won't have them)
+		add_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
+		// but remove the other filters so that they don't get applied to the next post
+		EED_Events_Archive::_remove_additional_events_archive_filters();
+		do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters');
+		// we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
+		// return ! empty( $template ) ? $template : $content;
+		return $content;
+	}
+
+
+	/**
+	 *    event_datetimes - adds datetimes ABOVE content
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_datetimes($content)
+	{
+		if (post_password_required()) {
+			return $content;
+		}
+		return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
+	}
+
+
+	/**
+	 *    event_tickets - adds tickets ABOVE content (which includes datetimes)
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_tickets($content)
+	{
+		if (post_password_required()) {
+			return $content;
+		}
+		return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
+	}
+
+
+	/**
+	 *    event_venues - adds venues BELOW content
+	 *
+	 * @access    public
+	 * @param    string $content
+	 * @return    string
+	 */
+	public static function event_venue($content)
+	{
+		return EED_Events_Archive::event_venues($content);
+	}
+
+
+	/**
+	 *    event_venues - adds venues BELOW content
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_venues($content)
+	{
+		if (post_password_required()) {
+			return $content;
+		}
+		return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
+	}
+
+
+	/**
+	 *    _add_additional_content_filters
+	 *
+	 * @access    private
+	 * @return        void
+	 */
+	private static function _add_additional_excerpt_filters()
+	{
+		add_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		add_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		add_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+	}
+
+
+	/**
+	 *    _add_additional_content_filters
+	 *
+	 * @access    private
+	 * @return        void
+	 */
+	private static function _add_additional_content_filters()
+	{
+		add_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+	}
+
+
+	/**
+	 *    _remove_additional_events_archive_filters
+	 *
+	 * @access    private
+	 * @return        void
+	 */
+	private static function _remove_additional_events_archive_filters()
+	{
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+	}
+
+
+	/**
+	 *    remove_all_events_archive_filters
+	 *
+	 * @access    public
+	 * @return        void
+	 */
+	public static function remove_all_events_archive_filters()
+	{
+		// remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
+		remove_filter('the_title', array('EED_Events_Archive', 'the_title'), 1);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+		// don't display entry meta because the existing theme will take care of that
+		remove_filter(
+			'FHEE__content_espresso_events_details_template__display_entry_meta',
+			'__return_false'
+		);
+	}
+
+
+	/**
+	 *    load_event_list_assets
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function load_event_list_assets()
+	{
+		do_action('AHEE__EED_Events_Archive__before_load_assets');
+		add_filter('FHEE_load_EE_Session', '__return_true');
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
+		if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
+			add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
+		}
+	}
+
+
+	/**
+	 *    wp_enqueue_scripts
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function wp_enqueue_scripts()
+	{
+		// get some style
+		if (apply_filters('FHEE_enable_default_espresso_css', false)) {
+			// first check uploads folder
+			if (EEH_File::is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+				wp_register_style(
+					$this->theme,
+					get_stylesheet_directory_uri() . $this->theme . '/style.css',
+					array('dashicons', 'espresso_default')
+				);
+			} else {
+			}
+			wp_enqueue_style($this->theme);
+		}
+	}
+
+
+	/**
+	 *    template_settings_form
+	 *
+	 * @access    public
+	 * @static
+	 * @return    string
+	 */
+	public static function template_settings_form()
+	{
+		$template_settings = EE_Registry::instance()->CFG->template_settings;
+		$template_settings->EED_Events_Archive = isset($template_settings->EED_Events_Archive)
+			? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config();
+		$template_settings->EED_Events_Archive = apply_filters(
+			'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
+			$template_settings->EED_Events_Archive
+		);
+		$events_archive_settings = array(
+			'display_status_banner' => 0,
+			'display_description' => 1,
+			'display_ticket_selector' => 0,
+			'display_datetimes' => 1,
+			'display_venue' => 0,
+			'display_expired_events' => 0,
+		);
+		$events_archive_settings = array_merge(
+			$events_archive_settings,
+			(array) $template_settings->EED_Events_Archive
+		);
+		EEH_Template::display_template(
+			EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
+			$events_archive_settings
+		);
+	}
+
+
+	/**
+	 *    update_template_settings
+	 *
+	 * @access    public
+	 * @param    EE_Template_Config $CFG
+	 * @param    EE_Request_Handler $REQ
+	 * @return    EE_Template_Config
+	 */
+	public static function update_template_settings($CFG, $REQ)
+	{
+		$CFG->EED_Events_Archive = new EE_Events_Archive_Config();
+		// unless we are resetting the config...
+		if (
+			! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
+			|| absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
+		) {
+			$CFG->EED_Events_Archive->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner'])
+				? absint($REQ['EED_Events_Archive_display_status_banner']) : 0;
+			$CFG->EED_Events_Archive->display_description = isset($REQ['EED_Events_Archive_display_description'])
+				? absint($REQ['EED_Events_Archive_display_description']) : 1;
+			$CFG->EED_Events_Archive->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
+				? absint($REQ['EED_Events_Archive_display_ticket_selector']) : 0;
+			$CFG->EED_Events_Archive->display_datetimes = isset($REQ['EED_Events_Archive_display_datetimes']) ? absint(
+				$REQ['EED_Events_Archive_display_datetimes']
+			) : 1;
+			$CFG->EED_Events_Archive->display_venue = isset($REQ['EED_Events_Archive_display_venue']) ? absint(
+				$REQ['EED_Events_Archive_display_venue']
+			) : 0;
+			$CFG->EED_Events_Archive->display_expired_events = isset($REQ['EED_Events_Archive_display_expired_events'])
+				? absint($REQ['EED_Events_Archive_display_expired_events']) : 0;
+		}
+		return $CFG;
+	}
+
+
+	/**
+	 *    event_list_css
+	 *
+	 * @access    public
+	 * @param string $extra_class
+	 * @return    string
+	 */
+	public static function event_list_css($extra_class = '')
+	{
+		$event_list_css = ! empty($extra_class) ? array($extra_class) : array();
+		$event_list_css[] = 'espresso-event-list-event';
+		return implode(' ', $event_list_css);
+	}
+
+
+	/**
+	 *    event_categories
+	 *
+	 * @access    public
+	 * @return    array
+	 */
+	public static function event_categories()
+	{
+		return EE_Registry::instance()->load_model('Term')->get_all_ee_categories();
+	}
+
+
+	/**
+	 *    display_description
+	 *
+	 * @access    public
+	 * @param $value
+	 * @return    bool
+	 */
+	public static function display_description($value)
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		$display_description = isset($config->display_description) ? $config->display_description : 1;
+		return $display_description === $value ? true : false;
+	}
+
+
+	/**
+	 *    display_ticket_selector
+	 *
+	 * @access    public
+	 * @return    bool
+	 */
+	public static function display_ticket_selector()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		return isset($config->display_ticket_selector) && $config->display_ticket_selector ? true : false;
+	}
+
+
+	/**
+	 *    display_venue
+	 *
+	 * @access    public
+	 * @return    bool
+	 */
+	public static function display_venue()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		return isset($config->display_venue) && $config->display_venue && EEH_Venue_View::venue_name() ? true : false;
+	}
+
+
+	/**
+	 *    display_datetimes
+	 *
+	 * @access    public
+	 * @return    bool
+	 */
+	public static function display_datetimes()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		return isset($config->display_datetimes) && $config->display_datetimes ? true : false;
+	}
+
+
+	/**
+	 *    event_list_title
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public static function event_list_title()
+	{
+		return apply_filters(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			__('Upcoming Events', 'event_espresso')
+		);
+	}
+
+
+	// GRAVEYARD
+
+
+	/**
+	 * @since 4.4.0
+	 */
+	public static function _doing_it_wrong_notice($function = '')
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			sprintf(
+				__(
+					'EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s',
+					'event_espresso'
+				),
+				$function,
+				'<br />',
+				'4.6.0'
+			),
+			'4.4.0'
+		);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public function get_post_data()
+	{
+		EEH_Event_Query::set_query_params();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public function posts_fields($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_fields($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public static function posts_fields_sql_for_orderby($orderby_params = array())
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_fields_sql_for_orderby($orderby_params);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public function posts_join($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_join_sql_for_terms($join_terms = null)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join_sql_for_terms($join_terms);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public static function posts_join_for_orderby($orderby_params = array())
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join_for_orderby($orderby_params);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public function posts_where($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public static function posts_where_sql_for_show_expired($show_expired = false)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_show_expired($show_expired);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_event_category_slug($event_category_slug);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public static function posts_where_sql_for_event_list_month($month = null)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_event_list_month($month);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public function posts_orderby($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_orderby($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public static function posts_orderby_sql($orderby_params = array(), $sort = 'ASC')
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_orderby_sql($orderby_params, $sort);
+	}
 }
 
 
@@ -1126,9 +1126,9 @@ 
  */
 function espresso_get_event_list_ID()
 {
-    EED_Events_Archive::$espresso_event_list_ID++;
-    EED_Events_Archive::$espresso_grid_event_lists[] = EED_Events_Archive::$espresso_event_list_ID;
-    return EED_Events_Archive::$espresso_event_list_ID;
+	EED_Events_Archive::$espresso_event_list_ID++;
+	EED_Events_Archive::$espresso_grid_event_lists[] = EED_Events_Archive::$espresso_event_list_ID;
+	return EED_Events_Archive::$espresso_event_list_ID;
 }
 
 /**
@@ -1136,7 +1136,7 @@ 
  */
 function espresso_event_list_title()
 {
-    return EED_Events_Archive::event_list_title();
+	return EED_Events_Archive::event_list_title();
 }
 
 /**
@@ -1145,7 +1145,7 @@ 
  */
 function espresso_event_list_css($extra_class = '')
 {
-    return EED_Events_Archive::event_list_css($extra_class);
+	return EED_Events_Archive::event_list_css($extra_class);
 }
 
 /**
@@ -1153,7 +1153,7 @@ 
  */
 function espresso_get_event_categories()
 {
-    return EED_Events_Archive::event_categories();
+	return EED_Events_Archive::event_categories();
 }
 
 /**
@@ -1161,7 +1161,7 @@ 
  */
 function espresso_display_full_description_in_event_list()
 {
-    return EED_Events_Archive::display_description(2);
+	return EED_Events_Archive::display_description(2);
 }
 
 /**
@@ -1169,7 +1169,7 @@ 
  */
 function espresso_display_excerpt_in_event_list()
 {
-    return EED_Events_Archive::display_description(1);
+	return EED_Events_Archive::display_description(1);
 }
 
 /**
@@ -1177,7 +1177,7 @@ 
  */
 function espresso_display_ticket_selector_in_event_list()
 {
-    return EED_Events_Archive::display_ticket_selector();
+	return EED_Events_Archive::display_ticket_selector();
 }
 
 /**
@@ -1185,7 +1185,7 @@ 
  */
 function espresso_display_venue_in_event_list()
 {
-    return EED_Events_Archive::display_venue();
+	return EED_Events_Archive::display_venue();
 }
 
 /**
@@ -1193,5 +1193,5 @@ 
  */
 function espresso_display_datetimes_in_event_list()
 {
-    return EED_Events_Archive::display_datetimes();
+	return EED_Events_Archive::display_datetimes();
 }

Spacing +15 added lines, -15 removed lines

@@ -123,8 +123,8 @@ 
      */
     public static function set_definitions()
     {
-        define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
+        define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
+        define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)).'templates/');
     }
 
 
@@ -144,7 +144,7 @@ 
      */
     public static function get_iframe_embed_button()
     {
-        if (! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
+        if ( ! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
             self::$_iframe_embed_button = new EventListIframeEmbedButton();
         }
         return self::$_iframe_embed_button;
@@ -228,10 +228,10 @@ 
         EEH_Event_Query::add_query_filters();
         // set params that will get used by the filters
         EEH_Event_Query::set_query_params(
-            '',    // month
-            '',    // category
-            $config->display_expired_events,    // show_expired
-            'start_date',    // orderby
+            '', // month
+            '', // category
+            $config->display_expired_events, // show_expired
+            'start_date', // orderby
             'ASC'    // sort
         );
         // check what template is loaded
@@ -297,7 +297,7 @@ 
     public function template_include($template = '')
     {
         // don't add content filter for dedicated EE child themes or private posts
-        if (! EEH_Template::is_espresso_theme()) {
+        if ( ! EEH_Template::is_espresso_theme()) {
             /** @type EE_Events_Archive_Config $config */
             $config = $this->config();
             // add status banner ?
@@ -396,7 +396,7 @@ 
     {
         global $post;
         if ($post instanceof WP_Post) {
-            return in_the_loop() && $post->ID == $id ? espresso_event_status_banner($post->ID) . $title : $title;
+            return in_the_loop() && $post->ID == $id ? espresso_event_status_banner($post->ID).$title : $title;
         }
         return $title;
     }
@@ -547,7 +547,7 @@ 
         if (post_password_required()) {
             return $content;
         }
-        return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
+        return EEH_Template::locate_template('content-espresso_events-datetimes.php').$content;
     }
 
 
@@ -563,7 +563,7 @@ 
         if (post_password_required()) {
             return $content;
         }
-        return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
+        return EEH_Template::locate_template('content-espresso_events-tickets.php').$content;
     }
 
 
@@ -592,7 +592,7 @@ 
         if (post_password_required()) {
             return $content;
         }
-        return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
+        return $content.EEH_Template::locate_template('content-espresso_events-venues.php');
     }
 
 
@@ -777,10 +777,10 @@ 
         // get some style
         if (apply_filters('FHEE_enable_default_espresso_css', false)) {
             // first check uploads folder
-            if (EEH_File::is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+            if (EEH_File::is_readable(get_stylesheet_directory().$this->theme.'/style.css')) {
                 wp_register_style(
                     $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
+                    get_stylesheet_directory_uri().$this->theme.'/style.css',
                     array('dashicons', 'espresso_default')
                 );
             } else {
@@ -819,7 +819,7 @@ 
             (array) $template_settings->EED_Events_Archive
         );
         EEH_Template::display_template(
-            EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
+            EVENTS_ARCHIVE_TEMPLATES_PATH.'admin-event-list-settings.template.php',
             $events_archive_settings
         );
     }

payment_methods/Paypal_Express/EEG_Paypal_Express.gateway.php

Doc Comments +2 added lines, -2 removed lines

@@ -20,8 +20,8 @@
      * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
      * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
      * @param $string
-     * @param $start
-     * @param $length
+     * @param integer $start
+     * @param integer $length
      * @return bool|string
      */
     function mb_strcut($string, $start, $length = null)

Indentation +669 added lines, -669 removed lines

@@ -13,677 +13,677 @@
 
 // Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
 if (! function_exists('mb_strcut')) {
-    /**
-     * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
-     * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
-     * @param $string
-     * @param $start
-     * @param $length
-     * @return bool|string
-     */
-    function mb_strcut($string, $start, $length = null)
-    {
-        return mb_substr($string, $start, $length);
-    }
+	/**
+	 * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
+	 * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
+	 * @param $string
+	 * @param $start
+	 * @param $length
+	 * @return bool|string
+	 */
+	function mb_strcut($string, $start, $length = null)
+	{
+		return mb_substr($string, $start, $length);
+	}
 }
 class EEG_Paypal_Express extends EE_Offsite_Gateway
 {
 
-    /**
-     * Merchant API Username.
-     *
-     * @var string
-     */
-    protected $_api_username;
-
-    /**
-     * Merchant API Password.
-     *
-     * @var string
-     */
-    protected $_api_password;
-
-    /**
-     * API Signature.
-     *
-     * @var string
-     */
-    protected $_api_signature;
-
-    /**
-     * Request Shipping address on PP checkout page.
-     *
-     * @var string
-     */
-    protected $_request_shipping_addr;
-
-    /**
-     * Business/personal logo.
-     *
-     * @var string
-     */
-    protected $_image_url;
-
-    /**
-     * gateway URL variable
-     *
-     * @var string
-     */
-    protected $_base_gateway_url = '';
-
-
-
-    /**
-     * EEG_Paypal_Express constructor.
-     */
-    public function __construct()
-    {
-        $this->_currencies_supported = array(
-            'USD',
-            'AUD',
-            'BRL',
-            'CAD',
-            'CZK',
-            'DKK',
-            'EUR',
-            'HKD',
-            'HUF',
-            'ILS',
-            'JPY',
-            'MYR',
-            'MXN',
-            'NOK',
-            'NZD',
-            'PHP',
-            'PLN',
-            'GBP',
-            'RUB',
-            'SGD',
-            'SEK',
-            'CHF',
-            'TWD',
-            'THB',
-            'TRY',
-            'INR',
-        );
-        parent::__construct();
-    }
-
-
-
-    /**
-     * Sets the gateway URL variable based on whether debug mode is enabled or not.
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        parent::set_settings($settings_array);
-        // Redirect URL.
-        $this->_base_gateway_url = $this->_debug_mode
-            ? 'https://api-3t.sandbox.paypal.com/nvp'
-            : 'https://api-3t.paypal.com/nvp';
-    }
-
-
-
-    /**
-     * @param EEI_Payment $payment
-     * @param array       $billing_info
-     * @param string      $return_url
-     * @param string      $notify_url
-     * @param string      $cancel_url
-     * @return \EE_Payment|\EEI_Payment
-     * @throws \EE_Error
-     */
-    public function set_redirection_info(
-        $payment,
-        $billing_info = array(),
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    ) {
-        if (! $payment instanceof EEI_Payment) {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Error. No associated payment was found.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return $payment;
-        }
-        $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Could not process this payment because it has no associated transaction.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return $payment;
-        }
-        $gateway_formatter = $this->_get_gateway_formatter();
-        $order_description = mb_strcut($gateway_formatter->formatOrderDescription($payment), 0, 127);
-        $primary_registration = $transaction->primary_registration();
-        $primary_attendee = $primary_registration instanceof EE_Registration
-            ? $primary_registration->attendee()
-            : false;
-        $locale = explode('-', get_bloginfo('language'));
-        // Gather request parameters.
-        $token_request_dtls = array(
-            'METHOD'                         => 'SetExpressCheckout',
-            'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-            'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-            'PAYMENTREQUEST_0_DESC'          => $order_description,
-            'RETURNURL'                      => $return_url,
-            'CANCELURL'                      => $cancel_url,
-            'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-            // Buyer does not need to create a PayPal account to check out.
-            // This is referred to as PayPal Account Optional.
-            'SOLUTIONTYPE'                   => 'Sole',
-            // Locale of the pages displayed by PayPal during Express Checkout.
-            'LOCALECODE'                     => $locale[1]
-        );
-        // Show itemized list.
-        $itemized_list = $this->itemize_list($payment, $transaction);
-        $token_request_dtls = array_merge($token_request_dtls, $itemized_list);
-        // Automatically filling out shipping and contact information.
-        if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
-            // If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
-            $token_request_dtls['NOSHIPPING'] = '2';
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
-            $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-        } elseif (! $this->_request_shipping_addr) {
-            // Do not request shipping details on the PP Checkout page.
-            $token_request_dtls['NOSHIPPING'] = '1';
-            $token_request_dtls['REQCONFIRMSHIPPING'] = '0';
-        }
-        // Used a business/personal logo on the PayPal page.
-        if (! empty($this->_image_url)) {
-            $token_request_dtls['LOGOIMG'] = $this->_image_url;
-        }
-        $token_request_dtls = apply_filters(
-            'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
-            $token_request_dtls,
-            $this
-        );
-        // Request PayPal token.
-        $token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
-        $token_rstatus = $this->_ppExpress_check_response($token_request_response);
-        $response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
-            ? $token_rstatus['args']
-            : array();
-        if ($token_rstatus['status']) {
-            // We got the Token so we may continue with the payment and redirect the client.
-            $payment->set_details($response_args);
-            $gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
-            $payment->set_redirect_url(
-                $gateway_url
-                . '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
-                . $response_args['TOKEN']
-            );
-        } else {
-            if (isset($response_args['L_ERRORCODE'])) {
-                $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
-            } else {
-                $payment->set_gateway_response(
-                    esc_html__(
-                        'Error occurred while trying to setup the Express Checkout.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $payment->set_details($response_args);
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     * @param array           $update_info {
-     * @type string           $gateway_txn_id
-     * @type string status an EEMI_Payment status
-     *                                     }
-     * @param EEI_Transaction $transaction
-     * @return EEI_Payment
-     */
-    public function handle_payment_update($update_info, $transaction)
-    {
-        $payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
-        if ($payment instanceof EEI_Payment) {
-            $this->log(array('Return from Authorization' => $update_info), $payment);
-            $transaction = $payment->transaction();
-            if (! $transaction instanceof EEI_Transaction) {
-                $payment->set_gateway_response(
-                    esc_html__(
-                        'Could not process this payment because it has no associated transaction.',
-                        'event_espresso'
-                    )
-                );
-                $payment->set_status($this->_pay_model->failed_status());
-                return $payment;
-            }
-            $primary_registrant = $transaction->primary_registration();
-            $payment_details = $payment->details();
-            // Check if we still have the token.
-            if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
-                $payment->set_status($this->_pay_model->failed_status());
-                return $payment;
-            }
-            $cdetails_request_dtls = array(
-                'METHOD' => 'GetExpressCheckoutDetails',
-                'TOKEN'  => $payment_details['TOKEN'],
-            );
-            // Request Customer Details.
-            $cdetails_request_response = $this->_ppExpress_request(
-                $cdetails_request_dtls,
-                'Customer Details',
-                $payment
-            );
-            $cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
-            $cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
-                ? $cdetails_rstatus['args']
-                : array();
-            if ($cdetails_rstatus['status']) {
-                // We got the PayerID so now we can Complete the transaction.
-                $docheckout_request_dtls = array(
-                    'METHOD'                         => 'DoExpressCheckoutPayment',
-                    'PAYERID'                        => $cdata_response_args['PAYERID'],
-                    'TOKEN'                          => $payment_details['TOKEN'],
-                    'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-                    'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-                    'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-                );
-                 // Include itemized list.
-                $itemized_list = $this->itemize_list(
-                    $payment,
-                    $transaction,
-                    $cdata_response_args
-                );
-                $docheckout_request_dtls = array_merge($docheckout_request_dtls, $itemized_list);
-                // Payment Checkout/Capture.
-                $docheckout_request_response = $this->_ppExpress_request(
-                    $docheckout_request_dtls,
-                    'Do Payment',
-                    $payment
-                );
-                $docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
-                $docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
-                    ? $docheckout_rstatus['args']
-                    : array();
-                if ($docheckout_rstatus['status']) {
-                    // All is well, payment approved.
-                    $primary_registration_code = $primary_registrant instanceof EE_Registration ?
-                        $primary_registrant->reg_code()
-                        : '';
-                    $payment->set_extra_accntng($primary_registration_code);
-                    $payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
-                        ? (float) $docheckout_response_args['PAYMENTINFO_0_AMT']
-                        : 0);
-                    $payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
-                        : null);
-                    $payment->set_details($cdata_response_args);
-                    $payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_ACK']
-                        : '');
-                    $payment->set_status($this->_pay_model->approved_status());
-                } else {
-                    if (isset($docheckout_response_args['L_ERRORCODE'])) {
-                        $payment->set_gateway_response(
-                            $docheckout_response_args['L_ERRORCODE']
-                            . '; '
-                            . $docheckout_response_args['L_SHORTMESSAGE']
-                        );
-                    } else {
-                        $payment->set_gateway_response(
-                            esc_html__(
-                                'Error occurred while trying to Capture the funds.',
-                                'event_espresso'
-                            )
-                        );
-                    }
-                    $payment->set_details($docheckout_response_args);
-                    $payment->set_status($this->_pay_model->declined_status());
-                }
-            } else {
-                if (isset($cdata_response_args['L_ERRORCODE'])) {
-                    $payment->set_gateway_response(
-                        $cdata_response_args['L_ERRORCODE']
-                        . '; '
-                        . $cdata_response_args['L_SHORTMESSAGE']
-                    );
-                } else {
-                    $payment->set_gateway_response(
-                        esc_html__(
-                            'Error occurred while trying to get payment Details from PayPal.',
-                            'event_espresso'
-                        )
-                    );
-                }
-                $payment->set_details($cdata_response_args);
-                $payment->set_status($this->_pay_model->failed_status());
-            }
-        } else {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Error occurred while trying to process the payment.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     *  Make a list of items that are in the giver transaction.
-     *
-     * @param EEI_Payment     $payment
-     * @param EEI_Transaction $transaction
-     * @param array           $request_response_args Data from a previous communication with PP.
-     * @return array
-     */
-    public function itemize_list(EEI_Payment $payment, EEI_Transaction $transaction, $request_response_args = array())
-    {
-        $itemized_list = array();
-        $gateway_formatter = $this->_get_gateway_formatter();
-        // If we have data from a previous communication with PP (on this transaction) we may use that for our list...
-        if (
-            ! empty($request_response_args)
-            && array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args)
-            && array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args)
-        ) {
-            foreach ($request_response_args as $arg_key => $arg_val) {
-                if (
-                    strpos($arg_key, 'PAYMENTREQUEST_') !== false
-                    && strpos($arg_key, 'NOTIFYURL') === false
-                ) {
-                    $itemized_list[ $arg_key ] = $arg_val;
-                }
-            }
-            // If we got only a few Items then something is not right.
-            if (count($itemized_list) > 2) {
-                return $itemized_list;
-            } else {
-                if (WP_DEBUG) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                // @codingStandardsIgnoreStart
-                                'Unable to continue with the checkout because a proper purchase list could not be generated. The purchased list we could have sent was %1$s',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            ),
-                            wp_json_encode($itemized_list)
-                        )
-                    );
-                }
-                // Reset the list and log an error, maybe allow to try and generate a new list (below).
-                $itemized_list = array();
-                $this->log(
-                    array(
-                        (string) esc_html__(
-                            'Could not generate a proper item list with:',
-                            'event_espresso'
-                        ) => $request_response_args
-                    ),
-                    $payment
-                );
-            }
-        }
-        // ...otherwise we generate a new list for this transaction.
-        if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
-            $item_num = 0;
-            $itemized_sum = 0;
-            $total_line_items = $transaction->total_line_item();
-            // Go through each item in the list.
-            foreach ($total_line_items->get_items() as $line_item) {
-                if ($line_item instanceof EE_Line_Item) {
-                    // PayPal doesn't like line items with 0.00 amount, so we may skip those.
-                    if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) {
-                        continue;
-                    }
-                    $unit_price = $line_item->unit_price();
-                    $line_item_quantity = $line_item->quantity();
-                    // This is a discount.
-                    if ($line_item->is_percent()) {
-                        $unit_price = $line_item->total();
-                        $line_item_quantity = 1;
-                    }
-                    // Item Name.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
-                        $gateway_formatter->formatLineItemName($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Item description.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = mb_strcut(
-                        $gateway_formatter->formatLineItemDesc($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Cost of individual item.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency($unit_price);
-                    // Item Number.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
-                    // Item quantity.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = $line_item_quantity;
-                    // Digital item is sold.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
-                    $itemized_sum += $line_item->total();
-                    ++$item_num;
-                }
-            }
-            // Item's sales S/H and tax amount.
-            $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
-            $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
-            $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-            $itemized_sum_diff_from_txn_total = round(
-                $transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
-                2
-            );
-            // If we were not able to recognize some item like promotion, surcharge or cancellation,
-            // add the difference as an extra line item.
-            if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
-                // Item Name.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
-                    esc_html__(
-                        'Other (promotion/surcharge/cancellation)',
-                        'event_espresso'
-                    ),
-                    0,
-                    127
-                );
-                // Item description.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = '';
-                // Cost of individual item.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
-                    $itemized_sum_diff_from_txn_total
-                );
-                // Item Number.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
-                // Item quantity.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = 1;
-                // Digital item is sold.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
-                $item_num++;
-            }
-        } else {
-            // Just one Item.
-            // Item Name.
-            $itemized_list['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
-                $gateway_formatter->formatPartialPaymentLineItemName($payment),
-                0,
-                127
-            );
-            // Item description.
-            $itemized_list['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
-                $gateway_formatter->formatPartialPaymentLineItemDesc($payment),
-                0,
-                127
-            );
-            // Cost of individual item.
-            $itemized_list['L_PAYMENTREQUEST_0_AMT0'] = $gateway_formatter->formatCurrency($payment->amount());
-            // Item Number.
-            $itemized_list['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
-            // Item quantity.
-            $itemized_list['L_PAYMENTREQUEST_0_QTY0'] = 1;
-            // Digital item is sold.
-            $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
-            // Item's sales S/H and tax amount.
-            $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $gateway_formatter->formatCurrency($payment->amount());
-            $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-        }
-        return $itemized_list;
-    }
-
-
-
-    /**
-     *  Make the Express checkout request.
-     *
-     * @param array       $request_params
-     * @param string      $request_text
-     * @param EEI_Payment $payment
-     * @return mixed
-     */
-    public function _ppExpress_request($request_params, $request_text, $payment)
-    {
-        $request_dtls = array(
-            'VERSION' => '204.0',
-            'USER' => $this->_api_username,
-            'PWD' => $this->_api_password,
-            'SIGNATURE' => $this->_api_signature,
-            // EE will blow up if you change this
-            'BUTTONSOURCE' => 'EventEspresso_SP',
-        );
-        $dtls = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
-        // Request Customer Details.
-        $request_response = wp_remote_post(
-            $this->_base_gateway_url,
-            array(
-                'method'      => 'POST',
-                'timeout'     => 45,
-                'httpversion' => '1.1',
-                'cookies'     => array(),
-                'headers'     => array(),
-                'body'        => http_build_query($dtls, '', '&'),
-            )
-        );
-        // Log the response.
-        $this->log(array($request_text . ' Response' => $request_response), $payment);
-        return $request_response;
-    }
-
-
-
-    /**
-     *  Check the response status.
-     *
-     * @param mixed $request_response
-     * @return array
-     */
-    public function _ppExpress_check_response($request_response)
-    {
-        if (is_wp_error($request_response) || empty($request_response['body'])) {
-            // If we got here then there was an error in this request.
-            return array('status' => false, 'args' => $request_response);
-        }
-        $response_args = array();
-        parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
-            return array('status' => false, 'args' => $request_response);
-        }
-        if (
-            (
-                isset($response_args['PAYERID'])
-                || isset($response_args['TOKEN'])
-                || isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                || (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
-            )
-            && in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
-        ) {
-            // Response status OK, return response parameters for further processing.
-            return array('status' => true, 'args' => $response_args);
-        }
-        $errors = $this->_get_errors($response_args);
-        return array('status' => false, 'args' => $errors);
-    }
-
-
-
-    /**
-     *  Log a "Cleared" request.
-     *
-     * @param array       $request
-     * @param EEI_Payment $payment
-     * @param string      $info
-     * @return void
-     */
-    private function _log_clean_request($request, $payment, $info)
-    {
-        $cleaned_request_data = $request;
-        unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
-        $this->log(array($info => $cleaned_request_data), $payment);
-    }
-
-
-
-    /**
-     *  Get error from the response data.
-     *
-     * @param array $data_array
-     * @return array
-     */
-    private function _get_errors($data_array)
-    {
-        $errors = array();
-        $n = 0;
-        while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
-            $l_error_code = isset($data_array[ "L_ERRORCODE{$n}" ])
-                ? $data_array[ "L_ERRORCODE{$n}" ]
-                : '';
-            $l_severity_code = isset($data_array[ "L_SEVERITYCODE{$n}" ])
-                ? $data_array[ "L_SEVERITYCODE{$n}" ]
-                : '';
-            $l_short_message = isset($data_array[ "L_SHORTMESSAGE{$n}" ])
-                ? $data_array[ "L_SHORTMESSAGE{$n}" ]
-                : '';
-            $l_long_message = isset($data_array[ "L_LONGMESSAGE{$n}" ])
-                ? $data_array[ "L_LONGMESSAGE{$n}" ]
-                : '';
-            if ($n === 0) {
-                $errors = array(
-                    'L_ERRORCODE'    => $l_error_code,
-                    'L_SHORTMESSAGE' => $l_short_message,
-                    'L_LONGMESSAGE'  => $l_long_message,
-                    'L_SEVERITYCODE' => $l_severity_code,
-                );
-            } else {
-                $errors['L_ERRORCODE'] .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
-            }
-            $n++;
-        }
-        return $errors;
-    }
+	/**
+	 * Merchant API Username.
+	 *
+	 * @var string
+	 */
+	protected $_api_username;
+
+	/**
+	 * Merchant API Password.
+	 *
+	 * @var string
+	 */
+	protected $_api_password;
+
+	/**
+	 * API Signature.
+	 *
+	 * @var string
+	 */
+	protected $_api_signature;
+
+	/**
+	 * Request Shipping address on PP checkout page.
+	 *
+	 * @var string
+	 */
+	protected $_request_shipping_addr;
+
+	/**
+	 * Business/personal logo.
+	 *
+	 * @var string
+	 */
+	protected $_image_url;
+
+	/**
+	 * gateway URL variable
+	 *
+	 * @var string
+	 */
+	protected $_base_gateway_url = '';
+
+
+
+	/**
+	 * EEG_Paypal_Express constructor.
+	 */
+	public function __construct()
+	{
+		$this->_currencies_supported = array(
+			'USD',
+			'AUD',
+			'BRL',
+			'CAD',
+			'CZK',
+			'DKK',
+			'EUR',
+			'HKD',
+			'HUF',
+			'ILS',
+			'JPY',
+			'MYR',
+			'MXN',
+			'NOK',
+			'NZD',
+			'PHP',
+			'PLN',
+			'GBP',
+			'RUB',
+			'SGD',
+			'SEK',
+			'CHF',
+			'TWD',
+			'THB',
+			'TRY',
+			'INR',
+		);
+		parent::__construct();
+	}
+
+
+
+	/**
+	 * Sets the gateway URL variable based on whether debug mode is enabled or not.
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		parent::set_settings($settings_array);
+		// Redirect URL.
+		$this->_base_gateway_url = $this->_debug_mode
+			? 'https://api-3t.sandbox.paypal.com/nvp'
+			: 'https://api-3t.paypal.com/nvp';
+	}
+
+
+
+	/**
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info
+	 * @param string      $return_url
+	 * @param string      $notify_url
+	 * @param string      $cancel_url
+	 * @return \EE_Payment|\EEI_Payment
+	 * @throws \EE_Error
+	 */
+	public function set_redirection_info(
+		$payment,
+		$billing_info = array(),
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	) {
+		if (! $payment instanceof EEI_Payment) {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Error. No associated payment was found.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return $payment;
+		}
+		$transaction = $payment->transaction();
+		if (! $transaction instanceof EEI_Transaction) {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Could not process this payment because it has no associated transaction.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return $payment;
+		}
+		$gateway_formatter = $this->_get_gateway_formatter();
+		$order_description = mb_strcut($gateway_formatter->formatOrderDescription($payment), 0, 127);
+		$primary_registration = $transaction->primary_registration();
+		$primary_attendee = $primary_registration instanceof EE_Registration
+			? $primary_registration->attendee()
+			: false;
+		$locale = explode('-', get_bloginfo('language'));
+		// Gather request parameters.
+		$token_request_dtls = array(
+			'METHOD'                         => 'SetExpressCheckout',
+			'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+			'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+			'PAYMENTREQUEST_0_DESC'          => $order_description,
+			'RETURNURL'                      => $return_url,
+			'CANCELURL'                      => $cancel_url,
+			'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+			// Buyer does not need to create a PayPal account to check out.
+			// This is referred to as PayPal Account Optional.
+			'SOLUTIONTYPE'                   => 'Sole',
+			// Locale of the pages displayed by PayPal during Express Checkout.
+			'LOCALECODE'                     => $locale[1]
+		);
+		// Show itemized list.
+		$itemized_list = $this->itemize_list($payment, $transaction);
+		$token_request_dtls = array_merge($token_request_dtls, $itemized_list);
+		// Automatically filling out shipping and contact information.
+		if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
+			// If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
+			$token_request_dtls['NOSHIPPING'] = '2';
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
+			$token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
+		} elseif (! $this->_request_shipping_addr) {
+			// Do not request shipping details on the PP Checkout page.
+			$token_request_dtls['NOSHIPPING'] = '1';
+			$token_request_dtls['REQCONFIRMSHIPPING'] = '0';
+		}
+		// Used a business/personal logo on the PayPal page.
+		if (! empty($this->_image_url)) {
+			$token_request_dtls['LOGOIMG'] = $this->_image_url;
+		}
+		$token_request_dtls = apply_filters(
+			'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
+			$token_request_dtls,
+			$this
+		);
+		// Request PayPal token.
+		$token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
+		$token_rstatus = $this->_ppExpress_check_response($token_request_response);
+		$response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
+			? $token_rstatus['args']
+			: array();
+		if ($token_rstatus['status']) {
+			// We got the Token so we may continue with the payment and redirect the client.
+			$payment->set_details($response_args);
+			$gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
+			$payment->set_redirect_url(
+				$gateway_url
+				. '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
+				. $response_args['TOKEN']
+			);
+		} else {
+			if (isset($response_args['L_ERRORCODE'])) {
+				$payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
+			} else {
+				$payment->set_gateway_response(
+					esc_html__(
+						'Error occurred while trying to setup the Express Checkout.',
+						'event_espresso'
+					)
+				);
+			}
+			$payment->set_details($response_args);
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 * @param array           $update_info {
+	 * @type string           $gateway_txn_id
+	 * @type string status an EEMI_Payment status
+	 *                                     }
+	 * @param EEI_Transaction $transaction
+	 * @return EEI_Payment
+	 */
+	public function handle_payment_update($update_info, $transaction)
+	{
+		$payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
+		if ($payment instanceof EEI_Payment) {
+			$this->log(array('Return from Authorization' => $update_info), $payment);
+			$transaction = $payment->transaction();
+			if (! $transaction instanceof EEI_Transaction) {
+				$payment->set_gateway_response(
+					esc_html__(
+						'Could not process this payment because it has no associated transaction.',
+						'event_espresso'
+					)
+				);
+				$payment->set_status($this->_pay_model->failed_status());
+				return $payment;
+			}
+			$primary_registrant = $transaction->primary_registration();
+			$payment_details = $payment->details();
+			// Check if we still have the token.
+			if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+				$payment->set_status($this->_pay_model->failed_status());
+				return $payment;
+			}
+			$cdetails_request_dtls = array(
+				'METHOD' => 'GetExpressCheckoutDetails',
+				'TOKEN'  => $payment_details['TOKEN'],
+			);
+			// Request Customer Details.
+			$cdetails_request_response = $this->_ppExpress_request(
+				$cdetails_request_dtls,
+				'Customer Details',
+				$payment
+			);
+			$cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
+			$cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
+				? $cdetails_rstatus['args']
+				: array();
+			if ($cdetails_rstatus['status']) {
+				// We got the PayerID so now we can Complete the transaction.
+				$docheckout_request_dtls = array(
+					'METHOD'                         => 'DoExpressCheckoutPayment',
+					'PAYERID'                        => $cdata_response_args['PAYERID'],
+					'TOKEN'                          => $payment_details['TOKEN'],
+					'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+					'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+					'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+				);
+				 // Include itemized list.
+				$itemized_list = $this->itemize_list(
+					$payment,
+					$transaction,
+					$cdata_response_args
+				);
+				$docheckout_request_dtls = array_merge($docheckout_request_dtls, $itemized_list);
+				// Payment Checkout/Capture.
+				$docheckout_request_response = $this->_ppExpress_request(
+					$docheckout_request_dtls,
+					'Do Payment',
+					$payment
+				);
+				$docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
+				$docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
+					? $docheckout_rstatus['args']
+					: array();
+				if ($docheckout_rstatus['status']) {
+					// All is well, payment approved.
+					$primary_registration_code = $primary_registrant instanceof EE_Registration ?
+						$primary_registrant->reg_code()
+						: '';
+					$payment->set_extra_accntng($primary_registration_code);
+					$payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
+						? (float) $docheckout_response_args['PAYMENTINFO_0_AMT']
+						: 0);
+					$payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
+						? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
+						: null);
+					$payment->set_details($cdata_response_args);
+					$payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
+						? $docheckout_response_args['PAYMENTINFO_0_ACK']
+						: '');
+					$payment->set_status($this->_pay_model->approved_status());
+				} else {
+					if (isset($docheckout_response_args['L_ERRORCODE'])) {
+						$payment->set_gateway_response(
+							$docheckout_response_args['L_ERRORCODE']
+							. '; '
+							. $docheckout_response_args['L_SHORTMESSAGE']
+						);
+					} else {
+						$payment->set_gateway_response(
+							esc_html__(
+								'Error occurred while trying to Capture the funds.',
+								'event_espresso'
+							)
+						);
+					}
+					$payment->set_details($docheckout_response_args);
+					$payment->set_status($this->_pay_model->declined_status());
+				}
+			} else {
+				if (isset($cdata_response_args['L_ERRORCODE'])) {
+					$payment->set_gateway_response(
+						$cdata_response_args['L_ERRORCODE']
+						. '; '
+						. $cdata_response_args['L_SHORTMESSAGE']
+					);
+				} else {
+					$payment->set_gateway_response(
+						esc_html__(
+							'Error occurred while trying to get payment Details from PayPal.',
+							'event_espresso'
+						)
+					);
+				}
+				$payment->set_details($cdata_response_args);
+				$payment->set_status($this->_pay_model->failed_status());
+			}
+		} else {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Error occurred while trying to process the payment.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 *  Make a list of items that are in the giver transaction.
+	 *
+	 * @param EEI_Payment     $payment
+	 * @param EEI_Transaction $transaction
+	 * @param array           $request_response_args Data from a previous communication with PP.
+	 * @return array
+	 */
+	public function itemize_list(EEI_Payment $payment, EEI_Transaction $transaction, $request_response_args = array())
+	{
+		$itemized_list = array();
+		$gateway_formatter = $this->_get_gateway_formatter();
+		// If we have data from a previous communication with PP (on this transaction) we may use that for our list...
+		if (
+			! empty($request_response_args)
+			&& array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args)
+			&& array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args)
+		) {
+			foreach ($request_response_args as $arg_key => $arg_val) {
+				if (
+					strpos($arg_key, 'PAYMENTREQUEST_') !== false
+					&& strpos($arg_key, 'NOTIFYURL') === false
+				) {
+					$itemized_list[ $arg_key ] = $arg_val;
+				}
+			}
+			// If we got only a few Items then something is not right.
+			if (count($itemized_list) > 2) {
+				return $itemized_list;
+			} else {
+				if (WP_DEBUG) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								// @codingStandardsIgnoreStart
+								'Unable to continue with the checkout because a proper purchase list could not be generated. The purchased list we could have sent was %1$s',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							),
+							wp_json_encode($itemized_list)
+						)
+					);
+				}
+				// Reset the list and log an error, maybe allow to try and generate a new list (below).
+				$itemized_list = array();
+				$this->log(
+					array(
+						(string) esc_html__(
+							'Could not generate a proper item list with:',
+							'event_espresso'
+						) => $request_response_args
+					),
+					$payment
+				);
+			}
+		}
+		// ...otherwise we generate a new list for this transaction.
+		if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
+			$item_num = 0;
+			$itemized_sum = 0;
+			$total_line_items = $transaction->total_line_item();
+			// Go through each item in the list.
+			foreach ($total_line_items->get_items() as $line_item) {
+				if ($line_item instanceof EE_Line_Item) {
+					// PayPal doesn't like line items with 0.00 amount, so we may skip those.
+					if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) {
+						continue;
+					}
+					$unit_price = $line_item->unit_price();
+					$line_item_quantity = $line_item->quantity();
+					// This is a discount.
+					if ($line_item->is_percent()) {
+						$unit_price = $line_item->total();
+						$line_item_quantity = 1;
+					}
+					// Item Name.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+						$gateway_formatter->formatLineItemName($line_item, $payment),
+						0,
+						127
+					);
+					// Item description.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = mb_strcut(
+						$gateway_formatter->formatLineItemDesc($line_item, $payment),
+						0,
+						127
+					);
+					// Cost of individual item.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency($unit_price);
+					// Item Number.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+					// Item quantity.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = $line_item_quantity;
+					// Digital item is sold.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+					$itemized_sum += $line_item->total();
+					++$item_num;
+				}
+			}
+			// Item's sales S/H and tax amount.
+			$itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
+			$itemized_list['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
+			$itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+			$itemized_sum_diff_from_txn_total = round(
+				$transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
+				2
+			);
+			// If we were not able to recognize some item like promotion, surcharge or cancellation,
+			// add the difference as an extra line item.
+			if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
+				// Item Name.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+					esc_html__(
+						'Other (promotion/surcharge/cancellation)',
+						'event_espresso'
+					),
+					0,
+					127
+				);
+				// Item description.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = '';
+				// Cost of individual item.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
+					$itemized_sum_diff_from_txn_total
+				);
+				// Item Number.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+				// Item quantity.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = 1;
+				// Digital item is sold.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+				$item_num++;
+			}
+		} else {
+			// Just one Item.
+			// Item Name.
+			$itemized_list['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
+				$gateway_formatter->formatPartialPaymentLineItemName($payment),
+				0,
+				127
+			);
+			// Item description.
+			$itemized_list['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
+				$gateway_formatter->formatPartialPaymentLineItemDesc($payment),
+				0,
+				127
+			);
+			// Cost of individual item.
+			$itemized_list['L_PAYMENTREQUEST_0_AMT0'] = $gateway_formatter->formatCurrency($payment->amount());
+			// Item Number.
+			$itemized_list['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
+			// Item quantity.
+			$itemized_list['L_PAYMENTREQUEST_0_QTY0'] = 1;
+			// Digital item is sold.
+			$itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
+			// Item's sales S/H and tax amount.
+			$itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $gateway_formatter->formatCurrency($payment->amount());
+			$itemized_list['PAYMENTREQUEST_0_TAXAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+		}
+		return $itemized_list;
+	}
+
+
+
+	/**
+	 *  Make the Express checkout request.
+	 *
+	 * @param array       $request_params
+	 * @param string      $request_text
+	 * @param EEI_Payment $payment
+	 * @return mixed
+	 */
+	public function _ppExpress_request($request_params, $request_text, $payment)
+	{
+		$request_dtls = array(
+			'VERSION' => '204.0',
+			'USER' => $this->_api_username,
+			'PWD' => $this->_api_password,
+			'SIGNATURE' => $this->_api_signature,
+			// EE will blow up if you change this
+			'BUTTONSOURCE' => 'EventEspresso_SP',
+		);
+		$dtls = array_merge($request_dtls, $request_params);
+		$this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+		// Request Customer Details.
+		$request_response = wp_remote_post(
+			$this->_base_gateway_url,
+			array(
+				'method'      => 'POST',
+				'timeout'     => 45,
+				'httpversion' => '1.1',
+				'cookies'     => array(),
+				'headers'     => array(),
+				'body'        => http_build_query($dtls, '', '&'),
+			)
+		);
+		// Log the response.
+		$this->log(array($request_text . ' Response' => $request_response), $payment);
+		return $request_response;
+	}
+
+
+
+	/**
+	 *  Check the response status.
+	 *
+	 * @param mixed $request_response
+	 * @return array
+	 */
+	public function _ppExpress_check_response($request_response)
+	{
+		if (is_wp_error($request_response) || empty($request_response['body'])) {
+			// If we got here then there was an error in this request.
+			return array('status' => false, 'args' => $request_response);
+		}
+		$response_args = array();
+		parse_str(urldecode($request_response['body']), $response_args);
+		if (! isset($response_args['ACK'])) {
+			return array('status' => false, 'args' => $request_response);
+		}
+		if (
+			(
+				isset($response_args['PAYERID'])
+				|| isset($response_args['TOKEN'])
+				|| isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
+				|| (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
+			)
+			&& in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
+		) {
+			// Response status OK, return response parameters for further processing.
+			return array('status' => true, 'args' => $response_args);
+		}
+		$errors = $this->_get_errors($response_args);
+		return array('status' => false, 'args' => $errors);
+	}
+
+
+
+	/**
+	 *  Log a "Cleared" request.
+	 *
+	 * @param array       $request
+	 * @param EEI_Payment $payment
+	 * @param string      $info
+	 * @return void
+	 */
+	private function _log_clean_request($request, $payment, $info)
+	{
+		$cleaned_request_data = $request;
+		unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
+		$this->log(array($info => $cleaned_request_data), $payment);
+	}
+
+
+
+	/**
+	 *  Get error from the response data.
+	 *
+	 * @param array $data_array
+	 * @return array
+	 */
+	private function _get_errors($data_array)
+	{
+		$errors = array();
+		$n = 0;
+		while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
+			$l_error_code = isset($data_array[ "L_ERRORCODE{$n}" ])
+				? $data_array[ "L_ERRORCODE{$n}" ]
+				: '';
+			$l_severity_code = isset($data_array[ "L_SEVERITYCODE{$n}" ])
+				? $data_array[ "L_SEVERITYCODE{$n}" ]
+				: '';
+			$l_short_message = isset($data_array[ "L_SHORTMESSAGE{$n}" ])
+				? $data_array[ "L_SHORTMESSAGE{$n}" ]
+				: '';
+			$l_long_message = isset($data_array[ "L_LONGMESSAGE{$n}" ])
+				? $data_array[ "L_LONGMESSAGE{$n}" ]
+				: '';
+			if ($n === 0) {
+				$errors = array(
+					'L_ERRORCODE'    => $l_error_code,
+					'L_SHORTMESSAGE' => $l_short_message,
+					'L_LONGMESSAGE'  => $l_long_message,
+					'L_SEVERITYCODE' => $l_severity_code,
+				);
+			} else {
+				$errors['L_ERRORCODE'] .= ', ' . $l_error_code;
+				$errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
+				$errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
+				$errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+			}
+			$n++;
+		}
+		return $errors;
+	}
 }

Spacing +37 added lines, -37 removed lines

@@ -12,7 +12,7 @@ 
  */
 
 // Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
-if (! function_exists('mb_strcut')) {
+if ( ! function_exists('mb_strcut')) {
     /**
      * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
      * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
@@ -143,7 +143,7 @@ 
         $notify_url = null,
         $cancel_url = null
     ) {
-        if (! $payment instanceof EEI_Payment) {
+        if ( ! $payment instanceof EEI_Payment) {
             $payment->set_gateway_response(
                 esc_html__(
                     'Error. No associated payment was found.',
@@ -154,7 +154,7 @@ 
             return $payment;
         }
         $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
+        if ( ! $transaction instanceof EEI_Transaction) {
             $payment->set_gateway_response(
                 esc_html__(
                     'Could not process this payment because it has no associated transaction.',
@@ -201,13 +201,13 @@ 
             $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
             $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
             $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-        } elseif (! $this->_request_shipping_addr) {
+        } elseif ( ! $this->_request_shipping_addr) {
             // Do not request shipping details on the PP Checkout page.
             $token_request_dtls['NOSHIPPING'] = '1';
             $token_request_dtls['REQCONFIRMSHIPPING'] = '0';
         }
         // Used a business/personal logo on the PayPal page.
-        if (! empty($this->_image_url)) {
+        if ( ! empty($this->_image_url)) {
             $token_request_dtls['LOGOIMG'] = $this->_image_url;
         }
         $token_request_dtls = apply_filters(
@@ -232,7 +232,7 @@ 
             );
         } else {
             if (isset($response_args['L_ERRORCODE'])) {
-                $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
+                $payment->set_gateway_response($response_args['L_ERRORCODE'].'; '.$response_args['L_SHORTMESSAGE']);
             } else {
                 $payment->set_gateway_response(
                     esc_html__(
@@ -263,7 +263,7 @@ 
         if ($payment instanceof EEI_Payment) {
             $this->log(array('Return from Authorization' => $update_info), $payment);
             $transaction = $payment->transaction();
-            if (! $transaction instanceof EEI_Transaction) {
+            if ( ! $transaction instanceof EEI_Transaction) {
                 $payment->set_gateway_response(
                     esc_html__(
                         'Could not process this payment because it has no associated transaction.',
@@ -276,7 +276,7 @@ 
             $primary_registrant = $transaction->primary_registration();
             $payment_details = $payment->details();
             // Check if we still have the token.
-            if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+            if ( ! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
                 $payment->set_status($this->_pay_model->failed_status());
                 return $payment;
             }
@@ -411,7 +411,7 @@ 
                     strpos($arg_key, 'PAYMENTREQUEST_') !== false
                     && strpos($arg_key, 'NOTIFYURL') === false
                 ) {
-                    $itemized_list[ $arg_key ] = $arg_val;
+                    $itemized_list[$arg_key] = $arg_val;
                 }
             }
             // If we got only a few Items then something is not right.
@@ -464,25 +464,25 @@ 
                         $line_item_quantity = 1;
                     }
                     // Item Name.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+                    $itemized_list['L_PAYMENTREQUEST_0_NAME'.$item_num] = mb_strcut(
                         $gateway_formatter->formatLineItemName($line_item, $payment),
                         0,
                         127
                     );
                     // Item description.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = mb_strcut(
+                    $itemized_list['L_PAYMENTREQUEST_0_DESC'.$item_num] = mb_strcut(
                         $gateway_formatter->formatLineItemDesc($line_item, $payment),
                         0,
                         127
                     );
                     // Cost of individual item.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency($unit_price);
+                    $itemized_list['L_PAYMENTREQUEST_0_AMT'.$item_num] = $gateway_formatter->formatCurrency($unit_price);
                     // Item Number.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+                    $itemized_list['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
                     // Item quantity.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = $line_item_quantity;
+                    $itemized_list['L_PAYMENTREQUEST_0_QTY'.$item_num] = $line_item_quantity;
                     // Digital item is sold.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+                    $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
                     $itemized_sum += $line_item->total();
                     ++$item_num;
                 }
@@ -500,7 +500,7 @@ 
             // add the difference as an extra line item.
             if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
                 // Item Name.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+                $itemized_list['L_PAYMENTREQUEST_0_NAME'.$item_num] = mb_strcut(
                     esc_html__(
                         'Other (promotion/surcharge/cancellation)',
                         'event_espresso'
@@ -509,17 +509,17 @@ 
                     127
                 );
                 // Item description.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = '';
+                $itemized_list['L_PAYMENTREQUEST_0_DESC'.$item_num] = '';
                 // Cost of individual item.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
+                $itemized_list['L_PAYMENTREQUEST_0_AMT'.$item_num] = $gateway_formatter->formatCurrency(
                     $itemized_sum_diff_from_txn_total
                 );
                 // Item Number.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+                $itemized_list['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
                 // Item quantity.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = 1;
+                $itemized_list['L_PAYMENTREQUEST_0_QTY'.$item_num] = 1;
                 // Digital item is sold.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+                $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
                 $item_num++;
             }
         } else {
@@ -574,7 +574,7 @@ 
             'BUTTONSOURCE' => 'EventEspresso_SP',
         );
         $dtls = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+        $this->_log_clean_request($dtls, $payment, $request_text.' Request');
         // Request Customer Details.
         $request_response = wp_remote_post(
             $this->_base_gateway_url,
@@ -588,7 +588,7 @@ 
             )
         );
         // Log the response.
-        $this->log(array($request_text . ' Response' => $request_response), $payment);
+        $this->log(array($request_text.' Response' => $request_response), $payment);
         return $request_response;
     }
 
@@ -608,7 +608,7 @@ 
         }
         $response_args = array();
         parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
+        if ( ! isset($response_args['ACK'])) {
             return array('status' => false, 'args' => $request_response);
         }
         if (
@@ -656,18 +656,18 @@ 
     {
         $errors = array();
         $n = 0;
-        while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
-            $l_error_code = isset($data_array[ "L_ERRORCODE{$n}" ])
-                ? $data_array[ "L_ERRORCODE{$n}" ]
+        while (isset($data_array["L_ERRORCODE{$n}"])) {
+            $l_error_code = isset($data_array["L_ERRORCODE{$n}"])
+                ? $data_array["L_ERRORCODE{$n}"]
                 : '';
-            $l_severity_code = isset($data_array[ "L_SEVERITYCODE{$n}" ])
-                ? $data_array[ "L_SEVERITYCODE{$n}" ]
+            $l_severity_code = isset($data_array["L_SEVERITYCODE{$n}"])
+                ? $data_array["L_SEVERITYCODE{$n}"]
                 : '';
-            $l_short_message = isset($data_array[ "L_SHORTMESSAGE{$n}" ])
-                ? $data_array[ "L_SHORTMESSAGE{$n}" ]
+            $l_short_message = isset($data_array["L_SHORTMESSAGE{$n}"])
+                ? $data_array["L_SHORTMESSAGE{$n}"]
                 : '';
-            $l_long_message = isset($data_array[ "L_LONGMESSAGE{$n}" ])
-                ? $data_array[ "L_LONGMESSAGE{$n}" ]
+            $l_long_message = isset($data_array["L_LONGMESSAGE{$n}"])
+                ? $data_array["L_LONGMESSAGE{$n}"]
                 : '';
             if ($n === 0) {
                 $errors = array(
@@ -677,10 +677,10 @@ 
                     'L_SEVERITYCODE' => $l_severity_code,
                 );
             } else {
-                $errors['L_ERRORCODE'] .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+                $errors['L_ERRORCODE'] .= ', '.$l_error_code;
+                $errors['L_SHORTMESSAGE'] .= ', '.$l_short_message;
+                $errors['L_LONGMESSAGE'] .= ', '.$l_long_message;
+                $errors['L_SEVERITYCODE'] .= ', '.$l_severity_code;
             }
             $n++;
         }

caffeinated/admin/extend/registrations/Extend_Registrations_Admin_Page.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -924,7 +924,7 @@
      * handles toggling the checkin status for the registration,
      *
      * @access protected
-     * @return int|void
+     * @return integer
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException

Indentation +1212 added lines, -1212 removed lines

@@ -16,1269 +16,1269 @@
 {
 
 
-    /**
-     * This is used to hold the reports template data which is setup early in the request.
-     *
-     * @type array
-     */
-    protected $_reports_template_data = array();
+	/**
+	 * This is used to hold the reports template data which is setup early in the request.
+	 *
+	 * @type array
+	 */
+	protected $_reports_template_data = array();
 
 
-    /**
-     * Extend_Registrations_Admin_Page constructor.
-     *
-     * @param bool $routing
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        if (! defined('REG_CAF_TEMPLATE_PATH')) {
-            define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/');
-            define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/');
-            define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/');
-        }
-    }
+	/**
+	 * Extend_Registrations_Admin_Page constructor.
+	 *
+	 * @param bool $routing
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		if (! defined('REG_CAF_TEMPLATE_PATH')) {
+			define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/');
+			define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/');
+			define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/');
+		}
+	}
 
 
-    /**
-     * Extending page configuration.
-     */
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations';
-        $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
-            ? $this->_req_data['_REG_ID']
-            : 0;
-        $new_page_routes = array(
-            'reports'                      => array(
-                'func'       => '_registration_reports',
-                'capability' => 'ee_read_registrations',
-            ),
-            'registration_checkins'        => array(
-                'func'       => '_registration_checkin_list_table',
-                'capability' => 'ee_read_checkins',
-            ),
-            'newsletter_selected_send'     => array(
-                'func'       => '_newsletter_selected_send',
-                'noheader'   => true,
-                'capability' => 'ee_send_message',
-            ),
-            'delete_checkin_rows'          => array(
-                'func'       => '_delete_checkin_rows',
-                'noheader'   => true,
-                'capability' => 'ee_delete_checkins',
-            ),
-            'delete_checkin_row'           => array(
-                'func'       => '_delete_checkin_row',
-                'noheader'   => true,
-                'capability' => 'ee_delete_checkin',
-                'obj_id'     => $reg_id,
-            ),
-            'toggle_checkin_status'        => array(
-                'func'       => '_toggle_checkin_status',
-                'noheader'   => true,
-                'capability' => 'ee_edit_checkin',
-                'obj_id'     => $reg_id,
-            ),
-            'toggle_checkin_status_bulk'   => array(
-                'func'       => '_toggle_checkin_status',
-                'noheader'   => true,
-                'capability' => 'ee_edit_checkins',
-            ),
-            'event_registrations'          => array(
-                'func'       => '_event_registrations_list_table',
-                'capability' => 'ee_read_checkins',
-            ),
-            'registrations_checkin_report' => array(
-                'func'       => '_registrations_checkin_report',
-                'noheader'   => true,
-                'capability' => 'ee_read_registrations',
-            ),
-        );
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-        $new_page_config = array(
-            'reports'               => array(
-                'nav'           => array(
-                    'label' => esc_html__('Reports', 'event_espresso'),
-                    'order' => 30,
-                ),
-                'help_tabs'     => array(
-                    'registrations_reports_help_tab' => array(
-                        'title'    => esc_html__('Registration Reports', 'event_espresso'),
-                        'filename' => 'registrations_reports',
-                    ),
-                ),
-                /*'help_tour' => array( 'Registration_Reports_Help_Tour' ),*/
-                'require_nonce' => false,
-            ),
-            'event_registrations'   => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Event Check-In', 'event_espresso'),
-                    'order'      => 10,
-                    'persistent' => true,
-                ),
-                'help_tabs'     => array(
-                    'registrations_event_checkin_help_tab'                       => array(
-                        'title'    => esc_html__('Registrations Event Check-In', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin',
-                    ),
-                    'registrations_event_checkin_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Event Check-In Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_table_column_headings',
-                    ),
-                    'registrations_event_checkin_filters_help_tab'               => array(
-                        'title'    => esc_html__('Event Check-In Filters', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_filters',
-                    ),
-                    'registrations_event_checkin_views_help_tab'                 => array(
-                        'title'    => esc_html__('Event Check-In Views', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_views',
-                    ),
-                    'registrations_event_checkin_other_help_tab'                 => array(
-                        'title'    => esc_html__('Event Check-In Other', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_other',
-                    ),
-                ),
-                'help_tour'     => array('Event_Checkin_Help_Tour'),
-                'qtips'         => array('Registration_List_Table_Tips'),
-                'list_table'    => 'EE_Event_Registrations_List_Table',
-                'metaboxes'     => array(),
-                'require_nonce' => false,
-            ),
-            'registration_checkins' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Check-In Records', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => '',
-                ),
-                'list_table'    => 'EE_Registration_CheckIn_List_Table',
-                // 'help_tour' => array( 'Checkin_Toggle_View_Help_Tour' ),
-                'metaboxes'     => array(),
-                'require_nonce' => false,
-            ),
-        );
-        $this->_page_config = array_merge($this->_page_config, $new_page_config);
-        $this->_page_config['contact_list']['list_table'] = 'Extend_EE_Attendee_Contact_List_Table';
-        $this->_page_config['default']['list_table'] = 'Extend_EE_Registrations_List_Table';
-    }
+	/**
+	 * Extending page configuration.
+	 */
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations';
+		$reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
+			? $this->_req_data['_REG_ID']
+			: 0;
+		$new_page_routes = array(
+			'reports'                      => array(
+				'func'       => '_registration_reports',
+				'capability' => 'ee_read_registrations',
+			),
+			'registration_checkins'        => array(
+				'func'       => '_registration_checkin_list_table',
+				'capability' => 'ee_read_checkins',
+			),
+			'newsletter_selected_send'     => array(
+				'func'       => '_newsletter_selected_send',
+				'noheader'   => true,
+				'capability' => 'ee_send_message',
+			),
+			'delete_checkin_rows'          => array(
+				'func'       => '_delete_checkin_rows',
+				'noheader'   => true,
+				'capability' => 'ee_delete_checkins',
+			),
+			'delete_checkin_row'           => array(
+				'func'       => '_delete_checkin_row',
+				'noheader'   => true,
+				'capability' => 'ee_delete_checkin',
+				'obj_id'     => $reg_id,
+			),
+			'toggle_checkin_status'        => array(
+				'func'       => '_toggle_checkin_status',
+				'noheader'   => true,
+				'capability' => 'ee_edit_checkin',
+				'obj_id'     => $reg_id,
+			),
+			'toggle_checkin_status_bulk'   => array(
+				'func'       => '_toggle_checkin_status',
+				'noheader'   => true,
+				'capability' => 'ee_edit_checkins',
+			),
+			'event_registrations'          => array(
+				'func'       => '_event_registrations_list_table',
+				'capability' => 'ee_read_checkins',
+			),
+			'registrations_checkin_report' => array(
+				'func'       => '_registrations_checkin_report',
+				'noheader'   => true,
+				'capability' => 'ee_read_registrations',
+			),
+		);
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+		$new_page_config = array(
+			'reports'               => array(
+				'nav'           => array(
+					'label' => esc_html__('Reports', 'event_espresso'),
+					'order' => 30,
+				),
+				'help_tabs'     => array(
+					'registrations_reports_help_tab' => array(
+						'title'    => esc_html__('Registration Reports', 'event_espresso'),
+						'filename' => 'registrations_reports',
+					),
+				),
+				/*'help_tour' => array( 'Registration_Reports_Help_Tour' ),*/
+				'require_nonce' => false,
+			),
+			'event_registrations'   => array(
+				'nav'           => array(
+					'label'      => esc_html__('Event Check-In', 'event_espresso'),
+					'order'      => 10,
+					'persistent' => true,
+				),
+				'help_tabs'     => array(
+					'registrations_event_checkin_help_tab'                       => array(
+						'title'    => esc_html__('Registrations Event Check-In', 'event_espresso'),
+						'filename' => 'registrations_event_checkin',
+					),
+					'registrations_event_checkin_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Event Check-In Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_table_column_headings',
+					),
+					'registrations_event_checkin_filters_help_tab'               => array(
+						'title'    => esc_html__('Event Check-In Filters', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_filters',
+					),
+					'registrations_event_checkin_views_help_tab'                 => array(
+						'title'    => esc_html__('Event Check-In Views', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_views',
+					),
+					'registrations_event_checkin_other_help_tab'                 => array(
+						'title'    => esc_html__('Event Check-In Other', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_other',
+					),
+				),
+				'help_tour'     => array('Event_Checkin_Help_Tour'),
+				'qtips'         => array('Registration_List_Table_Tips'),
+				'list_table'    => 'EE_Event_Registrations_List_Table',
+				'metaboxes'     => array(),
+				'require_nonce' => false,
+			),
+			'registration_checkins' => array(
+				'nav'           => array(
+					'label'      => esc_html__('Check-In Records', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => '',
+				),
+				'list_table'    => 'EE_Registration_CheckIn_List_Table',
+				// 'help_tour' => array( 'Checkin_Toggle_View_Help_Tour' ),
+				'metaboxes'     => array(),
+				'require_nonce' => false,
+			),
+		);
+		$this->_page_config = array_merge($this->_page_config, $new_page_config);
+		$this->_page_config['contact_list']['list_table'] = 'Extend_EE_Attendee_Contact_List_Table';
+		$this->_page_config['default']['list_table'] = 'Extend_EE_Registrations_List_Table';
+	}
 
 
-    /**
-     * Ajax hooks for all routes in this page.
-     */
-    protected function _ajax_hooks()
-    {
-        parent::_ajax_hooks();
-        add_action('wp_ajax_get_newsletter_form_content', array($this, 'get_newsletter_form_content'));
-    }
+	/**
+	 * Ajax hooks for all routes in this page.
+	 */
+	protected function _ajax_hooks()
+	{
+		parent::_ajax_hooks();
+		add_action('wp_ajax_get_newsletter_form_content', array($this, 'get_newsletter_form_content'));
+	}
 
 
-    /**
-     * Global scripts for all routes in this page.
-     */
-    public function load_scripts_styles()
-    {
-        parent::load_scripts_styles();
-        // if newsletter message type is active then let's add filter and load js for it.
-        if (EEH_MSG_Template::is_mt_active('newsletter')) {
-            // enqueue newsletter js
-            wp_enqueue_script(
-                'ee-newsletter-trigger',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
-                array('ee-dialog'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_style(
-                'ee-newsletter-trigger-css',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css',
-                array(),
-                EVENT_ESPRESSO_VERSION
-            );
-            // hook in buttons for newsletter message type trigger.
-            add_action(
-                'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons',
-                array($this, 'add_newsletter_action_buttons'),
-                10
-            );
-        }
-    }
+	/**
+	 * Global scripts for all routes in this page.
+	 */
+	public function load_scripts_styles()
+	{
+		parent::load_scripts_styles();
+		// if newsletter message type is active then let's add filter and load js for it.
+		if (EEH_MSG_Template::is_mt_active('newsletter')) {
+			// enqueue newsletter js
+			wp_enqueue_script(
+				'ee-newsletter-trigger',
+				REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
+				array('ee-dialog'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_style(
+				'ee-newsletter-trigger-css',
+				REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css',
+				array(),
+				EVENT_ESPRESSO_VERSION
+			);
+			// hook in buttons for newsletter message type trigger.
+			add_action(
+				'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons',
+				array($this, 'add_newsletter_action_buttons'),
+				10
+			);
+		}
+	}
 
 
-    /**
-     * Scripts and styles for just the reports route.
-     */
-    public function load_scripts_styles_reports()
-    {
-        wp_register_script(
-            'ee-reg-reports-js',
-            REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
-            array('google-charts'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-reg-reports-js');
-        $this->_registration_reports_js_setup();
-    }
+	/**
+	 * Scripts and styles for just the reports route.
+	 */
+	public function load_scripts_styles_reports()
+	{
+		wp_register_script(
+			'ee-reg-reports-js',
+			REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
+			array('google-charts'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-reg-reports-js');
+		$this->_registration_reports_js_setup();
+	}
 
 
-    /**
-     * Register screen options for event_registrations route.
-     */
-    protected function _add_screen_options_event_registrations()
-    {
-        $this->_per_page_screen_option();
-    }
+	/**
+	 * Register screen options for event_registrations route.
+	 */
+	protected function _add_screen_options_event_registrations()
+	{
+		$this->_per_page_screen_option();
+	}
 
 
-    /**
-     * Register screen options for registration_checkins route
-     */
-    protected function _add_screen_options_registration_checkins()
-    {
-        $page_title = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Check-In Records', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
+	/**
+	 * Register screen options for registration_checkins route
+	 */
+	protected function _add_screen_options_registration_checkins()
+	{
+		$page_title = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Check-In Records', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
 
 
-    /**
-     * Set views property for event_registrations route.
-     */
-    protected function _set_list_table_views_event_registrations()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => ! isset($this->_req_data['event_id'])
-                    ? array()
-                    : array(
-                        'toggle_checkin_status_bulk' => esc_html__('Toggle Check-In', 'event_espresso'),
-                    ),
-            ),
-        );
-    }
+	/**
+	 * Set views property for event_registrations route.
+	 */
+	protected function _set_list_table_views_event_registrations()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => ! isset($this->_req_data['event_id'])
+					? array()
+					: array(
+						'toggle_checkin_status_bulk' => esc_html__('Toggle Check-In', 'event_espresso'),
+					),
+			),
+		);
+	}
 
 
-    /**
-     * Set views property for registration_checkins route.
-     */
-    protected function _set_list_table_views_registration_checkins()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array('delete_checkin_rows' => esc_html__('Delete Check-In Rows', 'event_espresso')),
-            ),
-        );
-    }
+	/**
+	 * Set views property for registration_checkins route.
+	 */
+	protected function _set_list_table_views_registration_checkins()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array('delete_checkin_rows' => esc_html__('Delete Check-In Rows', 'event_espresso')),
+			),
+		);
+	}
 
 
-    /**
-     * callback for ajax action.
-     *
-     * @since 4.3.0
-     * @return void (JSON)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_newsletter_form_content()
-    {
-        // do a nonce check cause we're not coming in from an normal route here.
-        $nonce = isset($this->_req_data['get_newsletter_form_content_nonce']) ? sanitize_text_field(
-            $this->_req_data['get_newsletter_form_content_nonce']
-        ) : '';
-        $nonce_ref = 'get_newsletter_form_content_nonce';
-        $this->_verify_nonce($nonce, $nonce_ref);
-        // let's get the mtp for the incoming MTP_ ID
-        if (! isset($this->_req_data['GRP_ID'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['success'] = false;
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-        $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']);
-        if (! $MTPG instanceof EE_Message_Template_Group) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The GRP_ID given (%d) does not appear to have a corresponding row in the database.',
-                        'event_espresso'
-                    ),
-                    $this->_req_data['GRP_ID']
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['success'] = false;
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-        $MTPs = $MTPG->context_templates();
-        $MTPs = $MTPs['attendee'];
-        $template_fields = array();
-        /** @var EE_Message_Template $MTP */
-        foreach ($MTPs as $MTP) {
-            $field = $MTP->get('MTP_template_field');
-            if ($field === 'content') {
-                $content = $MTP->get('MTP_content');
-                if (! empty($content['newsletter_content'])) {
-                    $template_fields['newsletter_content'] = $content['newsletter_content'];
-                }
-                continue;
-            }
-            $template_fields[ $MTP->get('MTP_template_field') ] = $MTP->get('MTP_content');
-        }
-        $this->_template_args['success'] = true;
-        $this->_template_args['error'] = false;
-        $this->_template_args['data'] = array(
-            'batch_message_from'    => isset($template_fields['from'])
-                ? $template_fields['from']
-                : '',
-            'batch_message_subject' => isset($template_fields['subject'])
-                ? $template_fields['subject']
-                : '',
-            'batch_message_content' => isset($template_fields['newsletter_content'])
-                ? $template_fields['newsletter_content']
-                : '',
-        );
-        $this->_return_json();
-    }
+	/**
+	 * callback for ajax action.
+	 *
+	 * @since 4.3.0
+	 * @return void (JSON)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_newsletter_form_content()
+	{
+		// do a nonce check cause we're not coming in from an normal route here.
+		$nonce = isset($this->_req_data['get_newsletter_form_content_nonce']) ? sanitize_text_field(
+			$this->_req_data['get_newsletter_form_content_nonce']
+		) : '';
+		$nonce_ref = 'get_newsletter_form_content_nonce';
+		$this->_verify_nonce($nonce, $nonce_ref);
+		// let's get the mtp for the incoming MTP_ ID
+		if (! isset($this->_req_data['GRP_ID'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['success'] = false;
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+		$MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']);
+		if (! $MTPG instanceof EE_Message_Template_Group) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The GRP_ID given (%d) does not appear to have a corresponding row in the database.',
+						'event_espresso'
+					),
+					$this->_req_data['GRP_ID']
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['success'] = false;
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+		$MTPs = $MTPG->context_templates();
+		$MTPs = $MTPs['attendee'];
+		$template_fields = array();
+		/** @var EE_Message_Template $MTP */
+		foreach ($MTPs as $MTP) {
+			$field = $MTP->get('MTP_template_field');
+			if ($field === 'content') {
+				$content = $MTP->get('MTP_content');
+				if (! empty($content['newsletter_content'])) {
+					$template_fields['newsletter_content'] = $content['newsletter_content'];
+				}
+				continue;
+			}
+			$template_fields[ $MTP->get('MTP_template_field') ] = $MTP->get('MTP_content');
+		}
+		$this->_template_args['success'] = true;
+		$this->_template_args['error'] = false;
+		$this->_template_args['data'] = array(
+			'batch_message_from'    => isset($template_fields['from'])
+				? $template_fields['from']
+				: '',
+			'batch_message_subject' => isset($template_fields['subject'])
+				? $template_fields['subject']
+				: '',
+			'batch_message_content' => isset($template_fields['newsletter_content'])
+				? $template_fields['newsletter_content']
+				: '',
+		);
+		$this->_return_json();
+	}
 
 
-    /**
-     * callback for AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons action
-     *
-     * @since 4.3.0
-     * @param EE_Admin_List_Table $list_table
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function add_newsletter_action_buttons(EE_Admin_List_Table $list_table)
-    {
-        if (
-            ! EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_registrations_newsletter_selected_send'
-            )
-        ) {
-            return;
-        }
-        $routes_to_add_to = array(
-            'contact_list',
-            'event_registrations',
-            'default',
-        );
-        if ($this->_current_page === 'espresso_registrations' && in_array($this->_req_action, $routes_to_add_to)) {
-            if (
-                ($this->_req_action === 'event_registrations' && empty($this->_req_data['event_id']))
-                || (isset($this->_req_data['status']) && $this->_req_data['status'] === 'trash')
-            ) {
-                echo '';
-            } else {
-                $button_text = sprintf(
-                    esc_html__('Send Batch Message (%s selected)', 'event_espresso'),
-                    '<span class="send-selected-newsletter-count">0</span>'
-                );
-                echo '<button id="selected-batch-send-trigger" class="button secondary-button">'
-                     . '<span class="dashicons dashicons-email "></span>'
-                     . $button_text
-                     . '</button>';
-                add_action('admin_footer', array($this, 'newsletter_send_form_skeleton'));
-            }
-        }
-    }
+	/**
+	 * callback for AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons action
+	 *
+	 * @since 4.3.0
+	 * @param EE_Admin_List_Table $list_table
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function add_newsletter_action_buttons(EE_Admin_List_Table $list_table)
+	{
+		if (
+			! EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_registrations_newsletter_selected_send'
+			)
+		) {
+			return;
+		}
+		$routes_to_add_to = array(
+			'contact_list',
+			'event_registrations',
+			'default',
+		);
+		if ($this->_current_page === 'espresso_registrations' && in_array($this->_req_action, $routes_to_add_to)) {
+			if (
+				($this->_req_action === 'event_registrations' && empty($this->_req_data['event_id']))
+				|| (isset($this->_req_data['status']) && $this->_req_data['status'] === 'trash')
+			) {
+				echo '';
+			} else {
+				$button_text = sprintf(
+					esc_html__('Send Batch Message (%s selected)', 'event_espresso'),
+					'<span class="send-selected-newsletter-count">0</span>'
+				);
+				echo '<button id="selected-batch-send-trigger" class="button secondary-button">'
+					 . '<span class="dashicons dashicons-email "></span>'
+					 . $button_text
+					 . '</button>';
+				add_action('admin_footer', array($this, 'newsletter_send_form_skeleton'));
+			}
+		}
+	}
 
 
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function newsletter_send_form_skeleton()
-    {
-        $list_table = $this->_list_table_object;
-        $codes = array();
-        // need to templates for the newsletter message type for the template selector.
-        $values[] = array('text' => esc_html__('Select Template to Use', 'event_espresso'), 'id' => 0);
-        $mtps = EEM_Message_Template_Group::instance()->get_all(
-            array(array('MTP_message_type' => 'newsletter', 'MTP_messenger' => 'email'))
-        );
-        foreach ($mtps as $mtp) {
-            $name = $mtp->name();
-            $values[] = array(
-                'text' => empty($name) ? esc_html__('Global', 'event_espresso') : $name,
-                'id'   => $mtp->ID(),
-            );
-        }
-        // need to get a list of shortcodes that are available for the newsletter message type.
-        $shortcodes = EEH_MSG_Template::get_shortcodes(
-            'newsletter',
-            'email',
-            array(),
-            'attendee',
-            false
-        );
-        foreach ($shortcodes as $field => $shortcode_array) {
-            $available_shortcodes = array();
-            foreach ($shortcode_array as $shortcode => $shortcode_details) {
-                $field_id = $field === '[NEWSLETTER_CONTENT]'
-                    ? 'content'
-                    : $field;
-                $field_id = 'batch-message-' . strtolower($field_id);
-                $available_shortcodes[] = '<span class="js-shortcode-selection" data-value="'
-                                          . $shortcode
-                                          . '" data-linked-input-id="' . $field_id . '">'
-                                          . $shortcode
-                                          . '</span>';
-            }
-            $codes[ $field ] = implode(', ', $available_shortcodes);
-        }
-        $shortcodes = $codes;
-        $form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php';
-        $form_template_args = array(
-            'form_action'       => admin_url('admin.php?page=espresso_registrations'),
-            'form_route'        => 'newsletter_selected_send',
-            'form_nonce_name'   => 'newsletter_selected_send_nonce',
-            'form_nonce'        => wp_create_nonce('newsletter_selected_send_nonce'),
-            'redirect_back_to'  => $this->_req_action,
-            'ajax_nonce'        => wp_create_nonce('get_newsletter_form_content_nonce'),
-            'template_selector' => EEH_Form_Fields::select_input('newsletter_mtp_selected', $values),
-            'shortcodes'        => $shortcodes,
-            'id_type'           => $list_table instanceof EE_Attendee_Contact_List_Table ? 'contact' : 'registration',
-        );
-        EEH_Template::display_template($form_template, $form_template_args);
-    }
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function newsletter_send_form_skeleton()
+	{
+		$list_table = $this->_list_table_object;
+		$codes = array();
+		// need to templates for the newsletter message type for the template selector.
+		$values[] = array('text' => esc_html__('Select Template to Use', 'event_espresso'), 'id' => 0);
+		$mtps = EEM_Message_Template_Group::instance()->get_all(
+			array(array('MTP_message_type' => 'newsletter', 'MTP_messenger' => 'email'))
+		);
+		foreach ($mtps as $mtp) {
+			$name = $mtp->name();
+			$values[] = array(
+				'text' => empty($name) ? esc_html__('Global', 'event_espresso') : $name,
+				'id'   => $mtp->ID(),
+			);
+		}
+		// need to get a list of shortcodes that are available for the newsletter message type.
+		$shortcodes = EEH_MSG_Template::get_shortcodes(
+			'newsletter',
+			'email',
+			array(),
+			'attendee',
+			false
+		);
+		foreach ($shortcodes as $field => $shortcode_array) {
+			$available_shortcodes = array();
+			foreach ($shortcode_array as $shortcode => $shortcode_details) {
+				$field_id = $field === '[NEWSLETTER_CONTENT]'
+					? 'content'
+					: $field;
+				$field_id = 'batch-message-' . strtolower($field_id);
+				$available_shortcodes[] = '<span class="js-shortcode-selection" data-value="'
+										  . $shortcode
+										  . '" data-linked-input-id="' . $field_id . '">'
+										  . $shortcode
+										  . '</span>';
+			}
+			$codes[ $field ] = implode(', ', $available_shortcodes);
+		}
+		$shortcodes = $codes;
+		$form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php';
+		$form_template_args = array(
+			'form_action'       => admin_url('admin.php?page=espresso_registrations'),
+			'form_route'        => 'newsletter_selected_send',
+			'form_nonce_name'   => 'newsletter_selected_send_nonce',
+			'form_nonce'        => wp_create_nonce('newsletter_selected_send_nonce'),
+			'redirect_back_to'  => $this->_req_action,
+			'ajax_nonce'        => wp_create_nonce('get_newsletter_form_content_nonce'),
+			'template_selector' => EEH_Form_Fields::select_input('newsletter_mtp_selected', $values),
+			'shortcodes'        => $shortcodes,
+			'id_type'           => $list_table instanceof EE_Attendee_Contact_List_Table ? 'contact' : 'registration',
+		);
+		EEH_Template::display_template($form_template, $form_template_args);
+	}
 
 
-    /**
-     * Handles sending selected registrations/contacts a newsletter.
-     *
-     * @since  4.3.0
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _newsletter_selected_send()
-    {
-        $success = true;
-        // first we need to make sure we have a GRP_ID so we know what template we're sending and updating!
-        if (empty($this->_req_data['newsletter_mtp_selected'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'In order to send a message, a Message Template GRP_ID is needed. It was not provided so messages were not sent.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        if ($success) {
-            // update Message template in case there are any changes
-            $Message_Template_Group = EEM_Message_Template_Group::instance()->get_one_by_ID(
-                $this->_req_data['newsletter_mtp_selected']
-            );
-            $Message_Templates = $Message_Template_Group instanceof EE_Message_Template_Group
-                ? $Message_Template_Group->context_templates()
-                : array();
-            if (empty($Message_Templates)) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'Unable to retrieve message template fields from the db. Messages not sent.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            // let's just update the specific fields
-            foreach ($Message_Templates['attendee'] as $Message_Template) {
-                if ($Message_Template instanceof EE_Message_Template) {
-                    $field = $Message_Template->get('MTP_template_field');
-                    $content = $Message_Template->get('MTP_content');
-                    $new_content = $content;
-                    switch ($field) {
-                        case 'from':
-                            $new_content = ! empty($this->_req_data['batch_message']['from'])
-                                ? $this->_req_data['batch_message']['from']
-                                : $content;
-                            break;
-                        case 'subject':
-                            $new_content = ! empty($this->_req_data['batch_message']['subject'])
-                                ? $this->_req_data['batch_message']['subject']
-                                : $content;
-                            break;
-                        case 'content':
-                            $new_content = $content;
-                            $new_content['newsletter_content'] = ! empty($this->_req_data['batch_message']['content'])
-                                ? $this->_req_data['batch_message']['content']
-                                : $content['newsletter_content'];
-                            break;
-                        default:
-                            // continue the foreach loop, we don't want to set $new_content nor save.
-                            continue 2;
-                    }
-                    $Message_Template->set('MTP_content', $new_content);
-                    $Message_Template->save();
-                }
-            }
-            // great fields are updated!  now let's make sure we just have contact objects (EE_Attendee).
-            $id_type = ! empty($this->_req_data['batch_message']['id_type'])
-                ? $this->_req_data['batch_message']['id_type']
-                : 'registration';
-            // id_type will affect how we assemble the ids.
-            $ids = ! empty($this->_req_data['batch_message']['ids'])
-                ? json_decode(stripslashes($this->_req_data['batch_message']['ids']))
-                : array();
-            $registrations_used_for_contact_data = array();
-            // using switch because eventually we'll have other contexts that will be used for generating messages.
-            switch ($id_type) {
-                case 'registration':
-                    $registrations_used_for_contact_data = EEM_Registration::instance()->get_all(
-                        array(
-                            array(
-                                'REG_ID' => array('IN', $ids),
-                            ),
-                        )
-                    );
-                    break;
-                case 'contact':
-                    $registrations_used_for_contact_data = EEM_Registration::instance()
-                                                                           ->get_latest_registration_for_each_of_given_contacts(
-                                                                               $ids
-                                                                           );
-                    break;
-            }
-            do_action_ref_array(
-                'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
-                array(
-                    $registrations_used_for_contact_data,
-                    $Message_Template_Group->ID(),
-                )
-            );
-            // kept for backward compat, internally we no longer use this action.
-            // @deprecated 4.8.36.rc.002
-            $contacts = $id_type === 'registration'
-                ? EEM_Attendee::instance()->get_array_of_contacts_from_reg_ids($ids)
-                : EEM_Attendee::instance()->get_all(array(array('ATT_ID' => array('in', $ids))));
-            do_action_ref_array(
-                'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send',
-                array(
-                    $contacts,
-                    $Message_Template_Group->ID(),
-                )
-            );
-        }
-        $query_args = array(
-            'action' => ! empty($this->_req_data['redirect_back_to'])
-                ? $this->_req_data['redirect_back_to']
-                : 'default',
-        );
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
+	/**
+	 * Handles sending selected registrations/contacts a newsletter.
+	 *
+	 * @since  4.3.0
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _newsletter_selected_send()
+	{
+		$success = true;
+		// first we need to make sure we have a GRP_ID so we know what template we're sending and updating!
+		if (empty($this->_req_data['newsletter_mtp_selected'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'In order to send a message, a Message Template GRP_ID is needed. It was not provided so messages were not sent.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		if ($success) {
+			// update Message template in case there are any changes
+			$Message_Template_Group = EEM_Message_Template_Group::instance()->get_one_by_ID(
+				$this->_req_data['newsletter_mtp_selected']
+			);
+			$Message_Templates = $Message_Template_Group instanceof EE_Message_Template_Group
+				? $Message_Template_Group->context_templates()
+				: array();
+			if (empty($Message_Templates)) {
+				EE_Error::add_error(
+					esc_html__(
+						'Unable to retrieve message template fields from the db. Messages not sent.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			// let's just update the specific fields
+			foreach ($Message_Templates['attendee'] as $Message_Template) {
+				if ($Message_Template instanceof EE_Message_Template) {
+					$field = $Message_Template->get('MTP_template_field');
+					$content = $Message_Template->get('MTP_content');
+					$new_content = $content;
+					switch ($field) {
+						case 'from':
+							$new_content = ! empty($this->_req_data['batch_message']['from'])
+								? $this->_req_data['batch_message']['from']
+								: $content;
+							break;
+						case 'subject':
+							$new_content = ! empty($this->_req_data['batch_message']['subject'])
+								? $this->_req_data['batch_message']['subject']
+								: $content;
+							break;
+						case 'content':
+							$new_content = $content;
+							$new_content['newsletter_content'] = ! empty($this->_req_data['batch_message']['content'])
+								? $this->_req_data['batch_message']['content']
+								: $content['newsletter_content'];
+							break;
+						default:
+							// continue the foreach loop, we don't want to set $new_content nor save.
+							continue 2;
+					}
+					$Message_Template->set('MTP_content', $new_content);
+					$Message_Template->save();
+				}
+			}
+			// great fields are updated!  now let's make sure we just have contact objects (EE_Attendee).
+			$id_type = ! empty($this->_req_data['batch_message']['id_type'])
+				? $this->_req_data['batch_message']['id_type']
+				: 'registration';
+			// id_type will affect how we assemble the ids.
+			$ids = ! empty($this->_req_data['batch_message']['ids'])
+				? json_decode(stripslashes($this->_req_data['batch_message']['ids']))
+				: array();
+			$registrations_used_for_contact_data = array();
+			// using switch because eventually we'll have other contexts that will be used for generating messages.
+			switch ($id_type) {
+				case 'registration':
+					$registrations_used_for_contact_data = EEM_Registration::instance()->get_all(
+						array(
+							array(
+								'REG_ID' => array('IN', $ids),
+							),
+						)
+					);
+					break;
+				case 'contact':
+					$registrations_used_for_contact_data = EEM_Registration::instance()
+																		   ->get_latest_registration_for_each_of_given_contacts(
+																			   $ids
+																		   );
+					break;
+			}
+			do_action_ref_array(
+				'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
+				array(
+					$registrations_used_for_contact_data,
+					$Message_Template_Group->ID(),
+				)
+			);
+			// kept for backward compat, internally we no longer use this action.
+			// @deprecated 4.8.36.rc.002
+			$contacts = $id_type === 'registration'
+				? EEM_Attendee::instance()->get_array_of_contacts_from_reg_ids($ids)
+				: EEM_Attendee::instance()->get_all(array(array('ATT_ID' => array('in', $ids))));
+			do_action_ref_array(
+				'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send',
+				array(
+					$contacts,
+					$Message_Template_Group->ID(),
+				)
+			);
+		}
+		$query_args = array(
+			'action' => ! empty($this->_req_data['redirect_back_to'])
+				? $this->_req_data['redirect_back_to']
+				: 'default',
+		);
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
 
 
-    /**
-     * This is called when javascript is being enqueued to setup the various data needed for the reports js.
-     * Also $this->{$_reports_template_data} property is set for later usage by the _registration_reports method.
-     */
-    protected function _registration_reports_js_setup()
-    {
-        $this->_reports_template_data['admin_reports'][] = $this->_registrations_per_day_report();
-        $this->_reports_template_data['admin_reports'][] = $this->_registrations_per_event_report();
-    }
+	/**
+	 * This is called when javascript is being enqueued to setup the various data needed for the reports js.
+	 * Also $this->{$_reports_template_data} property is set for later usage by the _registration_reports method.
+	 */
+	protected function _registration_reports_js_setup()
+	{
+		$this->_reports_template_data['admin_reports'][] = $this->_registrations_per_day_report();
+		$this->_reports_template_data['admin_reports'][] = $this->_registrations_per_event_report();
+	}
 
 
-    /**
-     *        generates Business Reports regarding Registrations
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     */
-    protected function _registration_reports()
-    {
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $template_path,
-            $this->_reports_template_data,
-            true
-        );
-        // the final template wrapper
-        $this->display_admin_page_with_no_sidebar();
-    }
+	/**
+	 *        generates Business Reports regarding Registrations
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 */
+	protected function _registration_reports()
+	{
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$template_path,
+			$this->_reports_template_data,
+			true
+		);
+		// the final template wrapper
+		$this->display_admin_page_with_no_sidebar();
+	}
 
 
-    /**
-     * Generates Business Report showing total registrations per day.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _registrations_per_day_report($period = '-1 month')
-    {
-        $report_ID = 'reg-admin-registrations-per-day-report-dv';
-        $results = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period);
-        $results = (array) $results;
-        $regs = array();
-        $subtitle = '';
-        if ($results) {
-            $column_titles = array();
-            $tracker = 0;
-            foreach ($results as $result) {
-                $report_column_values = array();
-                foreach ($result as $property_name => $property_value) {
-                    $property_value = $property_name === 'Registration_REG_date' ? $property_value
-                        : (int) $property_value;
-                    $report_column_values[] = $property_value;
-                    if ($tracker === 0) {
-                        if ($property_name === 'Registration_REG_date') {
-                            $column_titles[] = esc_html__(
-                                'Date (only days with registrations are shown)',
-                                'event_espresso'
-                            );
-                        } else {
-                            $column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
-                        }
-                    }
-                }
-                $tracker++;
-                $regs[] = $report_column_values;
-            }
-            // make sure the column_titles is pushed to the beginning of the array
-            array_unshift($regs, $column_titles);
-            // setup the date range.
-            $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
-            $ending_date = new DateTime("now", $DateTimeZone);
-            $subtitle = sprintf(
-                _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'),
-                $ending_date->format('Y-m-d')
-            );
-        }
-        $report_title = esc_html__('Total Registrations per Day', 'event_espresso');
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'regs'      => $regs,
-            'noResults' => empty($regs),
-            'noRegsMsg' => sprintf(
-                esc_html__(
-                    '%sThere are currently no registration records in the last month for this report.%s',
-                    'event_espresso'
-                ),
-                '<h2>' . $report_title . '</h2><p>',
-                '</p>'
-            ),
-        );
-        wp_localize_script('ee-reg-reports-js', 'regPerDay', $report_params);
-        return $report_ID;
-    }
+	/**
+	 * Generates Business Report showing total registrations per day.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _registrations_per_day_report($period = '-1 month')
+	{
+		$report_ID = 'reg-admin-registrations-per-day-report-dv';
+		$results = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period);
+		$results = (array) $results;
+		$regs = array();
+		$subtitle = '';
+		if ($results) {
+			$column_titles = array();
+			$tracker = 0;
+			foreach ($results as $result) {
+				$report_column_values = array();
+				foreach ($result as $property_name => $property_value) {
+					$property_value = $property_name === 'Registration_REG_date' ? $property_value
+						: (int) $property_value;
+					$report_column_values[] = $property_value;
+					if ($tracker === 0) {
+						if ($property_name === 'Registration_REG_date') {
+							$column_titles[] = esc_html__(
+								'Date (only days with registrations are shown)',
+								'event_espresso'
+							);
+						} else {
+							$column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
+						}
+					}
+				}
+				$tracker++;
+				$regs[] = $report_column_values;
+			}
+			// make sure the column_titles is pushed to the beginning of the array
+			array_unshift($regs, $column_titles);
+			// setup the date range.
+			$DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
+			$beginning_date = new DateTime("now " . $period, $DateTimeZone);
+			$ending_date = new DateTime("now", $DateTimeZone);
+			$subtitle = sprintf(
+				_x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'),
+				$ending_date->format('Y-m-d')
+			);
+		}
+		$report_title = esc_html__('Total Registrations per Day', 'event_espresso');
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'regs'      => $regs,
+			'noResults' => empty($regs),
+			'noRegsMsg' => sprintf(
+				esc_html__(
+					'%sThere are currently no registration records in the last month for this report.%s',
+					'event_espresso'
+				),
+				'<h2>' . $report_title . '</h2><p>',
+				'</p>'
+			),
+		);
+		wp_localize_script('ee-reg-reports-js', 'regPerDay', $report_params);
+		return $report_ID;
+	}
 
 
-    /**
-     * Generates Business Report showing total registrations per event.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _registrations_per_event_report($period = '-1 month')
-    {
-        $report_ID = 'reg-admin-registrations-per-event-report-dv';
-        $results = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period);
-        $results = (array) $results;
-        $regs = array();
-        $subtitle = '';
-        if ($results) {
-            $column_titles = array();
-            $tracker = 0;
-            foreach ($results as $result) {
-                $report_column_values = array();
-                foreach ($result as $property_name => $property_value) {
-                    $property_value = $property_name === 'Registration_Event' ? wp_trim_words(
-                        $property_value,
-                        4,
-                        '...'
-                    ) : (int) $property_value;
-                    $report_column_values[] = $property_value;
-                    if ($tracker === 0) {
-                        if ($property_name === 'Registration_Event') {
-                            $column_titles[] = esc_html__('Event', 'event_espresso');
-                        } else {
-                            $column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
-                        }
-                    }
-                }
-                $tracker++;
-                $regs[] = $report_column_values;
-            }
-            // make sure the column_titles is pushed to the beginning of the array
-            array_unshift($regs, $column_titles);
-            // setup the date range.
-            $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
-            $ending_date = new DateTime("now", $DateTimeZone);
-            $subtitle = sprintf(
-                _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'),
-                $ending_date->format('Y-m-d')
-            );
-        }
-        $report_title = esc_html__('Total Registrations per Event', 'event_espresso');
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'regs'      => $regs,
-            'noResults' => empty($regs),
-            'noRegsMsg' => sprintf(
-                esc_html__(
-                    '%sThere are currently no registration records in the last month for this report.%s',
-                    'event_espresso'
-                ),
-                '<h2>' . $report_title . '</h2><p>',
-                '</p>'
-            ),
-        );
-        wp_localize_script('ee-reg-reports-js', 'regPerEvent', $report_params);
-        return $report_ID;
-    }
+	/**
+	 * Generates Business Report showing total registrations per event.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _registrations_per_event_report($period = '-1 month')
+	{
+		$report_ID = 'reg-admin-registrations-per-event-report-dv';
+		$results = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period);
+		$results = (array) $results;
+		$regs = array();
+		$subtitle = '';
+		if ($results) {
+			$column_titles = array();
+			$tracker = 0;
+			foreach ($results as $result) {
+				$report_column_values = array();
+				foreach ($result as $property_name => $property_value) {
+					$property_value = $property_name === 'Registration_Event' ? wp_trim_words(
+						$property_value,
+						4,
+						'...'
+					) : (int) $property_value;
+					$report_column_values[] = $property_value;
+					if ($tracker === 0) {
+						if ($property_name === 'Registration_Event') {
+							$column_titles[] = esc_html__('Event', 'event_espresso');
+						} else {
+							$column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
+						}
+					}
+				}
+				$tracker++;
+				$regs[] = $report_column_values;
+			}
+			// make sure the column_titles is pushed to the beginning of the array
+			array_unshift($regs, $column_titles);
+			// setup the date range.
+			$DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
+			$beginning_date = new DateTime("now " . $period, $DateTimeZone);
+			$ending_date = new DateTime("now", $DateTimeZone);
+			$subtitle = sprintf(
+				_x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'),
+				$ending_date->format('Y-m-d')
+			);
+		}
+		$report_title = esc_html__('Total Registrations per Event', 'event_espresso');
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'regs'      => $regs,
+			'noResults' => empty($regs),
+			'noRegsMsg' => sprintf(
+				esc_html__(
+					'%sThere are currently no registration records in the last month for this report.%s',
+					'event_espresso'
+				),
+				'<h2>' . $report_title . '</h2><p>',
+				'</p>'
+			),
+		);
+		wp_localize_script('ee-reg-reports-js', 'regPerEvent', $report_params);
+		return $report_ID;
+	}
 
 
-    /**
-     * generates HTML for the Registration Check-in list table (showing all Check-ins for a specific registration)
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    protected function _registration_checkin_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $reg_id = isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : null;
-        /** @var EE_Registration $registration */
-        $registration = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $registration instanceof EE_Registration) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('An error occurred. There is no registration with ID (%d)', 'event_espresso'),
-                    $reg_id
-                )
-            );
-        }
-        $attendee = $registration->attendee();
-        $this->_admin_page_title .= $this->get_action_link_or_button(
-            'new_registration',
-            'add-registrant',
-            array('event_id' => $registration->event_ID()),
-            'add-new-h2'
-        );
-        $checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
-        $checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
-        $legend_items = array(
-            'checkin'  => array(
-                'class' => $checked_in->cssClasses(),
-                'desc'  => $checked_in->legendLabel(),
-            ),
-            'checkout' => array(
-                'class' => $checked_out->cssClasses(),
-                'desc'  => $checked_out->legendLabel(),
-            ),
-        );
-        $this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
-        $dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
-        /** @var EE_Datetime $datetime */
-        $datetime = EEM_Datetime::instance()->get_one_by_ID($dtt_id);
-        $datetime_label = '';
-        if ($datetime instanceof EE_Datetime) {
-            $datetime_label = $datetime->get_dtt_display_name(true);
-            $datetime_label .= ! empty($datetime_label)
-                ? ' (' . $datetime->get_dtt_display_name() . ')'
-                : $datetime->get_dtt_display_name();
-        }
-        $datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration
-            ? EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action'   => 'event_registrations',
-                    'event_id' => $registration->event_ID(),
-                    'DTT_ID'   => $dtt_id,
-                ),
-                $this->_admin_base_url
-            )
-            : '';
-        $datetime_link = ! empty($datetime_link)
-            ? '<a href="' . $datetime_link . '">'
-              . '<span id="checkin-dtt">'
-              . $datetime_label
-              . '</span></a>'
-            : $datetime_label;
-        $attendee_name = $attendee instanceof EE_Attendee
-            ? $attendee->full_name()
-            : '';
-        $attendee_link = $attendee instanceof EE_Attendee
-            ? $attendee->get_admin_details_link()
-            : '';
-        $attendee_link = ! empty($attendee_link)
-            ? '<a href="' . $attendee->get_admin_details_link() . '"'
-              . ' title="' . esc_html__('Click for attendee details', 'event_espresso') . '">'
-              . '<span id="checkin-attendee-name">'
-              . $attendee_name
-              . '</span></a>'
-            : '';
-        $event_link = $registration->event() instanceof EE_Event
-            ? $registration->event()->get_admin_details_link()
-            : '';
-        $event_link = ! empty($event_link)
-            ? '<a href="' . $event_link . '"'
-              . ' title="' . esc_html__('Click here to edit event.', 'event_espresso') . '">'
-              . '<span id="checkin-event-name">'
-              . $registration->event_name()
-              . '</span>'
-              . '</a>'
-            : '';
-        $this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id)
-            ? '<h2>' . sprintf(
-                esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'),
-                $attendee_link,
-                $datetime_link,
-                $event_link
-            ) . '</h2>'
-            : '';
-        $this->_template_args['list_table_hidden_fields'] = ! empty($reg_id)
-            ? '<input type="hidden" name="_REG_ID" value="' . $reg_id . '">' : '';
-        $this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id)
-            ? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : '';
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
+	/**
+	 * generates HTML for the Registration Check-in list table (showing all Check-ins for a specific registration)
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	protected function _registration_checkin_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$reg_id = isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : null;
+		/** @var EE_Registration $registration */
+		$registration = EEM_Registration::instance()->get_one_by_ID($reg_id);
+		if (! $registration instanceof EE_Registration) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('An error occurred. There is no registration with ID (%d)', 'event_espresso'),
+					$reg_id
+				)
+			);
+		}
+		$attendee = $registration->attendee();
+		$this->_admin_page_title .= $this->get_action_link_or_button(
+			'new_registration',
+			'add-registrant',
+			array('event_id' => $registration->event_ID()),
+			'add-new-h2'
+		);
+		$checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
+		$checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
+		$legend_items = array(
+			'checkin'  => array(
+				'class' => $checked_in->cssClasses(),
+				'desc'  => $checked_in->legendLabel(),
+			),
+			'checkout' => array(
+				'class' => $checked_out->cssClasses(),
+				'desc'  => $checked_out->legendLabel(),
+			),
+		);
+		$this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
+		$dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
+		/** @var EE_Datetime $datetime */
+		$datetime = EEM_Datetime::instance()->get_one_by_ID($dtt_id);
+		$datetime_label = '';
+		if ($datetime instanceof EE_Datetime) {
+			$datetime_label = $datetime->get_dtt_display_name(true);
+			$datetime_label .= ! empty($datetime_label)
+				? ' (' . $datetime->get_dtt_display_name() . ')'
+				: $datetime->get_dtt_display_name();
+		}
+		$datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration
+			? EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action'   => 'event_registrations',
+					'event_id' => $registration->event_ID(),
+					'DTT_ID'   => $dtt_id,
+				),
+				$this->_admin_base_url
+			)
+			: '';
+		$datetime_link = ! empty($datetime_link)
+			? '<a href="' . $datetime_link . '">'
+			  . '<span id="checkin-dtt">'
+			  . $datetime_label
+			  . '</span></a>'
+			: $datetime_label;
+		$attendee_name = $attendee instanceof EE_Attendee
+			? $attendee->full_name()
+			: '';
+		$attendee_link = $attendee instanceof EE_Attendee
+			? $attendee->get_admin_details_link()
+			: '';
+		$attendee_link = ! empty($attendee_link)
+			? '<a href="' . $attendee->get_admin_details_link() . '"'
+			  . ' title="' . esc_html__('Click for attendee details', 'event_espresso') . '">'
+			  . '<span id="checkin-attendee-name">'
+			  . $attendee_name
+			  . '</span></a>'
+			: '';
+		$event_link = $registration->event() instanceof EE_Event
+			? $registration->event()->get_admin_details_link()
+			: '';
+		$event_link = ! empty($event_link)
+			? '<a href="' . $event_link . '"'
+			  . ' title="' . esc_html__('Click here to edit event.', 'event_espresso') . '">'
+			  . '<span id="checkin-event-name">'
+			  . $registration->event_name()
+			  . '</span>'
+			  . '</a>'
+			: '';
+		$this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id)
+			? '<h2>' . sprintf(
+				esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'),
+				$attendee_link,
+				$datetime_link,
+				$event_link
+			) . '</h2>'
+			: '';
+		$this->_template_args['list_table_hidden_fields'] = ! empty($reg_id)
+			? '<input type="hidden" name="_REG_ID" value="' . $reg_id . '">' : '';
+		$this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id)
+			? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : '';
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
 
 
-    /**
-     * toggle the Check-in status for the given registration (coming from ajax)
-     *
-     * @return void (JSON)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function toggle_checkin_status()
-    {
-        // first make sure we have the necessary data
-        if (! isset($this->_req_data['_regid'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['success'] = false;
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        };
-        // do a nonce check cause we're not coming in from an normal route here.
-        $nonce = isset($this->_req_data['checkinnonce']) ? sanitize_text_field($this->_req_data['checkinnonce'])
-            : '';
-        $nonce_ref = 'checkin_nonce';
-        $this->_verify_nonce($nonce, $nonce_ref);
-        // beautiful! Made it this far so let's get the status.
-        $new_status = new CheckinStatusDashicon($this->_toggle_checkin_status());
-        // setup new class to return via ajax
-        $this->_template_args['admin_page_content'] = 'clickable trigger-checkin ' . $new_status->cssClasses();
-        $this->_template_args['success'] = true;
-        $this->_return_json();
-    }
+	/**
+	 * toggle the Check-in status for the given registration (coming from ajax)
+	 *
+	 * @return void (JSON)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function toggle_checkin_status()
+	{
+		// first make sure we have the necessary data
+		if (! isset($this->_req_data['_regid'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['success'] = false;
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		};
+		// do a nonce check cause we're not coming in from an normal route here.
+		$nonce = isset($this->_req_data['checkinnonce']) ? sanitize_text_field($this->_req_data['checkinnonce'])
+			: '';
+		$nonce_ref = 'checkin_nonce';
+		$this->_verify_nonce($nonce, $nonce_ref);
+		// beautiful! Made it this far so let's get the status.
+		$new_status = new CheckinStatusDashicon($this->_toggle_checkin_status());
+		// setup new class to return via ajax
+		$this->_template_args['admin_page_content'] = 'clickable trigger-checkin ' . $new_status->cssClasses();
+		$this->_template_args['success'] = true;
+		$this->_return_json();
+	}
 
 
-    /**
-     * handles toggling the checkin status for the registration,
-     *
-     * @access protected
-     * @return int|void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _toggle_checkin_status()
-    {
-        // first let's get the query args out of the way for the redirect
-        $query_args = array(
-            'action'   => 'event_registrations',
-            'event_id' => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null,
-            'DTT_ID'   => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null,
-        );
-        $new_status = false;
-        // bulk action check in toggle
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // cycle thru checkboxes
-            while (list($REG_ID, $value) = each($this->_req_data['checkbox'])) {
-                $DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
-                $new_status = $this->_toggle_checkin($REG_ID, $DTT_ID);
-            }
-        } elseif (isset($this->_req_data['_regid'])) {
-            // coming from ajax request
-            $DTT_ID = isset($this->_req_data['dttid']) ? $this->_req_data['dttid'] : null;
-            $query_args['DTT_ID'] = $DTT_ID;
-            $new_status = $this->_toggle_checkin($this->_req_data['_regid'], $DTT_ID);
-        } else {
-            EE_Error::add_error(
-                esc_html__('Missing some required data to toggle the Check-in', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        if (defined('DOING_AJAX')) {
-            return $new_status;
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
+	/**
+	 * handles toggling the checkin status for the registration,
+	 *
+	 * @access protected
+	 * @return int|void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _toggle_checkin_status()
+	{
+		// first let's get the query args out of the way for the redirect
+		$query_args = array(
+			'action'   => 'event_registrations',
+			'event_id' => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null,
+			'DTT_ID'   => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null,
+		);
+		$new_status = false;
+		// bulk action check in toggle
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// cycle thru checkboxes
+			while (list($REG_ID, $value) = each($this->_req_data['checkbox'])) {
+				$DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
+				$new_status = $this->_toggle_checkin($REG_ID, $DTT_ID);
+			}
+		} elseif (isset($this->_req_data['_regid'])) {
+			// coming from ajax request
+			$DTT_ID = isset($this->_req_data['dttid']) ? $this->_req_data['dttid'] : null;
+			$query_args['DTT_ID'] = $DTT_ID;
+			$new_status = $this->_toggle_checkin($this->_req_data['_regid'], $DTT_ID);
+		} else {
+			EE_Error::add_error(
+				esc_html__('Missing some required data to toggle the Check-in', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		if (defined('DOING_AJAX')) {
+			return $new_status;
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
 
 
-    /**
-     * This is toggles a single Check-in for the given registration and datetime.
-     *
-     * @param  int $REG_ID The registration we're toggling
-     * @param  int $DTT_ID The datetime we're toggling
-     * @return int The new status toggled to.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _toggle_checkin($REG_ID, $DTT_ID)
-    {
-        /** @var EE_Registration $REG */
-        $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
-        $new_status = $REG->toggle_checkin_status($DTT_ID);
-        if ($new_status !== false) {
-            EE_Error::add_success($REG->get_checkin_msg($DTT_ID));
-        } else {
-            EE_Error::add_error($REG->get_checkin_msg($DTT_ID, true), __FILE__, __FUNCTION__, __LINE__);
-            $new_status = false;
-        }
-        return $new_status;
-    }
+	/**
+	 * This is toggles a single Check-in for the given registration and datetime.
+	 *
+	 * @param  int $REG_ID The registration we're toggling
+	 * @param  int $DTT_ID The datetime we're toggling
+	 * @return int The new status toggled to.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _toggle_checkin($REG_ID, $DTT_ID)
+	{
+		/** @var EE_Registration $REG */
+		$REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
+		$new_status = $REG->toggle_checkin_status($DTT_ID);
+		if ($new_status !== false) {
+			EE_Error::add_success($REG->get_checkin_msg($DTT_ID));
+		} else {
+			EE_Error::add_error($REG->get_checkin_msg($DTT_ID, true), __FILE__, __FUNCTION__, __LINE__);
+			$new_status = false;
+		}
+		return $new_status;
+	}
 
 
-    /**
-     * Takes care of deleting multiple EE_Checkin table rows
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _delete_checkin_rows()
-    {
-        $query_args = array(
-            'action'  => 'registration_checkins',
-            'DTT_ID'  => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
-            '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
-        );
-        $errors = 0;
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            while (list($CHK_ID, $value) = each($this->_req_data['checkbox'])) {
-                if (! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
-                    $errors++;
-                }
-            }
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'So, something went wrong with the bulk delete because there was no data received for instructions on WHAT to delete!',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_redirect_after_action(false, '', '', $query_args, true);
-        }
-        if ($errors > 0) {
-            EE_Error::add_error(
-                sprintf(__('There were %d records that did not delete successfully', 'event_espresso'), $errors),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            EE_Error::add_success(__('Records were successfully deleted', 'event_espresso'));
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
+	/**
+	 * Takes care of deleting multiple EE_Checkin table rows
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _delete_checkin_rows()
+	{
+		$query_args = array(
+			'action'  => 'registration_checkins',
+			'DTT_ID'  => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
+			'_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
+		);
+		$errors = 0;
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			while (list($CHK_ID, $value) = each($this->_req_data['checkbox'])) {
+				if (! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
+					$errors++;
+				}
+			}
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'So, something went wrong with the bulk delete because there was no data received for instructions on WHAT to delete!',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_redirect_after_action(false, '', '', $query_args, true);
+		}
+		if ($errors > 0) {
+			EE_Error::add_error(
+				sprintf(__('There were %d records that did not delete successfully', 'event_espresso'), $errors),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			EE_Error::add_success(__('Records were successfully deleted', 'event_espresso'));
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
 
 
-    /**
-     * Deletes a single EE_Checkin row
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _delete_checkin_row()
-    {
-        $query_args = array(
-            'action'  => 'registration_checkins',
-            'DTT_ID'  => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
-            '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
-        );
-        if (! empty($this->_req_data['CHK_ID'])) {
-            if (! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
-                EE_Error::add_error(
-                    esc_html__('Something went wrong and this check-in record was not deleted', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                EE_Error::add_success(__('Check-In record successfully deleted', 'event_espresso'));
-            }
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'In order to delete a Check-in record, there must be a Check-In ID available. There is not. It is not your fault, there is just a gremlin living in the code',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
+	/**
+	 * Deletes a single EE_Checkin row
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _delete_checkin_row()
+	{
+		$query_args = array(
+			'action'  => 'registration_checkins',
+			'DTT_ID'  => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
+			'_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
+		);
+		if (! empty($this->_req_data['CHK_ID'])) {
+			if (! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
+				EE_Error::add_error(
+					esc_html__('Something went wrong and this check-in record was not deleted', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				EE_Error::add_success(__('Check-In record successfully deleted', 'event_espresso'));
+			}
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'In order to delete a Check-in record, there must be a Check-In ID available. There is not. It is not your fault, there is just a gremlin living in the code',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
 
 
-    /**
-     *        generates HTML for the Event Registrations List Table
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _event_registrations_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_admin_page_title .= isset($this->_req_data['event_id'])
-            ? $this->get_action_link_or_button(
-                'new_registration',
-                'add-registrant',
-                array('event_id' => $this->_req_data['event_id']),
-                'add-new-h2',
-                '',
-                false
-            )
-            : '';
-        $checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
-        $checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
-        $checked_never = new CheckinStatusDashicon(EE_Checkin::status_checked_never);
-        $legend_items = array(
-            'star-icon'        => array(
-                'class' => 'dashicons dashicons-star-filled yellow-icon ee-icon-size-8',
-                'desc'  => esc_html__('This Registrant is the Primary Registrant', 'event_espresso'),
-            ),
-            'checkin'          => array(
-                'class' => $checked_in->cssClasses(),
-                'desc'  => $checked_in->legendLabel(),
-            ),
-            'checkout'         => array(
-                'class' => $checked_out->cssClasses(),
-                'desc'  => $checked_out->legendLabel(),
-            ),
-            'nocheckinrecord'  => array(
-                'class' => $checked_never->cssClasses(),
-                'desc'  => $checked_never->legendLabel(),
-            ),
-            'approved_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
-            ),
-            'cancelled_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
-            ),
-            'declined_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
-            ),
-            'not_approved'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
-            ),
-            'pending_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
-            ),
-            'wait_list'        => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
-            ),
-        );
-        $this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
-        $event_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
-        /** @var EE_Event $event */
-        $event = EEM_Event::instance()->get_one_by_ID($event_id);
-        $this->_template_args['before_list_table'] = $event instanceof EE_Event
-            ? '<h2>' . sprintf(
-                esc_html__('Viewing Registrations for Event: %s', 'event_espresso'),
-                EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name')
-            ) . '</h2>'
-            : '';
-        // need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on
-        // the event.
-        $DTT_ID = ! empty($this->_req_data['DTT_ID']) ? absint($this->_req_data['DTT_ID']) : 0;
-        $datetime = null;
-        if ($event instanceof EE_Event) {
-            $datetimes_on_event = $event->datetimes();
-            if (count($datetimes_on_event) === 1) {
-                $datetime = reset($datetimes_on_event);
-            }
-        }
-        $datetime = $datetime instanceof EE_Datetime ? $datetime : EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
-        if ($datetime instanceof EE_Datetime && $this->_template_args['before_list_table'] !== '') {
-            $this->_template_args['before_list_table'] = substr($this->_template_args['before_list_table'], 0, -5);
-            $this->_template_args['before_list_table'] .= ' &nbsp;<span class="drk-grey-text">';
-            $this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>';
-            $this->_template_args['before_list_table'] .= $datetime->name();
-            $this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )';
-            $this->_template_args['before_list_table'] .= '</span></h2>';
-        }
-        // if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status
-        // column represents
-        if (! $datetime instanceof EE_Datetime) {
-            $this->_template_args['before_list_table'] .= '<br><p class="description">'
-                                                          . esc_html__(
-                                                              'In this view, the check-in status represents the latest check-in record for the registration in that row.',
-                                                              'event_espresso'
-                                                          )
-                                                          . '</p>';
-        }
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
+	/**
+	 *        generates HTML for the Event Registrations List Table
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _event_registrations_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_admin_page_title .= isset($this->_req_data['event_id'])
+			? $this->get_action_link_or_button(
+				'new_registration',
+				'add-registrant',
+				array('event_id' => $this->_req_data['event_id']),
+				'add-new-h2',
+				'',
+				false
+			)
+			: '';
+		$checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
+		$checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
+		$checked_never = new CheckinStatusDashicon(EE_Checkin::status_checked_never);
+		$legend_items = array(
+			'star-icon'        => array(
+				'class' => 'dashicons dashicons-star-filled yellow-icon ee-icon-size-8',
+				'desc'  => esc_html__('This Registrant is the Primary Registrant', 'event_espresso'),
+			),
+			'checkin'          => array(
+				'class' => $checked_in->cssClasses(),
+				'desc'  => $checked_in->legendLabel(),
+			),
+			'checkout'         => array(
+				'class' => $checked_out->cssClasses(),
+				'desc'  => $checked_out->legendLabel(),
+			),
+			'nocheckinrecord'  => array(
+				'class' => $checked_never->cssClasses(),
+				'desc'  => $checked_never->legendLabel(),
+			),
+			'approved_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
+			),
+			'cancelled_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
+			),
+			'declined_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
+			),
+			'not_approved'     => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
+			),
+			'pending_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
+			),
+			'wait_list'        => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
+			),
+		);
+		$this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
+		$event_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
+		/** @var EE_Event $event */
+		$event = EEM_Event::instance()->get_one_by_ID($event_id);
+		$this->_template_args['before_list_table'] = $event instanceof EE_Event
+			? '<h2>' . sprintf(
+				esc_html__('Viewing Registrations for Event: %s', 'event_espresso'),
+				EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name')
+			) . '</h2>'
+			: '';
+		// need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on
+		// the event.
+		$DTT_ID = ! empty($this->_req_data['DTT_ID']) ? absint($this->_req_data['DTT_ID']) : 0;
+		$datetime = null;
+		if ($event instanceof EE_Event) {
+			$datetimes_on_event = $event->datetimes();
+			if (count($datetimes_on_event) === 1) {
+				$datetime = reset($datetimes_on_event);
+			}
+		}
+		$datetime = $datetime instanceof EE_Datetime ? $datetime : EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
+		if ($datetime instanceof EE_Datetime && $this->_template_args['before_list_table'] !== '') {
+			$this->_template_args['before_list_table'] = substr($this->_template_args['before_list_table'], 0, -5);
+			$this->_template_args['before_list_table'] .= ' &nbsp;<span class="drk-grey-text">';
+			$this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>';
+			$this->_template_args['before_list_table'] .= $datetime->name();
+			$this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )';
+			$this->_template_args['before_list_table'] .= '</span></h2>';
+		}
+		// if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status
+		// column represents
+		if (! $datetime instanceof EE_Datetime) {
+			$this->_template_args['before_list_table'] .= '<br><p class="description">'
+														  . esc_html__(
+															  'In this view, the check-in status represents the latest check-in record for the registration in that row.',
+															  'event_espresso'
+														  )
+														  . '</p>';
+		}
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
 
-    /**
-     * Download the registrations check-in report (same as the normal registration report, but with different where
-     * conditions)
-     *
-     * @return void ends the request by a redirect or download
-     */
-    public function _registrations_checkin_report()
-    {
-        $this->_registrations_report_base('_get_checkin_query_params_from_request');
-    }
+	/**
+	 * Download the registrations check-in report (same as the normal registration report, but with different where
+	 * conditions)
+	 *
+	 * @return void ends the request by a redirect or download
+	 */
+	public function _registrations_checkin_report()
+	{
+		$this->_registrations_report_base('_get_checkin_query_params_from_request');
+	}
 
-    /**
-     * Gets the query params from the request, plus adds a where condition for the registration status,
-     * because on the checkin page we only ever want to see approved and pending-approval registrations
-     *
-     * @param array $request
-     * @param int   $per_page
-     * @param bool  $count
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_checkin_query_params_from_request(
-        $request,
-        $per_page = 10,
-        $count = false
-    ) {
-        $query_params = $this->_get_registration_query_parameters($request, $per_page, $count);
-        // unlike the regular registrations list table,
-        $status_ids_array = apply_filters(
-            'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
-            array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved)
-        );
-        $query_params[0]['STS_ID'] = array('IN', $status_ids_array);
-        return $query_params;
-    }
+	/**
+	 * Gets the query params from the request, plus adds a where condition for the registration status,
+	 * because on the checkin page we only ever want to see approved and pending-approval registrations
+	 *
+	 * @param array $request
+	 * @param int   $per_page
+	 * @param bool  $count
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_checkin_query_params_from_request(
+		$request,
+		$per_page = 10,
+		$count = false
+	) {
+		$query_params = $this->_get_registration_query_parameters($request, $per_page, $count);
+		// unlike the regular registrations list table,
+		$status_ids_array = apply_filters(
+			'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
+			array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved)
+		);
+		$query_params[0]['STS_ID'] = array('IN', $status_ids_array);
+		return $query_params;
+	}
 
 
-    /**
-     * Gets registrations for an event
-     *
-     * @param int    $per_page
-     * @param bool   $count whether to return count or data.
-     * @param bool   $trash
-     * @param string $orderby
-     * @return EE_Registration[]|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_event_attendees($per_page = 10, $count = false, $trash = false, $orderby = 'ATT_fname')
-    {
-        // normalize some request params that get setup by the parent `get_registrations` method.
-        $request = $this->_req_data;
-        $request['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : $orderby;
-        $request['order'] = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC';
-        if ($trash) {
-            $request['status'] = 'trash';
-        }
-        $query_params = $this->_get_checkin_query_params_from_request($request, $per_page, $count);
-        /**
-         * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
-         *
-         * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
-         * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-         *                             or if you have the development copy of EE you can view this at the path:
-         *                             /docs/G--Model-System/model-query-params.md
-         */
-        $query_params['group_by'] = '';
+	/**
+	 * Gets registrations for an event
+	 *
+	 * @param int    $per_page
+	 * @param bool   $count whether to return count or data.
+	 * @param bool   $trash
+	 * @param string $orderby
+	 * @return EE_Registration[]|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_event_attendees($per_page = 10, $count = false, $trash = false, $orderby = 'ATT_fname')
+	{
+		// normalize some request params that get setup by the parent `get_registrations` method.
+		$request = $this->_req_data;
+		$request['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : $orderby;
+		$request['order'] = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC';
+		if ($trash) {
+			$request['status'] = 'trash';
+		}
+		$query_params = $this->_get_checkin_query_params_from_request($request, $per_page, $count);
+		/**
+		 * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
+		 *
+		 * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
+		 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+		 *                             or if you have the development copy of EE you can view this at the path:
+		 *                             /docs/G--Model-System/model-query-params.md
+		 */
+		$query_params['group_by'] = '';
 
-        return $count
-            ? EEM_Registration::instance()->count($query_params)
-            /** @type EE_Registration[] */
-            : EEM_Registration::instance()->get_all($query_params);
-    }
+		return $count
+			? EEM_Registration::instance()->count($query_params)
+			/** @type EE_Registration[] */
+			: EEM_Registration::instance()->get_all($query_params);
+	}
 }

Spacing +49 added lines, -49 removed lines

@@ -32,10 +32,10 @@ 
     public function __construct($routing = true)
     {
         parent::__construct($routing);
-        if (! defined('REG_CAF_TEMPLATE_PATH')) {
-            define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/');
-            define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/');
-            define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/');
+        if ( ! defined('REG_CAF_TEMPLATE_PATH')) {
+            define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND.'registrations/templates/');
+            define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND.'registrations/assets/');
+            define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'registrations/assets/');
         }
     }
 
@@ -45,7 +45,7 @@ 
      */
     protected function _extend_page_config()
     {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations';
+        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND.'registrations';
         $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
             ? $this->_req_data['_REG_ID']
             : 0;
@@ -185,14 +185,14 @@ 
             // enqueue newsletter js
             wp_enqueue_script(
                 'ee-newsletter-trigger',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
+                REG_CAF_ASSETS_URL.'ee-newsletter-trigger.js',
                 array('ee-dialog'),
                 EVENT_ESPRESSO_VERSION,
                 true
             );
             wp_enqueue_style(
                 'ee-newsletter-trigger-css',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css',
+                REG_CAF_ASSETS_URL.'ee-newsletter-trigger.css',
                 array(),
                 EVENT_ESPRESSO_VERSION
             );
@@ -213,7 +213,7 @@ 
     {
         wp_register_script(
             'ee-reg-reports-js',
-            REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
+            REG_CAF_ASSETS_URL.'ee-registration-admin-reports.js',
             array('google-charts'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -299,7 +299,7 @@ 
         $nonce_ref = 'get_newsletter_form_content_nonce';
         $this->_verify_nonce($nonce, $nonce_ref);
         // let's get the mtp for the incoming MTP_ ID
-        if (! isset($this->_req_data['GRP_ID'])) {
+        if ( ! isset($this->_req_data['GRP_ID'])) {
             EE_Error::add_error(
                 esc_html__(
                     'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).',
@@ -314,7 +314,7 @@ 
             $this->_return_json();
         }
         $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']);
-        if (! $MTPG instanceof EE_Message_Template_Group) {
+        if ( ! $MTPG instanceof EE_Message_Template_Group) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -339,12 +339,12 @@ 
             $field = $MTP->get('MTP_template_field');
             if ($field === 'content') {
                 $content = $MTP->get('MTP_content');
-                if (! empty($content['newsletter_content'])) {
+                if ( ! empty($content['newsletter_content'])) {
                     $template_fields['newsletter_content'] = $content['newsletter_content'];
                 }
                 continue;
             }
-            $template_fields[ $MTP->get('MTP_template_field') ] = $MTP->get('MTP_content');
+            $template_fields[$MTP->get('MTP_template_field')] = $MTP->get('MTP_content');
         }
         $this->_template_args['success'] = true;
         $this->_template_args['error'] = false;
@@ -446,17 +446,17 @@ 
                 $field_id = $field === '[NEWSLETTER_CONTENT]'
                     ? 'content'
                     : $field;
-                $field_id = 'batch-message-' . strtolower($field_id);
+                $field_id = 'batch-message-'.strtolower($field_id);
                 $available_shortcodes[] = '<span class="js-shortcode-selection" data-value="'
                                           . $shortcode
-                                          . '" data-linked-input-id="' . $field_id . '">'
+                                          . '" data-linked-input-id="'.$field_id.'">'
                                           . $shortcode
                                           . '</span>';
             }
-            $codes[ $field ] = implode(', ', $available_shortcodes);
+            $codes[$field] = implode(', ', $available_shortcodes);
         }
         $shortcodes = $codes;
-        $form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php';
+        $form_template = REG_CAF_TEMPLATE_PATH.'newsletter-send-form.template.php';
         $form_template_args = array(
             'form_action'       => admin_url('admin.php?page=espresso_registrations'),
             'form_route'        => 'newsletter_selected_send',
@@ -624,7 +624,7 @@ 
      */
     protected function _registration_reports()
     {
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+        $template_path = EE_ADMIN_TEMPLATE.'admin_reports.template.php';
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
             $template_path,
             $this->_reports_template_data,
@@ -679,7 +679,7 @@ 
             array_unshift($regs, $column_titles);
             // setup the date range.
             $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
+            $beginning_date = new DateTime("now ".$period, $DateTimeZone);
             $ending_date = new DateTime("now", $DateTimeZone);
             $subtitle = sprintf(
                 _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
@@ -699,7 +699,7 @@ 
                     '%sThere are currently no registration records in the last month for this report.%s',
                     'event_espresso'
                 ),
-                '<h2>' . $report_title . '</h2><p>',
+                '<h2>'.$report_title.'</h2><p>',
                 '</p>'
             ),
         );
@@ -752,7 +752,7 @@ 
             array_unshift($regs, $column_titles);
             // setup the date range.
             $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
+            $beginning_date = new DateTime("now ".$period, $DateTimeZone);
             $ending_date = new DateTime("now", $DateTimeZone);
             $subtitle = sprintf(
                 _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
@@ -772,7 +772,7 @@ 
                     '%sThere are currently no registration records in the last month for this report.%s',
                     'event_espresso'
                 ),
-                '<h2>' . $report_title . '</h2><p>',
+                '<h2>'.$report_title.'</h2><p>',
                 '</p>'
             ),
         );
@@ -798,7 +798,7 @@ 
         $reg_id = isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : null;
         /** @var EE_Registration $registration */
         $registration = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('An error occurred. There is no registration with ID (%d)', 'event_espresso'),
@@ -833,7 +833,7 @@ 
         if ($datetime instanceof EE_Datetime) {
             $datetime_label = $datetime->get_dtt_display_name(true);
             $datetime_label .= ! empty($datetime_label)
-                ? ' (' . $datetime->get_dtt_display_name() . ')'
+                ? ' ('.$datetime->get_dtt_display_name().')'
                 : $datetime->get_dtt_display_name();
         }
         $datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration
@@ -847,7 +847,7 @@ 
             )
             : '';
         $datetime_link = ! empty($datetime_link)
-            ? '<a href="' . $datetime_link . '">'
+            ? '<a href="'.$datetime_link.'">'
               . '<span id="checkin-dtt">'
               . $datetime_label
               . '</span></a>'
@@ -859,8 +859,8 @@ 
             ? $attendee->get_admin_details_link()
             : '';
         $attendee_link = ! empty($attendee_link)
-            ? '<a href="' . $attendee->get_admin_details_link() . '"'
-              . ' title="' . esc_html__('Click for attendee details', 'event_espresso') . '">'
+            ? '<a href="'.$attendee->get_admin_details_link().'"'
+              . ' title="'.esc_html__('Click for attendee details', 'event_espresso').'">'
               . '<span id="checkin-attendee-name">'
               . $attendee_name
               . '</span></a>'
@@ -869,25 +869,25 @@ 
             ? $registration->event()->get_admin_details_link()
             : '';
         $event_link = ! empty($event_link)
-            ? '<a href="' . $event_link . '"'
-              . ' title="' . esc_html__('Click here to edit event.', 'event_espresso') . '">'
+            ? '<a href="'.$event_link.'"'
+              . ' title="'.esc_html__('Click here to edit event.', 'event_espresso').'">'
               . '<span id="checkin-event-name">'
               . $registration->event_name()
               . '</span>'
               . '</a>'
             : '';
         $this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id)
-            ? '<h2>' . sprintf(
+            ? '<h2>'.sprintf(
                 esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'),
                 $attendee_link,
                 $datetime_link,
                 $event_link
-            ) . '</h2>'
+            ).'</h2>'
             : '';
         $this->_template_args['list_table_hidden_fields'] = ! empty($reg_id)
-            ? '<input type="hidden" name="_REG_ID" value="' . $reg_id . '">' : '';
+            ? '<input type="hidden" name="_REG_ID" value="'.$reg_id.'">' : '';
         $this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id)
-            ? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : '';
+            ? '<input type="hidden" name="DTT_ID" value="'.$dtt_id.'">' : '';
         $this->display_admin_list_table_page_with_no_sidebar();
     }
 
@@ -904,7 +904,7 @@ 
     public function toggle_checkin_status()
     {
         // first make sure we have the necessary data
-        if (! isset($this->_req_data['_regid'])) {
+        if ( ! isset($this->_req_data['_regid'])) {
             EE_Error::add_error(
                 esc_html__(
                     'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax',
@@ -926,7 +926,7 @@ 
         // beautiful! Made it this far so let's get the status.
         $new_status = new CheckinStatusDashicon($this->_toggle_checkin_status());
         // setup new class to return via ajax
-        $this->_template_args['admin_page_content'] = 'clickable trigger-checkin ' . $new_status->cssClasses();
+        $this->_template_args['admin_page_content'] = 'clickable trigger-checkin '.$new_status->cssClasses();
         $this->_template_args['success'] = true;
         $this->_return_json();
     }
@@ -952,7 +952,7 @@ 
         );
         $new_status = false;
         // bulk action check in toggle
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
             // cycle thru checkboxes
             while (list($REG_ID, $value) = each($this->_req_data['checkbox'])) {
                 $DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
@@ -1022,9 +1022,9 @@ 
             '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
         );
         $errors = 0;
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
             while (list($CHK_ID, $value) = each($this->_req_data['checkbox'])) {
-                if (! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
+                if ( ! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
                     $errors++;
                 }
             }
@@ -1070,8 +1070,8 @@ 
             'DTT_ID'  => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
             '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
         );
-        if (! empty($this->_req_data['CHK_ID'])) {
-            if (! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
+        if ( ! empty($this->_req_data['CHK_ID'])) {
+            if ( ! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
                 EE_Error::add_error(
                     esc_html__('Something went wrong and this check-in record was not deleted', 'event_espresso'),
                     __FILE__,
@@ -1140,27 +1140,27 @@ 
                 'desc'  => $checked_never->legendLabel(),
             ),
             'approved_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_approved,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
             ),
             'cancelled_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_cancelled,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
             ),
             'declined_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_declined,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
             ),
             'not_approved'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_not_approved,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
             ),
             'pending_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_pending_payment,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
             ),
             'wait_list'        => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_wait_list,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
             ),
         );
@@ -1169,10 +1169,10 @@ 
         /** @var EE_Event $event */
         $event = EEM_Event::instance()->get_one_by_ID($event_id);
         $this->_template_args['before_list_table'] = $event instanceof EE_Event
-            ? '<h2>' . sprintf(
+            ? '<h2>'.sprintf(
                 esc_html__('Viewing Registrations for Event: %s', 'event_espresso'),
                 EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name')
-            ) . '</h2>'
+            ).'</h2>'
             : '';
         // need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on
         // the event.
@@ -1190,12 +1190,12 @@ 
             $this->_template_args['before_list_table'] .= ' &nbsp;<span class="drk-grey-text">';
             $this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>';
             $this->_template_args['before_list_table'] .= $datetime->name();
-            $this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )';
+            $this->_template_args['before_list_table'] .= ' ( '.$datetime->date_and_time_range().' )';
             $this->_template_args['before_list_table'] .= '</span></h2>';
         }
         // if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status
         // column represents
-        if (! $datetime instanceof EE_Datetime) {
+        if ( ! $datetime instanceof EE_Datetime) {
             $this->_template_args['before_list_table'] .= '<br><p class="description">'
                                                           . esc_html__(
                                                               'In this view, the check-in status represents the latest check-in record for the registration in that row.',