eventespresso / event-espresso-core

core/libraries/form_sections/form_handlers/SequentialStepFormManager.php

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use EE_Error;
 use EE_Request;
-use EventEspresso\core\exceptions\ExceptionStackTraceDisplay;
 use EventEspresso\core\exceptions\InvalidClassException;
 use EventEspresso\core\exceptions\InvalidDataTypeException;
 use EventEspresso\core\exceptions\InvalidEntityException;

Indentation +580 added lines, -580 removed lines

@@ -29,584 +29,584 @@
 abstract class SequentialStepFormManager
 {
 
-    /**
-     * a simplified URL with no form related parameters
-     * that will be used to build the form's redirect URLs
-     *
-     * @var string $base_url
-     */
-    private $base_url = '';
-
-    /**
-     * the key used for the URL param that denotes the current form step
-     * defaults to 'ee-form-step'
-     *
-     * @var string $form_step_url_key
-     */
-    private $form_step_url_key = '';
-
-    /**
-     * @var string $default_form_step
-     */
-    private $default_form_step = '';
-
-    /**
-     * @var string $form_action
-     */
-    private $form_action;
-
-    /**
-     * value of one of the string constant above
-     *
-     * @var string $form_config
-     */
-    private $form_config;
-
-    /**
-     * @var string $progress_step_style
-     */
-    private $progress_step_style = '';
-
-    /**
-     * @var EE_Request $request
-     */
-    private $request;
-
-    /**
-     * @var Collection $form_steps
-     */
-    protected $form_steps;
-
-    /**
-     * @var ProgressStepManager $progress_step_manager
-     */
-    protected $progress_step_manager;
-
-
-    /**
-     * @return Collection|null
-     */
-    abstract protected function getFormStepsCollection();
-
-    // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
-    /**
-     * StepsManager constructor
-     *
-     * @param string     $base_url
-     * @param string     $default_form_step
-     * @param string     $form_action
-     * @param string     $form_config
-     * @param EE_Request $request
-     * @param string     $progress_step_style
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $base_url,
-        $default_form_step,
-        $form_action = '',
-        $form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-        $progress_step_style = 'number_bubbles',
-        EE_Request $request
-    ) {
-        $this->setBaseUrl($base_url);
-        $this->setDefaultFormStep($default_form_step);
-        $this->setFormAction($form_action);
-        $this->setFormConfig($form_config);
-        $this->setProgressStepStyle($progress_step_style);
-        $this->request = $request;
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function baseUrl()
-    {
-        if (strpos($this->base_url, $this->getCurrentStep()->slug()) === false) {
-            add_query_arg(
-                array($this->form_step_url_key => $this->getCurrentStep()->slug()),
-                $this->base_url
-            );
-        }
-        return $this->base_url;
-    }
-
-
-    /**
-     * @param string $base_url
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function setBaseUrl($base_url)
-    {
-        if (! is_string($base_url)) {
-            throw new InvalidDataTypeException('$base_url', $base_url, 'string');
-        }
-        if (empty($base_url)) {
-            throw new InvalidArgumentException(
-                esc_html__('The base URL can not be an empty string.', 'event_espresso')
-            );
-        }
-        $this->base_url = $base_url;
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidDataTypeException
-     */
-    public function formStepUrlKey()
-    {
-        if (empty($this->form_step_url_key)) {
-            $this->setFormStepUrlKey();
-        }
-        return $this->form_step_url_key;
-    }
-
-
-    /**
-     * @param string $form_step_url_key
-     * @throws InvalidDataTypeException
-     */
-    public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
-    {
-        if (! is_string($form_step_url_key)) {
-            throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
-        }
-        $this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function defaultFormStep()
-    {
-        return $this->default_form_step;
-    }
-
-
-    /**
-     * @param $default_form_step
-     * @throws InvalidDataTypeException
-     */
-    protected function setDefaultFormStep($default_form_step)
-    {
-        if (! is_string($default_form_step)) {
-            throw new InvalidDataTypeException('$default_form_step', $default_form_step, 'string');
-        }
-        $this->default_form_step = $default_form_step;
-    }
-
-
-    /**
-     * @return void
-     * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
-     * @throws InvalidDataTypeException
-     */
-    protected function setCurrentStepFromRequest()
-    {
-        $current_step_slug = $this->request()->get($this->formStepUrlKey(), $this->defaultFormStep());
-        if (! $this->form_steps->setCurrent($current_step_slug)) {
-            throw new InvalidIdentifierException(
-                $current_step_slug,
-                $this->defaultFormStep(),
-                $message = sprintf(
-                    esc_html__(
-                        'The "%1$s" form step could not be set.',
-                        'event_espresso'
-                    ),
-                    $current_step_slug
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return object|SequentialStepFormInterface
-     * @throws InvalidFormHandlerException
-     */
-    public function getCurrentStep()
-    {
-        if (! $this->form_steps->current() instanceof SequentialStepForm) {
-            throw new InvalidFormHandlerException($this->form_steps->current());
-        }
-        return $this->form_steps->current();
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function formAction()
-    {
-        if (! is_string($this->form_action) || empty($this->form_action)) {
-            $this->form_action = $this->baseUrl();
-        }
-        return $this->form_action;
-    }
-
-
-    /**
-     * @param string $form_action
-     * @throws InvalidDataTypeException
-     */
-    public function setFormAction($form_action)
-    {
-        if (! is_string($form_action)) {
-            throw new InvalidDataTypeException('$form_action', $form_action, 'string');
-        }
-        $this->form_action = $form_action;
-    }
-
-
-    /**
-     * @param array $form_action_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormHandlerException
-     */
-    public function addFormActionArgs($form_action_args = array())
-    {
-        if (! is_array($form_action_args)) {
-            throw new InvalidDataTypeException('$form_action_args', $form_action_args, 'array');
-        }
-        $form_action_args = ! empty($form_action_args)
-            ? $form_action_args
-            : array($this->formStepUrlKey() => $this->form_steps->current()->slug());
-        $this->getCurrentStep()->setFormAction(
-            add_query_arg($form_action_args, $this->formAction())
-        );
-        $this->form_action = $this->getCurrentStep()->formAction();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formConfig()
-    {
-        return $this->form_config;
-    }
-
-
-    /**
-     * @param string $form_config
-     */
-    public function setFormConfig($form_config)
-    {
-        $this->form_config = $form_config;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function progressStepStyle()
-    {
-        return $this->progress_step_style;
-    }
-
-
-    /**
-     * @param string $progress_step_style
-     */
-    public function setProgressStepStyle($progress_step_style)
-    {
-        $this->progress_step_style = $progress_step_style;
-    }
-
-
-    /**
-     * @return EE_Request
-     */
-    public function request()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @return Collection|null
-     * @throws InvalidInterfaceException
-     */
-    protected function getProgressStepsCollection()
-    {
-        static $collection = null;
-        if (! $collection instanceof ProgressStepCollection) {
-            $collection = new ProgressStepCollection();
-        }
-        return $collection;
-    }
-
-
-    /**
-     * @param Collection $progress_steps_collection
-     * @return ProgressStepManager
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFormHandlerException
-     */
-    protected function generateProgressSteps(Collection $progress_steps_collection)
-    {
-        $current_step = $this->getCurrentStep();
-        /** @var SequentialStepForm $form_step */
-        foreach ($this->form_steps as $form_step) {
-            // is this step active ?
-            if (! $form_step->initialize()) {
-                continue;
-            }
-            $progress_steps_collection->add(
-                new ProgressStep(
-                    $form_step->order(),
-                    $form_step->slug(),
-                    $form_step->slug(),
-                    $form_step->formName()
-                ),
-                $form_step->slug()
-            );
-        }
-        // set collection pointer back to current step
-        $this->form_steps->setCurrentUsingObject($current_step);
-        return new ProgressStepManager(
-            $this->progressStepStyle(),
-            $this->defaultFormStep(),
-            $this->formStepUrlKey(),
-            $progress_steps_collection
-        );
-    }
-
-
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws InvalidFormHandlerException
-     */
-    public function buildForm()
-    {
-        $this->buildCurrentStepFormForDisplay();
-    }
-
-
-    /**
-     * @param array $form_data
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFormHandlerException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     */
-    public function processForm($form_data = array())
-    {
-        $this->buildCurrentStepFormForProcessing();
-        $this->processCurrentStepForm($form_data);
-    }
-
-
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidFormHandlerException
-     */
-    public function buildCurrentStepFormForDisplay()
-    {
-        $form_step = $this->buildCurrentStepForm();
-        // no displayable content ? then skip straight to processing
-        if (! $form_step->displayable()) {
-            $this->addFormActionArgs();
-            $form_step->setFormAction($this->formAction());
-            wp_safe_redirect($form_step->formAction());
-        }
-    }
-
-
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidFormHandlerException
-     */
-    public function buildCurrentStepFormForProcessing()
-    {
-        $this->buildCurrentStepForm(false);
-    }
-
-
-    /**
-     * @param bool $for_display
-     * @return SequentialStepFormInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFormHandlerException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     */
-    private function buildCurrentStepForm($for_display = true)
-    {
-        $this->form_steps = $this->getFormStepsCollection();
-        $this->setCurrentStepFromRequest();
-        $form_step = $this->getCurrentStep();
-        if ($form_step->submitBtnText() === esc_html__('Submit', 'event_espresso')) {
-            $form_step->setSubmitBtnText(esc_html__('Next Step', 'event_espresso'));
-        }
-        if ($for_display && $form_step->displayable()) {
-            $this->progress_step_manager = $this->generateProgressSteps(
-                $this->getProgressStepsCollection()
-            );
-            $this->progress_step_manager->setCurrentStep(
-                $form_step->slug()
-            );
-            // mark all previous progress steps as completed
-            $this->progress_step_manager->setPreviousStepsCompleted();
-            $this->progress_step_manager->enqueueStylesAndScripts();
-            $this->addFormActionArgs();
-            $form_step->setFormAction($this->formAction());
-        } else {
-            $form_step->setRedirectUrl($this->baseUrl());
-            $form_step->addRedirectArgs(
-                array($this->formStepUrlKey() => $this->form_steps->current()->slug())
-            );
-        }
-        $form_step->generate();
-        if ($for_display) {
-            $form_step->enqueueStylesAndScripts();
-        }
-        return $form_step;
-    }
-
-
-    /**
-     * @param bool $return_as_string
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function displayProgressSteps($return_as_string = true)
-    {
-        $form_step = $this->getCurrentStep();
-        if (! $form_step->displayable()) {
-            return '';
-        }
-        $progress_steps = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__before_steps',
-            ''
-        );
-        $progress_steps .= $this->progress_step_manager->displaySteps();
-        $progress_steps .= apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__after_steps',
-            ''
-        );
-        if ($return_as_string) {
-            return $progress_steps;
-        }
-        echo $progress_steps;
-        return '';
-    }
-
-
-    /**
-     * @param bool $return_as_string
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function displayCurrentStepForm($return_as_string = true)
-    {
-        if ($return_as_string) {
-            return $this->getCurrentStep()->display();
-        }
-        echo $this->getCurrentStep()->display();
-        return '';
-    }
-
-
-    /**
-     * @param array $form_data
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormHandlerException
-     */
-    public function processCurrentStepForm($form_data = array())
-    {
-        // grab instance of current step because after calling next() below,
-        // any calls to getCurrentStep() will return the "next" step because we advanced
-        $current_step = $this->getCurrentStep();
-        try {
-            // form processing should either throw exceptions or return true
-            $current_step->process($form_data);
-        } catch (Exception $e) {
-            // something went wrong, convert the Exception to an EE_Error
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            // prevent redirect to next step or other if exception was thrown
-            if ($current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_NEXT_STEP
-                || $current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_OTHER
-            ) {
-                $current_step->setRedirectTo(SequentialStepForm::REDIRECT_TO_CURRENT_STEP);
-            }
-        }
-        // save notices to a transient so that when we redirect back
-        // to the display portion for this step
-        // those notices can be displayed
-        EE_Error::get_notices(false, true);
-        $this->redirectForm($current_step);
-    }
-
-
-    /**
-     * handles where to go to next
-     *
-     * @param SequentialStepFormInterface $current_step
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormHandlerException
-     */
-    public function redirectForm(SequentialStepFormInterface $current_step)
-    {
-        $redirect_step = $current_step;
-        switch ($current_step->redirectTo()) {
-            case SequentialStepForm::REDIRECT_TO_OTHER:
-                // going somewhere else, so just check out now
-                wp_safe_redirect($redirect_step->redirectUrl());
-                exit();
-                break;
-            case SequentialStepForm::REDIRECT_TO_PREV_STEP:
-                $redirect_step = $this->form_steps->previous();
-                break;
-            case SequentialStepForm::REDIRECT_TO_NEXT_STEP:
-                $this->form_steps->next();
-                if ($this->form_steps->valid()) {
-                    $redirect_step = $this->form_steps->current();
-                }
-                break;
-            case SequentialStepForm::REDIRECT_TO_CURRENT_STEP:
-            default:
-                // $redirect_step is already set
-        }
-        $current_step->setRedirectUrl($this->baseUrl());
-        $current_step->addRedirectArgs(
-            // use the slug for whatever step we are redirecting too
-            array($this->formStepUrlKey() => $redirect_step->slug())
-        );
-        wp_safe_redirect($current_step->redirectUrl());
-        exit();
-    }
+	/**
+	 * a simplified URL with no form related parameters
+	 * that will be used to build the form's redirect URLs
+	 *
+	 * @var string $base_url
+	 */
+	private $base_url = '';
+
+	/**
+	 * the key used for the URL param that denotes the current form step
+	 * defaults to 'ee-form-step'
+	 *
+	 * @var string $form_step_url_key
+	 */
+	private $form_step_url_key = '';
+
+	/**
+	 * @var string $default_form_step
+	 */
+	private $default_form_step = '';
+
+	/**
+	 * @var string $form_action
+	 */
+	private $form_action;
+
+	/**
+	 * value of one of the string constant above
+	 *
+	 * @var string $form_config
+	 */
+	private $form_config;
+
+	/**
+	 * @var string $progress_step_style
+	 */
+	private $progress_step_style = '';
+
+	/**
+	 * @var EE_Request $request
+	 */
+	private $request;
+
+	/**
+	 * @var Collection $form_steps
+	 */
+	protected $form_steps;
+
+	/**
+	 * @var ProgressStepManager $progress_step_manager
+	 */
+	protected $progress_step_manager;
+
+
+	/**
+	 * @return Collection|null
+	 */
+	abstract protected function getFormStepsCollection();
+
+	// phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
+	/**
+	 * StepsManager constructor
+	 *
+	 * @param string     $base_url
+	 * @param string     $default_form_step
+	 * @param string     $form_action
+	 * @param string     $form_config
+	 * @param EE_Request $request
+	 * @param string     $progress_step_style
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$base_url,
+		$default_form_step,
+		$form_action = '',
+		$form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+		$progress_step_style = 'number_bubbles',
+		EE_Request $request
+	) {
+		$this->setBaseUrl($base_url);
+		$this->setDefaultFormStep($default_form_step);
+		$this->setFormAction($form_action);
+		$this->setFormConfig($form_config);
+		$this->setProgressStepStyle($progress_step_style);
+		$this->request = $request;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function baseUrl()
+	{
+		if (strpos($this->base_url, $this->getCurrentStep()->slug()) === false) {
+			add_query_arg(
+				array($this->form_step_url_key => $this->getCurrentStep()->slug()),
+				$this->base_url
+			);
+		}
+		return $this->base_url;
+	}
+
+
+	/**
+	 * @param string $base_url
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function setBaseUrl($base_url)
+	{
+		if (! is_string($base_url)) {
+			throw new InvalidDataTypeException('$base_url', $base_url, 'string');
+		}
+		if (empty($base_url)) {
+			throw new InvalidArgumentException(
+				esc_html__('The base URL can not be an empty string.', 'event_espresso')
+			);
+		}
+		$this->base_url = $base_url;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidDataTypeException
+	 */
+	public function formStepUrlKey()
+	{
+		if (empty($this->form_step_url_key)) {
+			$this->setFormStepUrlKey();
+		}
+		return $this->form_step_url_key;
+	}
+
+
+	/**
+	 * @param string $form_step_url_key
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
+	{
+		if (! is_string($form_step_url_key)) {
+			throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
+		}
+		$this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function defaultFormStep()
+	{
+		return $this->default_form_step;
+	}
+
+
+	/**
+	 * @param $default_form_step
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setDefaultFormStep($default_form_step)
+	{
+		if (! is_string($default_form_step)) {
+			throw new InvalidDataTypeException('$default_form_step', $default_form_step, 'string');
+		}
+		$this->default_form_step = $default_form_step;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setCurrentStepFromRequest()
+	{
+		$current_step_slug = $this->request()->get($this->formStepUrlKey(), $this->defaultFormStep());
+		if (! $this->form_steps->setCurrent($current_step_slug)) {
+			throw new InvalidIdentifierException(
+				$current_step_slug,
+				$this->defaultFormStep(),
+				$message = sprintf(
+					esc_html__(
+						'The "%1$s" form step could not be set.',
+						'event_espresso'
+					),
+					$current_step_slug
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return object|SequentialStepFormInterface
+	 * @throws InvalidFormHandlerException
+	 */
+	public function getCurrentStep()
+	{
+		if (! $this->form_steps->current() instanceof SequentialStepForm) {
+			throw new InvalidFormHandlerException($this->form_steps->current());
+		}
+		return $this->form_steps->current();
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function formAction()
+	{
+		if (! is_string($this->form_action) || empty($this->form_action)) {
+			$this->form_action = $this->baseUrl();
+		}
+		return $this->form_action;
+	}
+
+
+	/**
+	 * @param string $form_action
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormAction($form_action)
+	{
+		if (! is_string($form_action)) {
+			throw new InvalidDataTypeException('$form_action', $form_action, 'string');
+		}
+		$this->form_action = $form_action;
+	}
+
+
+	/**
+	 * @param array $form_action_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function addFormActionArgs($form_action_args = array())
+	{
+		if (! is_array($form_action_args)) {
+			throw new InvalidDataTypeException('$form_action_args', $form_action_args, 'array');
+		}
+		$form_action_args = ! empty($form_action_args)
+			? $form_action_args
+			: array($this->formStepUrlKey() => $this->form_steps->current()->slug());
+		$this->getCurrentStep()->setFormAction(
+			add_query_arg($form_action_args, $this->formAction())
+		);
+		$this->form_action = $this->getCurrentStep()->formAction();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formConfig()
+	{
+		return $this->form_config;
+	}
+
+
+	/**
+	 * @param string $form_config
+	 */
+	public function setFormConfig($form_config)
+	{
+		$this->form_config = $form_config;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function progressStepStyle()
+	{
+		return $this->progress_step_style;
+	}
+
+
+	/**
+	 * @param string $progress_step_style
+	 */
+	public function setProgressStepStyle($progress_step_style)
+	{
+		$this->progress_step_style = $progress_step_style;
+	}
+
+
+	/**
+	 * @return EE_Request
+	 */
+	public function request()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @return Collection|null
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getProgressStepsCollection()
+	{
+		static $collection = null;
+		if (! $collection instanceof ProgressStepCollection) {
+			$collection = new ProgressStepCollection();
+		}
+		return $collection;
+	}
+
+
+	/**
+	 * @param Collection $progress_steps_collection
+	 * @return ProgressStepManager
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFormHandlerException
+	 */
+	protected function generateProgressSteps(Collection $progress_steps_collection)
+	{
+		$current_step = $this->getCurrentStep();
+		/** @var SequentialStepForm $form_step */
+		foreach ($this->form_steps as $form_step) {
+			// is this step active ?
+			if (! $form_step->initialize()) {
+				continue;
+			}
+			$progress_steps_collection->add(
+				new ProgressStep(
+					$form_step->order(),
+					$form_step->slug(),
+					$form_step->slug(),
+					$form_step->formName()
+				),
+				$form_step->slug()
+			);
+		}
+		// set collection pointer back to current step
+		$this->form_steps->setCurrentUsingObject($current_step);
+		return new ProgressStepManager(
+			$this->progressStepStyle(),
+			$this->defaultFormStep(),
+			$this->formStepUrlKey(),
+			$progress_steps_collection
+		);
+	}
+
+
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function buildForm()
+	{
+		$this->buildCurrentStepFormForDisplay();
+	}
+
+
+	/**
+	 * @param array $form_data
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFormHandlerException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 */
+	public function processForm($form_data = array())
+	{
+		$this->buildCurrentStepFormForProcessing();
+		$this->processCurrentStepForm($form_data);
+	}
+
+
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function buildCurrentStepFormForDisplay()
+	{
+		$form_step = $this->buildCurrentStepForm();
+		// no displayable content ? then skip straight to processing
+		if (! $form_step->displayable()) {
+			$this->addFormActionArgs();
+			$form_step->setFormAction($this->formAction());
+			wp_safe_redirect($form_step->formAction());
+		}
+	}
+
+
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function buildCurrentStepFormForProcessing()
+	{
+		$this->buildCurrentStepForm(false);
+	}
+
+
+	/**
+	 * @param bool $for_display
+	 * @return SequentialStepFormInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFormHandlerException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 */
+	private function buildCurrentStepForm($for_display = true)
+	{
+		$this->form_steps = $this->getFormStepsCollection();
+		$this->setCurrentStepFromRequest();
+		$form_step = $this->getCurrentStep();
+		if ($form_step->submitBtnText() === esc_html__('Submit', 'event_espresso')) {
+			$form_step->setSubmitBtnText(esc_html__('Next Step', 'event_espresso'));
+		}
+		if ($for_display && $form_step->displayable()) {
+			$this->progress_step_manager = $this->generateProgressSteps(
+				$this->getProgressStepsCollection()
+			);
+			$this->progress_step_manager->setCurrentStep(
+				$form_step->slug()
+			);
+			// mark all previous progress steps as completed
+			$this->progress_step_manager->setPreviousStepsCompleted();
+			$this->progress_step_manager->enqueueStylesAndScripts();
+			$this->addFormActionArgs();
+			$form_step->setFormAction($this->formAction());
+		} else {
+			$form_step->setRedirectUrl($this->baseUrl());
+			$form_step->addRedirectArgs(
+				array($this->formStepUrlKey() => $this->form_steps->current()->slug())
+			);
+		}
+		$form_step->generate();
+		if ($for_display) {
+			$form_step->enqueueStylesAndScripts();
+		}
+		return $form_step;
+	}
+
+
+	/**
+	 * @param bool $return_as_string
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function displayProgressSteps($return_as_string = true)
+	{
+		$form_step = $this->getCurrentStep();
+		if (! $form_step->displayable()) {
+			return '';
+		}
+		$progress_steps = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__before_steps',
+			''
+		);
+		$progress_steps .= $this->progress_step_manager->displaySteps();
+		$progress_steps .= apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__after_steps',
+			''
+		);
+		if ($return_as_string) {
+			return $progress_steps;
+		}
+		echo $progress_steps;
+		return '';
+	}
+
+
+	/**
+	 * @param bool $return_as_string
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function displayCurrentStepForm($return_as_string = true)
+	{
+		if ($return_as_string) {
+			return $this->getCurrentStep()->display();
+		}
+		echo $this->getCurrentStep()->display();
+		return '';
+	}
+
+
+	/**
+	 * @param array $form_data
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function processCurrentStepForm($form_data = array())
+	{
+		// grab instance of current step because after calling next() below,
+		// any calls to getCurrentStep() will return the "next" step because we advanced
+		$current_step = $this->getCurrentStep();
+		try {
+			// form processing should either throw exceptions or return true
+			$current_step->process($form_data);
+		} catch (Exception $e) {
+			// something went wrong, convert the Exception to an EE_Error
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			// prevent redirect to next step or other if exception was thrown
+			if ($current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_NEXT_STEP
+				|| $current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_OTHER
+			) {
+				$current_step->setRedirectTo(SequentialStepForm::REDIRECT_TO_CURRENT_STEP);
+			}
+		}
+		// save notices to a transient so that when we redirect back
+		// to the display portion for this step
+		// those notices can be displayed
+		EE_Error::get_notices(false, true);
+		$this->redirectForm($current_step);
+	}
+
+
+	/**
+	 * handles where to go to next
+	 *
+	 * @param SequentialStepFormInterface $current_step
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function redirectForm(SequentialStepFormInterface $current_step)
+	{
+		$redirect_step = $current_step;
+		switch ($current_step->redirectTo()) {
+			case SequentialStepForm::REDIRECT_TO_OTHER:
+				// going somewhere else, so just check out now
+				wp_safe_redirect($redirect_step->redirectUrl());
+				exit();
+				break;
+			case SequentialStepForm::REDIRECT_TO_PREV_STEP:
+				$redirect_step = $this->form_steps->previous();
+				break;
+			case SequentialStepForm::REDIRECT_TO_NEXT_STEP:
+				$this->form_steps->next();
+				if ($this->form_steps->valid()) {
+					$redirect_step = $this->form_steps->current();
+				}
+				break;
+			case SequentialStepForm::REDIRECT_TO_CURRENT_STEP:
+			default:
+				// $redirect_step is already set
+		}
+		$current_step->setRedirectUrl($this->baseUrl());
+		$current_step->addRedirectArgs(
+			// use the slug for whatever step we are redirecting too
+			array($this->formStepUrlKey() => $redirect_step->slug())
+		);
+		wp_safe_redirect($current_step->redirectUrl());
+		exit();
+	}
 }

core/libraries/form_sections/strategies/validation/EE_Credit_Card_Validation_Strategy.strategy.php

Indentation +15 added lines, -15 removed lines

@@ -13,19 +13,19 @@
 class EE_Credit_Card_Validation_Strategy extends EE_Text_Validation_Strategy
 {
 
-    /**
-     * @param null $validation_error_message
-     */
-    public function __construct($validation_error_message = null)
-    {
-        if (! $validation_error_message) {
-            $validation_error_message = __("Please enter a valid credit card number", "event_espresso");
-        }
-        parent::__construct(
-            $validation_error_message,
-            // @codingStandardsIgnoreStart
-            '~^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|2[2-7][0-9]{14}|6011[0-9]{12}|3(?:0[0-5]|[68][0-9])[0-9]{11}|3[47][0-9]{13})$~'
-            // @codingStandardsIgnoreEnd
-        );
-    }
+	/**
+	 * @param null $validation_error_message
+	 */
+	public function __construct($validation_error_message = null)
+	{
+		if (! $validation_error_message) {
+			$validation_error_message = __("Please enter a valid credit card number", "event_espresso");
+		}
+		parent::__construct(
+			$validation_error_message,
+			// @codingStandardsIgnoreStart
+			'~^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|2[2-7][0-9]{14}|6011[0-9]{12}|3(?:0[0-5]|[68][0-9])[0-9]{11}|3[47][0-9]{13})$~'
+			// @codingStandardsIgnoreEnd
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
      */
     public function __construct($validation_error_message = null)
     {
-        if (! $validation_error_message) {
+        if ( ! $validation_error_message) {
             $validation_error_message = __("Please enter a valid credit card number", "event_espresso");
         }
         parent::__construct(

caffeinated/admin/extend/about/templates/ee4-overview.template.php

Indentation +106 added lines, -106 removed lines

@@ -1,56 +1,56 @@ 
 <div class="headline-feature">
     <h2 class="about-headline-callout"><?php esc_html_e('Welcome to Event Espresso 4!', 'event_espresso'); ?></h2>
     <p><?php
-        echo sprintf(
-            esc_html__(
-                'Manage your events from your WordPress dashboard. Reduce your admin, reduce your costs, make your life easier! This is the Caffeinated/Regular version of Event Espresso, but we also have a hosted version called %sEvent Smart%s for customers that want to cut back on their hosting and security expenses.',
-                'event_espresso'
-            ),
-            '<a href="https://eventsmart.com//?utm_source=ee4_decaf&amp;utm_medium=link&amp;utm_campaign=espresso_about_tab&amp;utm_content=EE4+Caffeinated">',
-            '</a>'
-        ); ?></p>
+		echo sprintf(
+			esc_html__(
+				'Manage your events from your WordPress dashboard. Reduce your admin, reduce your costs, make your life easier! This is the Caffeinated/Regular version of Event Espresso, but we also have a hosted version called %sEvent Smart%s for customers that want to cut back on their hosting and security expenses.',
+				'event_espresso'
+			),
+			'<a href="https://eventsmart.com//?utm_source=ee4_decaf&amp;utm_medium=link&amp;utm_campaign=espresso_about_tab&amp;utm_content=EE4+Caffeinated">',
+			'</a>'
+		); ?></p>
     <h2><?php
-        esc_html_e(
-            'Powering 40,000+ event websites; $100 million in ticket sales per year!',
-            'event_espresso'
-        ); ?></h2>
+		esc_html_e(
+			'Powering 40,000+ event websites; $100 million in ticket sales per year!',
+			'event_espresso'
+		); ?></h2>
     <p><?php
-        echo sprintf(
-            esc_html__(
-                'Event Espresso is a %sWordPress event manager%s which makes it easy for you to register attendees for classes, workshops, events, trainings, conferences or concerts, all from your WordPress website. Event Espresso events are created from the WordPress admin area. You can create signup forms to collect information about your attendees, accept payments, and create reports. The lite version of the plugin provides everything that you need to manage your event using WordPress.',
-                'event_espresso'
-            ),
-            '<a href="http://eventespresso.com/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=espresso_about_tab&amp;utm_content=EE4+Decaf" rel="nofollow">',
-            '</a>'
-        ); ?></p>
+		echo sprintf(
+			esc_html__(
+				'Event Espresso is a %sWordPress event manager%s which makes it easy for you to register attendees for classes, workshops, events, trainings, conferences or concerts, all from your WordPress website. Event Espresso events are created from the WordPress admin area. You can create signup forms to collect information about your attendees, accept payments, and create reports. The lite version of the plugin provides everything that you need to manage your event using WordPress.',
+				'event_espresso'
+			),
+			'<a href="http://eventespresso.com/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=espresso_about_tab&amp;utm_content=EE4+Decaf" rel="nofollow">',
+			'</a>'
+		); ?></p>
 </div>
     <div class="feature-section has-3-columns is-fullwidth three-col">
         <div class="column col">
             <img src="<?php echo EE_GLOBAL_ASSETS_URL; ?>images/screenshots/publish_meta_box.jpg">
             <h3><?php esc_html_e('Optimized aesthetic', 'event_espresso'); ?></h3>
             <p><?php
-                esc_html_e(
-                    'The Event Espresso 4 dashboard has a fresh, uncluttered design that embraces clarity and simplicity.',
-                    'event_espresso'
-                ); ?></p>
+				esc_html_e(
+					'The Event Espresso 4 dashboard has a fresh, uncluttered design that embraces clarity and simplicity.',
+					'event_espresso'
+				); ?></p>
         </div>
         <div class="column col">
             <img src="<?php echo EE_GLOBAL_ASSETS_URL; ?>images/screenshots/registrations-overview.jpg">
             <h3><?php esc_html_e('Integrated management', 'event_espresso'); ?></h3>
             <p><?php
-                esc_html_e(
-                    'We’ve made it easier to know who your customers are and how they’ve done business with you over time.',
-                    'event_espresso'
-                ); ?></p>
+				esc_html_e(
+					'We’ve made it easier to know who your customers are and how they’ve done business with you over time.',
+					'event_espresso'
+				); ?></p>
         </div>
         <div class="column col last-feature">
             <img src="<?php echo EE_GLOBAL_ASSETS_URL; ?>images/screenshots/refined-bookkeeping.jpg">
             <h3><?php esc_html_e('Easy bookkeeping', 'event_espresso'); ?></h3>
             <p><?php
-                esc_html_e(
-                    'Registrations, payment, and transactions have been substantially improved in Event Espresso 4.',
-                    'event_espresso'
-                ); ?></p>
+				esc_html_e(
+					'Registrations, payment, and transactions have been substantially improved in Event Espresso 4.',
+					'event_espresso'
+				); ?></p>
         </div>
     </div>
 
@@ -62,16 +62,16 @@ 
         <div class="column col">
             <h3><?php esc_html_e('Higher customer retention', 'event_espresso'); ?></h3>
             <p><?php
-                esc_html_e(
-                    'The Event Espresso 4 registration process is faster than ever. With quick ticket selections, single page check-out, and customizable notifications! Registration that can scale to your business needs.',
-                    'event_espresso'
-                ); ?></p>
+				esc_html_e(
+					'The Event Espresso 4 registration process is faster than ever. With quick ticket selections, single page check-out, and customizable notifications! Registration that can scale to your business needs.',
+					'event_espresso'
+				); ?></p>
             <h4><?php esc_html_e('Ticket selection boxes on any post page or post', 'event_espresso'); ?></h4>
             <p><?php
-                esc_html_e(
-                    'Customers can easily register for classes, events, or conferences, in just a few simple steps. No matter how you use it, Event Espresso 4 will adapt to a multitude of different ticketing and pricing scenarios.',
-                    'event_espresso'
-                ); ?></p>
+				esc_html_e(
+					'Customers can easily register for classes, events, or conferences, in just a few simple steps. No matter how you use it, Event Espresso 4 will adapt to a multitude of different ticketing and pricing scenarios.',
+					'event_espresso'
+				); ?></p>
         </div>
         <div class="column col last-feature about-colors-img">
             <img src="<?php echo EE_GLOBAL_ASSETS_URL; ?>images/screenshots/registrtation-page-large.jpg">
@@ -85,21 +85,21 @@ 
         <div class="column col">
             <h3><?php esc_html_e('Refined event management', 'event_espresso'); ?></h3>
             <p><?php
-                esc_html_e(
-                    'The new event management screen lets you survey your events at a glance. Want more information? Click to view more. Quickly add/edit prices, dates, or information in any event.',
-                    'event_espresso'
-                ); ?></p>
+				esc_html_e(
+					'The new event management screen lets you survey your events at a glance. Want more information? Click to view more. Quickly add/edit prices, dates, or information in any event.',
+					'event_espresso'
+				); ?></p>
             <h4><?php esc_html_e('Smoother price types, taxes, and price modifiers', 'event_espresso'); ?></h4>
             <p><?php
-                esc_html_e(
-                    'Price Types allow you to create new prices that adjust the default ticket (base) price for your system-default ticket',
-                    'event_espresso'
-                ); ?>.</p>
+				esc_html_e(
+					'Price Types allow you to create new prices that adjust the default ticket (base) price for your system-default ticket',
+					'event_espresso'
+				); ?>.</p>
             <p><?php
-                esc_html_e(
-                    'Easily categorize a price modifier and indicate how that price gets applied to the running total when a transaction occurs.',
-                    'event_espresso'
-                ); ?></p>
+				esc_html_e(
+					'Easily categorize a price modifier and indicate how that price gets applied to the running total when a transaction occurs.',
+					'event_espresso'
+				); ?></p>
         </div>
         <div class="column col last-feature about-themes-img">
             <img src="<?php echo EE_GLOBAL_ASSETS_URL; ?>images/screenshots/event-management.jpg">
@@ -109,68 +109,68 @@ 
 <hr>
 
     <h2 class="about-headline-callout"><?php
-        esc_html_e(
-            'People Like You Manage Event Registration with WordPress',
-            'event_espresso'
-        ); ?></h2>
+		esc_html_e(
+			'People Like You Manage Event Registration with WordPress',
+			'event_espresso'
+		); ?></h2>
     <div class="feature-section has-2-columns is-fullwidth two-col">
         <div class="column col">
             <p><?php
-                echo sprintf(
-                    esc_html__(
-                        'Trusted by thousands, Event Espresso is the best WordPress event online registration and ticketing manager plugin–and the best supported with full-time support. Turn your existing blog or website into a %sfully-featured event management website%s and a new way to make money. With Event Espresso you get it all; everything from custom registration forms and emails, seating limits, multiple price options, and discount codes to printable tickets.',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>'
-                ); ?></p>
-            <p><?php
-                esc_html_e(
-                    'Event Espresso works perfectly for classes, workshops, fundraisers, sporting, trainings, conferences, networking, religion, social, non-profit, and nearly any other type of event.',
-                    'event_espresso'
-                ); ?></p>
+				echo sprintf(
+					esc_html__(
+						'Trusted by thousands, Event Espresso is the best WordPress event online registration and ticketing manager plugin–and the best supported with full-time support. Turn your existing blog or website into a %sfully-featured event management website%s and a new way to make money. With Event Espresso you get it all; everything from custom registration forms and emails, seating limits, multiple price options, and discount codes to printable tickets.',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>'
+				); ?></p>
+            <p><?php
+				esc_html_e(
+					'Event Espresso works perfectly for classes, workshops, fundraisers, sporting, trainings, conferences, networking, religion, social, non-profit, and nearly any other type of event.',
+					'event_espresso'
+				); ?></p>
         </div>
         <div class="column col">
             <p><?php
-                echo sprintf(
-                    esc_html__(
-                        'Our online event registration software can %smake your organization more profitable and efficient%s by helping you save money on registration and ticketing fees, reduce the countless hours of time you spend manually processing registrations, create a “green” and paperless event registration process and you will be open for business to accept registrations and payment 24/7.',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>'
-                ); ?></p>
-            <p><?php
-                esc_html_e(
-                    'If you\'re doing event registration and ticketing any other way, then you’re wasting time and money. We offer packages and prices to fit any budget, so get started with your online event registration and ticketing management system today.',
-                    'event_espresso'
-                ); ?></p>
+				echo sprintf(
+					esc_html__(
+						'Our online event registration software can %smake your organization more profitable and efficient%s by helping you save money on registration and ticketing fees, reduce the countless hours of time you spend manually processing registrations, create a “green” and paperless event registration process and you will be open for business to accept registrations and payment 24/7.',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>'
+				); ?></p>
+            <p><?php
+				esc_html_e(
+					'If you\'re doing event registration and ticketing any other way, then you’re wasting time and money. We offer packages and prices to fit any budget, so get started with your online event registration and ticketing management system today.',
+					'event_espresso'
+				); ?></p>
         </div>
     </div>
 
     <div class="feature-section has-2-columns is-fullwidth two-col">
         <div class="column col">
             <h3><?php
-                esc_html_e(
-                    'Turn your blog into a complete event registration and management system',
-                    'event_espresso'
-                ); ?></h3>
-            <p><?php
-                esc_html_e(
-                    'Create a beautiful event page with ticket selection, venue details, and an integrated single page checkout system. With WordPress, Event Espresso, and Espresso Arabica 2014 (based on the "Twenty Fourteen" theme by WordPress), your events will certainly sell out faster than ever!',
-                    'event_espresso'
-                ); ?></p>
-            <p><?php
-                esc_html_e(
-                    'With a striking design that does not compromise the simplicity of WordPress and Event Espresso 4, Espresso Arabica 2014 will be the best event theme on the market.',
-                    'event_espresso'
-                ); ?></p>
-            <p><?php
-                echo sprintf(
-                    esc_html__('%sLearn more >>%s', 'event_espresso'),
-                    '<a href="http://eventespresso.com/wiki/setup-event-espresso-arabica-theme/">',
-                    '</a>'
-                ); ?></p>
+				esc_html_e(
+					'Turn your blog into a complete event registration and management system',
+					'event_espresso'
+				); ?></h3>
+            <p><?php
+				esc_html_e(
+					'Create a beautiful event page with ticket selection, venue details, and an integrated single page checkout system. With WordPress, Event Espresso, and Espresso Arabica 2014 (based on the "Twenty Fourteen" theme by WordPress), your events will certainly sell out faster than ever!',
+					'event_espresso'
+				); ?></p>
+            <p><?php
+				esc_html_e(
+					'With a striking design that does not compromise the simplicity of WordPress and Event Espresso 4, Espresso Arabica 2014 will be the best event theme on the market.',
+					'event_espresso'
+				); ?></p>
+            <p><?php
+				echo sprintf(
+					esc_html__('%sLearn more >>%s', 'event_espresso'),
+					'<a href="http://eventespresso.com/wiki/setup-event-espresso-arabica-theme/">',
+					'</a>'
+				); ?></p>
         </div>
         <div class="column col"><img src="<?php echo EE_GLOBAL_ASSETS_URL; ?>images/screenshots/single-event-page.jpg"></div>
     </div>
@@ -183,10 +183,10 @@ 
     <div class="feature-section has-1-column is-fullwidth is-wide one-col">
         <div class="column col">
             <p><?php
-            esc_html_e(
-                'We’ve made it super easy to integrate Event Espresso with almost any properly coded WordPress theme, including many of the thousands of themes available on WordPress.org. The image below shows the same Event Espresso ticketing page across three diffrent WordPress themes.',
-                'event_espresso'
-            ); ?></p>
+			esc_html_e(
+				'We’ve made it super easy to integrate Event Espresso with almost any properly coded WordPress theme, including many of the thousands of themes available on WordPress.org. The image below shows the same Event Espresso ticketing page across three diffrent WordPress themes.',
+				'event_espresso'
+			); ?></p>
             <p><img class="about-overview-img" src="<?php echo EE_GLOBAL_ASSETS_URL; ?>images/screenshots/multiple-themes.jpg"/></p>
         </div>
     </div>

admin_pages/about/templates/ee4-overview.template.php

Indentation +124 added lines, -124 removed lines

@@ -1,24 +1,24 @@ 
 <?php
 // maintenance mode on?
 if (EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance) {
-    ?>
+	?>
     <div class="ee-attention">
         <h2 class="ee-maintenance-mode-callout">
             <?php esc_html_e(
-                'Event Espresso is in full maintenance mode.',
-                'event_espresso'
-            ); ?></h2>
+				'Event Espresso is in full maintenance mode.',
+				'event_espresso'
+			); ?></h2>
         <p>
             <?php
-            printf(
-                esc_html__(
-                    'A previous version of Event Espresso has detected. But before anything else can happen, we need to know whether or not to migrate (copy over) your existing event data so that it can be utilized by EE4. For more instructions on what to do, please visit the %sEvent Espresso Maintenance%s page.',
-                    'event_espresso'
-                ),
-                '<a href="admin.php?page=espresso_maintenance_settings">',
-                '</a>'
-            );
-            ?>
+			printf(
+				esc_html__(
+					'A previous version of Event Espresso has detected. But before anything else can happen, we need to know whether or not to migrate (copy over) your existing event data so that it can be utilized by EE4. For more instructions on what to do, please visit the %sEvent Espresso Maintenance%s page.',
+					'event_espresso'
+				),
+				'<a href="admin.php?page=espresso_maintenance_settings">',
+				'</a>'
+			);
+			?>
         </p>
     </div>
     <?php
@@ -27,62 +27,62 @@ 
 <div class="headline-feature">
     <h2 class="about-headline-callout">
         <?php esc_html_e(
-            'Welcome to the Decaf (free) Version of Event Espresso 4!',
-            'event_espresso'
-        ); ?></h2>
+			'Welcome to the Decaf (free) Version of Event Espresso 4!',
+			'event_espresso'
+		); ?></h2>
     <p><?php
-        echo sprintf(
-            esc_html__(
-                'Manage your events from your WordPress dashboard. Reduce your admin, reduce your costs, make your life easier! This is the Decaf version of Event Espresso, but we also have a premium version called %sEvent Espreso 4 Regular%s and a hosted version called %sEvent Smart%s (SaaS).',
-                'event_espresso'
-            ),
-            '<a href="?page=espresso_about&action=decafvpro">',
-            '</a>',
-            '<a href="https://eventsmart.com//?utm_source=ee4_decaf&amp;utm_medium=link&amp;utm_campaign=espresso_about_tab&amp;utm_content=EE4+Decaf">',
-            '</a>'
-        ); ?></p>
+		echo sprintf(
+			esc_html__(
+				'Manage your events from your WordPress dashboard. Reduce your admin, reduce your costs, make your life easier! This is the Decaf version of Event Espresso, but we also have a premium version called %sEvent Espreso 4 Regular%s and a hosted version called %sEvent Smart%s (SaaS).',
+				'event_espresso'
+			),
+			'<a href="?page=espresso_about&action=decafvpro">',
+			'</a>',
+			'<a href="https://eventsmart.com//?utm_source=ee4_decaf&amp;utm_medium=link&amp;utm_campaign=espresso_about_tab&amp;utm_content=EE4+Decaf">',
+			'</a>'
+		); ?></p>
     <h2>
         <?php esc_html_e(
-            'Powering 40,000+ event websites; $100 million in ticket sales per year!',
-            'event_espresso'
-        ); ?></h2>
+			'Powering 40,000+ event websites; $100 million in ticket sales per year!',
+			'event_espresso'
+		); ?></h2>
     <p><?php
-        echo sprintf(
-            esc_html__(
-                'Event Espresso is a %sWordPress event manager%s which makes it easy for you to register attendees for classes, workshops, events, trainings, conferences or concerts, all from your WordPress website. Event Espresso events are created from the WordPress admin area. You can create signup forms to collect information about your attendees, accept payments, and create reports. The Decaf (free) version of the plugin provides everything that you need to manage your event using WordPress.',
-                'event_espresso'
-            ),
-            '<a href="http://eventespresso.com/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=plugin_description_tab&amp;utm_content=EE4+Decaf">',
-            '</a>'
-        ); ?></p>
+		echo sprintf(
+			esc_html__(
+				'Event Espresso is a %sWordPress event manager%s which makes it easy for you to register attendees for classes, workshops, events, trainings, conferences or concerts, all from your WordPress website. Event Espresso events are created from the WordPress admin area. You can create signup forms to collect information about your attendees, accept payments, and create reports. The Decaf (free) version of the plugin provides everything that you need to manage your event using WordPress.',
+				'event_espresso'
+			),
+			'<a href="http://eventespresso.com/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=plugin_description_tab&amp;utm_content=EE4+Decaf">',
+			'</a>'
+		); ?></p>
 </div>
     <div class="feature-section has-3-columns is-fullwidth three-col">
         <div class="column col">
             <img src="<?php echo EE_GLOBAL_ASSETS_URL; ?>images/screenshots/publish_meta_box.jpg">
             <h3><?php esc_html_e('Optimized aesthetic', 'event_espresso'); ?></h3>
             <p><?php
-                esc_html_e(
-                    'The Event Espresso 4 dashboard has a fresh, uncluttered design that embraces clarity and simplicity.',
-                    'event_espresso'
-                ); ?></p>
+				esc_html_e(
+					'The Event Espresso 4 dashboard has a fresh, uncluttered design that embraces clarity and simplicity.',
+					'event_espresso'
+				); ?></p>
         </div>
         <div class="column col">
             <img src="<?php echo EE_GLOBAL_ASSETS_URL; ?>images/screenshots/registrations-overview.jpg">
             <h3><?php esc_html_e('Integrated management', 'event_espresso'); ?></h3>
             <p><?php
-                esc_html_e(
-                    'We’ve made it easier to know who your customers are and how they’ve done business with you over time.',
-                    'event_espresso'
-                ); ?></p>
+				esc_html_e(
+					'We’ve made it easier to know who your customers are and how they’ve done business with you over time.',
+					'event_espresso'
+				); ?></p>
         </div>
         <div class="column col last-feature">
             <img src="<?php echo EE_GLOBAL_ASSETS_URL; ?>images/screenshots/refined-bookkeeping.jpg">
             <h3><?php esc_html_e('Easy bookkeeping', 'event_espresso'); ?></h3>
             <p><?php
-                esc_html_e(
-                    'Registrations, payment, and transactions have been substantially improved in Event Espresso 4.',
-                    'event_espresso'
-                ); ?></p>
+				esc_html_e(
+					'Registrations, payment, and transactions have been substantially improved in Event Espresso 4.',
+					'event_espresso'
+				); ?></p>
         </div>
     </div>
 
@@ -92,16 +92,16 @@ 
         <div class="column col">
             <h3><?php esc_html_e('Higher customer retention', 'event_espresso'); ?></h3>
             <p><?php
-                esc_html_e(
-                    'The Event Espresso 4 registration process is faster than ever. With quick ticket selections, single page check-out, and customizable notifications! Registration that can scale to your business needs.',
-                    'event_espresso'
-                ); ?></p>
+				esc_html_e(
+					'The Event Espresso 4 registration process is faster than ever. With quick ticket selections, single page check-out, and customizable notifications! Registration that can scale to your business needs.',
+					'event_espresso'
+				); ?></p>
             <h4><?php esc_html_e('Ticket selection boxes on any post page or post', 'event_espresso'); ?></h4>
             <p><?php
-                esc_html_e(
-                    'Customers can easily register for classes, events, or conferences, in just a few simple steps. No matter how you use it, Event Espresso 4 will adapt to a multitude of different ticketing and pricing scenarios.',
-                    'event_espresso'
-                ); ?></p>
+				esc_html_e(
+					'Customers can easily register for classes, events, or conferences, in just a few simple steps. No matter how you use it, Event Espresso 4 will adapt to a multitude of different ticketing and pricing scenarios.',
+					'event_espresso'
+				); ?></p>
         </div>
         <div class="column col last-feature about-colors-img">
             <img src="<?php echo EE_GLOBAL_ASSETS_URL; ?>images/screenshots/registrtation-page-large.jpg">
@@ -112,22 +112,22 @@ 
         <div class="column col">
             <h3><?php esc_html_e('Refined event management', 'event_espresso'); ?></h3>
             <p><?php
-                esc_html_e(
-                    'The new event management screen lets you survey your events at a glance. Want more information? Click to view more. Quickly add/edit prices, dates, or information in any event.',
-                    'event_espresso'
-                ); ?></p>
+				esc_html_e(
+					'The new event management screen lets you survey your events at a glance. Want more information? Click to view more. Quickly add/edit prices, dates, or information in any event.',
+					'event_espresso'
+				); ?></p>
             <h4><?php
-                esc_html_e('Smoother price types, taxes, and price modifiers', 'event_espresso'); ?></h4>
+				esc_html_e('Smoother price types, taxes, and price modifiers', 'event_espresso'); ?></h4>
             <p><?php
-                esc_html_e(
-                    'Price Types allow you to create new prices that adjust the default ticket (base) price for your system-default ticket',
-                    'event_espresso'
-                ); ?>.</p>
+				esc_html_e(
+					'Price Types allow you to create new prices that adjust the default ticket (base) price for your system-default ticket',
+					'event_espresso'
+				); ?>.</p>
             <p><?php
-                esc_html_e(
-                    'Easily categorize a price modifier and indicate how that price gets applied to the running total when a transaction occurs.',
-                    'event_espresso'
-                ); ?></p>
+				esc_html_e(
+					'Easily categorize a price modifier and indicate how that price gets applied to the running total when a transaction occurs.',
+					'event_espresso'
+				); ?></p>
         </div>
         <div class="column col last-feature about-themes-img">
             <img src="<?php echo EE_GLOBAL_ASSETS_URL; ?>images/screenshots/event-management.jpg">
@@ -137,68 +137,68 @@ 
 <hr>
 
     <h2 class="about-headline-callout"><?php
-        esc_html_e(
-            'People Like You Manage Event Registration with WordPress',
-            'event_espresso'
-        ); ?></h2>
+		esc_html_e(
+			'People Like You Manage Event Registration with WordPress',
+			'event_espresso'
+		); ?></h2>
     <div class="feature-section has-2-columns is-fullwidth two-col">
         <div class="column col">
             <p><?php
-                echo sprintf(
-                    esc_html__(
-                        'Trusted by thousands, Event Espresso is the best WordPress event online registration and ticketing manager plugin–and the best supported with full-time support. Turn your existing blog or website into a %sfully-featured event management website%s and a new way to make money. With Event Espresso you get it all; everything from custom registration forms and emails, seating limits, multiple price options, and discount codes to printable tickets.',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>'
-                ); ?></p>
-            <p><?php
-                esc_html_e(
-                    'Event Espresso works perfectly for classes, workshops, fundraisers, sporting, trainings, conferences, networking, religion, social, non-profit, and nearly any other type of event.',
-                    'event_espresso'
-                ); ?></p>
+				echo sprintf(
+					esc_html__(
+						'Trusted by thousands, Event Espresso is the best WordPress event online registration and ticketing manager plugin–and the best supported with full-time support. Turn your existing blog or website into a %sfully-featured event management website%s and a new way to make money. With Event Espresso you get it all; everything from custom registration forms and emails, seating limits, multiple price options, and discount codes to printable tickets.',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>'
+				); ?></p>
+            <p><?php
+				esc_html_e(
+					'Event Espresso works perfectly for classes, workshops, fundraisers, sporting, trainings, conferences, networking, religion, social, non-profit, and nearly any other type of event.',
+					'event_espresso'
+				); ?></p>
         </div>
         <div class="column col">
             <p><?php
-                echo sprintf(
-                    esc_html__(
-                        'Our online event registration software can %smake your organization more profitable and efficient%s by helping you save money on registration and ticketing fees, reduce the countless hours of time you spend manually processing registrations, create a “green” and paperless event registration process and you will be open for business to accept registrations and payment 24/7.',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>'
-                ); ?></p>
-            <p><?php
-                esc_html_e(
-                    'If you\'re doing event registration and ticketing any other way, then you’re wasting time and money. We offer packages and prices to fit any budget, so get started with your online event registration and ticketing management system today.',
-                    'event_espresso'
-                ); ?></p>
+				echo sprintf(
+					esc_html__(
+						'Our online event registration software can %smake your organization more profitable and efficient%s by helping you save money on registration and ticketing fees, reduce the countless hours of time you spend manually processing registrations, create a “green” and paperless event registration process and you will be open for business to accept registrations and payment 24/7.',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>'
+				); ?></p>
+            <p><?php
+				esc_html_e(
+					'If you\'re doing event registration and ticketing any other way, then you’re wasting time and money. We offer packages and prices to fit any budget, so get started with your online event registration and ticketing management system today.',
+					'event_espresso'
+				); ?></p>
         </div>
     </div>
 
     <div class="feature-section has-2-columns is-fullwidth two-col">
         <div class="column col">
             <h3><?php
-                esc_html_e(
-                    'Turn your blog into a complete event registration and management system',
-                    'event_espresso'
-                ); ?></h3>
-            <p><?php
-                esc_html_e(
-                    'Create a beautiful event page with ticket selection, venue details, and an integrated single page checkout system. With WordPress, Event Espresso, and Espresso Arabica 2014 (based on the "Twenty Fourteen" theme by WordPress), your events will certainly sell out faster than ever!',
-                    'event_espresso'
-                ); ?></p>
-            <p><?php
-                esc_html_e(
-                    'With a striking design that does not compromise the simplicity of WordPress and Event Espresso 4, Espresso Arabica 2014 will be the best event theme on the market.',
-                    'event_espresso'
-                ); ?></p>
-            <p><?php
-                echo sprintf(
-                    esc_html__('%sLearn more >>%s', 'event_espresso'),
-                    '<a href="http://eventespresso.com/wiki/setup-event-espresso-arabica-theme/">',
-                    '</a>'
-                ); ?></p>
+				esc_html_e(
+					'Turn your blog into a complete event registration and management system',
+					'event_espresso'
+				); ?></h3>
+            <p><?php
+				esc_html_e(
+					'Create a beautiful event page with ticket selection, venue details, and an integrated single page checkout system. With WordPress, Event Espresso, and Espresso Arabica 2014 (based on the "Twenty Fourteen" theme by WordPress), your events will certainly sell out faster than ever!',
+					'event_espresso'
+				); ?></p>
+            <p><?php
+				esc_html_e(
+					'With a striking design that does not compromise the simplicity of WordPress and Event Espresso 4, Espresso Arabica 2014 will be the best event theme on the market.',
+					'event_espresso'
+				); ?></p>
+            <p><?php
+				echo sprintf(
+					esc_html__('%sLearn more >>%s', 'event_espresso'),
+					'<a href="http://eventespresso.com/wiki/setup-event-espresso-arabica-theme/">',
+					'</a>'
+				); ?></p>
         </div>
         <div class="column col"><img src="<?php echo EE_GLOBAL_ASSETS_URL; ?>images/screenshots/single-event-page.jpg"></div>
     </div>
@@ -209,10 +209,10 @@ 
     <div class="feature-section has-1-column is-fullwidth is-wide one-col">
         <div class="column col">
             <p><?php
-            esc_html_e(
-                'We’ve made it super easy to integrate Event Espresso with almost any properly coded WordPress theme, including many of the thousands of themes available on WordPress.org. The image below shows the same Event Espresso ticketing page across three diffrent WordPress themes.',
-                'event_espresso'
-            ); ?></p>
+			esc_html_e(
+				'We’ve made it super easy to integrate Event Espresso with almost any properly coded WordPress theme, including many of the thousands of themes available on WordPress.org. The image below shows the same Event Espresso ticketing page across three diffrent WordPress themes.',
+				'event_espresso'
+			); ?></p>
             <p><img class="about-overview-img" src="<?php echo EE_GLOBAL_ASSETS_URL; ?>images/screenshots/multiple-themes.jpg"/></p>
         </div>
     </div>

admin_pages/about/templates/reviews.template.php

Indentation +26 added lines, -26 removed lines

@@ -1,19 +1,19 @@ 
 <h2 style="text-align: left;"><?php esc_html_e('Who uses Event Espresso?', 'event_espresso'); ?></h2>
 <p><?php
-    echo sprintf(
-        esc_html__(
-            'Event Espresso is used by over 40,000 event organizers across the world. They host %sconferences%s, %sart classes%s, training courses, concerts, fundraisers, workshops, %sfilm festivals%s, %spaint and wine%s, and more.',
-            'event_espresso'
-        ),
-        '<a href="https://eventespresso.com/use-cases/conferences/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
-        '</a>',
-        '<a href="https://eventespresso.com/use-cases/art-classes/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
-        '</a>',
-        '<a href="https://eventespresso.com/use-cases/film-festival-ticketing-software/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
-        '</a>',
-        '<a href="https://eventespresso.com/use-cases/paint-wine-party-ticketing-software/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
-        '</a>'
-    ); ?></p>
+	echo sprintf(
+		esc_html__(
+			'Event Espresso is used by over 40,000 event organizers across the world. They host %sconferences%s, %sart classes%s, training courses, concerts, fundraisers, workshops, %sfilm festivals%s, %spaint and wine%s, and more.',
+			'event_espresso'
+		),
+		'<a href="https://eventespresso.com/use-cases/conferences/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
+		'</a>',
+		'<a href="https://eventespresso.com/use-cases/art-classes/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
+		'</a>',
+		'<a href="https://eventespresso.com/use-cases/film-festival-ticketing-software/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
+		'</a>',
+		'<a href="https://eventespresso.com/use-cases/paint-wine-party-ticketing-software/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
+		'</a>'
+	); ?></p>
 
     <h2 class="about-headline-callout"><?php esc_html_e('Rave Reviews About Event Espresso 4', 'event_espresso'); ?></h2>
     <p>See what people have to say about the Event Espresso software and support services on <a
@@ -135,16 +135,16 @@ 
 
     </div>
     <?php
-    if (! defined('EE_CAF_URL')) {
-        ?>
+	if (! defined('EE_CAF_URL')) {
+		?>
         <div align="right"><a
                 href="https://eventespresso.com/pricing/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=reviews+tab"
                 target="_blank" class="button button-primary button-hero"><span
                     class="dashicons dashicons-cart"></span><?php esc_html_e('Upgrade Now!', 'event_espresso') ?></a>
         </div>
         <?php
-    }
-    ?>
+	}
+	?>
     &nbsp;
     <hr/>
     <div class="feature-section has-3-columns is-fullwidth three-col">
@@ -255,16 +255,16 @@ 
 
     </div>
     <?php
-    if (! defined('EE_CAF_URL')) {
-        ?>
+	if (! defined('EE_CAF_URL')) {
+		?>
         <div align="right"><a
                 href="https://eventespresso.com/pricing/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=reviews+tab"
                 target="_blank" class="button button-primary button-hero"><span
                     class="dashicons dashicons-cart"></span><?php esc_html_e('Upgrade Now!', 'event_espresso') ?></a>
         </div>
         <?php
-    }
-    ?>
+	}
+	?>
     &nbsp;
     <hr/>
     <div class="feature-section has-3-columns is-fullwidth three-col">
@@ -366,13 +366,13 @@ 
         </div>
     </div>
     <?php
-    if (! defined('EE_CAF_URL')) {
-        ?>
+	if (! defined('EE_CAF_URL')) {
+		?>
         <div align="right"><a
                 href="https://eventespresso.com/pricing/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=reviews+tab"
                 target="_blank" class="button button-primary button-hero"><span
                     class="dashicons dashicons-cart"></span><?php esc_html_e('Upgrade Now!', 'event_espresso') ?></a>
         </div>
         <?php
-    }
-    ?>
\ No newline at end of file
+	}
+	?>
\ No newline at end of file

admin_pages/registrations/templates/reg_admin_details_side_meta_box_registrant.template.php

Indentation +12 added lines, -12 removed lines

@@ -35,13 +35,13 @@ 
 
 <div class="contact-details-buttons">
     <?php
-    if ($att_check instanceof EE_Attendee
-        && EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_contact',
-            'view_or_edit_contact_button',
-            $att_check->ID()
-        )) :
-    ?>
+	if ($att_check instanceof EE_Attendee
+		&& EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_contact',
+			'view_or_edit_contact_button',
+			$att_check->ID()
+		)) :
+	?>
     <a class="button button-small" href="<?php echo $att_edit_link; ?>"
        title="<?php echo esc_attr($att_edit_label); ?>">
         <span class="ee-icon ee-icon-user-edit"></span><?php echo $att_edit_label; ?>
@@ -49,15 +49,15 @@ 
     <?php if (! empty($create_link)) : ?>
         <a class="button button-small" href="<?php echo $create_link; ?>"
            title="<?php
-                   esc_attr_e(
-                       'This registration shares the contact details for the primary registration in this group.  If you\'d like this registration to have its own details, you can do so by clicking this button',
-                       'event_espresso'
-                   ); ?>">
+				   esc_attr_e(
+					   'This registration shares the contact details for the primary registration in this group.  If you\'d like this registration to have its own details, you can do so by clicking this button',
+					   'event_espresso'
+				   ); ?>">
             <span class="ee-icon ee-icon-user-add-new"></span><?php echo $create_label; ?>
         </a>
     <?php endif; ?>
 <div style="clear:both"></div>
 <?php
-    endif;
+	endif;
 ?>
 </div>

Spacing +3 added lines, -3 removed lines

@@ -2,7 +2,7 @@ 
     <div class="clearfix">
         <span class="admin-side-mbox-label-spn lt-grey-txt float-left">
             <?php esc_html_e('Name', 'event_espresso'); ?>
-        </span><?php echo $fname . ' ' . $lname; ?>
+        </span><?php echo $fname.' '.$lname; ?>
     </div>
     <div class="clearfix">
         <span class="admin-side-mbox-label-spn lt-grey-txt float-left">
@@ -16,7 +16,7 @@ 
         <span class="admin-side-mbox-label-spn lt-grey-txt float-left">
             <?php esc_html_e('Phone #', 'event_espresso'); ?>
         </span>
-        <?php if (! empty($phone)) : ?>
+        <?php if ( ! empty($phone)) : ?>
             <a href="tel:<?php echo $phone; ?>">
                 <?php echo $phone; ?>
             </a>
@@ -46,7 +46,7 @@ 
        title="<?php echo esc_attr($att_edit_label); ?>">
         <span class="ee-icon ee-icon-user-edit"></span><?php echo $att_edit_label; ?>
     </a>
-    <?php if (! empty($create_link)) : ?>
+    <?php if ( ! empty($create_link)) : ?>
         <a class="button button-small" href="<?php echo $create_link; ?>"
            title="<?php
                    esc_attr_e(

core/EE_Cron_Tasks.core.php

Indentation +592 added lines, -592 removed lines

@@ -15,596 +15,596 @@
 class EE_Cron_Tasks extends EE_Base
 {
 
-    /**
-     * WordPress doesn't allow duplicate crons within 10 minutes of the original,
-     * so we'll set our retry time for just over 10 minutes to avoid that
-     */
-    const reschedule_timeout = 605;
-
-
-    /**
-     * @var EE_Cron_Tasks
-     */
-    private static $_instance;
-
-
-    /**
-     * @return EE_Cron_Tasks
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function instance()
-    {
-        if (! self::$_instance instanceof EE_Cron_Tasks) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @access private
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function __construct()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        // verify that WP Cron is enabled
-        if (defined('DISABLE_WP_CRON')
-            && DISABLE_WP_CRON
-            && is_admin()
-            && ! get_option('ee_disabled_wp_cron_check')
-        ) {
-            /**
-             * This needs to be delayed until after the config is loaded because EE_Cron_Tasks is constructed before
-             * config is loaded.
-             * This is intentionally using a anonymous function so that its not easily de-registered.  Client code
-             * wanting to not have this functionality can just register its own action at a priority after this one to
-             * reverse any changes.
-             */
-            add_action(
-                'AHEE__EE_System__load_core_configuration__complete',
-                function () {
-                    EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
-                    EE_Registry::instance()->NET_CFG->update_config(true, false);
-                    add_option('ee_disabled_wp_cron_check', 1, '', false);
-                }
-            );
-        }
-        // UPDATE TRANSACTION WITH PAYMENT
-        add_action(
-            'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
-            array('EE_Cron_Tasks', 'setup_update_for_transaction_with_payment'),
-            10,
-            2
-        );
-        // ABANDONED / EXPIRED TRANSACTION CHECK
-        add_action(
-            'AHEE__EE_Cron_Tasks__expired_transaction_check',
-            array('EE_Cron_Tasks', 'expired_transaction_check'),
-            10,
-            1
-        );
-        // CLEAN OUT JUNK TRANSACTIONS AND RELATED DATA
-        add_action(
-            'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
-            array('EE_Cron_Tasks', 'clean_out_junk_transactions')
-        );
-        // logging
-        add_action(
-            'AHEE__EE_System__load_core_configuration__complete',
-            array('EE_Cron_Tasks', 'log_scheduled_ee_crons')
-        );
-        EE_Registry::instance()->load_lib('Messages_Scheduler');
-        // clean out old gateway logs
-        add_action(
-            'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs',
-            array('EE_Cron_Tasks', 'clean_out_old_gateway_logs')
-        );
-    }
-
-
-    /**
-     * @access protected
-     * @return void
-     */
-    public static function log_scheduled_ee_crons()
-    {
-        $ee_crons = array(
-            'AHEE__EE_Cron_Tasks__update_transaction_with_payment',
-            'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
-            'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
-        );
-        $crons = (array) get_option('cron');
-        if (! is_array($crons)) {
-            return;
-        }
-        foreach ($crons as $timestamp => $cron) {
-            /** @var array[] $cron */
-            foreach ($ee_crons as $ee_cron) {
-                if (isset($cron[ $ee_cron ]) && is_array($cron[ $ee_cron ])) {
-                    do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
-                    foreach ($cron[ $ee_cron ] as $ee_cron_details) {
-                        if (! empty($ee_cron_details['args'])) {
-                            do_action(
-                                'AHEE_log',
-                                __CLASS__,
-                                __FUNCTION__,
-                                print_r($ee_cron_details['args'], true),
-                                "{$ee_cron} args"
-                            );
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * reschedule_cron_for_transactions_if_maintenance_mode
-     * if Maintenance Mode is active, this will reschedule a cron to run again in 10 minutes
-     *
-     * @param string $cron_task
-     * @param array  $TXN_IDs
-     * @return bool
-     * @throws DomainException
-     */
-    public static function reschedule_cron_for_transactions_if_maintenance_mode($cron_task, array $TXN_IDs)
-    {
-        if (! method_exists('EE_Cron_Tasks', $cron_task)) {
-            throw new DomainException(
-                sprintf(
-                    __('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
-                    $cron_task
-                )
-            );
-        }
-        // reschedule the cron if we can't hit the db right now
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-            foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
-                // ensure $additional_vars is an array
-                $additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
-                // reset cron job for the TXN
-                call_user_func_array(
-                    array('EE_Cron_Tasks', $cron_task),
-                    array_merge(
-                        array(
-                            time() + (10 * MINUTE_IN_SECONDS),
-                            $TXN_ID,
-                        ),
-                        $additional_vars
-                    )
-                );
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-
-
-    /****************  UPDATE TRANSACTION WITH PAYMENT ****************/
-
-
-    /**
-     * array of TXN IDs and the payment
-     *
-     * @var array
-     */
-    protected static $_update_transactions_with_payment = array();
-
-
-    /**
-     * schedule_update_transaction_with_payment
-     * sets a wp_schedule_single_event() for updating any TXNs that may
-     * require updating due to recently received payments
-     *
-     * @param int $timestamp
-     * @param int $TXN_ID
-     * @param int $PAY_ID
-     */
-    public static function schedule_update_transaction_with_payment(
-        $timestamp,
-        $TXN_ID,
-        $PAY_ID
-    ) {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        // validate $TXN_ID and $timestamp
-        $TXN_ID = absint($TXN_ID);
-        $timestamp = absint($timestamp);
-        if ($TXN_ID && $timestamp) {
-            wp_schedule_single_event(
-                $timestamp,
-                'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
-                array($TXN_ID, $PAY_ID)
-            );
-        }
-    }
-
-
-    /**
-     * setup_update_for_transaction_with_payment
-     * this is the callback for the action hook:
-     * 'AHEE__EE_Cron_Tasks__update_transaction_with_payment'
-     * which is setup by EE_Cron_Tasks::schedule_update_transaction_with_payment().
-     * The passed TXN_ID and associated payment gets added to an array, and then
-     * the EE_Cron_Tasks::update_transaction_with_payment() function is hooked into
-     * 'shutdown' which will actually handle the processing of any
-     * transactions requiring updating, because doing so now would be too early
-     * and the required resources may not be available
-     *
-     * @param int $TXN_ID
-     * @param int $PAY_ID
-     */
-    public static function setup_update_for_transaction_with_payment($TXN_ID = 0, $PAY_ID = 0)
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
-        if (absint($TXN_ID)) {
-            self::$_update_transactions_with_payment[ $TXN_ID ] = $PAY_ID;
-            add_action(
-                'shutdown',
-                array('EE_Cron_Tasks', 'update_transaction_with_payment'),
-                5
-            );
-        }
-    }
-
-
-    /**
-     * update_transaction_with_payment
-     * loops through the self::$_abandoned_transactions array
-     * and attempts to finalize any TXNs that have not been completed
-     * but have had their sessions expired, most likely due to a user not
-     * returning from an off-site payment gateway
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public static function update_transaction_with_payment()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        if (// are there any TXNs that need cleaning up ?
-            empty(self::$_update_transactions_with_payment)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_update_transaction_with_payment',
-                self::$_update_transactions_with_payment
-            )
-        ) {
-            return;
-        }
-        /** @type EE_Payment_Processor $payment_processor */
-        $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        // set revisit flag for payment processor
-        $payment_processor->set_revisit();
-        // load EEM_Transaction
-        EE_Registry::instance()->load_model('Transaction');
-        foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
-            // reschedule the cron if we can't hit the db right now
-            if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-                // reset cron job for updating the TXN
-                EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                    time() + EE_Cron_Tasks::reschedule_timeout,
-                    $TXN_ID,
-                    $PAY_ID
-                );
-                continue;
-            }
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            $payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
-            // verify transaction
-            if ($transaction instanceof EE_Transaction && $payment instanceof EE_Payment) {
-                // now try to update the TXN with any payments
-                $payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
-            }
-            unset(self::$_update_transactions_with_payment[ $TXN_ID ]);
-        }
-    }
-
-
-
-    /************  END OF UPDATE TRANSACTION WITH PAYMENT  ************/
-
-
-    /*****************  EXPIRED TRANSACTION CHECK *****************/
-
-
-    /**
-     * array of TXN IDs
-     *
-     * @var array
-     */
-    protected static $_expired_transactions = array();
-
-
-    /**
-     * schedule_expired_transaction_check
-     * sets a wp_schedule_single_event() for following up on TXNs after their session has expired
-     *
-     * @param int $timestamp
-     * @param int $TXN_ID
-     */
-    public static function schedule_expired_transaction_check(
-        $timestamp,
-        $TXN_ID
-    ) {
-        // validate $TXN_ID and $timestamp
-        $TXN_ID = absint($TXN_ID);
-        $timestamp = absint($timestamp);
-        if ($TXN_ID && $timestamp) {
-            wp_schedule_single_event(
-                $timestamp,
-                'AHEE__EE_Cron_Tasks__expired_transaction_check',
-                array($TXN_ID)
-            );
-        }
-    }
-
-
-    /**
-     * expired_transaction_check
-     * this is the callback for the action hook:
-     * 'AHEE__EE_Cron_Tasks__transaction_session_expiration_check'
-     * which is utilized by wp_schedule_single_event()
-     * in \EED_Single_Page_Checkout::_initialize_transaction().
-     * The passed TXN_ID gets added to an array, and then the
-     * process_expired_transactions() function is hooked into
-     * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
-     * processing of any failed transactions, because doing so now would be
-     * too early and the required resources may not be available
-     *
-     * @param int $TXN_ID
-     */
-    public static function expired_transaction_check($TXN_ID = 0)
-    {
-        if (absint($TXN_ID)) {
-            self::$_expired_transactions[ $TXN_ID ] = $TXN_ID;
-            add_action(
-                'shutdown',
-                array('EE_Cron_Tasks', 'process_expired_transactions'),
-                5
-            );
-        }
-    }
-
-
-    /**
-     * process_expired_transactions
-     * loops through the self::$_expired_transactions array and processes any failed TXNs
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws DomainException
-     * @throws RuntimeException
-     */
-    public static function process_expired_transactions()
-    {
-        if (// are there any TXNs that need cleaning up ?
-            empty(self::$_expired_transactions)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_expired_transaction_check',
-                self::$_expired_transactions
-            )
-        ) {
-            return;
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // set revisit flag for txn processor
-        $transaction_processor->set_revisit();
-        // load EEM_Transaction
-        EE_Registry::instance()->load_model('Transaction');
-        foreach (self::$_expired_transactions as $TXN_ID) {
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            // verify transaction and whether it is failed or not
-            if ($transaction instanceof EE_Transaction) {
-                switch ($transaction->status_ID()) {
-                    // Completed TXNs
-                    case EEM_Transaction::complete_status_code:
-                        /** @type EE_Transaction_Processor $transaction_processor */
-                        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-                        $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-                            $transaction,
-                            $transaction->last_payment()
-                        );
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction',
-                            $transaction
-                        );
-                        break;
-                    // Overpaid TXNs
-                    case EEM_Transaction::overpaid_status_code:
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction',
-                            $transaction
-                        );
-                        break;
-                    // Incomplete TXNs
-                    case EEM_Transaction::incomplete_status_code:
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
-                            $transaction
-                        );
-                        // todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
-                        break;
-                    // Abandoned TXNs
-                    case EEM_Transaction::abandoned_status_code:
-                        // run hook before updating transaction, primarily so
-                        // EED_Ticket_Sales_Monitor::process_abandoned_transactions() can release reserved tickets
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
-                            $transaction
-                        );
-                        // don't finalize the TXN if it has already been completed
-                        if ($transaction->all_reg_steps_completed() !== true) {
-                            /** @type EE_Payment_Processor $payment_processor */
-                            $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-                            // let's simulate an IPN here which will trigger any notifications that need to go out
-                            $payment_processor->update_txn_based_on_payment(
-                                $transaction,
-                                $transaction->last_payment(),
-                                true,
-                                true
-                            );
-                        }
-                        break;
-                    // Failed TXNs
-                    case EEM_Transaction::failed_status_code:
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
-                            $transaction
-                        );
-                        // todo :
-                        // perform garbage collection here and remove clean_out_junk_transactions()
-                        // $registrations = $transaction->registrations();
-                        // if (! empty($registrations)) {
-                        //     foreach ($registrations as $registration) {
-                        //         if ($registration instanceof EE_Registration) {
-                        //             $delete_registration = true;
-                        //             if ($registration->attendee() instanceof EE_Attendee) {
-                        //                 $delete_registration = false;
-                        //             }
-                        //             if ($delete_registration) {
-                        //                 $registration->delete_permanently();
-                        //                 $registration->delete_related_permanently();
-                        //             }
-                        //         }
-                        //     }
-                        // }
-                        break;
-                }
-            }
-            unset(self::$_expired_transactions[ $TXN_ID ]);
-        }
-    }
-
-
-
-    /*************  END OF EXPIRED TRANSACTION CHECK  *************/
-
-
-    /************* START CLEAN UP BOT TRANSACTIONS **********************/
-
-
-    /**
-     * callback for 'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'
-     * which is setup during activation to run on an hourly cron
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws DomainException
-     */
-    public static function clean_out_junk_transactions()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            EED_Ticket_Sales_Monitor::reset_reservation_counts();
-            EEM_Transaction::instance('')->delete_junk_transactions();
-            EEM_Registration::instance('')->delete_registrations_with_no_transaction();
-            EEM_Line_Item::instance('')->delete_line_items_with_no_transaction();
-        }
-    }
-
-
-    /**
-     * Deletes old gateway logs. After about a week we usually don't need them for debugging. But folks can filter that.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function clean_out_old_gateway_logs()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
-            $time_diff_for_comparison = apply_filters(
-                'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
-                '-' . $reg_config->gateway_log_lifespan
-            );
-            EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
-        }
-    }
-
-
-    /*****************  FINALIZE ABANDONED TRANSACTIONS *****************/
-
-
-    /**
-     * @var array
-     */
-    protected static $_abandoned_transactions = array();
-
-
-    /**
-     * @deprecated
-     * @param int $timestamp
-     * @param int $TXN_ID
-     */
-    public static function schedule_finalize_abandoned_transactions_check($timestamp, $TXN_ID)
-    {
-        EE_Cron_Tasks::schedule_expired_transaction_check($timestamp, $TXN_ID);
-    }
-
-
-    /**
-     * @deprecated
-     * @param int $TXN_ID
-     */
-    public static function check_for_abandoned_transactions($TXN_ID = 0)
-    {
-        EE_Cron_Tasks::expired_transaction_check($TXN_ID);
-    }
-
-
-    /**
-     * @deprecated
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public static function finalize_abandoned_transactions()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        if (// are there any TXNs that need cleaning up ?
-            empty(self::$_abandoned_transactions)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_expired_transaction_check',
-                self::$_abandoned_transactions
-            )
-        ) {
-            return;
-        }
-        // combine our arrays of transaction IDs
-        self::$_expired_transactions = self::$_abandoned_transactions + self::$_expired_transactions;
-        // and deal with abandoned transactions here now...
-        EE_Cron_Tasks::process_expired_transactions();
-    }
-
-
-    /*************  END OF FINALIZE ABANDONED TRANSACTIONS  *************/
+	/**
+	 * WordPress doesn't allow duplicate crons within 10 minutes of the original,
+	 * so we'll set our retry time for just over 10 minutes to avoid that
+	 */
+	const reschedule_timeout = 605;
+
+
+	/**
+	 * @var EE_Cron_Tasks
+	 */
+	private static $_instance;
+
+
+	/**
+	 * @return EE_Cron_Tasks
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function instance()
+	{
+		if (! self::$_instance instanceof EE_Cron_Tasks) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @access private
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function __construct()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		// verify that WP Cron is enabled
+		if (defined('DISABLE_WP_CRON')
+			&& DISABLE_WP_CRON
+			&& is_admin()
+			&& ! get_option('ee_disabled_wp_cron_check')
+		) {
+			/**
+			 * This needs to be delayed until after the config is loaded because EE_Cron_Tasks is constructed before
+			 * config is loaded.
+			 * This is intentionally using a anonymous function so that its not easily de-registered.  Client code
+			 * wanting to not have this functionality can just register its own action at a priority after this one to
+			 * reverse any changes.
+			 */
+			add_action(
+				'AHEE__EE_System__load_core_configuration__complete',
+				function () {
+					EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
+					EE_Registry::instance()->NET_CFG->update_config(true, false);
+					add_option('ee_disabled_wp_cron_check', 1, '', false);
+				}
+			);
+		}
+		// UPDATE TRANSACTION WITH PAYMENT
+		add_action(
+			'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
+			array('EE_Cron_Tasks', 'setup_update_for_transaction_with_payment'),
+			10,
+			2
+		);
+		// ABANDONED / EXPIRED TRANSACTION CHECK
+		add_action(
+			'AHEE__EE_Cron_Tasks__expired_transaction_check',
+			array('EE_Cron_Tasks', 'expired_transaction_check'),
+			10,
+			1
+		);
+		// CLEAN OUT JUNK TRANSACTIONS AND RELATED DATA
+		add_action(
+			'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
+			array('EE_Cron_Tasks', 'clean_out_junk_transactions')
+		);
+		// logging
+		add_action(
+			'AHEE__EE_System__load_core_configuration__complete',
+			array('EE_Cron_Tasks', 'log_scheduled_ee_crons')
+		);
+		EE_Registry::instance()->load_lib('Messages_Scheduler');
+		// clean out old gateway logs
+		add_action(
+			'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs',
+			array('EE_Cron_Tasks', 'clean_out_old_gateway_logs')
+		);
+	}
+
+
+	/**
+	 * @access protected
+	 * @return void
+	 */
+	public static function log_scheduled_ee_crons()
+	{
+		$ee_crons = array(
+			'AHEE__EE_Cron_Tasks__update_transaction_with_payment',
+			'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
+			'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
+		);
+		$crons = (array) get_option('cron');
+		if (! is_array($crons)) {
+			return;
+		}
+		foreach ($crons as $timestamp => $cron) {
+			/** @var array[] $cron */
+			foreach ($ee_crons as $ee_cron) {
+				if (isset($cron[ $ee_cron ]) && is_array($cron[ $ee_cron ])) {
+					do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
+					foreach ($cron[ $ee_cron ] as $ee_cron_details) {
+						if (! empty($ee_cron_details['args'])) {
+							do_action(
+								'AHEE_log',
+								__CLASS__,
+								__FUNCTION__,
+								print_r($ee_cron_details['args'], true),
+								"{$ee_cron} args"
+							);
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * reschedule_cron_for_transactions_if_maintenance_mode
+	 * if Maintenance Mode is active, this will reschedule a cron to run again in 10 minutes
+	 *
+	 * @param string $cron_task
+	 * @param array  $TXN_IDs
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public static function reschedule_cron_for_transactions_if_maintenance_mode($cron_task, array $TXN_IDs)
+	{
+		if (! method_exists('EE_Cron_Tasks', $cron_task)) {
+			throw new DomainException(
+				sprintf(
+					__('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
+					$cron_task
+				)
+			);
+		}
+		// reschedule the cron if we can't hit the db right now
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+			foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
+				// ensure $additional_vars is an array
+				$additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
+				// reset cron job for the TXN
+				call_user_func_array(
+					array('EE_Cron_Tasks', $cron_task),
+					array_merge(
+						array(
+							time() + (10 * MINUTE_IN_SECONDS),
+							$TXN_ID,
+						),
+						$additional_vars
+					)
+				);
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+
+
+	/****************  UPDATE TRANSACTION WITH PAYMENT ****************/
+
+
+	/**
+	 * array of TXN IDs and the payment
+	 *
+	 * @var array
+	 */
+	protected static $_update_transactions_with_payment = array();
+
+
+	/**
+	 * schedule_update_transaction_with_payment
+	 * sets a wp_schedule_single_event() for updating any TXNs that may
+	 * require updating due to recently received payments
+	 *
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 * @param int $PAY_ID
+	 */
+	public static function schedule_update_transaction_with_payment(
+		$timestamp,
+		$TXN_ID,
+		$PAY_ID
+	) {
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		// validate $TXN_ID and $timestamp
+		$TXN_ID = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		if ($TXN_ID && $timestamp) {
+			wp_schedule_single_event(
+				$timestamp,
+				'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
+				array($TXN_ID, $PAY_ID)
+			);
+		}
+	}
+
+
+	/**
+	 * setup_update_for_transaction_with_payment
+	 * this is the callback for the action hook:
+	 * 'AHEE__EE_Cron_Tasks__update_transaction_with_payment'
+	 * which is setup by EE_Cron_Tasks::schedule_update_transaction_with_payment().
+	 * The passed TXN_ID and associated payment gets added to an array, and then
+	 * the EE_Cron_Tasks::update_transaction_with_payment() function is hooked into
+	 * 'shutdown' which will actually handle the processing of any
+	 * transactions requiring updating, because doing so now would be too early
+	 * and the required resources may not be available
+	 *
+	 * @param int $TXN_ID
+	 * @param int $PAY_ID
+	 */
+	public static function setup_update_for_transaction_with_payment($TXN_ID = 0, $PAY_ID = 0)
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
+		if (absint($TXN_ID)) {
+			self::$_update_transactions_with_payment[ $TXN_ID ] = $PAY_ID;
+			add_action(
+				'shutdown',
+				array('EE_Cron_Tasks', 'update_transaction_with_payment'),
+				5
+			);
+		}
+	}
+
+
+	/**
+	 * update_transaction_with_payment
+	 * loops through the self::$_abandoned_transactions array
+	 * and attempts to finalize any TXNs that have not been completed
+	 * but have had their sessions expired, most likely due to a user not
+	 * returning from an off-site payment gateway
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public static function update_transaction_with_payment()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		if (// are there any TXNs that need cleaning up ?
+			empty(self::$_update_transactions_with_payment)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_update_transaction_with_payment',
+				self::$_update_transactions_with_payment
+			)
+		) {
+			return;
+		}
+		/** @type EE_Payment_Processor $payment_processor */
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+		// set revisit flag for payment processor
+		$payment_processor->set_revisit();
+		// load EEM_Transaction
+		EE_Registry::instance()->load_model('Transaction');
+		foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
+			// reschedule the cron if we can't hit the db right now
+			if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+				// reset cron job for updating the TXN
+				EE_Cron_Tasks::schedule_update_transaction_with_payment(
+					time() + EE_Cron_Tasks::reschedule_timeout,
+					$TXN_ID,
+					$PAY_ID
+				);
+				continue;
+			}
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			$payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
+			// verify transaction
+			if ($transaction instanceof EE_Transaction && $payment instanceof EE_Payment) {
+				// now try to update the TXN with any payments
+				$payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
+			}
+			unset(self::$_update_transactions_with_payment[ $TXN_ID ]);
+		}
+	}
+
+
+
+	/************  END OF UPDATE TRANSACTION WITH PAYMENT  ************/
+
+
+	/*****************  EXPIRED TRANSACTION CHECK *****************/
+
+
+	/**
+	 * array of TXN IDs
+	 *
+	 * @var array
+	 */
+	protected static $_expired_transactions = array();
+
+
+	/**
+	 * schedule_expired_transaction_check
+	 * sets a wp_schedule_single_event() for following up on TXNs after their session has expired
+	 *
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 */
+	public static function schedule_expired_transaction_check(
+		$timestamp,
+		$TXN_ID
+	) {
+		// validate $TXN_ID and $timestamp
+		$TXN_ID = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		if ($TXN_ID && $timestamp) {
+			wp_schedule_single_event(
+				$timestamp,
+				'AHEE__EE_Cron_Tasks__expired_transaction_check',
+				array($TXN_ID)
+			);
+		}
+	}
+
+
+	/**
+	 * expired_transaction_check
+	 * this is the callback for the action hook:
+	 * 'AHEE__EE_Cron_Tasks__transaction_session_expiration_check'
+	 * which is utilized by wp_schedule_single_event()
+	 * in \EED_Single_Page_Checkout::_initialize_transaction().
+	 * The passed TXN_ID gets added to an array, and then the
+	 * process_expired_transactions() function is hooked into
+	 * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
+	 * processing of any failed transactions, because doing so now would be
+	 * too early and the required resources may not be available
+	 *
+	 * @param int $TXN_ID
+	 */
+	public static function expired_transaction_check($TXN_ID = 0)
+	{
+		if (absint($TXN_ID)) {
+			self::$_expired_transactions[ $TXN_ID ] = $TXN_ID;
+			add_action(
+				'shutdown',
+				array('EE_Cron_Tasks', 'process_expired_transactions'),
+				5
+			);
+		}
+	}
+
+
+	/**
+	 * process_expired_transactions
+	 * loops through the self::$_expired_transactions array and processes any failed TXNs
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws DomainException
+	 * @throws RuntimeException
+	 */
+	public static function process_expired_transactions()
+	{
+		if (// are there any TXNs that need cleaning up ?
+			empty(self::$_expired_transactions)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_expired_transaction_check',
+				self::$_expired_transactions
+			)
+		) {
+			return;
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// set revisit flag for txn processor
+		$transaction_processor->set_revisit();
+		// load EEM_Transaction
+		EE_Registry::instance()->load_model('Transaction');
+		foreach (self::$_expired_transactions as $TXN_ID) {
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			// verify transaction and whether it is failed or not
+			if ($transaction instanceof EE_Transaction) {
+				switch ($transaction->status_ID()) {
+					// Completed TXNs
+					case EEM_Transaction::complete_status_code:
+						/** @type EE_Transaction_Processor $transaction_processor */
+						$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+						$transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+							$transaction,
+							$transaction->last_payment()
+						);
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction',
+							$transaction
+						);
+						break;
+					// Overpaid TXNs
+					case EEM_Transaction::overpaid_status_code:
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction',
+							$transaction
+						);
+						break;
+					// Incomplete TXNs
+					case EEM_Transaction::incomplete_status_code:
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
+							$transaction
+						);
+						// todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
+						break;
+					// Abandoned TXNs
+					case EEM_Transaction::abandoned_status_code:
+						// run hook before updating transaction, primarily so
+						// EED_Ticket_Sales_Monitor::process_abandoned_transactions() can release reserved tickets
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
+							$transaction
+						);
+						// don't finalize the TXN if it has already been completed
+						if ($transaction->all_reg_steps_completed() !== true) {
+							/** @type EE_Payment_Processor $payment_processor */
+							$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+							// let's simulate an IPN here which will trigger any notifications that need to go out
+							$payment_processor->update_txn_based_on_payment(
+								$transaction,
+								$transaction->last_payment(),
+								true,
+								true
+							);
+						}
+						break;
+					// Failed TXNs
+					case EEM_Transaction::failed_status_code:
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
+							$transaction
+						);
+						// todo :
+						// perform garbage collection here and remove clean_out_junk_transactions()
+						// $registrations = $transaction->registrations();
+						// if (! empty($registrations)) {
+						//     foreach ($registrations as $registration) {
+						//         if ($registration instanceof EE_Registration) {
+						//             $delete_registration = true;
+						//             if ($registration->attendee() instanceof EE_Attendee) {
+						//                 $delete_registration = false;
+						//             }
+						//             if ($delete_registration) {
+						//                 $registration->delete_permanently();
+						//                 $registration->delete_related_permanently();
+						//             }
+						//         }
+						//     }
+						// }
+						break;
+				}
+			}
+			unset(self::$_expired_transactions[ $TXN_ID ]);
+		}
+	}
+
+
+
+	/*************  END OF EXPIRED TRANSACTION CHECK  *************/
+
+
+	/************* START CLEAN UP BOT TRANSACTIONS **********************/
+
+
+	/**
+	 * callback for 'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'
+	 * which is setup during activation to run on an hourly cron
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws DomainException
+	 */
+	public static function clean_out_junk_transactions()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			EED_Ticket_Sales_Monitor::reset_reservation_counts();
+			EEM_Transaction::instance('')->delete_junk_transactions();
+			EEM_Registration::instance('')->delete_registrations_with_no_transaction();
+			EEM_Line_Item::instance('')->delete_line_items_with_no_transaction();
+		}
+	}
+
+
+	/**
+	 * Deletes old gateway logs. After about a week we usually don't need them for debugging. But folks can filter that.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function clean_out_old_gateway_logs()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
+			$time_diff_for_comparison = apply_filters(
+				'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
+				'-' . $reg_config->gateway_log_lifespan
+			);
+			EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
+		}
+	}
+
+
+	/*****************  FINALIZE ABANDONED TRANSACTIONS *****************/
+
+
+	/**
+	 * @var array
+	 */
+	protected static $_abandoned_transactions = array();
+
+
+	/**
+	 * @deprecated
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 */
+	public static function schedule_finalize_abandoned_transactions_check($timestamp, $TXN_ID)
+	{
+		EE_Cron_Tasks::schedule_expired_transaction_check($timestamp, $TXN_ID);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @param int $TXN_ID
+	 */
+	public static function check_for_abandoned_transactions($TXN_ID = 0)
+	{
+		EE_Cron_Tasks::expired_transaction_check($TXN_ID);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public static function finalize_abandoned_transactions()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		if (// are there any TXNs that need cleaning up ?
+			empty(self::$_abandoned_transactions)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_expired_transaction_check',
+				self::$_abandoned_transactions
+			)
+		) {
+			return;
+		}
+		// combine our arrays of transaction IDs
+		self::$_expired_transactions = self::$_abandoned_transactions + self::$_expired_transactions;
+		// and deal with abandoned transactions here now...
+		EE_Cron_Tasks::process_expired_transactions();
+	}
+
+
+	/*************  END OF FINALIZE ABANDONED TRANSACTIONS  *************/
 }

core/domain/services/admin/ajax/ThankYouPageIpnMonitor.php

Indentation +219 added lines, -219 removed lines

@@ -22,239 +22,239 @@
 class ThankYouPageIpnMonitor
 {
 
-    /**
-     * @var string $heartbeat
-     */
-    private $heartbeat;
+	/**
+	 * @var string $heartbeat
+	 */
+	private $heartbeat;
 
-    /**
-     * @var EED_Thank_You_Page $thank_you_page
-     */
-    private $thank_you_page;
+	/**
+	 * @var EED_Thank_You_Page $thank_you_page
+	 */
+	private $thank_you_page;
 
-    /**
-     * @var EE_Transaction $transaction
-     */
-    private $transaction;
+	/**
+	 * @var EE_Transaction $transaction
+	 */
+	private $transaction;
 
 
-    /**
-     * EventEditorHeartbeat constructor.
-     */
-    public function __construct()
-    {
-        $this->heartbeat = WordpressHeartbeat::RESPONSE_KEY_THANK_YOU_PAGE;
-        add_filter('heartbeat_received', array($this, 'heartbeatResponse'), 10, 3);
-        add_filter('heartbeat_nopriv_received', array($this, 'heartbeatResponse'), 10, 3);
-    }
+	/**
+	 * EventEditorHeartbeat constructor.
+	 */
+	public function __construct()
+	{
+		$this->heartbeat = WordpressHeartbeat::RESPONSE_KEY_THANK_YOU_PAGE;
+		add_filter('heartbeat_received', array($this, 'heartbeatResponse'), 10, 3);
+		add_filter('heartbeat_nopriv_received', array($this, 'heartbeatResponse'), 10, 3);
+	}
 
 
-    /**
-     * thank_you_page_IPN_monitor
-     * this basically just pulls the TXN based on the reg_url_link sent from the server,
-     * then checks that the TXN status is not failed, and that no other errors have been generated.
-     * it also calculates the IPN wait time since the Thank You page was first loaded
-     *
-     * @param array $response
-     * @param array $data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function heartbeatResponse($response = array(), $data = array())
-    {
-        // does this heartbeat contain our data ?
-        if (! isset($data[ $this->heartbeat ])) {
-            return $response;
-        }
-        // check for reg_url_link in the incoming heartbeat data
-        if (! isset($data[ $this->heartbeat ]['e_reg_url_link'])) {
-            $response[ $this->heartbeat ] = array(
-                'errors' => ! empty($notices['errors'])
-                    ? $notices['errors']
-                    : __(
-                        'No transaction information could be retrieved because the registration URL link is missing or invalid.',
-                        'event_espresso'
-                    ),
-            );
-            return $response;
-        }
-        // kk heartbeat has our data
-        $response = $this->initializeThankYouPageAndTransaction($response, $data);
-        // if something went wrong...
-        if (isset($response[ $this->heartbeat ]['errors'])) {
-            return $response;
-        }
-        // grab transient of Transaction's status
-        $txn_status = isset($data[ $this->heartbeat ]['txn_status'])
-            ? $data[ $this->heartbeat ]['txn_status']
-            : null;
-        $response = $this->getTransactionDetails($txn_status, $response, $data);
-        // no payment data yet?
-        if (isset($response[ $this->heartbeat ]['still_waiting'])) {
-            return $response;
-        }
-        // TXN is happening so let's get the payments now
-        // if we've already gotten payments then the heartbeat data will contain the timestamp of the last time we checked
-        $since = isset($data[ $this->heartbeat ]['get_payments_since'])
-            ? $data[ $this->heartbeat ]['get_payments_since']
-            : 0;
-        return $this->paymentDetails($response, $since);
-    }
+	/**
+	 * thank_you_page_IPN_monitor
+	 * this basically just pulls the TXN based on the reg_url_link sent from the server,
+	 * then checks that the TXN status is not failed, and that no other errors have been generated.
+	 * it also calculates the IPN wait time since the Thank You page was first loaded
+	 *
+	 * @param array $response
+	 * @param array $data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function heartbeatResponse($response = array(), $data = array())
+	{
+		// does this heartbeat contain our data ?
+		if (! isset($data[ $this->heartbeat ])) {
+			return $response;
+		}
+		// check for reg_url_link in the incoming heartbeat data
+		if (! isset($data[ $this->heartbeat ]['e_reg_url_link'])) {
+			$response[ $this->heartbeat ] = array(
+				'errors' => ! empty($notices['errors'])
+					? $notices['errors']
+					: __(
+						'No transaction information could be retrieved because the registration URL link is missing or invalid.',
+						'event_espresso'
+					),
+			);
+			return $response;
+		}
+		// kk heartbeat has our data
+		$response = $this->initializeThankYouPageAndTransaction($response, $data);
+		// if something went wrong...
+		if (isset($response[ $this->heartbeat ]['errors'])) {
+			return $response;
+		}
+		// grab transient of Transaction's status
+		$txn_status = isset($data[ $this->heartbeat ]['txn_status'])
+			? $data[ $this->heartbeat ]['txn_status']
+			: null;
+		$response = $this->getTransactionDetails($txn_status, $response, $data);
+		// no payment data yet?
+		if (isset($response[ $this->heartbeat ]['still_waiting'])) {
+			return $response;
+		}
+		// TXN is happening so let's get the payments now
+		// if we've already gotten payments then the heartbeat data will contain the timestamp of the last time we checked
+		$since = isset($data[ $this->heartbeat ]['get_payments_since'])
+			? $data[ $this->heartbeat ]['get_payments_since']
+			: 0;
+		return $this->paymentDetails($response, $since);
+	}
 
 
-    /**
-     * @param array $response
-     * @param array $data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function initializeThankYouPageAndTransaction($response, $data)
-    {
-        require_once EE_MODULES . 'thank_you_page/EED_Thank_You_Page.module.php';
-        // set_definitions, instantiate the thank you page class, and get the ball rolling
-        EED_Thank_You_Page::set_definitions();
-        $this->thank_you_page = EED_Thank_You_Page::instance();
-        $this->thank_you_page->set_reg_url_link($data[ $this->heartbeat ]['e_reg_url_link']);
-        $this->thank_you_page->init();
-        // get TXN
-        $transaction = $this->thank_you_page->get_txn();
-        // no TXN? then get out
-        if (! $transaction instanceof EE_Transaction) {
-            $notices = EE_Error::get_notices();
-            $response[ $this->heartbeat ] = array(
-                'errors' => ! empty($notices['errors'])
-                    ? $notices['errors']
-                    : sprintf(
-                        __(
-                            'The information for your transaction could not be retrieved from the server or the transaction data received was invalid because of a technical reason. (%s)',
-                            'event_espresso'
-                        ),
-                        __LINE__
-                    ),
-            );
-            return $response;
-        }
-        $this->transaction = $transaction;
-        return $response;
-    }
+	/**
+	 * @param array $response
+	 * @param array $data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function initializeThankYouPageAndTransaction($response, $data)
+	{
+		require_once EE_MODULES . 'thank_you_page/EED_Thank_You_Page.module.php';
+		// set_definitions, instantiate the thank you page class, and get the ball rolling
+		EED_Thank_You_Page::set_definitions();
+		$this->thank_you_page = EED_Thank_You_Page::instance();
+		$this->thank_you_page->set_reg_url_link($data[ $this->heartbeat ]['e_reg_url_link']);
+		$this->thank_you_page->init();
+		// get TXN
+		$transaction = $this->thank_you_page->get_txn();
+		// no TXN? then get out
+		if (! $transaction instanceof EE_Transaction) {
+			$notices = EE_Error::get_notices();
+			$response[ $this->heartbeat ] = array(
+				'errors' => ! empty($notices['errors'])
+					? $notices['errors']
+					: sprintf(
+						__(
+							'The information for your transaction could not be retrieved from the server or the transaction data received was invalid because of a technical reason. (%s)',
+							'event_espresso'
+						),
+						__LINE__
+					),
+			);
+			return $response;
+		}
+		$this->transaction = $transaction;
+		return $response;
+	}
 
 
-    /**
-     * @param string $txn_status
-     * @param array  $response
-     * @param array  $data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function getTransactionDetails($txn_status, $response, $data)
-    {
-        // has the TXN status changed since we last checked (or empty because this is the first time running through this code)?
-        if ($txn_status !== $this->transaction->status_ID()) {
-            // switch between two possible basic outcomes
-            switch ($this->transaction->status_ID()) {
-                // TXN has been updated in some way
-                case EEM_Transaction::overpaid_status_code:
-                case EEM_Transaction::complete_status_code:
-                case EEM_Transaction::incomplete_status_code:
-                    // send updated TXN results back to client,
-                    return $this->setTransactionDetails($response);
-                // or we have a bad TXN, or really slow IPN, so calculate the wait time and send that back...
-                case EEM_Transaction::failed_status_code:
-                default:
-                    // keep on waiting...
-                    return $this->updateServerWaitTime($data[ $this->heartbeat ]);
-            }
-            // or is the TXN still failed (never been updated) ???
-        } elseif ($this->transaction->failed()) {
-            // keep on waiting...
-            return $this->updateServerWaitTime($data[ $this->heartbeat ]);
-        }
-        return $response;
-    }
+	/**
+	 * @param string $txn_status
+	 * @param array  $response
+	 * @param array  $data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function getTransactionDetails($txn_status, $response, $data)
+	{
+		// has the TXN status changed since we last checked (or empty because this is the first time running through this code)?
+		if ($txn_status !== $this->transaction->status_ID()) {
+			// switch between two possible basic outcomes
+			switch ($this->transaction->status_ID()) {
+				// TXN has been updated in some way
+				case EEM_Transaction::overpaid_status_code:
+				case EEM_Transaction::complete_status_code:
+				case EEM_Transaction::incomplete_status_code:
+					// send updated TXN results back to client,
+					return $this->setTransactionDetails($response);
+				// or we have a bad TXN, or really slow IPN, so calculate the wait time and send that back...
+				case EEM_Transaction::failed_status_code:
+				default:
+					// keep on waiting...
+					return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+			}
+			// or is the TXN still failed (never been updated) ???
+		} elseif ($this->transaction->failed()) {
+			// keep on waiting...
+			return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+		}
+		return $response;
+	}
 
 
-    /**
-     * @param array $response
-     * @param boolean $status_only
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function setTransactionDetails($response, $status_only = false)
-    {
-        if (! $status_only && ! isset($response[ $this->heartbeat ]['transaction_details'])) {
-            $response[ $this->heartbeat ]['transaction_details'] = $this->thank_you_page->get_transaction_details();
-        }
-        if (! isset($response[ $this->heartbeat ]['txn_status'])) {
-            $response[ $this->heartbeat ]['txn_status'] = $this->transaction->status_ID();
-        }
-        return $response;
-    }
+	/**
+	 * @param array $response
+	 * @param boolean $status_only
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function setTransactionDetails($response, $status_only = false)
+	{
+		if (! $status_only && ! isset($response[ $this->heartbeat ]['transaction_details'])) {
+			$response[ $this->heartbeat ]['transaction_details'] = $this->thank_you_page->get_transaction_details();
+		}
+		if (! isset($response[ $this->heartbeat ]['txn_status'])) {
+			$response[ $this->heartbeat ]['txn_status'] = $this->transaction->status_ID();
+		}
+		return $response;
+	}
 
 
-    /**
-     * @param array $response
-     * @param int $since
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function paymentDetails($response, $since)
-    {
-        // then check for payments
-        $payments = $this->thank_you_page->get_txn_payments($since);
-        // has a payment been processed ?
-        if (! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
-            if ($since) {
-                $response[ $this->heartbeat ]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
-                $response = $this->setTransactionDetails($response);
-            } else {
-                $response[ $this->heartbeat ]['payment_details'] = $this->thank_you_page->get_payment_details(
-                    $payments
-                );
-            }
-            // reset time to check for payments
-            $response[ $this->heartbeat ]['get_payments_since'] = time();
-        } else {
-            $response[ $this->heartbeat ]['get_payments_since'] = $since;
-        }
-        return $response;
-    }
+	/**
+	 * @param array $response
+	 * @param int $since
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function paymentDetails($response, $since)
+	{
+		// then check for payments
+		$payments = $this->thank_you_page->get_txn_payments($since);
+		// has a payment been processed ?
+		if (! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
+			if ($since) {
+				$response[ $this->heartbeat ]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
+				$response = $this->setTransactionDetails($response);
+			} else {
+				$response[ $this->heartbeat ]['payment_details'] = $this->thank_you_page->get_payment_details(
+					$payments
+				);
+			}
+			// reset time to check for payments
+			$response[ $this->heartbeat ]['get_payments_since'] = time();
+		} else {
+			$response[ $this->heartbeat ]['get_payments_since'] = $since;
+		}
+		return $response;
+	}
 
 
-    /**
-     * @param array $thank_you_page_data    thank you page portion of the incoming JSON array
-     *                                      from the WP heartbeat data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function updateServerWaitTime($thank_you_page_data)
-    {
-        $response[ $this->heartbeat ]['still_waiting'] = isset($thank_you_page_data['initial_access'])
-            ? time() - $thank_you_page_data['initial_access']
-            : 0;
-        $response = $this->setTransactionDetails($response, true);
-        return $response;
-    }
+	/**
+	 * @param array $thank_you_page_data    thank you page portion of the incoming JSON array
+	 *                                      from the WP heartbeat data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function updateServerWaitTime($thank_you_page_data)
+	{
+		$response[ $this->heartbeat ]['still_waiting'] = isset($thank_you_page_data['initial_access'])
+			? time() - $thank_you_page_data['initial_access']
+			: 0;
+		$response = $this->setTransactionDetails($response, true);
+		return $response;
+	}
 }

Spacing +25 added lines, -25 removed lines

@@ -67,12 +67,12 @@ 
     public function heartbeatResponse($response = array(), $data = array())
     {
         // does this heartbeat contain our data ?
-        if (! isset($data[ $this->heartbeat ])) {
+        if ( ! isset($data[$this->heartbeat])) {
             return $response;
         }
         // check for reg_url_link in the incoming heartbeat data
-        if (! isset($data[ $this->heartbeat ]['e_reg_url_link'])) {
-            $response[ $this->heartbeat ] = array(
+        if ( ! isset($data[$this->heartbeat]['e_reg_url_link'])) {
+            $response[$this->heartbeat] = array(
                 'errors' => ! empty($notices['errors'])
                     ? $notices['errors']
                     : __(
@@ -85,22 +85,22 @@ 
         // kk heartbeat has our data
         $response = $this->initializeThankYouPageAndTransaction($response, $data);
         // if something went wrong...
-        if (isset($response[ $this->heartbeat ]['errors'])) {
+        if (isset($response[$this->heartbeat]['errors'])) {
             return $response;
         }
         // grab transient of Transaction's status
-        $txn_status = isset($data[ $this->heartbeat ]['txn_status'])
-            ? $data[ $this->heartbeat ]['txn_status']
+        $txn_status = isset($data[$this->heartbeat]['txn_status'])
+            ? $data[$this->heartbeat]['txn_status']
             : null;
         $response = $this->getTransactionDetails($txn_status, $response, $data);
         // no payment data yet?
-        if (isset($response[ $this->heartbeat ]['still_waiting'])) {
+        if (isset($response[$this->heartbeat]['still_waiting'])) {
             return $response;
         }
         // TXN is happening so let's get the payments now
         // if we've already gotten payments then the heartbeat data will contain the timestamp of the last time we checked
-        $since = isset($data[ $this->heartbeat ]['get_payments_since'])
-            ? $data[ $this->heartbeat ]['get_payments_since']
+        $since = isset($data[$this->heartbeat]['get_payments_since'])
+            ? $data[$this->heartbeat]['get_payments_since']
             : 0;
         return $this->paymentDetails($response, $since);
     }
@@ -117,18 +117,18 @@ 
      */
     private function initializeThankYouPageAndTransaction($response, $data)
     {
-        require_once EE_MODULES . 'thank_you_page/EED_Thank_You_Page.module.php';
+        require_once EE_MODULES.'thank_you_page/EED_Thank_You_Page.module.php';
         // set_definitions, instantiate the thank you page class, and get the ball rolling
         EED_Thank_You_Page::set_definitions();
         $this->thank_you_page = EED_Thank_You_Page::instance();
-        $this->thank_you_page->set_reg_url_link($data[ $this->heartbeat ]['e_reg_url_link']);
+        $this->thank_you_page->set_reg_url_link($data[$this->heartbeat]['e_reg_url_link']);
         $this->thank_you_page->init();
         // get TXN
         $transaction = $this->thank_you_page->get_txn();
         // no TXN? then get out
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             $notices = EE_Error::get_notices();
-            $response[ $this->heartbeat ] = array(
+            $response[$this->heartbeat] = array(
                 'errors' => ! empty($notices['errors'])
                     ? $notices['errors']
                     : sprintf(
@@ -173,12 +173,12 @@ 
                 case EEM_Transaction::failed_status_code:
                 default:
                     // keep on waiting...
-                    return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+                    return $this->updateServerWaitTime($data[$this->heartbeat]);
             }
             // or is the TXN still failed (never been updated) ???
         } elseif ($this->transaction->failed()) {
             // keep on waiting...
-            return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+            return $this->updateServerWaitTime($data[$this->heartbeat]);
         }
         return $response;
     }
@@ -196,11 +196,11 @@ 
      */
     private function setTransactionDetails($response, $status_only = false)
     {
-        if (! $status_only && ! isset($response[ $this->heartbeat ]['transaction_details'])) {
-            $response[ $this->heartbeat ]['transaction_details'] = $this->thank_you_page->get_transaction_details();
+        if ( ! $status_only && ! isset($response[$this->heartbeat]['transaction_details'])) {
+            $response[$this->heartbeat]['transaction_details'] = $this->thank_you_page->get_transaction_details();
         }
-        if (! isset($response[ $this->heartbeat ]['txn_status'])) {
-            $response[ $this->heartbeat ]['txn_status'] = $this->transaction->status_ID();
+        if ( ! isset($response[$this->heartbeat]['txn_status'])) {
+            $response[$this->heartbeat]['txn_status'] = $this->transaction->status_ID();
         }
         return $response;
     }
@@ -221,19 +221,19 @@ 
         // then check for payments
         $payments = $this->thank_you_page->get_txn_payments($since);
         // has a payment been processed ?
-        if (! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
+        if ( ! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
             if ($since) {
-                $response[ $this->heartbeat ]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
+                $response[$this->heartbeat]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
                 $response = $this->setTransactionDetails($response);
             } else {
-                $response[ $this->heartbeat ]['payment_details'] = $this->thank_you_page->get_payment_details(
+                $response[$this->heartbeat]['payment_details'] = $this->thank_you_page->get_payment_details(
                     $payments
                 );
             }
             // reset time to check for payments
-            $response[ $this->heartbeat ]['get_payments_since'] = time();
+            $response[$this->heartbeat]['get_payments_since'] = time();
         } else {
-            $response[ $this->heartbeat ]['get_payments_since'] = $since;
+            $response[$this->heartbeat]['get_payments_since'] = $since;
         }
         return $response;
     }
@@ -251,7 +251,7 @@ 
      */
     private function updateServerWaitTime($thank_you_page_data)
     {
-        $response[ $this->heartbeat ]['still_waiting'] = isset($thank_you_page_data['initial_access'])
+        $response[$this->heartbeat]['still_waiting'] = isset($thank_you_page_data['initial_access'])
             ? time() - $thank_you_page_data['initial_access']
             : 0;
         $response = $this->setTransactionDetails($response, true);

core/domain/services/admin/ajax/WordpressHeartbeat.php

Indentation +42 added lines, -42 removed lines

@@ -17,52 +17,52 @@
 class WordpressHeartbeat
 {
 
-    const RESPONSE_KEY_THANK_YOU_PAGE = 'espresso_thank_you_page';
+	const RESPONSE_KEY_THANK_YOU_PAGE = 'espresso_thank_you_page';
 
-    /**
-     * @var LoaderInterface $loader
-     */
-    protected $loader;
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	protected $loader;
 
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
 
 
-    /**
-     * WordpressHeartbeat constructor.
-     *
-     * @param LoaderInterface  $loader
-     * @param RequestInterface $request
-     */
-    public function __construct(
-        LoaderInterface $loader,
-        RequestInterface $request
-    ) {
-        $this->loader = $loader;
-        $this->request = $request;
-        do_action('AHEE__EventEspresso_core_domain_services_admin_ajax_WordpressHeartbeat__constructor', $this);
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'resolveRoutes'));
-    }
+	/**
+	 * WordpressHeartbeat constructor.
+	 *
+	 * @param LoaderInterface  $loader
+	 * @param RequestInterface $request
+	 */
+	public function __construct(
+		LoaderInterface $loader,
+		RequestInterface $request
+	) {
+		$this->loader = $loader;
+		$this->request = $request;
+		do_action('AHEE__EventEspresso_core_domain_services_admin_ajax_WordpressHeartbeat__constructor', $this);
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'resolveRoutes'));
+	}
 
 
-    /**
-     * @since 4.9.76.p
-     * @throws InvalidClassException
-     */
-    public function resolveRoutes()
-    {
-        $screenID = $this->request->getRequestParam('screen_id');
-        $heartbeat_data = $this->request->getRequestParam('data', []);
-        if ($screenID === 'espresso_events') {
-            $this->loader->getShared(
-                'EventEspresso\core\domain\services\admin\ajax\EventEditorHeartbeat'
-            );
-        } elseif ($screenID === 'front' && ! empty($heartbeat_data[ self::RESPONSE_KEY_THANK_YOU_PAGE ])) {
-            $this->loader->getShared(
-                'EventEspresso\core\domain\services\admin\ajax\ThankYouPageIpnMonitor'
-            );
-        }
-    }
+	/**
+	 * @since 4.9.76.p
+	 * @throws InvalidClassException
+	 */
+	public function resolveRoutes()
+	{
+		$screenID = $this->request->getRequestParam('screen_id');
+		$heartbeat_data = $this->request->getRequestParam('data', []);
+		if ($screenID === 'espresso_events') {
+			$this->loader->getShared(
+				'EventEspresso\core\domain\services\admin\ajax\EventEditorHeartbeat'
+			);
+		} elseif ($screenID === 'front' && ! empty($heartbeat_data[ self::RESPONSE_KEY_THANK_YOU_PAGE ])) {
+			$this->loader->getShared(
+				'EventEspresso\core\domain\services\admin\ajax\ThankYouPageIpnMonitor'
+			);
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
             $this->loader->getShared(
                 'EventEspresso\core\domain\services\admin\ajax\EventEditorHeartbeat'
             );
-        } elseif ($screenID === 'front' && ! empty($heartbeat_data[ self::RESPONSE_KEY_THANK_YOU_PAGE ])) {
+        } elseif ($screenID === 'front' && ! empty($heartbeat_data[self::RESPONSE_KEY_THANK_YOU_PAGE])) {
             $this->loader->getShared(
                 'EventEspresso\core\domain\services\admin\ajax\ThankYouPageIpnMonitor'
             );