eventespresso / event-espresso-core

core/domain/Domain.php

Indentation +83 added lines, -83 removed lines

@@ -15,87 +15,87 @@
  */
 class Domain extends DomainBase implements CaffeinatedInterface
 {
-    /**
-     * URL path component used to denote an API request
-     */
-    const API_NAMESPACE = 'ee/v';
-
-    const ASSET_NAMESPACE = 'eventespresso';
-
-    const TEXT_DOMAIN = 'event_espresso';
-
-    /**
-     * Slug used for the context where a registration status is changed from a manual trigger in the Registration Admin
-     * Page ui.
-     */
-    const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN
-        = 'manual_registration_status_change_from_registration_admin';
-
-    const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
-        = 'manual_registration_status_change_from_registration_admin_and_notify';
-
-
-    /**
-     * Whether or not EE core is the full premium version.
-     * @since 4.9.59.p
-     * @var bool
-     */
-    private $caffeinated;
-
-    /**
-     * @since $VID:$
-     * @var bool
-     */
-    private $multisite;
-
-
-    public function __construct(FilePath $plugin_file, Version $version)
-    {
-        parent::__construct($plugin_file, $version);
-        $this->setCaffeinated();
-        $this->multisite = is_multisite();
-    }
-
-    /**
-     * Whether or not EE core is the full premium version.
-     * @since 4.9.59.p
-     * @return bool
-     */
-    public function isCaffeinated()
-    {
-        return $this->caffeinated;
-    }
-
-
-    /**
-     * Setter for $is_caffeinated property.
-     * @since 4.9.59.p
-     */
-    private function setCaffeinated()
-    {
-        $this->caffeinated = (! defined('EE_DECAF') || EE_DECAF !== true)
-            && is_readable($this->pluginPath() . 'caffeinated/brewing_regular.php');
-    }
-
-
-    /**
-     * This should be used everywhere the Event Espresso brand name is referenced in public facing interfaces
-     * to allow for filtering the brand.
-     *
-     * @return string
-     */
-    public static function brandName()
-    {
-        return (string) apply_filters('FHEE__EventEspresso_core_domain_Domain__brandName', 'Event Espresso');
-    }
-
-
-    /**
-     * @return bool
-     * @since $VID:$
-     */
-    public function isMultiSite(): bool
-    {
-        return $this->multisite;
-    }
+	/**
+	 * URL path component used to denote an API request
+	 */
+	const API_NAMESPACE = 'ee/v';
+
+	const ASSET_NAMESPACE = 'eventespresso';
+
+	const TEXT_DOMAIN = 'event_espresso';
+
+	/**
+	 * Slug used for the context where a registration status is changed from a manual trigger in the Registration Admin
+	 * Page ui.
+	 */
+	const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN
+		= 'manual_registration_status_change_from_registration_admin';
+
+	const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
+		= 'manual_registration_status_change_from_registration_admin_and_notify';
+
+
+	/**
+	 * Whether or not EE core is the full premium version.
+	 * @since 4.9.59.p
+	 * @var bool
+	 */
+	private $caffeinated;
+
+	/**
+	 * @since $VID:$
+	 * @var bool
+	 */
+	private $multisite;
+
+
+	public function __construct(FilePath $plugin_file, Version $version)
+	{
+		parent::__construct($plugin_file, $version);
+		$this->setCaffeinated();
+		$this->multisite = is_multisite();
+	}
+
+	/**
+	 * Whether or not EE core is the full premium version.
+	 * @since 4.9.59.p
+	 * @return bool
+	 */
+	public function isCaffeinated()
+	{
+		return $this->caffeinated;
+	}
+
+
+	/**
+	 * Setter for $is_caffeinated property.
+	 * @since 4.9.59.p
+	 */
+	private function setCaffeinated()
+	{
+		$this->caffeinated = (! defined('EE_DECAF') || EE_DECAF !== true)
+			&& is_readable($this->pluginPath() . 'caffeinated/brewing_regular.php');
+	}
+
+
+	/**
+	 * This should be used everywhere the Event Espresso brand name is referenced in public facing interfaces
+	 * to allow for filtering the brand.
+	 *
+	 * @return string
+	 */
+	public static function brandName()
+	{
+		return (string) apply_filters('FHEE__EventEspresso_core_domain_Domain__brandName', 'Event Espresso');
+	}
+
+
+	/**
+	 * @return bool
+	 * @since $VID:$
+	 */
+	public function isMultiSite(): bool
+	{
+		return $this->multisite;
+	}
 }

modules/single_page_checkout/reg_steps/attendee_information/EE_SPCO_Reg_Step_Attendee_Information.class.php

Indentation +858 added lines, -858 removed lines

@@ -22,862 +22,862 @@
  */
 class EE_SPCO_Reg_Step_Attendee_Information extends EE_SPCO_Reg_Step
 {
-    /**
-     * @var RegForm
-     */
-    public $reg_form;
-
-    /**
-     * @var int
-     */
-    protected $reg_form_count = 0;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->_slug    = 'attendee_information';
-        $this->_name    = esc_html__('Attendee Information', 'event_espresso');
-        $this->checkout = $checkout;
-        $this->_reset_success_message();
-        $this->set_instructions(
-            esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
-        );
-    }
-
-
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
-            ' is a required question.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
-            ' is a required question. Please enter a value for at least one of the options.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
-            'Please answer all required questions correctly before proceeding.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
-            esc_html_x(
-                'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
-                'The attendee information was successfully copied.(line break)Please ensure the rest of the registration form is completed before proceeding.',
-                'event_espresso'
-            ),
-            '<br/>'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
-            'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
-            'You must enter a valid email address.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
-            'You must enter a valid email address and answer all other required questions before you can proceed.',
-            'event_espresso'
-        );
-    }
-
-
-    public function enqueue_styles_and_scripts()
-    {
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function initialize_reg_step(): bool
-    {
-        return true;
-    }
-
-
-    /**
-     * @return RegForm
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function generate_reg_form(): RegForm
-    {
-        $this->setLegacyFiltersForRegFormGeneration();
-        /** @var RegFormDependencyHandler $dependency_handler */
-        $dependency_handler = LoaderFactory::getShared(RegFormDependencyHandler::class);
-        $dependency_handler->registerDependencies();
-        // TODO detect if event has a reg form UUID and swap this out for form generated by new reg form builder
-        return LoaderFactory::getShared(RegForm::class, [$this]);
-    }
-
-
-    /**
-     * @since   $VID:$
-     */
-    private function setLegacyFiltersForRegFormGeneration()
-    {
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_groups_query_parameters',
-            [$this, 'registrationQuestionGroupsQueryParameters'],
-            1,
-            2
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_group_reg_form',
-            [$this, 'registrationQuestionGroupsRegForm'],
-            1,
-            3
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__printCopyInfo',
-            [$this, 'registrationRegFormPrintCopyInfo'],
-            1,
-            2
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__related_questions_query_params',
-            [$this, 'registrationRegFormRelatedQuestionsQueryParams'],
-            1,
-            3
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__before_question_group_questions',
-            [$this, 'registrationRegFormBeforeQuestionGroupQuestions'],
-            1,
-            3
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__subsections_array',
-            [$this, 'registrationRegFormSubsections'],
-            1,
-            3
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__after_question_group_questions',
-            [$this, 'registrationRegFormAfterQuestionGroupQuestions'],
-            1,
-            3
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_AutoCopyAttendeeInfoForm__construct__template_args',
-            [$this, 'autoCopyAttendeeInfoTemplateArgs'],
-            1
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_CountryOptions__generateLegacyCountryOptions__country_options',
-            [$this, 'generateQuestionInputCountryOptions'],
-            1,
-            4
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_StateOptions__generateLegacyStateOptions__state_options',
-            [$this, 'generateQuestionInputStateOptions'],
-            1,
-            4
-        );
-    }
-
-
-    /**
-     * @param array           $query_params
-     * @param EE_Registration $registration
-     * @return mixed|void
-     * @since   $VID:$
-     */
-    public function registrationQuestionGroupsQueryParameters(
-        array $query_params,
-        EE_Registration $registration
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
-            $query_params,
-            $registration,
-            $this
-        );
-    }
-
-
-    /**
-     * @param RegFormQuestionGroup $question_group_reg_form
-     * @param EE_Registration      $registration
-     * @param EE_Question_Group    $question_group
-     * @return mixed|void
-     * @since   $VID:$
-     */
-    public function registrationQuestionGroupsRegForm(
-        RegFormQuestionGroup $question_group_reg_form,
-        EE_Registration $registration,
-        EE_Question_Group $question_group
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            $question_group_reg_form,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @param int $print_copy_info
-     * @param int $attendee_nmbr
-     * @return mixed|void
-     * @since   $VID:$
-     */
-    public function registrationRegFormPrintCopyInfo(
-        int $print_copy_info,
-        int $attendee_nmbr
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form___printCopyInfo',
-            $print_copy_info,
-            $attendee_nmbr
-        );
-    }
-
-
-    /**
-     * @param array             $query_params
-     * @param EE_Question_Group $question_group
-     * @param EE_Registration   $registration
-     * @return mixed|void
-     * @since   $VID:$
-     */
-    public function registrationRegFormRelatedQuestionsQueryParams(
-        array $query_params,
-        EE_Question_Group $question_group,
-        EE_Registration $registration
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
-            $query_params,
-            $question_group,
-            $registration,
-            $this
-        );
-    }
-
-
-    /**
-     * @param                   $html
-     * @param EE_Registration   $registration
-     * @param EE_Question_Group $question_group
-     * @return mixed|void
-     * @since   $VID:$
-     */
-    public function registrationRegFormBeforeQuestionGroupQuestions(
-        $html,
-        EE_Registration $registration,
-        EE_Question_Group $question_group
-    ) {
-        return apply_filters(
-            'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
-            $html,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @param array             $form_subsections
-     * @param EE_Registration   $registration
-     * @param EE_Question_Group $question_group
-     * @return mixed|void
-     * @since   $VID:$
-     */
-    public function registrationRegFormSubsections(
-        array $form_subsections,
-        EE_Registration $registration,
-        EE_Question_Group $question_group
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
-            $form_subsections,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @param                   $html
-     * @param EE_Registration   $registration
-     * @param EE_Question_Group $question_group
-     * @return mixed|void
-     * @since   $VID:$
-     */
-    public function registrationRegFormAfterQuestionGroupQuestions(
-        $html,
-        EE_Registration $registration,
-        EE_Question_Group $question_group
-    ) {
-        return apply_filters(
-            'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
-            $html,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @param array $template_args
-     * @return mixed|void
-     * @since   $VID:$
-     */
-    public function autoCopyAttendeeInfoTemplateArgs(array $template_args = [])
-    {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
-            $template_args
-        );
-    }
-
-
-    /**
-     * @param array           $country_options
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @param EE_Answer|null  $answer
-     * @return mixed|void
-     * @since   $VID:$
-     */
-    public function generateQuestionInputCountryOptions(
-        array $country_options,
-        EE_Registration $registration,
-        EE_Question $question,
-        ?EE_Answer $answer
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            $country_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-    }
-
-
-    /**
-     * @param array           $state_options
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @param EE_Answer|null  $answer
-     * @return mixed|void
-     * @since   $VID:$
-     */
-    public function generateQuestionInputStateOptions(
-        array $state_options,
-        EE_Registration $registration,
-        EE_Question $question,
-        ?EE_Answer $answer
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            $state_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::getRegForm()
-     *
-     * @deprecated   $VID:$
-     */
-    private function _registrations_reg_form()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::additionalAttendeeRegInfoInput()
-     *
-     * @deprecated   $VID:$
-     */
-    private function _additional_attendee_reg_info_input()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::questionGroupRegForm()
-     *
-     * @deprecated   $VID:$
-     */
-    private function _question_group_reg_form()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::questionGroupHeader()
-     *
-     * @deprecated   $VID:$
-     */
-    private function _question_group_header()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\CopyAttendeeInfoForm
-     *
-     * @deprecated   $VID:$
-     */
-    private function _copy_attendee_info_form()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\AutoCopyAttendeeInfoForm
-     *
-     * @deprecated   $VID:$
-     */
-    private function _auto_copy_attendee_info()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\CopyAttendeeInfoForm
-     *
-     * @deprecated   $VID:$
-     */
-    private function _copy_attendee_info_inputs()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::additionalPrimaryRegistrantInputs()
-     *
-     * @deprecated   $VID:$
-     */
-    private function _additional_primary_registrant_inputs()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionFactory::create()
-     *
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated   $VID:$
-     */
-    public function reg_form_question(EE_Registration $registration, EE_Question $question): EE_Form_Input_Base
-    {
-        /** @var RegFormQuestionFactory $reg_form_question_factory */
-        $reg_form_question_factory = LoaderFactory::getShared(RegFormQuestionFactory::class);
-        return $reg_form_question_factory->create($registration, $question);
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::generateQuestionInput()
-     *
-     * @deprecated   $VID:$
-     */
-    private function _generate_question_input()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\CountryOptions::forLegacyFormInput()
-     *
-     * @param array|null           $countries_list
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @param EE_Answer|null       $answer
-     * @return array 2d keys are country IDs, values are their names
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated   $VID:$
-     */
-    public function use_cached_countries_for_form_input(
-        array $countries_list = null,
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ): array {
-        /** @var CountryOptions $country_options */
-        $country_options = LoaderFactory::getShared(CountryOptions::class, [$this->checkout->action]);
-        return $country_options->forLegacyFormInput($countries_list, $question, $registration, $answer);
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\StateOptions::forLegacyFormInput()
-     *
-     * @param array|null           $states_list
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @param EE_Answer|null       $answer
-     * @return array 2d keys are state IDs, values are their names
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated   $VID:$
-     */
-    public function use_cached_states_for_form_input(
-        array $states_list = null,
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ): array {
-        /** @var StateOptions $state_options */
-        $state_options = LoaderFactory::getShared(StateOptions::class, [$this->checkout->action]);
-        return $state_options->forLegacyFormInput($states_list, $question, $registration, $answer);
-    }
-
-
-    /********************************************************************************************************/
-    /****************************************  PROCESS REG STEP  ****************************************/
-    /********************************************************************************************************/
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_reg_step(): bool
-    {
-        $this->setLegacyFiltersForRegFormProcessing();
-        // grab validated data from form
-        $valid_data = $this->checkout->current_step->valid_data();
-        // if we don't have any $valid_data then something went TERRIBLY WRONG !!!
-        if (empty($valid_data)) {
-            return $this->inValidDataError();
-        }
-        if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
-            return $this->inValidTransactionError();
-        }
-        // get cached registrations
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        // verify we got the goods
-        if (empty($registrations)) {
-            return $this->noRegistrationsError();
-        }
-        /** @var RegFormHandler $reg_form_handler */
-        $reg_form_handler = LoaderFactory::getNew(RegFormHandler::class, [$this->checkout]);
-        // extract attendee info from form data and save to model objects
-        if (! $reg_form_handler->processRegistrations($registrations, $valid_data)) {
-            // return immediately if the previous step exited early due to errors
-            return false;
-        }
-        // if first pass thru SPCO,
-        // then let's check processed registrations against the total number of tickets in the cart
-        $registrations_processed = $reg_form_handler->attendeeCount();
-        if (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
-            return $this->registrationProcessingError($registrations_processed);
-        }
-        // mark this reg step as completed
-        $this->set_completed();
-        $this->_set_success_message(
-            esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
-        );
-        // do action in case a plugin wants to do something with the data submitted in step 1.
-        // passes EE_Single_Page_Checkout, and it's posted data
-        do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
-        return true;
-    }
-
-
-    /**
-     * @since   $VID:$
-     */
-    private function setLegacyFiltersForRegFormProcessing()
-    {
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegistrations__bypass',
-            [$this, 'preRegistrationProcess'],
-            1,
-            5
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegFormData__registrant_form_data',
-            [$this, 'validDataLineItem'],
-            1,
-            2
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormInputHandler__saveRegistrationFormInput',
-            [$this, 'saveRegistrationFormInput'],
-            1,
-            4
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantData__ensureCriticalRegistrantDataIsSet',
-            [$this, 'mergeAddressDetailsWithCriticalAttendeeDetails'],
-            1
-        );
-    }
-
-
-    /**
-     * @param bool            $bypass
-     * @param int             $attendee_count
-     * @param EE_Registration $registration
-     * @param array           $registrations
-     * @param array           $reg_form_data
-     * @return mixed|void
-     * @since   $VID:$
-     */
-    public function preRegistrationProcess(
-        bool $bypass,
-        int $attendee_count,
-        EE_Registration $registration,
-        array $registrations,
-        array $reg_form_data
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
-            $bypass,
-            $attendee_count,
-            $registration,
-            $registrations,
-            $reg_form_data,
-            $this
-        );
-    }
-
-
-    /**
-     * @param array           $reg_form_data
-     * @param EE_Registration $registration
-     * @return mixed|void
-     * @since   $VID:$
-     */
-    public function validDataLineItem(array $reg_form_data, EE_Registration $registration)
-    {
-        return apply_filters(
-            'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-            $reg_form_data,
-            $registration
-        );
-    }
-
-
-    /**
-     * @param bool            $save
-     * @param EE_Registration $registration
-     * @param                 $form_input
-     * @param                 $input_value
-     * @return mixed|void
-     * @since   $VID:$
-     */
-    public function saveRegistrationFormInput(bool $save, EE_Registration $registration, $form_input, $input_value)
-    {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
-            $save,
-            $registration,
-            $form_input,
-            $input_value,
-            $this
-        );
-    }
-
-
-    /**
-     * @param bool $merge_data
-     * @return mixed|void
-     * @since   $VID:$
-     */
-    public function mergeAddressDetailsWithCriticalAttendeeDetails(bool $merge_data)
-    {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
-            $merge_data
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @since   $VID:$
-     */
-    private function inValidDataError(): bool
-    {
-        EE_Error::add_error(
-            esc_html__('No valid question responses were received.', 'event_espresso'),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
-
-
-    /**
-     * @return bool
-     * @since   $VID:$
-     */
-    private function inValidTransactionError(): bool
-    {
-        EE_Error::add_error(
-            esc_html__(
-                'A valid transaction could not be initiated for processing your registrations.',
-                'event_espresso'
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
-
-
-    /**
-     * @return bool
-     * @since   $VID:$
-     */
-    private function noRegistrationsError(): bool
-    {
-        // combine the old translated string with a new one, in order to not break translations
-        $error_message = esc_html__(
-            'Your form data could not be applied to any valid registrations.',
-            'event_espresso'
-        );
-        $error_message .= sprintf(
-            esc_html_x(
-                '%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.',
-                '(line break)This can sometimes happen if too much time has been taken to complete the registration process.(line break)Please return to the (link)Event List(end link) and reselect your tickets. If the problem continues, please contact the site administrator.',
-                'event_espresso'
-            ),
-            '<a href="' . get_post_type_archive_link('espresso_events') . '" >',
-            '</a>',
-            '<br />'
-        );
-        EE_Error::add_error($error_message, __FILE__, __FUNCTION__, __LINE__);
-        return false;
-    }
-
-
-    /**
-     * @param int $registrations_processed
-     * @return bool
-     * @since   $VID:$
-     */
-    private function registrationProcessingError(int $registrations_processed): bool
-    {
-        // generate a correctly translated string for all possible singular/plural combinations
-        if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
-            $error_msg = sprintf(
-                esc_html_x(
-                    'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
-                    'There was 1 ticket in the Event Queue, but 2 registrations were processed',
-                    'event_espresso'
-                ),
-                $this->checkout->total_ticket_count,
-                $registrations_processed
-            );
-        } elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
-            $error_msg = sprintf(
-                esc_html_x(
-                    'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
-                    'There was a total of 2 tickets in the Event Queue, but only 1 registration was processed',
-                    'event_espresso'
-                ),
-                $this->checkout->total_ticket_count,
-                $registrations_processed
-            );
-        } else {
-            $error_msg = sprintf(
-                esc_html__(
-                    'There was a total of 2 tickets in the Event Queue, but 2 registrations were processed',
-                    'event_espresso'
-                ),
-                $this->checkout->total_ticket_count,
-                $registrations_processed
-            );
-        }
-        EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-        return false;
-    }
-
-
-    /**
-     *    update_reg_step
-     *    this is the final step after a user  revisits the site to edit their attendee information
-     *    this gets called AFTER the process_reg_step() method above
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update_reg_step(): bool
-    {
-        // save everything
-        if ($this->process_reg_step()) {
-            $this->checkout->redirect     = true;
-            $this->checkout->redirect_url = add_query_arg(
-                [
-                    'e_reg_url_link' => $this->checkout->reg_url_link,
-                    'revisit'        => true,
-                ],
-                $this->checkout->thank_you_page_url
-            );
-            $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * @var RegForm
+	 */
+	public $reg_form;
+
+	/**
+	 * @var int
+	 */
+	protected $reg_form_count = 0;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->_slug    = 'attendee_information';
+		$this->_name    = esc_html__('Attendee Information', 'event_espresso');
+		$this->checkout = $checkout;
+		$this->_reset_success_message();
+		$this->set_instructions(
+			esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
+		);
+	}
+
+
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
+			' is a required question.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
+			' is a required question. Please enter a value for at least one of the options.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
+			'Please answer all required questions correctly before proceeding.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
+			esc_html_x(
+				'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
+				'The attendee information was successfully copied.(line break)Please ensure the rest of the registration form is completed before proceeding.',
+				'event_espresso'
+			),
+			'<br/>'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
+			'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
+			'You must enter a valid email address.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
+			'You must enter a valid email address and answer all other required questions before you can proceed.',
+			'event_espresso'
+		);
+	}
+
+
+	public function enqueue_styles_and_scripts()
+	{
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function initialize_reg_step(): bool
+	{
+		return true;
+	}
+
+
+	/**
+	 * @return RegForm
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function generate_reg_form(): RegForm
+	{
+		$this->setLegacyFiltersForRegFormGeneration();
+		/** @var RegFormDependencyHandler $dependency_handler */
+		$dependency_handler = LoaderFactory::getShared(RegFormDependencyHandler::class);
+		$dependency_handler->registerDependencies();
+		// TODO detect if event has a reg form UUID and swap this out for form generated by new reg form builder
+		return LoaderFactory::getShared(RegForm::class, [$this]);
+	}
+
+
+	/**
+	 * @since   $VID:$
+	 */
+	private function setLegacyFiltersForRegFormGeneration()
+	{
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_groups_query_parameters',
+			[$this, 'registrationQuestionGroupsQueryParameters'],
+			1,
+			2
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_group_reg_form',
+			[$this, 'registrationQuestionGroupsRegForm'],
+			1,
+			3
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__printCopyInfo',
+			[$this, 'registrationRegFormPrintCopyInfo'],
+			1,
+			2
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__related_questions_query_params',
+			[$this, 'registrationRegFormRelatedQuestionsQueryParams'],
+			1,
+			3
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__before_question_group_questions',
+			[$this, 'registrationRegFormBeforeQuestionGroupQuestions'],
+			1,
+			3
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__subsections_array',
+			[$this, 'registrationRegFormSubsections'],
+			1,
+			3
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__after_question_group_questions',
+			[$this, 'registrationRegFormAfterQuestionGroupQuestions'],
+			1,
+			3
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_AutoCopyAttendeeInfoForm__construct__template_args',
+			[$this, 'autoCopyAttendeeInfoTemplateArgs'],
+			1
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_CountryOptions__generateLegacyCountryOptions__country_options',
+			[$this, 'generateQuestionInputCountryOptions'],
+			1,
+			4
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_StateOptions__generateLegacyStateOptions__state_options',
+			[$this, 'generateQuestionInputStateOptions'],
+			1,
+			4
+		);
+	}
+
+
+	/**
+	 * @param array           $query_params
+	 * @param EE_Registration $registration
+	 * @return mixed|void
+	 * @since   $VID:$
+	 */
+	public function registrationQuestionGroupsQueryParameters(
+		array $query_params,
+		EE_Registration $registration
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
+			$query_params,
+			$registration,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param RegFormQuestionGroup $question_group_reg_form
+	 * @param EE_Registration      $registration
+	 * @param EE_Question_Group    $question_group
+	 * @return mixed|void
+	 * @since   $VID:$
+	 */
+	public function registrationQuestionGroupsRegForm(
+		RegFormQuestionGroup $question_group_reg_form,
+		EE_Registration $registration,
+		EE_Question_Group $question_group
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			$question_group_reg_form,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param int $print_copy_info
+	 * @param int $attendee_nmbr
+	 * @return mixed|void
+	 * @since   $VID:$
+	 */
+	public function registrationRegFormPrintCopyInfo(
+		int $print_copy_info,
+		int $attendee_nmbr
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form___printCopyInfo',
+			$print_copy_info,
+			$attendee_nmbr
+		);
+	}
+
+
+	/**
+	 * @param array             $query_params
+	 * @param EE_Question_Group $question_group
+	 * @param EE_Registration   $registration
+	 * @return mixed|void
+	 * @since   $VID:$
+	 */
+	public function registrationRegFormRelatedQuestionsQueryParams(
+		array $query_params,
+		EE_Question_Group $question_group,
+		EE_Registration $registration
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
+			$query_params,
+			$question_group,
+			$registration,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param                   $html
+	 * @param EE_Registration   $registration
+	 * @param EE_Question_Group $question_group
+	 * @return mixed|void
+	 * @since   $VID:$
+	 */
+	public function registrationRegFormBeforeQuestionGroupQuestions(
+		$html,
+		EE_Registration $registration,
+		EE_Question_Group $question_group
+	) {
+		return apply_filters(
+			'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
+			$html,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param array             $form_subsections
+	 * @param EE_Registration   $registration
+	 * @param EE_Question_Group $question_group
+	 * @return mixed|void
+	 * @since   $VID:$
+	 */
+	public function registrationRegFormSubsections(
+		array $form_subsections,
+		EE_Registration $registration,
+		EE_Question_Group $question_group
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
+			$form_subsections,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param                   $html
+	 * @param EE_Registration   $registration
+	 * @param EE_Question_Group $question_group
+	 * @return mixed|void
+	 * @since   $VID:$
+	 */
+	public function registrationRegFormAfterQuestionGroupQuestions(
+		$html,
+		EE_Registration $registration,
+		EE_Question_Group $question_group
+	) {
+		return apply_filters(
+			'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
+			$html,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param array $template_args
+	 * @return mixed|void
+	 * @since   $VID:$
+	 */
+	public function autoCopyAttendeeInfoTemplateArgs(array $template_args = [])
+	{
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
+			$template_args
+		);
+	}
+
+
+	/**
+	 * @param array           $country_options
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @param EE_Answer|null  $answer
+	 * @return mixed|void
+	 * @since   $VID:$
+	 */
+	public function generateQuestionInputCountryOptions(
+		array $country_options,
+		EE_Registration $registration,
+		EE_Question $question,
+		?EE_Answer $answer
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			$country_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+	}
+
+
+	/**
+	 * @param array           $state_options
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @param EE_Answer|null  $answer
+	 * @return mixed|void
+	 * @since   $VID:$
+	 */
+	public function generateQuestionInputStateOptions(
+		array $state_options,
+		EE_Registration $registration,
+		EE_Question $question,
+		?EE_Answer $answer
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			$state_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::getRegForm()
+	 *
+	 * @deprecated   $VID:$
+	 */
+	private function _registrations_reg_form()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::additionalAttendeeRegInfoInput()
+	 *
+	 * @deprecated   $VID:$
+	 */
+	private function _additional_attendee_reg_info_input()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::questionGroupRegForm()
+	 *
+	 * @deprecated   $VID:$
+	 */
+	private function _question_group_reg_form()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::questionGroupHeader()
+	 *
+	 * @deprecated   $VID:$
+	 */
+	private function _question_group_header()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\CopyAttendeeInfoForm
+	 *
+	 * @deprecated   $VID:$
+	 */
+	private function _copy_attendee_info_form()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\AutoCopyAttendeeInfoForm
+	 *
+	 * @deprecated   $VID:$
+	 */
+	private function _auto_copy_attendee_info()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\CopyAttendeeInfoForm
+	 *
+	 * @deprecated   $VID:$
+	 */
+	private function _copy_attendee_info_inputs()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::additionalPrimaryRegistrantInputs()
+	 *
+	 * @deprecated   $VID:$
+	 */
+	private function _additional_primary_registrant_inputs()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionFactory::create()
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated   $VID:$
+	 */
+	public function reg_form_question(EE_Registration $registration, EE_Question $question): EE_Form_Input_Base
+	{
+		/** @var RegFormQuestionFactory $reg_form_question_factory */
+		$reg_form_question_factory = LoaderFactory::getShared(RegFormQuestionFactory::class);
+		return $reg_form_question_factory->create($registration, $question);
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::generateQuestionInput()
+	 *
+	 * @deprecated   $VID:$
+	 */
+	private function _generate_question_input()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\CountryOptions::forLegacyFormInput()
+	 *
+	 * @param array|null           $countries_list
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @param EE_Answer|null       $answer
+	 * @return array 2d keys are country IDs, values are their names
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated   $VID:$
+	 */
+	public function use_cached_countries_for_form_input(
+		array $countries_list = null,
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	): array {
+		/** @var CountryOptions $country_options */
+		$country_options = LoaderFactory::getShared(CountryOptions::class, [$this->checkout->action]);
+		return $country_options->forLegacyFormInput($countries_list, $question, $registration, $answer);
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\StateOptions::forLegacyFormInput()
+	 *
+	 * @param array|null           $states_list
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @param EE_Answer|null       $answer
+	 * @return array 2d keys are state IDs, values are their names
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated   $VID:$
+	 */
+	public function use_cached_states_for_form_input(
+		array $states_list = null,
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	): array {
+		/** @var StateOptions $state_options */
+		$state_options = LoaderFactory::getShared(StateOptions::class, [$this->checkout->action]);
+		return $state_options->forLegacyFormInput($states_list, $question, $registration, $answer);
+	}
+
+
+	/********************************************************************************************************/
+	/****************************************  PROCESS REG STEP  ****************************************/
+	/********************************************************************************************************/
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_reg_step(): bool
+	{
+		$this->setLegacyFiltersForRegFormProcessing();
+		// grab validated data from form
+		$valid_data = $this->checkout->current_step->valid_data();
+		// if we don't have any $valid_data then something went TERRIBLY WRONG !!!
+		if (empty($valid_data)) {
+			return $this->inValidDataError();
+		}
+		if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
+			return $this->inValidTransactionError();
+		}
+		// get cached registrations
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		// verify we got the goods
+		if (empty($registrations)) {
+			return $this->noRegistrationsError();
+		}
+		/** @var RegFormHandler $reg_form_handler */
+		$reg_form_handler = LoaderFactory::getNew(RegFormHandler::class, [$this->checkout]);
+		// extract attendee info from form data and save to model objects
+		if (! $reg_form_handler->processRegistrations($registrations, $valid_data)) {
+			// return immediately if the previous step exited early due to errors
+			return false;
+		}
+		// if first pass thru SPCO,
+		// then let's check processed registrations against the total number of tickets in the cart
+		$registrations_processed = $reg_form_handler->attendeeCount();
+		if (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
+			return $this->registrationProcessingError($registrations_processed);
+		}
+		// mark this reg step as completed
+		$this->set_completed();
+		$this->_set_success_message(
+			esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
+		);
+		// do action in case a plugin wants to do something with the data submitted in step 1.
+		// passes EE_Single_Page_Checkout, and it's posted data
+		do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
+		return true;
+	}
+
+
+	/**
+	 * @since   $VID:$
+	 */
+	private function setLegacyFiltersForRegFormProcessing()
+	{
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegistrations__bypass',
+			[$this, 'preRegistrationProcess'],
+			1,
+			5
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegFormData__registrant_form_data',
+			[$this, 'validDataLineItem'],
+			1,
+			2
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormInputHandler__saveRegistrationFormInput',
+			[$this, 'saveRegistrationFormInput'],
+			1,
+			4
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantData__ensureCriticalRegistrantDataIsSet',
+			[$this, 'mergeAddressDetailsWithCriticalAttendeeDetails'],
+			1
+		);
+	}
+
+
+	/**
+	 * @param bool            $bypass
+	 * @param int             $attendee_count
+	 * @param EE_Registration $registration
+	 * @param array           $registrations
+	 * @param array           $reg_form_data
+	 * @return mixed|void
+	 * @since   $VID:$
+	 */
+	public function preRegistrationProcess(
+		bool $bypass,
+		int $attendee_count,
+		EE_Registration $registration,
+		array $registrations,
+		array $reg_form_data
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
+			$bypass,
+			$attendee_count,
+			$registration,
+			$registrations,
+			$reg_form_data,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param array           $reg_form_data
+	 * @param EE_Registration $registration
+	 * @return mixed|void
+	 * @since   $VID:$
+	 */
+	public function validDataLineItem(array $reg_form_data, EE_Registration $registration)
+	{
+		return apply_filters(
+			'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+			$reg_form_data,
+			$registration
+		);
+	}
+
+
+	/**
+	 * @param bool            $save
+	 * @param EE_Registration $registration
+	 * @param                 $form_input
+	 * @param                 $input_value
+	 * @return mixed|void
+	 * @since   $VID:$
+	 */
+	public function saveRegistrationFormInput(bool $save, EE_Registration $registration, $form_input, $input_value)
+	{
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
+			$save,
+			$registration,
+			$form_input,
+			$input_value,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param bool $merge_data
+	 * @return mixed|void
+	 * @since   $VID:$
+	 */
+	public function mergeAddressDetailsWithCriticalAttendeeDetails(bool $merge_data)
+	{
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
+			$merge_data
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	private function inValidDataError(): bool
+	{
+		EE_Error::add_error(
+			esc_html__('No valid question responses were received.', 'event_espresso'),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
+
+
+	/**
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	private function inValidTransactionError(): bool
+	{
+		EE_Error::add_error(
+			esc_html__(
+				'A valid transaction could not be initiated for processing your registrations.',
+				'event_espresso'
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
+
+
+	/**
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	private function noRegistrationsError(): bool
+	{
+		// combine the old translated string with a new one, in order to not break translations
+		$error_message = esc_html__(
+			'Your form data could not be applied to any valid registrations.',
+			'event_espresso'
+		);
+		$error_message .= sprintf(
+			esc_html_x(
+				'%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.',
+				'(line break)This can sometimes happen if too much time has been taken to complete the registration process.(line break)Please return to the (link)Event List(end link) and reselect your tickets. If the problem continues, please contact the site administrator.',
+				'event_espresso'
+			),
+			'<a href="' . get_post_type_archive_link('espresso_events') . '" >',
+			'</a>',
+			'<br />'
+		);
+		EE_Error::add_error($error_message, __FILE__, __FUNCTION__, __LINE__);
+		return false;
+	}
+
+
+	/**
+	 * @param int $registrations_processed
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	private function registrationProcessingError(int $registrations_processed): bool
+	{
+		// generate a correctly translated string for all possible singular/plural combinations
+		if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
+			$error_msg = sprintf(
+				esc_html_x(
+					'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
+					'There was 1 ticket in the Event Queue, but 2 registrations were processed',
+					'event_espresso'
+				),
+				$this->checkout->total_ticket_count,
+				$registrations_processed
+			);
+		} elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
+			$error_msg = sprintf(
+				esc_html_x(
+					'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
+					'There was a total of 2 tickets in the Event Queue, but only 1 registration was processed',
+					'event_espresso'
+				),
+				$this->checkout->total_ticket_count,
+				$registrations_processed
+			);
+		} else {
+			$error_msg = sprintf(
+				esc_html__(
+					'There was a total of 2 tickets in the Event Queue, but 2 registrations were processed',
+					'event_espresso'
+				),
+				$this->checkout->total_ticket_count,
+				$registrations_processed
+			);
+		}
+		EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+		return false;
+	}
+
+
+	/**
+	 *    update_reg_step
+	 *    this is the final step after a user  revisits the site to edit their attendee information
+	 *    this gets called AFTER the process_reg_step() method above
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update_reg_step(): bool
+	{
+		// save everything
+		if ($this->process_reg_step()) {
+			$this->checkout->redirect     = true;
+			$this->checkout->redirect_url = add_query_arg(
+				[
+					'e_reg_url_link' => $this->checkout->reg_url_link,
+					'revisit'        => true,
+				],
+				$this->checkout->thank_you_page_url
+			);
+			$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+			return true;
+		}
+		return false;
+	}
 }

modules/core_rest_api/EED_Core_Rest_Api.module.php

Indentation +1378 added lines, -1378 removed lines

@@ -21,1382 +21,1382 @@
  */
 class EED_Core_Rest_Api extends EED_Module
 {
-    const ee_api_namespace = Domain::API_NAMESPACE;
-
-    const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
-
-    const saved_routes_option_names = 'ee_core_routes';
-
-    /**
-     * string used in _links response bodies to make them globally unique.
-     *
-     * @see http://v2.wp-api.org/extending/linking/
-     */
-    const ee_api_link_namespace = 'https://api.eventespresso.com/';
-
-    /**
-     * @var CalculatedModelFields
-     */
-    protected static $_field_calculator;
-
-
-    /**
-     * @return EED_Core_Rest_Api|EED_Module
-     */
-    public static function instance()
-    {
-        return parent::get_instance(EED_Core_Rest_Api::class);
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
-
-
-    public static function set_hooks_both()
-    {
-        add_action('rest_api_init', ['EED_Core_Rest_Api', 'set_hooks_rest_api'], 5);
-        add_action('rest_api_init', ['EED_Core_Rest_Api', 'register_routes'], 10);
-        add_filter('rest_route_data', ['EED_Core_Rest_Api', 'hide_old_endpoints'], 10, 2);
-        add_filter(
-            'rest_index',
-            ['EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filterEeMetadataIntoIndex']
-        );
-    }
-
-
-    /**
-     * @since   $VID:$
-     */
-    public static function loadCalculatedModelFields()
-    {
-        EED_Core_Rest_Api::$_field_calculator = LoaderFactory::getLoader()->load(
-            'EventEspresso\core\libraries\rest_api\CalculatedModelFields'
-        );
-        EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
-    }
-
-
-    /**
-     * sets up hooks which only need to be included as part of REST API requests;
-     * other requests like to the frontend or admin etc don't need them
-     *
-     * @throws EE_Error
-     */
-    public static function set_hooks_rest_api()
-    {
-        // set hooks which account for changes made to the API
-        EED_Core_Rest_Api::_set_hooks_for_changes();
-    }
-
-
-    /**
-     * public wrapper of _set_hooks_for_changes.
-     * Loads all the hooks which make requests to old versions of the API
-     * appear the same as they always did
-     *
-     * @throws EE_Error
-     */
-    public static function set_hooks_for_changes()
-    {
-        EED_Core_Rest_Api::_set_hooks_for_changes();
-    }
-
-
-    /**
-     * Loads all the hooks which make requests to old versions of the API
-     * appear the same as they always did
-     *
-     * @throws EE_Error
-     */
-    protected static function _set_hooks_for_changes()
-    {
-        $folder_contents = EEH_File::get_contents_of_folders([EE_LIBRARIES . 'rest_api/changes'], false);
-        foreach ($folder_contents as $classname_in_namespace => $filepath) {
-            // ignore the base parent class
-            // and legacy named classes
-            if (
-                $classname_in_namespace === 'ChangesInBase'
-                || strpos($classname_in_namespace, 'Changes_In_') === 0
-            ) {
-                continue;
-            }
-            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
-            if (class_exists($full_classname)) {
-                $instance_of_class = new $full_classname();
-                if ($instance_of_class instanceof ChangesInBase) {
-                    $instance_of_class->setHooks();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Filters the WP routes to add our EE-related ones. This takes a bit of time
-     * so we actually prefer to only do it when an EE plugin is activated or upgraded
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function register_routes()
-    {
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_routes) {
-            foreach ($relative_routes as $relative_route => $data_for_multiple_endpoints) {
-                /**
-                 * @var array     $data_for_multiple_endpoints numerically indexed array
-                 *                                         but can also contain route options like {
-                 * @type array    $schema                      {
-                 * @type callable $schema_callback
-                 * @type array    $callback_args               arguments that will be passed to the callback, after the
-                 * WP_REST_Request of course
-                 * }
-                 * }
-                 */
-                // when registering routes, register all the endpoints' data at the same time
-                $multiple_endpoint_args = [];
-                foreach ($data_for_multiple_endpoints as $endpoint_key => $data_for_single_endpoint) {
-                    /**
-                     * @var array     $data_for_single_endpoint {
-                     * @type callable $callback
-                     * @type string methods
-                     * @type array args
-                     * @type array _links
-                     * @type array    $callback_args            arguments that will be passed to the callback, after the
-                     * WP_REST_Request of course
-                     * }
-                     */
-                    // skip route options
-                    if (! is_numeric($endpoint_key)) {
-                        continue;
-                    }
-                    if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
-                        throw new EE_Error(
-                            esc_html__(
-                            // @codingStandardsIgnoreStart
-                                'Endpoint configuration data needs to have entries "callback" (callable) and "methods" (comma-separated list of accepts HTTP methods).',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            )
-                        );
-                    }
-                    $callback = $data_for_single_endpoint['callback'];
-                    $single_endpoint_args = [
-                        'methods' => $data_for_single_endpoint['methods'],
-                        'args'    => isset($data_for_single_endpoint['args']) ? $data_for_single_endpoint['args']
-                            : [],
-                    ];
-                    if (isset($data_for_single_endpoint['_links'])) {
-                        $single_endpoint_args['_links'] = $data_for_single_endpoint['_links'];
-                    }
-                    if (isset($data_for_single_endpoint['callback_args'])) {
-                        $callback_args = $data_for_single_endpoint['callback_args'];
-                        $single_endpoint_args['callback'] = static function (WP_REST_Request $request) use (
-                            $callback,
-                            $callback_args
-                        ) {
-                            array_unshift($callback_args, $request);
-                            return call_user_func_array(
-                                $callback,
-                                $callback_args
-                            );
-                        };
-                    } else {
-                        $single_endpoint_args['callback'] = $data_for_single_endpoint['callback'];
-                    }
-                    // As of WordPress 5.5, if a permission_callback is not provided,
-                    // the REST API will issue a _doing_it_wrong notice.
-                    // Since the EE REST API defers capabilities to the db model system,
-                    // we will just use the generic WP callback for public endpoints
-                    if (! isset($single_endpoint_args['permission_callback'])) {
-                        $single_endpoint_args['permission_callback'] = '__return_true';
-                    }
-                    $multiple_endpoint_args[] = $single_endpoint_args;
-                }
-                if (isset($data_for_multiple_endpoints['schema'])) {
-                    $schema_route_data = $data_for_multiple_endpoints['schema'];
-                    $schema_callback = $schema_route_data['schema_callback'];
-                    $callback_args = $schema_route_data['callback_args'];
-                    $multiple_endpoint_args['schema'] = static function () use ($schema_callback, $callback_args) {
-                        return call_user_func_array(
-                            $schema_callback,
-                            $callback_args
-                        );
-                    };
-                }
-                register_rest_route(
-                    $namespace,
-                    $relative_route,
-                    $multiple_endpoint_args
-                );
-            }
-        }
-    }
-
-
-    /**
-     * Checks if there was a version change or something that merits invalidating the cached
-     * route data. If so, invalidates the cached route data so that it gets refreshed
-     * next time the WP API is used
-     */
-    public static function invalidate_cached_route_data_on_version_change()
-    {
-        if (EE_System::instance()->detect_req_type() !== EE_System::req_type_normal) {
-            EED_Core_Rest_Api::invalidate_cached_route_data();
-        }
-        foreach (EE_Registry::instance()->addons as $addon) {
-            if ($addon instanceof EE_Addon && $addon->detect_req_type() !== EE_System::req_type_normal) {
-                EED_Core_Rest_Api::invalidate_cached_route_data();
-            }
-        }
-    }
-
-
-    /**
-     * Removes the cached route data so it will get refreshed next time the WP API is used
-     */
-    public static function invalidate_cached_route_data()
-    {
-        // delete the saved EE REST API routes
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
-            delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
-        }
-    }
-
-
-    /**
-     * Gets the EE route data
-     *
-     * @return array top-level key is the namespace, next-level key is the route and its value is array{
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @type string|array $callback
-     * @type string       $methods
-     * @type boolean      $hidden_endpoint
-     * }
-     */
-    public static function get_ee_route_data()
-    {
-        $ee_routes = [];
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoints) {
-            $ee_routes[ EED_Core_Rest_Api::ee_api_namespace . $version ] = EED_Core_Rest_Api::_get_ee_route_data_for_version(
-                $version,
-                $hidden_endpoints
-            );
-        }
-        return $ee_routes;
-    }
-
-
-    /**
-     * Gets the EE route data from the wp options if it exists already,
-     * otherwise re-generates it and saves it to the option
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoints
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $ee_routes = get_option(EED_Core_Rest_Api::saved_routes_option_names . $version, null);
-        if (! $ee_routes || EED_Core_Rest_Api::debugMode()) {
-            $ee_routes = EED_Core_Rest_Api::_save_ee_route_data_for_version($version, $hidden_endpoints);
-        }
-        return $ee_routes;
-    }
-
-
-    /**
-     * Saves the EE REST API route data to a wp option and returns it
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoints
-     * @return mixed|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $instance = EED_Core_Rest_Api::instance();
-        $routes = apply_filters(
-            'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
-            array_replace_recursive(
-                $instance->_get_config_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_model_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
-            )
-        );
-        $option_name = EED_Core_Rest_Api::saved_routes_option_names . $version;
-        if (get_option($option_name)) {
-            update_option($option_name, $routes, true);
-        } else {
-            add_option($option_name, $routes, null, 'no');
-        }
-        return $routes;
-    }
-
-
-    /**
-     * Calculates all the EE routes and saves it to a WordPress option so we don't
-     * need to calculate it on every request
-     *
-     * @return void
-     * @deprecated since version 4.9.1
-     */
-    public static function save_ee_routes()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $instance = EED_Core_Rest_Api::instance();
-            $routes = apply_filters(
-                'EED_Core_Rest_Api__save_ee_routes__routes',
-                array_replace_recursive(
-                    $instance->_register_config_routes(),
-                    $instance->_register_meta_routes(),
-                    $instance->_register_model_routes(),
-                    $instance->_register_rpc_routes()
-                )
-            );
-            update_option(EED_Core_Rest_Api::saved_routes_option_names, $routes, true);
-        }
-    }
-
-
-    /**
-     * Gets all the route information relating to EE models
-     *
-     * @return array @see get_ee_route_data
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_model_routes()
-    {
-        $model_routes = [];
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
-            $model_routes[ EED_Core_Rest_Api::ee_api_namespace
-                           . $version ] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
-        }
-        return $model_routes;
-    }
-
-
-    /**
-     * Decides whether or not to add write endpoints for this model.
-     * Currently, this defaults to exclude all global tables and models
-     * which would allow inserting WP core data (we don't want to duplicate
-     * what WP API does, as it's unnecessary, extra work, and potentially extra bugs)
-     *
-     * @param EEM_Base $model
-     * @return bool
-     */
-    public static function should_have_write_endpoints(EEM_Base $model)
-    {
-        if ($model->is_wp_core_model()) {
-            return false;
-        }
-        foreach ($model->get_tables() as $table) {
-            if ($table->is_global()) {
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * Gets the names of all models which should have plural routes (eg `ee/v4.8.36/events`)
-     * in this versioned namespace of EE4
-     *
-     * @param $version
-     * @return array keys are model names (eg 'Event') and values ar either classnames (eg 'EEM_Event')
-     */
-    public static function model_names_with_plural_routes($version)
-    {
-        $model_version_info = new ModelVersionInfo($version);
-        $models_to_register = $model_version_info->modelsForRequestedVersion();
-        // let's not bother having endpoints for extra metas
-        unset(
-            $models_to_register['Extra_Meta'],
-            $models_to_register['Extra_Join'],
-            $models_to_register['Post_Meta']
-        );
-        return apply_filters(
-            'FHEE__EED_Core_REST_API___register_model_routes',
-            $models_to_register
-        );
-    }
-
-
-    /**
-     * Gets the route data for EE models in the specified version
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        $model_routes = [];
-        $model_version_info = new ModelVersionInfo($version);
-        foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) {
-            $model = EE_Registry::instance()->load_model($model_name);
-            // if this isn't a valid model then let's skip iterate to the next item in the loop.
-            if (! $model instanceof EEM_Base) {
-                continue;
-            }
-            // yes we could just register one route for ALL models, but then they wouldn't show up in the index
-            $plural_model_route = EED_Core_Rest_Api::get_collection_route($model);
-            $singular_model_route = EED_Core_Rest_Api::get_entity_route($model, '(?P<id>[^\/]+)');
-            $model_routes[ $plural_model_route ] = [
-                [
-                    'callback'        => [
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handleRequestGetAll',
-                    ],
-                    'callback_args'   => [$version, $model_name],
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_read_query_params($model, $version),
-                    '_links'          => [
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
-                    ],
-                ],
-                'schema' => [
-                    'schema_callback' => [
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handleSchemaRequest',
-                    ],
-                    'callback_args'   => [$version, $model_name],
-                ],
-            ];
-            $model_routes[ $singular_model_route ] = [
-                [
-                    'callback'        => [
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handleRequestGetOne',
-                    ],
-                    'callback_args'   => [$version, $model_name],
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_response_selection_query_params($model, $version, true),
-                ],
-            ];
-            if (
-                apply_filters(
-                    'FHEE__EED_Core_Rest_Api___get_model_route_data_for_version__add_write_endpoints',
-                    EED_Core_Rest_Api::should_have_write_endpoints($model),
-                    $model
-                )
-            ) {
-                $model_routes[ $plural_model_route ][] = [
-                    'callback'        => [
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                        'handleRequestInsert',
-                    ],
-                    'callback_args'   => [$version, $model_name],
-                    'methods'         => WP_REST_Server::CREATABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_write_params($model_name, $model_version_info, true),
-                ];
-                $model_routes[ $singular_model_route ] = array_merge(
-                    $model_routes[ $singular_model_route ],
-                    [
-                        [
-                            'callback'        => [
-                                'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                                'handleRequestUpdate',
-                            ],
-                            'callback_args'   => [$version, $model_name],
-                            'methods'         => WP_REST_Server::EDITABLE,
-                            'hidden_endpoint' => $hidden_endpoint,
-                            'args'            => $this->_get_write_params($model_name, $model_version_info),
-                        ],
-                        [
-                            'callback'        => [
-                                'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                                'handleRequestDelete',
-                            ],
-                            'callback_args'   => [$version, $model_name],
-                            'methods'         => WP_REST_Server::DELETABLE,
-                            'hidden_endpoint' => $hidden_endpoint,
-                            'args'            => $this->_get_delete_query_params($model, $version),
-                        ],
-                    ]
-                );
-            }
-            foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-                $related_route = EED_Core_Rest_Api::get_relation_route_via(
-                    $model,
-                    '(?P<id>[^\/]+)',
-                    $relation_obj
-                );
-                $model_routes[ $related_route ] = [
-                    [
-                        'callback'        => [
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                            'handleRequestGetRelated',
-                        ],
-                        'callback_args'   => [$version, $model_name, $relation_name],
-                        'methods'         => WP_REST_Server::READABLE,
-                        'hidden_endpoint' => $hidden_endpoint,
-                        'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
-                    ],
-                ];
-
-                $related_write_route = $related_route . '/' . '(?P<related_id>[^\/]+)';
-                $model_routes[ $related_write_route ] = [
-                    [
-                        'callback'        => [
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                            'handleRequestAddRelation',
-                        ],
-                        'callback_args'   => [$version, $model_name, $relation_name],
-                        'methods'         => WP_REST_Server::EDITABLE,
-                        'hidden_endpoint' => $hidden_endpoint,
-                        'args'            => $this->_get_add_relation_query_params(
-                            $model,
-                            $relation_obj->get_other_model(),
-                            $version
-                        ),
-                    ],
-                    [
-                        'callback'        => [
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                            'handleRequestRemoveRelation',
-                        ],
-                        'callback_args'   => [$version, $model_name, $relation_name],
-                        'methods'         => WP_REST_Server::DELETABLE,
-                        'hidden_endpoint' => $hidden_endpoint,
-                        'args'            => [],
-                    ],
-                ];
-            }
-        }
-        return $model_routes;
-    }
-
-
-    /**
-     * Gets the relative URI to a model's REST API plural route, after the EE4 versioned namespace,
-     * excluding the preceding slash.
-     * Eg you pass get_plural_route_to('Event') = 'events'
-     *
-     * @param EEM_Base $model
-     * @return string
-     */
-    public static function get_collection_route(EEM_Base $model)
-    {
-        return EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-    }
-
-
-    /**
-     * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
-     * excluding the preceding slash.
-     * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
-     *
-     * @param EEM_Base $model eg Event or Venue
-     * @param string   $id
-     * @return string
-     */
-    public static function get_entity_route($model, $id)
-    {
-        return EED_Core_Rest_Api::get_collection_route($model) . '/' . $id;
-    }
-
-
-    /**
-     * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
-     * excluding the preceding slash.
-     * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
-     *
-     * @param EEM_Base               $model eg Event or Venue
-     * @param string                 $id
-     * @param EE_Model_Relation_Base $relation_obj
-     * @return string
-     */
-    public static function get_relation_route_via(EEM_Base $model, $id, EE_Model_Relation_Base $relation_obj)
-    {
-        $related_model_name_endpoint_part = ModelRead::getRelatedEntityName(
-            $relation_obj->get_other_model()->get_this_model_name(),
-            $relation_obj
-        );
-        return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part;
-    }
-
-
-    /**
-     * Adds onto the $relative_route the EE4 REST API versioned namespace.
-     * Eg if given '4.8.36' and 'events', will return 'ee/v4.8.36/events'
-     *
-     * @param string $relative_route
-     * @param string $version
-     * @return string
-     */
-    public static function get_versioned_route_to($relative_route, $version = '4.8.36')
-    {
-        return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
-    }
-
-
-    /**
-     * Adds all the RPC-style routes (remote procedure call-like routes, ie
-     * routes that don't conform to the traditional REST CRUD-style).
-     *
-     * @deprecated since 4.9.1
-     */
-    protected function _register_rpc_routes()
-    {
-        $routes = [];
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
-            $routes[ EED_Core_Rest_Api::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version(
-                $version,
-                $hidden_endpoint
-            );
-        }
-        return $routes;
-    }
-
-
-    /**
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        $this_versions_routes = [];
-        // checkin endpoint
-        $this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = [
-            [
-                'callback'        => [
-                    'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
-                    'handleRequestToggleCheckin',
-                ],
-                'methods'         => WP_REST_Server::CREATABLE,
-                'hidden_endpoint' => $hidden_endpoint,
-                'args'            => [
-                    'force' => [
-                        'required'    => false,
-                        'default'     => false,
-                        'description' => esc_html__(
-                        // @codingStandardsIgnoreStart
-                            'Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        ),
-                    ],
-                ],
-                'callback_args'   => [$version],
-            ],
-        ];
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
-            $this_versions_routes,
-            $version,
-            $hidden_endpoint
-        );
-    }
-
-
-    /**
-     * Gets the query params that can be used when request one or many
-     *
-     * @param EEM_Base $model
-     * @param string   $version
-     * @return array
-     */
-    protected function _get_response_selection_query_params(EEM_Base $model, $version, $single_only = false)
-    {
-        EED_Core_Rest_Api::loadCalculatedModelFields();
-        $query_params = [
-            'include'   => [
-                'required' => false,
-                'default'  => '*',
-                'type'     => 'string',
-            ],
-            'calculate' => [
-                'required'          => false,
-                'default'           => '',
-                'enum'              => EED_Core_Rest_Api::$_field_calculator->retrieveCalculatedFieldsForModel($model),
-                'type'              => 'string',
-                // because we accept a CSV list of the enumerated strings, WP core validation and sanitization
-                // freaks out. We'll just validate this argument while handling the request
-                'validate_callback' => null,
-                'sanitize_callback' => null,
-            ],
-            'password'  => [
-                'required' => false,
-                'default'  => '',
-                'type'     => 'string',
-            ],
-        ];
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
-            $query_params,
-            $model,
-            $version
-        );
-    }
-
-
-    /**
-     * Gets the parameters acceptable for delete requests
-     *
-     * @param EEM_Base $model
-     * @param string   $version
-     * @return array
-     */
-    protected function _get_delete_query_params(EEM_Base $model, $version)
-    {
-        $params_for_delete = [
-            'allow_blocking' => [
-                'required' => false,
-                'default'  => true,
-                'type'     => 'boolean',
-            ],
-        ];
-        $params_for_delete['force'] = [
-            'required' => false,
-            'default'  => false,
-            'type'     => 'boolean',
-        ];
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___get_delete_query_params',
-            $params_for_delete,
-            $model,
-            $version
-        );
-    }
-
-
-    /**
-     * @param EEM_Base $source_model
-     * @param EEM_Base $related_model
-     * @param          $version
-     * @return array
-     * @throws EE_Error
-     * @since $VID:$
-     */
-    protected function _get_add_relation_query_params(EEM_Base $source_model, EEM_Base $related_model, $version)
-    {
-        // if they're related through a HABTM relation, check for any non-FKs
-        $all_relation_settings = $source_model->relation_settings();
-        $relation_settings = $all_relation_settings[ $related_model->get_this_model_name() ];
-        $params = [];
-        if ($relation_settings instanceof EE_HABTM_Relation && $relation_settings->hasNonKeyFields()) {
-            foreach ($relation_settings->getNonKeyFields() as $field) {
-                /* @var $field EE_Model_Field_Base */
-                $params[ $field->get_name() ] = [
-                    'required'          => ! $field->is_nullable(),
-                    'default'           => ModelDataTranslator::prepareFieldValueForJson(
-                        $field,
-                        $field->get_default_value(),
-                        $version
-                    ),
-                    'type'              => $field->getSchemaType(),
-                    'validate_callback' => null,
-                    'sanitize_callback' => null,
-                ];
-            }
-        }
-        return $params;
-    }
-
-
-    /**
-     * Gets info about reading query params that are acceptable
-     *
-     * @param EEM_Base $model eg 'Event' or 'Venue'
-     * @param string   $version
-     * @return array    describing the args acceptable when querying this model
-     * @throws EE_Error
-     */
-    protected function _get_read_query_params(EEM_Base $model, $version)
-    {
-        $default_orderby = [];
-        foreach ($model->get_combined_primary_key_fields() as $key_field) {
-            $default_orderby[ $key_field->get_name() ] = 'ASC';
-        }
-        return array_merge(
-            $this->_get_response_selection_query_params($model, $version),
-            [
-                'where'    => [
-                    'required'          => false,
-                    'default'           => [],
-                    'type'              => 'object',
-                    // because we accept an almost infinite list of possible where conditions, WP
-                    // core validation and sanitization freaks out. We'll just validate this argument
-                    // while handling the request
-                    'validate_callback' => null,
-                    'sanitize_callback' => null,
-                ],
-                'limit'    => [
-                    'required'          => false,
-                    'default'           => EED_Core_Rest_Api::get_default_query_limit(),
-                    'type'              => [
-                        'array',
-                        'string',
-                        'integer',
-                    ],
-                    // because we accept a variety of types, WP core validation and sanitization
-                    // freaks out. We'll just validate this argument while handling the request
-                    'validate_callback' => null,
-                    'sanitize_callback' => null,
-                ],
-                'order_by' => [
-                    'required'          => false,
-                    'default'           => $default_orderby,
-                    'type'              => [
-                        'object',
-                        'string',
-                    ],// because we accept a variety of types, WP core validation and sanitization
-                    // freaks out. We'll just validate this argument while handling the request
-                    'validate_callback' => null,
-                    'sanitize_callback' => null,
-                ],
-                'group_by' => [
-                    'required'          => false,
-                    'default'           => null,
-                    'type'              => [
-                        'object',
-                        'string',
-                    ],
-                    // because we accept  an almost infinite list of possible groupings,
-                    // WP core validation and sanitization
-                    // freaks out. We'll just validate this argument while handling the request
-                    'validate_callback' => null,
-                    'sanitize_callback' => null,
-                ],
-                'having'   => [
-                    'required'          => false,
-                    'default'           => null,
-                    'type'              => 'object',
-                    // because we accept an almost infinite list of possible where conditions, WP
-                    // core validation and sanitization freaks out. We'll just validate this argument
-                    // while handling the request
-                    'validate_callback' => null,
-                    'sanitize_callback' => null,
-                ],
-                'caps'     => [
-                    'required' => false,
-                    'default'  => EEM_Base::caps_read,
-                    'type'     => 'string',
-                    'enum'     => [
-                        EEM_Base::caps_read,
-                        EEM_Base::caps_read_admin,
-                        EEM_Base::caps_edit,
-                        EEM_Base::caps_delete,
-                    ],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Gets parameter information for a model regarding writing data
-     *
-     * @param string           $model_name
-     * @param ModelVersionInfo $model_version_info
-     * @param boolean          $create                                       whether this is for request to create (in
-     *                                                                       which case we need all required params) or
-     *                                                                       just to update (in which case we don't
-     *                                                                       need those on every request)
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_write_params(
-        $model_name,
-        ModelVersionInfo $model_version_info,
-        $create = false
-    ) {
-        $model = EE_Registry::instance()->load_model($model_name);
-        $fields = $model_version_info->fieldsOnModelInThisVersion($model);
-
-        // we do our own validation and sanitization within the controller
-        $sanitize_callback = function_exists('rest_validate_value_from_schema')
-            ? ['EED_Core_Rest_Api', 'default_sanitize_callback']
-            : null;
-        $args_info = [];
-        foreach ($fields as $field_name => $field_obj) {
-            if ($field_obj->is_auto_increment()) {
-                // totally ignore auto increment IDs
-                continue;
-            }
-            $arg_info = $field_obj->getSchema();
-            $required = $create && ! $field_obj->is_nullable() && $field_obj->get_default_value() === null;
-            $arg_info['required'] = $required;
-            // remove the read-only flag. If it were read-only we wouldn't list it as an argument while writing, right?
-            unset($arg_info['readonly']);
-            $schema_properties = $field_obj->getSchemaProperties();
-            if (
-                isset($schema_properties['raw'])
-                && $field_obj->getSchemaType() === 'object'
-            ) {
-                // if there's a "raw" form of this argument, use those properties instead
-                $arg_info = array_replace(
-                    $arg_info,
-                    $schema_properties['raw']
-                );
-            }
-            $arg_info['default'] = ModelDataTranslator::prepareFieldValueForJson(
-                $field_obj,
-                $field_obj->get_default_value(),
-                $model_version_info->requestedVersion()
-            );
-            $arg_info['sanitize_callback'] = $sanitize_callback;
-            $args_info[ $field_name ] = $arg_info;
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $gmt_arg_info = $arg_info;
-                $gmt_arg_info['description'] = sprintf(
-                    esc_html__(
-                        '%1$s - the value for this field in UTC. Ignored if %2$s is provided.',
-                        'event_espresso'
-                    ),
-                    $field_obj->get_nicename(),
-                    $field_name
-                );
-                $args_info[ $field_name . '_gmt' ] = $gmt_arg_info;
-            }
-        }
-        return $args_info;
-    }
-
-
-    /**
-     * Replacement for WP API's 'rest_parse_request_arg'.
-     * If the value is blank but not required, don't bother validating it.
-     * Also, it uses our email validation instead of WP API's default.
-     *
-     * @param                 $value
-     * @param WP_REST_Request $request
-     * @param                 $param
-     * @return bool|true|WP_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function default_sanitize_callback($value, WP_REST_Request $request, $param)
-    {
-        $attributes = $request->get_attributes();
-        if (
-            ! isset($attributes['args'][ $param ])
-            || ! is_array($attributes['args'][ $param ])
-        ) {
-            $validation_result = true;
-        } else {
-            $args = $attributes['args'][ $param ];
-            if (
-                (
-                    $value === ''
-                    || $value === null
-                )
-                && (! isset($args['required'])
-                    || $args['required'] === false
-                )
-            ) {
-                // not required and not provided? that's cool
-                $validation_result = true;
-            } elseif (
-                isset($args['format'])
-                      && $args['format'] === 'email'
-            ) {
-                $validation_result = true;
-                if (! EED_Core_Rest_Api::_validate_email($value)) {
-                    $validation_result = new WP_Error(
-                        'rest_invalid_param',
-                        esc_html__(
-                            'The email address is not valid or does not exist.',
-                            'event_espresso'
-                        )
-                    );
-                }
-            } else {
-                $validation_result = rest_validate_value_from_schema($value, $args, $param);
-            }
-        }
-        if (is_wp_error($validation_result)) {
-            return $validation_result;
-        }
-        return rest_sanitize_request_arg($value, $request, $param);
-    }
-
-
-    /**
-     * Returns whether or not this email address is valid. Copied from EE_Email_Validation_Strategy::_validate_email()
-     *
-     * @param $email
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected static function _validate_email($email)
-    {
-        try {
-            EmailAddressFactory::create($email);
-            return true;
-        } catch (EmailValidationException $e) {
-            return false;
-        }
-    }
-
-
-    /**
-     * Gets routes for the config
-     *
-     * @return array @see _register_model_routes
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_config_routes()
-    {
-        $config_routes = [];
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
-            $config_routes[ EED_Core_Rest_Api::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version(
-                $version,
-                $hidden_endpoint
-            );
-        }
-        return $config_routes;
-    }
-
-
-    /**
-     * Gets routes for the config for the specified version
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_config_route_data_for_version($version, $hidden_endpoint)
-    {
-        return [
-            'config'    => [
-                [
-                    'callback'        => [
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handleRequest',
-                    ],
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'callback_args'   => [$version],
-                ],
-            ],
-            'site_info' => [
-                [
-                    'callback'        => [
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handleRequestSiteInfo',
-                    ],
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'callback_args'   => [$version],
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * Gets the meta info routes
-     *
-     * @return array @see _register_model_routes
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_meta_routes()
-    {
-        $meta_routes = [];
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
-            $meta_routes[ EED_Core_Rest_Api::ee_api_namespace . $version ] = $this->_get_meta_route_data_for_version(
-                $version,
-                $hidden_endpoint
-            );
-        }
-        return $meta_routes;
-    }
-
-
-    /**
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        return [
-            'resources' => [
-                [
-                    'callback'        => [
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
-                        'handleRequestModelsMeta',
-                    ],
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'callback_args'   => [$version],
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * Tries to hide old 4.6 endpoints from the
-     *
-     * @param array $route_data
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function hide_old_endpoints($route_data)
-    {
-        // allow API clients to override which endpoints get hidden, in case
-        // they want to discover particular endpoints
-        // also, we don't have access to the request so we have to just grab it from the superglobal
-        $force_show_ee_namespace = ltrim(
-            EED_Core_Rest_Api::getRequest()->getRequestParam('force_show_ee_namespace'),
-            '/'
-        );
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
-            foreach ($relative_urls as $resource_name => $endpoints) {
-                foreach ($endpoints as $key => $endpoint) {
-                    // skip schema and other route options
-                    if (! is_numeric($key)) {
-                        continue;
-                    }
-                    // by default, hide "hidden_endpoint"s, unless the request indicates
-                    // to $force_show_ee_namespace, in which case only show that one
-                    // namespace's endpoints (and hide all others)
-                    if (
-                        ($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
-                        || ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '')
-                    ) {
-                        $full_route = '/' . ltrim($namespace, '/');
-                        $full_route .= '/' . ltrim($resource_name, '/');
-                        unset($route_data[ $full_route ]);
-                    }
-                }
-            }
-        }
-        return $route_data;
-    }
-
-
-    /**
-     * Returns an array describing which versions of core support serving requests for.
-     * Keys are core versions' major and minor version, and values are the
-     * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
-     * data by just removing a few models and fields from the responses. However, 4.15 might remove
-     * the answers table entirely, in which case it would be very difficult for
-     * it to serve 4.6-style responses.
-     * Versions of core that are missing from this array are unknowns.
-     * previous ver
-     *
-     * @return array
-     */
-    public static function version_compatibilities()
-    {
-        return apply_filters(
-            'FHEE__EED_Core_REST_API__version_compatibilities',
-            [
-                '4.8.29' => '4.8.29',
-                '4.8.33' => '4.8.29',
-                '4.8.34' => '4.8.29',
-                '4.8.36' => '4.8.29',
-            ]
-        );
-    }
-
-
-    /**
-     * Gets the latest API version served. Eg if there
-     * are two versions served of the API, 4.8.29 and 4.8.32, and
-     * we are on core version 4.8.34, it will return the string "4.8.32"
-     *
-     * @return string
-     */
-    public static function latest_rest_api_version()
-    {
-        $versions_served = EED_Core_Rest_Api::versions_served();
-        $versions_served_keys = array_keys($versions_served);
-        return end($versions_served_keys);
-    }
-
-
-    /**
-     * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
-     * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
-     * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
-     * We also indicate whether or not this version should be put in the index or not
-     *
-     * @return array keys are API version numbers (just major and minor numbers), and values
-     * are whether or not they should be hidden
-     */
-    public static function versions_served()
-    {
-        $versions_served = [];
-        $possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
-        $lowest_compatible_version = end($possibly_served_versions);
-        reset($possibly_served_versions);
-        $versions_served_historically = array_keys($possibly_served_versions);
-        $latest_version = end($versions_served_historically);
-        reset($versions_served_historically);
-        // for each version of core we have ever served:
-        foreach ($versions_served_historically as $key_versioned_endpoint) {
-            // if it's not above the current core version, and it's compatible with the current version of core
-
-            if ($key_versioned_endpoint === $latest_version) {
-                // don't hide the latest version in the index
-                $versions_served[ $key_versioned_endpoint ] = false;
-            } elseif (
-                version_compare($key_versioned_endpoint, $lowest_compatible_version, '>=')
-                && version_compare($key_versioned_endpoint, EED_Core_Rest_Api::core_version(), '<')
-            ) {
-                // include, but hide, previous versions which are still supported
-                $versions_served[ $key_versioned_endpoint ] = true;
-            } elseif (
-                apply_filters(
-                    'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
-                    false,
-                    $possibly_served_versions
-                )
-            ) {
-                // if a version is no longer supported, don't include it in index or list of versions served
-                $versions_served[ $key_versioned_endpoint ] = true;
-            }
-        }
-        return $versions_served;
-    }
-
-
-    /**
-     * Gets the major and minor version of EE core's version string
-     *
-     * @return string
-     */
-    public static function core_version()
-    {
-        return apply_filters(
-            'FHEE__EED_Core_REST_API__core_version',
-            implode(
-                '.',
-                array_slice(
-                    explode(
-                        '.',
-                        espresso_version()
-                    ),
-                    0,
-                    3
-                )
-            )
-        );
-    }
-
-
-    /**
-     * Gets the default limit that should be used when querying for resources
-     *
-     * @return int
-     */
-    public static function get_default_query_limit()
-    {
-        // we actually don't use a const because we want folks to always use
-        // this method, not the const directly
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api__get_default_query_limit',
-            50
-        );
-    }
-
-
-    /**
-     * @param string $version api version string (i.e. '4.8.36')
-     * @return array
-     */
-    public static function getCollectionRoutesIndexedByModelName($version = '')
-    {
-        $version = empty($version) ? EED_Core_Rest_Api::latest_rest_api_version() : $version;
-        $model_names = EED_Core_Rest_Api::model_names_with_plural_routes($version);
-        $collection_routes = [];
-        foreach ($model_names as $model_name => $model_class_name) {
-            $collection_routes[ strtolower($model_name) ] = '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/'
-                                                            . EEH_Inflector::pluralize_and_lower($model_name);
-        }
-        return $collection_routes;
-    }
-
-
-    /**
-     * Returns an array of primary key names indexed by model names.
-     *
-     * @param string $version
-     * @return array
-     */
-    public static function getPrimaryKeyNamesIndexedByModelName($version = '')
-    {
-        $version = empty($version) ? EED_Core_Rest_Api::latest_rest_api_version() : $version;
-        $model_names = EED_Core_Rest_Api::model_names_with_plural_routes($version);
-        $primary_key_items = [];
-        foreach ($model_names as $model_name => $model_class_name) {
-            $primary_keys = $model_class_name::instance()->get_combined_primary_key_fields();
-            foreach ($primary_keys as $primary_key_name => $primary_key_field) {
-                if (count($primary_keys) > 1) {
-                    $primary_key_items[ strtolower($model_name) ][] = $primary_key_name;
-                } else {
-                    $primary_key_items[ strtolower($model_name) ] = $primary_key_name;
-                }
-            }
-        }
-        return $primary_key_items;
-    }
-
-
-    /**
-     * Determines the EE REST API debug mode is activated, or not.
-     *
-     * @return bool
-     * @since 4.9.76.p
-     */
-    public static function debugMode()
-    {
-        static $debug_mode = null; // could be class prop
-        if ($debug_mode === null) {
-            $debug_mode = defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE;
-        }
-        return $debug_mode;
-    }
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @access    public
-     * @param WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
+	const ee_api_namespace = Domain::API_NAMESPACE;
+
+	const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
+
+	const saved_routes_option_names = 'ee_core_routes';
+
+	/**
+	 * string used in _links response bodies to make them globally unique.
+	 *
+	 * @see http://v2.wp-api.org/extending/linking/
+	 */
+	const ee_api_link_namespace = 'https://api.eventespresso.com/';
+
+	/**
+	 * @var CalculatedModelFields
+	 */
+	protected static $_field_calculator;
+
+
+	/**
+	 * @return EED_Core_Rest_Api|EED_Module
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(EED_Core_Rest_Api::class);
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
+
+
+	public static function set_hooks_both()
+	{
+		add_action('rest_api_init', ['EED_Core_Rest_Api', 'set_hooks_rest_api'], 5);
+		add_action('rest_api_init', ['EED_Core_Rest_Api', 'register_routes'], 10);
+		add_filter('rest_route_data', ['EED_Core_Rest_Api', 'hide_old_endpoints'], 10, 2);
+		add_filter(
+			'rest_index',
+			['EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filterEeMetadataIntoIndex']
+		);
+	}
+
+
+	/**
+	 * @since   $VID:$
+	 */
+	public static function loadCalculatedModelFields()
+	{
+		EED_Core_Rest_Api::$_field_calculator = LoaderFactory::getLoader()->load(
+			'EventEspresso\core\libraries\rest_api\CalculatedModelFields'
+		);
+		EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
+	}
+
+
+	/**
+	 * sets up hooks which only need to be included as part of REST API requests;
+	 * other requests like to the frontend or admin etc don't need them
+	 *
+	 * @throws EE_Error
+	 */
+	public static function set_hooks_rest_api()
+	{
+		// set hooks which account for changes made to the API
+		EED_Core_Rest_Api::_set_hooks_for_changes();
+	}
+
+
+	/**
+	 * public wrapper of _set_hooks_for_changes.
+	 * Loads all the hooks which make requests to old versions of the API
+	 * appear the same as they always did
+	 *
+	 * @throws EE_Error
+	 */
+	public static function set_hooks_for_changes()
+	{
+		EED_Core_Rest_Api::_set_hooks_for_changes();
+	}
+
+
+	/**
+	 * Loads all the hooks which make requests to old versions of the API
+	 * appear the same as they always did
+	 *
+	 * @throws EE_Error
+	 */
+	protected static function _set_hooks_for_changes()
+	{
+		$folder_contents = EEH_File::get_contents_of_folders([EE_LIBRARIES . 'rest_api/changes'], false);
+		foreach ($folder_contents as $classname_in_namespace => $filepath) {
+			// ignore the base parent class
+			// and legacy named classes
+			if (
+				$classname_in_namespace === 'ChangesInBase'
+				|| strpos($classname_in_namespace, 'Changes_In_') === 0
+			) {
+				continue;
+			}
+			$full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
+			if (class_exists($full_classname)) {
+				$instance_of_class = new $full_classname();
+				if ($instance_of_class instanceof ChangesInBase) {
+					$instance_of_class->setHooks();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Filters the WP routes to add our EE-related ones. This takes a bit of time
+	 * so we actually prefer to only do it when an EE plugin is activated or upgraded
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function register_routes()
+	{
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_routes) {
+			foreach ($relative_routes as $relative_route => $data_for_multiple_endpoints) {
+				/**
+				 * @var array     $data_for_multiple_endpoints numerically indexed array
+				 *                                         but can also contain route options like {
+				 * @type array    $schema                      {
+				 * @type callable $schema_callback
+				 * @type array    $callback_args               arguments that will be passed to the callback, after the
+				 * WP_REST_Request of course
+				 * }
+				 * }
+				 */
+				// when registering routes, register all the endpoints' data at the same time
+				$multiple_endpoint_args = [];
+				foreach ($data_for_multiple_endpoints as $endpoint_key => $data_for_single_endpoint) {
+					/**
+					 * @var array     $data_for_single_endpoint {
+					 * @type callable $callback
+					 * @type string methods
+					 * @type array args
+					 * @type array _links
+					 * @type array    $callback_args            arguments that will be passed to the callback, after the
+					 * WP_REST_Request of course
+					 * }
+					 */
+					// skip route options
+					if (! is_numeric($endpoint_key)) {
+						continue;
+					}
+					if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
+						throw new EE_Error(
+							esc_html__(
+							// @codingStandardsIgnoreStart
+								'Endpoint configuration data needs to have entries "callback" (callable) and "methods" (comma-separated list of accepts HTTP methods).',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							)
+						);
+					}
+					$callback = $data_for_single_endpoint['callback'];
+					$single_endpoint_args = [
+						'methods' => $data_for_single_endpoint['methods'],
+						'args'    => isset($data_for_single_endpoint['args']) ? $data_for_single_endpoint['args']
+							: [],
+					];
+					if (isset($data_for_single_endpoint['_links'])) {
+						$single_endpoint_args['_links'] = $data_for_single_endpoint['_links'];
+					}
+					if (isset($data_for_single_endpoint['callback_args'])) {
+						$callback_args = $data_for_single_endpoint['callback_args'];
+						$single_endpoint_args['callback'] = static function (WP_REST_Request $request) use (
+							$callback,
+							$callback_args
+						) {
+							array_unshift($callback_args, $request);
+							return call_user_func_array(
+								$callback,
+								$callback_args
+							);
+						};
+					} else {
+						$single_endpoint_args['callback'] = $data_for_single_endpoint['callback'];
+					}
+					// As of WordPress 5.5, if a permission_callback is not provided,
+					// the REST API will issue a _doing_it_wrong notice.
+					// Since the EE REST API defers capabilities to the db model system,
+					// we will just use the generic WP callback for public endpoints
+					if (! isset($single_endpoint_args['permission_callback'])) {
+						$single_endpoint_args['permission_callback'] = '__return_true';
+					}
+					$multiple_endpoint_args[] = $single_endpoint_args;
+				}
+				if (isset($data_for_multiple_endpoints['schema'])) {
+					$schema_route_data = $data_for_multiple_endpoints['schema'];
+					$schema_callback = $schema_route_data['schema_callback'];
+					$callback_args = $schema_route_data['callback_args'];
+					$multiple_endpoint_args['schema'] = static function () use ($schema_callback, $callback_args) {
+						return call_user_func_array(
+							$schema_callback,
+							$callback_args
+						);
+					};
+				}
+				register_rest_route(
+					$namespace,
+					$relative_route,
+					$multiple_endpoint_args
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * Checks if there was a version change or something that merits invalidating the cached
+	 * route data. If so, invalidates the cached route data so that it gets refreshed
+	 * next time the WP API is used
+	 */
+	public static function invalidate_cached_route_data_on_version_change()
+	{
+		if (EE_System::instance()->detect_req_type() !== EE_System::req_type_normal) {
+			EED_Core_Rest_Api::invalidate_cached_route_data();
+		}
+		foreach (EE_Registry::instance()->addons as $addon) {
+			if ($addon instanceof EE_Addon && $addon->detect_req_type() !== EE_System::req_type_normal) {
+				EED_Core_Rest_Api::invalidate_cached_route_data();
+			}
+		}
+	}
+
+
+	/**
+	 * Removes the cached route data so it will get refreshed next time the WP API is used
+	 */
+	public static function invalidate_cached_route_data()
+	{
+		// delete the saved EE REST API routes
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
+			delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
+		}
+	}
+
+
+	/**
+	 * Gets the EE route data
+	 *
+	 * @return array top-level key is the namespace, next-level key is the route and its value is array{
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @type string|array $callback
+	 * @type string       $methods
+	 * @type boolean      $hidden_endpoint
+	 * }
+	 */
+	public static function get_ee_route_data()
+	{
+		$ee_routes = [];
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoints) {
+			$ee_routes[ EED_Core_Rest_Api::ee_api_namespace . $version ] = EED_Core_Rest_Api::_get_ee_route_data_for_version(
+				$version,
+				$hidden_endpoints
+			);
+		}
+		return $ee_routes;
+	}
+
+
+	/**
+	 * Gets the EE route data from the wp options if it exists already,
+	 * otherwise re-generates it and saves it to the option
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoints
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$ee_routes = get_option(EED_Core_Rest_Api::saved_routes_option_names . $version, null);
+		if (! $ee_routes || EED_Core_Rest_Api::debugMode()) {
+			$ee_routes = EED_Core_Rest_Api::_save_ee_route_data_for_version($version, $hidden_endpoints);
+		}
+		return $ee_routes;
+	}
+
+
+	/**
+	 * Saves the EE REST API route data to a wp option and returns it
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoints
+	 * @return mixed|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$instance = EED_Core_Rest_Api::instance();
+		$routes = apply_filters(
+			'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
+			array_replace_recursive(
+				$instance->_get_config_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_model_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
+			)
+		);
+		$option_name = EED_Core_Rest_Api::saved_routes_option_names . $version;
+		if (get_option($option_name)) {
+			update_option($option_name, $routes, true);
+		} else {
+			add_option($option_name, $routes, null, 'no');
+		}
+		return $routes;
+	}
+
+
+	/**
+	 * Calculates all the EE routes and saves it to a WordPress option so we don't
+	 * need to calculate it on every request
+	 *
+	 * @return void
+	 * @deprecated since version 4.9.1
+	 */
+	public static function save_ee_routes()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$instance = EED_Core_Rest_Api::instance();
+			$routes = apply_filters(
+				'EED_Core_Rest_Api__save_ee_routes__routes',
+				array_replace_recursive(
+					$instance->_register_config_routes(),
+					$instance->_register_meta_routes(),
+					$instance->_register_model_routes(),
+					$instance->_register_rpc_routes()
+				)
+			);
+			update_option(EED_Core_Rest_Api::saved_routes_option_names, $routes, true);
+		}
+	}
+
+
+	/**
+	 * Gets all the route information relating to EE models
+	 *
+	 * @return array @see get_ee_route_data
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_model_routes()
+	{
+		$model_routes = [];
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
+			$model_routes[ EED_Core_Rest_Api::ee_api_namespace
+						   . $version ] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
+		}
+		return $model_routes;
+	}
+
+
+	/**
+	 * Decides whether or not to add write endpoints for this model.
+	 * Currently, this defaults to exclude all global tables and models
+	 * which would allow inserting WP core data (we don't want to duplicate
+	 * what WP API does, as it's unnecessary, extra work, and potentially extra bugs)
+	 *
+	 * @param EEM_Base $model
+	 * @return bool
+	 */
+	public static function should_have_write_endpoints(EEM_Base $model)
+	{
+		if ($model->is_wp_core_model()) {
+			return false;
+		}
+		foreach ($model->get_tables() as $table) {
+			if ($table->is_global()) {
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * Gets the names of all models which should have plural routes (eg `ee/v4.8.36/events`)
+	 * in this versioned namespace of EE4
+	 *
+	 * @param $version
+	 * @return array keys are model names (eg 'Event') and values ar either classnames (eg 'EEM_Event')
+	 */
+	public static function model_names_with_plural_routes($version)
+	{
+		$model_version_info = new ModelVersionInfo($version);
+		$models_to_register = $model_version_info->modelsForRequestedVersion();
+		// let's not bother having endpoints for extra metas
+		unset(
+			$models_to_register['Extra_Meta'],
+			$models_to_register['Extra_Join'],
+			$models_to_register['Post_Meta']
+		);
+		return apply_filters(
+			'FHEE__EED_Core_REST_API___register_model_routes',
+			$models_to_register
+		);
+	}
+
+
+	/**
+	 * Gets the route data for EE models in the specified version
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		$model_routes = [];
+		$model_version_info = new ModelVersionInfo($version);
+		foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) {
+			$model = EE_Registry::instance()->load_model($model_name);
+			// if this isn't a valid model then let's skip iterate to the next item in the loop.
+			if (! $model instanceof EEM_Base) {
+				continue;
+			}
+			// yes we could just register one route for ALL models, but then they wouldn't show up in the index
+			$plural_model_route = EED_Core_Rest_Api::get_collection_route($model);
+			$singular_model_route = EED_Core_Rest_Api::get_entity_route($model, '(?P<id>[^\/]+)');
+			$model_routes[ $plural_model_route ] = [
+				[
+					'callback'        => [
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handleRequestGetAll',
+					],
+					'callback_args'   => [$version, $model_name],
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_read_query_params($model, $version),
+					'_links'          => [
+						'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
+					],
+				],
+				'schema' => [
+					'schema_callback' => [
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handleSchemaRequest',
+					],
+					'callback_args'   => [$version, $model_name],
+				],
+			];
+			$model_routes[ $singular_model_route ] = [
+				[
+					'callback'        => [
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handleRequestGetOne',
+					],
+					'callback_args'   => [$version, $model_name],
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_response_selection_query_params($model, $version, true),
+				],
+			];
+			if (
+				apply_filters(
+					'FHEE__EED_Core_Rest_Api___get_model_route_data_for_version__add_write_endpoints',
+					EED_Core_Rest_Api::should_have_write_endpoints($model),
+					$model
+				)
+			) {
+				$model_routes[ $plural_model_route ][] = [
+					'callback'        => [
+						'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+						'handleRequestInsert',
+					],
+					'callback_args'   => [$version, $model_name],
+					'methods'         => WP_REST_Server::CREATABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_write_params($model_name, $model_version_info, true),
+				];
+				$model_routes[ $singular_model_route ] = array_merge(
+					$model_routes[ $singular_model_route ],
+					[
+						[
+							'callback'        => [
+								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+								'handleRequestUpdate',
+							],
+							'callback_args'   => [$version, $model_name],
+							'methods'         => WP_REST_Server::EDITABLE,
+							'hidden_endpoint' => $hidden_endpoint,
+							'args'            => $this->_get_write_params($model_name, $model_version_info),
+						],
+						[
+							'callback'        => [
+								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+								'handleRequestDelete',
+							],
+							'callback_args'   => [$version, $model_name],
+							'methods'         => WP_REST_Server::DELETABLE,
+							'hidden_endpoint' => $hidden_endpoint,
+							'args'            => $this->_get_delete_query_params($model, $version),
+						],
+					]
+				);
+			}
+			foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+				$related_route = EED_Core_Rest_Api::get_relation_route_via(
+					$model,
+					'(?P<id>[^\/]+)',
+					$relation_obj
+				);
+				$model_routes[ $related_route ] = [
+					[
+						'callback'        => [
+							'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+							'handleRequestGetRelated',
+						],
+						'callback_args'   => [$version, $model_name, $relation_name],
+						'methods'         => WP_REST_Server::READABLE,
+						'hidden_endpoint' => $hidden_endpoint,
+						'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
+					],
+				];
+
+				$related_write_route = $related_route . '/' . '(?P<related_id>[^\/]+)';
+				$model_routes[ $related_write_route ] = [
+					[
+						'callback'        => [
+							'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+							'handleRequestAddRelation',
+						],
+						'callback_args'   => [$version, $model_name, $relation_name],
+						'methods'         => WP_REST_Server::EDITABLE,
+						'hidden_endpoint' => $hidden_endpoint,
+						'args'            => $this->_get_add_relation_query_params(
+							$model,
+							$relation_obj->get_other_model(),
+							$version
+						),
+					],
+					[
+						'callback'        => [
+							'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+							'handleRequestRemoveRelation',
+						],
+						'callback_args'   => [$version, $model_name, $relation_name],
+						'methods'         => WP_REST_Server::DELETABLE,
+						'hidden_endpoint' => $hidden_endpoint,
+						'args'            => [],
+					],
+				];
+			}
+		}
+		return $model_routes;
+	}
+
+
+	/**
+	 * Gets the relative URI to a model's REST API plural route, after the EE4 versioned namespace,
+	 * excluding the preceding slash.
+	 * Eg you pass get_plural_route_to('Event') = 'events'
+	 *
+	 * @param EEM_Base $model
+	 * @return string
+	 */
+	public static function get_collection_route(EEM_Base $model)
+	{
+		return EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+	}
+
+
+	/**
+	 * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
+	 * excluding the preceding slash.
+	 * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
+	 *
+	 * @param EEM_Base $model eg Event or Venue
+	 * @param string   $id
+	 * @return string
+	 */
+	public static function get_entity_route($model, $id)
+	{
+		return EED_Core_Rest_Api::get_collection_route($model) . '/' . $id;
+	}
+
+
+	/**
+	 * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
+	 * excluding the preceding slash.
+	 * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
+	 *
+	 * @param EEM_Base               $model eg Event or Venue
+	 * @param string                 $id
+	 * @param EE_Model_Relation_Base $relation_obj
+	 * @return string
+	 */
+	public static function get_relation_route_via(EEM_Base $model, $id, EE_Model_Relation_Base $relation_obj)
+	{
+		$related_model_name_endpoint_part = ModelRead::getRelatedEntityName(
+			$relation_obj->get_other_model()->get_this_model_name(),
+			$relation_obj
+		);
+		return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part;
+	}
+
+
+	/**
+	 * Adds onto the $relative_route the EE4 REST API versioned namespace.
+	 * Eg if given '4.8.36' and 'events', will return 'ee/v4.8.36/events'
+	 *
+	 * @param string $relative_route
+	 * @param string $version
+	 * @return string
+	 */
+	public static function get_versioned_route_to($relative_route, $version = '4.8.36')
+	{
+		return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
+	}
+
+
+	/**
+	 * Adds all the RPC-style routes (remote procedure call-like routes, ie
+	 * routes that don't conform to the traditional REST CRUD-style).
+	 *
+	 * @deprecated since 4.9.1
+	 */
+	protected function _register_rpc_routes()
+	{
+		$routes = [];
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
+			$routes[ EED_Core_Rest_Api::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version(
+				$version,
+				$hidden_endpoint
+			);
+		}
+		return $routes;
+	}
+
+
+	/**
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		$this_versions_routes = [];
+		// checkin endpoint
+		$this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = [
+			[
+				'callback'        => [
+					'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
+					'handleRequestToggleCheckin',
+				],
+				'methods'         => WP_REST_Server::CREATABLE,
+				'hidden_endpoint' => $hidden_endpoint,
+				'args'            => [
+					'force' => [
+						'required'    => false,
+						'default'     => false,
+						'description' => esc_html__(
+						// @codingStandardsIgnoreStart
+							'Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						),
+					],
+				],
+				'callback_args'   => [$version],
+			],
+		];
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
+			$this_versions_routes,
+			$version,
+			$hidden_endpoint
+		);
+	}
+
+
+	/**
+	 * Gets the query params that can be used when request one or many
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $version
+	 * @return array
+	 */
+	protected function _get_response_selection_query_params(EEM_Base $model, $version, $single_only = false)
+	{
+		EED_Core_Rest_Api::loadCalculatedModelFields();
+		$query_params = [
+			'include'   => [
+				'required' => false,
+				'default'  => '*',
+				'type'     => 'string',
+			],
+			'calculate' => [
+				'required'          => false,
+				'default'           => '',
+				'enum'              => EED_Core_Rest_Api::$_field_calculator->retrieveCalculatedFieldsForModel($model),
+				'type'              => 'string',
+				// because we accept a CSV list of the enumerated strings, WP core validation and sanitization
+				// freaks out. We'll just validate this argument while handling the request
+				'validate_callback' => null,
+				'sanitize_callback' => null,
+			],
+			'password'  => [
+				'required' => false,
+				'default'  => '',
+				'type'     => 'string',
+			],
+		];
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
+			$query_params,
+			$model,
+			$version
+		);
+	}
+
+
+	/**
+	 * Gets the parameters acceptable for delete requests
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $version
+	 * @return array
+	 */
+	protected function _get_delete_query_params(EEM_Base $model, $version)
+	{
+		$params_for_delete = [
+			'allow_blocking' => [
+				'required' => false,
+				'default'  => true,
+				'type'     => 'boolean',
+			],
+		];
+		$params_for_delete['force'] = [
+			'required' => false,
+			'default'  => false,
+			'type'     => 'boolean',
+		];
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___get_delete_query_params',
+			$params_for_delete,
+			$model,
+			$version
+		);
+	}
+
+
+	/**
+	 * @param EEM_Base $source_model
+	 * @param EEM_Base $related_model
+	 * @param          $version
+	 * @return array
+	 * @throws EE_Error
+	 * @since $VID:$
+	 */
+	protected function _get_add_relation_query_params(EEM_Base $source_model, EEM_Base $related_model, $version)
+	{
+		// if they're related through a HABTM relation, check for any non-FKs
+		$all_relation_settings = $source_model->relation_settings();
+		$relation_settings = $all_relation_settings[ $related_model->get_this_model_name() ];
+		$params = [];
+		if ($relation_settings instanceof EE_HABTM_Relation && $relation_settings->hasNonKeyFields()) {
+			foreach ($relation_settings->getNonKeyFields() as $field) {
+				/* @var $field EE_Model_Field_Base */
+				$params[ $field->get_name() ] = [
+					'required'          => ! $field->is_nullable(),
+					'default'           => ModelDataTranslator::prepareFieldValueForJson(
+						$field,
+						$field->get_default_value(),
+						$version
+					),
+					'type'              => $field->getSchemaType(),
+					'validate_callback' => null,
+					'sanitize_callback' => null,
+				];
+			}
+		}
+		return $params;
+	}
+
+
+	/**
+	 * Gets info about reading query params that are acceptable
+	 *
+	 * @param EEM_Base $model eg 'Event' or 'Venue'
+	 * @param string   $version
+	 * @return array    describing the args acceptable when querying this model
+	 * @throws EE_Error
+	 */
+	protected function _get_read_query_params(EEM_Base $model, $version)
+	{
+		$default_orderby = [];
+		foreach ($model->get_combined_primary_key_fields() as $key_field) {
+			$default_orderby[ $key_field->get_name() ] = 'ASC';
+		}
+		return array_merge(
+			$this->_get_response_selection_query_params($model, $version),
+			[
+				'where'    => [
+					'required'          => false,
+					'default'           => [],
+					'type'              => 'object',
+					// because we accept an almost infinite list of possible where conditions, WP
+					// core validation and sanitization freaks out. We'll just validate this argument
+					// while handling the request
+					'validate_callback' => null,
+					'sanitize_callback' => null,
+				],
+				'limit'    => [
+					'required'          => false,
+					'default'           => EED_Core_Rest_Api::get_default_query_limit(),
+					'type'              => [
+						'array',
+						'string',
+						'integer',
+					],
+					// because we accept a variety of types, WP core validation and sanitization
+					// freaks out. We'll just validate this argument while handling the request
+					'validate_callback' => null,
+					'sanitize_callback' => null,
+				],
+				'order_by' => [
+					'required'          => false,
+					'default'           => $default_orderby,
+					'type'              => [
+						'object',
+						'string',
+					],// because we accept a variety of types, WP core validation and sanitization
+					// freaks out. We'll just validate this argument while handling the request
+					'validate_callback' => null,
+					'sanitize_callback' => null,
+				],
+				'group_by' => [
+					'required'          => false,
+					'default'           => null,
+					'type'              => [
+						'object',
+						'string',
+					],
+					// because we accept  an almost infinite list of possible groupings,
+					// WP core validation and sanitization
+					// freaks out. We'll just validate this argument while handling the request
+					'validate_callback' => null,
+					'sanitize_callback' => null,
+				],
+				'having'   => [
+					'required'          => false,
+					'default'           => null,
+					'type'              => 'object',
+					// because we accept an almost infinite list of possible where conditions, WP
+					// core validation and sanitization freaks out. We'll just validate this argument
+					// while handling the request
+					'validate_callback' => null,
+					'sanitize_callback' => null,
+				],
+				'caps'     => [
+					'required' => false,
+					'default'  => EEM_Base::caps_read,
+					'type'     => 'string',
+					'enum'     => [
+						EEM_Base::caps_read,
+						EEM_Base::caps_read_admin,
+						EEM_Base::caps_edit,
+						EEM_Base::caps_delete,
+					],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Gets parameter information for a model regarding writing data
+	 *
+	 * @param string           $model_name
+	 * @param ModelVersionInfo $model_version_info
+	 * @param boolean          $create                                       whether this is for request to create (in
+	 *                                                                       which case we need all required params) or
+	 *                                                                       just to update (in which case we don't
+	 *                                                                       need those on every request)
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_write_params(
+		$model_name,
+		ModelVersionInfo $model_version_info,
+		$create = false
+	) {
+		$model = EE_Registry::instance()->load_model($model_name);
+		$fields = $model_version_info->fieldsOnModelInThisVersion($model);
+
+		// we do our own validation and sanitization within the controller
+		$sanitize_callback = function_exists('rest_validate_value_from_schema')
+			? ['EED_Core_Rest_Api', 'default_sanitize_callback']
+			: null;
+		$args_info = [];
+		foreach ($fields as $field_name => $field_obj) {
+			if ($field_obj->is_auto_increment()) {
+				// totally ignore auto increment IDs
+				continue;
+			}
+			$arg_info = $field_obj->getSchema();
+			$required = $create && ! $field_obj->is_nullable() && $field_obj->get_default_value() === null;
+			$arg_info['required'] = $required;
+			// remove the read-only flag. If it were read-only we wouldn't list it as an argument while writing, right?
+			unset($arg_info['readonly']);
+			$schema_properties = $field_obj->getSchemaProperties();
+			if (
+				isset($schema_properties['raw'])
+				&& $field_obj->getSchemaType() === 'object'
+			) {
+				// if there's a "raw" form of this argument, use those properties instead
+				$arg_info = array_replace(
+					$arg_info,
+					$schema_properties['raw']
+				);
+			}
+			$arg_info['default'] = ModelDataTranslator::prepareFieldValueForJson(
+				$field_obj,
+				$field_obj->get_default_value(),
+				$model_version_info->requestedVersion()
+			);
+			$arg_info['sanitize_callback'] = $sanitize_callback;
+			$args_info[ $field_name ] = $arg_info;
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$gmt_arg_info = $arg_info;
+				$gmt_arg_info['description'] = sprintf(
+					esc_html__(
+						'%1$s - the value for this field in UTC. Ignored if %2$s is provided.',
+						'event_espresso'
+					),
+					$field_obj->get_nicename(),
+					$field_name
+				);
+				$args_info[ $field_name . '_gmt' ] = $gmt_arg_info;
+			}
+		}
+		return $args_info;
+	}
+
+
+	/**
+	 * Replacement for WP API's 'rest_parse_request_arg'.
+	 * If the value is blank but not required, don't bother validating it.
+	 * Also, it uses our email validation instead of WP API's default.
+	 *
+	 * @param                 $value
+	 * @param WP_REST_Request $request
+	 * @param                 $param
+	 * @return bool|true|WP_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function default_sanitize_callback($value, WP_REST_Request $request, $param)
+	{
+		$attributes = $request->get_attributes();
+		if (
+			! isset($attributes['args'][ $param ])
+			|| ! is_array($attributes['args'][ $param ])
+		) {
+			$validation_result = true;
+		} else {
+			$args = $attributes['args'][ $param ];
+			if (
+				(
+					$value === ''
+					|| $value === null
+				)
+				&& (! isset($args['required'])
+					|| $args['required'] === false
+				)
+			) {
+				// not required and not provided? that's cool
+				$validation_result = true;
+			} elseif (
+				isset($args['format'])
+					  && $args['format'] === 'email'
+			) {
+				$validation_result = true;
+				if (! EED_Core_Rest_Api::_validate_email($value)) {
+					$validation_result = new WP_Error(
+						'rest_invalid_param',
+						esc_html__(
+							'The email address is not valid or does not exist.',
+							'event_espresso'
+						)
+					);
+				}
+			} else {
+				$validation_result = rest_validate_value_from_schema($value, $args, $param);
+			}
+		}
+		if (is_wp_error($validation_result)) {
+			return $validation_result;
+		}
+		return rest_sanitize_request_arg($value, $request, $param);
+	}
+
+
+	/**
+	 * Returns whether or not this email address is valid. Copied from EE_Email_Validation_Strategy::_validate_email()
+	 *
+	 * @param $email
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected static function _validate_email($email)
+	{
+		try {
+			EmailAddressFactory::create($email);
+			return true;
+		} catch (EmailValidationException $e) {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Gets routes for the config
+	 *
+	 * @return array @see _register_model_routes
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_config_routes()
+	{
+		$config_routes = [];
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
+			$config_routes[ EED_Core_Rest_Api::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version(
+				$version,
+				$hidden_endpoint
+			);
+		}
+		return $config_routes;
+	}
+
+
+	/**
+	 * Gets routes for the config for the specified version
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_config_route_data_for_version($version, $hidden_endpoint)
+	{
+		return [
+			'config'    => [
+				[
+					'callback'        => [
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handleRequest',
+					],
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'callback_args'   => [$version],
+				],
+			],
+			'site_info' => [
+				[
+					'callback'        => [
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handleRequestSiteInfo',
+					],
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'callback_args'   => [$version],
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * Gets the meta info routes
+	 *
+	 * @return array @see _register_model_routes
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_meta_routes()
+	{
+		$meta_routes = [];
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
+			$meta_routes[ EED_Core_Rest_Api::ee_api_namespace . $version ] = $this->_get_meta_route_data_for_version(
+				$version,
+				$hidden_endpoint
+			);
+		}
+		return $meta_routes;
+	}
+
+
+	/**
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		return [
+			'resources' => [
+				[
+					'callback'        => [
+						'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
+						'handleRequestModelsMeta',
+					],
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'callback_args'   => [$version],
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * Tries to hide old 4.6 endpoints from the
+	 *
+	 * @param array $route_data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function hide_old_endpoints($route_data)
+	{
+		// allow API clients to override which endpoints get hidden, in case
+		// they want to discover particular endpoints
+		// also, we don't have access to the request so we have to just grab it from the superglobal
+		$force_show_ee_namespace = ltrim(
+			EED_Core_Rest_Api::getRequest()->getRequestParam('force_show_ee_namespace'),
+			'/'
+		);
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
+			foreach ($relative_urls as $resource_name => $endpoints) {
+				foreach ($endpoints as $key => $endpoint) {
+					// skip schema and other route options
+					if (! is_numeric($key)) {
+						continue;
+					}
+					// by default, hide "hidden_endpoint"s, unless the request indicates
+					// to $force_show_ee_namespace, in which case only show that one
+					// namespace's endpoints (and hide all others)
+					if (
+						($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
+						|| ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '')
+					) {
+						$full_route = '/' . ltrim($namespace, '/');
+						$full_route .= '/' . ltrim($resource_name, '/');
+						unset($route_data[ $full_route ]);
+					}
+				}
+			}
+		}
+		return $route_data;
+	}
+
+
+	/**
+	 * Returns an array describing which versions of core support serving requests for.
+	 * Keys are core versions' major and minor version, and values are the
+	 * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
+	 * data by just removing a few models and fields from the responses. However, 4.15 might remove
+	 * the answers table entirely, in which case it would be very difficult for
+	 * it to serve 4.6-style responses.
+	 * Versions of core that are missing from this array are unknowns.
+	 * previous ver
+	 *
+	 * @return array
+	 */
+	public static function version_compatibilities()
+	{
+		return apply_filters(
+			'FHEE__EED_Core_REST_API__version_compatibilities',
+			[
+				'4.8.29' => '4.8.29',
+				'4.8.33' => '4.8.29',
+				'4.8.34' => '4.8.29',
+				'4.8.36' => '4.8.29',
+			]
+		);
+	}
+
+
+	/**
+	 * Gets the latest API version served. Eg if there
+	 * are two versions served of the API, 4.8.29 and 4.8.32, and
+	 * we are on core version 4.8.34, it will return the string "4.8.32"
+	 *
+	 * @return string
+	 */
+	public static function latest_rest_api_version()
+	{
+		$versions_served = EED_Core_Rest_Api::versions_served();
+		$versions_served_keys = array_keys($versions_served);
+		return end($versions_served_keys);
+	}
+
+
+	/**
+	 * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
+	 * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
+	 * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
+	 * We also indicate whether or not this version should be put in the index or not
+	 *
+	 * @return array keys are API version numbers (just major and minor numbers), and values
+	 * are whether or not they should be hidden
+	 */
+	public static function versions_served()
+	{
+		$versions_served = [];
+		$possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
+		$lowest_compatible_version = end($possibly_served_versions);
+		reset($possibly_served_versions);
+		$versions_served_historically = array_keys($possibly_served_versions);
+		$latest_version = end($versions_served_historically);
+		reset($versions_served_historically);
+		// for each version of core we have ever served:
+		foreach ($versions_served_historically as $key_versioned_endpoint) {
+			// if it's not above the current core version, and it's compatible with the current version of core
+
+			if ($key_versioned_endpoint === $latest_version) {
+				// don't hide the latest version in the index
+				$versions_served[ $key_versioned_endpoint ] = false;
+			} elseif (
+				version_compare($key_versioned_endpoint, $lowest_compatible_version, '>=')
+				&& version_compare($key_versioned_endpoint, EED_Core_Rest_Api::core_version(), '<')
+			) {
+				// include, but hide, previous versions which are still supported
+				$versions_served[ $key_versioned_endpoint ] = true;
+			} elseif (
+				apply_filters(
+					'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
+					false,
+					$possibly_served_versions
+				)
+			) {
+				// if a version is no longer supported, don't include it in index or list of versions served
+				$versions_served[ $key_versioned_endpoint ] = true;
+			}
+		}
+		return $versions_served;
+	}
+
+
+	/**
+	 * Gets the major and minor version of EE core's version string
+	 *
+	 * @return string
+	 */
+	public static function core_version()
+	{
+		return apply_filters(
+			'FHEE__EED_Core_REST_API__core_version',
+			implode(
+				'.',
+				array_slice(
+					explode(
+						'.',
+						espresso_version()
+					),
+					0,
+					3
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the default limit that should be used when querying for resources
+	 *
+	 * @return int
+	 */
+	public static function get_default_query_limit()
+	{
+		// we actually don't use a const because we want folks to always use
+		// this method, not the const directly
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api__get_default_query_limit',
+			50
+		);
+	}
+
+
+	/**
+	 * @param string $version api version string (i.e. '4.8.36')
+	 * @return array
+	 */
+	public static function getCollectionRoutesIndexedByModelName($version = '')
+	{
+		$version = empty($version) ? EED_Core_Rest_Api::latest_rest_api_version() : $version;
+		$model_names = EED_Core_Rest_Api::model_names_with_plural_routes($version);
+		$collection_routes = [];
+		foreach ($model_names as $model_name => $model_class_name) {
+			$collection_routes[ strtolower($model_name) ] = '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/'
+															. EEH_Inflector::pluralize_and_lower($model_name);
+		}
+		return $collection_routes;
+	}
+
+
+	/**
+	 * Returns an array of primary key names indexed by model names.
+	 *
+	 * @param string $version
+	 * @return array
+	 */
+	public static function getPrimaryKeyNamesIndexedByModelName($version = '')
+	{
+		$version = empty($version) ? EED_Core_Rest_Api::latest_rest_api_version() : $version;
+		$model_names = EED_Core_Rest_Api::model_names_with_plural_routes($version);
+		$primary_key_items = [];
+		foreach ($model_names as $model_name => $model_class_name) {
+			$primary_keys = $model_class_name::instance()->get_combined_primary_key_fields();
+			foreach ($primary_keys as $primary_key_name => $primary_key_field) {
+				if (count($primary_keys) > 1) {
+					$primary_key_items[ strtolower($model_name) ][] = $primary_key_name;
+				} else {
+					$primary_key_items[ strtolower($model_name) ] = $primary_key_name;
+				}
+			}
+		}
+		return $primary_key_items;
+	}
+
+
+	/**
+	 * Determines the EE REST API debug mode is activated, or not.
+	 *
+	 * @return bool
+	 * @since 4.9.76.p
+	 */
+	public static function debugMode()
+	{
+		static $debug_mode = null; // could be class prop
+		if ($debug_mode === null) {
+			$debug_mode = defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE;
+		}
+		return $debug_mode;
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @param WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 }

core/helpers/EEH_Money.helper.php

Indentation +220 added lines, -220 removed lines

@@ -10,236 +10,236 @@
  */
 class EEH_Money extends EEH_Base
 {
-    /**
-     * This removes all localized money formatting from the incoming value
-     * Note: uses this site's currency settings for deciding what is considered a
-     * "thousands separator" (usually the character "," )
-     * and what is a "decimal mark" (usually the character ".")
-     *
-     * @param int|float|string $money_value
-     * @param string|null      $CNT_ISO
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function strip_localized_money_formatting($money_value, ?string $CNT_ISO = ''): float
-    {
-        $currency_config = EE_Currency_Config::getCurrencyConfig($CNT_ISO);
-        $money_value     = str_replace(
-            [
-                $currency_config->thsnds,
-                $currency_config->dec_mrk,
-            ],
-            [
-                '', // remove thousands separator
-                '.', // convert decimal mark to what PHP expects
-            ],
-            $money_value
-        );
-        return (float) filter_var(
-            $money_value,
-            FILTER_SANITIZE_NUMBER_FLOAT,
-            FILTER_FLAG_ALLOW_FRACTION
-        );
-    }
+	/**
+	 * This removes all localized money formatting from the incoming value
+	 * Note: uses this site's currency settings for deciding what is considered a
+	 * "thousands separator" (usually the character "," )
+	 * and what is a "decimal mark" (usually the character ".")
+	 *
+	 * @param int|float|string $money_value
+	 * @param string|null      $CNT_ISO
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function strip_localized_money_formatting($money_value, ?string $CNT_ISO = ''): float
+	{
+		$currency_config = EE_Currency_Config::getCurrencyConfig($CNT_ISO);
+		$money_value     = str_replace(
+			[
+				$currency_config->thsnds,
+				$currency_config->dec_mrk,
+			],
+			[
+				'', // remove thousands separator
+				'.', // convert decimal mark to what PHP expects
+			],
+			$money_value
+		);
+		return (float) filter_var(
+			$money_value,
+			FILTER_SANITIZE_NUMBER_FLOAT,
+			FILTER_FLAG_ALLOW_FRACTION
+		);
+	}
 
 
-    /**
-     * This converts an incoming localized money value into a standard float item (to three decimal places)
-     * Only use this if you know the $money_value follows your currency configuration's
-     * settings. Note: this uses this site's currency settings for deciding what is considered a
-     * "thousands separator" (usually the character "," )
-     * and what is a "decimal mark" (usually the character ".")
-     *
-     * @param int|float|string $money_value
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function convert_to_float_from_localized_money($money_value): float
-    {
-        // float it! and round to three decimal places
-        return round(EEH_Money::strip_localized_money_formatting($money_value), 3);
-    }
+	/**
+	 * This converts an incoming localized money value into a standard float item (to three decimal places)
+	 * Only use this if you know the $money_value follows your currency configuration's
+	 * settings. Note: this uses this site's currency settings for deciding what is considered a
+	 * "thousands separator" (usually the character "," )
+	 * and what is a "decimal mark" (usually the character ".")
+	 *
+	 * @param int|float|string $money_value
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function convert_to_float_from_localized_money($money_value): float
+	{
+		// float it! and round to three decimal places
+		return round(EEH_Money::strip_localized_money_formatting($money_value), 3);
+	}
 
 
-    /**
-     * For comparing floats. Default operator is '=', but see the $operator below for all options.
-     * This should be used to compare floats instead of normal '==' because floats
-     * are inherently imprecise, and so you can sometimes have two floats that appear to be identical
-     * but actually differ by 0.00000001.
-     *
-     * @see http://biostall.com/php-function-to-compare-floating-point-numbers
-     * @param int|float|string $float1
-     * @param int|float|string $float2
-     * @param string|null      $operator The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne
-     * @return bool whether the equation is true or false
-     * @throws EE_Error
-     */
-    public static function compare_floats($float1, $float2, ?string $operator = '='): bool
-    {
-        // Check numbers to 5 digits of precision
-        $epsilon = 0.00001;
-        $float1  = (float) $float1;
-        $float2  = (float) $float2;
-        switch ($operator) {
-            // equal
-            case '=':
-            case '==':
-            case '===':
-            case 'eq':
-                if (abs($float1 - $float2) < $epsilon) {
-                    return true;
-                }
-                break;
-            // less than
-            case '<':
-            case 'lt':
-                if (abs($float1 - $float2) < $epsilon) {
-                    return false;
-                }
-                if ($float1 < $float2) {
-                    return true;
-                }
-                break;
-            // less than or equal
-            case '<=':
-            case 'lte':
-                if (
-                    self::compare_floats($float1, $float2, '<')
-                    || self::compare_floats($float1, $float2)
-                ) {
-                    return true;
-                }
-                break;
-            // greater than
-            case '>':
-            case 'gt':
-                if (abs($float1 - $float2) < $epsilon) {
-                    return false;
-                }
-                if ($float1 > $float2) {
-                    return true;
-                }
-                break;
-            // greater than or equal
-            case '>=':
-            case 'gte':
-                if (
-                    self::compare_floats($float1, $float2, '>')
-                    || self::compare_floats($float1, $float2)
-                ) {
-                    return true;
-                }
-                break;
-            case '<>':
-            case '!=':
-            case '!==':
-            case 'ne':
-                if (abs($float1 - $float2) > $epsilon) {
-                    return true;
-                }
-                break;
-            default:
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "Unknown operator %s in EEH_Money::compare_floats()",
-                            'event_espresso'
-                        ),
-                        $operator
-                    )
-                );
-        }
-        return false;
-    }
+	/**
+	 * For comparing floats. Default operator is '=', but see the $operator below for all options.
+	 * This should be used to compare floats instead of normal '==' because floats
+	 * are inherently imprecise, and so you can sometimes have two floats that appear to be identical
+	 * but actually differ by 0.00000001.
+	 *
+	 * @see http://biostall.com/php-function-to-compare-floating-point-numbers
+	 * @param int|float|string $float1
+	 * @param int|float|string $float2
+	 * @param string|null      $operator The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne
+	 * @return bool whether the equation is true or false
+	 * @throws EE_Error
+	 */
+	public static function compare_floats($float1, $float2, ?string $operator = '='): bool
+	{
+		// Check numbers to 5 digits of precision
+		$epsilon = 0.00001;
+		$float1  = (float) $float1;
+		$float2  = (float) $float2;
+		switch ($operator) {
+			// equal
+			case '=':
+			case '==':
+			case '===':
+			case 'eq':
+				if (abs($float1 - $float2) < $epsilon) {
+					return true;
+				}
+				break;
+			// less than
+			case '<':
+			case 'lt':
+				if (abs($float1 - $float2) < $epsilon) {
+					return false;
+				}
+				if ($float1 < $float2) {
+					return true;
+				}
+				break;
+			// less than or equal
+			case '<=':
+			case 'lte':
+				if (
+					self::compare_floats($float1, $float2, '<')
+					|| self::compare_floats($float1, $float2)
+				) {
+					return true;
+				}
+				break;
+			// greater than
+			case '>':
+			case 'gt':
+				if (abs($float1 - $float2) < $epsilon) {
+					return false;
+				}
+				if ($float1 > $float2) {
+					return true;
+				}
+				break;
+			// greater than or equal
+			case '>=':
+			case 'gte':
+				if (
+					self::compare_floats($float1, $float2, '>')
+					|| self::compare_floats($float1, $float2)
+				) {
+					return true;
+				}
+				break;
+			case '<>':
+			case '!=':
+			case '!==':
+			case 'ne':
+				if (abs($float1 - $float2) > $epsilon) {
+					return true;
+				}
+				break;
+			default:
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"Unknown operator %s in EEH_Money::compare_floats()",
+							'event_espresso'
+						),
+						$operator
+					)
+				);
+		}
+		return false;
+	}
 
 
-    /**
-     * This returns a localized format string suitable for jQplot.
-     *
-     * @param string|null $CNT_ISO If this is provided, then will attempt to get the currency settings for the country.
-     *                             Otherwise will use currency settings for current active country on site.
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_format_for_jqplot(?string $CNT_ISO = ''): string
-    {
-        // default format
-        $format          = 'f';
-        $currency_config = EE_Currency_Config::getCurrencyConfig($CNT_ISO);
-        // first get the decimal place and number of places
-        $format = "%'." . $currency_config->dec_plc . $format;
-        // currency symbol on right side.
-        return $currency_config->sign_b4 ? $currency_config->sign . $format : $format . $currency_config->sign;
-    }
+	/**
+	 * This returns a localized format string suitable for jQplot.
+	 *
+	 * @param string|null $CNT_ISO If this is provided, then will attempt to get the currency settings for the country.
+	 *                             Otherwise will use currency settings for current active country on site.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_format_for_jqplot(?string $CNT_ISO = ''): string
+	{
+		// default format
+		$format          = 'f';
+		$currency_config = EE_Currency_Config::getCurrencyConfig($CNT_ISO);
+		// first get the decimal place and number of places
+		$format = "%'." . $currency_config->dec_plc . $format;
+		// currency symbol on right side.
+		return $currency_config->sign_b4 ? $currency_config->sign . $format : $format . $currency_config->sign;
+	}
 
 
-    /**
-     * This returns a localized format string suitable for usage with the Google Charts API format param.
-     *
-     * @param string|null $CNT_ISO If this is provided, then will attempt to get the currency settings for the country.
-     *                             Otherwise will use currency settings for current active country on site.
-     *                             Note: GoogleCharts uses ICU pattern set
-     *                             (@return array
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see http://icu-project.org/apiref/icu4c/classDecimalFormat.html#_details)
-     */
-    public static function get_format_for_google_charts(?string $CNT_ISO = ''): array
-    {
-        $currency_config            = EE_Currency_Config::getCurrencyConfig($CNT_ISO);
-        $decimal_places_placeholder = str_pad('', $currency_config->dec_plc, '0');
-        // first get the decimal place and number of places
-        $format = '#,##0.' . $decimal_places_placeholder;
-        // currency symbol on right side.
-        $format          = $currency_config->sign_b4
-            ? $currency_config->sign . $format
-            : $format
-              . $currency_config->sign;
-        $formatterObject = [
-            'decimalSymbol'  => $currency_config->dec_mrk,
-            'groupingSymbol' => $currency_config->thsnds,
-            'fractionDigits' => $currency_config->dec_plc,
-        ];
-        if ($currency_config->sign_b4) {
-            $formatterObject['prefix'] = $currency_config->sign;
-        } else {
-            $formatterObject['suffix'] = $currency_config->sign;
-        }
-        return [
-            'format'          => $format,
-            'formatterObject' => $formatterObject,
-        ];
-    }
+	/**
+	 * This returns a localized format string suitable for usage with the Google Charts API format param.
+	 *
+	 * @param string|null $CNT_ISO If this is provided, then will attempt to get the currency settings for the country.
+	 *                             Otherwise will use currency settings for current active country on site.
+	 *                             Note: GoogleCharts uses ICU pattern set
+	 *                             (@return array
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see http://icu-project.org/apiref/icu4c/classDecimalFormat.html#_details)
+	 */
+	public static function get_format_for_google_charts(?string $CNT_ISO = ''): array
+	{
+		$currency_config            = EE_Currency_Config::getCurrencyConfig($CNT_ISO);
+		$decimal_places_placeholder = str_pad('', $currency_config->dec_plc, '0');
+		// first get the decimal place and number of places
+		$format = '#,##0.' . $decimal_places_placeholder;
+		// currency symbol on right side.
+		$format          = $currency_config->sign_b4
+			? $currency_config->sign . $format
+			: $format
+			  . $currency_config->sign;
+		$formatterObject = [
+			'decimalSymbol'  => $currency_config->dec_mrk,
+			'groupingSymbol' => $currency_config->thsnds,
+			'fractionDigits' => $currency_config->dec_plc,
+		];
+		if ($currency_config->sign_b4) {
+			$formatterObject['prefix'] = $currency_config->sign;
+		} else {
+			$formatterObject['suffix'] = $currency_config->sign;
+		}
+		return [
+			'format'          => $format,
+			'formatterObject' => $formatterObject,
+		];
+	}
 
 
-    /**
-     * @param string|null $CNT_ISO
-     * @return EE_Currency_Config
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_currency_config(?string $CNT_ISO = ''): EE_Currency_Config
-    {
-        return EE_Currency_Config::getCurrencyConfig($CNT_ISO);
-    }
+	/**
+	 * @param string|null $CNT_ISO
+	 * @return EE_Currency_Config
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_currency_config(?string $CNT_ISO = ''): EE_Currency_Config
+	{
+		return EE_Currency_Config::getCurrencyConfig($CNT_ISO);
+	}
 
 
-    /**
-     * @param string|null $CNT_ISO
-     * @param bool        $as_decimal if false [default] will return the number of decimal places ex: 1, 2, 3
-     *                                if true, will return the subunits as a decimal fraction ex: .1, .01, .001
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since $VID:$
-     */
-    public static function getCurrencySubUnits(?string $CNT_ISO = '', bool $as_decimal = false): float
-    {
-        $currency_config = EE_Currency_Config::getCurrencyConfig($CNT_ISO);
-        return $as_decimal ? pow(10, ($currency_config->dec_plc * -1)) : $currency_config->dec_plc;
-    }
+	/**
+	 * @param string|null $CNT_ISO
+	 * @param bool        $as_decimal if false [default] will return the number of decimal places ex: 1, 2, 3
+	 *                                if true, will return the subunits as a decimal fraction ex: .1, .01, .001
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since $VID:$
+	 */
+	public static function getCurrencySubUnits(?string $CNT_ISO = '', bool $as_decimal = false): float
+	{
+		$currency_config = EE_Currency_Config::getCurrencyConfig($CNT_ISO);
+		return $as_decimal ? pow(10, ($currency_config->dec_plc * -1)) : $currency_config->dec_plc;
+	}
 }

core/db_models/EEM_Datetime.model.php

Indentation +838 added lines, -838 removed lines

@@ -12,842 +12,842 @@
  */
 class EEM_Datetime extends EEM_Soft_Delete_Base
 {
-    /**
-     * @var EEM_Datetime $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string $timezone A 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
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item           = esc_html__('Datetime', 'event_espresso');
-        $this->plural_item             = esc_html__('Datetimes', 'event_espresso');
-        $this->_tables                 = [
-            'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
-        ];
-        $this->_fields                 = [
-            'Datetime' => [
-                'DTT_ID'          => new EE_Primary_Key_Int_Field(
-                    'DTT_ID',
-                    esc_html__('Datetime ID', 'event_espresso')
-                ),
-                'EVT_ID'          => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Event ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'VNU_ID' => new EE_Foreign_Key_Int_Field(
-                    'VNU_ID',
-                    __('Venue ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Venue'
-                ),
-                'DTT_name'        => new EE_Plain_Text_Field(
-                    'DTT_name',
-                    esc_html__('Datetime Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'DTT_description' => new EE_Post_Content_Field(
-                    'DTT_description',
-                    esc_html__('Description for Datetime', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'DTT_EVT_start'   => new EE_Datetime_Field(
-                    'DTT_EVT_start',
-                    esc_html__('Start time/date of Event', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'DTT_EVT_end'     => new EE_Datetime_Field(
-                    'DTT_EVT_end',
-                    esc_html__('End time/date of Event', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'DTT_reg_limit'   => new EE_Infinite_Integer_Field(
-                    'DTT_reg_limit',
-                    esc_html__('Registration Limit for this time', 'event_espresso'),
-                    true,
-                    EE_INF
-                ),
-                'DTT_sold'        => new EE_Integer_Field(
-                    'DTT_sold',
-                    esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'DTT_reserved'    => new EE_Integer_Field(
-                    'DTT_reserved',
-                    esc_html__('Quantity of tickets reserved, but not yet fully purchased', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'DTT_is_primary'  => new EE_Boolean_Field(
-                    'DTT_is_primary',
-                    esc_html__('Flag indicating datetime is primary one for event', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'DTT_order'       => new EE_Integer_Field(
-                    'DTT_order',
-                    esc_html__('The order in which the Datetime is displayed', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'DTT_parent'      => new EE_Integer_Field(
-                    'DTT_parent',
-                    esc_html__('Indicates what DTT_ID is the parent of this DTT_ID', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'DTT_deleted'     => new EE_Trashed_Flag_Field(
-                    'DTT_deleted',
-                    esc_html__('Flag indicating datetime is archived', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations        = [
-            'Ticket'          => new EE_HABTM_Relation('Datetime_Ticket'),
-            'Event'           => new EE_Belongs_To_Relation(),
-            'Checkin'         => new EE_Has_Many_Relation(),
-            'Datetime_Ticket' => new EE_Has_Many_Relation(),
-            'Venue'           => new EE_Belongs_To_Relation(),
-        ];
-        $path_to_event_model           = 'Event';
-        $this->model_chain_to_password = $path_to_event_model;
-        $this->_model_chain_to_wp_user = $path_to_event_model;
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Event_Related_Public(
-                $path_to_event_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model,
-                EEM_Base::caps_edit
-            );
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * create new blank datetime
-     *
-     * @access public
-     * @return EE_Datetime[] array on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     */
-    public function create_new_blank_datetime()
-    {
-        // makes sure timezone is always set.
-        $timezone_string = $this->get_timezone();
-        /**
-         * Filters the initial start date for the new datetime.
-         * Any time included in this value will be overridden later so use additional filters to modify the time.
-         *
-         * @param int $start_date Unix timestamp representing now + 30 days in seconds.
-         * @return int Unix timestamp
-         */
-        $start_date = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__start_date',
-            $this->current_time_for_query('DTT_EVT_start', true) + MONTH_IN_SECONDS
-        );
-        /**
-         * Filters the initial end date for the new datetime.
-         * Any time included in this value will be overridden later so use additional filters to modify the time.
-         *
-         * @param int $end_data Unix timestamp representing now + 30 days in seconds.
-         * @return int Unix timestamp
-         */
-        $end_date       = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__end_date',
-            $this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS
-        );
-        $blank_datetime = EE_Datetime::new_instance(
-            [
-                'DTT_EVT_start' => $start_date,
-                'DTT_EVT_end'   => $end_date,
-                'DTT_order'     => 1,
-                'DTT_reg_limit' => EE_INF,
-            ],
-            $timezone_string
-        );
-        /**
-         * Filters the initial start time and format for the new EE_Datetime instance.
-         *
-         * @param array $start_time An array having size 2.  First element is the time, second element is the time
-         *                          format.
-         * @return array
-         */
-        $start_time = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__start_time',
-            ['8am', 'ga']
-        );
-        /**
-         * Filters the initial end time and format for the new EE_Datetime instance.
-         *
-         * @param array $end_time An array having size 2.  First element is the time, second element is the time
-         *                        format
-         * @return array
-         */
-        $end_time = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__end_time',
-            ['5pm', 'ga']
-        );
-        $this->validateStartAndEndTimeForBlankDate($start_time, $end_time);
-        $blank_datetime->set_start_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_start',
-                $start_time[0],
-                $start_time[1],
-                $timezone_string
-            )
-        );
-        $blank_datetime->set_end_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_end',
-                $end_time[0],
-                $end_time[1],
-                $timezone_string
-            )
-        );
-        return [$blank_datetime];
-    }
-
-
-    /**
-     * Validates whether the start_time and end_time are in the expected format.
-     *
-     * @param array $start_time
-     * @param array $end_time
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     */
-    private function validateStartAndEndTimeForBlankDate(array $start_time, array $end_time)
-    {
-        if (! is_array($start_time)) {
-            throw new InvalidDataTypeException('start_time', $start_time, 'array');
-        }
-        if (! is_array($end_time)) {
-            throw new InvalidDataTypeException('end_time', $end_time, 'array');
-        }
-        if (count($start_time) !== 2) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'The variable %1$s is expected to be an array with two elements.  The first item in the '
-                    . 'array should be a valid time string, the second item in the array should be a valid time format',
-                    '$start_time'
-                )
-            );
-        }
-        if (count($end_time) !== 2) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'The variable %1$s is expected to be an array with two elements.  The first item in the '
-                    . 'array should be a valid time string, the second item in the array should be a valid time format',
-                    '$end_time'
-                )
-            );
-        }
-    }
-
-
-    /**
-     * get event start date from db
-     *
-     * @access public
-     * @param int $EVT_ID
-     * @return EE_Datetime[] array on success, FALSE on fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_event_dates($EVT_ID = 0)
-    {
-        if (! $EVT_ID) { // on add_new_event event_id gets set to 0
-            return $this->create_new_blank_datetime();
-        }
-        $results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
-        if (empty($results)) {
-            return $this->create_new_blank_datetime();
-        }
-        return $results;
-    }
-
-
-    /**
-     * get all datetimes attached to an event ordered by the DTT_order field
-     *
-     * @public
-     * @param int     $EVT_ID     event id
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param int     $limit      If included then limit the count of results by
-     *                            the given number
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_event_ordered_by_DTT_order(
-        int $EVT_ID,
-        bool $include_expired = true,
-        bool $include_deleted = true,
-        $limit = 0
-    ) {
-        $prev_data_prep_value = $this->prepModelForQuery();
-        $where_params         = ['Event.EVT_ID' => absint($EVT_ID)];
-        $query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
-        $query_params         = $this->addDefaultWhereConditions($query_params);
-        $query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
-        return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
-    }
-
-
-    /**
-     * Gets the datetimes for the event (with the given limit), and orders them by "importance".
-     * By importance, we mean that the primary datetimes are most important (DEPRECATED FOR NOW),
-     * and then the earlier datetimes are the most important.
-     * Maybe we'll want this to take into account datetimes that haven't already passed, but we don't yet.
-     *
-     * @param int $EVT_ID
-     * @param int $limit
-     * @return EE_Datetime[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_event_ordered_by_importance(int $EVT_ID, $limit = 0)
-    {
-        $query_params[0] = ['Event.EVT_ID' => absint($EVT_ID)];
-        $query_params    = $this->addDefaultWhereConditions($query_params);
-        $query_params    = $this->addDefaultQueryParams($query_params, $limit);
-        return $this->get_all($query_params);
-    }
-
-
-    /**
-     * @param int     $EVT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function get_oldest_datetime_for_event(
-        int $EVT_ID,
-        bool $include_expired = false,
-        bool $include_deleted = false
-    ) {
-        $results = $this->get_datetimes_for_event_ordered_by_start_time(
-            $EVT_ID,
-            $include_expired,
-            $include_deleted,
-            1
-        );
-        if ($results) {
-            return array_shift($results);
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the 'primary' datetime for an event.
-     *
-     * @param int  $EVT_ID
-     * @param bool $try_to_exclude_expired
-     * @param bool $try_to_exclude_deleted
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function get_primary_datetime_for_event(
-        int $EVT_ID,
-        bool $try_to_exclude_expired = true,
-        bool $try_to_exclude_deleted = true
-    ) {
-        if ($try_to_exclude_expired) {
-            $non_expired = $this->get_oldest_datetime_for_event($EVT_ID, false, false);
-            if ($non_expired) {
-                return $non_expired;
-            }
-        }
-        if ($try_to_exclude_deleted) {
-            $expired_even = $this->get_oldest_datetime_for_event($EVT_ID, true);
-            if ($expired_even) {
-                return $expired_even;
-            }
-        }
-        return $this->get_oldest_datetime_for_event($EVT_ID, true, true);
-    }
-
-
-    /**
-     * Gets ALL the datetimes for an event (including trashed ones, for now), ordered
-     * only by start date
-     *
-     * @param int     $EVT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param int     $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_event_ordered_by_start_time(
-        int $EVT_ID,
-        bool $include_expired = true,
-        bool $include_deleted = true,
-        $limit = 0
-    ) {
-        $prev_data_prep_value = $this->prepModelForQuery();
-        $where_params         = ['Event.EVT_ID' => absint($EVT_ID)];
-        $query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
-        $query_params         = $this->addDefaultWhereConditions(
-            $query_params,
-            EEM_Base::default_where_conditions_this_only
-        );
-        $query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
-        return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
-    }
-
-
-    /**
-     * Gets ALL the datetimes for an ticket (including trashed ones, for now), ordered
-     * only by start date
-     *
-     * @param int     $TKT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param int     $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_ticket_ordered_by_start_time(
-        int $TKT_ID,
-        bool $include_expired = true,
-        bool $include_deleted = true,
-        $limit = 0
-    ) {
-        $prev_data_prep_value = $this->prepModelForQuery();
-        $where_params         = ['Ticket.TKT_ID' => absint($TKT_ID)];
-        $query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
-        $query_params         = $this->addDefaultQueryParams($query_params, $limit);
-        return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
-    }
-
-
-    /**
-     * Gets all the datetimes for a ticket (including trashed ones, for now), ordered by the DTT_order for the
-     * datetimes.
-     *
-     * @param int      $TKT_ID           ID of ticket to retrieve the datetimes for
-     * @param boolean  $include_expired  whether to include expired datetimes or not
-     * @param boolean  $include_deleted  whether to include trashed datetimes or not.
-     * @param int|null $limit            if null, no limit, if int then limit results by
-     *                                   that number
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_ticket_ordered_by_DTT_order(
-        int $TKT_ID,
-        bool $include_expired = true,
-        bool $include_deleted = true,
-        $limit = 0
-    ) {
-        $prev_data_prep_value = $this->prepModelForQuery();
-        $where_params         = ['Ticket.TKT_ID' => absint($TKT_ID)];
-        $query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
-        $query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
-        return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
-    }
-
-
-    /**
-     * Gets the most important datetime for a particular event (ie, the primary event usually. But if for some WACK
-     * reason it doesn't exist, we consider the earliest event the most important)
-     *
-     * @param int $EVT_ID
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function get_most_important_datetime_for_event(int $EVT_ID)
-    {
-        $results = $this->get_datetimes_for_event_ordered_by_importance($EVT_ID, 1);
-        if ($results) {
-            return array_shift($results);
-        }
-        return null;
-    }
-
-
-    /**
-     * This returns a wpdb->results        Array of all DTT month and years matching the incoming query params and
-     * grouped by month and year.
-     *
-     * @param array  $where_params       @see
-     *                                   https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @param string $evt_active_status  A string representing the evt active status to filter the months by.
-     *                                   Can be:
-     *                                   - '' = no filter
-     *                                   - upcoming = Published events with at least one upcoming datetime.
-     *                                   - expired = Events with all datetimes expired.
-     *                                   - active = Events that are published and have at least one datetime that
-     *                                   starts before now and ends after now.
-     *                                   - inactive = Events that are either not published.
-     * @return stdClass[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     */
-    public function get_dtt_months_and_years(array $where_params, $evt_active_status = '')
-    {
-        $current_time_for_DTT_EVT_start = $this->current_time_for_query('DTT_EVT_start');
-        $current_time_for_DTT_EVT_end   = $this->current_time_for_query('DTT_EVT_end');
-        switch ($evt_active_status) {
-            case 'upcoming':
-                $where_params['Event.status'] = 'publish';
-                // if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['DTT_EVT_start*****'] = $where_params['DTT_EVT_start'];
-                }
-                $where_params['DTT_EVT_start'] = ['>', $current_time_for_DTT_EVT_start];
-                break;
-            case 'expired':
-                if (isset($where_params['Event.status'])) {
-                    unset($where_params['Event.status']);
-                }
-                // get events to exclude
-                $exclude_query[0] = array_merge(
-                    $where_params,
-                    ['DTT_EVT_end' => ['>', $current_time_for_DTT_EVT_end]]
-                );
-                // first get all events that have datetimes where its not expired.
-                $event_ids = $this->_get_all_wpdb_results(
-                    $exclude_query,
-                    OBJECT_K,
-                    'Datetime.EVT_ID'
-                );
-                $event_ids = array_keys($event_ids);
-                if (isset($where_params['DTT_EVT_end'])) {
-                    $where_params['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
-                }
-                $where_params['DTT_EVT_end']  = ['<', $current_time_for_DTT_EVT_end];
-                $where_params['Event.EVT_ID'] = ['NOT IN', $event_ids];
-                break;
-            case 'active':
-                $where_params['Event.status'] = 'publish';
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['Datetime.DTT_EVT_start******'] = $where_params['DTT_EVT_start'];
-                }
-                if (isset($where_params['Datetime.DTT_EVT_end'])) {
-                    $where_params['Datetime.DTT_EVT_end*****'] = $where_params['DTT_EVT_end'];
-                }
-                $where_params['DTT_EVT_start'] = ['<', $current_time_for_DTT_EVT_start];
-                $where_params['DTT_EVT_end']   = ['>', $current_time_for_DTT_EVT_end];
-                break;
-            case 'inactive':
-                if (isset($where_params['Event.status'])) {
-                    unset($where_params['Event.status']);
-                }
-                if (isset($where_params['OR'])) {
-                    $where_params['AND']['OR'] = $where_params['OR'];
-                }
-                if (isset($where_params['DTT_EVT_end'])) {
-                    $where_params['AND']['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
-                    unset($where_params['DTT_EVT_end']);
-                }
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['AND']['DTT_EVT_start'] = $where_params['DTT_EVT_start'];
-                    unset($where_params['DTT_EVT_start']);
-                }
-                $where_params['AND']['Event.status'] = ['!=', 'publish'];
-                break;
-        }
-        $query_params[0]          = $where_params;
-        $query_params['group_by'] = ['dtt_year', 'dtt_month'];
-        $query_params             = $this->addOrderByQueryParams($query_params, 'DTT_EVT_start', 'DESC');
-
-        $query_interval    = EEH_DTT_Helper::get_sql_query_interval_for_offset(
-            $this->get_timezone(),
-            'DTT_EVT_start'
-        );
-        $columns_to_select = [
-            'dtt_year'      => ['YEAR(' . $query_interval . ')', '%s'],
-            'dtt_month'     => ['MONTHNAME(' . $query_interval . ')', '%s'],
-            'dtt_month_num' => ['MONTH(' . $query_interval . ')', '%s'],
-        ];
-        return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
-    }
-
-
-    /**
-     * Updates the DTT_sold attribute on each datetime (based on the registrations
-     * for the tickets for each datetime)
-     *
-     * @param EE_Base_Class[]|EE_Datetime[] $datetimes
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_sold(array $datetimes)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'Please use \EEM_Ticket::update_tickets_sold() instead which will in turn correctly update both the Ticket AND Datetime counts.',
-                'event_espresso'
-            ),
-            '4.9.32.rc.005'
-        );
-        foreach ($datetimes as $datetime) {
-            $datetime->update_sold();
-        }
-    }
-
-
-    /**
-     *    Gets the total number of tickets available at a particular datetime
-     *    (does NOT take into account the datetime's spaces available)
-     *
-     * @param int   $DTT_ID
-     * @param array $query_params
-     * @return int of tickets available. If sold out, return less than 1. If infinite, returns EE_INF,  IF there are NO
-     *             tickets attached to datetime then FALSE is returned.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function sum_tickets_currently_available_at_datetime(int $DTT_ID, array $query_params = [])
-    {
-        $datetime = $this->get_one_by_ID($DTT_ID);
-        if ($datetime instanceof EE_Datetime) {
-            return $datetime->tickets_remaining($query_params);
-        }
-        return 0;
-    }
-
-
-    /**
-     * This returns an array of counts of datetimes in the database for each Datetime status that can be queried.
-     *
-     * @param array $stati_to_include  If included you can restrict the statuses we return counts for by including the
-     *                                 stati you want counts for as values in the array.  An empty array returns counts
-     *                                 for all valid stati.
-     * @param array $query_params      If included can be used to refine the conditions for returning the count (i.e.
-     *                                 only for Datetimes connected to a specific event, or specific ticket.
-     * @return array  The value returned is an array indexed by Datetime Status and the values are the counts.  The
-     * @throws EE_Error
-     *                                 stati used as index keys are: EE_Datetime::active EE_Datetime::upcoming
-     *                                 EE_Datetime::expired
-     */
-    public function get_datetime_counts_by_status(array $stati_to_include = [], array $query_params = [])
-    {
-        // only accept where conditions for this query.
-        $_where            = isset($query_params[0]) ? $query_params[0] : [];
-        $status_query_args = [
-            EE_Datetime::active   => array_merge(
-                $_where,
-                ['DTT_EVT_start' => ['<', time()], 'DTT_EVT_end' => ['>', time()]]
-            ),
-            EE_Datetime::upcoming => array_merge(
-                $_where,
-                ['DTT_EVT_start' => ['>', time()]]
-            ),
-            EE_Datetime::expired  => array_merge(
-                $_where,
-                ['DTT_EVT_end' => ['<', time()]]
-            ),
-        ];
-        if (! empty($stati_to_include)) {
-            foreach (array_keys($status_query_args) as $status) {
-                if (! in_array($status, $stati_to_include, true)) {
-                    unset($status_query_args[ $status ]);
-                }
-            }
-        }
-        // loop through and query counts for each stati.
-        $status_query_results = [];
-        foreach ($status_query_args as $status => $status_where_conditions) {
-            $status_query_results[ $status ] = EEM_Datetime::count(
-                [$status_where_conditions],
-                'DTT_ID',
-                true
-            );
-        }
-        return $status_query_results;
-    }
-
-
-    /**
-     * Returns the specific count for a given Datetime status matching any given query_params.
-     *
-     * @param string $status Valid string representation for Datetime status requested. (Defaults to Active).
-     * @param array  $query_params
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = [])
-    {
-        $count = $this->get_datetime_counts_by_status([$status], $query_params);
-        return ! empty($count[ $status ]) ? $count[ $status ] : 0;
-    }
-
-
-    /**
-     * @return bool|int
-     * @since   $VID:$
-     */
-    private function prepModelForQuery()
-    {
-        $prev_data_prep_value = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        return $prev_data_prep_value;
-    }
-
-
-    /**
-     * @param array    $query_params
-     * @param bool|int $prev_data_prep_value
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function getDatetimesAndRestoreModel(array $query_params, $prev_data_prep_value)
-    {
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($prev_data_prep_value);
-        return $result;
-    }
-
-
-    /**
-     * @param array  $query_params
-     * @param int    $limit
-     * @param string $order_by
-     * @param string $order
-     * @return array
-     * @since   $VID:$
-     */
-    private function addDefaultQueryParams(array $query_params, $limit = 0, $order_by = 'DTT_EVT_start', $order = 'ASC')
-    {
-        $query_params = $this->addOrderByQueryParams($query_params, $order_by, $order);
-        $query_params = $this->addLimitQueryParams($query_params, $limit);
-        return $query_params;
-    }
-
-
-    /**
-     * @param array  $query_params
-     * @param string $default_where_conditions
-     * @return array
-     * @since   $VID:$
-     */
-    private function addDefaultWhereConditions(
-        array $query_params,
-        $default_where_conditions = EEM_Base::default_where_conditions_none
-    ) {
-        $query_params['default_where_conditions'] = $default_where_conditions;
-        return $query_params;
-    }
-
-
-    /**
-     * @param array $where_params
-     * @param bool  $include_deleted
-     * @param bool  $include_expired
-     * @return array
-     * @since   $VID:$
-     */
-    private function addDefaultWhereParams(array $where_params, bool $include_deleted = true, bool $include_expired = true)
-    {
-        $where_params = $this->addExpiredWhereParams($where_params, $include_expired);
-        $where_params = $this->addDeletedWhereParams($where_params, $include_deleted);
-        return $where_params;
-    }
-
-
-    /**
-     * @param array $where_params
-     * @param bool  $include_deleted
-     * @return array
-     * @since   $VID:$
-     */
-    private function addDeletedWhereParams(array $where_params, bool $include_deleted = true)
-    {
-        $deleted                     = $include_deleted ? [true, false] : [false];
-        $where_params['DTT_deleted'] = ['IN', $deleted];
-        return $where_params;
-    }
-
-
-    /**
-     * @param array $where_params
-     * @param bool  $include_expired
-     * @return array
-     * @since   $VID:$
-     */
-    private function addExpiredWhereParams(array $where_params, bool $include_expired = true)
-    {
-        if (! $include_expired) {
-            $where_params['DTT_EVT_end'] = ['>=', current_time('mysql', true)];
-        }
-        return $where_params;
-    }
-
-
-    /**
-     * @param array $query_params
-     * @param int   $limit
-     * @return array
-     * @since   $VID:$
-     */
-    private function addLimitQueryParams(array $query_params, $limit = 0)
-    {
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * @param array  $query_params
-     * @param string $order_by
-     * @param string $order
-     * @return array
-     * @since   $VID:$
-     */
-    private function addOrderByQueryParams(array $query_params, $order_by = 'DTT_EVT_start', $order = 'ASC')
-    {
-        $order                    = $order === 'ASC' ? 'ASC' : 'DESC';
-        $valid_order_columns      = ['DTT_ID', 'DTT_EVT_start', 'DTT_EVT_end', 'DTT_order'];
-        $order_by                 = in_array($order_by, $valid_order_columns, true) ? $order_by : 'DTT_EVT_start';
-        $query_params['order_by'] = [$order_by => $order];
-        return $query_params;
-    }
+	/**
+	 * @var EEM_Datetime $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string $timezone A 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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item           = esc_html__('Datetime', 'event_espresso');
+		$this->plural_item             = esc_html__('Datetimes', 'event_espresso');
+		$this->_tables                 = [
+			'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
+		];
+		$this->_fields                 = [
+			'Datetime' => [
+				'DTT_ID'          => new EE_Primary_Key_Int_Field(
+					'DTT_ID',
+					esc_html__('Datetime ID', 'event_espresso')
+				),
+				'EVT_ID'          => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('Event ID', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'VNU_ID' => new EE_Foreign_Key_Int_Field(
+					'VNU_ID',
+					__('Venue ID', 'event_espresso'),
+					false,
+					0,
+					'Venue'
+				),
+				'DTT_name'        => new EE_Plain_Text_Field(
+					'DTT_name',
+					esc_html__('Datetime Name', 'event_espresso'),
+					false,
+					''
+				),
+				'DTT_description' => new EE_Post_Content_Field(
+					'DTT_description',
+					esc_html__('Description for Datetime', 'event_espresso'),
+					false,
+					''
+				),
+				'DTT_EVT_start'   => new EE_Datetime_Field(
+					'DTT_EVT_start',
+					esc_html__('Start time/date of Event', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'DTT_EVT_end'     => new EE_Datetime_Field(
+					'DTT_EVT_end',
+					esc_html__('End time/date of Event', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'DTT_reg_limit'   => new EE_Infinite_Integer_Field(
+					'DTT_reg_limit',
+					esc_html__('Registration Limit for this time', 'event_espresso'),
+					true,
+					EE_INF
+				),
+				'DTT_sold'        => new EE_Integer_Field(
+					'DTT_sold',
+					esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
+					true,
+					0
+				),
+				'DTT_reserved'    => new EE_Integer_Field(
+					'DTT_reserved',
+					esc_html__('Quantity of tickets reserved, but not yet fully purchased', 'event_espresso'),
+					false,
+					0
+				),
+				'DTT_is_primary'  => new EE_Boolean_Field(
+					'DTT_is_primary',
+					esc_html__('Flag indicating datetime is primary one for event', 'event_espresso'),
+					false,
+					false
+				),
+				'DTT_order'       => new EE_Integer_Field(
+					'DTT_order',
+					esc_html__('The order in which the Datetime is displayed', 'event_espresso'),
+					false,
+					0
+				),
+				'DTT_parent'      => new EE_Integer_Field(
+					'DTT_parent',
+					esc_html__('Indicates what DTT_ID is the parent of this DTT_ID', 'event_espresso'),
+					true,
+					0
+				),
+				'DTT_deleted'     => new EE_Trashed_Flag_Field(
+					'DTT_deleted',
+					esc_html__('Flag indicating datetime is archived', 'event_espresso'),
+					false,
+					false
+				),
+			],
+		];
+		$this->_model_relations        = [
+			'Ticket'          => new EE_HABTM_Relation('Datetime_Ticket'),
+			'Event'           => new EE_Belongs_To_Relation(),
+			'Checkin'         => new EE_Has_Many_Relation(),
+			'Datetime_Ticket' => new EE_Has_Many_Relation(),
+			'Venue'           => new EE_Belongs_To_Relation(),
+		];
+		$path_to_event_model           = 'Event';
+		$this->model_chain_to_password = $path_to_event_model;
+		$this->_model_chain_to_wp_user = $path_to_event_model;
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Event_Related_Public(
+				$path_to_event_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model,
+				EEM_Base::caps_edit
+			);
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * create new blank datetime
+	 *
+	 * @access public
+	 * @return EE_Datetime[] array on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 */
+	public function create_new_blank_datetime()
+	{
+		// makes sure timezone is always set.
+		$timezone_string = $this->get_timezone();
+		/**
+		 * Filters the initial start date for the new datetime.
+		 * Any time included in this value will be overridden later so use additional filters to modify the time.
+		 *
+		 * @param int $start_date Unix timestamp representing now + 30 days in seconds.
+		 * @return int Unix timestamp
+		 */
+		$start_date = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__start_date',
+			$this->current_time_for_query('DTT_EVT_start', true) + MONTH_IN_SECONDS
+		);
+		/**
+		 * Filters the initial end date for the new datetime.
+		 * Any time included in this value will be overridden later so use additional filters to modify the time.
+		 *
+		 * @param int $end_data Unix timestamp representing now + 30 days in seconds.
+		 * @return int Unix timestamp
+		 */
+		$end_date       = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__end_date',
+			$this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS
+		);
+		$blank_datetime = EE_Datetime::new_instance(
+			[
+				'DTT_EVT_start' => $start_date,
+				'DTT_EVT_end'   => $end_date,
+				'DTT_order'     => 1,
+				'DTT_reg_limit' => EE_INF,
+			],
+			$timezone_string
+		);
+		/**
+		 * Filters the initial start time and format for the new EE_Datetime instance.
+		 *
+		 * @param array $start_time An array having size 2.  First element is the time, second element is the time
+		 *                          format.
+		 * @return array
+		 */
+		$start_time = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__start_time',
+			['8am', 'ga']
+		);
+		/**
+		 * Filters the initial end time and format for the new EE_Datetime instance.
+		 *
+		 * @param array $end_time An array having size 2.  First element is the time, second element is the time
+		 *                        format
+		 * @return array
+		 */
+		$end_time = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__end_time',
+			['5pm', 'ga']
+		);
+		$this->validateStartAndEndTimeForBlankDate($start_time, $end_time);
+		$blank_datetime->set_start_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_start',
+				$start_time[0],
+				$start_time[1],
+				$timezone_string
+			)
+		);
+		$blank_datetime->set_end_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_end',
+				$end_time[0],
+				$end_time[1],
+				$timezone_string
+			)
+		);
+		return [$blank_datetime];
+	}
+
+
+	/**
+	 * Validates whether the start_time and end_time are in the expected format.
+	 *
+	 * @param array $start_time
+	 * @param array $end_time
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 */
+	private function validateStartAndEndTimeForBlankDate(array $start_time, array $end_time)
+	{
+		if (! is_array($start_time)) {
+			throw new InvalidDataTypeException('start_time', $start_time, 'array');
+		}
+		if (! is_array($end_time)) {
+			throw new InvalidDataTypeException('end_time', $end_time, 'array');
+		}
+		if (count($start_time) !== 2) {
+			throw new InvalidArgumentException(
+				sprintf(
+					'The variable %1$s is expected to be an array with two elements.  The first item in the '
+					. 'array should be a valid time string, the second item in the array should be a valid time format',
+					'$start_time'
+				)
+			);
+		}
+		if (count($end_time) !== 2) {
+			throw new InvalidArgumentException(
+				sprintf(
+					'The variable %1$s is expected to be an array with two elements.  The first item in the '
+					. 'array should be a valid time string, the second item in the array should be a valid time format',
+					'$end_time'
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * get event start date from db
+	 *
+	 * @access public
+	 * @param int $EVT_ID
+	 * @return EE_Datetime[] array on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_event_dates($EVT_ID = 0)
+	{
+		if (! $EVT_ID) { // on add_new_event event_id gets set to 0
+			return $this->create_new_blank_datetime();
+		}
+		$results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
+		if (empty($results)) {
+			return $this->create_new_blank_datetime();
+		}
+		return $results;
+	}
+
+
+	/**
+	 * get all datetimes attached to an event ordered by the DTT_order field
+	 *
+	 * @public
+	 * @param int     $EVT_ID     event id
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param int     $limit      If included then limit the count of results by
+	 *                            the given number
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_event_ordered_by_DTT_order(
+		int $EVT_ID,
+		bool $include_expired = true,
+		bool $include_deleted = true,
+		$limit = 0
+	) {
+		$prev_data_prep_value = $this->prepModelForQuery();
+		$where_params         = ['Event.EVT_ID' => absint($EVT_ID)];
+		$query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
+		$query_params         = $this->addDefaultWhereConditions($query_params);
+		$query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
+		return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
+	}
+
+
+	/**
+	 * Gets the datetimes for the event (with the given limit), and orders them by "importance".
+	 * By importance, we mean that the primary datetimes are most important (DEPRECATED FOR NOW),
+	 * and then the earlier datetimes are the most important.
+	 * Maybe we'll want this to take into account datetimes that haven't already passed, but we don't yet.
+	 *
+	 * @param int $EVT_ID
+	 * @param int $limit
+	 * @return EE_Datetime[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_event_ordered_by_importance(int $EVT_ID, $limit = 0)
+	{
+		$query_params[0] = ['Event.EVT_ID' => absint($EVT_ID)];
+		$query_params    = $this->addDefaultWhereConditions($query_params);
+		$query_params    = $this->addDefaultQueryParams($query_params, $limit);
+		return $this->get_all($query_params);
+	}
+
+
+	/**
+	 * @param int     $EVT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function get_oldest_datetime_for_event(
+		int $EVT_ID,
+		bool $include_expired = false,
+		bool $include_deleted = false
+	) {
+		$results = $this->get_datetimes_for_event_ordered_by_start_time(
+			$EVT_ID,
+			$include_expired,
+			$include_deleted,
+			1
+		);
+		if ($results) {
+			return array_shift($results);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the 'primary' datetime for an event.
+	 *
+	 * @param int  $EVT_ID
+	 * @param bool $try_to_exclude_expired
+	 * @param bool $try_to_exclude_deleted
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function get_primary_datetime_for_event(
+		int $EVT_ID,
+		bool $try_to_exclude_expired = true,
+		bool $try_to_exclude_deleted = true
+	) {
+		if ($try_to_exclude_expired) {
+			$non_expired = $this->get_oldest_datetime_for_event($EVT_ID, false, false);
+			if ($non_expired) {
+				return $non_expired;
+			}
+		}
+		if ($try_to_exclude_deleted) {
+			$expired_even = $this->get_oldest_datetime_for_event($EVT_ID, true);
+			if ($expired_even) {
+				return $expired_even;
+			}
+		}
+		return $this->get_oldest_datetime_for_event($EVT_ID, true, true);
+	}
+
+
+	/**
+	 * Gets ALL the datetimes for an event (including trashed ones, for now), ordered
+	 * only by start date
+	 *
+	 * @param int     $EVT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param int     $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_event_ordered_by_start_time(
+		int $EVT_ID,
+		bool $include_expired = true,
+		bool $include_deleted = true,
+		$limit = 0
+	) {
+		$prev_data_prep_value = $this->prepModelForQuery();
+		$where_params         = ['Event.EVT_ID' => absint($EVT_ID)];
+		$query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
+		$query_params         = $this->addDefaultWhereConditions(
+			$query_params,
+			EEM_Base::default_where_conditions_this_only
+		);
+		$query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
+		return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
+	}
+
+
+	/**
+	 * Gets ALL the datetimes for an ticket (including trashed ones, for now), ordered
+	 * only by start date
+	 *
+	 * @param int     $TKT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param int     $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_ticket_ordered_by_start_time(
+		int $TKT_ID,
+		bool $include_expired = true,
+		bool $include_deleted = true,
+		$limit = 0
+	) {
+		$prev_data_prep_value = $this->prepModelForQuery();
+		$where_params         = ['Ticket.TKT_ID' => absint($TKT_ID)];
+		$query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
+		$query_params         = $this->addDefaultQueryParams($query_params, $limit);
+		return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
+	}
+
+
+	/**
+	 * Gets all the datetimes for a ticket (including trashed ones, for now), ordered by the DTT_order for the
+	 * datetimes.
+	 *
+	 * @param int      $TKT_ID           ID of ticket to retrieve the datetimes for
+	 * @param boolean  $include_expired  whether to include expired datetimes or not
+	 * @param boolean  $include_deleted  whether to include trashed datetimes or not.
+	 * @param int|null $limit            if null, no limit, if int then limit results by
+	 *                                   that number
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_ticket_ordered_by_DTT_order(
+		int $TKT_ID,
+		bool $include_expired = true,
+		bool $include_deleted = true,
+		$limit = 0
+	) {
+		$prev_data_prep_value = $this->prepModelForQuery();
+		$where_params         = ['Ticket.TKT_ID' => absint($TKT_ID)];
+		$query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
+		$query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
+		return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
+	}
+
+
+	/**
+	 * Gets the most important datetime for a particular event (ie, the primary event usually. But if for some WACK
+	 * reason it doesn't exist, we consider the earliest event the most important)
+	 *
+	 * @param int $EVT_ID
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function get_most_important_datetime_for_event(int $EVT_ID)
+	{
+		$results = $this->get_datetimes_for_event_ordered_by_importance($EVT_ID, 1);
+		if ($results) {
+			return array_shift($results);
+		}
+		return null;
+	}
+
+
+	/**
+	 * This returns a wpdb->results        Array of all DTT month and years matching the incoming query params and
+	 * grouped by month and year.
+	 *
+	 * @param array  $where_params       @see
+	 *                                   https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @param string $evt_active_status  A string representing the evt active status to filter the months by.
+	 *                                   Can be:
+	 *                                   - '' = no filter
+	 *                                   - upcoming = Published events with at least one upcoming datetime.
+	 *                                   - expired = Events with all datetimes expired.
+	 *                                   - active = Events that are published and have at least one datetime that
+	 *                                   starts before now and ends after now.
+	 *                                   - inactive = Events that are either not published.
+	 * @return stdClass[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 */
+	public function get_dtt_months_and_years(array $where_params, $evt_active_status = '')
+	{
+		$current_time_for_DTT_EVT_start = $this->current_time_for_query('DTT_EVT_start');
+		$current_time_for_DTT_EVT_end   = $this->current_time_for_query('DTT_EVT_end');
+		switch ($evt_active_status) {
+			case 'upcoming':
+				$where_params['Event.status'] = 'publish';
+				// if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['DTT_EVT_start*****'] = $where_params['DTT_EVT_start'];
+				}
+				$where_params['DTT_EVT_start'] = ['>', $current_time_for_DTT_EVT_start];
+				break;
+			case 'expired':
+				if (isset($where_params['Event.status'])) {
+					unset($where_params['Event.status']);
+				}
+				// get events to exclude
+				$exclude_query[0] = array_merge(
+					$where_params,
+					['DTT_EVT_end' => ['>', $current_time_for_DTT_EVT_end]]
+				);
+				// first get all events that have datetimes where its not expired.
+				$event_ids = $this->_get_all_wpdb_results(
+					$exclude_query,
+					OBJECT_K,
+					'Datetime.EVT_ID'
+				);
+				$event_ids = array_keys($event_ids);
+				if (isset($where_params['DTT_EVT_end'])) {
+					$where_params['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
+				}
+				$where_params['DTT_EVT_end']  = ['<', $current_time_for_DTT_EVT_end];
+				$where_params['Event.EVT_ID'] = ['NOT IN', $event_ids];
+				break;
+			case 'active':
+				$where_params['Event.status'] = 'publish';
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['Datetime.DTT_EVT_start******'] = $where_params['DTT_EVT_start'];
+				}
+				if (isset($where_params['Datetime.DTT_EVT_end'])) {
+					$where_params['Datetime.DTT_EVT_end*****'] = $where_params['DTT_EVT_end'];
+				}
+				$where_params['DTT_EVT_start'] = ['<', $current_time_for_DTT_EVT_start];
+				$where_params['DTT_EVT_end']   = ['>', $current_time_for_DTT_EVT_end];
+				break;
+			case 'inactive':
+				if (isset($where_params['Event.status'])) {
+					unset($where_params['Event.status']);
+				}
+				if (isset($where_params['OR'])) {
+					$where_params['AND']['OR'] = $where_params['OR'];
+				}
+				if (isset($where_params['DTT_EVT_end'])) {
+					$where_params['AND']['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
+					unset($where_params['DTT_EVT_end']);
+				}
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['AND']['DTT_EVT_start'] = $where_params['DTT_EVT_start'];
+					unset($where_params['DTT_EVT_start']);
+				}
+				$where_params['AND']['Event.status'] = ['!=', 'publish'];
+				break;
+		}
+		$query_params[0]          = $where_params;
+		$query_params['group_by'] = ['dtt_year', 'dtt_month'];
+		$query_params             = $this->addOrderByQueryParams($query_params, 'DTT_EVT_start', 'DESC');
+
+		$query_interval    = EEH_DTT_Helper::get_sql_query_interval_for_offset(
+			$this->get_timezone(),
+			'DTT_EVT_start'
+		);
+		$columns_to_select = [
+			'dtt_year'      => ['YEAR(' . $query_interval . ')', '%s'],
+			'dtt_month'     => ['MONTHNAME(' . $query_interval . ')', '%s'],
+			'dtt_month_num' => ['MONTH(' . $query_interval . ')', '%s'],
+		];
+		return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
+	}
+
+
+	/**
+	 * Updates the DTT_sold attribute on each datetime (based on the registrations
+	 * for the tickets for each datetime)
+	 *
+	 * @param EE_Base_Class[]|EE_Datetime[] $datetimes
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_sold(array $datetimes)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'Please use \EEM_Ticket::update_tickets_sold() instead which will in turn correctly update both the Ticket AND Datetime counts.',
+				'event_espresso'
+			),
+			'4.9.32.rc.005'
+		);
+		foreach ($datetimes as $datetime) {
+			$datetime->update_sold();
+		}
+	}
+
+
+	/**
+	 *    Gets the total number of tickets available at a particular datetime
+	 *    (does NOT take into account the datetime's spaces available)
+	 *
+	 * @param int   $DTT_ID
+	 * @param array $query_params
+	 * @return int of tickets available. If sold out, return less than 1. If infinite, returns EE_INF,  IF there are NO
+	 *             tickets attached to datetime then FALSE is returned.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function sum_tickets_currently_available_at_datetime(int $DTT_ID, array $query_params = [])
+	{
+		$datetime = $this->get_one_by_ID($DTT_ID);
+		if ($datetime instanceof EE_Datetime) {
+			return $datetime->tickets_remaining($query_params);
+		}
+		return 0;
+	}
+
+
+	/**
+	 * This returns an array of counts of datetimes in the database for each Datetime status that can be queried.
+	 *
+	 * @param array $stati_to_include  If included you can restrict the statuses we return counts for by including the
+	 *                                 stati you want counts for as values in the array.  An empty array returns counts
+	 *                                 for all valid stati.
+	 * @param array $query_params      If included can be used to refine the conditions for returning the count (i.e.
+	 *                                 only for Datetimes connected to a specific event, or specific ticket.
+	 * @return array  The value returned is an array indexed by Datetime Status and the values are the counts.  The
+	 * @throws EE_Error
+	 *                                 stati used as index keys are: EE_Datetime::active EE_Datetime::upcoming
+	 *                                 EE_Datetime::expired
+	 */
+	public function get_datetime_counts_by_status(array $stati_to_include = [], array $query_params = [])
+	{
+		// only accept where conditions for this query.
+		$_where            = isset($query_params[0]) ? $query_params[0] : [];
+		$status_query_args = [
+			EE_Datetime::active   => array_merge(
+				$_where,
+				['DTT_EVT_start' => ['<', time()], 'DTT_EVT_end' => ['>', time()]]
+			),
+			EE_Datetime::upcoming => array_merge(
+				$_where,
+				['DTT_EVT_start' => ['>', time()]]
+			),
+			EE_Datetime::expired  => array_merge(
+				$_where,
+				['DTT_EVT_end' => ['<', time()]]
+			),
+		];
+		if (! empty($stati_to_include)) {
+			foreach (array_keys($status_query_args) as $status) {
+				if (! in_array($status, $stati_to_include, true)) {
+					unset($status_query_args[ $status ]);
+				}
+			}
+		}
+		// loop through and query counts for each stati.
+		$status_query_results = [];
+		foreach ($status_query_args as $status => $status_where_conditions) {
+			$status_query_results[ $status ] = EEM_Datetime::count(
+				[$status_where_conditions],
+				'DTT_ID',
+				true
+			);
+		}
+		return $status_query_results;
+	}
+
+
+	/**
+	 * Returns the specific count for a given Datetime status matching any given query_params.
+	 *
+	 * @param string $status Valid string representation for Datetime status requested. (Defaults to Active).
+	 * @param array  $query_params
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = [])
+	{
+		$count = $this->get_datetime_counts_by_status([$status], $query_params);
+		return ! empty($count[ $status ]) ? $count[ $status ] : 0;
+	}
+
+
+	/**
+	 * @return bool|int
+	 * @since   $VID:$
+	 */
+	private function prepModelForQuery()
+	{
+		$prev_data_prep_value = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		return $prev_data_prep_value;
+	}
+
+
+	/**
+	 * @param array    $query_params
+	 * @param bool|int $prev_data_prep_value
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function getDatetimesAndRestoreModel(array $query_params, $prev_data_prep_value)
+	{
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($prev_data_prep_value);
+		return $result;
+	}
+
+
+	/**
+	 * @param array  $query_params
+	 * @param int    $limit
+	 * @param string $order_by
+	 * @param string $order
+	 * @return array
+	 * @since   $VID:$
+	 */
+	private function addDefaultQueryParams(array $query_params, $limit = 0, $order_by = 'DTT_EVT_start', $order = 'ASC')
+	{
+		$query_params = $this->addOrderByQueryParams($query_params, $order_by, $order);
+		$query_params = $this->addLimitQueryParams($query_params, $limit);
+		return $query_params;
+	}
+
+
+	/**
+	 * @param array  $query_params
+	 * @param string $default_where_conditions
+	 * @return array
+	 * @since   $VID:$
+	 */
+	private function addDefaultWhereConditions(
+		array $query_params,
+		$default_where_conditions = EEM_Base::default_where_conditions_none
+	) {
+		$query_params['default_where_conditions'] = $default_where_conditions;
+		return $query_params;
+	}
+
+
+	/**
+	 * @param array $where_params
+	 * @param bool  $include_deleted
+	 * @param bool  $include_expired
+	 * @return array
+	 * @since   $VID:$
+	 */
+	private function addDefaultWhereParams(array $where_params, bool $include_deleted = true, bool $include_expired = true)
+	{
+		$where_params = $this->addExpiredWhereParams($where_params, $include_expired);
+		$where_params = $this->addDeletedWhereParams($where_params, $include_deleted);
+		return $where_params;
+	}
+
+
+	/**
+	 * @param array $where_params
+	 * @param bool  $include_deleted
+	 * @return array
+	 * @since   $VID:$
+	 */
+	private function addDeletedWhereParams(array $where_params, bool $include_deleted = true)
+	{
+		$deleted                     = $include_deleted ? [true, false] : [false];
+		$where_params['DTT_deleted'] = ['IN', $deleted];
+		return $where_params;
+	}
+
+
+	/**
+	 * @param array $where_params
+	 * @param bool  $include_expired
+	 * @return array
+	 * @since   $VID:$
+	 */
+	private function addExpiredWhereParams(array $where_params, bool $include_expired = true)
+	{
+		if (! $include_expired) {
+			$where_params['DTT_EVT_end'] = ['>=', current_time('mysql', true)];
+		}
+		return $where_params;
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @param int   $limit
+	 * @return array
+	 * @since   $VID:$
+	 */
+	private function addLimitQueryParams(array $query_params, $limit = 0)
+	{
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * @param array  $query_params
+	 * @param string $order_by
+	 * @param string $order
+	 * @return array
+	 * @since   $VID:$
+	 */
+	private function addOrderByQueryParams(array $query_params, $order_by = 'DTT_EVT_start', $order = 'ASC')
+	{
+		$order                    = $order === 'ASC' ? 'ASC' : 'DESC';
+		$valid_order_columns      = ['DTT_ID', 'DTT_EVT_start', 'DTT_EVT_end', 'DTT_order'];
+		$order_by                 = in_array($order_by, $valid_order_columns, true) ? $order_by : 'DTT_EVT_start';
+		$query_params['order_by'] = [$order_by => $order];
+		return $query_params;
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Default_Protected.strategy.php

Indentation +160 added lines, -160 removed lines

@@ -14,164 +14,164 @@
  */
 class EE_Restriction_Generator_Default_Protected extends EE_Restriction_Generator_Base
 {
-    /**
-     * Name of the field on this model (or a related model, including the model chain to it)
-     * that is a boolean indicating whether or not a model object is considered "Default" or not
-     *
-     * @var string
-     */
-    protected $_default_field_name;
-
-    /**
-     * The model chain to follow to get to the event model, including the event model itself.
-     * Eg 'Ticket.Datetime.Event'
-     *
-     * @var string
-     */
-    protected $_path_to_event_model;
-
-
-    /**
-     * @param string $default_field_name  the name of the field Name of the field on this model
-     *                                    (or a related model, including the model chain to it)
-     *                                    that is a boolean indicating whether or not a model object
-     *                                    is considered "Default" or not
-     * @param string $path_to_event_model The model chain to follow to get to the event model,
-     *                                    including the event model itself. Eg 'Ticket.Datetime.Event'
-     */
-    public function __construct(string $default_field_name, string $path_to_event_model)
-    {
-        $this->_default_field_name  = $default_field_name;
-        $this->_path_to_event_model = rtrim($path_to_event_model, '.') . '.';
-    }
-
-
-    /**
-     * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
-     * @throws EE_Error
-     */
-    protected function _generate_restrictions(): array
-    {
-        // if there are no standard caps for this model, then for now
-        // all we know is if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
-            return [
-                self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions(),
-            ];
-        }
-
-        $action         = $this->action();
-        $others         = "{$action}_others";
-        $private        = "{$action}_private";
-        $default        = "{$action}_default";
-        $others_default = "{$action}_others_default";
-        $event_model    = EEM_Event::instance();
-
-        $restrictions = [
-            // first: access to non-defaults is essentially controlled by which events are accessible
-            // if they don't have the basic event cap, they can't access ANY non-default items
-            $this->getCapKey($event_model, $action)    => $this->nonDefaultRestrictions(true),
-            // if they don't have the others event cap, they can't access others' non-default items
-            $this->getCapKey($event_model, $others)    => $this->othersNonDefaultRestrictions($event_model, $others),
-            // if they have basic and others, but not private, they can't access others' private non-default items
-            $this->getCapKey($event_model, $private)   => $this->privateRestrictions($event_model, $private),
-            // second: access to defaults is controlled by the default capabilities
-            // if they don't have the default capability, restrict access to only non-default items
-            $this->getCapKey($this->model(), $default) => $this->nonDefaultRestrictions(false),
-        ];
-        // if they don't have the "others" default capability,
-        // restrict access to only their default ones, and non-default ones
-        if (EE_Restriction_Generator_Base::is_cap($this->model(), $others_default)) {
-            $restrictions[ $this->getCapKey($this->model(), $others_default) ] = $this->othersDefaultRestrictions(
-                $others_default
-            );
-        }
-        return $restrictions;
-    }
-
-
-    /**
-     * @param EEM_Base $model
-     * @param string   $action
-     * @return string
-     * @since   $VID:$
-     */
-    private function getCapKey(EEM_Base $model, string $action): string
-    {
-        return EE_Restriction_Generator_Base::get_cap_name($model, $action);
-    }
-
-
-    /**
-     * @param bool $use_default_field_name
-     * @return EE_Default_Where_Conditions
-     * @since   $VID:$
-     */
-    private function nonDefaultRestrictions(bool $use_default_field_name): EE_Default_Where_Conditions
-    {
-        return new EE_Default_Where_Conditions([$this->_default_field_name => $use_default_field_name]);
-    }
-
-
-    /**
-     * @param string $action
-     * @return EE_Default_Where_Conditions
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function othersDefaultRestrictions(string $action): EE_Default_Where_Conditions
-    {
-        return new EE_Default_Where_Conditions(
-            [
-                // if they don't have the others default cap, they can't access others default items
-                // (but they can access their own default items, and non-default items)
-                'OR*no_' . $this->getCapKey($this->model(), $action) => [
-                    'AND'                      => [
-                        $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                        $this->_default_field_name                  => true,
-                    ],
-                    $this->_default_field_name => false,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @param EEM_Event $event_model
-     * @param string    $action
-     * @return EE_Default_Where_Conditions
-     * @since   $VID:$
-     */
-    private function othersNonDefaultRestrictions(EEM_Event $event_model, string $action): EE_Default_Where_Conditions
-    {
-        return new EE_Default_Where_Conditions(
-            [
-                'OR*no_' . $this->getCapKey($event_model, $action) => [
-                    $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                ],
-                $this->_default_field_name                         => true,
-            ]
-        );
-    }
-
-
-    /**
-     * @param EEM_Event $event_model
-     * @param string    $action
-     * @return EE_Default_Where_Conditions
-     * @since   $VID:$
-     */
-    private function privateRestrictions(EEM_Event $event_model, string $action): EE_Default_Where_Conditions
-    {
-        return new EE_Default_Where_Conditions(
-            [
-                'OR*no_' . $this->getCapKey($event_model, $action) => [
-                    $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                    $this->_path_to_event_model . 'status'      => ['!=', 'private'],
-                    $this->_default_field_name                  => true,
-                ],
-            ]
-        );
-    }
+	/**
+	 * Name of the field on this model (or a related model, including the model chain to it)
+	 * that is a boolean indicating whether or not a model object is considered "Default" or not
+	 *
+	 * @var string
+	 */
+	protected $_default_field_name;
+
+	/**
+	 * The model chain to follow to get to the event model, including the event model itself.
+	 * Eg 'Ticket.Datetime.Event'
+	 *
+	 * @var string
+	 */
+	protected $_path_to_event_model;
+
+
+	/**
+	 * @param string $default_field_name  the name of the field Name of the field on this model
+	 *                                    (or a related model, including the model chain to it)
+	 *                                    that is a boolean indicating whether or not a model object
+	 *                                    is considered "Default" or not
+	 * @param string $path_to_event_model The model chain to follow to get to the event model,
+	 *                                    including the event model itself. Eg 'Ticket.Datetime.Event'
+	 */
+	public function __construct(string $default_field_name, string $path_to_event_model)
+	{
+		$this->_default_field_name  = $default_field_name;
+		$this->_path_to_event_model = rtrim($path_to_event_model, '.') . '.';
+	}
+
+
+	/**
+	 * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
+	 * @throws EE_Error
+	 */
+	protected function _generate_restrictions(): array
+	{
+		// if there are no standard caps for this model, then for now
+		// all we know is if they need the default cap to access this
+		if (! $this->model()->cap_slug()) {
+			return [
+				self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions(),
+			];
+		}
+
+		$action         = $this->action();
+		$others         = "{$action}_others";
+		$private        = "{$action}_private";
+		$default        = "{$action}_default";
+		$others_default = "{$action}_others_default";
+		$event_model    = EEM_Event::instance();
+
+		$restrictions = [
+			// first: access to non-defaults is essentially controlled by which events are accessible
+			// if they don't have the basic event cap, they can't access ANY non-default items
+			$this->getCapKey($event_model, $action)    => $this->nonDefaultRestrictions(true),
+			// if they don't have the others event cap, they can't access others' non-default items
+			$this->getCapKey($event_model, $others)    => $this->othersNonDefaultRestrictions($event_model, $others),
+			// if they have basic and others, but not private, they can't access others' private non-default items
+			$this->getCapKey($event_model, $private)   => $this->privateRestrictions($event_model, $private),
+			// second: access to defaults is controlled by the default capabilities
+			// if they don't have the default capability, restrict access to only non-default items
+			$this->getCapKey($this->model(), $default) => $this->nonDefaultRestrictions(false),
+		];
+		// if they don't have the "others" default capability,
+		// restrict access to only their default ones, and non-default ones
+		if (EE_Restriction_Generator_Base::is_cap($this->model(), $others_default)) {
+			$restrictions[ $this->getCapKey($this->model(), $others_default) ] = $this->othersDefaultRestrictions(
+				$others_default
+			);
+		}
+		return $restrictions;
+	}
+
+
+	/**
+	 * @param EEM_Base $model
+	 * @param string   $action
+	 * @return string
+	 * @since   $VID:$
+	 */
+	private function getCapKey(EEM_Base $model, string $action): string
+	{
+		return EE_Restriction_Generator_Base::get_cap_name($model, $action);
+	}
+
+
+	/**
+	 * @param bool $use_default_field_name
+	 * @return EE_Default_Where_Conditions
+	 * @since   $VID:$
+	 */
+	private function nonDefaultRestrictions(bool $use_default_field_name): EE_Default_Where_Conditions
+	{
+		return new EE_Default_Where_Conditions([$this->_default_field_name => $use_default_field_name]);
+	}
+
+
+	/**
+	 * @param string $action
+	 * @return EE_Default_Where_Conditions
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function othersDefaultRestrictions(string $action): EE_Default_Where_Conditions
+	{
+		return new EE_Default_Where_Conditions(
+			[
+				// if they don't have the others default cap, they can't access others default items
+				// (but they can access their own default items, and non-default items)
+				'OR*no_' . $this->getCapKey($this->model(), $action) => [
+					'AND'                      => [
+						$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+						$this->_default_field_name                  => true,
+					],
+					$this->_default_field_name => false,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @param EEM_Event $event_model
+	 * @param string    $action
+	 * @return EE_Default_Where_Conditions
+	 * @since   $VID:$
+	 */
+	private function othersNonDefaultRestrictions(EEM_Event $event_model, string $action): EE_Default_Where_Conditions
+	{
+		return new EE_Default_Where_Conditions(
+			[
+				'OR*no_' . $this->getCapKey($event_model, $action) => [
+					$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+				],
+				$this->_default_field_name                         => true,
+			]
+		);
+	}
+
+
+	/**
+	 * @param EEM_Event $event_model
+	 * @param string    $action
+	 * @return EE_Default_Where_Conditions
+	 * @since   $VID:$
+	 */
+	private function privateRestrictions(EEM_Event $event_model, string $action): EE_Default_Where_Conditions
+	{
+		return new EE_Default_Where_Conditions(
+			[
+				'OR*no_' . $this->getCapKey($event_model, $action) => [
+					$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+					$this->_path_to_event_model . 'status'      => ['!=', 'private'],
+					$this->_default_field_name                  => true,
+				],
+			]
+		);
+	}
 }

core/db_models/EEM_Price.model.php

Indentation +337 added lines, -337 removed lines

@@ -12,368 +12,368 @@
  */
 class EEM_Price extends EEM_Soft_Delete_Base
 {
-    // private instance of the EEM_Price object
-    protected static $_instance;
+	// private instance of the EEM_Price object
+	protected static $_instance;
 
 
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @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)
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = __('Price', 'event_espresso');
-        $this->plural_item   = __('Prices', 'event_espresso');
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @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)
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = __('Price', 'event_espresso');
+		$this->plural_item   = __('Prices', 'event_espresso');
 
-        $this->_tables          = [
-            'Price' => new EE_Primary_Table('esp_price', 'PRC_ID'),
-        ];
-        $this->_fields          = [
-            'Price' => [
-                'PRC_ID'         => new EE_Primary_Key_Int_Field(
-                    'PRC_ID',
-                    'Price ID'
-                ),
-                'PRT_ID'         => new EE_Foreign_Key_Int_Field(
-                    'PRT_ID',
-                    esc_html__('Price type Id', 'event_espresso'),
-                    false,
-                    null,
-                    'Price_Type'
-                ),
-                'PRC_amount'     => new EE_Money_Field(
-                    'PRC_amount',
-                    esc_html__('Price Amount', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'PRC_name'       => new EE_Plain_Text_Field(
-                    'PRC_name',
-                    esc_html__('Name of Price', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'PRC_desc'       => new EE_Post_Content_Field(
-                    'PRC_desc',
-                    esc_html__('Price Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'PRC_is_default' => new EE_Boolean_Field(
-                    'PRC_is_default',
-                    esc_html__('Flag indicating whether price is a default price', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PRC_overrides'  => new EE_Integer_Field(
-                    'PRC_overrides',
-                    esc_html__(
-                        'Price ID for a global Price that will be overridden by this Price  ( for replacing default prices )',
-                        'event_espresso'
-                    ),
-                    true,
-                    0
-                ),
-                'PRC_order'      => new EE_Integer_Field(
-                    'PRC_order',
-                    esc_html__(
-                        'Order of Application of Price (lower numbers apply first?)',
-                        'event_espresso'
-                    ),
-                    false,
-                    1
-                ),
-                'PRC_deleted'    => new EE_Trashed_Flag_Field(
-                    'PRC_deleted',
-                    esc_html__('Flag Indicating if this has been deleted or not', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PRC_parent'     => new EE_Integer_Field(
-                    'PRC_parent',
-                    esc_html__('Indicates what PRC_ID is the parent of this PRC_ID', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'PRC_wp_user'    => new EE_WP_User_Field(
-                    'PRC_wp_user',
-                    esc_html__('Price Creator ID', 'event_espresso'),
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Ticket'     => new EE_HABTM_Relation('Ticket_Price'),
-            'Price_Type' => new EE_Belongs_To_Relation(),
-            'WP_User'    => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] =
-            new EE_Restriction_Generator_Default_Public(
-                'PRC_is_default',
-                'Ticket.Datetime.Event'
-            );
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Default_Protected(
-                'PRC_is_default',
-                'Ticket.Datetime.Event'
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Default_Protected(
-                'PRC_is_default',
-                'Ticket.Datetime.Event'
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Default_Protected(
-                'PRC_is_default',
-                'Ticket.Datetime.Event'
-            );
-        parent::__construct($timezone);
-    }
+		$this->_tables          = [
+			'Price' => new EE_Primary_Table('esp_price', 'PRC_ID'),
+		];
+		$this->_fields          = [
+			'Price' => [
+				'PRC_ID'         => new EE_Primary_Key_Int_Field(
+					'PRC_ID',
+					'Price ID'
+				),
+				'PRT_ID'         => new EE_Foreign_Key_Int_Field(
+					'PRT_ID',
+					esc_html__('Price type Id', 'event_espresso'),
+					false,
+					null,
+					'Price_Type'
+				),
+				'PRC_amount'     => new EE_Money_Field(
+					'PRC_amount',
+					esc_html__('Price Amount', 'event_espresso'),
+					false,
+					0
+				),
+				'PRC_name'       => new EE_Plain_Text_Field(
+					'PRC_name',
+					esc_html__('Name of Price', 'event_espresso'),
+					false,
+					''
+				),
+				'PRC_desc'       => new EE_Post_Content_Field(
+					'PRC_desc',
+					esc_html__('Price Description', 'event_espresso'),
+					false,
+					''
+				),
+				'PRC_is_default' => new EE_Boolean_Field(
+					'PRC_is_default',
+					esc_html__('Flag indicating whether price is a default price', 'event_espresso'),
+					false,
+					false
+				),
+				'PRC_overrides'  => new EE_Integer_Field(
+					'PRC_overrides',
+					esc_html__(
+						'Price ID for a global Price that will be overridden by this Price  ( for replacing default prices )',
+						'event_espresso'
+					),
+					true,
+					0
+				),
+				'PRC_order'      => new EE_Integer_Field(
+					'PRC_order',
+					esc_html__(
+						'Order of Application of Price (lower numbers apply first?)',
+						'event_espresso'
+					),
+					false,
+					1
+				),
+				'PRC_deleted'    => new EE_Trashed_Flag_Field(
+					'PRC_deleted',
+					esc_html__('Flag Indicating if this has been deleted or not', 'event_espresso'),
+					false,
+					false
+				),
+				'PRC_parent'     => new EE_Integer_Field(
+					'PRC_parent',
+					esc_html__('Indicates what PRC_ID is the parent of this PRC_ID', 'event_espresso'),
+					true,
+					0
+				),
+				'PRC_wp_user'    => new EE_WP_User_Field(
+					'PRC_wp_user',
+					esc_html__('Price Creator ID', 'event_espresso'),
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Ticket'     => new EE_HABTM_Relation('Ticket_Price'),
+			'Price_Type' => new EE_Belongs_To_Relation(),
+			'WP_User'    => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] =
+			new EE_Restriction_Generator_Default_Public(
+				'PRC_is_default',
+				'Ticket.Datetime.Event'
+			);
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Default_Protected(
+				'PRC_is_default',
+				'Ticket.Datetime.Event'
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Default_Protected(
+				'PRC_is_default',
+				'Ticket.Datetime.Event'
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Default_Protected(
+				'PRC_is_default',
+				'Ticket.Datetime.Event'
+			);
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * instantiate a new price object with blank/empty properties
-     *
-     * @return mixed array on success, FALSE on fail
-     */
-    public function get_new_price()
-    {
-        return $this->create_default_object();
-    }
+	/**
+	 * instantiate a new price object with blank/empty properties
+	 *
+	 * @return mixed array on success, FALSE on fail
+	 */
+	public function get_new_price()
+	{
+		return $this->create_default_object();
+	}
 
 
-    /**
-     * retrieve  ALL prices from db
-     *
-     * @return EE_Base_Class[]|EE_PRice[]
-     * @throws EE_Error
-     */
-    public function get_all_prices()
-    {
-        // retrieve all prices
-        return $this->get_all(['order_by' => ['PRC_amount' => 'ASC']]);
-    }
+	/**
+	 * retrieve  ALL prices from db
+	 *
+	 * @return EE_Base_Class[]|EE_PRice[]
+	 * @throws EE_Error
+	 */
+	public function get_all_prices()
+	{
+		// retrieve all prices
+		return $this->get_all(['order_by' => ['PRC_amount' => 'ASC']]);
+	}
 
 
-    /**
-     * retrieve all active prices for a particular event
-     *
-     * @param int $EVT_ID
-     * @return array on success
-     * @throws EE_Error
-     */
-    public function get_all_event_prices($EVT_ID = 0)
-    {
-        return $this->get_all(
-            [
-                [
-                    'EVT_ID'            => $EVT_ID,
-                    'Price_Type.PBT_ID' => ['!=', EEM_Price_Type::base_type_tax],
-                ],
-                'order_by' => $this->_order_by_array_for_get_all_method(),
-            ]
-        );
-    }
+	/**
+	 * retrieve all active prices for a particular event
+	 *
+	 * @param int $EVT_ID
+	 * @return array on success
+	 * @throws EE_Error
+	 */
+	public function get_all_event_prices($EVT_ID = 0)
+	{
+		return $this->get_all(
+			[
+				[
+					'EVT_ID'            => $EVT_ID,
+					'Price_Type.PBT_ID' => ['!=', EEM_Price_Type::base_type_tax],
+				],
+				'order_by' => $this->_order_by_array_for_get_all_method(),
+			]
+		);
+	}
 
 
-    /**
-     * retrieve all active global prices (that are not taxes (PBT_ID=4)) for a particular event
-     *
-     * @param boolean $count return count
-     * @param bool    $include_taxes
-     * @return bool|EE_Base_Class[]|EE_PRice[]
-     * @throws EE_Error
-     */
-    public function get_all_default_prices($count = false, $include_taxes = false)
-    {
-        $_where = [
-            'PRC_deleted'    => 0,
-            'PRC_is_default' => 1,
-        ];
-        if (! $include_taxes) {
-            $_where['Price_Type.PBT_ID'] = ['!=', 4];
-        }
-        $_query_params = [
-            $_where,
-            'order_by' => $this->_order_by_array_for_get_all_method(),
-        ];
-        return $count ? $this->count([$_where]) : $this->get_all($_query_params);
-    }
+	/**
+	 * retrieve all active global prices (that are not taxes (PBT_ID=4)) for a particular event
+	 *
+	 * @param boolean $count return count
+	 * @param bool    $include_taxes
+	 * @return bool|EE_Base_Class[]|EE_PRice[]
+	 * @throws EE_Error
+	 */
+	public function get_all_default_prices($count = false, $include_taxes = false)
+	{
+		$_where = [
+			'PRC_deleted'    => 0,
+			'PRC_is_default' => 1,
+		];
+		if (! $include_taxes) {
+			$_where['Price_Type.PBT_ID'] = ['!=', 4];
+		}
+		$_query_params = [
+			$_where,
+			'order_by' => $this->_order_by_array_for_get_all_method(),
+		];
+		return $count ? $this->count([$_where]) : $this->get_all($_query_params);
+	}
 
 
-    /**
-     * retrieve all active global prices that are taxes
-     *
-     * @return bool|EE_Base_Class[]|EE_PRice[]
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    public function getAllDefaultTaxes()
-    {
-        return $this->get_all(
-            [
-                [
-                    'PRC_deleted'    => 0,
-                    'PRC_is_default' => 1,
-                    'Price_Type.PBT_ID' => EEM_Price_Type::base_type_tax
-                ],
-                'order_by' => [
-                    'Price_Type.PRT_order' => 'ASC',
-                    'PRC_order' => 'ASC'
-                ],
-            ]
-        );
-    }
+	/**
+	 * retrieve all active global prices that are taxes
+	 *
+	 * @return bool|EE_Base_Class[]|EE_PRice[]
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	public function getAllDefaultTaxes()
+	{
+		return $this->get_all(
+			[
+				[
+					'PRC_deleted'    => 0,
+					'PRC_is_default' => 1,
+					'Price_Type.PBT_ID' => EEM_Price_Type::base_type_tax
+				],
+				'order_by' => [
+					'Price_Type.PRT_order' => 'ASC',
+					'PRC_order' => 'ASC'
+				],
+			]
+		);
+	}
 
 
-    /**
-     * retrieve all prices that are taxes
-     *
-     * @return EE_Base_Class[]|EE_PRice[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_all_prices_that_are_taxes()
-    {
-        $taxes     = [];
-        $all_taxes = $this->get_all(
-            [
-                ['Price_Type.PBT_ID' => EEM_Price_Type::base_type_tax, 'PRC_is_default' => 1],
-                'order_by' => ['Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC'],
-            ]
-        );
-        foreach ($all_taxes as $tax) {
-            if ($tax instanceof EE_Price) {
-                $taxes[ $tax->order() ][ $tax->ID() ] = $tax;
-            }
-        }
-        return $taxes;
-    }
+	/**
+	 * retrieve all prices that are taxes
+	 *
+	 * @return EE_Base_Class[]|EE_PRice[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_all_prices_that_are_taxes()
+	{
+		$taxes     = [];
+		$all_taxes = $this->get_all(
+			[
+				['Price_Type.PBT_ID' => EEM_Price_Type::base_type_tax, 'PRC_is_default' => 1],
+				'order_by' => ['Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC'],
+			]
+		);
+		foreach ($all_taxes as $tax) {
+			if ($tax instanceof EE_Price) {
+				$taxes[ $tax->order() ][ $tax->ID() ] = $tax;
+			}
+		}
+		return $taxes;
+	}
 
 
-    /**
-     * retrieve all prices for an ticket plus default global prices, but not taxes
-     *
-     * @param int $TKT_ID the id of the event.  If not included then we assume that this is a new ticket.
-     * @return EE_Base_Class[]|EE_PRice[]|boolean
-     * @throws EE_Error
-     */
-    public function get_all_ticket_prices_for_admin($TKT_ID = 0)
-    {
-        $array_of_price_objects = [];
-        if (empty($TKT_ID)) {
-            // if there is no tkt, get prices with no tkt ID, are global, are not a tax, and are active
-            // return that list
-            $default_prices = $this->get_all_default_prices();
+	/**
+	 * retrieve all prices for an ticket plus default global prices, but not taxes
+	 *
+	 * @param int $TKT_ID the id of the event.  If not included then we assume that this is a new ticket.
+	 * @return EE_Base_Class[]|EE_PRice[]|boolean
+	 * @throws EE_Error
+	 */
+	public function get_all_ticket_prices_for_admin($TKT_ID = 0)
+	{
+		$array_of_price_objects = [];
+		if (empty($TKT_ID)) {
+			// if there is no tkt, get prices with no tkt ID, are global, are not a tax, and are active
+			// return that list
+			$default_prices = $this->get_all_default_prices();
 
-            if ($default_prices) {
-                foreach ($default_prices as $price) {
-                    if ($price instanceof EE_Price) {
-                        $array_of_price_objects[ $price->type() ][] = $price;
-                    }
-                }
-                return $array_of_price_objects;
-            }
-            return [];
-        }
-        $ticket_prices = $this->get_all(
-            [
-                [
-                    'TKT_ID'      => $TKT_ID,
-                    'PRC_deleted' => 0,
-                ],
-                'order_by' => ['PRC_order' => 'ASC'],
-            ]
-        );
+			if ($default_prices) {
+				foreach ($default_prices as $price) {
+					if ($price instanceof EE_Price) {
+						$array_of_price_objects[ $price->type() ][] = $price;
+					}
+				}
+				return $array_of_price_objects;
+			}
+			return [];
+		}
+		$ticket_prices = $this->get_all(
+			[
+				[
+					'TKT_ID'      => $TKT_ID,
+					'PRC_deleted' => 0,
+				],
+				'order_by' => ['PRC_order' => 'ASC'],
+			]
+		);
 
-        if (! empty($ticket_prices)) {
-            foreach ($ticket_prices as $price) {
-                if ($price instanceof EE_Price) {
-                    $array_of_price_objects[ $price->type() ][] = $price;
-                }
-            }
-            return $array_of_price_objects;
-        }
-        return false;
-    }
+		if (! empty($ticket_prices)) {
+			foreach ($ticket_prices as $price) {
+				if ($price instanceof EE_Price) {
+					$array_of_price_objects[ $price->type() ][] = $price;
+				}
+			}
+			return $array_of_price_objects;
+		}
+		return false;
+	}
 
 
-    /**
-     * _sort_event_prices_by_type
-     *
-     * @param EE_Price $price_a
-     * @param EE_Price $price_b
-     * @return bool false on fail
-     */
-    public function _sort_event_prices_by_type(EE_Price $price_a, EE_Price $price_b)
-    {
-        if ($price_a->type_obj()->order() === $price_b->type_obj()->order()) {
-            return $this->_sort_event_prices_by_order($price_a, $price_b);
-        }
-        return $price_a->type_obj()->order() < $price_b->type_obj()->order() ? -1 : 1;
-    }
+	/**
+	 * _sort_event_prices_by_type
+	 *
+	 * @param EE_Price $price_a
+	 * @param EE_Price $price_b
+	 * @return bool false on fail
+	 */
+	public function _sort_event_prices_by_type(EE_Price $price_a, EE_Price $price_b)
+	{
+		if ($price_a->type_obj()->order() === $price_b->type_obj()->order()) {
+			return $this->_sort_event_prices_by_order($price_a, $price_b);
+		}
+		return $price_a->type_obj()->order() < $price_b->type_obj()->order() ? -1 : 1;
+	}
 
 
-    /**
-     *        _sort_event_prices_by_order
-     *
-     * @param EE_Price $price_a
-     * @param EE_Price $price_b
-     * @return bool false on fail
-     */
-    public function _sort_event_prices_by_order(EE_Price $price_a, EE_Price $price_b)
-    {
-        if ($price_a->order() === $price_b->order()) {
-            return 0;
-        }
-        return $price_a->order() < $price_b->order() ? -1 : 1;
-    }
+	/**
+	 *        _sort_event_prices_by_order
+	 *
+	 * @param EE_Price $price_a
+	 * @param EE_Price $price_b
+	 * @return bool false on fail
+	 */
+	public function _sort_event_prices_by_order(EE_Price $price_a, EE_Price $price_b)
+	{
+		if ($price_a->order() === $price_b->order()) {
+			return 0;
+		}
+		return $price_a->order() < $price_b->order() ? -1 : 1;
+	}
 
 
-    /**
-     * get all prices of a specific type
-     *
-     * @param int $type - PRT_ID
-     * @return EE_Base_Class[]|EE_PRice[]
-     * @throws EE_Error
-     */
-    public function get_all_prices_that_are_type($type = 0)
-    {
-        return $this->get_all(
-            [
-                [
-                    'PRT_ID' => $type,
-                ],
-                'order_by' => $this->_order_by_array_for_get_all_method(),
-            ]
-        );
-    }
+	/**
+	 * get all prices of a specific type
+	 *
+	 * @param int $type - PRT_ID
+	 * @return EE_Base_Class[]|EE_PRice[]
+	 * @throws EE_Error
+	 */
+	public function get_all_prices_that_are_type($type = 0)
+	{
+		return $this->get_all(
+			[
+				[
+					'PRT_ID' => $type,
+				],
+				'order_by' => $this->_order_by_array_for_get_all_method(),
+			]
+		);
+	}
 
 
-    /**
-     * Returns an array of the normal 'order_by' query parameter provided to the get_all query.
-     * Of course you don't have to use it, but this is the order we usually want to sort prices by
-     *
-     * @return array which can be used like so: $this->get_all(array(array(...where
-     *               stuff...),'order_by'=>$this->_order_by_array_for_get_all_method()));
-     */
-    public function _order_by_array_for_get_all_method()
-    {
-        return [
-            'PRC_order'            => 'ASC',
-            'Price_Type.PRT_order' => 'ASC',
-            'PRC_ID'               => 'ASC',
-        ];
-    }
+	/**
+	 * Returns an array of the normal 'order_by' query parameter provided to the get_all query.
+	 * Of course you don't have to use it, but this is the order we usually want to sort prices by
+	 *
+	 * @return array which can be used like so: $this->get_all(array(array(...where
+	 *               stuff...),'order_by'=>$this->_order_by_array_for_get_all_method()));
+	 */
+	public function _order_by_array_for_get_all_method()
+	{
+		return [
+			'PRC_order'            => 'ASC',
+			'Price_Type.PRT_order' => 'ASC',
+			'PRC_ID'               => 'ASC',
+		];
+	}
 }

core/db_models/EEM_Event_Message_Template.model.php

Indentation +119 added lines, -119 removed lines

@@ -11,134 +11,134 @@
  */
 class EEM_Event_Message_Template extends EEM_Base
 {
-    // private instance of the EEM_Event_Message_Template object
-    protected static $_instance = null;
+	// private instance of the EEM_Event_Message_Template object
+	protected static $_instance = null;
 
 
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @param null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Event Message Template', 'event_espresso');
-        $this->plural_item = esc_html__('Event Message Templates', 'event_espresso');
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @param null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Event Message Template', 'event_espresso');
+		$this->plural_item = esc_html__('Event Message Templates', 'event_espresso');
 
-        $this->_tables = [
-            'Event_Message_Template' => new EE_Primary_Table('esp_event_message_template', 'EMT_ID'),
-        ];
-        $this->_fields = [
-            'Event_Message_Template' => [
-                'EMT_ID' => new EE_Primary_Key_Int_Field(
-                    'EMT_ID',
-                    esc_html__('Event Message Template ID', 'event_espresso')
-                ),
-                'EVT_ID' => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('The ID to the Event', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'GRP_ID' => new EE_Foreign_Key_Int_Field(
-                    'GRP_ID',
-                    esc_html__('The ID to the Message Template Group', 'event_espresso'),
-                    false,
-                    0,
-                    'Message_Template_Group'
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Event'                  => new EE_Belongs_To_Relation(),
-            'Message_Template_Group' => new EE_Belongs_To_Relation(),
-        ];
-        $path_to_event = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
-            $path_to_event
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event,
-            EEM_Base::caps_edit
-        );
-        parent::__construct($timezone);
-    }
+		$this->_tables = [
+			'Event_Message_Template' => new EE_Primary_Table('esp_event_message_template', 'EMT_ID'),
+		];
+		$this->_fields = [
+			'Event_Message_Template' => [
+				'EMT_ID' => new EE_Primary_Key_Int_Field(
+					'EMT_ID',
+					esc_html__('Event Message Template ID', 'event_espresso')
+				),
+				'EVT_ID' => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('The ID to the Event', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'GRP_ID' => new EE_Foreign_Key_Int_Field(
+					'GRP_ID',
+					esc_html__('The ID to the Message Template Group', 'event_espresso'),
+					false,
+					0,
+					'Message_Template_Group'
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Event'                  => new EE_Belongs_To_Relation(),
+			'Message_Template_Group' => new EE_Belongs_To_Relation(),
+		];
+		$path_to_event = 'Event';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
+			$path_to_event
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event,
+			EEM_Base::caps_edit
+		);
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * helper method to simply return an array of event ids for events attached to the given
-     * message template group.
-     *
-     * @param int $GRP_ID The MTP group we want attached events for.
-     * @return  array               An array of event ids.
-     * @throws EE_Error
-     * @since 4.3.0
-     */
-    public function get_attached_event_ids($GRP_ID)
-    {
-        $event_ids = $this->_get_all_wpdb_results([['GRP_ID' => $GRP_ID]], ARRAY_N, 'EVT_ID');
-        $event_ids = call_user_func_array('array_merge', $event_ids);
-        return $event_ids;
-    }
+	/**
+	 * helper method to simply return an array of event ids for events attached to the given
+	 * message template group.
+	 *
+	 * @param int $GRP_ID The MTP group we want attached events for.
+	 * @return  array               An array of event ids.
+	 * @throws EE_Error
+	 * @since 4.3.0
+	 */
+	public function get_attached_event_ids($GRP_ID)
+	{
+		$event_ids = $this->_get_all_wpdb_results([['GRP_ID' => $GRP_ID]], ARRAY_N, 'EVT_ID');
+		$event_ids = call_user_func_array('array_merge', $event_ids);
+		return $event_ids;
+	}
 
 
-    /**
-     * helper method for clearing event/group relations for the given event ids and grp ids.
-     *
-     * @param array $GRP_IDs An array of GRP_IDs. Optional. If empty then there must be EVT IDs.
-     * @param array $EVT_IDs An array of EVT_IDs.  Optional. If empty then there must be GRP IDs.
-     * @return int             How many rows were deleted.
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function delete_event_group_relations($GRP_IDs = [], $EVT_IDs = [])
-    {
-        if (empty($GRP_IDs) && empty($EVT_IDs)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        '%s requires either an array of GRP_IDs or EVT_IDs or both, but both cannot be empty.',
-                        'event_espresso'
-                    ),
-                    __METHOD__
-                )
-            );
-        }
+	/**
+	 * helper method for clearing event/group relations for the given event ids and grp ids.
+	 *
+	 * @param array $GRP_IDs An array of GRP_IDs. Optional. If empty then there must be EVT IDs.
+	 * @param array $EVT_IDs An array of EVT_IDs.  Optional. If empty then there must be GRP IDs.
+	 * @return int             How many rows were deleted.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function delete_event_group_relations($GRP_IDs = [], $EVT_IDs = [])
+	{
+		if (empty($GRP_IDs) && empty($EVT_IDs)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'%s requires either an array of GRP_IDs or EVT_IDs or both, but both cannot be empty.',
+						'event_espresso'
+					),
+					__METHOD__
+				)
+			);
+		}
 
-        $where = [];
-        if (! empty($GRP_IDs)) {
-            $where['GRP_ID'] = ['IN', (array) $GRP_IDs];
-        }
-        if (! empty($EVT_IDs)) {
-            $where['EVT_ID'] = ['IN', (array) $EVT_IDs];
-        }
+		$where = [];
+		if (! empty($GRP_IDs)) {
+			$where['GRP_ID'] = ['IN', (array) $GRP_IDs];
+		}
+		if (! empty($EVT_IDs)) {
+			$where['EVT_ID'] = ['IN', (array) $EVT_IDs];
+		}
 
-        return $this->delete([$where], false);
-    }
+		return $this->delete([$where], false);
+	}
 
 
-    /**
-     * returns a numerically indexed array
-     * with values that correspond to the 'GRP_ID' column
-     * where the 'EVT_ID' column matches that of the supplied event
-     *
-     * @param EE_Event $event
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   $VID:$
-     */
-    public function messageTemplateGroupIDsForEvent(EE_Event $event): array
-    {
-        $results = $this->get_col([['EVT_ID' => $event->ID()]], 'GRP_ID');
-        return $results !== false ? $results : [];
-    }
+	/**
+	 * returns a numerically indexed array
+	 * with values that correspond to the 'GRP_ID' column
+	 * where the 'EVT_ID' column matches that of the supplied event
+	 *
+	 * @param EE_Event $event
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   $VID:$
+	 */
+	public function messageTemplateGroupIDsForEvent(EE_Event $event): array
+	{
+		$results = $this->get_col([['EVT_ID' => $event->ID()]], 'GRP_ID');
+		return $results !== false ? $results : [];
+	}
 }

core/domain/entities/admin/GraphQLData/GraphQLData.php

Indentation +61 added lines, -61 removed lines

@@ -14,74 +14,74 @@
  */
 abstract class GraphQLData implements GraphQLDataInterface
 {
-    /**
-     * @var string $namespace The graphql namespace/prefix.
-     */
-    protected $namespace = 'Espresso';
+	/**
+	 * @var string $namespace The graphql namespace/prefix.
+	 */
+	protected $namespace = 'Espresso';
 
-    /**
-     * @var array $params
-     */
-    private $params = [];
+	/**
+	 * @var array $params
+	 */
+	private $params = [];
 
 
-    /**
-     * @param array $params
-     */
-    public function setParams(array $params)
-    {
-        $this->params = $params;
-    }
+	/**
+	 * @param array $params
+	 */
+	public function setParams(array $params)
+	{
+		$this->params = $params;
+	}
 
 
 
-    /**
-     * @param string $field_key
-     * @param array  $where_params
-     * @return mixed|null
-     * @since $VID:$
-     */
-    protected function getQueryResponse(string $field_key, array $where_params = [])
-    {
-        if (! empty($where_params)) {
-            if (! array_key_exists('variables', $this->params)) {
-                $this->params['variables'] = [];
-            }
-            $this->params['variables']['where'] = $where_params;
-        }
+	/**
+	 * @param string $field_key
+	 * @param array  $where_params
+	 * @return mixed|null
+	 * @since $VID:$
+	 */
+	protected function getQueryResponse(string $field_key, array $where_params = [])
+	{
+		if (! empty($where_params)) {
+			if (! array_key_exists('variables', $this->params)) {
+				$this->params['variables'] = [];
+			}
+			$this->params['variables']['where'] = $where_params;
+		}
 
-        $responseData = $this->makeGraphQLRequest($this->params);
-        return ! empty($responseData[ $field_key ]) ? $responseData[ $field_key ] : null;
-    }
+		$responseData = $this->makeGraphQLRequest($this->params);
+		return ! empty($responseData[ $field_key ]) ? $responseData[ $field_key ] : null;
+	}
 
 
-    /**
-     * @param array $data
-     * @return array|null
-     * @since $VID:$
-     */
-    protected function makeGraphQLRequest(array $data)
-    {
-        $error = '';
-        try {
-            $response = graphql($data);
-            if (! empty($response['data'])) {
-                return $response['data'];
-            }
-            $error = ! empty($response['errors'])
-                ? print_r($response['errors'], true)
-                : esc_html__(
-                    'An unknown error has occurred during the GraphQL request and no data was found to return.',
-                    'event_espresso'
-                );
-        } catch (Exception $e) {
-            if (defined('GRAPHQL_DEBUG') && GRAPHQL_DEBUG) {
-                $error = $e->getMessage();
-            }
-        }
-        if ($error !== '') {
-            error_log($error);
-        }
-        return null;
-    }
+	/**
+	 * @param array $data
+	 * @return array|null
+	 * @since $VID:$
+	 */
+	protected function makeGraphQLRequest(array $data)
+	{
+		$error = '';
+		try {
+			$response = graphql($data);
+			if (! empty($response['data'])) {
+				return $response['data'];
+			}
+			$error = ! empty($response['errors'])
+				? print_r($response['errors'], true)
+				: esc_html__(
+					'An unknown error has occurred during the GraphQL request and no data was found to return.',
+					'event_espresso'
+				);
+		} catch (Exception $e) {
+			if (defined('GRAPHQL_DEBUG') && GRAPHQL_DEBUG) {
+				$error = $e->getMessage();
+			}
+		}
+		if ($error !== '') {
+			error_log($error);
+		}
+		return null;
+	}
 }