eventespresso / event-espresso-core

core/business/EE_Registration_Processor.class.php

Indentation +825 added lines, -825 removed lines

@@ -27,830 +27,830 @@
  */
 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 = [];
-
-    /**
-     * reg status at the end of the request after all processing.
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected $_new_reg_status = [];
-
-    /**
-     * amounts paid at the end of the request after all processing.
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected static $_amount_paid = [];
-
-    /**
-     * 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 RequestInterface $request
-     */
-    protected $request;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param RequestInterface|null $request
-     * @return EE_Registration_Processor instance
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function instance(RequestInterface $request = null)
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registration_Processor) {
-            if (! $request instanceof RequestInterface) {
-                $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
-            }
-            self::$_instance = new self($request);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * EE_Registration_Processor constructor.
-     *
-     * @param RequestInterface $request
-     */
-    public function __construct(RequestInterface $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,
-            new Context(
-                __METHOD__,
-                esc_html__(
-                    'Executed when the registration status is updated during the registration process just prior to triggering notifications.',
-                    'event_espresso'
-                )
-            )
-        );
-        $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()),
-                false,
-                new Context(
-                    __METHOD__,
-                    esc_html__(
-                        'Executed when the registration status is manually updated during the reg process.',
-                        'event_espresso'
-                    )
-                )
-            );
-            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() === RegStatus::INCOMPLETE) {
-            // grab default reg status for the event, if set
-            $event_default_registration_status = $registration->defaultRegistrationStatus();
-            // 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 === RegStatus::APPROVED
-                ? RegStatus::PENDING_PAYMENT
-                : $STS_ID;
-            // set incoming REG_Status
-            $this->set_new_reg_status($registration->ID(), $STS_ID);
-            $context = $context instanceof ContextInterface
-                ? $context
-                : new Context(
-                    __METHOD__,
-                    esc_html__(
-                        'Executed when the registration status is updated to the default reg status during the registration process.',
-                        'event_espresso'
-                    )
-                );
-            $registration->set_status($STS_ID, false, $context);
-            if ($save) {
-                $registration->save();
-            }
-            // don't trigger notifications during IPNs because they will get triggered by
-            // EventEspresso\core\services\payments\PostPaymentProcessor
-            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 !== RegStatus::CANCELLED
-            && $reg_status !== RegStatus::DECLINED
-            && $reg_status !== RegStatus::APPROVED
-            && $registration->defaultRegistrationStatus() === RegStatus::APPROVED
-        ) {
-            // set incoming REG_Status
-            $this->set_new_reg_status($registration->ID(), RegStatus::APPROVED);
-            // toggle status to approved
-            $registration->set_status(
-                RegStatus::APPROVED,
-                false,
-                new Context(
-                    __METHOD__,
-                    esc_html__(
-                        'Executed when the registration status is updated for events with a default reg status of RegStatus::APPROVED.',
-                        'event_espresso'
-                    )
-                )
-            );
-            if ($save) {
-                $registration->save();
-            }
-            // don't trigger notifications during IPNs because they will get triggered by
-            // EventEspresso\core\services\payments\PostPaymentProcessor
-            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 = []
-    ) {
-        // 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 = [];
+
+	/**
+	 * reg status at the end of the request after all processing.
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected $_new_reg_status = [];
+
+	/**
+	 * amounts paid at the end of the request after all processing.
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected static $_amount_paid = [];
+
+	/**
+	 * 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 RequestInterface $request
+	 */
+	protected $request;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param RequestInterface|null $request
+	 * @return EE_Registration_Processor instance
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function instance(RequestInterface $request = null)
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Registration_Processor) {
+			if (! $request instanceof RequestInterface) {
+				$request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
+			}
+			self::$_instance = new self($request);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * EE_Registration_Processor constructor.
+	 *
+	 * @param RequestInterface $request
+	 */
+	public function __construct(RequestInterface $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,
+			new Context(
+				__METHOD__,
+				esc_html__(
+					'Executed when the registration status is updated during the registration process just prior to triggering notifications.',
+					'event_espresso'
+				)
+			)
+		);
+		$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()),
+				false,
+				new Context(
+					__METHOD__,
+					esc_html__(
+						'Executed when the registration status is manually updated during the reg process.',
+						'event_espresso'
+					)
+				)
+			);
+			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() === RegStatus::INCOMPLETE) {
+			// grab default reg status for the event, if set
+			$event_default_registration_status = $registration->defaultRegistrationStatus();
+			// 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 === RegStatus::APPROVED
+				? RegStatus::PENDING_PAYMENT
+				: $STS_ID;
+			// set incoming REG_Status
+			$this->set_new_reg_status($registration->ID(), $STS_ID);
+			$context = $context instanceof ContextInterface
+				? $context
+				: new Context(
+					__METHOD__,
+					esc_html__(
+						'Executed when the registration status is updated to the default reg status during the registration process.',
+						'event_espresso'
+					)
+				);
+			$registration->set_status($STS_ID, false, $context);
+			if ($save) {
+				$registration->save();
+			}
+			// don't trigger notifications during IPNs because they will get triggered by
+			// EventEspresso\core\services\payments\PostPaymentProcessor
+			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 !== RegStatus::CANCELLED
+			&& $reg_status !== RegStatus::DECLINED
+			&& $reg_status !== RegStatus::APPROVED
+			&& $registration->defaultRegistrationStatus() === RegStatus::APPROVED
+		) {
+			// set incoming REG_Status
+			$this->set_new_reg_status($registration->ID(), RegStatus::APPROVED);
+			// toggle status to approved
+			$registration->set_status(
+				RegStatus::APPROVED,
+				false,
+				new Context(
+					__METHOD__,
+					esc_html__(
+						'Executed when the registration status is updated for events with a default reg status of RegStatus::APPROVED.',
+						'event_espresso'
+					)
+				)
+			);
+			if ($save) {
+				$registration->save();
+			}
+			// don't trigger notifications during IPNs because they will get triggered by
+			// EventEspresso\core\services\payments\PostPaymentProcessor
+			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 = []
+	) {
+		// 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() === RegStatus::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(), RegStatus::APPROVED);
-            // toggle status to approved
-            $registration->set_status(
-                RegStatus::APPROVED,
-                false,
-                new Context(
-                    __METHOD__,
-                    esc_html__(
-                        'Executed when the registration status is updated to RegStatus::APPROVED when no monies are owing.',
-                        'event_espresso'
-                    )
-                )
-            );
-            if ($save) {
-                $registration->save();
-            }
-            // don't trigger notifications during IPNs because they will get triggered by
-            // EventEspresso\core\services\payments\PostPaymentProcessor
-            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 = [])
-    {
-        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 (
-                ! $this->request->getRequestParam('non_primary_reg_notification', 0, 'int')
-                && ! $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 = []
-    ) {
-        // 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()) === RegStatus::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
-     * @throws ReflectionException
-     */
-    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
-     * @throws ReflectionException
-     */
-    public function fix_reg_final_price_rounding_issue($transaction)
-    {
-        $reg_final_price_sum = EEM_Registration::instance()->sum(
-            [
-                [
-                    '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.0) {
-            $a_reg = EEM_Registration::instance()->get_one(
-                [
-                    [
-                        'TXN_ID' => $transaction->ID(),
-                    ],
-                ]
-            );
-            return $a_reg instanceof EE_Registration
-                   && $a_reg->save(['REG_final_price' => $a_reg->final_price() + $diff]);
-        }
-        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
-     * @throws ReflectionException
-     */
-    public function update_registration_after_being_canceled_or_declined(
-        EE_Registration $registration,
-        array $closed_reg_statuses = [],
-        $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
-     * @throws ReflectionException
-     */
-    public function update_canceled_or_declined_registration_after_being_reinstated(
-        EE_Registration $registration,
-        array $closed_reg_statuses = [],
-        $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.
-     *
-     * @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 UnexpectedEntityException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated
-     * @since 4.9.1
-     */
-    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
-     *
-     * @param int                   $att_nmbr
-     * @param EE_Line_Item | string $item
-     * @return RegUrlLink
-     * @throws InvalidArgumentException
-     * @deprecated
-     * @since 4.9.1
-     */
-    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
-     *
-     * @param EE_Registration $registration
-     * @return RegCode
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @since 4.9.1
-     * @deprecated
-     */
-    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() === RegStatus::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(), RegStatus::APPROVED);
+			// toggle status to approved
+			$registration->set_status(
+				RegStatus::APPROVED,
+				false,
+				new Context(
+					__METHOD__,
+					esc_html__(
+						'Executed when the registration status is updated to RegStatus::APPROVED when no monies are owing.',
+						'event_espresso'
+					)
+				)
+			);
+			if ($save) {
+				$registration->save();
+			}
+			// don't trigger notifications during IPNs because they will get triggered by
+			// EventEspresso\core\services\payments\PostPaymentProcessor
+			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 = [])
+	{
+		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 (
+				! $this->request->getRequestParam('non_primary_reg_notification', 0, 'int')
+				&& ! $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 = []
+	) {
+		// 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()) === RegStatus::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
+	 * @throws ReflectionException
+	 */
+	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
+	 * @throws ReflectionException
+	 */
+	public function fix_reg_final_price_rounding_issue($transaction)
+	{
+		$reg_final_price_sum = EEM_Registration::instance()->sum(
+			[
+				[
+					'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.0) {
+			$a_reg = EEM_Registration::instance()->get_one(
+				[
+					[
+						'TXN_ID' => $transaction->ID(),
+					],
+				]
+			);
+			return $a_reg instanceof EE_Registration
+				   && $a_reg->save(['REG_final_price' => $a_reg->final_price() + $diff]);
+		}
+		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
+	 * @throws ReflectionException
+	 */
+	public function update_registration_after_being_canceled_or_declined(
+		EE_Registration $registration,
+		array $closed_reg_statuses = [],
+		$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
+	 * @throws ReflectionException
+	 */
+	public function update_canceled_or_declined_registration_after_being_reinstated(
+		EE_Registration $registration,
+		array $closed_reg_statuses = [],
+		$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.
+	 *
+	 * @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 UnexpectedEntityException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated
+	 * @since 4.9.1
+	 */
+	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
+	 *
+	 * @param int                   $att_nmbr
+	 * @param EE_Line_Item | string $item
+	 * @return RegUrlLink
+	 * @throws InvalidArgumentException
+	 * @deprecated
+	 * @since 4.9.1
+	 */
+	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
+	 *
+	 * @param EE_Registration $registration
+	 * @return RegCode
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @since 4.9.1
+	 * @deprecated
+	 */
+	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 +25 added lines, -25 removed lines

@@ -82,8 +82,8 @@ 
     public static function instance(RequestInterface $request = null)
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registration_Processor) {
-            if (! $request instanceof RequestInterface) {
+        if ( ! self::$_instance instanceof EE_Registration_Processor) {
+            if ( ! $request instanceof RequestInterface) {
                 $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
             }
             self::$_instance = new self($request);
@@ -109,7 +109,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;
     }
 
 
@@ -120,8 +120,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;
         }
     }
 
@@ -132,7 +132,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;
     }
 
 
@@ -142,7 +142,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;
     }
 
 
@@ -219,7 +219,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',
@@ -303,7 +303,7 @@ 
             }
             // don't trigger notifications during IPNs because they will get triggered by
             // EventEspresso\core\services\payments\PostPaymentProcessor
-            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);
             }
@@ -372,7 +372,7 @@ 
             }
             // don't trigger notifications during IPNs because they will get triggered by
             // EventEspresso\core\services\payments\PostPaymentProcessor
-            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);
             }
@@ -420,7 +420,7 @@ 
         // 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'])
+        $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']
@@ -445,14 +445,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(), RegStatus::APPROVED);
             // toggle status to approved
@@ -472,7 +472,7 @@ 
             }
             // don't trigger notifications during IPNs because they will get triggered by
             // EventEspresso\core\services\payments\PostPaymentProcessor
-            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);
             }
@@ -506,7 +506,7 @@ 
     public function trigger_registration_update_notifications($registration, array $additional_details = [])
     {
         try {
-            if (! $registration instanceof EE_Registration) {
+            if ( ! $registration instanceof EE_Registration) {
                 throw new EE_Error(
                     esc_html__('An invalid registration was received.', 'event_espresso')
                 );
@@ -597,8 +597,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();
                 }
@@ -638,7 +638,7 @@ 
             ],
             'REG_final_price'
         );
-        $diff                = $transaction->total() - $reg_final_price_sum;
+        $diff = $transaction->total() - $reg_final_price_sum;
         // ok then, just grab one of the registrations
         if ($diff !== 0.0) {
             $a_reg = EEM_Registration::instance()->get_one(
@@ -675,11 +675,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();
@@ -711,7 +711,7 @@ 
             return false;
         }
         $ticket = $registration->ticket();
-        if (! $ticket instanceof EE_Ticket) {
+        if ( ! $ticket instanceof EE_Ticket) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -761,7 +761,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()'
@@ -771,7 +771,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'),
@@ -809,7 +809,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'
@@ -835,7 +835,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/domain/values/gateways/GracePeriod.php

Indentation +158 added lines, -158 removed lines

@@ -23,162 +23,162 @@
  */
 class GracePeriod extends WordPressOption
 {
-    private const OPTION_NAME        = 'ee_gateway_grace_period';
-
-    private const EXPIRY_DATE_FORMAT = 'Y-m-d H:i:s';
-
-    public const  LICENSE_ACTIVE     = 'active';
-
-    public const  LICENSE_DECAF      = 'decaf';
-
-    public const  LICENSE_EXPIRED    = 'expired';
-
-
-    protected DateTimeImmutable $current_date;
-
-    protected DateTimeImmutable $grace_period_start_date;
-
-    protected DateTimeZone $UTC_TZ;
-
-    protected array $grace_periods = [
-        GracePeriod::LICENSE_ACTIVE  => 14,
-        GracePeriod::LICENSE_EXPIRED => 14,
-        GracePeriod::LICENSE_DECAF   => 28,
-    ];
-
-
-    /**
-     * @throws Exception
-     */
-    public function __construct()
-    {
-        parent::__construct(GracePeriod::OPTION_NAME, 0);
-        $this->UTC_TZ                  = new DateTimeZone('UTC');
-        $this->current_date            = new DateTimeImmutable('now', $this->UTC_TZ);
-        $this->grace_period_start_date = $this->gracePeriodStartDate();
-    }
-
-
-    /**
-     * @param string $license_status
-     * @param string $license_expires
-     * @return bool
-     * @throws Exception
-     */
-    public function withinGracePeriod(string $license_status, string $license_expires): bool
-    {
-        if ($license_status === GracePeriod::LICENSE_ACTIVE) {
-            return true;
-        }
-        $license_expires_datetime = $this->licenseExpiresDateTime($license_expires);
-        if ($license_expires_datetime instanceof DateTimeImmutable) {
-            $this->resetGracePeriodIfLicenseExpired($this->licenseExpiresDateTime($license_expires));
-        }
-        return $this->daysLeft() <= $this->gracePeriodForLicense($license_status);
-    }
-
-
-    /**
-     * @return DateTimeImmutable
-     * @throws Exception
-     */
-    protected function gracePeriodStartDate(): DateTimeImmutable
-    {
-        $grace_period_start_timestamp = $this->loadOption();
-        if (! $grace_period_start_timestamp) {
-            $grace_period_start_timestamp = time();
-            $this->updateOption($grace_period_start_timestamp, true);
-        }
-        return new DateTimeImmutable("@$grace_period_start_timestamp", $this->UTC_TZ);
-    }
-
-
-    /**
-     * will reset the grace period start date if the license is expired
-     *
-     * @param DateTimeImmutable $license_expiry_date
-     * @throws Exception
-     */
-    protected function resetGracePeriodIfLicenseExpired(DateTimeImmutable $license_expiry_date)
-    {
-        // return if license has not expired
-        if ($license_expiry_date >= $this->current_date) {
-            return;
-        }
-        // return if grace period start date is already set to the date the license expired
-        if ($license_expiry_date == $this->grace_period_start_date) {
-            return;
-        }
-        // reset grace period start date to the date the license expired
-        $grace_period_timestamp = $license_expiry_date->getTimestamp();
-        $this->updateOption($grace_period_timestamp, true);
-        $this->grace_period_start_date = new DateTimeImmutable("@$grace_period_timestamp", $this->UTC_TZ);
-    }
-
-
-    /**
-     * returns the number of days between the grace period start date and the current date
-     *
-     * @return DateInterval
-     * @throws Exception
-     */
-    protected function gracePeriodDateInterval(): DateInterval
-    {
-        return $this->grace_period_start_date->diff($this->current_date, true);
-    }
-
-
-    /**
-     * returns the number of days left in the grace period
-     *
-     * @return int
-     * @throws Exception
-     */
-    protected function daysLeft(): int
-    {
-        return max((int) $this->gracePeriodDateInterval()->format('%a'), 0);
-    }
-
-
-    /**
-     * @param string $license_status
-     * @return int
-     */
-    protected function gracePeriodForLicense(string $license_status): int
-    {
-        return $this->grace_periods[ $license_status ] ?? 0;
-    }
-
-
-    /**
-     * @param string $license_expires
-     * @return DateTimeImmutable|null
-     */
-    protected function licenseExpiresDateTime(string $license_expires): ?DateTimeImmutable
-    {
-        if (empty($license_expires)) {
-            return null;
-        }
-        $dateTime = DateTime::createFromFormat(GracePeriod::EXPIRY_DATE_FORMAT, $license_expires);
-        $errors   = DateTime::getLastErrors();
-        // return null if date could not be created or there were errors
-        if (
-            $dateTime === false
-            || (is_array($errors) && ($errors['warning_count'] > 0 || $errors['error_count'] > 0))
-        ) {
-            return null;
-        }
-        return DateTimeImmutable::createFromMutable($dateTime);
-    }
-
-
-    /**
-     * override parent method to prevent deletion
-     *
-     * @return bool
-     */
-    public function deleteOption(): bool
-    {
-        return false;
-    }
+	private const OPTION_NAME        = 'ee_gateway_grace_period';
+
+	private const EXPIRY_DATE_FORMAT = 'Y-m-d H:i:s';
+
+	public const  LICENSE_ACTIVE     = 'active';
+
+	public const  LICENSE_DECAF      = 'decaf';
+
+	public const  LICENSE_EXPIRED    = 'expired';
+
+
+	protected DateTimeImmutable $current_date;
+
+	protected DateTimeImmutable $grace_period_start_date;
+
+	protected DateTimeZone $UTC_TZ;
+
+	protected array $grace_periods = [
+		GracePeriod::LICENSE_ACTIVE  => 14,
+		GracePeriod::LICENSE_EXPIRED => 14,
+		GracePeriod::LICENSE_DECAF   => 28,
+	];
+
+
+	/**
+	 * @throws Exception
+	 */
+	public function __construct()
+	{
+		parent::__construct(GracePeriod::OPTION_NAME, 0);
+		$this->UTC_TZ                  = new DateTimeZone('UTC');
+		$this->current_date            = new DateTimeImmutable('now', $this->UTC_TZ);
+		$this->grace_period_start_date = $this->gracePeriodStartDate();
+	}
+
+
+	/**
+	 * @param string $license_status
+	 * @param string $license_expires
+	 * @return bool
+	 * @throws Exception
+	 */
+	public function withinGracePeriod(string $license_status, string $license_expires): bool
+	{
+		if ($license_status === GracePeriod::LICENSE_ACTIVE) {
+			return true;
+		}
+		$license_expires_datetime = $this->licenseExpiresDateTime($license_expires);
+		if ($license_expires_datetime instanceof DateTimeImmutable) {
+			$this->resetGracePeriodIfLicenseExpired($this->licenseExpiresDateTime($license_expires));
+		}
+		return $this->daysLeft() <= $this->gracePeriodForLicense($license_status);
+	}
+
+
+	/**
+	 * @return DateTimeImmutable
+	 * @throws Exception
+	 */
+	protected function gracePeriodStartDate(): DateTimeImmutable
+	{
+		$grace_period_start_timestamp = $this->loadOption();
+		if (! $grace_period_start_timestamp) {
+			$grace_period_start_timestamp = time();
+			$this->updateOption($grace_period_start_timestamp, true);
+		}
+		return new DateTimeImmutable("@$grace_period_start_timestamp", $this->UTC_TZ);
+	}
+
+
+	/**
+	 * will reset the grace period start date if the license is expired
+	 *
+	 * @param DateTimeImmutable $license_expiry_date
+	 * @throws Exception
+	 */
+	protected function resetGracePeriodIfLicenseExpired(DateTimeImmutable $license_expiry_date)
+	{
+		// return if license has not expired
+		if ($license_expiry_date >= $this->current_date) {
+			return;
+		}
+		// return if grace period start date is already set to the date the license expired
+		if ($license_expiry_date == $this->grace_period_start_date) {
+			return;
+		}
+		// reset grace period start date to the date the license expired
+		$grace_period_timestamp = $license_expiry_date->getTimestamp();
+		$this->updateOption($grace_period_timestamp, true);
+		$this->grace_period_start_date = new DateTimeImmutable("@$grace_period_timestamp", $this->UTC_TZ);
+	}
+
+
+	/**
+	 * returns the number of days between the grace period start date and the current date
+	 *
+	 * @return DateInterval
+	 * @throws Exception
+	 */
+	protected function gracePeriodDateInterval(): DateInterval
+	{
+		return $this->grace_period_start_date->diff($this->current_date, true);
+	}
+
+
+	/**
+	 * returns the number of days left in the grace period
+	 *
+	 * @return int
+	 * @throws Exception
+	 */
+	protected function daysLeft(): int
+	{
+		return max((int) $this->gracePeriodDateInterval()->format('%a'), 0);
+	}
+
+
+	/**
+	 * @param string $license_status
+	 * @return int
+	 */
+	protected function gracePeriodForLicense(string $license_status): int
+	{
+		return $this->grace_periods[ $license_status ] ?? 0;
+	}
+
+
+	/**
+	 * @param string $license_expires
+	 * @return DateTimeImmutable|null
+	 */
+	protected function licenseExpiresDateTime(string $license_expires): ?DateTimeImmutable
+	{
+		if (empty($license_expires)) {
+			return null;
+		}
+		$dateTime = DateTime::createFromFormat(GracePeriod::EXPIRY_DATE_FORMAT, $license_expires);
+		$errors   = DateTime::getLastErrors();
+		// return null if date could not be created or there were errors
+		if (
+			$dateTime === false
+			|| (is_array($errors) && ($errors['warning_count'] > 0 || $errors['error_count'] > 0))
+		) {
+			return null;
+		}
+		return DateTimeImmutable::createFromMutable($dateTime);
+	}
+
+
+	/**
+	 * override parent method to prevent deletion
+	 *
+	 * @return bool
+	 */
+	public function deleteOption(): bool
+	{
+		return false;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -85,7 +85,7 @@ 
     protected function gracePeriodStartDate(): DateTimeImmutable
     {
         $grace_period_start_timestamp = $this->loadOption();
-        if (! $grace_period_start_timestamp) {
+        if ( ! $grace_period_start_timestamp) {
             $grace_period_start_timestamp = time();
             $this->updateOption($grace_period_start_timestamp, true);
         }
@@ -146,7 +146,7 @@ 
      */
     protected function gracePeriodForLicense(string $license_status): int
     {
-        return $this->grace_periods[ $license_status ] ?? 0;
+        return $this->grace_periods[$license_status] ?? 0;
     }
 
 

core/domain/services/contexts/RequestTypeContextDetector.php

Indentation +280 added lines, -280 removed lines

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

core/domain/services/capabilities/FeatureFlag.php

Indentation +207 added lines, -207 removed lines

@@ -11,211 +11,211 @@
 class FeatureFlag
 {
 
-    /**
-     * Whether to use the New Event Editor (EDTR) or continue using the legacy Event Editor
-     * deafult: Enabled for Caffeinated sites, disabled for Decaf or Multisite installs
-     */
-    public const  USE_ADVANCED_EVENT_EDITOR = 'ee_advanced_event_editor';
-
-    /**
-     * Whether to enable the Bulk Edit feature in the Advanced Event Editor (EDTR)
-     * default: Enabled for Caffeinated sites, disabled for Decaf or Multisite installs
-     */
-    public const  USE_EVENT_EDITOR_BULK_EDIT = 'ee_event_editor_bulk_edit';
-
-    /**
-     * Whether to enable the new Default Ticket Manager in the EDTR
-     * default: Enabled
-     */
-    public const  USE_DEFAULT_TICKET_MANAGER = 'use_default_ticket_manager';
-
-    /**
-     * Whether to enable the Rich Text Editor for the Event Description field in the EDTR or use tinymce
-     * default: Disabled
-     */
-    public const  USE_EVENT_DESCRIPTION_RTE = 'use_event_description_rte';
-
-    /**
-     * Whether to enable the Rich Text Editor for all other RTE fields in the EDTR
-     * default: Disabled
-     */
-    public const  USE_EXPERIMENTAL_RTE = 'use_experimental_rte';
-
-    /**
-     * Whether to enable the new Registration Form Builder in the EDTR
-     * or continue using the legacy Question Groups and Registration Form admin pages
-     * default: Disabled
-     */
-    public const  USE_REG_FORM_BUILDER = 'use_reg_form_builder';
-
-    /**
-     * Whether to enable the new Registration Options meta box in the EDTR
-     * or continue using the legacy Event Registration Options
-     * default: Disabled
-     */
-    public const  USE_REG_OPTIONS_META_BOX = 'use_reg_options_meta_box';
-
-    /**
-     * Whether to enable the new Single Page Checkout form refactor changes
-     * default: Disabled
-     *
-     * @since 5.0.18.p
-     */
-    public const  USE_SPCO_FORM_REFACTOR = 'use_spco_form_refactor';
-
-    /**
-     * Whether to enable the new Reg Form Ticket Questions functionality
-     * default: Disabled
-     */
-    public const  USE_REG_FORM_TICKET_QUESTIONS = 'use_reg_form_ticket_questions';
-
-    /**
-     * Whether to use the EDD Plugin Licensing system to manage licenses for the EE plugins
-     * default: Disabled
-     */
-    public const USE_EDD_PLUGIN_LICENSING = 'use_edd_plugin_licensing';
-
-    /**
-     * Whether to use the new Datetime Status Controls in the EDTR
-     * default: Disabled
-     */
-    public const USE_DATETIME_STATUS_CONTROLS = 'use_datetime_status_controls';
-
-    /**
-     * Whether to apply Gateway Partner fees to transactions
-     * default: Disabled
-     */
-    public const USE_PAYMENT_PROCESSOR_FEES = 'use_payment_processor_fees';
-
-
-    public static function getFormOptions(): array
-    {
-        return [
-            FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT    => [
-                'name'            => esc_html__('Event Editor Bulk Edit', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Event Editor Bulk Edit', 'event_espresso'),
-                'help_text'       => sprintf(
-                    esc_html__(
-                        'Whether to enable the Bulk Edit feature in the Advanced Event Editor (EDTR).%1$s%2$sPLEASE NOTE: Bulk Editing is ALWAYS enabled if the Recurring Events Manager add-on is active.%3$s%1$s default: Enabled for Caffeinated sites, disabled for Decaf or Multisite installs',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    '<strong>',
-                    '</strong>'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_DEFAULT_TICKET_MANAGER    => [
-                'name'            => esc_html__('Default Ticket Manager', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Default Ticket Manager', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to enable the new Default Ticket Manager in the EDTR. default: Enabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_EVENT_DESCRIPTION_RTE     => [
-                'name'            => esc_html__('Event Description RTE', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Rich Text Editor for Event Description', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to enable the Rich Text Editor for the Event Description field in the EDTR or use tinymce. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_EXPERIMENTAL_RTE          => [
-                'name'            => esc_html__('Rich Text Editor', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Rich Text Editor for other RTE fields', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to enable the Rich Text Editor for all other RTE fields in the EDTR. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_REG_FORM_BUILDER          => [
-                'name'            => esc_html__('Registration Form Builder', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Registration Form Builder', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to enable the new Registration Form Builder in the EDTR or continue using the legacy Question Groups and Registration Form admin pages. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_REG_OPTIONS_META_BOX      => [
-                'name'            => esc_html__('Registration Options', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Registration Options', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to enable the new Registration Options meta box in the EDTR or continue using the legacy Event Registration Options. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_SPCO_FORM_REFACTOR        => [
-                'name'            => esc_html__('SPCO Form Refactor', 'event_espresso'),
-                'html_label_text' => esc_html__('Use SPCO Form Refactor', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to enable the new Single Page Checkout form refactor changes or continue using the legacy Single Page Checkout form. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_REG_FORM_TICKET_QUESTIONS => [
-                'name'            => esc_html__('Reg Form Ticket Questions', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Reg Form Ticket Questions', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to enable the new Reg Form Ticket Questions functionality. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_EDD_PLUGIN_LICENSING      => [
-                'name'            => esc_html__('EDD Plugin Licensing', 'event_espresso'),
-                'html_label_text' => esc_html__('Use EDD Plugin Licensing', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to use the EDD Plugin Licensing system to manage licenses for the EE plugins. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => defined('EE_USE_EDD_PLUGIN_LICENSING'),
-                'overridden_by'   => defined('EE_USE_EDD_PLUGIN_LICENSING')
-                    ? sprintf(
-                        esc_html__(
-                            '%1$sCurrently overriden by the %2$s constant in wp-config.php%3$s',
-                            'event_espresso'
-                        ),
-                        '<br><span class="ee-status--warning">',
-                        'EE_USE_EDD_PLUGIN_LICENSING',
-                        '</span>'
-                    )
-                    : '',
-            ],
-            FeatureFlag::USE_DATETIME_STATUS_CONTROLS  => [
-                'name'            => esc_html__('Datetime Status Controls', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Datetime Status Controls', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to use the new Datetime Status Controls in the EDTR. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_PAYMENT_PROCESSOR_FEES    => [
-                'name'            => esc_html__('Gateway Partner Fees', 'event_espresso'),
-                'html_label_text' => esc_html__('Apply Payment Processor Fees', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to apply Gateway Partner fees to transactions. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-        ];
-    }
+	/**
+	 * Whether to use the New Event Editor (EDTR) or continue using the legacy Event Editor
+	 * deafult: Enabled for Caffeinated sites, disabled for Decaf or Multisite installs
+	 */
+	public const  USE_ADVANCED_EVENT_EDITOR = 'ee_advanced_event_editor';
+
+	/**
+	 * Whether to enable the Bulk Edit feature in the Advanced Event Editor (EDTR)
+	 * default: Enabled for Caffeinated sites, disabled for Decaf or Multisite installs
+	 */
+	public const  USE_EVENT_EDITOR_BULK_EDIT = 'ee_event_editor_bulk_edit';
+
+	/**
+	 * Whether to enable the new Default Ticket Manager in the EDTR
+	 * default: Enabled
+	 */
+	public const  USE_DEFAULT_TICKET_MANAGER = 'use_default_ticket_manager';
+
+	/**
+	 * Whether to enable the Rich Text Editor for the Event Description field in the EDTR or use tinymce
+	 * default: Disabled
+	 */
+	public const  USE_EVENT_DESCRIPTION_RTE = 'use_event_description_rte';
+
+	/**
+	 * Whether to enable the Rich Text Editor for all other RTE fields in the EDTR
+	 * default: Disabled
+	 */
+	public const  USE_EXPERIMENTAL_RTE = 'use_experimental_rte';
+
+	/**
+	 * Whether to enable the new Registration Form Builder in the EDTR
+	 * or continue using the legacy Question Groups and Registration Form admin pages
+	 * default: Disabled
+	 */
+	public const  USE_REG_FORM_BUILDER = 'use_reg_form_builder';
+
+	/**
+	 * Whether to enable the new Registration Options meta box in the EDTR
+	 * or continue using the legacy Event Registration Options
+	 * default: Disabled
+	 */
+	public const  USE_REG_OPTIONS_META_BOX = 'use_reg_options_meta_box';
+
+	/**
+	 * Whether to enable the new Single Page Checkout form refactor changes
+	 * default: Disabled
+	 *
+	 * @since 5.0.18.p
+	 */
+	public const  USE_SPCO_FORM_REFACTOR = 'use_spco_form_refactor';
+
+	/**
+	 * Whether to enable the new Reg Form Ticket Questions functionality
+	 * default: Disabled
+	 */
+	public const  USE_REG_FORM_TICKET_QUESTIONS = 'use_reg_form_ticket_questions';
+
+	/**
+	 * Whether to use the EDD Plugin Licensing system to manage licenses for the EE plugins
+	 * default: Disabled
+	 */
+	public const USE_EDD_PLUGIN_LICENSING = 'use_edd_plugin_licensing';
+
+	/**
+	 * Whether to use the new Datetime Status Controls in the EDTR
+	 * default: Disabled
+	 */
+	public const USE_DATETIME_STATUS_CONTROLS = 'use_datetime_status_controls';
+
+	/**
+	 * Whether to apply Gateway Partner fees to transactions
+	 * default: Disabled
+	 */
+	public const USE_PAYMENT_PROCESSOR_FEES = 'use_payment_processor_fees';
+
+
+	public static function getFormOptions(): array
+	{
+		return [
+			FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT    => [
+				'name'            => esc_html__('Event Editor Bulk Edit', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Event Editor Bulk Edit', 'event_espresso'),
+				'help_text'       => sprintf(
+					esc_html__(
+						'Whether to enable the Bulk Edit feature in the Advanced Event Editor (EDTR).%1$s%2$sPLEASE NOTE: Bulk Editing is ALWAYS enabled if the Recurring Events Manager add-on is active.%3$s%1$s default: Enabled for Caffeinated sites, disabled for Decaf or Multisite installs',
+						'event_espresso'
+					),
+					'<br/>',
+					'<strong>',
+					'</strong>'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_DEFAULT_TICKET_MANAGER    => [
+				'name'            => esc_html__('Default Ticket Manager', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Default Ticket Manager', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to enable the new Default Ticket Manager in the EDTR. default: Enabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_EVENT_DESCRIPTION_RTE     => [
+				'name'            => esc_html__('Event Description RTE', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Rich Text Editor for Event Description', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to enable the Rich Text Editor for the Event Description field in the EDTR or use tinymce. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_EXPERIMENTAL_RTE          => [
+				'name'            => esc_html__('Rich Text Editor', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Rich Text Editor for other RTE fields', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to enable the Rich Text Editor for all other RTE fields in the EDTR. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_REG_FORM_BUILDER          => [
+				'name'            => esc_html__('Registration Form Builder', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Registration Form Builder', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to enable the new Registration Form Builder in the EDTR or continue using the legacy Question Groups and Registration Form admin pages. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_REG_OPTIONS_META_BOX      => [
+				'name'            => esc_html__('Registration Options', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Registration Options', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to enable the new Registration Options meta box in the EDTR or continue using the legacy Event Registration Options. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_SPCO_FORM_REFACTOR        => [
+				'name'            => esc_html__('SPCO Form Refactor', 'event_espresso'),
+				'html_label_text' => esc_html__('Use SPCO Form Refactor', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to enable the new Single Page Checkout form refactor changes or continue using the legacy Single Page Checkout form. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_REG_FORM_TICKET_QUESTIONS => [
+				'name'            => esc_html__('Reg Form Ticket Questions', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Reg Form Ticket Questions', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to enable the new Reg Form Ticket Questions functionality. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_EDD_PLUGIN_LICENSING      => [
+				'name'            => esc_html__('EDD Plugin Licensing', 'event_espresso'),
+				'html_label_text' => esc_html__('Use EDD Plugin Licensing', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to use the EDD Plugin Licensing system to manage licenses for the EE plugins. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => defined('EE_USE_EDD_PLUGIN_LICENSING'),
+				'overridden_by'   => defined('EE_USE_EDD_PLUGIN_LICENSING')
+					? sprintf(
+						esc_html__(
+							'%1$sCurrently overriden by the %2$s constant in wp-config.php%3$s',
+							'event_espresso'
+						),
+						'<br><span class="ee-status--warning">',
+						'EE_USE_EDD_PLUGIN_LICENSING',
+						'</span>'
+					)
+					: '',
+			],
+			FeatureFlag::USE_DATETIME_STATUS_CONTROLS  => [
+				'name'            => esc_html__('Datetime Status Controls', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Datetime Status Controls', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to use the new Datetime Status Controls in the EDTR. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_PAYMENT_PROCESSOR_FEES    => [
+				'name'            => esc_html__('Gateway Partner Fees', 'event_espresso'),
+				'html_label_text' => esc_html__('Apply Payment Processor Fees', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to apply Gateway Partner fees to transactions. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+		];
+	}
 }

core/domain/services/capabilities/FeatureFlagsConfig.php

Indentation +166 added lines, -166 removed lines

@@ -17,170 +17,170 @@
  */
 class FeatureFlagsConfig extends JsonDataWordpressOption
 {
-    /**
-     * WP option name for saving the Feature Flags configuration
-     */
-    private const OPTION_NAME = 'ee_feature_flags';
-
-    /**
-     * use FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT instead
-     * this hasn't been deleted because it's used in the REM add-on
-     *
-     * @deprecated 5.0.18.p
-     */
-    public const  USE_EVENT_EDITOR_BULK_EDIT = FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT;
-
-    private static array $removed = [
-        FeatureFlag::USE_ADVANCED_EVENT_EDITOR,
-    ];
-
-
-
-    protected Domain $domain;
-
-    private ?stdClass $feature_flags = null;
-
-
-    public function __construct(Domain $domain, JsonDataHandler $json_data_handler)
-    {
-        $this->domain = $domain;
-        parent::__construct($json_data_handler, FeatureFlagsConfig::OPTION_NAME, $this->getDefaultFeatureFlagOptions());
-    }
-
-
-    /**
-     * see the FeatureFlag::USE_* constants for descriptions of each feature flag and their default values
-     *
-     * @return stdClass
-     */
-    public function getDefaultFeatureFlagOptions(): stdClass
-    {
-        return (object) [
-            FeatureFlag::USE_DATETIME_STATUS_CONTROLS  => false,
-            FeatureFlag::USE_DEFAULT_TICKET_MANAGER    => true,
-            FeatureFlag::USE_EDD_PLUGIN_LICENSING      => defined('EE_USE_EDD_PLUGIN_LICENSING')
-                                                            && EE_USE_EDD_PLUGIN_LICENSING,
-            FeatureFlag::USE_EVENT_DESCRIPTION_RTE     => false,
-            FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT    => $this->domain->isCaffeinated()
-                                                            && ! $this->domain->isMultiSite(),
-            FeatureFlag::USE_EXPERIMENTAL_RTE          => false,
-            FeatureFlag::USE_REG_FORM_BUILDER          => false,
-            FeatureFlag::USE_REG_FORM_TICKET_QUESTIONS => false,
-            FeatureFlag::USE_REG_OPTIONS_META_BOX      => false,
-            FeatureFlag::USE_SPCO_FORM_REFACTOR        => false,
-            FeatureFlag::USE_PAYMENT_PROCESSOR_FEES    => true,
-        ];
-    }
-
-
-    /**
-     * feature flags that absolutely must be enabled/disabled based on hard-coded conditions
-     *
-     * @return stdClass
-     * @since 5.0.20.p
-     */
-    public function getOverrides(): stdClass
-    {
-        $overrides = [];
-        if (defined('EE_USE_EDD_PLUGIN_LICENSING')) {
-            $overrides[ FeatureFlag::USE_EDD_PLUGIN_LICENSING ] = EE_USE_EDD_PLUGIN_LICENSING;
-        }
-        return (object) $overrides;
-    }
-
-
-    /**
-     * @return stdClass
-     */
-    public function getFeatureFlags(): stdClass
-    {
-        if ($this->feature_flags) {
-            return $this->feature_flags;
-        }
-        $default_options     = $this->getDefaultFeatureFlagOptions();
-        $this->feature_flags = $this->getAll();
-        $overrides           = $this->getOverrides();
-        // ensure that all feature flags are set
-        foreach ($default_options as $key => $value) {
-            // if the feature flag is not set, use the default value
-            if (! isset($this->feature_flags->$key)) {
-                $this->feature_flags->$key = $value;
-            }
-            // ensure that all overrides are set
-            if (isset($overrides->$key)) {
-                $this->feature_flags->$key = $overrides->$key;
-            }
-        }
-        return $this->feature_flags;
-    }
-
-
-    public function saveFeatureFlagsConfig(?stdClass $feature_flags = null): int
-    {
-        $feature_flags = $feature_flags ?? $this->feature_flags;
-        foreach (FeatureFlagsConfig::$removed as $feature_flag) {
-            unset($feature_flags->{$feature_flag});
-        }
-        return $this->updateOption($feature_flags);
-    }
-
-
-    /**
-     * enables a feature flag, ex:
-     * $this->enableFeatureFlag(FeatureFlag::USE_ADVANCED_EVENT_EDITOR);
-     *
-     * @param string $feature_flag the feature flag to enable. One of the FeatureFlag::USE_* constants
-     * @param bool   $add_if_missing
-     * @param bool   $save
-     * @return int
-     */
-    public function enableFeatureFlag(string $feature_flag, bool $add_if_missing = false, bool $save = true): int
-    {
-        if (! $this->feature_flags) {
-            $this->getFeatureFlags();
-        }
-        if (! property_exists($this->feature_flags, $feature_flag) && ! $add_if_missing) {
-            return WordPressOption::UPDATE_ERROR;
-        }
-        $this->feature_flags->{$feature_flag} = true;
-        // if feature flag is the advanced event editor bulk edit options
-        // then only enabled if the site is Caffeinated and not MultiSite
-        if ( $feature_flag === FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT ) {
-            $this->feature_flags->{$feature_flag} = $this->domain->isCaffeinated() && ! $this->domain->isMultiSite();
-        }
-        if ($save) {
-            return $this->saveFeatureFlagsConfig($this->feature_flags);
-        }
-        return WordPressOption::UPDATE_NONE;
-    }
-
-
-    /**
-     * disables a feature flag, ex:
-     * $this->disableFeatureFlag(FeatureFlag::USE_ADVANCED_EVENT_EDITOR);
-     *
-     * @param string $feature_flag the feature flag to disable. One of the FeatureFlag::USE_* constants
-     * @param bool   $save
-     * @return int
-     */
-    public function disableFeatureFlag(string $feature_flag, bool $save = true): int
-    {
-        if (! $this->feature_flags) {
-            $this->getFeatureFlags();
-        }
-        if (! property_exists($this->feature_flags, $feature_flag)) {
-            return WordPressOption::UPDATE_ERROR;
-        }
-        $this->feature_flags->{$feature_flag} = false;
-        if ($save) {
-            return $this->saveFeatureFlagsConfig($this->feature_flags);
-        }
-        return WordPressOption::UPDATE_NONE;
-    }
-
-
-    public function getFeatureFlagsFormOptions(): ?array
-    {
-        return FeatureFlag::getFormOptions();
-    }
+	/**
+	 * WP option name for saving the Feature Flags configuration
+	 */
+	private const OPTION_NAME = 'ee_feature_flags';
+
+	/**
+	 * use FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT instead
+	 * this hasn't been deleted because it's used in the REM add-on
+	 *
+	 * @deprecated 5.0.18.p
+	 */
+	public const  USE_EVENT_EDITOR_BULK_EDIT = FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT;
+
+	private static array $removed = [
+		FeatureFlag::USE_ADVANCED_EVENT_EDITOR,
+	];
+
+
+
+	protected Domain $domain;
+
+	private ?stdClass $feature_flags = null;
+
+
+	public function __construct(Domain $domain, JsonDataHandler $json_data_handler)
+	{
+		$this->domain = $domain;
+		parent::__construct($json_data_handler, FeatureFlagsConfig::OPTION_NAME, $this->getDefaultFeatureFlagOptions());
+	}
+
+
+	/**
+	 * see the FeatureFlag::USE_* constants for descriptions of each feature flag and their default values
+	 *
+	 * @return stdClass
+	 */
+	public function getDefaultFeatureFlagOptions(): stdClass
+	{
+		return (object) [
+			FeatureFlag::USE_DATETIME_STATUS_CONTROLS  => false,
+			FeatureFlag::USE_DEFAULT_TICKET_MANAGER    => true,
+			FeatureFlag::USE_EDD_PLUGIN_LICENSING      => defined('EE_USE_EDD_PLUGIN_LICENSING')
+															&& EE_USE_EDD_PLUGIN_LICENSING,
+			FeatureFlag::USE_EVENT_DESCRIPTION_RTE     => false,
+			FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT    => $this->domain->isCaffeinated()
+															&& ! $this->domain->isMultiSite(),
+			FeatureFlag::USE_EXPERIMENTAL_RTE          => false,
+			FeatureFlag::USE_REG_FORM_BUILDER          => false,
+			FeatureFlag::USE_REG_FORM_TICKET_QUESTIONS => false,
+			FeatureFlag::USE_REG_OPTIONS_META_BOX      => false,
+			FeatureFlag::USE_SPCO_FORM_REFACTOR        => false,
+			FeatureFlag::USE_PAYMENT_PROCESSOR_FEES    => true,
+		];
+	}
+
+
+	/**
+	 * feature flags that absolutely must be enabled/disabled based on hard-coded conditions
+	 *
+	 * @return stdClass
+	 * @since 5.0.20.p
+	 */
+	public function getOverrides(): stdClass
+	{
+		$overrides = [];
+		if (defined('EE_USE_EDD_PLUGIN_LICENSING')) {
+			$overrides[ FeatureFlag::USE_EDD_PLUGIN_LICENSING ] = EE_USE_EDD_PLUGIN_LICENSING;
+		}
+		return (object) $overrides;
+	}
+
+
+	/**
+	 * @return stdClass
+	 */
+	public function getFeatureFlags(): stdClass
+	{
+		if ($this->feature_flags) {
+			return $this->feature_flags;
+		}
+		$default_options     = $this->getDefaultFeatureFlagOptions();
+		$this->feature_flags = $this->getAll();
+		$overrides           = $this->getOverrides();
+		// ensure that all feature flags are set
+		foreach ($default_options as $key => $value) {
+			// if the feature flag is not set, use the default value
+			if (! isset($this->feature_flags->$key)) {
+				$this->feature_flags->$key = $value;
+			}
+			// ensure that all overrides are set
+			if (isset($overrides->$key)) {
+				$this->feature_flags->$key = $overrides->$key;
+			}
+		}
+		return $this->feature_flags;
+	}
+
+
+	public function saveFeatureFlagsConfig(?stdClass $feature_flags = null): int
+	{
+		$feature_flags = $feature_flags ?? $this->feature_flags;
+		foreach (FeatureFlagsConfig::$removed as $feature_flag) {
+			unset($feature_flags->{$feature_flag});
+		}
+		return $this->updateOption($feature_flags);
+	}
+
+
+	/**
+	 * enables a feature flag, ex:
+	 * $this->enableFeatureFlag(FeatureFlag::USE_ADVANCED_EVENT_EDITOR);
+	 *
+	 * @param string $feature_flag the feature flag to enable. One of the FeatureFlag::USE_* constants
+	 * @param bool   $add_if_missing
+	 * @param bool   $save
+	 * @return int
+	 */
+	public function enableFeatureFlag(string $feature_flag, bool $add_if_missing = false, bool $save = true): int
+	{
+		if (! $this->feature_flags) {
+			$this->getFeatureFlags();
+		}
+		if (! property_exists($this->feature_flags, $feature_flag) && ! $add_if_missing) {
+			return WordPressOption::UPDATE_ERROR;
+		}
+		$this->feature_flags->{$feature_flag} = true;
+		// if feature flag is the advanced event editor bulk edit options
+		// then only enabled if the site is Caffeinated and not MultiSite
+		if ( $feature_flag === FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT ) {
+			$this->feature_flags->{$feature_flag} = $this->domain->isCaffeinated() && ! $this->domain->isMultiSite();
+		}
+		if ($save) {
+			return $this->saveFeatureFlagsConfig($this->feature_flags);
+		}
+		return WordPressOption::UPDATE_NONE;
+	}
+
+
+	/**
+	 * disables a feature flag, ex:
+	 * $this->disableFeatureFlag(FeatureFlag::USE_ADVANCED_EVENT_EDITOR);
+	 *
+	 * @param string $feature_flag the feature flag to disable. One of the FeatureFlag::USE_* constants
+	 * @param bool   $save
+	 * @return int
+	 */
+	public function disableFeatureFlag(string $feature_flag, bool $save = true): int
+	{
+		if (! $this->feature_flags) {
+			$this->getFeatureFlags();
+		}
+		if (! property_exists($this->feature_flags, $feature_flag)) {
+			return WordPressOption::UPDATE_ERROR;
+		}
+		$this->feature_flags->{$feature_flag} = false;
+		if ($save) {
+			return $this->saveFeatureFlagsConfig($this->feature_flags);
+		}
+		return WordPressOption::UPDATE_NONE;
+	}
+
+
+	public function getFeatureFlagsFormOptions(): ?array
+	{
+		return FeatureFlag::getFormOptions();
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -83,7 +83,7 @@ 
     {
         $overrides = [];
         if (defined('EE_USE_EDD_PLUGIN_LICENSING')) {
-            $overrides[ FeatureFlag::USE_EDD_PLUGIN_LICENSING ] = EE_USE_EDD_PLUGIN_LICENSING;
+            $overrides[FeatureFlag::USE_EDD_PLUGIN_LICENSING] = EE_USE_EDD_PLUGIN_LICENSING;
         }
         return (object) $overrides;
     }
@@ -103,7 +103,7 @@ 
         // ensure that all feature flags are set
         foreach ($default_options as $key => $value) {
             // if the feature flag is not set, use the default value
-            if (! isset($this->feature_flags->$key)) {
+            if ( ! isset($this->feature_flags->$key)) {
                 $this->feature_flags->$key = $value;
             }
             // ensure that all overrides are set
@@ -136,16 +136,16 @@ 
      */
     public function enableFeatureFlag(string $feature_flag, bool $add_if_missing = false, bool $save = true): int
     {
-        if (! $this->feature_flags) {
+        if ( ! $this->feature_flags) {
             $this->getFeatureFlags();
         }
-        if (! property_exists($this->feature_flags, $feature_flag) && ! $add_if_missing) {
+        if ( ! property_exists($this->feature_flags, $feature_flag) && ! $add_if_missing) {
             return WordPressOption::UPDATE_ERROR;
         }
         $this->feature_flags->{$feature_flag} = true;
         // if feature flag is the advanced event editor bulk edit options
         // then only enabled if the site is Caffeinated and not MultiSite
-        if ( $feature_flag === FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT ) {
+        if ($feature_flag === FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT) {
             $this->feature_flags->{$feature_flag} = $this->domain->isCaffeinated() && ! $this->domain->isMultiSite();
         }
         if ($save) {
@@ -165,10 +165,10 @@ 
      */
     public function disableFeatureFlag(string $feature_flag, bool $save = true): int
     {
-        if (! $this->feature_flags) {
+        if ( ! $this->feature_flags) {
             $this->getFeatureFlags();
         }
-        if (! property_exists($this->feature_flags, $feature_flag)) {
+        if ( ! property_exists($this->feature_flags, $feature_flag)) {
             return WordPressOption::UPDATE_ERROR;
         }
         $this->feature_flags->{$feature_flag} = false;

core/domain/services/assets/CoreAssetManager.php

Indentation +160 added lines, -160 removed lines

@@ -29,164 +29,164 @@
 class CoreAssetManager extends AssetManager
 {
 
-    // WordPress core / Third party JS asset handles
-    const JS_HANDLE_JS_CORE = 'eejs-core';
-
-    const JS_HANDLE_CORE    = 'espresso_core';
-
-    const JS_HANDLE_I18N    = 'eei18n';
-
-    const JS_HANDLE_VENDOR  = 'eventespresso-vendor';
-
-    const JS_HANDLE_RAMDA  = 'ramda';
-
-    const RAMDA_VERSION = '0.27.1';
-
-    // EE CSS assets handles
-    const CSS_HANDLE_DEFAULT = 'espresso_default';
-
-    const CSS_HANDLE_CUSTOM  = 'espresso_custom_css';
-
-    /**
-     * @var EE_Currency_Config $currency_config
-     */
-    protected $currency_config;
-
-    /**
-     * @var EE_Template_Config $template_config
-     */
-    protected $template_config;
-
-
-    /**
-     * CoreAssetRegister constructor.
-     *
-     * @param AssetCollection    $assets
-     * @param EE_Currency_Config $currency_config
-     * @param EE_Template_Config $template_config
-     * @param DomainInterface    $domain
-     * @param Registry           $registry
-     */
-    public function __construct(
-        AssetCollection $assets,
-        EE_Currency_Config $currency_config,
-        EE_Template_Config $template_config,
-        DomainInterface $domain,
-        Registry $registry
-    ) {
-        $this->currency_config = $currency_config;
-        $this->template_config = $template_config;
-        parent::__construct($domain, $assets, $registry);
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @since 4.9.62.p
-     */
-    public function addAssets()
-    {
-        $this->addJavascriptFiles();
-        $this->addStylesheetFiles();
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @since 4.9.62.p
-     */
-    public function addJavascriptFiles()
-    {
-        $this->addJs(CoreAssetManager::JS_HANDLE_VENDOR);
-        $this->addJs(CoreAssetManager::JS_HANDLE_JS_CORE)->setHasInlineData();
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_CORE,
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-            [JqueryAssetManager::JS_HANDLE_JQUERY]
-        )->setInlineDataCallback(
-            function () {
-                wp_localize_script(
-                    CoreAssetManager::JS_HANDLE_CORE,
-                    CoreAssetManager::JS_HANDLE_I18N,
-                    EE_Registry::sanitize_i18n_js_strings()
-                );
-            }
-        );
-        $this->loadQtipJs();
-        $this->addVendorJavascript(
-            CoreAssetManager::JS_HANDLE_RAMDA,
-            [],
-            true,
-            CoreAssetManager::RAMDA_VERSION
-        );
-    }
-
-
-    /**
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DomainException
-     * @since 4.9.62.p
-     */
-    public function addStylesheetFiles()
-    {
-        if (! is_admin()) {
-            $this->addStylesheet(
-                CoreAssetManager::CSS_HANDLE_DEFAULT,
-                is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css')
-                    ? EVENT_ESPRESSO_UPLOAD_URL . 'css/espresso_default.css'
-                    : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
-                ['dashicons']
-            );
-        }
-    }
-
-
-    /**
-     * Returns configuration data for the js Currency VO.
-     *
-     * @return array
-     * @since 4.9.71.p
-     */
-    private function getCurrencySettings()
-    {
-        return [
-            'code'               => $this->currency_config->code,
-            'singularLabel'      => $this->currency_config->name,
-            'pluralLabel'        => $this->currency_config->plural,
-            'sign'               => $this->currency_config->sign,
-            'signB4'             => $this->currency_config->sign_b4,
-            'decimalPlaces'      => $this->currency_config->dec_plc,
-            'decimalMark'        => $this->currency_config->dec_mrk,
-            'thousandsSeparator' => $this->currency_config->thsnds,
-        ];
-    }
-
-
-    /**
-     * replacement:
-     * EventEspresso\core\domain\services\assets\EspressoLegacyAdminAssetManager::loadQtipJs()
-     *
-     * @param JavascriptAsset $script
-     * @deprecated 5.0.0.p
-     */
-    public function loadQtipJs(JavascriptAsset $script = null)
-    {
-        // qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook,
-        // can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' );
-        if (apply_filters('FHEE_load_qtip', false)) {
-            EEH_Qtip_Loader::instance()->register_and_enqueue();
-        }
-    }
+	// WordPress core / Third party JS asset handles
+	const JS_HANDLE_JS_CORE = 'eejs-core';
+
+	const JS_HANDLE_CORE    = 'espresso_core';
+
+	const JS_HANDLE_I18N    = 'eei18n';
+
+	const JS_HANDLE_VENDOR  = 'eventespresso-vendor';
+
+	const JS_HANDLE_RAMDA  = 'ramda';
+
+	const RAMDA_VERSION = '0.27.1';
+
+	// EE CSS assets handles
+	const CSS_HANDLE_DEFAULT = 'espresso_default';
+
+	const CSS_HANDLE_CUSTOM  = 'espresso_custom_css';
+
+	/**
+	 * @var EE_Currency_Config $currency_config
+	 */
+	protected $currency_config;
+
+	/**
+	 * @var EE_Template_Config $template_config
+	 */
+	protected $template_config;
+
+
+	/**
+	 * CoreAssetRegister constructor.
+	 *
+	 * @param AssetCollection    $assets
+	 * @param EE_Currency_Config $currency_config
+	 * @param EE_Template_Config $template_config
+	 * @param DomainInterface    $domain
+	 * @param Registry           $registry
+	 */
+	public function __construct(
+		AssetCollection $assets,
+		EE_Currency_Config $currency_config,
+		EE_Template_Config $template_config,
+		DomainInterface $domain,
+		Registry $registry
+	) {
+		$this->currency_config = $currency_config;
+		$this->template_config = $template_config;
+		parent::__construct($domain, $assets, $registry);
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @since 4.9.62.p
+	 */
+	public function addAssets()
+	{
+		$this->addJavascriptFiles();
+		$this->addStylesheetFiles();
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @since 4.9.62.p
+	 */
+	public function addJavascriptFiles()
+	{
+		$this->addJs(CoreAssetManager::JS_HANDLE_VENDOR);
+		$this->addJs(CoreAssetManager::JS_HANDLE_JS_CORE)->setHasInlineData();
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_CORE,
+			EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+			[JqueryAssetManager::JS_HANDLE_JQUERY]
+		)->setInlineDataCallback(
+			function () {
+				wp_localize_script(
+					CoreAssetManager::JS_HANDLE_CORE,
+					CoreAssetManager::JS_HANDLE_I18N,
+					EE_Registry::sanitize_i18n_js_strings()
+				);
+			}
+		);
+		$this->loadQtipJs();
+		$this->addVendorJavascript(
+			CoreAssetManager::JS_HANDLE_RAMDA,
+			[],
+			true,
+			CoreAssetManager::RAMDA_VERSION
+		);
+	}
+
+
+	/**
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 * @since 4.9.62.p
+	 */
+	public function addStylesheetFiles()
+	{
+		if (! is_admin()) {
+			$this->addStylesheet(
+				CoreAssetManager::CSS_HANDLE_DEFAULT,
+				is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css')
+					? EVENT_ESPRESSO_UPLOAD_URL . 'css/espresso_default.css'
+					: EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+				['dashicons']
+			);
+		}
+	}
+
+
+	/**
+	 * Returns configuration data for the js Currency VO.
+	 *
+	 * @return array
+	 * @since 4.9.71.p
+	 */
+	private function getCurrencySettings()
+	{
+		return [
+			'code'               => $this->currency_config->code,
+			'singularLabel'      => $this->currency_config->name,
+			'pluralLabel'        => $this->currency_config->plural,
+			'sign'               => $this->currency_config->sign,
+			'signB4'             => $this->currency_config->sign_b4,
+			'decimalPlaces'      => $this->currency_config->dec_plc,
+			'decimalMark'        => $this->currency_config->dec_mrk,
+			'thousandsSeparator' => $this->currency_config->thsnds,
+		];
+	}
+
+
+	/**
+	 * replacement:
+	 * EventEspresso\core\domain\services\assets\EspressoLegacyAdminAssetManager::loadQtipJs()
+	 *
+	 * @param JavascriptAsset $script
+	 * @deprecated 5.0.0.p
+	 */
+	public function loadQtipJs(JavascriptAsset $script = null)
+	{
+		// qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook,
+		// can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' );
+		if (apply_filters('FHEE_load_qtip', false)) {
+			EEH_Qtip_Loader::instance()->register_and_enqueue();
+		}
+	}
 }

core/domain/services/licensing/LicenseData.php

Indentation +36 added lines, -36 removed lines

@@ -10,55 +10,55 @@
 class LicenseData
 {
 
-    public const  LICENSE_ACTIVE  = 'active';
+	public const  LICENSE_ACTIVE  = 'active';
 
-    public const  LICENSE_DECAF   = 'decaf';
+	public const  LICENSE_DECAF   = 'decaf';
 
-    public const  LICENSE_EXPIRED = 'expired';
+	public const  LICENSE_EXPIRED = 'expired';
 
-    public const  LICENSE_VALID   = 'valid';
+	public const  LICENSE_VALID   = 'valid';
 
 
-    private Domain $domain;
+	private Domain $domain;
 
-    private FeatureFlags $feature;
-    private LicenseDataStrategy $license_data;
+	private FeatureFlags $feature;
+	private LicenseDataStrategy $license_data;
 
 
-    /**
-     * @param Domain $domain
-     * @param FeatureFlags $feature
-     */
-    public function __construct(Domain $domain, FeatureFlags $feature)
-    {
-        $this->domain       = $domain;
-        $this->feature      = $feature;
-        $this->license_data = $this->feature->allowed(FeatureFlag::USE_EDD_PLUGIN_LICENSING)
-            ? LoaderFactory::getShared(LicenseDataEDD::class)
-            : LoaderFactory::getShared(LicenseDataPue::class);
-        $this->license_data->loadLicenseData();
-    }
+	/**
+	 * @param Domain $domain
+	 * @param FeatureFlags $feature
+	 */
+	public function __construct(Domain $domain, FeatureFlags $feature)
+	{
+		$this->domain       = $domain;
+		$this->feature      = $feature;
+		$this->license_data = $this->feature->allowed(FeatureFlag::USE_EDD_PLUGIN_LICENSING)
+			? LoaderFactory::getShared(LicenseDataEDD::class)
+			: LoaderFactory::getShared(LicenseDataPue::class);
+		$this->license_data->loadLicenseData();
+	}
 
 
 
-    /**
-     * @return bool
-     * @since 5.0.22.p
-     */
-    protected function isDecaf(): bool
-    {
-        return ! $this->domain->isDecaf();
-    }
+	/**
+	 * @return bool
+	 * @since 5.0.22.p
+	 */
+	protected function isDecaf(): bool
+	{
+		return ! $this->domain->isDecaf();
+	}
 
 
-    public function licenseStatus(): string
-    {
-        return ! $this->domain->isDecaf() ? $this->license_data->getLicenseStatus() :  LicenseData::LICENSE_DECAF;
-    }
+	public function licenseStatus(): string
+	{
+		return ! $this->domain->isDecaf() ? $this->license_data->getLicenseStatus() :  LicenseData::LICENSE_DECAF;
+	}
 
 
-    public function licenseExpiry(): string
-    {
-        return ! $this->isDecaf() ? $this->license_data->getLicenseExpiry() : '';
-    }
+	public function licenseExpiry(): string
+	{
+		return ! $this->isDecaf() ? $this->license_data->getLicenseExpiry() : '';
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
 
     public function licenseStatus(): string
     {
-        return ! $this->domain->isDecaf() ? $this->license_data->getLicenseStatus() :  LicenseData::LICENSE_DECAF;
+        return ! $this->domain->isDecaf() ? $this->license_data->getLicenseStatus() : LicenseData::LICENSE_DECAF;
     }
 
 

core/domain/services/licensing/LicenseDataEDD.php

Indentation +31 added lines, -31 removed lines

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

Spacing +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
     public function loadLicenseData()
     {
         $license_data = $this->license_key_data->getLicenseDataForPlugin(Domain::pluginSlug());
-        if (! isset($license_data->license)) {
+        if ( ! isset($license_data->license)) {
             $this->status = LicenseData::LICENSE_EXPIRED;
             $this->expiry = '';
             return;

core/domain/services/licensing/LicenseDataPue.php

Indentation +26 added lines, -26 removed lines

@@ -14,39 +14,39 @@
  */
 class LicenseDataPue implements LicenseDataStrategy
 {
-    private string $status;
+	private string $status;
 
-    protected EE_Network_Core_Config $network_core_config;
+	protected EE_Network_Core_Config $network_core_config;
 
 
-    /**
-     * @param EE_Network_Core_Config $network_core_config
-     */
-    public function __construct(EE_Network_Core_Config $network_core_config)
-    {
-        $this->network_core_config = $network_core_config;
-    }
+	/**
+	 * @param EE_Network_Core_Config $network_core_config
+	 */
+	public function __construct(EE_Network_Core_Config $network_core_config)
+	{
+		$this->network_core_config = $network_core_config;
+	}
 
 
-    public function loadLicenseData(): void
-    {
-        if (empty($this->network_core_config->site_license_key)) {
-            $this->status = LicenseData::LICENSE_EXPIRED;
-            return;
-        }
-        $verify_fail  = get_option('puvererr_' . basename(EE_PLUGIN_BASENAME), false);
-        $this->status = $verify_fail ? LicenseData::LICENSE_EXPIRED : LicenseData::LICENSE_ACTIVE;
-    }
+	public function loadLicenseData(): void
+	{
+		if (empty($this->network_core_config->site_license_key)) {
+			$this->status = LicenseData::LICENSE_EXPIRED;
+			return;
+		}
+		$verify_fail  = get_option('puvererr_' . basename(EE_PLUGIN_BASENAME), false);
+		$this->status = $verify_fail ? LicenseData::LICENSE_EXPIRED : LicenseData::LICENSE_ACTIVE;
+	}
 
 
-    public function getLicenseStatus(): string
-    {
-        return $this->status;
-    }
+	public function getLicenseStatus(): string
+	{
+		return $this->status;
+	}
 
 
-    public function getLicenseExpiry(): string
-    {
-        return '';
-    }
+	public function getLicenseExpiry(): string
+	{
+		return '';
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
             $this->status = LicenseData::LICENSE_EXPIRED;
             return;
         }
-        $verify_fail  = get_option('puvererr_' . basename(EE_PLUGIN_BASENAME), false);
+        $verify_fail  = get_option('puvererr_'.basename(EE_PLUGIN_BASENAME), false);
         $this->status = $verify_fail ? LicenseData::LICENSE_EXPIRED : LicenseData::LICENSE_ACTIVE;
     }