eventespresso / event-espresso-core

core/libraries/form_sections/form_handlers/SequentialStepFormManager.php

Doc Comments +2 added lines, -2 removed lines

@@ -203,7 +203,7 @@ 
 
 
     /**
-     * @param $default_form_step
+     * @param string $default_form_step
      * @throws InvalidDataTypeException
      */
     protected function setDefaultFormStep($default_form_step)
@@ -242,7 +242,7 @@ 
 
 
     /**
-     * @return object|SequentialStepFormInterface
+     * @return SequentialStepForm
      * @throws InvalidFormHandlerException
      */
     public function getCurrentStep()

Indentation +583 added lines, -583 removed lines

@@ -29,587 +29,587 @@
 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, so...
-            // if WP_DEBUG === true, display the Exception and stack trace right now
-            new ExceptionStackTraceDisplay($e);
-            // else 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, so...
+			// if WP_DEBUG === true, display the Exception and stack trace right now
+			new ExceptionStackTraceDisplay($e);
+			// else 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();
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -141,7 +141,7 @@ 
      */
     protected function setBaseUrl($base_url)
     {
-        if (! is_string($base_url)) {
+        if ( ! is_string($base_url)) {
             throw new InvalidDataTypeException('$base_url', $base_url, 'string');
         }
         if (empty($base_url)) {
@@ -172,7 +172,7 @@ 
      */
     public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
     {
-        if (! is_string($form_step_url_key)) {
+        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';
@@ -194,7 +194,7 @@ 
      */
     protected function setDefaultFormStep($default_form_step)
     {
-        if (! is_string($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;
@@ -209,7 +209,7 @@ 
     protected function setCurrentStepFromRequest()
     {
         $current_step_slug = $this->request()->get($this->formStepUrlKey(), $this->defaultFormStep());
-        if (! $this->form_steps->setCurrent($current_step_slug)) {
+        if ( ! $this->form_steps->setCurrent($current_step_slug)) {
             throw new InvalidIdentifierException(
                 $current_step_slug,
                 $this->defaultFormStep(),
@@ -231,7 +231,7 @@ 
      */
     public function getCurrentStep()
     {
-        if (! $this->form_steps->current() instanceof SequentialStepForm) {
+        if ( ! $this->form_steps->current() instanceof SequentialStepForm) {
             throw new InvalidFormHandlerException($this->form_steps->current());
         }
         return $this->form_steps->current();
@@ -244,7 +244,7 @@ 
      */
     public function formAction()
     {
-        if (! is_string($this->form_action) || empty($this->form_action)) {
+        if ( ! is_string($this->form_action) || empty($this->form_action)) {
             $this->form_action = $this->baseUrl();
         }
         return $this->form_action;
@@ -257,7 +257,7 @@ 
      */
     public function setFormAction($form_action)
     {
-        if (! is_string($form_action)) {
+        if ( ! is_string($form_action)) {
             throw new InvalidDataTypeException('$form_action', $form_action, 'string');
         }
         $this->form_action = $form_action;
@@ -271,7 +271,7 @@ 
      */
     public function addFormActionArgs($form_action_args = array())
     {
-        if (! is_array($form_action_args)) {
+        if ( ! is_array($form_action_args)) {
             throw new InvalidDataTypeException('$form_action_args', $form_action_args, 'array');
         }
         $form_action_args = ! empty($form_action_args)
@@ -336,7 +336,7 @@ 
     protected function getProgressStepsCollection()
     {
         static $collection = null;
-        if (! $collection instanceof ProgressStepCollection) {
+        if ( ! $collection instanceof ProgressStepCollection) {
             $collection = new ProgressStepCollection();
         }
         return $collection;
@@ -358,7 +358,7 @@ 
         /** @var SequentialStepForm $form_step */
         foreach ($this->form_steps as $form_step) {
             // is this step active ?
-            if (! $form_step->initialize()) {
+            if ( ! $form_step->initialize()) {
                 continue;
             }
             $progress_steps_collection->add(
@@ -427,7 +427,7 @@ 
     {
         $form_step = $this->buildCurrentStepForm();
         // no displayable content ? then skip straight to processing
-        if (! $form_step->displayable()) {
+        if ( ! $form_step->displayable()) {
             $this->addFormActionArgs();
             $form_step->setFormAction($this->formAction());
             wp_safe_redirect($form_step->formAction());
@@ -503,7 +503,7 @@ 
     public function displayProgressSteps($return_as_string = true)
     {
         $form_step = $this->getCurrentStep();
-        if (! $form_step->displayable()) {
+        if ( ! $form_step->displayable()) {
             return '';
         }
         $progress_steps = apply_filters(

acceptance_tests/Helpers/TicketSelector.php

Doc Comments +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
     /**
      * Use to select a quantity from the first ticket for the given event (so this can be used on a event archive page).
      * @param int|string $event_id
-     * @param int|string $quantity
+     * @param integer $quantity
      */
     public function selectQuantityOfFirstTicketForEventId($event_id, $quantity = 1)
     {

Indentation +17 added lines, -17 removed lines

@@ -12,23 +12,23 @@
 trait TicketSelector
 {
 
-    /**
-     * Use to select a quantity from the first ticket for the given event (so this can be used on a event archive page).
-     * @param int|string $event_id
-     * @param int|string $quantity
-     */
-    public function selectQuantityOfFirstTicketForEventId($event_id, $quantity = 1)
-    {
-        $this->actor()->selectOption(TicketSelectorElements::ticketOptionByEventIdSelector($event_id), $quantity);
-    }
+	/**
+	 * Use to select a quantity from the first ticket for the given event (so this can be used on a event archive page).
+	 * @param int|string $event_id
+	 * @param int|string $quantity
+	 */
+	public function selectQuantityOfFirstTicketForEventId($event_id, $quantity = 1)
+	{
+		$this->actor()->selectOption(TicketSelectorElements::ticketOptionByEventIdSelector($event_id), $quantity);
+	}
 
 
-    /**
-     * Used to submit the ticket selection for the given event id (so this can be used on an event archive page).
-     * @param int|string $event_id
-     */
-    public function submitTicketSelectionsForEventId($event_id)
-    {
-        $this->actor()->click(TicketSelectorElements::ticketSelectionSubmitSelectorByEventId($event_id));
-    }
+	/**
+	 * Used to submit the ticket selection for the given event id (so this can be used on an event archive page).
+	 * @param int|string $event_id
+	 */
+	public function submitTicketSelectionsForEventId($event_id)
+	{
+		$this->actor()->click(TicketSelectorElements::ticketSelectionSubmitSelectorByEventId($event_id));
+	}
 }
\ No newline at end of file

acceptance_tests/Page/MessagesAdmin.php

Spacing +2 added lines, -2 removed lines

@@ -103,8 +103,8 @@
     public static function editMessageTemplateClassByMessageType($message_type_slug, $context = '')
     {
         return $context
-            ? '.' . $message_type_slug . '-' . $context . '-edit-link'
-            : '.' . $message_type_slug . '-edit-link';
+            ? '.'.$message_type_slug.'-'.$context.'-edit-link'
+            : '.'.$message_type_slug.'-edit-link';
     }
 
 

Indentation +267 added lines, -267 removed lines

@@ -14,292 +14,292 @@
 class MessagesAdmin extends CoreAdmin
 {
 
-    /**
-     * Context slug for the admin messages context.
-     */
-    const ADMIN_CONTEXT_SLUG = 'admin';
+	/**
+	 * Context slug for the admin messages context.
+	 */
+	const ADMIN_CONTEXT_SLUG = 'admin';
 
-    /**
-     * Context slug for the primary attendee messages context
-     */
-    const PRIMARY_ATTENDEE_CONTEXT_SLUG = 'primary_attendee';
+	/**
+	 * Context slug for the primary attendee messages context
+	 */
+	const PRIMARY_ATTENDEE_CONTEXT_SLUG = 'primary_attendee';
 
 
-    /**
-     * Context slug for the attendee messages context
-     */
-    const ATTENDEE_CONTEXT_SLUG = 'attendee';
+	/**
+	 * Context slug for the attendee messages context
+	 */
+	const ATTENDEE_CONTEXT_SLUG = 'attendee';
 
 
-    /**
-     * Status reference for the EEM_Message::status_sent status.
-     */
-    const MESSAGE_STATUS_SENT = 'MSN';
+	/**
+	 * Status reference for the EEM_Message::status_sent status.
+	 */
+	const MESSAGE_STATUS_SENT = 'MSN';
 
 
-    /**
-     * Message type slug for the Payment Failed message type
-     */
-    const PAYMENT_FAILED_MESSAGE_TYPE_SLUG = 'payment_failed';
+	/**
+	 * Message type slug for the Payment Failed message type
+	 */
+	const PAYMENT_FAILED_MESSAGE_TYPE_SLUG = 'payment_failed';
 
 
-    /**
-     * Message type slug for the Registration Pending Payment message type
-     */
-    const MESSAGE_TYPE_PENDING_PAYMENT = 'pending_approval';
+	/**
+	 * Message type slug for the Registration Pending Payment message type
+	 */
+	const MESSAGE_TYPE_PENDING_PAYMENT = 'pending_approval';
 
 
-    /**
-     * Selector for the Global Messages "Send on same request" field in the Messages Settings tab.
-     */
-    const GLOBAL_MESSAGES_SETTINGS_ON_REQUEST_SELECTION_SELECTOR =
-        '#global_messages_settings-do-messages-on-same-request';
+	/**
+	 * Selector for the Global Messages "Send on same request" field in the Messages Settings tab.
+	 */
+	const GLOBAL_MESSAGES_SETTINGS_ON_REQUEST_SELECTION_SELECTOR =
+		'#global_messages_settings-do-messages-on-same-request';
 
 
-    /**
-     * Selector for the Global Messages Settings submit button in the Messages Settings tab.
-     */
-    const GLOBAL_MESSAGES_SETTINGS_SUBMIT_SELECTOR = '#global_messages_settings-update-settings-submit';
+	/**
+	 * Selector for the Global Messages Settings submit button in the Messages Settings tab.
+	 */
+	const GLOBAL_MESSAGES_SETTINGS_SUBMIT_SELECTOR = '#global_messages_settings-update-settings-submit';
 
 
-    /**
-     * This is the container where active message types for a messenger are found/dragged to.
-     */
-    const MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR = '#active-message-types';
+	/**
+	 * This is the container where active message types for a messenger are found/dragged to.
+	 */
+	const MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR = '#active-message-types';
 
 
-    /**
-     * Locator for the context switcher selector on the Message Template Editor page.
-     */
-    const MESSAGES_CONTEXT_SWITCHER_SELECTOR = "//form[@id='ee-msg-context-switcher-frm']/select";
+	/**
+	 * Locator for the context switcher selector on the Message Template Editor page.
+	 */
+	const MESSAGES_CONTEXT_SWITCHER_SELECTOR = "//form[@id='ee-msg-context-switcher-frm']/select";
 
 
-    /**
-     * Locator for the context switcher submit button in the Message Template Editor page.
-     */
-    const MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR = "#submit-msg-context-switcher-sbmt";
+	/**
+	 * Locator for the context switcher submit button in the Message Template Editor page.
+	 */
+	const MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR = "#submit-msg-context-switcher-sbmt";
 
 
-    /**
-     * Locator for the dialog container used for housing viewed messages in the message activity list table.
-     */
-    const MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR = '.ee-admin-dialog-container-inner-content';
-
-
-    /**
-     * Returns the selector for the on/off toggle for context on the message template editor.
-     */
-    const MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE =
-        "//div[@class='activate_context_on_off_toggle_container']/div[@class='switch']/label";
-
-
-    const SELECTOR_LINK_FINALIZE_PAYMENT_PENDING_PAYMENT_MESSAGE = "//td/p[@class='callout']/a";
-
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     * @return string
-     */
-    public static function messageActivityListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_messages', 'default', $additional_params);
-    }
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     * @return string
-     */
-    public static function defaultMessageTemplateListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_messages', 'global_mtps', $additional_params);
-    }
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     * @return string
-     */
-    public static function customMessageTemplateListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_messages', 'custom_mtps', $additional_params);
-    }
-
-
-    /**
-     * @return string
-     */
-    public static function messageSettingsUrl()
-    {
-        return self::adminUrl('espresso_messages', 'settings');
-    }
-
-
-
-    public static function draggableSettingsBoxSelectorForMessageTypeAndMessenger(
-        $message_type_slug,
-        $messenger_slug = 'email'
-    ) {
-        return "#$message_type_slug-messagetype-$messenger_slug";
-    }
-
-
-    /**
-     * @param string $message_type_slug
-     * @param string $context
-     * @return string
-     */
-    public static function editMessageTemplateClassByMessageType($message_type_slug, $context = '')
-    {
-        return $context
-            ? '.' . $message_type_slug . '-' . $context . '-edit-link'
-            : '.' . $message_type_slug . '-edit-link';
-    }
-
-
-    /**
-     * Selector for (a) specific table cell(s) in the Messages Activity list table for the given parameters.
-     *
-     * @param        $field
-     * @param        $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param string $table_cell_content_for_field
-     * @param int    $number_in_set   It's possible that the given parameters could match multiple items in the view.
-     *                                This allows you to indicate which item from the set to match.  If this is set to 0
-     *                                then all matches for the locator will be returned.
-     * @return string
-     * @throws \InvalidArgumentException
-     */
-    public static function messagesActivityListTableCellSelectorFor(
-        $field,
-        $message_type_label,
-        $message_status = self::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $table_cell_content_for_field = '',
-        $number_in_set = 1
-    ) {
-        $selector = "//tbody[@id='the-list']";
-        $selector .= "//tr[contains(@class, 'msg-status-$message_status')]"
-                     . "//td[contains(@class, 'message_type') and text()='$message_type_label']";
-        if ($messenger) {
-            $selector .= "/ancestor::tr/td[contains(@class, 'messenger') and text()='$messenger']";
-        }
-        $selector .= "/ancestor::tr/td[contains(@class, 'column-context') and text()='$context']";
-        $selector .= $table_cell_content_for_field
-            ? "/ancestor::tr/td[contains(@class, 'column-$field') and text()='$table_cell_content_for_field']"
-            : "/ancestor::tr/td[contains(@class, 'column-$field')]";
-        return $number_in_set > 0 ? Locator::elementAt($selector, $number_in_set) : $selector;
-    }
-
-
-    /**
-     * Selector for the Create Custom button found in the message template list table.
-     * @param string $message_type_label
-     * @param string $messenger_label
-     * @return string
-     */
-    public static function createCustomButtonForMessageTypeAndMessenger($message_type_label, $messenger_label)
-    {
-        $selector = "//tr/td[contains(@class, 'message_type') and text()='$message_type_label']"
-                    . "//ancestor::tr/td[contains(@class, 'messenger') and contains(., '$messenger_label')]"
-                    . "//ancestor::tr/td/a[@class='button button-small']";
-        return $selector;
-    }
-
-
-    /**
-     * Note, this could potentially match multiple buttons in the view so the selector is intentionally restricted to
-     * the FIRST match (which will be the latest message sent if the table is default sorted).
-     *
-     * @param string $message_type_label    The visible message type label for the row you want to match
-     * @param string $message_status        The status of the message for the row you want to match.
-     * @param string $messenger             The visible messenger label for the row you want to match.
-     * @param string $context               The visible context label for the row you want to match.
-     * @param int    $number_in_set         It's possible that the given parameters could match multiple items in the
-     *                                      view. This allows you to indicate which item from the set to match.
-     * @return string
-     * @throws \InvalidArgumentException
-     */
-    public static function messagesActivityListTableViewButtonSelectorFor(
-        $message_type_label,
-        $message_status = self::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $selector = self::messagesActivityListTableCellSelectorFor(
-            'action',
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            '',
-            $number_in_set
-        );
-        $selector .= "/a/span[contains(@class, 'ee-message-action-link-view')"
-                     . " and not(contains(@class, 'ee-message-action-link-view_transaction'))]";
-        return $selector;
-    }
-
-
-    /**
-     * Locator for the delete action link for a message item in the message activity list table.
-     * Note: The link is not visible by default, so the column would need hovered over for the link to appear.
-     *
-     * @param        $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     * @return string
-     * @throws \InvalidArgumentException
-     */
-    public static function messagesActivityListTableDeleteActionSelectorFor(
-        $message_type_label,
-        $message_status = self::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $selector = self::messagesActivityListTableCellSelectorFor(
-            'to',
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            '',
-            $number_in_set
-        );
-        $selector .= "/div/span[@class='delete']/a";
-        return $selector;
-    }
-
-
-
-    /**
-     * Returns the input selector for a given field in the message template editor.
-     * Assumes one is already viewing the Message Template Editor.
-     * @param string     $field
-     * @return string
-     */
-    public static function messageInputFieldSelectorFor($field)
-    {
-        return "//div[@id='post-body']//input[@id='$field-content']";
-    }
-
-
-    /**
-     * Wrapper for self::messageInputFieldSelectorFor('to') that takes care of getting the input for the To field.
-     */
-    public static function messageTemplateToFieldSelector()
-    {
-        return self::messageInputFieldSelectorFor('to');
-    }
+	/**
+	 * Locator for the dialog container used for housing viewed messages in the message activity list table.
+	 */
+	const MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR = '.ee-admin-dialog-container-inner-content';
+
+
+	/**
+	 * Returns the selector for the on/off toggle for context on the message template editor.
+	 */
+	const MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE =
+		"//div[@class='activate_context_on_off_toggle_container']/div[@class='switch']/label";
+
+
+	const SELECTOR_LINK_FINALIZE_PAYMENT_PENDING_PAYMENT_MESSAGE = "//td/p[@class='callout']/a";
+
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 * @return string
+	 */
+	public static function messageActivityListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_messages', 'default', $additional_params);
+	}
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 * @return string
+	 */
+	public static function defaultMessageTemplateListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_messages', 'global_mtps', $additional_params);
+	}
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 * @return string
+	 */
+	public static function customMessageTemplateListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_messages', 'custom_mtps', $additional_params);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function messageSettingsUrl()
+	{
+		return self::adminUrl('espresso_messages', 'settings');
+	}
+
+
+
+	public static function draggableSettingsBoxSelectorForMessageTypeAndMessenger(
+		$message_type_slug,
+		$messenger_slug = 'email'
+	) {
+		return "#$message_type_slug-messagetype-$messenger_slug";
+	}
+
+
+	/**
+	 * @param string $message_type_slug
+	 * @param string $context
+	 * @return string
+	 */
+	public static function editMessageTemplateClassByMessageType($message_type_slug, $context = '')
+	{
+		return $context
+			? '.' . $message_type_slug . '-' . $context . '-edit-link'
+			: '.' . $message_type_slug . '-edit-link';
+	}
+
+
+	/**
+	 * Selector for (a) specific table cell(s) in the Messages Activity list table for the given parameters.
+	 *
+	 * @param        $field
+	 * @param        $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param string $table_cell_content_for_field
+	 * @param int    $number_in_set   It's possible that the given parameters could match multiple items in the view.
+	 *                                This allows you to indicate which item from the set to match.  If this is set to 0
+	 *                                then all matches for the locator will be returned.
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 */
+	public static function messagesActivityListTableCellSelectorFor(
+		$field,
+		$message_type_label,
+		$message_status = self::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$table_cell_content_for_field = '',
+		$number_in_set = 1
+	) {
+		$selector = "//tbody[@id='the-list']";
+		$selector .= "//tr[contains(@class, 'msg-status-$message_status')]"
+					 . "//td[contains(@class, 'message_type') and text()='$message_type_label']";
+		if ($messenger) {
+			$selector .= "/ancestor::tr/td[contains(@class, 'messenger') and text()='$messenger']";
+		}
+		$selector .= "/ancestor::tr/td[contains(@class, 'column-context') and text()='$context']";
+		$selector .= $table_cell_content_for_field
+			? "/ancestor::tr/td[contains(@class, 'column-$field') and text()='$table_cell_content_for_field']"
+			: "/ancestor::tr/td[contains(@class, 'column-$field')]";
+		return $number_in_set > 0 ? Locator::elementAt($selector, $number_in_set) : $selector;
+	}
+
+
+	/**
+	 * Selector for the Create Custom button found in the message template list table.
+	 * @param string $message_type_label
+	 * @param string $messenger_label
+	 * @return string
+	 */
+	public static function createCustomButtonForMessageTypeAndMessenger($message_type_label, $messenger_label)
+	{
+		$selector = "//tr/td[contains(@class, 'message_type') and text()='$message_type_label']"
+					. "//ancestor::tr/td[contains(@class, 'messenger') and contains(., '$messenger_label')]"
+					. "//ancestor::tr/td/a[@class='button button-small']";
+		return $selector;
+	}
+
+
+	/**
+	 * Note, this could potentially match multiple buttons in the view so the selector is intentionally restricted to
+	 * the FIRST match (which will be the latest message sent if the table is default sorted).
+	 *
+	 * @param string $message_type_label    The visible message type label for the row you want to match
+	 * @param string $message_status        The status of the message for the row you want to match.
+	 * @param string $messenger             The visible messenger label for the row you want to match.
+	 * @param string $context               The visible context label for the row you want to match.
+	 * @param int    $number_in_set         It's possible that the given parameters could match multiple items in the
+	 *                                      view. This allows you to indicate which item from the set to match.
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 */
+	public static function messagesActivityListTableViewButtonSelectorFor(
+		$message_type_label,
+		$message_status = self::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$selector = self::messagesActivityListTableCellSelectorFor(
+			'action',
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			'',
+			$number_in_set
+		);
+		$selector .= "/a/span[contains(@class, 'ee-message-action-link-view')"
+					 . " and not(contains(@class, 'ee-message-action-link-view_transaction'))]";
+		return $selector;
+	}
+
+
+	/**
+	 * Locator for the delete action link for a message item in the message activity list table.
+	 * Note: The link is not visible by default, so the column would need hovered over for the link to appear.
+	 *
+	 * @param        $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 */
+	public static function messagesActivityListTableDeleteActionSelectorFor(
+		$message_type_label,
+		$message_status = self::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$selector = self::messagesActivityListTableCellSelectorFor(
+			'to',
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			'',
+			$number_in_set
+		);
+		$selector .= "/div/span[@class='delete']/a";
+		return $selector;
+	}
+
+
+
+	/**
+	 * Returns the input selector for a given field in the message template editor.
+	 * Assumes one is already viewing the Message Template Editor.
+	 * @param string     $field
+	 * @return string
+	 */
+	public static function messageInputFieldSelectorFor($field)
+	{
+		return "//div[@id='post-body']//input[@id='$field-content']";
+	}
+
+
+	/**
+	 * Wrapper for self::messageInputFieldSelectorFor('to') that takes care of getting the input for the To field.
+	 */
+	public static function messageTemplateToFieldSelector()
+	{
+		return self::messageInputFieldSelectorFor('to');
+	}
 }
\ No newline at end of file

core/db_models/EEM_Registration.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -467,7 +467,7 @@
      * @param    int $ATT_ID
      * @param    int $att_nmbr in case the ATT_ID is the same for multiple registrations (same details used) then the
      *                         attendee number is required
-     * @return        mixed        array on success, FALSE on fail
+     * @return        null|EE_Base_Class        array on success, FALSE on fail
      * @throws EE_Error
      */
     public function get_registration_for_transaction_attendee($TXN_ID = 0, $ATT_ID = 0, $att_nmbr = 0)

Unused Use Statements -1 removed lines

@@ -1,5 +1,4 @@
 <?php
-use EventEspresso\core\exceptions\InvalidIdentifierException;
 use EventEspresso\core\exceptions\InvalidStatusException;
 use EventEspresso\core\services\database\TableAnalysis;
 

Indentation +866 added lines, -866 removed lines

@@ -13,815 +13,815 @@ 
 class EEM_Registration extends EEM_Soft_Delete_Base
 {
 
-    /**
-     * @var EEM_Registration $_instance
-     */
-    protected static $_instance;
-
-    /**
-     * Keys are the status IDs for registrations (eg, RAP, RCN, etc), and the values
-     * are status codes (eg, approved, cancelled, etc)
-     *
-     * @var array
-     */
-    private static $_reg_status;
-
-    /**
-     * The value of REG_count for a primary registrant
-     */
-    const PRIMARY_REGISTRANT_COUNT = 1;
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate an INCOMPLETE registration.
-     * Initial status for registrations when they are first created
-     * Payments are NOT allowed.
-     * Automatically toggled to whatever the default Event registration status is upon completion of the attendee
-     * information reg step NO space reserved. Registration is NOT active
-     */
-    const status_id_incomplete = 'RIC';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate an UNAPPROVED registration.
-     * Payments are NOT allowed.
-     * Event Admin must manually toggle STS_ID for it to change
-     * No space reserved.
-     * Registration is active
-     */
-    const status_id_not_approved = 'RNA';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate registration is PENDING_PAYMENT .
-     * Payments are allowed.
-     * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
-     * No space reserved.
-     * Registration is active
-     */
-    const status_id_pending_payment = 'RPP';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate registration is on the WAIT_LIST .
-     * Payments are allowed.
-     * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
-     * No space reserved.
-     * Registration is active
-     */
-    const status_id_wait_list = 'RWL';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate an APPROVED registration.
-     * the TXN may or may not be completed ( paid in full )
-     * Payments are allowed.
-     * A space IS reserved.
-     * Registration is active
-     */
-    const status_id_approved = 'RAP';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate a registration was CANCELLED by the attendee.
-     * Payments are NOT allowed.
-     * NO space reserved.
-     * Registration is NOT active
-     */
-    const status_id_cancelled = 'RCN';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate a registration was DECLINED by the Event Admin
-     * Payments are NOT allowed.
-     * No space reserved.
-     * Registration is NOT active
-     */
-    const status_id_declined = 'RDC';
-
-    /**
-     * @var TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-
-    /**
-     *    private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access protected
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
-     *                         incoming timezone data that gets saved). Note this just sends the timezone info to the
-     *                         date time model field objects.  Default is NULL (and will be assumed using the set
-     *                         timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-        $this->singular_item = esc_html__('Registration', 'event_espresso');
-        $this->plural_item = esc_html__('Registrations', 'event_espresso');
-        $this->_tables = array(
-            'Registration' => new EE_Primary_Table('esp_registration', 'REG_ID'),
-        );
-        $this->_fields = array(
-            'Registration' => array(
-                'REG_ID' => new EE_Primary_Key_Int_Field(
-                    'REG_ID',
-                    esc_html__('Registration ID', 'event_espresso')
-                ),
-                'EVT_ID' => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Event ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'ATT_ID' => new EE_Foreign_Key_Int_Field(
-                    'ATT_ID',
-                    esc_html__('Attendee ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Attendee'
-                ),
-                'TXN_ID' => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__('Transaction ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Transaction'
-                ),
-                'TKT_ID' => new EE_Foreign_Key_Int_Field(
-                    'TKT_ID',
-                    esc_html__('Ticket ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Ticket'
-                ),
-                'STS_ID' => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    esc_html__('Status ID', 'event_espresso'),
-                    false,
-                    EEM_Registration::status_id_incomplete,
-                    'Status'
-                ),
-                'REG_date' => new EE_Datetime_Field(
-                    'REG_date',
-                    esc_html__('Time registration occurred', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'REG_final_price' => new EE_Money_Field(
-                    'REG_final_price',
-                    esc_html__('Registration\'s share of the transaction total', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'REG_paid' => new EE_Money_Field(
-                    'REG_paid',
-                    esc_html__('Amount paid to date towards registration', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'REG_session' => new EE_Plain_Text_Field(
-                    'REG_session',
-                    esc_html__('Session ID of registration', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'REG_code' => new EE_Plain_Text_Field(
-                    'REG_code',
-                    esc_html__('Unique Code for this registration', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'REG_url_link' => new EE_Plain_Text_Field(
-                    'REG_url_link',
-                    esc_html__('String to be used in URL for identifying registration', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'REG_count' => new EE_Integer_Field(
-                    'REG_count',
-                    esc_html__('Count of this registration in the group registration ', 'event_espresso'),
-                    true,
-                    1
-                ),
-                'REG_group_size' => new EE_Integer_Field(
-                    'REG_group_size',
-                    esc_html__('Number of registrations on this group', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'REG_att_is_going' => new EE_Boolean_Field(
-                    'REG_att_is_going',
-                    esc_html__('Flag indicating the registrant plans on attending', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'REG_deleted' => new EE_Trashed_Flag_Field(
-                    'REG_deleted',
-                    esc_html__('Flag indicating if registration has been archived or not.', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Event' => new EE_Belongs_To_Relation(),
-            'Attendee' => new EE_Belongs_To_Relation(),
-            'Transaction' => new EE_Belongs_To_Relation(),
-            'Ticket' => new EE_Belongs_To_Relation(),
-            'Status' => new EE_Belongs_To_Relation(),
-            'Answer' => new EE_Has_Many_Relation(),
-            'Checkin' => new EE_Has_Many_Relation(),
-            'Registration_Payment' => new EE_Has_Many_Relation(),
-            'Payment' => new EE_HABTM_Relation('Registration_Payment'),
-            'Message' => new EE_Has_Many_Any_Relation(false)
-            // allow deletes even if there are messages in the queue related
-        );
-        $this->_model_chain_to_wp_user = 'Event';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * a list of ALL valid registration statuses currently in use within the system
-     * generated by combining the filterable active and inactive reg status arrays
-     *
-     * @return array
-     */
-    public static function reg_statuses()
-    {
-        return array_unique(
-            array_merge(
-                EEM_Registration::active_reg_statuses(),
-                EEM_Registration::inactive_reg_statuses()
-            )
-        );
-    }
-
-
-    /**
-     * reg_statuses_that_allow_payment
-     * a filterable list of registration statuses that allow a registrant to make a payment
-     *
-     * @access public
-     * @return array
-     */
-    public static function reg_statuses_that_allow_payment()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__reg_statuses_that_allow_payment',
-            array(
-                EEM_Registration::status_id_approved,
-                EEM_Registration::status_id_pending_payment,
-            )
-        );
-    }
-
-
-    /**
-     * active_reg_statuses
-     * a filterable list of registration statuses that are considered active
-     *
-     * @access public
-     * @return array
-     */
-    public static function active_reg_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__active_reg_statuses',
-            array(
-                EEM_Registration::status_id_approved,
-                EEM_Registration::status_id_pending_payment,
-                EEM_Registration::status_id_wait_list,
-                EEM_Registration::status_id_not_approved,
-            )
-        );
-    }
-
-
-    /**
-     * inactive_reg_statuses
-     * a filterable list of registration statuses that are not considered active
-     *
-     * @access public
-     * @return array
-     */
-    public static function inactive_reg_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__inactive_reg_statuses',
-            array(
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-            )
-        );
-    }
-
-
-    /**
-     *    closed_reg_statuses
-     *    a filterable list of registration statuses that are considered "closed"
-     * meaning they should not be considered in any calculations involving monies owing
-     *
-     * @access public
-     * @return array
-     */
-    public static function closed_reg_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__closed_reg_statuses',
-            array(
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_wait_list,
-            )
-        );
-    }
-
-
-    /**
-     *        get list of registration statuses
-     *
-     * @access public
-     * @param array $exclude The status ids to exclude from the returned results
-     * @param bool $translated If true will return the values as singular localized strings
-     * @return array
-     * @throws EE_Error
-     */
-    public static function reg_status_array($exclude = array(), $translated = false)
-    {
-        EEM_Registration::instance()->_get_registration_status_array($exclude);
-        return $translated
-            ? EEM_Status::instance()->localized_status(self::$_reg_status, false, 'sentence')
-            : self::$_reg_status;
-    }
-
-
-    /**
-     *    get list of registration statuses
-     *
-     * @access private
-     * @param array $exclude
-     * @return void
-     * @throws EE_Error
-     */
-    private function _get_registration_status_array($exclude = array())
-    {
-        // in the very rare circumstance that we are deleting a model's table's data
-        // and the table hasn't actually been created, this could have an error
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
-            $results = $wpdb->get_results(
-                "SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
-            );
-            self::$_reg_status = array();
-            foreach ($results as $status) {
-                if (!in_array($status->STS_ID, $exclude, true)) {
-                    self::$_reg_status[ $status->STS_ID ] = $status->STS_code;
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws EE_Error
-     */
-    protected function _get_table_analysis()
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                get_class($this)
-            )
-        );
-    }
-
-
-    /**
-     * This returns a wpdb->results array of all registration date month and years matching the incoming query params
-     * and grouped by month and year.
-     *
-     * @param  array $where_params Array of query_params as described in the comments for EEM_Base::get_all()
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_reg_months_and_years($where_params)
-    {
-        $query_params[0] = $where_params;
-        $query_params['group_by'] = array('reg_year', 'reg_month');
-        $query_params['order_by'] = array('REG_date' => 'DESC');
-        $columns_to_select = array(
-            'reg_year' => array('YEAR(REG_date)', '%s'),
-            'reg_month' => array('MONTHNAME(REG_date)', '%s'),
-        );
-        return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
-    }
-
-
-    /**
-     * retrieve ALL registrations for a particular Attendee from db
-     *
-     * @param int $ATT_ID
-     * @return EE_Base_Class[]|EE_Registration[]|null
-     * @throws EE_Error
-     */
-    public function get_all_registrations_for_attendee($ATT_ID = 0)
-    {
-        if (!$ATT_ID) {
-            return null;
-        }
-        return $this->get_all(array(array('ATT_ID' => $ATT_ID)));
-    }
-
-
-    /**
-     * Gets a registration given their REG_url_link. Yes, this should usually
-     * be passed via a GET parameter.
-     *
-     * @param string $REG_url_link
-     * @return EE_Base_Class|EE_Registration|null
-     * @throws EE_Error
-     */
-    public function get_registration_for_reg_url_link($REG_url_link)
-    {
-        if (!$REG_url_link) {
-            return null;
-        }
-        return $this->get_one(array(array('REG_url_link' => $REG_url_link)));
-    }
-
-
-    /**
-     *        retrieve registration for a specific transaction attendee from db
-     *
-     * @access        public
-     * @param    int $TXN_ID
-     * @param    int $ATT_ID
-     * @param    int $att_nmbr in case the ATT_ID is the same for multiple registrations (same details used) then the
-     *                         attendee number is required
-     * @return        mixed        array on success, FALSE on fail
-     * @throws EE_Error
-     */
-    public function get_registration_for_transaction_attendee($TXN_ID = 0, $ATT_ID = 0, $att_nmbr = 0)
-    {
-        return $this->get_one(array(
-            array(
-                'TXN_ID' => $TXN_ID,
-                'ATT_ID' => $ATT_ID,
-            ),
-            'limit' => array(min($att_nmbr - 1, 0), 1),
-        ));
-    }
-
-
-    /**
-     *        get the number of registrations per day  for the Registration Admin page Reports Tab.
-     *        (doesn't utilize models because it's a fairly specialized query)
-     *
-     * @access        public
-     * @param $period string which can be passed to php's strtotime function (eg "-1 month")
-     * @return stdClass[] with properties regDate and total
-     * @throws EE_Error
-     */
-    public function get_registrations_per_day_report($period = '-1 month')
-    {
-        $sql_date = $this->convert_datetime_for_query(
-            'REG_date',
-            date('Y-m-d H:i:s', strtotime($period)),
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where = array(
-            'REG_date' => array('>=', $sql_date),
-            'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
-        );
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
-            $where['Event.EVT_wp_user'] = get_current_user_id();
-        }
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
-        $results = $this->_get_all_wpdb_results(
-            array(
-                $where,
-                'group_by' => 'regDate',
-                'order_by' => array('REG_date' => 'ASC'),
-            ),
-            OBJECT,
-            array(
-                'regDate' => array('DATE(' . $query_interval . ')', '%s'),
-                'total' => array('count(REG_ID)', '%d'),
-            )
-        );
-        return $results;
-    }
-
-
-    /**
-     * Get the number of registrations per day including the count of registrations for each Registration Status.
-     * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
-     *
-     * @param string $period
-     * @return stdClass[] with properties Registration_REG_date and a column for each registration status as the STS_ID
-     * @throws EE_Error
-     *                    (i.e. RAP)
-     */
-    public function get_registrations_per_day_and_per_status_report($period = '-1 month')
-    {
-        global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
-        $event_table = $wpdb->posts;
-        $sql_date = date('Y-m-d H:i:s', strtotime($period));
-        // prepare the query interval for displaying offset
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'dates.REG_date');
-        // inner date query
-        $inner_date_query = "SELECT DISTINCT REG_date from {$registration_table} ";
-        $inner_where = ' WHERE';
-        // exclude events not authored by user if permissions in effect
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
-            $inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
-        }
-        $inner_where .= " REG_date >= '{$sql_date}'";
-        $inner_date_query .= $inner_where;
-        // start main query
-        $select = "SELECT DATE({$query_interval}) as Registration_REG_date, ";
-        $join = '';
-        $join_parts = array();
-        $select_parts = array();
-        // loop through registration stati to do parts for each status.
-        foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
-            if ($STS_ID === EEM_Registration::status_id_incomplete) {
-                continue;
-            }
-            $select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}";
-            $join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.REG_date = dates.REG_date AND {$STS_code}.STS_ID = '{$STS_ID}'";
-        }
-        // setup the selects
-        $select .= implode(', ', $select_parts);
-        $select .= " FROM ($inner_date_query) AS dates LEFT JOIN ";
-        // setup the joins
-        $join .= implode(' LEFT JOIN ', $join_parts);
-        // now let's put it all together
-        $query = $select . $join . ' GROUP BY Registration_REG_date';
-        // and execute it
-        return $wpdb->get_results($query, ARRAY_A);
-    }
-
-
-    /**
-     *        get the number of registrations per event  for the Registration Admin page Reports Tab
-     *
-     * @access        public
-     * @param $period string which can be passed to php's strtotime function (eg "-1 month")
-     * @return stdClass[] each with properties event_name, reg_limit, and total
-     * @throws EE_Error
-     */
-    public function get_registrations_per_event_report($period = '-1 month')
-    {
-        $date_sql = $this->convert_datetime_for_query(
-            'REG_date',
-            date('Y-m-d H:i:s', strtotime($period)),
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where = array(
-            'REG_date' => array('>=', $date_sql),
-            'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
-        );
-        if (!EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_others_registrations',
-            'reg_per_event_report'
-        )
-        ) {
-            $where['Event.EVT_wp_user'] = get_current_user_id();
-        }
-        $results = $this->_get_all_wpdb_results(
-            array(
-            $where,
-            'group_by' => 'Event.EVT_name',
-            'order_by' => 'Event.EVT_name',
-            'limit' => array(0, 24),
-            ),
-            OBJECT,
-            array(
-                'event_name' => array('Event_CPT.post_title', '%s'),
-                'total' => array('COUNT(REG_ID)', '%s'),
-            )
-        );
-        return $results;
-    }
-
-
-    /**
-     * Get the number of registrations per event grouped by registration status.
-     * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
-     *
-     * @param string $period
-     * @return stdClass[] with properties `Registration_Event` and a column for each registration status as the STS_ID
-     * @throws EE_Error
-     *                    (i.e. RAP)
-     */
-    public function get_registrations_per_event_and_per_status_report($period = '-1 month')
-    {
-        global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
-        $event_table = $wpdb->posts;
-        $sql_date = date('Y-m-d H:i:s', strtotime($period));
-        // inner date query
-        $inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
-        $inner_where = ' WHERE';
-        // exclude events not authored by user if permissions in effect
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
-            $inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
-        }
-        $inner_where .= " REG_date >= '{$sql_date}'";
-        $inner_date_query .= $inner_where;
-        // build main query
-        $select = 'SELECT Event.post_title as Registration_Event, ';
-        $join = '';
-        $join_parts = array();
-        $select_parts = array();
-        // loop through registration stati to do parts for each status.
-        foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
-            if ($STS_ID === EEM_Registration::status_id_incomplete) {
-                continue;
-            }
-            $select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}";
-            $join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.EVT_ID = dates.EVT_ID AND {$STS_code}.STS_ID = '{$STS_ID}' AND {$STS_code}.REG_date = dates.REG_date";
-        }
-        // setup the selects
-        $select .= implode(', ', $select_parts);
-        $select .= " FROM ($inner_date_query) AS dates LEFT JOIN $event_table as Event ON Event.ID = dates.EVT_ID LEFT JOIN ";
-        // setup remaining joins
-        $join .= implode(' LEFT JOIN ', $join_parts);
-        // now put it all together
-        $query = $select . $join . ' GROUP BY Registration_Event';
-        // and execute
-        return $wpdb->get_results($query, ARRAY_A);
-    }
-
-
-    /**
-     * Returns the EE_Registration of the primary attendee on the transaction id provided
-     *
-     * @param int $TXN_ID
-     * @return EE_Base_Class|EE_Registration|null
-     * @throws EE_Error
-     */
-    public function get_primary_registration_for_transaction_ID($TXN_ID = 0)
-    {
-        if (!$TXN_ID) {
-            return null;
-        }
-        return $this->get_one(array(
-            array(
-                'TXN_ID' => $TXN_ID,
-                'REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT,
-            ),
-        ));
-    }
-
-
-    /**
-     *        get_event_registration_count
-     *
-     * @access public
-     * @param int $EVT_ID
-     * @param boolean $for_incomplete_payments
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_event_registration_count($EVT_ID, $for_incomplete_payments = false)
-    {
-        // we only count approved registrations towards registration limits
-        $query_params = array(array('EVT_ID' => $EVT_ID, 'STS_ID' => self::status_id_approved));
-        if ($for_incomplete_payments) {
-            $query_params[0]['Transaction.STS_ID'] = array('!=', EEM_Transaction::complete_status_code);
-        }
-        return $this->count($query_params);
-    }
-
-
-    /**
-     * Deletes all registrations with no transactions. Note that this needs to be very efficient
-     * and so it uses wpdb directly
-     *
-     * @global WPDB $wpdb
-     * @return int number deleted
-     * @throws EE_Error
-     */
-    public function delete_registrations_with_no_transaction()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        return $wpdb->query(
-            'DELETE r FROM '
-            . $this->table()
-            . ' r LEFT JOIN '
-            . EEM_Transaction::instance()->table()
-            . ' t ON r.TXN_ID = t.TXN_ID WHERE t.TXN_ID IS NULL'
-        );
-    }
-
-
-    /**
-     *  Count registrations checked into (or out of) a datetime
-     *
-     * @param int $DTT_ID datetime ID
-     * @param boolean $checked_in whether to count registrations checked IN or OUT
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_registrations_checked_into_datetime($DTT_ID, $checked_in = true)
-    {
-        global $wpdb;
-        // subquery to get latest checkin
-        $query = $wpdb->prepare(
-            'SELECT '
-            . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
-            . '( SELECT '
-            . 'max( CHK_timestamp ) AS latest_checkin, '
-            . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' '
-            . 'WHERE DTT_ID=%d '
-            . 'GROUP BY REG_ID'
-            . ') AS most_recent_checkin_per_reg '
-            . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
-            . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
-            . 'WHERE '
-            . 'checkins.CHK_in=%d',
-            $DTT_ID,
-            $checked_in
-        );
-        return (int) $wpdb->get_var($query);
-    }
-
-
-    /**
-     *  Count registrations checked into (or out of) an event.
-     *
-     * @param int $EVT_ID event ID
-     * @param boolean $checked_in whether to count registrations checked IN or OUT
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_registrations_checked_into_event($EVT_ID, $checked_in = true)
-    {
-        global $wpdb;
-        // subquery to get latest checkin
-        $query = $wpdb->prepare(
-            'SELECT '
-            . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
-            . '( SELECT '
-            . 'max( CHK_timestamp ) AS latest_checkin, '
-            . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS c '
-            . 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d '
-            . 'ON c.DTT_ID=d.DTT_ID '
-            . 'WHERE d.EVT_ID=%d '
-            . 'GROUP BY REG_ID'
-            . ') AS most_recent_checkin_per_reg '
-            . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
-            . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
-            . 'WHERE '
-            . 'checkins.CHK_in=%d',
-            $EVT_ID,
-            $checked_in
-        );
-        return (int) $wpdb->get_var($query);
-    }
-
-
-    /**
-     * The purpose of this method is to retrieve an array of
-     * EE_Registration objects that represent the latest registration
-     * for each ATT_ID given in the function argument.
-     *
-     * @param array $attendee_ids
-     * @return EE_Base_Class[]|EE_Registration[]
-     * @throws EE_Error
-     */
-    public function get_latest_registration_for_each_of_given_contacts($attendee_ids = array())
-    {
-        // first do a native wp_query to get the latest REG_ID's matching these attendees.
-        global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
-        $attendee_table = $wpdb->posts;
-        $attendee_ids = is_array($attendee_ids)
-            ? array_map('absint', $attendee_ids)
-            : array((int) $attendee_ids);
-        $ATT_IDs = implode(',', $attendee_ids);
-        // first we do a query to get the registration ids
-        // (because a group by before order by causes the order by to be ignored.)
-        $registration_id_query = "
+	/**
+	 * @var EEM_Registration $_instance
+	 */
+	protected static $_instance;
+
+	/**
+	 * Keys are the status IDs for registrations (eg, RAP, RCN, etc), and the values
+	 * are status codes (eg, approved, cancelled, etc)
+	 *
+	 * @var array
+	 */
+	private static $_reg_status;
+
+	/**
+	 * The value of REG_count for a primary registrant
+	 */
+	const PRIMARY_REGISTRANT_COUNT = 1;
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate an INCOMPLETE registration.
+	 * Initial status for registrations when they are first created
+	 * Payments are NOT allowed.
+	 * Automatically toggled to whatever the default Event registration status is upon completion of the attendee
+	 * information reg step NO space reserved. Registration is NOT active
+	 */
+	const status_id_incomplete = 'RIC';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate an UNAPPROVED registration.
+	 * Payments are NOT allowed.
+	 * Event Admin must manually toggle STS_ID for it to change
+	 * No space reserved.
+	 * Registration is active
+	 */
+	const status_id_not_approved = 'RNA';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate registration is PENDING_PAYMENT .
+	 * Payments are allowed.
+	 * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
+	 * No space reserved.
+	 * Registration is active
+	 */
+	const status_id_pending_payment = 'RPP';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate registration is on the WAIT_LIST .
+	 * Payments are allowed.
+	 * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
+	 * No space reserved.
+	 * Registration is active
+	 */
+	const status_id_wait_list = 'RWL';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate an APPROVED registration.
+	 * the TXN may or may not be completed ( paid in full )
+	 * Payments are allowed.
+	 * A space IS reserved.
+	 * Registration is active
+	 */
+	const status_id_approved = 'RAP';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate a registration was CANCELLED by the attendee.
+	 * Payments are NOT allowed.
+	 * NO space reserved.
+	 * Registration is NOT active
+	 */
+	const status_id_cancelled = 'RCN';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate a registration was DECLINED by the Event Admin
+	 * Payments are NOT allowed.
+	 * No space reserved.
+	 * Registration is NOT active
+	 */
+	const status_id_declined = 'RDC';
+
+	/**
+	 * @var TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+
+	/**
+	 *    private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access protected
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
+	 *                         incoming timezone data that gets saved). Note this just sends the timezone info to the
+	 *                         date time model field objects.  Default is NULL (and will be assumed using the set
+	 *                         timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+		$this->singular_item = esc_html__('Registration', 'event_espresso');
+		$this->plural_item = esc_html__('Registrations', 'event_espresso');
+		$this->_tables = array(
+			'Registration' => new EE_Primary_Table('esp_registration', 'REG_ID'),
+		);
+		$this->_fields = array(
+			'Registration' => array(
+				'REG_ID' => new EE_Primary_Key_Int_Field(
+					'REG_ID',
+					esc_html__('Registration ID', 'event_espresso')
+				),
+				'EVT_ID' => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('Event ID', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'ATT_ID' => new EE_Foreign_Key_Int_Field(
+					'ATT_ID',
+					esc_html__('Attendee ID', 'event_espresso'),
+					false,
+					0,
+					'Attendee'
+				),
+				'TXN_ID' => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__('Transaction ID', 'event_espresso'),
+					false,
+					0,
+					'Transaction'
+				),
+				'TKT_ID' => new EE_Foreign_Key_Int_Field(
+					'TKT_ID',
+					esc_html__('Ticket ID', 'event_espresso'),
+					false,
+					0,
+					'Ticket'
+				),
+				'STS_ID' => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					esc_html__('Status ID', 'event_espresso'),
+					false,
+					EEM_Registration::status_id_incomplete,
+					'Status'
+				),
+				'REG_date' => new EE_Datetime_Field(
+					'REG_date',
+					esc_html__('Time registration occurred', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'REG_final_price' => new EE_Money_Field(
+					'REG_final_price',
+					esc_html__('Registration\'s share of the transaction total', 'event_espresso'),
+					false,
+					0
+				),
+				'REG_paid' => new EE_Money_Field(
+					'REG_paid',
+					esc_html__('Amount paid to date towards registration', 'event_espresso'),
+					false,
+					0
+				),
+				'REG_session' => new EE_Plain_Text_Field(
+					'REG_session',
+					esc_html__('Session ID of registration', 'event_espresso'),
+					false,
+					''
+				),
+				'REG_code' => new EE_Plain_Text_Field(
+					'REG_code',
+					esc_html__('Unique Code for this registration', 'event_espresso'),
+					false,
+					''
+				),
+				'REG_url_link' => new EE_Plain_Text_Field(
+					'REG_url_link',
+					esc_html__('String to be used in URL for identifying registration', 'event_espresso'),
+					false,
+					''
+				),
+				'REG_count' => new EE_Integer_Field(
+					'REG_count',
+					esc_html__('Count of this registration in the group registration ', 'event_espresso'),
+					true,
+					1
+				),
+				'REG_group_size' => new EE_Integer_Field(
+					'REG_group_size',
+					esc_html__('Number of registrations on this group', 'event_espresso'),
+					false,
+					1
+				),
+				'REG_att_is_going' => new EE_Boolean_Field(
+					'REG_att_is_going',
+					esc_html__('Flag indicating the registrant plans on attending', 'event_espresso'),
+					false,
+					false
+				),
+				'REG_deleted' => new EE_Trashed_Flag_Field(
+					'REG_deleted',
+					esc_html__('Flag indicating if registration has been archived or not.', 'event_espresso'),
+					false,
+					false
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Event' => new EE_Belongs_To_Relation(),
+			'Attendee' => new EE_Belongs_To_Relation(),
+			'Transaction' => new EE_Belongs_To_Relation(),
+			'Ticket' => new EE_Belongs_To_Relation(),
+			'Status' => new EE_Belongs_To_Relation(),
+			'Answer' => new EE_Has_Many_Relation(),
+			'Checkin' => new EE_Has_Many_Relation(),
+			'Registration_Payment' => new EE_Has_Many_Relation(),
+			'Payment' => new EE_HABTM_Relation('Registration_Payment'),
+			'Message' => new EE_Has_Many_Any_Relation(false)
+			// allow deletes even if there are messages in the queue related
+		);
+		$this->_model_chain_to_wp_user = 'Event';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * a list of ALL valid registration statuses currently in use within the system
+	 * generated by combining the filterable active and inactive reg status arrays
+	 *
+	 * @return array
+	 */
+	public static function reg_statuses()
+	{
+		return array_unique(
+			array_merge(
+				EEM_Registration::active_reg_statuses(),
+				EEM_Registration::inactive_reg_statuses()
+			)
+		);
+	}
+
+
+	/**
+	 * reg_statuses_that_allow_payment
+	 * a filterable list of registration statuses that allow a registrant to make a payment
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function reg_statuses_that_allow_payment()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__reg_statuses_that_allow_payment',
+			array(
+				EEM_Registration::status_id_approved,
+				EEM_Registration::status_id_pending_payment,
+			)
+		);
+	}
+
+
+	/**
+	 * active_reg_statuses
+	 * a filterable list of registration statuses that are considered active
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function active_reg_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__active_reg_statuses',
+			array(
+				EEM_Registration::status_id_approved,
+				EEM_Registration::status_id_pending_payment,
+				EEM_Registration::status_id_wait_list,
+				EEM_Registration::status_id_not_approved,
+			)
+		);
+	}
+
+
+	/**
+	 * inactive_reg_statuses
+	 * a filterable list of registration statuses that are not considered active
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function inactive_reg_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__inactive_reg_statuses',
+			array(
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+			)
+		);
+	}
+
+
+	/**
+	 *    closed_reg_statuses
+	 *    a filterable list of registration statuses that are considered "closed"
+	 * meaning they should not be considered in any calculations involving monies owing
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function closed_reg_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__closed_reg_statuses',
+			array(
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_wait_list,
+			)
+		);
+	}
+
+
+	/**
+	 *        get list of registration statuses
+	 *
+	 * @access public
+	 * @param array $exclude The status ids to exclude from the returned results
+	 * @param bool $translated If true will return the values as singular localized strings
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function reg_status_array($exclude = array(), $translated = false)
+	{
+		EEM_Registration::instance()->_get_registration_status_array($exclude);
+		return $translated
+			? EEM_Status::instance()->localized_status(self::$_reg_status, false, 'sentence')
+			: self::$_reg_status;
+	}
+
+
+	/**
+	 *    get list of registration statuses
+	 *
+	 * @access private
+	 * @param array $exclude
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _get_registration_status_array($exclude = array())
+	{
+		// in the very rare circumstance that we are deleting a model's table's data
+		// and the table hasn't actually been created, this could have an error
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
+			$results = $wpdb->get_results(
+				"SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
+			);
+			self::$_reg_status = array();
+			foreach ($results as $status) {
+				if (!in_array($status->STS_ID, $exclude, true)) {
+					self::$_reg_status[ $status->STS_ID ] = $status->STS_code;
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws EE_Error
+	 */
+	protected function _get_table_analysis()
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+				get_class($this)
+			)
+		);
+	}
+
+
+	/**
+	 * This returns a wpdb->results array of all registration date month and years matching the incoming query params
+	 * and grouped by month and year.
+	 *
+	 * @param  array $where_params Array of query_params as described in the comments for EEM_Base::get_all()
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_reg_months_and_years($where_params)
+	{
+		$query_params[0] = $where_params;
+		$query_params['group_by'] = array('reg_year', 'reg_month');
+		$query_params['order_by'] = array('REG_date' => 'DESC');
+		$columns_to_select = array(
+			'reg_year' => array('YEAR(REG_date)', '%s'),
+			'reg_month' => array('MONTHNAME(REG_date)', '%s'),
+		);
+		return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
+	}
+
+
+	/**
+	 * retrieve ALL registrations for a particular Attendee from db
+	 *
+	 * @param int $ATT_ID
+	 * @return EE_Base_Class[]|EE_Registration[]|null
+	 * @throws EE_Error
+	 */
+	public function get_all_registrations_for_attendee($ATT_ID = 0)
+	{
+		if (!$ATT_ID) {
+			return null;
+		}
+		return $this->get_all(array(array('ATT_ID' => $ATT_ID)));
+	}
+
+
+	/**
+	 * Gets a registration given their REG_url_link. Yes, this should usually
+	 * be passed via a GET parameter.
+	 *
+	 * @param string $REG_url_link
+	 * @return EE_Base_Class|EE_Registration|null
+	 * @throws EE_Error
+	 */
+	public function get_registration_for_reg_url_link($REG_url_link)
+	{
+		if (!$REG_url_link) {
+			return null;
+		}
+		return $this->get_one(array(array('REG_url_link' => $REG_url_link)));
+	}
+
+
+	/**
+	 *        retrieve registration for a specific transaction attendee from db
+	 *
+	 * @access        public
+	 * @param    int $TXN_ID
+	 * @param    int $ATT_ID
+	 * @param    int $att_nmbr in case the ATT_ID is the same for multiple registrations (same details used) then the
+	 *                         attendee number is required
+	 * @return        mixed        array on success, FALSE on fail
+	 * @throws EE_Error
+	 */
+	public function get_registration_for_transaction_attendee($TXN_ID = 0, $ATT_ID = 0, $att_nmbr = 0)
+	{
+		return $this->get_one(array(
+			array(
+				'TXN_ID' => $TXN_ID,
+				'ATT_ID' => $ATT_ID,
+			),
+			'limit' => array(min($att_nmbr - 1, 0), 1),
+		));
+	}
+
+
+	/**
+	 *        get the number of registrations per day  for the Registration Admin page Reports Tab.
+	 *        (doesn't utilize models because it's a fairly specialized query)
+	 *
+	 * @access        public
+	 * @param $period string which can be passed to php's strtotime function (eg "-1 month")
+	 * @return stdClass[] with properties regDate and total
+	 * @throws EE_Error
+	 */
+	public function get_registrations_per_day_report($period = '-1 month')
+	{
+		$sql_date = $this->convert_datetime_for_query(
+			'REG_date',
+			date('Y-m-d H:i:s', strtotime($period)),
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where = array(
+			'REG_date' => array('>=', $sql_date),
+			'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
+		);
+		if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
+			$where['Event.EVT_wp_user'] = get_current_user_id();
+		}
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
+		$results = $this->_get_all_wpdb_results(
+			array(
+				$where,
+				'group_by' => 'regDate',
+				'order_by' => array('REG_date' => 'ASC'),
+			),
+			OBJECT,
+			array(
+				'regDate' => array('DATE(' . $query_interval . ')', '%s'),
+				'total' => array('count(REG_ID)', '%d'),
+			)
+		);
+		return $results;
+	}
+
+
+	/**
+	 * Get the number of registrations per day including the count of registrations for each Registration Status.
+	 * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
+	 *
+	 * @param string $period
+	 * @return stdClass[] with properties Registration_REG_date and a column for each registration status as the STS_ID
+	 * @throws EE_Error
+	 *                    (i.e. RAP)
+	 */
+	public function get_registrations_per_day_and_per_status_report($period = '-1 month')
+	{
+		global $wpdb;
+		$registration_table = $wpdb->prefix . 'esp_registration';
+		$event_table = $wpdb->posts;
+		$sql_date = date('Y-m-d H:i:s', strtotime($period));
+		// prepare the query interval for displaying offset
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'dates.REG_date');
+		// inner date query
+		$inner_date_query = "SELECT DISTINCT REG_date from {$registration_table} ";
+		$inner_where = ' WHERE';
+		// exclude events not authored by user if permissions in effect
+		if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
+			$inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
+		}
+		$inner_where .= " REG_date >= '{$sql_date}'";
+		$inner_date_query .= $inner_where;
+		// start main query
+		$select = "SELECT DATE({$query_interval}) as Registration_REG_date, ";
+		$join = '';
+		$join_parts = array();
+		$select_parts = array();
+		// loop through registration stati to do parts for each status.
+		foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
+			if ($STS_ID === EEM_Registration::status_id_incomplete) {
+				continue;
+			}
+			$select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}";
+			$join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.REG_date = dates.REG_date AND {$STS_code}.STS_ID = '{$STS_ID}'";
+		}
+		// setup the selects
+		$select .= implode(', ', $select_parts);
+		$select .= " FROM ($inner_date_query) AS dates LEFT JOIN ";
+		// setup the joins
+		$join .= implode(' LEFT JOIN ', $join_parts);
+		// now let's put it all together
+		$query = $select . $join . ' GROUP BY Registration_REG_date';
+		// and execute it
+		return $wpdb->get_results($query, ARRAY_A);
+	}
+
+
+	/**
+	 *        get the number of registrations per event  for the Registration Admin page Reports Tab
+	 *
+	 * @access        public
+	 * @param $period string which can be passed to php's strtotime function (eg "-1 month")
+	 * @return stdClass[] each with properties event_name, reg_limit, and total
+	 * @throws EE_Error
+	 */
+	public function get_registrations_per_event_report($period = '-1 month')
+	{
+		$date_sql = $this->convert_datetime_for_query(
+			'REG_date',
+			date('Y-m-d H:i:s', strtotime($period)),
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where = array(
+			'REG_date' => array('>=', $date_sql),
+			'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
+		);
+		if (!EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_others_registrations',
+			'reg_per_event_report'
+		)
+		) {
+			$where['Event.EVT_wp_user'] = get_current_user_id();
+		}
+		$results = $this->_get_all_wpdb_results(
+			array(
+			$where,
+			'group_by' => 'Event.EVT_name',
+			'order_by' => 'Event.EVT_name',
+			'limit' => array(0, 24),
+			),
+			OBJECT,
+			array(
+				'event_name' => array('Event_CPT.post_title', '%s'),
+				'total' => array('COUNT(REG_ID)', '%s'),
+			)
+		);
+		return $results;
+	}
+
+
+	/**
+	 * Get the number of registrations per event grouped by registration status.
+	 * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
+	 *
+	 * @param string $period
+	 * @return stdClass[] with properties `Registration_Event` and a column for each registration status as the STS_ID
+	 * @throws EE_Error
+	 *                    (i.e. RAP)
+	 */
+	public function get_registrations_per_event_and_per_status_report($period = '-1 month')
+	{
+		global $wpdb;
+		$registration_table = $wpdb->prefix . 'esp_registration';
+		$event_table = $wpdb->posts;
+		$sql_date = date('Y-m-d H:i:s', strtotime($period));
+		// inner date query
+		$inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
+		$inner_where = ' WHERE';
+		// exclude events not authored by user if permissions in effect
+		if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
+			$inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
+		}
+		$inner_where .= " REG_date >= '{$sql_date}'";
+		$inner_date_query .= $inner_where;
+		// build main query
+		$select = 'SELECT Event.post_title as Registration_Event, ';
+		$join = '';
+		$join_parts = array();
+		$select_parts = array();
+		// loop through registration stati to do parts for each status.
+		foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
+			if ($STS_ID === EEM_Registration::status_id_incomplete) {
+				continue;
+			}
+			$select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}";
+			$join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.EVT_ID = dates.EVT_ID AND {$STS_code}.STS_ID = '{$STS_ID}' AND {$STS_code}.REG_date = dates.REG_date";
+		}
+		// setup the selects
+		$select .= implode(', ', $select_parts);
+		$select .= " FROM ($inner_date_query) AS dates LEFT JOIN $event_table as Event ON Event.ID = dates.EVT_ID LEFT JOIN ";
+		// setup remaining joins
+		$join .= implode(' LEFT JOIN ', $join_parts);
+		// now put it all together
+		$query = $select . $join . ' GROUP BY Registration_Event';
+		// and execute
+		return $wpdb->get_results($query, ARRAY_A);
+	}
+
+
+	/**
+	 * Returns the EE_Registration of the primary attendee on the transaction id provided
+	 *
+	 * @param int $TXN_ID
+	 * @return EE_Base_Class|EE_Registration|null
+	 * @throws EE_Error
+	 */
+	public function get_primary_registration_for_transaction_ID($TXN_ID = 0)
+	{
+		if (!$TXN_ID) {
+			return null;
+		}
+		return $this->get_one(array(
+			array(
+				'TXN_ID' => $TXN_ID,
+				'REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT,
+			),
+		));
+	}
+
+
+	/**
+	 *        get_event_registration_count
+	 *
+	 * @access public
+	 * @param int $EVT_ID
+	 * @param boolean $for_incomplete_payments
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_event_registration_count($EVT_ID, $for_incomplete_payments = false)
+	{
+		// we only count approved registrations towards registration limits
+		$query_params = array(array('EVT_ID' => $EVT_ID, 'STS_ID' => self::status_id_approved));
+		if ($for_incomplete_payments) {
+			$query_params[0]['Transaction.STS_ID'] = array('!=', EEM_Transaction::complete_status_code);
+		}
+		return $this->count($query_params);
+	}
+
+
+	/**
+	 * Deletes all registrations with no transactions. Note that this needs to be very efficient
+	 * and so it uses wpdb directly
+	 *
+	 * @global WPDB $wpdb
+	 * @return int number deleted
+	 * @throws EE_Error
+	 */
+	public function delete_registrations_with_no_transaction()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		return $wpdb->query(
+			'DELETE r FROM '
+			. $this->table()
+			. ' r LEFT JOIN '
+			. EEM_Transaction::instance()->table()
+			. ' t ON r.TXN_ID = t.TXN_ID WHERE t.TXN_ID IS NULL'
+		);
+	}
+
+
+	/**
+	 *  Count registrations checked into (or out of) a datetime
+	 *
+	 * @param int $DTT_ID datetime ID
+	 * @param boolean $checked_in whether to count registrations checked IN or OUT
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_registrations_checked_into_datetime($DTT_ID, $checked_in = true)
+	{
+		global $wpdb;
+		// subquery to get latest checkin
+		$query = $wpdb->prepare(
+			'SELECT '
+			. 'COUNT( DISTINCT checkins.REG_ID ) '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+			. '( SELECT '
+			. 'max( CHK_timestamp ) AS latest_checkin, '
+			. 'REG_ID AS REG_ID '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' '
+			. 'WHERE DTT_ID=%d '
+			. 'GROUP BY REG_ID'
+			. ') AS most_recent_checkin_per_reg '
+			. 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
+			. 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
+			. 'WHERE '
+			. 'checkins.CHK_in=%d',
+			$DTT_ID,
+			$checked_in
+		);
+		return (int) $wpdb->get_var($query);
+	}
+
+
+	/**
+	 *  Count registrations checked into (or out of) an event.
+	 *
+	 * @param int $EVT_ID event ID
+	 * @param boolean $checked_in whether to count registrations checked IN or OUT
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_registrations_checked_into_event($EVT_ID, $checked_in = true)
+	{
+		global $wpdb;
+		// subquery to get latest checkin
+		$query = $wpdb->prepare(
+			'SELECT '
+			. 'COUNT( DISTINCT checkins.REG_ID ) '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+			. '( SELECT '
+			. 'max( CHK_timestamp ) AS latest_checkin, '
+			. 'REG_ID AS REG_ID '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' AS c '
+			. 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d '
+			. 'ON c.DTT_ID=d.DTT_ID '
+			. 'WHERE d.EVT_ID=%d '
+			. 'GROUP BY REG_ID'
+			. ') AS most_recent_checkin_per_reg '
+			. 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
+			. 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
+			. 'WHERE '
+			. 'checkins.CHK_in=%d',
+			$EVT_ID,
+			$checked_in
+		);
+		return (int) $wpdb->get_var($query);
+	}
+
+
+	/**
+	 * The purpose of this method is to retrieve an array of
+	 * EE_Registration objects that represent the latest registration
+	 * for each ATT_ID given in the function argument.
+	 *
+	 * @param array $attendee_ids
+	 * @return EE_Base_Class[]|EE_Registration[]
+	 * @throws EE_Error
+	 */
+	public function get_latest_registration_for_each_of_given_contacts($attendee_ids = array())
+	{
+		// first do a native wp_query to get the latest REG_ID's matching these attendees.
+		global $wpdb;
+		$registration_table = $wpdb->prefix . 'esp_registration';
+		$attendee_table = $wpdb->posts;
+		$attendee_ids = is_array($attendee_ids)
+			? array_map('absint', $attendee_ids)
+			: array((int) $attendee_ids);
+		$ATT_IDs = implode(',', $attendee_ids);
+		// first we do a query to get the registration ids
+		// (because a group by before order by causes the order by to be ignored.)
+		$registration_id_query = "
 			SELECT registrations.registration_ids as registration_id
 			FROM (
 				SELECT
@@ -835,61 +835,61 @@ 
 			  ) AS registrations
 			  GROUP BY registrations.attendee_ids
 		";
-        $registration_ids = $wpdb->get_results($registration_id_query, ARRAY_A);
-        if (empty($registration_ids)) {
-            return array();
-        }
-        $ids_for_model_query = array();
-        // let's flatten the ids so they can be used in the model query.
-        foreach ($registration_ids as $registration_id) {
-            if (isset($registration_id['registration_id'])) {
-                $ids_for_model_query[] = $registration_id['registration_id'];
-            }
-        }
-        // construct query
-        $_where = array(
-            'REG_ID' => array('IN', $ids_for_model_query),
-        );
-        return $this->get_all(array($_where));
-    }
-
-
-
-    /**
-     * returns a count of registrations for the supplied event having the status as specified
-     *
-     * @param int $EVT_ID
-     * @param array $statuses
-     * @return int
-     * @throws InvalidArgumentException
-     * @throws InvalidStatusException
-     * @throws EE_Error
-     */
-    public function event_reg_count_for_statuses($EVT_ID, $statuses = array())
-    {
-        $EVT_ID = absint($EVT_ID);
-        if (! $EVT_ID) {
-            throw new InvalidArgumentException(
-                esc_html__('An invalid Event ID was supplied.', 'event_espresso')
-            );
-        }
-        $statuses = is_array($statuses) ? $statuses : array($statuses);
-        $statuses = ! empty($statuses) ? $statuses : array(EEM_Registration::status_id_approved);
-        $valid_reg_statuses = EEM_Registration::reg_statuses();
-        foreach ($statuses as $status) {
-            if (! in_array($status, $valid_reg_statuses, true)) {
-                throw new InvalidStatusException($status, esc_html__('Registration', 'event_espresso'));
-            }
-        }
-        return $this->count(
-            array(
-                array(
-                    'EVT_ID' => $EVT_ID,
-                    'STS_ID' => array('IN', $statuses),
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
+		$registration_ids = $wpdb->get_results($registration_id_query, ARRAY_A);
+		if (empty($registration_ids)) {
+			return array();
+		}
+		$ids_for_model_query = array();
+		// let's flatten the ids so they can be used in the model query.
+		foreach ($registration_ids as $registration_id) {
+			if (isset($registration_id['registration_id'])) {
+				$ids_for_model_query[] = $registration_id['registration_id'];
+			}
+		}
+		// construct query
+		$_where = array(
+			'REG_ID' => array('IN', $ids_for_model_query),
+		);
+		return $this->get_all(array($_where));
+	}
+
+
+
+	/**
+	 * returns a count of registrations for the supplied event having the status as specified
+	 *
+	 * @param int $EVT_ID
+	 * @param array $statuses
+	 * @return int
+	 * @throws InvalidArgumentException
+	 * @throws InvalidStatusException
+	 * @throws EE_Error
+	 */
+	public function event_reg_count_for_statuses($EVT_ID, $statuses = array())
+	{
+		$EVT_ID = absint($EVT_ID);
+		if (! $EVT_ID) {
+			throw new InvalidArgumentException(
+				esc_html__('An invalid Event ID was supplied.', 'event_espresso')
+			);
+		}
+		$statuses = is_array($statuses) ? $statuses : array($statuses);
+		$statuses = ! empty($statuses) ? $statuses : array(EEM_Registration::status_id_approved);
+		$valid_reg_statuses = EEM_Registration::reg_statuses();
+		foreach ($statuses as $status) {
+			if (! in_array($status, $valid_reg_statuses, true)) {
+				throw new InvalidStatusException($status, esc_html__('Registration', 'event_espresso'));
+			}
+		}
+		return $this->count(
+			array(
+				array(
+					'EVT_ID' => $EVT_ID,
+					'STS_ID' => array('IN', $statuses),
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
 }

Spacing +25 added lines, -25 removed lines

@@ -369,14 +369,14 @@ 
         // and the table hasn't actually been created, this could have an error
         /** @type WPDB $wpdb */
         global $wpdb;
-        if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
+        if ($this->_get_table_analysis()->tableExists($wpdb->prefix.'esp_status')) {
             $results = $wpdb->get_results(
                 "SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
             );
             self::$_reg_status = array();
             foreach ($results as $status) {
-                if (!in_array($status->STS_ID, $exclude, true)) {
-                    self::$_reg_status[ $status->STS_ID ] = $status->STS_code;
+                if ( ! in_array($status->STS_ID, $exclude, true)) {
+                    self::$_reg_status[$status->STS_ID] = $status->STS_code;
                 }
             }
         }
@@ -433,7 +433,7 @@ 
      */
     public function get_all_registrations_for_attendee($ATT_ID = 0)
     {
-        if (!$ATT_ID) {
+        if ( ! $ATT_ID) {
             return null;
         }
         return $this->get_all(array(array('ATT_ID' => $ATT_ID)));
@@ -450,7 +450,7 @@ 
      */
     public function get_registration_for_reg_url_link($REG_url_link)
     {
-        if (!$REG_url_link) {
+        if ( ! $REG_url_link) {
             return null;
         }
         return $this->get_one(array(array('REG_url_link' => $REG_url_link)));
@@ -501,7 +501,7 @@ 
             'REG_date' => array('>=', $sql_date),
             'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
         );
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
             $where['Event.EVT_wp_user'] = get_current_user_id();
         }
         $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
@@ -513,7 +513,7 @@ 
             ),
             OBJECT,
             array(
-                'regDate' => array('DATE(' . $query_interval . ')', '%s'),
+                'regDate' => array('DATE('.$query_interval.')', '%s'),
                 'total' => array('count(REG_ID)', '%d'),
             )
         );
@@ -533,7 +533,7 @@ 
     public function get_registrations_per_day_and_per_status_report($period = '-1 month')
     {
         global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
+        $registration_table = $wpdb->prefix.'esp_registration';
         $event_table = $wpdb->posts;
         $sql_date = date('Y-m-d H:i:s', strtotime($period));
         // prepare the query interval for displaying offset
@@ -542,9 +542,9 @@ 
         $inner_date_query = "SELECT DISTINCT REG_date from {$registration_table} ";
         $inner_where = ' WHERE';
         // exclude events not authored by user if permissions in effect
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
             $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
-            $inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
+            $inner_where .= ' post_author = '.get_current_user_id().' AND';
         }
         $inner_where .= " REG_date >= '{$sql_date}'";
         $inner_date_query .= $inner_where;
@@ -567,7 +567,7 @@ 
         // setup the joins
         $join .= implode(' LEFT JOIN ', $join_parts);
         // now let's put it all together
-        $query = $select . $join . ' GROUP BY Registration_REG_date';
+        $query = $select.$join.' GROUP BY Registration_REG_date';
         // and execute it
         return $wpdb->get_results($query, ARRAY_A);
     }
@@ -593,7 +593,7 @@ 
             'REG_date' => array('>=', $date_sql),
             'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
         );
-        if (!EE_Registry::instance()->CAP->current_user_can(
+        if ( ! EE_Registry::instance()->CAP->current_user_can(
             'ee_read_others_registrations',
             'reg_per_event_report'
         )
@@ -629,16 +629,16 @@ 
     public function get_registrations_per_event_and_per_status_report($period = '-1 month')
     {
         global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
+        $registration_table = $wpdb->prefix.'esp_registration';
         $event_table = $wpdb->posts;
         $sql_date = date('Y-m-d H:i:s', strtotime($period));
         // inner date query
         $inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
         $inner_where = ' WHERE';
         // exclude events not authored by user if permissions in effect
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
             $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
-            $inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
+            $inner_where .= ' post_author = '.get_current_user_id().' AND';
         }
         $inner_where .= " REG_date >= '{$sql_date}'";
         $inner_date_query .= $inner_where;
@@ -661,7 +661,7 @@ 
         // setup remaining joins
         $join .= implode(' LEFT JOIN ', $join_parts);
         // now put it all together
-        $query = $select . $join . ' GROUP BY Registration_Event';
+        $query = $select.$join.' GROUP BY Registration_Event';
         // and execute
         return $wpdb->get_results($query, ARRAY_A);
     }
@@ -676,7 +676,7 @@ 
      */
     public function get_primary_registration_for_transaction_ID($TXN_ID = 0)
     {
-        if (!$TXN_ID) {
+        if ( ! $TXN_ID) {
             return null;
         }
         return $this->get_one(array(
@@ -745,11 +745,11 @@ 
         $query = $wpdb->prepare(
             'SELECT '
             . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+            . 'FROM '.EEM_Checkin::instance()->table().' AS checkins INNER JOIN'
             . '( SELECT '
             . 'max( CHK_timestamp ) AS latest_checkin, '
             . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' '
+            . 'FROM '.EEM_Checkin::instance()->table().' '
             . 'WHERE DTT_ID=%d '
             . 'GROUP BY REG_ID'
             . ') AS most_recent_checkin_per_reg '
@@ -779,12 +779,12 @@ 
         $query = $wpdb->prepare(
             'SELECT '
             . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+            . 'FROM '.EEM_Checkin::instance()->table().' AS checkins INNER JOIN'
             . '( SELECT '
             . 'max( CHK_timestamp ) AS latest_checkin, '
             . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS c '
-            . 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d '
+            . 'FROM '.EEM_Checkin::instance()->table().' AS c '
+            . 'INNER JOIN '.EEM_Datetime::instance()->table().' AS d '
             . 'ON c.DTT_ID=d.DTT_ID '
             . 'WHERE d.EVT_ID=%d '
             . 'GROUP BY REG_ID'
@@ -813,7 +813,7 @@ 
     {
         // first do a native wp_query to get the latest REG_ID's matching these attendees.
         global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
+        $registration_table = $wpdb->prefix.'esp_registration';
         $attendee_table = $wpdb->posts;
         $attendee_ids = is_array($attendee_ids)
             ? array_map('absint', $attendee_ids)
@@ -868,7 +868,7 @@ 
     public function event_reg_count_for_statuses($EVT_ID, $statuses = array())
     {
         $EVT_ID = absint($EVT_ID);
-        if (! $EVT_ID) {
+        if ( ! $EVT_ID) {
             throw new InvalidArgumentException(
                 esc_html__('An invalid Event ID was supplied.', 'event_espresso')
             );
@@ -877,7 +877,7 @@ 
         $statuses = ! empty($statuses) ? $statuses : array(EEM_Registration::status_id_approved);
         $valid_reg_statuses = EEM_Registration::reg_statuses();
         foreach ($statuses as $status) {
-            if (! in_array($status, $valid_reg_statuses, true)) {
+            if ( ! in_array($status, $valid_reg_statuses, true)) {
                 throw new InvalidStatusException($status, esc_html__('Registration', 'event_espresso'));
             }
         }

core/exceptions/InvalidStatusException.php

Indentation +22 added lines, -22 removed lines

@@ -8,26 +8,26 @@
 
 class InvalidStatusException extends InvalidArgumentException
 {
-    /**
-     * InvalidStatusException constructor.
-     * @param string $status the invalid status id that was supplied
-     * @param string $domain the name of the domain, model, or class that the status belongs to
-     * @param string $message custom message
-     * @param int $code
-     * @param Exception|null $previous
-     */
-    public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    '"%1$s" is not a valid %2$s status',
-                    'event_espresso'
-                ),
-                $status,
-                $domain
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidStatusException constructor.
+	 * @param string $status the invalid status id that was supplied
+	 * @param string $domain the name of the domain, model, or class that the status belongs to
+	 * @param string $message custom message
+	 * @param int $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'"%1$s" is not a valid %2$s status',
+					'event_espresso'
+				),
+				$status,
+				$domain
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/domain/services/admin/AdminToolBar.php

Spacing +10 added lines, -10 removed lines

@@ -120,7 +120,7 @@ 
     {
         wp_register_style(
             'espresso-admin-toolbar',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
+            EE_GLOBAL_ASSETS_URL.'css/espresso-admin-toolbar.css',
             array('dashicons'),
             EVENT_ESPRESSO_VERSION
         );
@@ -143,7 +143,7 @@ 
                 'href'  => $this->events_admin_url,
                 'meta'  => array(
                     'title' => esc_html__('Event Espresso', 'event_espresso'),
-                    'class' => $this->menu_class . 'first',
+                    'class' => $this->menu_class.'first',
                 ),
             )
         );
@@ -491,7 +491,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Approved', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-approved',
                     ),
                 )
             );
@@ -528,7 +528,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Pending Payment', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-pending',
                     ),
                 )
             );
@@ -565,7 +565,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Not Approved', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-not-approved',
                     ),
                 )
             );
@@ -602,7 +602,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Cancelled', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-cancelled',
                     ),
                 )
             );
@@ -674,7 +674,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Approved', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-approved',
                     ),
                 )
             );
@@ -711,7 +711,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Pending', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-pending',
                     ),
                 )
             );
@@ -748,7 +748,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Not Approved', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-not-approved',
                     ),
                 )
             );
@@ -785,7 +785,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Cancelled', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-cancelled',
                     ),
                 )
             );

Indentation +737 added lines, -737 removed lines

@@ -19,741 +19,741 @@
 class AdminToolBar
 {
 
-    /**
-     * @var WP_Admin_Bar $admin_bar
-     */
-    private $admin_bar;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var string $events_admin_url
-     */
-    private $events_admin_url;
-
-    /**
-     * @var string $menu_class
-     */
-    private $menu_class = 'espresso_menu_item_class';
-
-    /**
-     * @var string $reg_admin_url
-     */
-    private $reg_admin_url;
-
-
-    /**
-     * AdminToolBar constructor.
-     *
-     * @param EE_Capabilities $capabilities
-     */
-    public function __construct(EE_Capabilities $capabilities)
-    {
-        $this->capabilities = $capabilities;
-        add_action('admin_bar_menu', array($this, 'espressoToolbarItems'), 100);
-        $this->enqueueAssets();
-    }
-
-
-    /**
-     *    espresso_toolbar_items
-     *
-     * @access public
-     * @param  WP_Admin_Bar $admin_bar
-     * @return void
-     */
-    public function espressoToolbarItems(WP_Admin_Bar $admin_bar)
-    {
-        // if its an AJAX request, or user is NOT an admin, or in full M-Mode
-        if (defined('DOING_AJAX')
-            || ! $this->capabilities->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
-            || EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
-        ) {
-            return;
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->admin_bar = $admin_bar;
-        // we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
-        // because they're only defined in each of their respective constructors
-        // and this might be a frontend request, in which case they aren't available
-        $this->events_admin_url = admin_url('admin.php?page=espresso_events');
-        $this->reg_admin_url = admin_url('admin.php?page=espresso_registrations');
-        // now let's add all of the menu items
-        $this->addTopLevelMenu();
-        $this->addEventsSubMenu();
-        $this->addEventsAddEditHeader();
-        $this->addEventsAddNew();
-        $this->addEventsEditCurrentEvent();
-        $this->addEventsViewHeader();
-        $this->addEventsViewAll();
-        $this->addEventsViewToday();
-        $this->addEventsViewThisMonth();
-        $this->addRegistrationSubMenu();
-        $this->addRegistrationOverviewToday();
-        $this->addRegistrationOverviewTodayApproved();
-        $this->addRegistrationOverviewTodayPendingPayment();
-        $this->addRegistrationOverviewTodayNotApproved();
-        $this->addRegistrationOverviewTodayCancelled();
-        $this->addRegistrationOverviewThisMonth();
-        $this->addRegistrationOverviewThisMonthApproved();
-        $this->addRegistrationOverviewThisMonthPending();
-        $this->addRegistrationOverviewThisMonthNotApproved();
-        $this->addRegistrationOverviewThisMonthCancelled();
-        $this->addExtensionsAndServices();
-    }
-
-
-    /**
-     * @return void
-     */
-    private function enqueueAssets()
-    {
-        wp_register_style(
-            'espresso-admin-toolbar',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
-            array('dashicons'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso-admin-toolbar');
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addTopLevelMenu()
-    {
-        $this->admin_bar->add_menu(
-            array(
-                'id'    => 'espresso-toolbar',
-                'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
-                           . esc_html_x('Event Espresso', 'admin bar menu group label', 'event_espresso')
-                           . '</span>',
-                'href'  => $this->events_admin_url,
-                'meta'  => array(
-                    'title' => esc_html__('Event Espresso', 'event_espresso'),
-                    'class' => $this->menu_class . 'first',
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsSubMenu()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events'
-        )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Events', 'event_espresso'),
-                    'href'   => $this->events_admin_url,
-                    'meta'   => array(
-                        'title'  => esc_html__('Events', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsAddEditHeader()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-view'
-        )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-add-edit',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => esc_html__('Add / Edit', 'event_espresso'),
-                    'href'   => '',
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsAddNew()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_edit_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-new'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-new',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Add New', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array('action' => 'create_new'),
-                        $this->events_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Add New', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsEditCurrentEvent()
-    {
-        if (is_single() && (get_post_type() === 'espresso_events')) {
-            // Current post
-            global $post;
-            if ($this->capabilities->current_user_can(
-                'ee_edit_event',
-                'ee_admin_bar_menu_espresso-toolbar-events-edit',
-                $post->ID
-            )) {
-                $this->admin_bar->add_menu(
-                    array(
-                        'id'     => 'espresso-toolbar-events-edit',
-                        'parent' => 'espresso-toolbar-events',
-                        'title'  => '<span class="ee-toolbar-icon"></span>'
-                                    . esc_html__('Edit Event', 'event_espresso'),
-                        'href'   => EEH_URL::add_query_args_and_nonce(
-                            array(
-                                'action' => 'edit',
-                                'post'   => $post->ID,
-                            ),
-                            $this->events_admin_url
-                        ),
-                        'meta'   => array(
-                            'title'  => esc_html__('Edit Event', 'event_espresso'),
-                            'target' => '',
-                            'class'  => $this->menu_class,
-                        ),
-                    )
-                );
-            }
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewHeader()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-view'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-view',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => esc_html__('View', 'event_espresso'),
-                    'href'   => '',
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewAll()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-all'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-all',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('All', 'event_espresso'),
-                    'href'   => $this->events_admin_url,
-                    'meta'   => array(
-                        'title'  => esc_html__('All', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewToday()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-today'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-today',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Today', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action' => 'default',
-                            'status' => 'today',
-                        ),
-                        $this->events_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Today', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewThisMonth()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-month'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-month',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('This Month', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action' => 'default',
-                            'status' => 'month',
-                        ),
-                        $this->events_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('This Month', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationSubMenu()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Registrations', 'event_espresso'),
-                    'href'   => $this->reg_admin_url,
-                    'meta'   => array(
-                        'title'  => esc_html__('Registrations', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewToday()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => esc_html__('Today', 'event_espresso'),
-                    'href'   => '',
-                    'meta'   => array(
-                        'title'  => esc_html__('Today', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayApproved()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayPendingPayment()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-pending',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Pending', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_pending_payment,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Pending Payment', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayNotApproved()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-not-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Not Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_not_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Not Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayCancelled()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-cancelled',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Cancelled', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_cancelled,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Cancelled', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonth()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => esc_html__('This Month', 'event_espresso'),
-                    'href'   => '', // EEH_URL::add_query_args_and_nonce(
-                    //     array(
-                    //         'action' => 'default',
-                    //         'status' => 'month'
-                    //     ),
-                    //     $this->reg_admin_url
-                    // ),
-                    'meta'   => array(
-                        'title'  => esc_html__('This Month', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthApproved()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthPending()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-pending',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Pending', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_pending_payment,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Pending', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthNotApproved()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-not-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Not Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_not_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Not Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthCancelled()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-cancelled',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Cancelled', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_cancelled,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Cancelled', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addExtensionsAndServices()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_ee',
-            'ee_admin_bar_menu_espresso-toolbar-extensions-and-services'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-extensions-and-services',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Extensions & Services', 'event_espresso'),
-                    'href'   => admin_url('admin.php?page=espresso_packages'),
-                    'meta'   => array(
-                        'title'  => esc_html__('Extensions & Services', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
+	/**
+	 * @var WP_Admin_Bar $admin_bar
+	 */
+	private $admin_bar;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var string $events_admin_url
+	 */
+	private $events_admin_url;
+
+	/**
+	 * @var string $menu_class
+	 */
+	private $menu_class = 'espresso_menu_item_class';
+
+	/**
+	 * @var string $reg_admin_url
+	 */
+	private $reg_admin_url;
+
+
+	/**
+	 * AdminToolBar constructor.
+	 *
+	 * @param EE_Capabilities $capabilities
+	 */
+	public function __construct(EE_Capabilities $capabilities)
+	{
+		$this->capabilities = $capabilities;
+		add_action('admin_bar_menu', array($this, 'espressoToolbarItems'), 100);
+		$this->enqueueAssets();
+	}
+
+
+	/**
+	 *    espresso_toolbar_items
+	 *
+	 * @access public
+	 * @param  WP_Admin_Bar $admin_bar
+	 * @return void
+	 */
+	public function espressoToolbarItems(WP_Admin_Bar $admin_bar)
+	{
+		// if its an AJAX request, or user is NOT an admin, or in full M-Mode
+		if (defined('DOING_AJAX')
+			|| ! $this->capabilities->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
+			|| EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
+		) {
+			return;
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->admin_bar = $admin_bar;
+		// we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
+		// because they're only defined in each of their respective constructors
+		// and this might be a frontend request, in which case they aren't available
+		$this->events_admin_url = admin_url('admin.php?page=espresso_events');
+		$this->reg_admin_url = admin_url('admin.php?page=espresso_registrations');
+		// now let's add all of the menu items
+		$this->addTopLevelMenu();
+		$this->addEventsSubMenu();
+		$this->addEventsAddEditHeader();
+		$this->addEventsAddNew();
+		$this->addEventsEditCurrentEvent();
+		$this->addEventsViewHeader();
+		$this->addEventsViewAll();
+		$this->addEventsViewToday();
+		$this->addEventsViewThisMonth();
+		$this->addRegistrationSubMenu();
+		$this->addRegistrationOverviewToday();
+		$this->addRegistrationOverviewTodayApproved();
+		$this->addRegistrationOverviewTodayPendingPayment();
+		$this->addRegistrationOverviewTodayNotApproved();
+		$this->addRegistrationOverviewTodayCancelled();
+		$this->addRegistrationOverviewThisMonth();
+		$this->addRegistrationOverviewThisMonthApproved();
+		$this->addRegistrationOverviewThisMonthPending();
+		$this->addRegistrationOverviewThisMonthNotApproved();
+		$this->addRegistrationOverviewThisMonthCancelled();
+		$this->addExtensionsAndServices();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function enqueueAssets()
+	{
+		wp_register_style(
+			'espresso-admin-toolbar',
+			EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
+			array('dashicons'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso-admin-toolbar');
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addTopLevelMenu()
+	{
+		$this->admin_bar->add_menu(
+			array(
+				'id'    => 'espresso-toolbar',
+				'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
+						   . esc_html_x('Event Espresso', 'admin bar menu group label', 'event_espresso')
+						   . '</span>',
+				'href'  => $this->events_admin_url,
+				'meta'  => array(
+					'title' => esc_html__('Event Espresso', 'event_espresso'),
+					'class' => $this->menu_class . 'first',
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsSubMenu()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events'
+		)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Events', 'event_espresso'),
+					'href'   => $this->events_admin_url,
+					'meta'   => array(
+						'title'  => esc_html__('Events', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsAddEditHeader()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-view'
+		)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-add-edit',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => esc_html__('Add / Edit', 'event_espresso'),
+					'href'   => '',
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsAddNew()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_edit_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-new'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-new',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Add New', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array('action' => 'create_new'),
+						$this->events_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Add New', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsEditCurrentEvent()
+	{
+		if (is_single() && (get_post_type() === 'espresso_events')) {
+			// Current post
+			global $post;
+			if ($this->capabilities->current_user_can(
+				'ee_edit_event',
+				'ee_admin_bar_menu_espresso-toolbar-events-edit',
+				$post->ID
+			)) {
+				$this->admin_bar->add_menu(
+					array(
+						'id'     => 'espresso-toolbar-events-edit',
+						'parent' => 'espresso-toolbar-events',
+						'title'  => '<span class="ee-toolbar-icon"></span>'
+									. esc_html__('Edit Event', 'event_espresso'),
+						'href'   => EEH_URL::add_query_args_and_nonce(
+							array(
+								'action' => 'edit',
+								'post'   => $post->ID,
+							),
+							$this->events_admin_url
+						),
+						'meta'   => array(
+							'title'  => esc_html__('Edit Event', 'event_espresso'),
+							'target' => '',
+							'class'  => $this->menu_class,
+						),
+					)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewHeader()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-view'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-view',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => esc_html__('View', 'event_espresso'),
+					'href'   => '',
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewAll()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-all'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-all',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('All', 'event_espresso'),
+					'href'   => $this->events_admin_url,
+					'meta'   => array(
+						'title'  => esc_html__('All', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewToday()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-today'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-today',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Today', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action' => 'default',
+							'status' => 'today',
+						),
+						$this->events_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Today', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewThisMonth()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-month'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-month',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('This Month', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action' => 'default',
+							'status' => 'month',
+						),
+						$this->events_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('This Month', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationSubMenu()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Registrations', 'event_espresso'),
+					'href'   => $this->reg_admin_url,
+					'meta'   => array(
+						'title'  => esc_html__('Registrations', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewToday()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => esc_html__('Today', 'event_espresso'),
+					'href'   => '',
+					'meta'   => array(
+						'title'  => esc_html__('Today', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayApproved()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayPendingPayment()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-pending',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Pending', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_pending_payment,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Pending Payment', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayNotApproved()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-not-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Not Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_not_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Not Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayCancelled()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-cancelled',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Cancelled', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_cancelled,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Cancelled', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonth()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => esc_html__('This Month', 'event_espresso'),
+					'href'   => '', // EEH_URL::add_query_args_and_nonce(
+					//     array(
+					//         'action' => 'default',
+					//         'status' => 'month'
+					//     ),
+					//     $this->reg_admin_url
+					// ),
+					'meta'   => array(
+						'title'  => esc_html__('This Month', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthApproved()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthPending()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-pending',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Pending', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_pending_payment,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Pending', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthNotApproved()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-not-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Not Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_not_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Not Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthCancelled()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-cancelled',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Cancelled', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_cancelled,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Cancelled', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addExtensionsAndServices()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_ee',
+			'ee_admin_bar_menu_espresso-toolbar-extensions-and-services'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-extensions-and-services',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Extensions & Services', 'event_espresso'),
+					'href'   => admin_url('admin.php?page=espresso_packages'),
+					'meta'   => array(
+						'title'  => esc_html__('Extensions & Services', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
 }

core/db_models/EEM_Soft_Delete_Base.model.php

Doc Comments +2 added lines, -2 removed lines

@@ -205,7 +205,7 @@ 
      *
      * @param array  $query_params like EEM_Base::get_all
      * @param string $field_to_sum
-     * @return int
+     * @return double
      */
     public function sum_deleted($query_params = null, $field_to_sum = null)
     {
@@ -270,7 +270,7 @@ 
      * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
      *                                that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
      *                                which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
-     * @return boolean success
+     * @return integer success
      */
     public function delete_permanently($query_params = array(), $allow_blocking = true)
     {

Indentation +359 added lines, -359 removed lines

@@ -26,363 +26,363 @@
 abstract class EEM_Soft_Delete_Base extends EEM_Base
 {
 
-    /**
-     * @param null $timezone
-     */
-    protected function __construct($timezone = null)
-    {
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            $this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
-        }
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * Searches for field on this model of type 'deleted_flag'. if it is found,
-     * returns it's name.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function deleted_field_name()
-    {
-        $field = $this->get_a_field_of_type('EE_Trashed_Flag_Field');
-        if ($field) {
-            return $field->get_name();
-        } else {
-            throw new EE_Error(sprintf(__(
-                'We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
-                'event_espresso'
-            ), get_class($this), get_class($this)));
-        }
-    }
-
-
-
-    /**
-     * Gets one item that's been deleted, according to $query_params
-     *
-     * @param array $query_params like EEM_Base::get_all's $query_params
-     * @return EE_Soft_Delete_Base_Class
-     */
-    public function get_one_deleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::get_one($query_params);
-    }
-
-
-
-    /**
-     * Gets one item from the DB, regardless of whether it's been soft-deleted or not
-     *
-     * @param array $query_params like EEM_base::get_all's $query_params
-     * @return EE_Soft_Delete_Base_Class
-     */
-    public function get_one_deleted_or_undeleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::get_one($query_params);
-    }
-
-
-
-    /**
-     * Gets the item indicated by its ID. But if it's soft-deleted, pretends it doesn't exist.
-     *
-     * @param int|string $id
-     * @return EE_Soft_Delete_Base_Class
-     */
-    public function get_one_by_ID_but_ignore_deleted($id)
-    {
-        return $this->get_one(
-            $this->alter_query_params_to_restrict_by_ID(
-                $id,
-                array('default_where_conditions' => 'default')
-            )
-        );
-    }
-
-
-
-    /**
-     * Counts all the deleted/trashed items
-     *
-     * @param array  $query_params like EEM_Base::get_all
-     * @param string $field_to_count
-     * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
-     * @return int
-     */
-    public function count_deleted($query_params = null, $field_to_count = null, $distinct = false)
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::count($query_params, $field_to_count, $distinct);
-    }
-
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @param array $query_params like EEM_Base::get_all's $query_params
-     * @return array like EEM_Base::get_all's $query_params
-     */
-    protected function _alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params[0][ $deletedFlagFieldName ] = true;
-        return $query_params;
-    }
-
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @param array $query_params like EEM_Base::get_all's $query_params
-     * @return array like EEM_Base::get_all's $query_params
-     */
-    public function alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        return $this->_alter_query_params_so_only_trashed_items_included($query_params);
-    }
-
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    public function alter_query_params_so_deleted_and_undeleted_items_included($query_params = array())
-    {
-        return $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-    }
-
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
-    {
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = 'minimum';
-        }
-        return $query_params;
-    }
-
-
-
-    /**
-     * Counts all deleted and undeleted items
-     *
-     * @param array  $query_params like EEM_Base::get_all
-     * @param string $field_to_count
-     * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
-     * @return int
-     */
-    public function count_deleted_and_undeleted($query_params = null, $field_to_count = null, $distinct = false)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::count($query_params, $field_to_count, $distinct);
-    }
-
-
-
-    /**
-     * Sum all the deleted items.
-     *
-     * @param array  $query_params like EEM_Base::get_all
-     * @param string $field_to_sum
-     * @return int
-     */
-    public function sum_deleted($query_params = null, $field_to_sum = null)
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::sum($query_params, $field_to_sum);
-    }
-
-
-
-    /**
-     * Sums all the deleted and undeleted items.
-     *
-     * @param array  $query_params lik eEEM_Base::get_all
-     * @param string $field_to_sum
-     * @return int
-     */
-    public function sum_deleted_and_undeleted($query_params = null, $field_to_sum = null)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        parent::sum($query_params, $field_to_sum);
-    }
-
-
-
-    /**
-     * Gets all deleted and undeleted mode objects from the db that meet the criteria, regardless of
-     * whether they've been soft-deleted or not
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Soft_Delete_Base_Class[]
-     */
-    public function get_all_deleted_and_undeleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::get_all($query_params);
-    }
-
-
-
-    /**
-     * For 'soft deletable' models, gets all which ARE deleted, according to conditions specified in $query_params.
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Soft_Delete_Base_Class[]
-     */
-    public function get_all_deleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::get_all($query_params);
-    }
-
-
-
-    /**
-     * Permanently deletes the selected rows. When selecting rows for deletion, ignores
-     * whether they've been soft-deleted or not. (ie, you don't have to soft-delete objects
-     * before you can permanently delete them).
-     * Because this will cause a real deletion, related models may block this deletion (ie, add an error
-     * and abort the delete)
-     *
-     * @param array   $query_params   like EEM_Base::get_all
-     * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
-     *                                that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
-     *                                which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
-     * @return boolean success
-     */
-    public function delete_permanently($query_params = array(), $allow_blocking = true)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::delete_permanently($query_params, $allow_blocking);
-    }
-
-
-
-    /**
-     * Restores a particular item by its ID (primary key). Ignores the fact whether the item
-     * has been soft-deleted or not.
-     *
-     * @param mixed $ID int if primary key is an int, string otherwise
-     * @return boolean success
-     */
-    public function restore_by_ID($ID = false)
-    {
-        return $this->delete_or_restore_by_ID(false, $ID);
-    }
-
-
-
-    /**
-     * For deleting or restoring a particular item. Note that this model is a SOFT-DELETABLE model! However,
-     * this function will ignore whether the items have been soft-deleted or not.
-     *
-     * @param boolean $delete true for delete, false for restore
-     * @param mixed   $ID     int if primary key is an int, string otherwise
-     * @return boolean
-     */
-    public function delete_or_restore_by_ID($delete = true, $ID = false)
-    {
-        if (! $ID) {
-            return false;
-        }
-        if ($this->delete_or_restore(
-            $delete,
-            $this->alter_query_params_to_restrict_by_ID($ID)
-        )
-        ) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Overrides parent's 'delete' method to instead do a soft delete on all rows that
-     * meet the criteria in $where_col_n_values. This particular function ignores whether the items have been soft-deleted or not.
-     * Note: because this item will be soft-deleted only,
-     * doesn't block because of model dependencies
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @param bool  $block_deletes
-     * @return boolean
-     */
-    public function delete($query_params = array(), $block_deletes = false)
-    {
-        // no matter what, we WON'T block soft deletes.
-        return $this->delete_or_restore(true, $query_params);
-    }
-
-
-
-    /**
-     * 'Un-deletes' the chosen items. Note that this model is a SOFT-DELETABLE model! That means that, by default, trashed/soft-deleted
-     * items are ignored in queries. However, this particular function ignores whether the items have been soft-deleted or not.
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return boolean
-     */
-    public function restore($query_params = array())
-    {
-        return $this->delete_or_restore(false, $query_params);
-    }
-
-
-
-    /**
-     * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
-     *
-     * @param boolean $delete       true to indicate deletion, false to indicate restoration
-     * @param array   $query_params like EEM_Base::get_all
-     * @return boolean
-     */
-    public function delete_or_restore($delete = true, $query_params = array())
-    {
-        $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        if ($this->update(array($deletedFlagFieldName => $delete), $query_params)) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Updates all the items of this model which match the $query params, regardless of whether
-     * they've been soft-deleted or not
-     *
-     * @param array   $fields_n_values         like EEM_Base::update's $fields_n_value
-     * @param array   $query_params            like EEM_base::get_all's $query_params
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
-     *                                         in this model's entity map according to $fields_n_values that match $query_params. This
-     *                                         obviously has some overhead, so you can disable it by setting this to FALSE, but
-     *                                         be aware that model objects being used could get out-of-sync with the database
-     * @return int number of items updated
-     */
-    public function update_deleted_and_undeleted($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return $this->update($fields_n_values, $query_params, $keep_model_objs_in_sync);
-    }
+	/**
+	 * @param null $timezone
+	 */
+	protected function __construct($timezone = null)
+	{
+		if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			$this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
+		}
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * Searches for field on this model of type 'deleted_flag'. if it is found,
+	 * returns it's name.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function deleted_field_name()
+	{
+		$field = $this->get_a_field_of_type('EE_Trashed_Flag_Field');
+		if ($field) {
+			return $field->get_name();
+		} else {
+			throw new EE_Error(sprintf(__(
+				'We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
+				'event_espresso'
+			), get_class($this), get_class($this)));
+		}
+	}
+
+
+
+	/**
+	 * Gets one item that's been deleted, according to $query_params
+	 *
+	 * @param array $query_params like EEM_Base::get_all's $query_params
+	 * @return EE_Soft_Delete_Base_Class
+	 */
+	public function get_one_deleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::get_one($query_params);
+	}
+
+
+
+	/**
+	 * Gets one item from the DB, regardless of whether it's been soft-deleted or not
+	 *
+	 * @param array $query_params like EEM_base::get_all's $query_params
+	 * @return EE_Soft_Delete_Base_Class
+	 */
+	public function get_one_deleted_or_undeleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::get_one($query_params);
+	}
+
+
+
+	/**
+	 * Gets the item indicated by its ID. But if it's soft-deleted, pretends it doesn't exist.
+	 *
+	 * @param int|string $id
+	 * @return EE_Soft_Delete_Base_Class
+	 */
+	public function get_one_by_ID_but_ignore_deleted($id)
+	{
+		return $this->get_one(
+			$this->alter_query_params_to_restrict_by_ID(
+				$id,
+				array('default_where_conditions' => 'default')
+			)
+		);
+	}
+
+
+
+	/**
+	 * Counts all the deleted/trashed items
+	 *
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @param string $field_to_count
+	 * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
+	 * @return int
+	 */
+	public function count_deleted($query_params = null, $field_to_count = null, $distinct = false)
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::count($query_params, $field_to_count, $distinct);
+	}
+
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @param array $query_params like EEM_Base::get_all's $query_params
+	 * @return array like EEM_Base::get_all's $query_params
+	 */
+	protected function _alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		$deletedFlagFieldName = $this->deleted_field_name();
+		$query_params[0][ $deletedFlagFieldName ] = true;
+		return $query_params;
+	}
+
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @param array $query_params like EEM_Base::get_all's $query_params
+	 * @return array like EEM_Base::get_all's $query_params
+	 */
+	public function alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		return $this->_alter_query_params_so_only_trashed_items_included($query_params);
+	}
+
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	public function alter_query_params_so_deleted_and_undeleted_items_included($query_params = array())
+	{
+		return $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+	}
+
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
+	{
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = 'minimum';
+		}
+		return $query_params;
+	}
+
+
+
+	/**
+	 * Counts all deleted and undeleted items
+	 *
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @param string $field_to_count
+	 * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
+	 * @return int
+	 */
+	public function count_deleted_and_undeleted($query_params = null, $field_to_count = null, $distinct = false)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::count($query_params, $field_to_count, $distinct);
+	}
+
+
+
+	/**
+	 * Sum all the deleted items.
+	 *
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @param string $field_to_sum
+	 * @return int
+	 */
+	public function sum_deleted($query_params = null, $field_to_sum = null)
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::sum($query_params, $field_to_sum);
+	}
+
+
+
+	/**
+	 * Sums all the deleted and undeleted items.
+	 *
+	 * @param array  $query_params lik eEEM_Base::get_all
+	 * @param string $field_to_sum
+	 * @return int
+	 */
+	public function sum_deleted_and_undeleted($query_params = null, $field_to_sum = null)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		parent::sum($query_params, $field_to_sum);
+	}
+
+
+
+	/**
+	 * Gets all deleted and undeleted mode objects from the db that meet the criteria, regardless of
+	 * whether they've been soft-deleted or not
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Soft_Delete_Base_Class[]
+	 */
+	public function get_all_deleted_and_undeleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::get_all($query_params);
+	}
+
+
+
+	/**
+	 * For 'soft deletable' models, gets all which ARE deleted, according to conditions specified in $query_params.
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Soft_Delete_Base_Class[]
+	 */
+	public function get_all_deleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::get_all($query_params);
+	}
+
+
+
+	/**
+	 * Permanently deletes the selected rows. When selecting rows for deletion, ignores
+	 * whether they've been soft-deleted or not. (ie, you don't have to soft-delete objects
+	 * before you can permanently delete them).
+	 * Because this will cause a real deletion, related models may block this deletion (ie, add an error
+	 * and abort the delete)
+	 *
+	 * @param array   $query_params   like EEM_Base::get_all
+	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
+	 *                                that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
+	 *                                which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
+	 * @return boolean success
+	 */
+	public function delete_permanently($query_params = array(), $allow_blocking = true)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::delete_permanently($query_params, $allow_blocking);
+	}
+
+
+
+	/**
+	 * Restores a particular item by its ID (primary key). Ignores the fact whether the item
+	 * has been soft-deleted or not.
+	 *
+	 * @param mixed $ID int if primary key is an int, string otherwise
+	 * @return boolean success
+	 */
+	public function restore_by_ID($ID = false)
+	{
+		return $this->delete_or_restore_by_ID(false, $ID);
+	}
+
+
+
+	/**
+	 * For deleting or restoring a particular item. Note that this model is a SOFT-DELETABLE model! However,
+	 * this function will ignore whether the items have been soft-deleted or not.
+	 *
+	 * @param boolean $delete true for delete, false for restore
+	 * @param mixed   $ID     int if primary key is an int, string otherwise
+	 * @return boolean
+	 */
+	public function delete_or_restore_by_ID($delete = true, $ID = false)
+	{
+		if (! $ID) {
+			return false;
+		}
+		if ($this->delete_or_restore(
+			$delete,
+			$this->alter_query_params_to_restrict_by_ID($ID)
+		)
+		) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Overrides parent's 'delete' method to instead do a soft delete on all rows that
+	 * meet the criteria in $where_col_n_values. This particular function ignores whether the items have been soft-deleted or not.
+	 * Note: because this item will be soft-deleted only,
+	 * doesn't block because of model dependencies
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @param bool  $block_deletes
+	 * @return boolean
+	 */
+	public function delete($query_params = array(), $block_deletes = false)
+	{
+		// no matter what, we WON'T block soft deletes.
+		return $this->delete_or_restore(true, $query_params);
+	}
+
+
+
+	/**
+	 * 'Un-deletes' the chosen items. Note that this model is a SOFT-DELETABLE model! That means that, by default, trashed/soft-deleted
+	 * items are ignored in queries. However, this particular function ignores whether the items have been soft-deleted or not.
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return boolean
+	 */
+	public function restore($query_params = array())
+	{
+		return $this->delete_or_restore(false, $query_params);
+	}
+
+
+
+	/**
+	 * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
+	 *
+	 * @param boolean $delete       true to indicate deletion, false to indicate restoration
+	 * @param array   $query_params like EEM_Base::get_all
+	 * @return boolean
+	 */
+	public function delete_or_restore($delete = true, $query_params = array())
+	{
+		$deletedFlagFieldName = $this->deleted_field_name();
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		if ($this->update(array($deletedFlagFieldName => $delete), $query_params)) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Updates all the items of this model which match the $query params, regardless of whether
+	 * they've been soft-deleted or not
+	 *
+	 * @param array   $fields_n_values         like EEM_Base::update's $fields_n_value
+	 * @param array   $query_params            like EEM_base::get_all's $query_params
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
+	 *                                         in this model's entity map according to $fields_n_values that match $query_params. This
+	 *                                         obviously has some overhead, so you can disable it by setting this to FALSE, but
+	 *                                         be aware that model objects being used could get out-of-sync with the database
+	 * @return int number of items updated
+	 */
+	public function update_deleted_and_undeleted($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return $this->update($fields_n_values, $query_params, $keep_model_objs_in_sync);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -31,7 +31,7 @@ 
      */
     protected function __construct($timezone = null)
     {
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+        if ( ! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
             $this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
         }
         parent::__construct($timezone);
@@ -132,7 +132,7 @@ 
     protected function _alter_query_params_so_only_trashed_items_included($query_params)
     {
         $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params[0][ $deletedFlagFieldName ] = true;
+        $query_params[0][$deletedFlagFieldName] = true;
         return $query_params;
     }
 
@@ -172,7 +172,7 @@ 
      */
     protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
     {
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = 'minimum';
         }
         return $query_params;
@@ -300,7 +300,7 @@ 
      */
     public function delete_or_restore_by_ID($delete = true, $ID = false)
     {
-        if (! $ID) {
+        if ( ! $ID) {
             return false;
         }
         if ($this->delete_or_restore(

caffeinated/admin/extend/messages/Custom_Messages_Template_List_Table.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -151,7 +151,7 @@
      * This provides a count of events using this custom template
      *
      * @param  EE_Message_Template_Group $item message_template group data
-     * @return string column output
+     * @return integer column output
      */
     public function column_events($item)
     {

Indentation +225 added lines, -225 removed lines

@@ -12,252 +12,252 @@
 class Custom_Messages_Template_List_Table extends Messages_Template_List_Table
 {
 
-    /**
-     * Setup initial data.
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->get_admin_page()->get_message_templates(
-            $this->_per_page,
-            $this->_view,
-            false,
-            false,
-            false
-        );
-        $this->_all_data_count = $this->get_admin_page()->get_message_templates(
-            $this->_per_page,
-            $this->_view,
-            true,
-            true,
-            false
-        );
-    }
+	/**
+	 * Setup initial data.
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->get_admin_page()->get_message_templates(
+			$this->_per_page,
+			$this->_view,
+			false,
+			false,
+			false
+		);
+		$this->_all_data_count = $this->get_admin_page()->get_message_templates(
+			$this->_per_page,
+			$this->_view,
+			true,
+			true,
+			false
+		);
+	}
 
 
-    /**
-     * Set initial properties
-     */
-    protected function _set_properties()
-    {
-        parent::_set_properties();
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('Message Template Group', 'event_espresso'),
-            'plural'   => esc_html__('Message Template', 'event_espresso'),
-            'ajax'     => true, // for now,
-            'screen'   => $this->get_admin_page()->get_current_screen()->id,
-        );
+	/**
+	 * Set initial properties
+	 */
+	protected function _set_properties()
+	{
+		parent::_set_properties();
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('Message Template Group', 'event_espresso'),
+			'plural'   => esc_html__('Message Template', 'event_espresso'),
+			'ajax'     => true, // for now,
+			'screen'   => $this->get_admin_page()->get_current_screen()->id,
+		);
 
-        $this->_columns = array_merge(
-            array(
-                'cb'   => '<input type="checkbox" />',
-                'name' => esc_html__('Template Name', 'event_espresso'),
-            ),
-            $this->_columns,
-            array(
-                'events'  => esc_html__('Events', 'event_espresso'),
-                'actions' => '',
-            )
-        );
-    }
+		$this->_columns = array_merge(
+			array(
+				'cb'   => '<input type="checkbox" />',
+				'name' => esc_html__('Template Name', 'event_espresso'),
+			),
+			$this->_columns,
+			array(
+				'events'  => esc_html__('Events', 'event_espresso'),
+				'actions' => '',
+			)
+		);
+	}
 
 
-    /**
-     * Custom message for when there are no items found.
-     *
-     * @since 4.3.0
-     */
-    public function no_items()
-    {
-        if ($this->_view !== 'trashed') {
-            printf(
-                esc_html__(
-                    '%sNo Custom Templates found.%s To create your first custom message template, go to the "Default Message Templates" tab and click the "Create Custom" button next to the template you want to use as a base for the new one.',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>'
-            );
-        } else {
-            parent::no_items();
-        }
-    }
+	/**
+	 * Custom message for when there are no items found.
+	 *
+	 * @since 4.3.0
+	 */
+	public function no_items()
+	{
+		if ($this->_view !== 'trashed') {
+			printf(
+				esc_html__(
+					'%sNo Custom Templates found.%s To create your first custom message template, go to the "Default Message Templates" tab and click the "Create Custom" button next to the template you want to use as a base for the new one.',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>'
+			);
+		} else {
+			parent::no_items();
+		}
+	}
 
 
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function column_cb($item)
-    {
-        return sprintf('<input type="checkbox" name="checkbox[%s]" value="1" />', $item->GRP_ID());
-    }
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function column_cb($item)
+	{
+		return sprintf('<input type="checkbox" name="checkbox[%s]" value="1" />', $item->GRP_ID());
+	}
 
 
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function column_name($item)
-    {
-        return '<p>' . $item->name() . '</p>';
-    }
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function column_name($item)
+	{
+		return '<p>' . $item->name() . '</p>';
+	}
 
 
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function column_actions($item)
-    {
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_messages',
-            'espresso_messages_add_new_message_template'
-        )) {
-            $create_args = array(
-                'GRP_ID'       => $item->ID(),
-                'messenger'    => $item->messenger(),
-                'message_type' => $item->message_type(),
-                'action'       => 'add_new_message_template',
-            );
-            $create_link = EE_Admin_Page::add_query_args_and_nonce($create_args, EE_MSG_ADMIN_URL);
-            return sprintf(
-                '<p><a href="%s" class="button button-small">%s</a></p>',
-                $create_link,
-                esc_html__('Create Custom', 'event_espresso')
-            );
-        }
-        return '';
-    }
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function column_actions($item)
+	{
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_messages',
+			'espresso_messages_add_new_message_template'
+		)) {
+			$create_args = array(
+				'GRP_ID'       => $item->ID(),
+				'messenger'    => $item->messenger(),
+				'message_type' => $item->message_type(),
+				'action'       => 'add_new_message_template',
+			);
+			$create_link = EE_Admin_Page::add_query_args_and_nonce($create_args, EE_MSG_ADMIN_URL);
+			return sprintf(
+				'<p><a href="%s" class="button button-small">%s</a></p>',
+				$create_link,
+				esc_html__('Create Custom', 'event_espresso')
+			);
+		}
+		return '';
+	}
 
-    /**
-     * Set the view counts on the _views property
-     */
-    protected function _add_view_counts()
-    {
-        foreach ($this->_views as $view => $args) {
-            $this->_views[ $view ]['count'] = $this->get_admin_page()->get_message_templates(
-                $this->_per_page,
-                $view,
-                true,
-                true,
-                false
-            );
-        }
-    }
+	/**
+	 * Set the view counts on the _views property
+	 */
+	protected function _add_view_counts()
+	{
+		foreach ($this->_views as $view => $args) {
+			$this->_views[ $view ]['count'] = $this->get_admin_page()->get_message_templates(
+				$this->_per_page,
+				$view,
+				true,
+				true,
+				false
+			);
+		}
+	}
 
 
-    /**
-     * column_events
-     * This provides a count of events using this custom template
-     *
-     * @param  EE_Message_Template_Group $item message_template group data
-     * @return string column output
-     */
-    public function column_events($item)
-    {
-        return $item->count_events();
-    }
+	/**
+	 * column_events
+	 * This provides a count of events using this custom template
+	 *
+	 * @param  EE_Message_Template_Group $item message_template group data
+	 * @return string column output
+	 */
+	public function column_events($item)
+	{
+		return $item->count_events();
+	}
 
 
-    /**
-     * Add additional actions for custom message template list view.
-     *
-     * @param EE_Message_Template_Group $item
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_actions_for_messenger_column(EE_Message_Template_Group $item)
-    {
-        $actions = parent::_get_actions_for_messenger_column($item);
+	/**
+	 * Add additional actions for custom message template list view.
+	 *
+	 * @param EE_Message_Template_Group $item
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_actions_for_messenger_column(EE_Message_Template_Group $item)
+	{
+		$actions = parent::_get_actions_for_messenger_column($item);
 
-        // add additional actions for trash/restore etc.
-        $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action'   => 'trash_message_template',
-            'id'       => $item->GRP_ID(),
-            'noheader' => true,
-        ), EE_MSG_ADMIN_URL);
-        // restore link
-        $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action'   => 'restore_message_template',
-            'id'       => $item->GRP_ID(),
-            'noheader' => true,
-        ), EE_MSG_ADMIN_URL);
-        // delete price link
-        $delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action'   => 'delete_message_template',
-            'id'       => $item->GRP_ID(),
-            'noheader' => true,
-        ), EE_MSG_ADMIN_URL);
+		// add additional actions for trash/restore etc.
+		$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action'   => 'trash_message_template',
+			'id'       => $item->GRP_ID(),
+			'noheader' => true,
+		), EE_MSG_ADMIN_URL);
+		// restore link
+		$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action'   => 'restore_message_template',
+			'id'       => $item->GRP_ID(),
+			'noheader' => true,
+		), EE_MSG_ADMIN_URL);
+		// delete price link
+		$delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action'   => 'delete_message_template',
+			'id'       => $item->GRP_ID(),
+			'noheader' => true,
+		), EE_MSG_ADMIN_URL);
 
-        if (! $item->get('MTP_deleted')
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_message',
-                'espresso_messages_trash_message_template',
-                $item->ID()
-            )
-        ) {
-            $actions['trash'] = '<a href="'
-                                . $trash_lnk_url
-                                . '" title="'
-                                . esc_attr__('Move Template Group to Trash', 'event_espresso')
-                                . '">'
-                                . esc_html__('Move to Trash', 'event_espresso')
-                                . '</a>';
-        } else {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_message',
-                'espresso_messages_restore_message_template',
-                $item->ID()
-            )) {
-                $actions['restore'] = '<a href="'
-                                      . $restore_lnk_url
-                                      . '" title="'
-                                      . esc_attr__('Restore Message Template', 'event_espresso')
-                                      . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
-            }
+		if (! $item->get('MTP_deleted')
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_message',
+				'espresso_messages_trash_message_template',
+				$item->ID()
+			)
+		) {
+			$actions['trash'] = '<a href="'
+								. $trash_lnk_url
+								. '" title="'
+								. esc_attr__('Move Template Group to Trash', 'event_espresso')
+								. '">'
+								. esc_html__('Move to Trash', 'event_espresso')
+								. '</a>';
+		} else {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_message',
+				'espresso_messages_restore_message_template',
+				$item->ID()
+			)) {
+				$actions['restore'] = '<a href="'
+									  . $restore_lnk_url
+									  . '" title="'
+									  . esc_attr__('Restore Message Template', 'event_espresso')
+									  . '">'
+									  . esc_html__('Restore', 'event_espresso') . '</a>';
+			}
 
-            if ($this->_view === 'trashed'
-                && EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_message',
-                    'espresso_messages_delete_message_template',
-                    $item->ID()
-                )) {
-                $actions['delete'] = '<a href="'
-                                     . $delete_lnk_url
-                                     . '" title="'
-                                     . esc_attr__('Delete Template Group Permanently', 'event_espresso')
-                                     . '">'
-                                     . esc_html__('Delete Permanently', 'event_espresso')
-                                     . '</a>';
-            }
-        }
-        return $actions;
-    }
+			if ($this->_view === 'trashed'
+				&& EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_message',
+					'espresso_messages_delete_message_template',
+					$item->ID()
+				)) {
+				$actions['delete'] = '<a href="'
+									 . $delete_lnk_url
+									 . '" title="'
+									 . esc_attr__('Delete Template Group Permanently', 'event_espresso')
+									 . '">'
+									 . esc_html__('Delete Permanently', 'event_espresso')
+									 . '</a>';
+			}
+		}
+		return $actions;
+	}
 
 
-    /**
-     * Generate dropdown filter select input for messengers
-     *
-     * @param bool $global
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_messengers_dropdown_filter($global = true)
-    {
-        return parent::_get_messengers_dropdown_filter(false);
-    }
+	/**
+	 * Generate dropdown filter select input for messengers
+	 *
+	 * @param bool $global
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_messengers_dropdown_filter($global = true)
+	{
+		return parent::_get_messengers_dropdown_filter(false);
+	}
 
 
-    /**
-     * Generate dropdown filter select input for message types
-     *
-     * @param bool $global
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_message_types_dropdown_filter($global = true)
-    {
-        return parent::_get_message_types_dropdown_filter(false);
-    }
+	/**
+	 * Generate dropdown filter select input for message types
+	 *
+	 * @param bool $global
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_message_types_dropdown_filter($global = true)
+	{
+		return parent::_get_message_types_dropdown_filter(false);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -99,7 +99,7 @@ 
      */
     public function column_name($item)
     {
-        return '<p>' . $item->name() . '</p>';
+        return '<p>'.$item->name().'</p>';
     }
 
 
@@ -135,7 +135,7 @@ 
     protected function _add_view_counts()
     {
         foreach ($this->_views as $view => $args) {
-            $this->_views[ $view ]['count'] = $this->get_admin_page()->get_message_templates(
+            $this->_views[$view]['count'] = $this->get_admin_page()->get_message_templates(
                 $this->_per_page,
                 $view,
                 true,
@@ -189,7 +189,7 @@ 
             'noheader' => true,
         ), EE_MSG_ADMIN_URL);
 
-        if (! $item->get('MTP_deleted')
+        if ( ! $item->get('MTP_deleted')
             && EE_Registry::instance()->CAP->current_user_can(
                 'ee_delete_message',
                 'espresso_messages_trash_message_template',
@@ -214,7 +214,7 @@ 
                                       . '" title="'
                                       . esc_attr__('Restore Message Template', 'event_espresso')
                                       . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
+                                      . esc_html__('Restore', 'event_espresso').'</a>';
             }
 
             if ($this->_view === 'trashed'

core/libraries/messages/EE_Message_Template_Group_Collection.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
     /**
      * This retrieves any EE_Message_Template_Group in the repo by its ID.
      *
-     * @param $GRP_ID
+     * @param integer $GRP_ID
      * @return EE_Message_Template_Group | null
      */
     public function get_by_ID($GRP_ID)

Indentation +100 added lines, -100 removed lines

@@ -14,115 +14,115 @@
 {
 
 
-    /**
-     * EE_Message_Template_Group_Collection constructor.
-     */
-    public function __construct()
-    {
-        $this->interface = 'EE_Message_Template_Group';
-    }
+	/**
+	 * EE_Message_Template_Group_Collection constructor.
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EE_Message_Template_Group';
+	}
 
 
-    /**
-     * Adds the Message Template Group object to the repository.
-     *
-     * @param           $message_template_group
-     * @param array|int $EVT_ID    Some templates are specific to EVT, so this is provided as a way of
-     *                         indexing the template by key.  If this template is shared among multiple events then
-     *                         include the events as an array.
-     * @return bool
-     */
-    public function add($message_template_group, $EVT_ID = array())
-    {
-        $EVT_ID = is_array($EVT_ID) ? $EVT_ID : (array) $EVT_ID;
-        if ($message_template_group instanceof $this->interface) {
-            $data['key'] = $this->getKey(
-                $message_template_group->messenger(),
-                $message_template_group->message_type(),
-                $EVT_ID
-            );
-            return parent::add($message_template_group, $data);
-        }
-        return false;
-    }
+	/**
+	 * Adds the Message Template Group object to the repository.
+	 *
+	 * @param           $message_template_group
+	 * @param array|int $EVT_ID    Some templates are specific to EVT, so this is provided as a way of
+	 *                         indexing the template by key.  If this template is shared among multiple events then
+	 *                         include the events as an array.
+	 * @return bool
+	 */
+	public function add($message_template_group, $EVT_ID = array())
+	{
+		$EVT_ID = is_array($EVT_ID) ? $EVT_ID : (array) $EVT_ID;
+		if ($message_template_group instanceof $this->interface) {
+			$data['key'] = $this->getKey(
+				$message_template_group->messenger(),
+				$message_template_group->message_type(),
+				$EVT_ID
+			);
+			return parent::add($message_template_group, $data);
+		}
+		return false;
+	}
 
 
-    /**
-     * This retrieves any EE_Message_Template_Group in the repo by its ID.
-     *
-     * @param $GRP_ID
-     * @return EE_Message_Template_Group | null
-     */
-    public function get_by_ID($GRP_ID)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current()->ID() === $GRP_ID) {
-                /** @var EE_Message_Template_Group $message_template_group */
-                $message_template_group = $this->current();
-                $this->rewind();
-                return $message_template_group;
-            }
-            $this->next();
-        }
-        return null;
-    }
+	/**
+	 * This retrieves any EE_Message_Template_Group in the repo by its ID.
+	 *
+	 * @param $GRP_ID
+	 * @return EE_Message_Template_Group | null
+	 */
+	public function get_by_ID($GRP_ID)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current()->ID() === $GRP_ID) {
+				/** @var EE_Message_Template_Group $message_template_group */
+				$message_template_group = $this->current();
+				$this->rewind();
+				return $message_template_group;
+			}
+			$this->next();
+		}
+		return null;
+	}
 
 
-    /**
-     * Generates a hash used to identify a given Message Template Group.
-     *
-     * @param string $messenger    The EE_messenger->name
-     * @param string $message_type The EE_message_type->name
-     * @param int    $EVT_ID       Optional.  If the template is for a specific EVT then that should be included.
-     * @deprecated 4.9.40.rc.017  Use getKey instead.
-     * @return string
-     */
-    public function get_key($messenger, $message_type, $EVT_ID = 0)
-    {
-        $EVT_ID = (array) $EVT_ID;
-        return $this->getKey($messenger, $message_type, $EVT_ID);
-    }
+	/**
+	 * Generates a hash used to identify a given Message Template Group.
+	 *
+	 * @param string $messenger    The EE_messenger->name
+	 * @param string $message_type The EE_message_type->name
+	 * @param int    $EVT_ID       Optional.  If the template is for a specific EVT then that should be included.
+	 * @deprecated 4.9.40.rc.017  Use getKey instead.
+	 * @return string
+	 */
+	public function get_key($messenger, $message_type, $EVT_ID = 0)
+	{
+		$EVT_ID = (array) $EVT_ID;
+		return $this->getKey($messenger, $message_type, $EVT_ID);
+	}
 
 
-    /**
-     * Generates a hash used to identify a given Message Template Group
-     * @param string    $messenger      The EE_messenger->name
-     * @param string    $message_type   The EE_message_type->name
-     * @param array     $EVT_ID         Optional.  If the template is for a specific EVT_ID (or events) then that should
-     *                                  be included.
-     * @since 4.9.40.rc.017
-     * @return string
-     */
-    public function getKey($messenger, $message_type, array $EVT_ID = array())
-    {
-        sort($EVT_ID);
-        $EVT_ID = implode(',', array_unique($EVT_ID));
-        return md5($messenger . $message_type . $EVT_ID);
-    }
+	/**
+	 * Generates a hash used to identify a given Message Template Group
+	 * @param string    $messenger      The EE_messenger->name
+	 * @param string    $message_type   The EE_message_type->name
+	 * @param array     $EVT_ID         Optional.  If the template is for a specific EVT_ID (or events) then that should
+	 *                                  be included.
+	 * @since 4.9.40.rc.017
+	 * @return string
+	 */
+	public function getKey($messenger, $message_type, array $EVT_ID = array())
+	{
+		sort($EVT_ID);
+		$EVT_ID = implode(',', array_unique($EVT_ID));
+		return md5($messenger . $message_type . $EVT_ID);
+	}
 
 
-    /**
-     * This returns a saved EE_Message_Template_Group object if there is one in the repository indexed by a key matching
-     * the given string.
-     *
-     * @param string $key @see EE_Message_Template_Group::get_key() to setup a key formatted for searching.
-     * @return null|EE_Message_Template_Group
-     */
-    public function get_by_key($key)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $data = $this->getInfo();
-            if (isset($data['key']) && $data['key'] === $key) {
-                /** @var EE_Message_Template_Group $message_template_group */
-                $message_template_group = $this->current();
-                $this->rewind();
-                return $message_template_group;
-            }
-            $this->next();
-        }
-        return null;
-    }
+	/**
+	 * This returns a saved EE_Message_Template_Group object if there is one in the repository indexed by a key matching
+	 * the given string.
+	 *
+	 * @param string $key @see EE_Message_Template_Group::get_key() to setup a key formatted for searching.
+	 * @return null|EE_Message_Template_Group
+	 */
+	public function get_by_key($key)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$data = $this->getInfo();
+			if (isset($data['key']) && $data['key'] === $key) {
+				/** @var EE_Message_Template_Group $message_template_group */
+				$message_template_group = $this->current();
+				$this->rewind();
+				return $message_template_group;
+			}
+			$this->next();
+		}
+		return null;
+	}
 
 }

Spacing +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
     {
         sort($EVT_ID);
         $EVT_ID = implode(',', array_unique($EVT_ID));
-        return md5($messenger . $message_type . $EVT_ID);
+        return md5($messenger.$message_type.$EVT_ID);
     }