eventespresso / event-espresso-core

core/libraries/messages/data_class/EE_Messages_Preview_incoming_data.class.php

Indentation +599 added lines, -599 removed lines

@@ -21,603 +21,603 @@
  */
 class EE_Messages_Preview_incoming_data extends EE_Messages_incoming_data
 {
-    // some specific properties we need for this class
-    private $_events        = [];
-
-    private $_attendees     = [];
-
-    private $_registrations = [];
-
-
-    /**
-     * For the constructor of this special preview class.  We're either looking for an event id or empty data.  If we
-     * have an event id (or ids) then we'll use that as the source for the "dummy" data.  If the data is empty then
-     * we'll get the first three published events from the users database and use that as a source.
-     *
-     * @param array $data
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($data = [])
-    {
-        $this->_data = isset($data['event_ids']) ? $data['event_ids'] : [];
-        $this->_setup_attendees_events();
-        parent::__construct($data);
-    }
-
-
-    /**
-     * Returns database safe representation of the data later used to when instantiating this object.
-     *
-     * @param array $data The incoming data to be prepped.
-     *
-     * @return array   The prepped data for db
-     */
-    public static function convert_data_for_persistent_storage($data)
-    {
-        return $data;
-    }
-
-
-    /**
-     * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
-     * can be sent into this method and converted back into the format used for instantiating with this data handler.
-     *
-     * @param array $data
-     *
-     * @return array
-     */
-    public static function convert_data_from_persistent_storage($data)
-    {
-        return $data;
-    }
-
-
-    /**
-     * This will just setup the _events property in the expected format.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _setup_attendees_events()
-    {
-
-        // setup some attendee objects
-        $attendees = $this->_get_some_attendees();
-
-        // if empty $data we'll do a query to get some events from the server.
-        // otherwise we'll retrieve the event data for the given ids.
-        $events = $this->_get_some_events($this->_data);
-
-        $answers_n_questions = $this->_get_some_q_and_as();
-
-        if (count($events) < 1) {
-            throw new EE_Error(
-                esc_html__(
-                    'We can\'t generate a preview for you because there are no active events in your database',
-                    'event_espresso'
-                )
-            );
-        }
-
-
-        // now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
-        // we'll actually use the generated line_item identifiers for our loop
-        $dtts = $tkts = [];
-        foreach ($events as $id => $event) {
-            if (! $event instanceof EE_Event) {
-                continue;
-            }
-            $this->_events[ $id ]['ID']       = $id;
-            $this->_events[ $id ]['name']     = $event->get('EVT_name');
-            $datetime                         = $event->get_first_related('Datetime');
-            $tickets                          = $datetime instanceof EE_Datetime ? $datetime->get_many_related(
-                'Ticket',
-                ['default_where_conditions' => 'none']
-            ) : [];
-            $this->_events[ $id ]['event']    = $event;
-            $this->_events[ $id ]['reg_objs'] = [];
-            $this->_events[ $id ]['tkt_objs'] = $tickets;
-            $this->_events[ $id ]['dtt_objs'] = [];
-
-            $tkts     = [];
-            foreach ($tickets as $ticket) {
-                if (! $ticket instanceof EE_Ticket) {
-                    continue;
-                }
-                $reldatetime                       = $ticket->datetimes();
-                $tkts[ $ticket->ID() ]             = [];
-                $tkts[ $ticket->ID() ]['ticket']   = $ticket;
-                $tkts[ $ticket->ID() ]['dtt_objs'] = $reldatetime;
-                $tkts[ $ticket->ID() ]['att_objs'] = $attendees;
-                $tkts[ $ticket->ID() ]['count']    = count($attendees);
-                $tkts[ $ticket->ID() ]['EE_Event'] = $event;
-                foreach ($reldatetime as $datetime) {
-                    if ($datetime instanceof EE_Datetime && ! isset($dtts[ $datetime->ID() ])) {
-                        $this->_events[ $id ]['dtt_objs'][ $datetime->ID() ] = $datetime;
-                        $dtts[ $datetime->ID() ]['datetime']                 = $datetime;
-                        $dtts[ $datetime->ID() ]['tkt_objs'][]               = $ticket;
-                        $dtts[ $datetime->ID() ]['evt_objs'][]               = $event;
-                    }
-                }
-            }
-
-            $this->_events[ $id ]['total_attendees'] = count($attendees);
-            $this->_events[ $id ]['att_objs']        = $attendees;
-
-            // let's also setup the dummy attendees property!
-            foreach ($attendees as $att_key => $attendee) {
-                if (! $attendee instanceof EE_Attendee) {
-                    continue;
-                }
-                $this->_attendees[ $att_key ]['line_ref'][] =
-                    $id;  // so later it can be determined what events this attendee registered for!
-                $this->_attendees[ $att_key ]['evt_objs'][] = $event;
-                $this->_attendees[ $att_key ]['att_obj']    = $attendee;
-                // $this->_attendees[$att_key]['registration_id'] = 0;
-                $this->_attendees[ $att_key ]['attendee_email'] = $attendee->email();
-                $this->_attendees[ $att_key ]['tkt_objs']       = $tickets;
-                if ($att_key == 999999991) {
-                    $this->_attendees[ $att_key ]['ans_objs'][999]  = $answers_n_questions['answers'][999];
-                    $this->_attendees[ $att_key ]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
-                    $this->_attendees[ $att_key ]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
-                } elseif ($att_key == 999999992) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
-                    $this->_attendees[ $att_key ]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
-                    $this->_attendees[ $att_key ]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
-                } elseif ($att_key == 999999993) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
-                    $this->_attendees[ $att_key ]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
-                    $this->_attendees[ $att_key ]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
-                }
-            }
-        }
-
-        $this->tickets            = $tkts;
-        $this->datetimes          = $dtts;
-        $this->answers            = $answers_n_questions['answers'];
-        $this->questions          = $answers_n_questions['questions'];
-        $this->total_ticket_count = count($tkts) * count($this->_attendees);
-    }
-
-
-    /**
-     * This just returns an array of dummy attendee objects that we'll use to attach to events for our preview data
-     *
-     * @access private
-     * @return array an array of attendee objects
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    private function _get_some_attendees()
-    {
-        // let's just setup a dummy array of various attendee details
-        $dummy_attendees = [
-            0 => [
-                'Luke',
-                'Skywalker',
-                'farfaraway@galaxy.sp',
-                '804 Bantha Dr.',
-                'Complex 8',
-                'Mos Eisley',
-                32,
-                'US',
-                'f0r3e',
-                '222-333-4763',
-                false,
-                '999999991',
-            ],
-            1 => [
-                'Princess',
-                'Leia',
-                'buns@fcn.al',
-                '1456 Valley Way Boulevard',
-                'Suite 9',
-                'Alderaan',
-                15,
-                'US',
-                'c1h2c',
-                '78-123-111-1111',
-                false,
-                '999999992',
-            ],
-            2 => [
-                'Yoda',
-                'I Am',
-                'arrivenot@emailbad.fr',
-                '4th Tree',
-                '5th Knot',
-                'Marsh',
-                22,
-                'US',
-                'l18n',
-                '999-999-9999',
-                false,
-                '999999993',
-            ],
-        ];
-
-        // let's generate the attendee objects
-        $attendees = [];
-        $var_array = [
-            'fname',
-            'lname',
-            'email',
-            'address',
-            'address2',
-            'city',
-            'staid',
-            'cntry',
-            'zip',
-            'phone',
-            'deleted',
-            'attid',
-        ];
-
-        // EE_Registry::instance()->load_class( 'Attendee', array(), FALSE, false, TRUE );
-        foreach ($dummy_attendees as $dummy) {
-            $att = array_combine($var_array, $dummy);
-            extract($att);
-            /** @var $fname string */
-            /** @var $lname string */
-            /** @var $address string */
-            /** @var $address2 string */
-            /** @var $city string */
-            /** @var $staid string */
-            /** @var $cntry string */
-            /** @var $zip string */
-            /** @var $email string */
-            /** @var $phone string */
-            /** @var $attid string */
-            $attendees[ $attid ] = EE_Attendee::new_instance(
-                [
-                    'ATT_fname'    => $fname,
-                    'ATT_lname'    => $lname,
-                    'ATT_address'  => $address,
-                    'ATT_address2' => $address2,
-                    'ATT_city'     => $city,
-                    'STA_ID'       => $staid,
-                    'CNT_ISO'      => $cntry,
-                    'ATT_zip'      => $zip,
-                    'ATT_email'    => $email,
-                    'ATT_phone'    => $phone,
-                    'ATT_ID'       => $attid,
-                ]
-            );
-        }
-
-        return $attendees;
-    }
-
-
-    /**
-     * Return an array of dummy question objects indexed by answer id and dummy answer objects indexed by answer id.
-     * This will be used in our dummy data setup
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_some_q_and_as()
-    {
-        $quests_array = [
-            0 => [
-                555,
-                esc_html__('What is your favorite planet?', 'event_espresso'),
-                0,
-            ],
-            1 => [
-                556,
-                esc_html__('What is your favorite food?', 'event_espresso'),
-                0,
-            ],
-            2 => [
-                557,
-                esc_html__('How many lightyears have you travelled', 'event_espresso'),
-                0,
-            ],
-        ];
-
-        $ans_array = [
-            0 => [
-                999,
-                555,
-                'Tattoine',
-            ],
-            1 => [
-                1000,
-                555,
-                'Alderaan',
-            ],
-            2 => [
-                1001,
-                555,
-                'Dantooine',
-            ],
-            3 => [
-                1002,
-                556,
-                'Fish Fingers',
-            ],
-            4 => [
-                1003,
-                556,
-                'Sushi',
-            ],
-            5 => [
-                1004,
-                556,
-                'Water',
-            ],
-            6 => [
-                1005,
-                557,
-                'A lot',
-            ],
-            7 => [
-                1006,
-                557,
-                "That's none of your business.",
-            ],
-            8 => [
-                1007,
-                557,
-                "People less travel me then.",
-            ],
-        ];
-
-        $qst_columns = ['QST_ID', 'QST_display_text', 'QST_system'];
-        $ans_columns = ['ANS_ID', 'QST_ID', 'ANS_value'];
-
-        // EE_Registry::instance()->load_class( 'Question', array(), FALSE, TRUE, TRUE );
-        // EE_Registry::instance()->load_class( 'Answer', array(), FALSE, TRUE, TRUE );
-
-        $qsts = [];
-        // first the questions
-        foreach ($quests_array as $qst) {
-            $qstobj                    = array_combine($qst_columns, $qst);
-            $qsts[ $qstobj['QST_ID'] ] = EE_Question::new_instance($qstobj);
-        }
-
-        // now the answers (and we'll setup our arrays)
-        $q_n_as = [];
-        foreach ($ans_array as $ans) {
-            $ansobj                               = array_combine($ans_columns, $ans);
-            $ansobj                               = EE_Answer::new_instance($ansobj);
-            $q_n_as['answers'][ $ansobj->ID() ]   = $ansobj;
-            $q_n_as['questions'][ $ansobj->ID() ] = $qsts[ $ansobj->get('QST_ID') ];
-        }
-
-        return $q_n_as;
-    }
-
-
-    /**
-     * Return an array of event objects from the database
-     *
-     * If event ids are not included then we'll just retrieve the first published event from the database.
-     *
-     * @param array $event_ids if set, this will be an array of event ids to obtain events for.
-     *
-     * @return array    An array of event objects from the db.
-     * @throws EE_Error
-     */
-    private function _get_some_events(array $event_ids = [])
-    {
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        // if we have an evt_id then we want to make sure we use that for the preview
-        // (because a specific event template is being viewed);
-        $event_ids = $request->getRequestParam('evt_id', $event_ids, 'int', true);
-        // clear out any invalid IDs, like 0
-        $event_ids = array_filter($event_ids);
-        $limit     = ! empty($event_ids)
-            ? null
-            : apply_filters('FHEE__EE_Messages_Preview_incoming_data___get_some_events__limit', '0,1');
-
-        $where = ! empty($event_ids)
-            ? [
-                'EVT_ID'                 => ['IN', $event_ids],
-                'Datetime.Ticket.TKT_ID' => ['>', 1],
-            ]
-            : ['Datetime.Ticket.TKT_ID' => ['>', 1]];
-
-        return EEM_Event::instance()->get_all([$where, 'limit' => $limit]);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _setup_data()
-    {
-        // need to figure out the running total for test purposes so... we're going to create a temp cart and add the tickets to it!
-        if (EE_Registry::instance()->SSN instanceof EE_Session) {
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-            $session = EE_Registry::instance()->SSN;
-        } else {
-            $session = EE_Registry::instance()->load_core('Session');
-        }
-        $cart = EE_Cart::instance(null, $session);
-
-        // add tickets to cart
-        foreach ($this->tickets as $ticket) {
-            $cart->add_ticket_to_cart($ticket['ticket']);
-        }
-
-        // setup txn property
-        $this->txn = EE_Transaction::new_instance(
-            [
-                'TXN_timestamp'    => time(), // unix timestamp
-                'TXN_total'        => 0, // txn_total
-                'TXN_paid'         => 0, // txn_paid
-                'STS_ID'           => EEM_Transaction::incomplete_status_code, // sts_id
-                'TXN_session_data' => null, // dump of txn session object (we're just going to leave blank here)
-                'TXN_hash_salt'    => null, // hash salt blank as well
-                'TXN_ID'           => 999999,
-            ]
-        );
-
-
-        // setup reg_objects
-        // note we're setting up a reg object for each attendee in each event but ALSO adding to the reg_object array.
-        $this->reg_objs = [];
-        $regid          = 9999990;
-        foreach ($this->_attendees as $key => $attendee) {
-            // note we need to setup reg_objects for each event this attendee belongs to
-            $regatt = $attendee['att_obj'] instanceof EE_Attendee ? $attendee['att_obj']->ID() : null;
-            $regtxn = $this->txn->ID();
-            $regcnt = 1;
-            foreach ($attendee['line_ref'] as $evtid) {
-                foreach ($this->_events[ $evtid ]['tkt_objs'] as $ticket) {
-                    if (! $ticket instanceof EE_Ticket) {
-                        continue;
-                    }
-                    $reg_array                                            = [
-                        'EVT_ID'           => $evtid,
-                        'ATT_ID'           => $regatt,
-                        'TXN_ID'           => $regtxn,
-                        'TKT_ID'           => $ticket->ID(),
-                        'STS_ID'           => RegStatus::PENDING_PAYMENT,
-                        'REG_date'         => time(),
-                        'REG_final_price'  => $ticket->get('TKT_price'),
-                        'REG_session'      => 'dummy_session_id',
-                        'REG_code'         => $regid . '-dummy-generated-code',
-                        'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
-                        'REG_count'        => $regcnt,
-                        'REG_group_size'   => $this->_events[ $evtid ]['total_attendees'],
-                        'REG_att_is_going' => true,
-                        'REG_ID'           => $regid,
-                    ];
-                    $REG_OBJ                                              = EE_Registration::new_instance($reg_array);
-                    $this->_attendees[ $key ]['reg_objs'][ $regid ]       = $REG_OBJ;
-                    $this->_events[ $evtid ]['reg_objs'][]                = $REG_OBJ;
-                    $this->reg_objs[]                                     = $REG_OBJ;
-                    $this->tickets[ $ticket->ID() ]['reg_objs'][ $regid ] = $REG_OBJ;
-
-                    $regcnt++;
-                    $regid++;
-                }
-            }
-        }
-
-
-        // setup line items!
-        $line_item_total = EEH_Line_Item::create_total_line_item($this->txn);
-
-        // add tickets
-        foreach ($this->tickets as $item) {
-            $qty    = $item['count'];
-            $ticket = $item['ticket'];
-            EEH_Line_Item::add_ticket_purchase($line_item_total, $ticket, $qty);
-        }
-
-        $shipping_line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_name'       => esc_html__(
-                    'Shipping Surcharge',
-                    'event_espresso'
-                ),
-                'LIN_desc'       => esc_html__(
-                    'Sent via Millenium Falcon',
-                    'event_espresso'
-                ),
-                'LIN_unit_price' => 20,
-                'LIN_quantity'   => 1,
-                'LIN_is_taxable' => true,
-                'LIN_total'      => 20,
-                'LIN_type'       => EEM_Line_Item::type_line_item,
-            ]
-        );
-        EEH_Line_Item::add_item($line_item_total, $shipping_line_item);
-        $this->additional_line_items = [$shipping_line_item];
-
-        // now let's add taxes
-        EEH_Line_Item::apply_taxes($line_item_total);
-
-        // now we should be able to get the items we need from this object
-        $event_line_items = EEH_Line_Item::get_pre_tax_subtotal($line_item_total)->children();
-        $line_items       = [];
-        foreach ($event_line_items as $line_item) {
-            if (! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
-                continue;
-            }
-            $ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
-            foreach ($ticket_line_items as $ticket_line_item) {
-                if (! $ticket_line_item instanceof EE_Line_Item) {
-                    continue;
-                }
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['line_item']      = $ticket_line_item;
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['sub_line_items'] = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['children']              = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['EE_Ticket']             =
-                    $this->tickets[ $ticket_line_item->OBJ_ID() ]['ticket'];
-            }
-        }
-
-        $this->line_items_with_children = $line_items;
-        $this->tax_line_items           = $line_item_total->tax_descendants();
-
-        // add proper total to transaction object.
-        $grand_total                 = $line_item_total->recalculate_total_including_taxes();
-        $this->grand_total_line_item = $line_item_total;
-        $this->txn->set_total($grand_total);
-
-
-        // add additional details for each registration
-        foreach ($this->reg_objs as $reg) {
-            if (! $reg instanceof EE_Registration) {
-                continue;
-            }
-            $this->_registrations[ $reg->ID() ]['tkt_obj']  = $this->tickets[ $reg->get('TKT_ID') ]['ticket'];
-            $this->_registrations[ $reg->ID() ]['evt_obj']  = $this->_events[ $reg->get('EVT_ID') ]['event'];
-            $this->_registrations[ $reg->ID() ]['reg_obj']  = $reg;
-            $this->_registrations[ $reg->ID() ]['ans_objs'] = $this->_attendees[ $reg->get('ATT_ID') ]['ans_objs'];
-            $this->_registrations[ $reg->ID() ]['att_obj']  = $this->_attendees[ $reg->get('ATT_ID') ]['att_obj'];
-            $this->_registrations[ $reg->ID() ]['dtt_objs'] = $this->tickets[ $reg->get('TKT_ID') ]['dtt_objs'];
-        }
-
-
-        // events and attendees
-        $this->events        = $this->_events;
-        $this->attendees     = $this->_attendees;
-        $this->registrations = $this->_registrations;
-
-        $attendees_to_shift = $this->_attendees;
-
-        // setup primary attendee property
-        $this->primary_attendee_data = [
-            'fname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->fname()
-                : '',
-
-            'lname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->lname()
-                : '',
-
-            'email' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->email()
-                : '',
-
-            'att_obj' => $this->_attendees[999999991]['att_obj'],
-
-            'reg_obj' => array_shift($attendees_to_shift[999999991]['reg_objs']),
-        ];
-
-        // reg_info property
-        // note this isn't referenced by any shortcode parsers so we'll ignore for now.
-        $this->reg_info = [];
-
-        // let's set a reg_obj for messengers expecting one.
-        $this->reg_obj = array_shift($this->_attendees[999999991]['reg_objs']);
-
-        // the below are just dummy items.
-        $this->user_id     = 1;
-        $this->ip_address  = '192.0.2.1';
-        $this->user_agent  = '';
-        $this->init_access = time();
-        $this->last_access = time();
-    }
+	// some specific properties we need for this class
+	private $_events        = [];
+
+	private $_attendees     = [];
+
+	private $_registrations = [];
+
+
+	/**
+	 * For the constructor of this special preview class.  We're either looking for an event id or empty data.  If we
+	 * have an event id (or ids) then we'll use that as the source for the "dummy" data.  If the data is empty then
+	 * we'll get the first three published events from the users database and use that as a source.
+	 *
+	 * @param array $data
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($data = [])
+	{
+		$this->_data = isset($data['event_ids']) ? $data['event_ids'] : [];
+		$this->_setup_attendees_events();
+		parent::__construct($data);
+	}
+
+
+	/**
+	 * Returns database safe representation of the data later used to when instantiating this object.
+	 *
+	 * @param array $data The incoming data to be prepped.
+	 *
+	 * @return array   The prepped data for db
+	 */
+	public static function convert_data_for_persistent_storage($data)
+	{
+		return $data;
+	}
+
+
+	/**
+	 * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
+	 * can be sent into this method and converted back into the format used for instantiating with this data handler.
+	 *
+	 * @param array $data
+	 *
+	 * @return array
+	 */
+	public static function convert_data_from_persistent_storage($data)
+	{
+		return $data;
+	}
+
+
+	/**
+	 * This will just setup the _events property in the expected format.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _setup_attendees_events()
+	{
+
+		// setup some attendee objects
+		$attendees = $this->_get_some_attendees();
+
+		// if empty $data we'll do a query to get some events from the server.
+		// otherwise we'll retrieve the event data for the given ids.
+		$events = $this->_get_some_events($this->_data);
+
+		$answers_n_questions = $this->_get_some_q_and_as();
+
+		if (count($events) < 1) {
+			throw new EE_Error(
+				esc_html__(
+					'We can\'t generate a preview for you because there are no active events in your database',
+					'event_espresso'
+				)
+			);
+		}
+
+
+		// now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
+		// we'll actually use the generated line_item identifiers for our loop
+		$dtts = $tkts = [];
+		foreach ($events as $id => $event) {
+			if (! $event instanceof EE_Event) {
+				continue;
+			}
+			$this->_events[ $id ]['ID']       = $id;
+			$this->_events[ $id ]['name']     = $event->get('EVT_name');
+			$datetime                         = $event->get_first_related('Datetime');
+			$tickets                          = $datetime instanceof EE_Datetime ? $datetime->get_many_related(
+				'Ticket',
+				['default_where_conditions' => 'none']
+			) : [];
+			$this->_events[ $id ]['event']    = $event;
+			$this->_events[ $id ]['reg_objs'] = [];
+			$this->_events[ $id ]['tkt_objs'] = $tickets;
+			$this->_events[ $id ]['dtt_objs'] = [];
+
+			$tkts     = [];
+			foreach ($tickets as $ticket) {
+				if (! $ticket instanceof EE_Ticket) {
+					continue;
+				}
+				$reldatetime                       = $ticket->datetimes();
+				$tkts[ $ticket->ID() ]             = [];
+				$tkts[ $ticket->ID() ]['ticket']   = $ticket;
+				$tkts[ $ticket->ID() ]['dtt_objs'] = $reldatetime;
+				$tkts[ $ticket->ID() ]['att_objs'] = $attendees;
+				$tkts[ $ticket->ID() ]['count']    = count($attendees);
+				$tkts[ $ticket->ID() ]['EE_Event'] = $event;
+				foreach ($reldatetime as $datetime) {
+					if ($datetime instanceof EE_Datetime && ! isset($dtts[ $datetime->ID() ])) {
+						$this->_events[ $id ]['dtt_objs'][ $datetime->ID() ] = $datetime;
+						$dtts[ $datetime->ID() ]['datetime']                 = $datetime;
+						$dtts[ $datetime->ID() ]['tkt_objs'][]               = $ticket;
+						$dtts[ $datetime->ID() ]['evt_objs'][]               = $event;
+					}
+				}
+			}
+
+			$this->_events[ $id ]['total_attendees'] = count($attendees);
+			$this->_events[ $id ]['att_objs']        = $attendees;
+
+			// let's also setup the dummy attendees property!
+			foreach ($attendees as $att_key => $attendee) {
+				if (! $attendee instanceof EE_Attendee) {
+					continue;
+				}
+				$this->_attendees[ $att_key ]['line_ref'][] =
+					$id;  // so later it can be determined what events this attendee registered for!
+				$this->_attendees[ $att_key ]['evt_objs'][] = $event;
+				$this->_attendees[ $att_key ]['att_obj']    = $attendee;
+				// $this->_attendees[$att_key]['registration_id'] = 0;
+				$this->_attendees[ $att_key ]['attendee_email'] = $attendee->email();
+				$this->_attendees[ $att_key ]['tkt_objs']       = $tickets;
+				if ($att_key == 999999991) {
+					$this->_attendees[ $att_key ]['ans_objs'][999]  = $answers_n_questions['answers'][999];
+					$this->_attendees[ $att_key ]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
+					$this->_attendees[ $att_key ]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
+				} elseif ($att_key == 999999992) {
+					$this->_attendees[ $att_key ]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
+					$this->_attendees[ $att_key ]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
+					$this->_attendees[ $att_key ]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
+				} elseif ($att_key == 999999993) {
+					$this->_attendees[ $att_key ]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
+					$this->_attendees[ $att_key ]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
+					$this->_attendees[ $att_key ]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
+				}
+			}
+		}
+
+		$this->tickets            = $tkts;
+		$this->datetimes          = $dtts;
+		$this->answers            = $answers_n_questions['answers'];
+		$this->questions          = $answers_n_questions['questions'];
+		$this->total_ticket_count = count($tkts) * count($this->_attendees);
+	}
+
+
+	/**
+	 * This just returns an array of dummy attendee objects that we'll use to attach to events for our preview data
+	 *
+	 * @access private
+	 * @return array an array of attendee objects
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	private function _get_some_attendees()
+	{
+		// let's just setup a dummy array of various attendee details
+		$dummy_attendees = [
+			0 => [
+				'Luke',
+				'Skywalker',
+				'farfaraway@galaxy.sp',
+				'804 Bantha Dr.',
+				'Complex 8',
+				'Mos Eisley',
+				32,
+				'US',
+				'f0r3e',
+				'222-333-4763',
+				false,
+				'999999991',
+			],
+			1 => [
+				'Princess',
+				'Leia',
+				'buns@fcn.al',
+				'1456 Valley Way Boulevard',
+				'Suite 9',
+				'Alderaan',
+				15,
+				'US',
+				'c1h2c',
+				'78-123-111-1111',
+				false,
+				'999999992',
+			],
+			2 => [
+				'Yoda',
+				'I Am',
+				'arrivenot@emailbad.fr',
+				'4th Tree',
+				'5th Knot',
+				'Marsh',
+				22,
+				'US',
+				'l18n',
+				'999-999-9999',
+				false,
+				'999999993',
+			],
+		];
+
+		// let's generate the attendee objects
+		$attendees = [];
+		$var_array = [
+			'fname',
+			'lname',
+			'email',
+			'address',
+			'address2',
+			'city',
+			'staid',
+			'cntry',
+			'zip',
+			'phone',
+			'deleted',
+			'attid',
+		];
+
+		// EE_Registry::instance()->load_class( 'Attendee', array(), FALSE, false, TRUE );
+		foreach ($dummy_attendees as $dummy) {
+			$att = array_combine($var_array, $dummy);
+			extract($att);
+			/** @var $fname string */
+			/** @var $lname string */
+			/** @var $address string */
+			/** @var $address2 string */
+			/** @var $city string */
+			/** @var $staid string */
+			/** @var $cntry string */
+			/** @var $zip string */
+			/** @var $email string */
+			/** @var $phone string */
+			/** @var $attid string */
+			$attendees[ $attid ] = EE_Attendee::new_instance(
+				[
+					'ATT_fname'    => $fname,
+					'ATT_lname'    => $lname,
+					'ATT_address'  => $address,
+					'ATT_address2' => $address2,
+					'ATT_city'     => $city,
+					'STA_ID'       => $staid,
+					'CNT_ISO'      => $cntry,
+					'ATT_zip'      => $zip,
+					'ATT_email'    => $email,
+					'ATT_phone'    => $phone,
+					'ATT_ID'       => $attid,
+				]
+			);
+		}
+
+		return $attendees;
+	}
+
+
+	/**
+	 * Return an array of dummy question objects indexed by answer id and dummy answer objects indexed by answer id.
+	 * This will be used in our dummy data setup
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_some_q_and_as()
+	{
+		$quests_array = [
+			0 => [
+				555,
+				esc_html__('What is your favorite planet?', 'event_espresso'),
+				0,
+			],
+			1 => [
+				556,
+				esc_html__('What is your favorite food?', 'event_espresso'),
+				0,
+			],
+			2 => [
+				557,
+				esc_html__('How many lightyears have you travelled', 'event_espresso'),
+				0,
+			],
+		];
+
+		$ans_array = [
+			0 => [
+				999,
+				555,
+				'Tattoine',
+			],
+			1 => [
+				1000,
+				555,
+				'Alderaan',
+			],
+			2 => [
+				1001,
+				555,
+				'Dantooine',
+			],
+			3 => [
+				1002,
+				556,
+				'Fish Fingers',
+			],
+			4 => [
+				1003,
+				556,
+				'Sushi',
+			],
+			5 => [
+				1004,
+				556,
+				'Water',
+			],
+			6 => [
+				1005,
+				557,
+				'A lot',
+			],
+			7 => [
+				1006,
+				557,
+				"That's none of your business.",
+			],
+			8 => [
+				1007,
+				557,
+				"People less travel me then.",
+			],
+		];
+
+		$qst_columns = ['QST_ID', 'QST_display_text', 'QST_system'];
+		$ans_columns = ['ANS_ID', 'QST_ID', 'ANS_value'];
+
+		// EE_Registry::instance()->load_class( 'Question', array(), FALSE, TRUE, TRUE );
+		// EE_Registry::instance()->load_class( 'Answer', array(), FALSE, TRUE, TRUE );
+
+		$qsts = [];
+		// first the questions
+		foreach ($quests_array as $qst) {
+			$qstobj                    = array_combine($qst_columns, $qst);
+			$qsts[ $qstobj['QST_ID'] ] = EE_Question::new_instance($qstobj);
+		}
+
+		// now the answers (and we'll setup our arrays)
+		$q_n_as = [];
+		foreach ($ans_array as $ans) {
+			$ansobj                               = array_combine($ans_columns, $ans);
+			$ansobj                               = EE_Answer::new_instance($ansobj);
+			$q_n_as['answers'][ $ansobj->ID() ]   = $ansobj;
+			$q_n_as['questions'][ $ansobj->ID() ] = $qsts[ $ansobj->get('QST_ID') ];
+		}
+
+		return $q_n_as;
+	}
+
+
+	/**
+	 * Return an array of event objects from the database
+	 *
+	 * If event ids are not included then we'll just retrieve the first published event from the database.
+	 *
+	 * @param array $event_ids if set, this will be an array of event ids to obtain events for.
+	 *
+	 * @return array    An array of event objects from the db.
+	 * @throws EE_Error
+	 */
+	private function _get_some_events(array $event_ids = [])
+	{
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		// if we have an evt_id then we want to make sure we use that for the preview
+		// (because a specific event template is being viewed);
+		$event_ids = $request->getRequestParam('evt_id', $event_ids, 'int', true);
+		// clear out any invalid IDs, like 0
+		$event_ids = array_filter($event_ids);
+		$limit     = ! empty($event_ids)
+			? null
+			: apply_filters('FHEE__EE_Messages_Preview_incoming_data___get_some_events__limit', '0,1');
+
+		$where = ! empty($event_ids)
+			? [
+				'EVT_ID'                 => ['IN', $event_ids],
+				'Datetime.Ticket.TKT_ID' => ['>', 1],
+			]
+			: ['Datetime.Ticket.TKT_ID' => ['>', 1]];
+
+		return EEM_Event::instance()->get_all([$where, 'limit' => $limit]);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _setup_data()
+	{
+		// need to figure out the running total for test purposes so... we're going to create a temp cart and add the tickets to it!
+		if (EE_Registry::instance()->SSN instanceof EE_Session) {
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+			$session = EE_Registry::instance()->SSN;
+		} else {
+			$session = EE_Registry::instance()->load_core('Session');
+		}
+		$cart = EE_Cart::instance(null, $session);
+
+		// add tickets to cart
+		foreach ($this->tickets as $ticket) {
+			$cart->add_ticket_to_cart($ticket['ticket']);
+		}
+
+		// setup txn property
+		$this->txn = EE_Transaction::new_instance(
+			[
+				'TXN_timestamp'    => time(), // unix timestamp
+				'TXN_total'        => 0, // txn_total
+				'TXN_paid'         => 0, // txn_paid
+				'STS_ID'           => EEM_Transaction::incomplete_status_code, // sts_id
+				'TXN_session_data' => null, // dump of txn session object (we're just going to leave blank here)
+				'TXN_hash_salt'    => null, // hash salt blank as well
+				'TXN_ID'           => 999999,
+			]
+		);
+
+
+		// setup reg_objects
+		// note we're setting up a reg object for each attendee in each event but ALSO adding to the reg_object array.
+		$this->reg_objs = [];
+		$regid          = 9999990;
+		foreach ($this->_attendees as $key => $attendee) {
+			// note we need to setup reg_objects for each event this attendee belongs to
+			$regatt = $attendee['att_obj'] instanceof EE_Attendee ? $attendee['att_obj']->ID() : null;
+			$regtxn = $this->txn->ID();
+			$regcnt = 1;
+			foreach ($attendee['line_ref'] as $evtid) {
+				foreach ($this->_events[ $evtid ]['tkt_objs'] as $ticket) {
+					if (! $ticket instanceof EE_Ticket) {
+						continue;
+					}
+					$reg_array                                            = [
+						'EVT_ID'           => $evtid,
+						'ATT_ID'           => $regatt,
+						'TXN_ID'           => $regtxn,
+						'TKT_ID'           => $ticket->ID(),
+						'STS_ID'           => RegStatus::PENDING_PAYMENT,
+						'REG_date'         => time(),
+						'REG_final_price'  => $ticket->get('TKT_price'),
+						'REG_session'      => 'dummy_session_id',
+						'REG_code'         => $regid . '-dummy-generated-code',
+						'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
+						'REG_count'        => $regcnt,
+						'REG_group_size'   => $this->_events[ $evtid ]['total_attendees'],
+						'REG_att_is_going' => true,
+						'REG_ID'           => $regid,
+					];
+					$REG_OBJ                                              = EE_Registration::new_instance($reg_array);
+					$this->_attendees[ $key ]['reg_objs'][ $regid ]       = $REG_OBJ;
+					$this->_events[ $evtid ]['reg_objs'][]                = $REG_OBJ;
+					$this->reg_objs[]                                     = $REG_OBJ;
+					$this->tickets[ $ticket->ID() ]['reg_objs'][ $regid ] = $REG_OBJ;
+
+					$regcnt++;
+					$regid++;
+				}
+			}
+		}
+
+
+		// setup line items!
+		$line_item_total = EEH_Line_Item::create_total_line_item($this->txn);
+
+		// add tickets
+		foreach ($this->tickets as $item) {
+			$qty    = $item['count'];
+			$ticket = $item['ticket'];
+			EEH_Line_Item::add_ticket_purchase($line_item_total, $ticket, $qty);
+		}
+
+		$shipping_line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_name'       => esc_html__(
+					'Shipping Surcharge',
+					'event_espresso'
+				),
+				'LIN_desc'       => esc_html__(
+					'Sent via Millenium Falcon',
+					'event_espresso'
+				),
+				'LIN_unit_price' => 20,
+				'LIN_quantity'   => 1,
+				'LIN_is_taxable' => true,
+				'LIN_total'      => 20,
+				'LIN_type'       => EEM_Line_Item::type_line_item,
+			]
+		);
+		EEH_Line_Item::add_item($line_item_total, $shipping_line_item);
+		$this->additional_line_items = [$shipping_line_item];
+
+		// now let's add taxes
+		EEH_Line_Item::apply_taxes($line_item_total);
+
+		// now we should be able to get the items we need from this object
+		$event_line_items = EEH_Line_Item::get_pre_tax_subtotal($line_item_total)->children();
+		$line_items       = [];
+		foreach ($event_line_items as $line_item) {
+			if (! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
+				continue;
+			}
+			$ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
+			foreach ($ticket_line_items as $ticket_line_item) {
+				if (! $ticket_line_item instanceof EE_Line_Item) {
+					continue;
+				}
+				$this->tickets[ $ticket_line_item->OBJ_ID() ]['line_item']      = $ticket_line_item;
+				$this->tickets[ $ticket_line_item->OBJ_ID() ]['sub_line_items'] = $ticket_line_item->children();
+				$line_items[ $ticket_line_item->ID() ]['children']              = $ticket_line_item->children();
+				$line_items[ $ticket_line_item->ID() ]['EE_Ticket']             =
+					$this->tickets[ $ticket_line_item->OBJ_ID() ]['ticket'];
+			}
+		}
+
+		$this->line_items_with_children = $line_items;
+		$this->tax_line_items           = $line_item_total->tax_descendants();
+
+		// add proper total to transaction object.
+		$grand_total                 = $line_item_total->recalculate_total_including_taxes();
+		$this->grand_total_line_item = $line_item_total;
+		$this->txn->set_total($grand_total);
+
+
+		// add additional details for each registration
+		foreach ($this->reg_objs as $reg) {
+			if (! $reg instanceof EE_Registration) {
+				continue;
+			}
+			$this->_registrations[ $reg->ID() ]['tkt_obj']  = $this->tickets[ $reg->get('TKT_ID') ]['ticket'];
+			$this->_registrations[ $reg->ID() ]['evt_obj']  = $this->_events[ $reg->get('EVT_ID') ]['event'];
+			$this->_registrations[ $reg->ID() ]['reg_obj']  = $reg;
+			$this->_registrations[ $reg->ID() ]['ans_objs'] = $this->_attendees[ $reg->get('ATT_ID') ]['ans_objs'];
+			$this->_registrations[ $reg->ID() ]['att_obj']  = $this->_attendees[ $reg->get('ATT_ID') ]['att_obj'];
+			$this->_registrations[ $reg->ID() ]['dtt_objs'] = $this->tickets[ $reg->get('TKT_ID') ]['dtt_objs'];
+		}
+
+
+		// events and attendees
+		$this->events        = $this->_events;
+		$this->attendees     = $this->_attendees;
+		$this->registrations = $this->_registrations;
+
+		$attendees_to_shift = $this->_attendees;
+
+		// setup primary attendee property
+		$this->primary_attendee_data = [
+			'fname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->fname()
+				: '',
+
+			'lname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->lname()
+				: '',
+
+			'email' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->email()
+				: '',
+
+			'att_obj' => $this->_attendees[999999991]['att_obj'],
+
+			'reg_obj' => array_shift($attendees_to_shift[999999991]['reg_objs']),
+		];
+
+		// reg_info property
+		// note this isn't referenced by any shortcode parsers so we'll ignore for now.
+		$this->reg_info = [];
+
+		// let's set a reg_obj for messengers expecting one.
+		$this->reg_obj = array_shift($this->_attendees[999999991]['reg_objs']);
+
+		// the below are just dummy items.
+		$this->user_id     = 1;
+		$this->ip_address  = '192.0.2.1';
+		$this->user_agent  = '';
+		$this->init_access = time();
+		$this->last_access = time();
+	}
 }

core/libraries/messages/messenger/EE_Email_messenger.class.php

Indentation +638 added lines, -638 removed lines

@@ -5,642 +5,642 @@
  */
 class EE_Email_messenger extends EE_messenger
 {
-    /**
-     * To field for email
-     * @var string
-     */
-    protected $_to = '';
-
-
-    /**
-     * CC field for email.
-     * @var string
-     */
-    protected $_cc = '';
-
-    /**
-     * From field for email
-     * @var string
-     */
-    protected $_from = '';
-
-
-    /**
-     * Subject field for email
-     * @var string
-     */
-    protected $_subject = '';
-
-
-    /**
-     * Content field for email
-     * @var string
-     */
-    protected $_content = '';
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     */
-    public function __construct()
-    {
-        // set name and description properties
-        $this->name                = 'email';
-        $this->description         = sprintf(
-            esc_html__(
-                'This messenger delivers messages via email using the built-in %s function included with WordPress',
-                'event_espresso'
-            ),
-            '<code>wp_mail</code>'
-        );
-        $this->label               = array(
-            'singular' => esc_html__('email', 'event_espresso'),
-            'plural'   => esc_html__('emails', 'event_espresso'),
-        );
-        $this->activate_on_install = true;
-
-        // we're using defaults so let's call parent constructor that will take care of setting up all the other
-        // properties
-        parent::__construct();
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array(
-            'events_edit' => true,
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     */
-    protected function _set_valid_shortcodes()
-    {
-        // remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
-        // message type.
-        $this->_valid_shortcodes = array(
-            'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_validator_config()
-    {
-        $valid_shortcodes = $this->get_valid_shortcodes();
-
-        $this->_validator_config = array(
-            'to'            => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type'       => 'email',
-            ),
-            'cc' => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type' => 'email',
-            ),
-            'from'          => array(
-                'shortcodes' => $valid_shortcodes['from'],
-                'type'       => 'email',
-            ),
-            'subject'       => array(
-                'shortcodes' => array(
-                    'organization',
-                    'primary_registration_details',
-                    'event_author',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-            ),
-            'content'       => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket_list',
-                    'organization',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                    'transaction',
-                    'messenger',
-                ),
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
-                'required'   => array('[ATTENDEE_LIST]'),
-            ),
-            'event_list'    => array(
-                'shortcodes' => array(
-                    'event',
-                    'attendee_list',
-                    'ticket_list',
-                    'venue',
-                    'datetime_list',
-                    'attendee',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                ),
-                'required'   => array('[EVENT_LIST]'),
-            ),
-            'ticket_list'   => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket',
-                    'datetime_list',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-                'required'   => array('[TICKET_LIST]'),
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required'   => array('[DATETIME_LIST]'),
-            ),
-        );
-    }
-
-
-    /**
-     * @see   parent EE_messenger class for docs
-     * @since 4.5.0
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        if ($sending_messenger_name === 'html') {
-            add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        }
-    }
-
-
-    public function add_email_css(
-        $variation_path,
-        $messenger,
-        $message_type,
-        $type,
-        $variation,
-        $file_extension,
-        $url,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        // prevent recursion on this callback.
-        remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
-        $variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
-
-        add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        return $variation;
-    }
-
-
-    /**
-     * See parent for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_test_settings_fields()
-    {
-        $this->_test_settings_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html__('Send a test email to', 'event_espresso'),
-                'type'       => 'email',
-                'required'   => false,
-                'validation' => true,
-                'css_class'  => 'ee-input-width--big',
-                'format'     => '%s',
-                'default'    => get_bloginfo('admin_email'),
-            ),
-            'subject' => array(
-                'input'      => 'hidden',
-                'label'      => '',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => false,
-                'format'     => '%s',
-                'value'      => sprintf(esc_html__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
-                'default'    => '',
-                'css_class'  => '',
-            ),
-        );
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger but will get used by a messenger field for
-        // shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
-        // they relate to.  This is important for the Messages_admin to know what fields to display to the user.
-        //  Also, notice that the "values" are equal to the field type that messages admin will use to know what
-        // kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
-        // indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
-        // displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
-        // will not be displayed/parsed.
-        $this->_template_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'To',
-                    'Label for the "To" field for email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'cc'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'CC',
-                    'Label for the "Carbon Copy" field used for additional email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'from'    => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'From',
-                    'Label for the "From" field for email addresses.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'subject' => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'Subject',
-                    'Label for the "Subject" field (short description of contents) for emails.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'content' => '',
-            // left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra'   => array(
-                'content' => array(
-                    'main'          => array(
-                        'input'      => 'wp_editor',
-                        'label'      => esc_html__('Main Content', 'event_espresso'),
-                        'type'       => 'string',
-                        'required'   => false,
-                        'validation' => true,
-                        'format'     => '%s',
-                        'rows'       => '15',
-                    ),
-                    'event_list'    => array(
-                        'input'               => 'wp_editor',
-                        'label'               => '[EVENT_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'rows'                => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]'),
-                    ),
-                    'attendee_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[ATTENDEE_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]'),
-                    ),
-                    'ticket_list'   => array(
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]'),
-                    ),
-                    'datetime_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[DATETIME_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[DATETIME_LIST]'),
-                    ),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * See definition of this class in parent
-     */
-    protected function _set_default_message_types()
-    {
-        $this->_default_message_types = array(
-            'payment',
-            'payment_refund',
-            'registration',
-            'not_approved_registration',
-            'pending_approval',
-        );
-    }
-
-
-    /**
-     * @see   definition of this class in parent
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array(
-            'payment',
-            'registration',
-            'not_approved_registration',
-            'declined_registration',
-            'cancelled_registration',
-            'pending_approval',
-            'registration_summary',
-            'payment_reminder',
-            'payment_declined',
-            'payment_refund',
-        );
-    }
-
-
-    /**
-     * setting up admin_settings_fields for messenger.
-     */
-    protected function _set_admin_settings_fields()
-    {
-    }
-
-    /**
-     * We just deliver the messages don't kill us!!
-     *
-     * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
-     *              present.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _send_message()
-    {
-        $success = wp_mail(
-            $this->_to,
-            // some old values for subject may be expecting HTML entities to be decoded in the subject
-            // and subjects aren't interpreted as HTML, so there should be no HTML in them
-            wp_strip_all_tags(wp_specialchars_decode($this->_subject, ENT_QUOTES)),
-            $this->_body(),
-            $this->_headers()
-        );
-        if (! $success) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
-                        'event_espresso'
-                    ),
-                    $this->_to,
-                    $this->_from,
-                    '<br />'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     * see parent for definition
-     *
-     * @return string html body of the message content and the related css.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _preview()
-    {
-        return $this->_body(true);
-    }
-
-
-    /**
-     * Setup headers for email
-     *
-     * @access protected
-     * @return string formatted header for email
-     */
-    protected function _headers()
-    {
-        $this->_ensure_has_from_email_address();
-        $from    = $this->_from;
-        $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
-            'Content-Type:text/html; charset=utf-8',
-        );
-
-        /**
-         * Second condition added as a result of https://events.codebasehq.com/projects/event-espresso/tickets/11416 to
-         * cover back compat where there may be users who have saved cc values in their db for the newsletter message
-         * type which they are no longer able to change.
-         */
-        if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
-            $headers[] = 'cc: ' . $this->_cc;
-        }
-
-        // but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
-        // header.
-        add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
-        add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
-        return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
-    }
-
-
-    /**
-     * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
-     * address for the from address to avoid problems with sending emails.
-     */
-    protected function _ensure_has_from_email_address()
-    {
-        if (empty($this->_from)) {
-            $this->_from = get_bloginfo('admin_email');
-        }
-    }
-
-
-    /**
-     * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
-     * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
-     * be empty
-     *
-     * @since 4.3.1
-     * @return array
-     */
-    private function _parse_from()
-    {
-        if (strpos($this->_from, '<') !== false) {
-            $from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
-            $from_name = str_replace('"', '', $from_name);
-            $from_name = trim($from_name);
-
-            $from_email = substr($this->_from, strpos($this->_from, '<') + 1);
-            $from_email = str_replace('>', '', $from_email);
-            $from_email = trim($from_email);
-        } elseif (trim($this->_from) !== '') {
-            $from_name  = '';
-            $from_email = trim($this->_from);
-        } else {
-            $from_name = $from_email = '';
-        }
-        return array($from_name, $from_email);
-    }
-
-
-    /**
-     * Callback for the wp_mail_from filter.
-     *
-     * @since 4.3.1
-     * @param string $from_email What the original from_email is.
-     * @return string
-     */
-    public function set_from_address($from_email)
-    {
-        $parsed_from = $this->_parse_from();
-        // includes fallback if the parsing failed.
-        $from_email = is_array($parsed_from) && ! empty($parsed_from[1])
-            ? $parsed_from[1]
-            : get_bloginfo('admin_email');
-        return $from_email;
-    }
-
-
-    /**
-     * Callback fro the wp_mail_from_name filter.
-     *
-     * @since 4.3.1
-     * @param string $from_name The original from_name.
-     * @return string
-     */
-    public function set_from_name($from_name)
-    {
-        $parsed_from = $this->_parse_from();
-        if (is_array($parsed_from) && ! empty($parsed_from[0])) {
-            $from_name = $parsed_from[0];
-        }
-
-        // if from name is "WordPress" let's sub in the site name instead (more friendly!)
-        // but realize the default name is HTML entity-encoded
-        $from_name = $from_name == 'WordPress' ? wp_specialchars_decode(get_bloginfo(), ENT_QUOTES) : $from_name;
-
-        return $from_name;
-    }
-
-
-    /**
-     * setup body for email
-     *
-     * @param bool $preview will determine whether this is preview template or not.
-     * @return string formatted body for email.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _body($preview = false)
-    {
-        // setup template args!
-        $this->_template_args = array(
-            'subject'   => $this->_subject,
-            'from'      => $this->_from,
-            'main_body' => wpautop($this->_content),
-        );
-        $body                 = $this->_get_main_template($preview);
-
-        /**
-         * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
-         *
-         * @type    bool $preview Indicates whether a preview is being generated or not.
-         * @return  bool    true  indicates to use the inliner, false bypasses it.
-         */
-        if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
-            // now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
-                $style = file_get_contents(
-                    $this->get_variation(
-                        $this->_tmp_pack,
-                        $this->_incoming_message_type->name,
-                        false,
-                        'main',
-                        $this->_variation
-                    ),
-                    true
-                );
-                $CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles();
-                $body  = $CSS->convert($body, $style);
-            }
-        }
-        return $body;
-    }
-
-
-    /**
-     * This just returns any existing test settings that might be saved in the database
-     *
-     * @access public
-     * @return array
-     */
-    public function get_existing_test_settings()
-    {
-        $settings = parent::get_existing_test_settings();
-        // override subject if present because we always want it to be fresh.
-        if (is_array($settings) && ! empty($settings['subject'])) {
-            $settings['subject'] = sprintf(esc_html__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
-        }
-        return $settings;
-    }
+	/**
+	 * To field for email
+	 * @var string
+	 */
+	protected $_to = '';
+
+
+	/**
+	 * CC field for email.
+	 * @var string
+	 */
+	protected $_cc = '';
+
+	/**
+	 * From field for email
+	 * @var string
+	 */
+	protected $_from = '';
+
+
+	/**
+	 * Subject field for email
+	 * @var string
+	 */
+	protected $_subject = '';
+
+
+	/**
+	 * Content field for email
+	 * @var string
+	 */
+	protected $_content = '';
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 */
+	public function __construct()
+	{
+		// set name and description properties
+		$this->name                = 'email';
+		$this->description         = sprintf(
+			esc_html__(
+				'This messenger delivers messages via email using the built-in %s function included with WordPress',
+				'event_espresso'
+			),
+			'<code>wp_mail</code>'
+		);
+		$this->label               = array(
+			'singular' => esc_html__('email', 'event_espresso'),
+			'plural'   => esc_html__('emails', 'event_espresso'),
+		);
+		$this->activate_on_install = true;
+
+		// we're using defaults so let's call parent constructor that will take care of setting up all the other
+		// properties
+		parent::__construct();
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array(
+			'events_edit' => true,
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		// remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
+		// message type.
+		$this->_valid_shortcodes = array(
+			'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_validator_config()
+	{
+		$valid_shortcodes = $this->get_valid_shortcodes();
+
+		$this->_validator_config = array(
+			'to'            => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type'       => 'email',
+			),
+			'cc' => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type' => 'email',
+			),
+			'from'          => array(
+				'shortcodes' => $valid_shortcodes['from'],
+				'type'       => 'email',
+			),
+			'subject'       => array(
+				'shortcodes' => array(
+					'organization',
+					'primary_registration_details',
+					'event_author',
+					'primary_registration_details',
+					'recipient_details',
+				),
+			),
+			'content'       => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket_list',
+					'organization',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+					'transaction',
+					'messenger',
+				),
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
+				'required'   => array('[ATTENDEE_LIST]'),
+			),
+			'event_list'    => array(
+				'shortcodes' => array(
+					'event',
+					'attendee_list',
+					'ticket_list',
+					'venue',
+					'datetime_list',
+					'attendee',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+				),
+				'required'   => array('[EVENT_LIST]'),
+			),
+			'ticket_list'   => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket',
+					'datetime_list',
+					'primary_registration_details',
+					'recipient_details',
+				),
+				'required'   => array('[TICKET_LIST]'),
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required'   => array('[DATETIME_LIST]'),
+			),
+		);
+	}
+
+
+	/**
+	 * @see   parent EE_messenger class for docs
+	 * @since 4.5.0
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		if ($sending_messenger_name === 'html') {
+			add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		}
+	}
+
+
+	public function add_email_css(
+		$variation_path,
+		$messenger,
+		$message_type,
+		$type,
+		$variation,
+		$file_extension,
+		$url,
+		EE_Messages_Template_Pack $template_pack
+	) {
+		// prevent recursion on this callback.
+		remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
+		$variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
+
+		add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		return $variation;
+	}
+
+
+	/**
+	 * See parent for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_test_settings_fields()
+	{
+		$this->_test_settings_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html__('Send a test email to', 'event_espresso'),
+				'type'       => 'email',
+				'required'   => false,
+				'validation' => true,
+				'css_class'  => 'ee-input-width--big',
+				'format'     => '%s',
+				'default'    => get_bloginfo('admin_email'),
+			),
+			'subject' => array(
+				'input'      => 'hidden',
+				'label'      => '',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => false,
+				'format'     => '%s',
+				'value'      => sprintf(esc_html__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
+				'default'    => '',
+				'css_class'  => '',
+			),
+		);
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger but will get used by a messenger field for
+		// shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
+		// they relate to.  This is important for the Messages_admin to know what fields to display to the user.
+		//  Also, notice that the "values" are equal to the field type that messages admin will use to know what
+		// kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
+		// indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
+		// displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
+		// will not be displayed/parsed.
+		$this->_template_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'To',
+					'Label for the "To" field for email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'cc'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'CC',
+					'Label for the "Carbon Copy" field used for additional email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'from'    => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'From',
+					'Label for the "From" field for email addresses.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'subject' => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'Subject',
+					'Label for the "Subject" field (short description of contents) for emails.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'content' => '',
+			// left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra'   => array(
+				'content' => array(
+					'main'          => array(
+						'input'      => 'wp_editor',
+						'label'      => esc_html__('Main Content', 'event_espresso'),
+						'type'       => 'string',
+						'required'   => false,
+						'validation' => true,
+						'format'     => '%s',
+						'rows'       => '15',
+					),
+					'event_list'    => array(
+						'input'               => 'wp_editor',
+						'label'               => '[EVENT_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'rows'                => '15',
+						'shortcodes_required' => array('[EVENT_LIST]'),
+					),
+					'attendee_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[ATTENDEE_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]'),
+					),
+					'ticket_list'   => array(
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[TICKET_LIST]'),
+					),
+					'datetime_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[DATETIME_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[DATETIME_LIST]'),
+					),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * See definition of this class in parent
+	 */
+	protected function _set_default_message_types()
+	{
+		$this->_default_message_types = array(
+			'payment',
+			'payment_refund',
+			'registration',
+			'not_approved_registration',
+			'pending_approval',
+		);
+	}
+
+
+	/**
+	 * @see   definition of this class in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array(
+			'payment',
+			'registration',
+			'not_approved_registration',
+			'declined_registration',
+			'cancelled_registration',
+			'pending_approval',
+			'registration_summary',
+			'payment_reminder',
+			'payment_declined',
+			'payment_refund',
+		);
+	}
+
+
+	/**
+	 * setting up admin_settings_fields for messenger.
+	 */
+	protected function _set_admin_settings_fields()
+	{
+	}
+
+	/**
+	 * We just deliver the messages don't kill us!!
+	 *
+	 * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
+	 *              present.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _send_message()
+	{
+		$success = wp_mail(
+			$this->_to,
+			// some old values for subject may be expecting HTML entities to be decoded in the subject
+			// and subjects aren't interpreted as HTML, so there should be no HTML in them
+			wp_strip_all_tags(wp_specialchars_decode($this->_subject, ENT_QUOTES)),
+			$this->_body(),
+			$this->_headers()
+		);
+		if (! $success) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
+						'event_espresso'
+					),
+					$this->_to,
+					$this->_from,
+					'<br />'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 * see parent for definition
+	 *
+	 * @return string html body of the message content and the related css.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _preview()
+	{
+		return $this->_body(true);
+	}
+
+
+	/**
+	 * Setup headers for email
+	 *
+	 * @access protected
+	 * @return string formatted header for email
+	 */
+	protected function _headers()
+	{
+		$this->_ensure_has_from_email_address();
+		$from    = $this->_from;
+		$headers = array(
+			'From:' . $from,
+			'Reply-To:' . $from,
+			'Content-Type:text/html; charset=utf-8',
+		);
+
+		/**
+		 * Second condition added as a result of https://events.codebasehq.com/projects/event-espresso/tickets/11416 to
+		 * cover back compat where there may be users who have saved cc values in their db for the newsletter message
+		 * type which they are no longer able to change.
+		 */
+		if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
+			$headers[] = 'cc: ' . $this->_cc;
+		}
+
+		// but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
+		// header.
+		add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
+		add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
+		return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
+	}
+
+
+	/**
+	 * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
+	 * address for the from address to avoid problems with sending emails.
+	 */
+	protected function _ensure_has_from_email_address()
+	{
+		if (empty($this->_from)) {
+			$this->_from = get_bloginfo('admin_email');
+		}
+	}
+
+
+	/**
+	 * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
+	 * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
+	 * be empty
+	 *
+	 * @since 4.3.1
+	 * @return array
+	 */
+	private function _parse_from()
+	{
+		if (strpos($this->_from, '<') !== false) {
+			$from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
+			$from_name = str_replace('"', '', $from_name);
+			$from_name = trim($from_name);
+
+			$from_email = substr($this->_from, strpos($this->_from, '<') + 1);
+			$from_email = str_replace('>', '', $from_email);
+			$from_email = trim($from_email);
+		} elseif (trim($this->_from) !== '') {
+			$from_name  = '';
+			$from_email = trim($this->_from);
+		} else {
+			$from_name = $from_email = '';
+		}
+		return array($from_name, $from_email);
+	}
+
+
+	/**
+	 * Callback for the wp_mail_from filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_email What the original from_email is.
+	 * @return string
+	 */
+	public function set_from_address($from_email)
+	{
+		$parsed_from = $this->_parse_from();
+		// includes fallback if the parsing failed.
+		$from_email = is_array($parsed_from) && ! empty($parsed_from[1])
+			? $parsed_from[1]
+			: get_bloginfo('admin_email');
+		return $from_email;
+	}
+
+
+	/**
+	 * Callback fro the wp_mail_from_name filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_name The original from_name.
+	 * @return string
+	 */
+	public function set_from_name($from_name)
+	{
+		$parsed_from = $this->_parse_from();
+		if (is_array($parsed_from) && ! empty($parsed_from[0])) {
+			$from_name = $parsed_from[0];
+		}
+
+		// if from name is "WordPress" let's sub in the site name instead (more friendly!)
+		// but realize the default name is HTML entity-encoded
+		$from_name = $from_name == 'WordPress' ? wp_specialchars_decode(get_bloginfo(), ENT_QUOTES) : $from_name;
+
+		return $from_name;
+	}
+
+
+	/**
+	 * setup body for email
+	 *
+	 * @param bool $preview will determine whether this is preview template or not.
+	 * @return string formatted body for email.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _body($preview = false)
+	{
+		// setup template args!
+		$this->_template_args = array(
+			'subject'   => $this->_subject,
+			'from'      => $this->_from,
+			'main_body' => wpautop($this->_content),
+		);
+		$body                 = $this->_get_main_template($preview);
+
+		/**
+		 * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
+		 *
+		 * @type    bool $preview Indicates whether a preview is being generated or not.
+		 * @return  bool    true  indicates to use the inliner, false bypasses it.
+		 */
+		if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
+			// now if this isn't a preview, let's setup the body so it has inline styles
+			if (! $preview || ($preview && defined('DOING_AJAX'))) {
+				$style = file_get_contents(
+					$this->get_variation(
+						$this->_tmp_pack,
+						$this->_incoming_message_type->name,
+						false,
+						'main',
+						$this->_variation
+					),
+					true
+				);
+				$CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles();
+				$body  = $CSS->convert($body, $style);
+			}
+		}
+		return $body;
+	}
+
+
+	/**
+	 * This just returns any existing test settings that might be saved in the database
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_existing_test_settings()
+	{
+		$settings = parent::get_existing_test_settings();
+		// override subject if present because we always want it to be fresh.
+		if (is_array($settings) && ! empty($settings['subject'])) {
+			$settings['subject'] = sprintf(esc_html__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
+		}
+		return $settings;
+	}
 }

core/libraries/rest_api/calculations/Datetime.php

Indentation +200 added lines, -200 removed lines

@@ -18,214 +18,214 @@
 
 class Datetime extends DatetimeCalculationBase
 {
-    /**
-     * @var EEM_Datetime
-     */
-    protected $datetime_model;
+	/**
+	 * @var EEM_Datetime
+	 */
+	protected $datetime_model;
 
-    /**
-     * @var EEM_Registration
-     */
-    protected $registration_model;
-    public function __construct(EEM_Datetime $datetime_model, EEM_Registration $registration_model)
-    {
-        $this->datetime_model = $datetime_model;
-        $this->registration_model = $registration_model;
-    }
+	/**
+	 * @var EEM_Registration
+	 */
+	protected $registration_model;
+	public function __construct(EEM_Datetime $datetime_model, EEM_Registration $registration_model)
+	{
+		$this->datetime_model = $datetime_model;
+		$this->registration_model = $registration_model;
+	}
 
-    /**
-     * Calculates the total spaces available on the datetime, taking into account
-     * ticket limits too.
-     *
-     * @see EE_Datetime::spaces_remaining( true )
-     * @param array            $wpdb_row
-     * @param WP_REST_Request $request
-     * @param DatetimeControllerBase  $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function spacesRemainingConsideringTickets($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Datetime.DTT_ID'])) {
-            $dtt_obj = $this->datetime_model->get_one_by_ID($wpdb_row['Datetime.DTT_ID']);
-        } else {
-            $dtt_obj = null;
-        }
-        if ($dtt_obj instanceof EE_Datetime) {
-            return $dtt_obj->spaces_remaining(true);
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                // @codingStandardsIgnoreStart
-                    'Cannot calculate spaces_remaining_considering_tickets because the datetime with ID %1$s (from database row %2$s) was not found',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $wpdb_row['Datetime.DTT_ID'],
-                print_r($wpdb_row, true)
-            )
-        );
-    }
+	/**
+	 * Calculates the total spaces available on the datetime, taking into account
+	 * ticket limits too.
+	 *
+	 * @see EE_Datetime::spaces_remaining( true )
+	 * @param array            $wpdb_row
+	 * @param WP_REST_Request $request
+	 * @param DatetimeControllerBase  $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function spacesRemainingConsideringTickets($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Datetime.DTT_ID'])) {
+			$dtt_obj = $this->datetime_model->get_one_by_ID($wpdb_row['Datetime.DTT_ID']);
+		} else {
+			$dtt_obj = null;
+		}
+		if ($dtt_obj instanceof EE_Datetime) {
+			return $dtt_obj->spaces_remaining(true);
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+				// @codingStandardsIgnoreStart
+					'Cannot calculate spaces_remaining_considering_tickets because the datetime with ID %1$s (from database row %2$s) was not found',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$wpdb_row['Datetime.DTT_ID'],
+				print_r($wpdb_row, true)
+			)
+		);
+	}
 
 
-    /**
-     * Counts registrations who have checked into this datetime
-     *
-     * @param array           $wpdb_row
-     * @param WP_REST_Request $request
-     * @param DatetimeControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function registrationsCheckedInCount($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count');
-        return $this->registration_model
-                               ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], true);
-    }
+	/**
+	 * Counts registrations who have checked into this datetime
+	 *
+	 * @param array           $wpdb_row
+	 * @param WP_REST_Request $request
+	 * @param DatetimeControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function registrationsCheckedInCount($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count');
+		return $this->registration_model
+							   ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], true);
+	}
 
 
-    /**
-     * Counts registrations who have checked out of this datetime
-     *
-     * @param array           $wpdb_row
-     * @param WP_REST_Request $request
-     * @param DatetimeControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function registrationsCheckedOutCount($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count');
-        return $this->registration_model
-                               ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], false);
-    }
+	/**
+	 * Counts registrations who have checked out of this datetime
+	 *
+	 * @param array           $wpdb_row
+	 * @param WP_REST_Request $request
+	 * @param DatetimeControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function registrationsCheckedOutCount($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count');
+		return $this->registration_model
+							   ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], false);
+	}
 
 
-    /**
-     * Counts the number of pending-payment registrations for this event (regardless
-     * of how many datetimes each registrations' ticket purchase is for)
-     *
-     * @param array           $wpdb_row
-     * @param WP_REST_Request $request
-     * @param DatetimeControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function spotsTakenPendingPayment($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $this->verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment');
-        return $this->registration_model->count(
-            array(
-                array(
-                    'Ticket.Datetime.DTT_ID' => $wpdb_row['Datetime.DTT_ID'],
-                    'STS_ID'                 => RegStatus::PENDING_PAYMENT,
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
+	/**
+	 * Counts the number of pending-payment registrations for this event (regardless
+	 * of how many datetimes each registrations' ticket purchase is for)
+	 *
+	 * @param array           $wpdb_row
+	 * @param WP_REST_Request $request
+	 * @param DatetimeControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function spotsTakenPendingPayment($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$this->verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment');
+		return $this->registration_model->count(
+			array(
+				array(
+					'Ticket.Datetime.DTT_ID' => $wpdb_row['Datetime.DTT_ID'],
+					'STS_ID'                 => RegStatus::PENDING_PAYMENT,
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
 
 
-    /**
-     * Provides an array for all the calculations possible that outlines a json schema for those calculations.
-     * Array is indexed by calculation (snake case) and value is the schema for that calculation.
-     *
-     * @since 4.9.68.p
-     * @return array
-     */
-    public function schemaForCalculations()
-    {
-        return array(
-            'spaces_remaining_considering_tickets' => array(
-                'description' => esc_html__(
-                    'Calculates the total spaces available on the datetime, taking into account ticket limits too.',
-                    'event_espresso'
-                ),
-                'type' => 'number',
-                'protected' => true,
-            ),
-            'registrations_checked_in_count' => array(
-                'description' => esc_html__(
-                    'Counts registrations who have checked into this datetime.',
-                    'event_espresso'
-                ),
-                'type' => 'number',
-                'protected' => true,
-            ),
-            'registrations_checked_out_count' => array(
-                'description' => esc_html__(
-                    'Counts registrations who have checked out of this datetime.',
-                    'event_espresso'
-                ),
-                'type' => 'number',
-                'protected' => true,
-            ),
-            'spots_taken_pending_payment' => array(
-                'description' => esc_html__(
-                    'The count of pending-payment registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for',
-                    'event_espresso'
-                ),
-                'type' => 'number',
-                'protected' => true,
-            ),
-        );
-    }
+	/**
+	 * Provides an array for all the calculations possible that outlines a json schema for those calculations.
+	 * Array is indexed by calculation (snake case) and value is the schema for that calculation.
+	 *
+	 * @since 4.9.68.p
+	 * @return array
+	 */
+	public function schemaForCalculations()
+	{
+		return array(
+			'spaces_remaining_considering_tickets' => array(
+				'description' => esc_html__(
+					'Calculates the total spaces available on the datetime, taking into account ticket limits too.',
+					'event_espresso'
+				),
+				'type' => 'number',
+				'protected' => true,
+			),
+			'registrations_checked_in_count' => array(
+				'description' => esc_html__(
+					'Counts registrations who have checked into this datetime.',
+					'event_espresso'
+				),
+				'type' => 'number',
+				'protected' => true,
+			),
+			'registrations_checked_out_count' => array(
+				'description' => esc_html__(
+					'Counts registrations who have checked out of this datetime.',
+					'event_espresso'
+				),
+				'type' => 'number',
+				'protected' => true,
+			),
+			'spots_taken_pending_payment' => array(
+				'description' => esc_html__(
+					'The count of pending-payment registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for',
+					'event_espresso'
+				),
+				'type' => 'number',
+				'protected' => true,
+			),
+		);
+	}
 }

core/libraries/rest_api/calculations/Event.php

Indentation +567 added lines, -567 removed lines

@@ -27,571 +27,571 @@
  */
 class Event extends EventCalculationBase
 {
-    /**
-     * @var EEM_Event
-     */
-    protected $event_model;
-
-    /**
-     * @var EEM_Registration
-     */
-    protected $registration_model;
-    public function __construct(EEM_Event $event_model, EEM_Registration $registration_model)
-    {
-        $this->event_model = $event_model;
-        $this->registration_model = $registration_model;
-    }
-
-    /**
-     * Calculates the total spaces on the event (not subtracting sales, but taking
-     * sales into account; so this is the optimum sales that CAN still be achieved)
-     * See EE_Event::total_available_spaces( true );
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws UnexpectedEntityException
-     * @throws InvalidArgumentException
-     */
-    public function optimumSalesAtStart($wpdb_row, $request, $controller)
-    {
-        $event_obj = null;
-        if (Event::wpdbRowHasEventId($wpdb_row)) {
-            $event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']);
-        }
-        if ($event_obj instanceof EE_Event) {
-            return $event_obj->total_available_spaces();
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                // @codingStandardsIgnoreStart
-                    'Cannot calculate optimum_sales_at_start because the event with ID %1$s (from database row %2$s) was not found',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $wpdb_row['Event_CPT.ID'],
-                print_r($wpdb_row, true)
-            )
-        );
-    }
-
-
-    /**
-     * Calculates the total spaces on the event (ignoring all sales; so this is the optimum
-     * sales that COULD have been achieved)
-     * See EE_Event::total_available_spaces( true );
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return int
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws UnexpectedEntityException
-     */
-    public function optimumSalesNow($wpdb_row, $request, $controller)
-    {
-        $event_obj = null;
-        if (Event::wpdbRowHasEventId($wpdb_row)) {
-            $event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']);
-        }
-        if ($event_obj instanceof EE_Event) {
-            return $event_obj->total_available_spaces(true);
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                // @codingStandardsIgnoreStart
-                    'Cannot calculate optimum_sales_now because the event with ID %1$s (from database row %2$s) was not found',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $wpdb_row['Event_CPT.ID'],
-                print_r($wpdb_row, true)
-            )
-        );
-    }
-
-
-    /**
-     * Like optimum_sales_now, but minus total sales so far.
-     * See EE_Event::spaces_remaining_for_sale( true );
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return int
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws UnexpectedEntityException
-     */
-    public function spacesRemaining($wpdb_row, $request, $controller)
-    {
-        $event_obj = null;
-        if (Event::wpdbRowHasEventId($wpdb_row)) {
-            $event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']);
-        }
-        if ($event_obj instanceof EE_Event) {
-            return $event_obj->spaces_remaining_for_sale();
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                // @codingStandardsIgnoreStart
-                    'Cannot calculate spaces_remaining because the event with ID %1$s (from database row %2$s) was not found',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $wpdb_row['Event_CPT.ID'],
-                print_r($wpdb_row, true)
-            )
-        );
-    }
-
-
-    /**
-     * Counts the number of approved registrations for this event (regardless
-     * of how many datetimes each registrations' ticket purchase is for)
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function spotsTaken($wpdb_row, $request, $controller)
-    {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate spots_taken because the database row %1$s does not have a valid entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        return $this->registration_model->count(
-            array(
-                array(
-                    'EVT_ID' => $wpdb_row['Event_CPT.ID'],
-                    'STS_ID' => RegStatus::APPROVED,
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
-
-
-    /**
-     * Counts the number of pending-payment registrations for this event (regardless
-     * of how many datetimes each registrations' ticket purchase is for)
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function spotsTakenPendingPayment($wpdb_row, $request, $controller)
-    {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $this->verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment');
-        return $this->registration_model->count(
-            array(
-                array(
-                    'EVT_ID' => $wpdb_row['Event_CPT.ID'],
-                    'STS_ID' => RegStatus::PENDING_PAYMENT,
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
-
-
-    /**
-     * Counts all the registrations who have checked into one of this events' datetimes
-     * See EE_Event::total_available_spaces( false );
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return int|null if permission denied
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function registrationsCheckedInCount($wpdb_row, $request, $controller)
-    {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count');
-        return $this->registration_model->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], true);
-    }
-
-
-    /**
-     * Counts all the registrations who have checked out of one of this events' datetimes
-     * See EE_Event::total_available_spaces( false );
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function registrationsCheckedOutCount($wpdb_row, $request, $controller)
-    {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count');
-        return $this->registration_model->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], false);
-    }
-
-
-    /**
-     * Gets the thumbnail image
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public function imageThumbnail($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'thumbnail');
-    }
-
-
-    /**
-     * Gets the medium image
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public function imageMedium($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'medium');
-    }
-
-
-    /**
-     * Gets the medium-large image
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public function imageMediumLarge($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'medium_large');
-    }
-
-
-    /**
-     * Gets the large image
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public function imageLarge($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'large');
-    }
-
-
-    /**
-     * Gets the post-thumbnail image
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public function imagePostThumbnail($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'post-thumbnail');
-    }
-
-
-    /**
-     * Gets the full size image
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public function imageFull($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'full');
-    }
-
-
-    /**
-     * Gets image specs and formats them for the display in the API,
-     * according to the image size requested
-     *
-     * @param array  $wpdb_row
-     * @param string $image_size one of these: thumbnail, medium, medium_large, large, post-thumbnail, full
-     * @return array|false if no such image exists. If array it will have keys 'url', 'width', 'height' and 'original'
-     * @throws EE_Error
-     */
-    protected function calculateImageData($wpdb_row, $image_size)
-    {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate image because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $EVT_ID = $wpdb_row['Event_CPT.ID'];
-        $attachment_id = get_post_thumbnail_id($EVT_ID);
-        $data = wp_get_attachment_image_src($attachment_id, $image_size);
-        if (! $data) {
-            return null;
-        }
-        $generated = true;
-        if (isset($data[3])) {
-            $generated = $data[3];
-        }
-        return array(
-            'url'       => $data[0],
-            'width'     => $data[1],
-            'height'    => $data[2],
-            'generated' => $generated,
-        );
-    }
-
-
-    /**
-     * Returns true if the array of data contains 'Event_CPT.ID'. False otherwise
-     *
-     * @param array $wpdb_row
-     * @return bool
-     */
-    protected function wpdbRowHasEventId($wpdb_row)
-    {
-        return (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID']) && absint($wpdb_row['Event_CPT.ID']));
-    }
-
-
-    /**
-     * Provides an array for all the calculations possible that outlines a json schema for those calculations.
-     * Array is indexed by calculation (snake case) and value is the schema for that calculation.
-     *
-     * @since 4.9.68.p
-     * @return array
-     */
-    public function schemaForCalculations()
-    {
-        $image_object_properties = array(
-            'url'       => array(
-                'type' => 'string',
-            ),
-            'width'     => array(
-                'type' => 'number',
-            ),
-            'height'    => array(
-                'type' => 'number',
-            ),
-            'generated' => array(
-                'type' => 'boolean',
-            ),
-        );
-        return array(
-            'optimum_sales_at_start'          => array(
-                'description' => esc_html__(
-                    'The total spaces on the event (not subtracting sales, but taking sales into account; so this is the optimum sales that CAN still be achieved.',
-                    'event_espresso'
-                ),
-                'type'        => 'number',
-                'protected' => true,
-            ),
-            'optimum_sales_now'               => array(
-                'description' => esc_html__(
-                    'The total spaces on the event (ignoring all sales; so this is the optimum sales that could have been achieved.',
-                    'event_espresso'
-                ),
-                'type'        => 'number',
-                'protected' => true,
-            ),
-            'spaces_remaining'                => array(
-                'description' => esc_html__(
-                    'The optimum_sales_number result, minus total sales so far.',
-                    'event_espresso'
-                ),
-                'type'        => 'number',
-                'protected' => true,
-            ),
-            'spots_taken'                     => array(
-                'description' => esc_html__(
-                    'The number of approved registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for)',
-                    'event_espresso'
-                ),
-                'type'        => 'number',
-                'protected' => true,
-            ),
-            'spots_taken_pending_payment'     => array(
-                'description' => esc_html__(
-                    'The number of pending-payment registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for)',
-                    'event_espresso'
-                ),
-                'type'        => 'number',
-                'protected' => true,
-            ),
-            'registrations_checked_in_count'  => array(
-                'description' => esc_html__(
-                    'The count of all the registrations who have checked into one of this event\'s datetimes.',
-                    'event_espresso'
-                ),
-                'type'        => 'number',
-                'protected' => true,
-            ),
-            'registrations_checked_out_count' => array(
-                'description' => esc_html__(
-                    'The count of all registrations who have checked out of one of this event\'s datetimes.',
-                    'event_espresso'
-                ),
-                'type'        => 'number',
-                'protected' => true,
-            ),
-            'image_thumbnail'                 => array(
-                'description'          => esc_html__(
-                    'The thumbnail image data.',
-                    'event_espresso'
-                ),
-                'type'                 => 'object',
-                'properties'           => $image_object_properties,
-                'additionalProperties' => false,
-            ),
-            'image_medium'                    => array(
-                'description'          => esc_html__(
-                    'The medium image data.',
-                    'event_espresso'
-                ),
-                'type'                 => 'object',
-                'properties'           => $image_object_properties,
-                'additionalProperties' => false,
-            ),
-            'image_medium_large'              => array(
-                'description'          => esc_html__(
-                    'The medium-large image data.',
-                    'event_espresso'
-                ),
-                'type'                 => 'object',
-                'properties'           => $image_object_properties,
-                'additionalProperties' => false,
-            ),
-            'image_large'                     => array(
-                'description'          => esc_html__(
-                    'The large image data.',
-                    'event_espresso'
-                ),
-                'type'                 => 'object',
-                'properties'           => $image_object_properties,
-                'additionalProperties' => false,
-            ),
-            'image_post_thumbnail'            => array(
-                'description'          => esc_html__(
-                    'The post-thumbnail image data.',
-                    'event_espresso'
-                ),
-                'type'                 => 'object',
-                'properties'           => $image_object_properties,
-                'additionalProperties' => false,
-            ),
-            'image_full'                      => array(
-                'description'          => esc_html__(
-                    'The full size image data',
-                    'event_espresso'
-                ),
-                'type'                 => 'object',
-                'properties'           => $image_object_properties,
-                'additionalProperties' => false,
-            ),
-        );
-    }
+	/**
+	 * @var EEM_Event
+	 */
+	protected $event_model;
+
+	/**
+	 * @var EEM_Registration
+	 */
+	protected $registration_model;
+	public function __construct(EEM_Event $event_model, EEM_Registration $registration_model)
+	{
+		$this->event_model = $event_model;
+		$this->registration_model = $registration_model;
+	}
+
+	/**
+	 * Calculates the total spaces on the event (not subtracting sales, but taking
+	 * sales into account; so this is the optimum sales that CAN still be achieved)
+	 * See EE_Event::total_available_spaces( true );
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws UnexpectedEntityException
+	 * @throws InvalidArgumentException
+	 */
+	public function optimumSalesAtStart($wpdb_row, $request, $controller)
+	{
+		$event_obj = null;
+		if (Event::wpdbRowHasEventId($wpdb_row)) {
+			$event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']);
+		}
+		if ($event_obj instanceof EE_Event) {
+			return $event_obj->total_available_spaces();
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+				// @codingStandardsIgnoreStart
+					'Cannot calculate optimum_sales_at_start because the event with ID %1$s (from database row %2$s) was not found',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$wpdb_row['Event_CPT.ID'],
+				print_r($wpdb_row, true)
+			)
+		);
+	}
+
+
+	/**
+	 * Calculates the total spaces on the event (ignoring all sales; so this is the optimum
+	 * sales that COULD have been achieved)
+	 * See EE_Event::total_available_spaces( true );
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return int
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws UnexpectedEntityException
+	 */
+	public function optimumSalesNow($wpdb_row, $request, $controller)
+	{
+		$event_obj = null;
+		if (Event::wpdbRowHasEventId($wpdb_row)) {
+			$event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']);
+		}
+		if ($event_obj instanceof EE_Event) {
+			return $event_obj->total_available_spaces(true);
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+				// @codingStandardsIgnoreStart
+					'Cannot calculate optimum_sales_now because the event with ID %1$s (from database row %2$s) was not found',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$wpdb_row['Event_CPT.ID'],
+				print_r($wpdb_row, true)
+			)
+		);
+	}
+
+
+	/**
+	 * Like optimum_sales_now, but minus total sales so far.
+	 * See EE_Event::spaces_remaining_for_sale( true );
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return int
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spacesRemaining($wpdb_row, $request, $controller)
+	{
+		$event_obj = null;
+		if (Event::wpdbRowHasEventId($wpdb_row)) {
+			$event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']);
+		}
+		if ($event_obj instanceof EE_Event) {
+			return $event_obj->spaces_remaining_for_sale();
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+				// @codingStandardsIgnoreStart
+					'Cannot calculate spaces_remaining because the event with ID %1$s (from database row %2$s) was not found',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$wpdb_row['Event_CPT.ID'],
+				print_r($wpdb_row, true)
+			)
+		);
+	}
+
+
+	/**
+	 * Counts the number of approved registrations for this event (regardless
+	 * of how many datetimes each registrations' ticket purchase is for)
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function spotsTaken($wpdb_row, $request, $controller)
+	{
+		if (! Event::wpdbRowHasEventId($wpdb_row)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate spots_taken because the database row %1$s does not have a valid entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		return $this->registration_model->count(
+			array(
+				array(
+					'EVT_ID' => $wpdb_row['Event_CPT.ID'],
+					'STS_ID' => RegStatus::APPROVED,
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
+
+
+	/**
+	 * Counts the number of pending-payment registrations for this event (regardless
+	 * of how many datetimes each registrations' ticket purchase is for)
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function spotsTakenPendingPayment($wpdb_row, $request, $controller)
+	{
+		if (! Event::wpdbRowHasEventId($wpdb_row)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$this->verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment');
+		return $this->registration_model->count(
+			array(
+				array(
+					'EVT_ID' => $wpdb_row['Event_CPT.ID'],
+					'STS_ID' => RegStatus::PENDING_PAYMENT,
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
+
+
+	/**
+	 * Counts all the registrations who have checked into one of this events' datetimes
+	 * See EE_Event::total_available_spaces( false );
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return int|null if permission denied
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function registrationsCheckedInCount($wpdb_row, $request, $controller)
+	{
+		if (! Event::wpdbRowHasEventId($wpdb_row)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count');
+		return $this->registration_model->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], true);
+	}
+
+
+	/**
+	 * Counts all the registrations who have checked out of one of this events' datetimes
+	 * See EE_Event::total_available_spaces( false );
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function registrationsCheckedOutCount($wpdb_row, $request, $controller)
+	{
+		if (! Event::wpdbRowHasEventId($wpdb_row)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count');
+		return $this->registration_model->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], false);
+	}
+
+
+	/**
+	 * Gets the thumbnail image
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function imageThumbnail($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'thumbnail');
+	}
+
+
+	/**
+	 * Gets the medium image
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function imageMedium($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'medium');
+	}
+
+
+	/**
+	 * Gets the medium-large image
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function imageMediumLarge($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'medium_large');
+	}
+
+
+	/**
+	 * Gets the large image
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function imageLarge($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'large');
+	}
+
+
+	/**
+	 * Gets the post-thumbnail image
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function imagePostThumbnail($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'post-thumbnail');
+	}
+
+
+	/**
+	 * Gets the full size image
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function imageFull($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'full');
+	}
+
+
+	/**
+	 * Gets image specs and formats them for the display in the API,
+	 * according to the image size requested
+	 *
+	 * @param array  $wpdb_row
+	 * @param string $image_size one of these: thumbnail, medium, medium_large, large, post-thumbnail, full
+	 * @return array|false if no such image exists. If array it will have keys 'url', 'width', 'height' and 'original'
+	 * @throws EE_Error
+	 */
+	protected function calculateImageData($wpdb_row, $image_size)
+	{
+		if (! Event::wpdbRowHasEventId($wpdb_row)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate image because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$EVT_ID = $wpdb_row['Event_CPT.ID'];
+		$attachment_id = get_post_thumbnail_id($EVT_ID);
+		$data = wp_get_attachment_image_src($attachment_id, $image_size);
+		if (! $data) {
+			return null;
+		}
+		$generated = true;
+		if (isset($data[3])) {
+			$generated = $data[3];
+		}
+		return array(
+			'url'       => $data[0],
+			'width'     => $data[1],
+			'height'    => $data[2],
+			'generated' => $generated,
+		);
+	}
+
+
+	/**
+	 * Returns true if the array of data contains 'Event_CPT.ID'. False otherwise
+	 *
+	 * @param array $wpdb_row
+	 * @return bool
+	 */
+	protected function wpdbRowHasEventId($wpdb_row)
+	{
+		return (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID']) && absint($wpdb_row['Event_CPT.ID']));
+	}
+
+
+	/**
+	 * Provides an array for all the calculations possible that outlines a json schema for those calculations.
+	 * Array is indexed by calculation (snake case) and value is the schema for that calculation.
+	 *
+	 * @since 4.9.68.p
+	 * @return array
+	 */
+	public function schemaForCalculations()
+	{
+		$image_object_properties = array(
+			'url'       => array(
+				'type' => 'string',
+			),
+			'width'     => array(
+				'type' => 'number',
+			),
+			'height'    => array(
+				'type' => 'number',
+			),
+			'generated' => array(
+				'type' => 'boolean',
+			),
+		);
+		return array(
+			'optimum_sales_at_start'          => array(
+				'description' => esc_html__(
+					'The total spaces on the event (not subtracting sales, but taking sales into account; so this is the optimum sales that CAN still be achieved.',
+					'event_espresso'
+				),
+				'type'        => 'number',
+				'protected' => true,
+			),
+			'optimum_sales_now'               => array(
+				'description' => esc_html__(
+					'The total spaces on the event (ignoring all sales; so this is the optimum sales that could have been achieved.',
+					'event_espresso'
+				),
+				'type'        => 'number',
+				'protected' => true,
+			),
+			'spaces_remaining'                => array(
+				'description' => esc_html__(
+					'The optimum_sales_number result, minus total sales so far.',
+					'event_espresso'
+				),
+				'type'        => 'number',
+				'protected' => true,
+			),
+			'spots_taken'                     => array(
+				'description' => esc_html__(
+					'The number of approved registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for)',
+					'event_espresso'
+				),
+				'type'        => 'number',
+				'protected' => true,
+			),
+			'spots_taken_pending_payment'     => array(
+				'description' => esc_html__(
+					'The number of pending-payment registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for)',
+					'event_espresso'
+				),
+				'type'        => 'number',
+				'protected' => true,
+			),
+			'registrations_checked_in_count'  => array(
+				'description' => esc_html__(
+					'The count of all the registrations who have checked into one of this event\'s datetimes.',
+					'event_espresso'
+				),
+				'type'        => 'number',
+				'protected' => true,
+			),
+			'registrations_checked_out_count' => array(
+				'description' => esc_html__(
+					'The count of all registrations who have checked out of one of this event\'s datetimes.',
+					'event_espresso'
+				),
+				'type'        => 'number',
+				'protected' => true,
+			),
+			'image_thumbnail'                 => array(
+				'description'          => esc_html__(
+					'The thumbnail image data.',
+					'event_espresso'
+				),
+				'type'                 => 'object',
+				'properties'           => $image_object_properties,
+				'additionalProperties' => false,
+			),
+			'image_medium'                    => array(
+				'description'          => esc_html__(
+					'The medium image data.',
+					'event_espresso'
+				),
+				'type'                 => 'object',
+				'properties'           => $image_object_properties,
+				'additionalProperties' => false,
+			),
+			'image_medium_large'              => array(
+				'description'          => esc_html__(
+					'The medium-large image data.',
+					'event_espresso'
+				),
+				'type'                 => 'object',
+				'properties'           => $image_object_properties,
+				'additionalProperties' => false,
+			),
+			'image_large'                     => array(
+				'description'          => esc_html__(
+					'The large image data.',
+					'event_espresso'
+				),
+				'type'                 => 'object',
+				'properties'           => $image_object_properties,
+				'additionalProperties' => false,
+			),
+			'image_post_thumbnail'            => array(
+				'description'          => esc_html__(
+					'The post-thumbnail image data.',
+					'event_espresso'
+				),
+				'type'                 => 'object',
+				'properties'           => $image_object_properties,
+				'additionalProperties' => false,
+			),
+			'image_full'                      => array(
+				'description'          => esc_html__(
+					'The full size image data',
+					'event_espresso'
+				),
+				'type'                 => 'object',
+				'properties'           => $image_object_properties,
+				'additionalProperties' => false,
+			),
+		);
+	}
 }

core/libraries/rest_api/controllers/rpc/Checkin.php

Indentation +118 added lines, -118 removed lines

@@ -25,124 +25,124 @@
  */
 class Checkin extends Base
 {
-    /**
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @return WP_Error|WP_REST_Response
-     */
-    public static function handleRequestToggleCheckin(WP_REST_Request $request, $version)
-    {
-        $controller = new Checkin();
-        return $controller->createCheckinCheckoutObject($request, $version);
-    }
+	/**
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @return WP_Error|WP_REST_Response
+	 */
+	public static function handleRequestToggleCheckin(WP_REST_Request $request, $version)
+	{
+		$controller = new Checkin();
+		return $controller->createCheckinCheckoutObject($request, $version);
+	}
 
 
-    /**
-     * Toggles whether the user is checked in or not.
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @return WP_Error|WP_REST_Response
-     */
-    protected function createCheckinCheckoutObject(WP_REST_Request $request, $version)
-    {
-        $reg_id = $request->get_param('REG_ID');
-        $dtt_id = $request->get_param('DTT_ID');
-        $force = $request->get_param('force');
-        if ($force == 'true') {
-            $force = true;
-        } else {
-            $force = false;
-        }
-        $reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $reg instanceof EE_Registration) {
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_registration_toggle_checkin_invalid_id',
-                    sprintf(
-                        esc_html__(
-                            'You cannot checkin registration with ID %1$s because it doesn\'t exist.',
-                            'event_espresso'
-                        ),
-                        $reg_id
-                    ),
-                    array('status' => 422)
-                )
-            );
-        }
-        if (! EE_Capabilities::instance()->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)) {
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_user_cannot_toggle_checkin',
-                    sprintf(
-                        esc_html__('You are not allowed to checkin registration with ID %1$s.', 'event_espresso'),
-                        $reg_id
-                    ),
-                    array('status' => 403)
-                )
-            );
-        }
-        $success = $reg->toggle_checkin_status($dtt_id, ! $force);
-        if ($success === false) {
-            // check if we know they can't check in because they're not approved and we aren't forcing
-            if (! $reg->is_approved() && ! $force) {
-                // rely on EE_Error::add_error messages to have been added to give more data about why it failed
-                return $this->sendResponse(
-                    new WP_Error(
-                        'rest_toggle_checkin_failed',
-                        esc_html__(
-                        // @codingStandardsIgnoreStart
-                            'Registration check-in failed because the registration is not approved / awaiting review. You may attempt to force checking in though.',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        )
-                    )
-                );
-            }
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_toggle_checkin_failed_not_forceable',
-                    esc_html__('Registration checkin failed. Please see additional error data.', 'event_espresso')
-                )
-            );
-        }
-        $checkin = EEM_Checkin::instance()->get_one(
-            array(
-                array(
-                    'REG_ID' => $reg_id,
-                    'DTT_ID' => $dtt_id,
-                ),
-                'order_by' => array(
-                    'CHK_timestamp' => 'DESC',
-                ),
-            )
-        );
-        if (! $checkin instanceof EE_Checkin) {
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_toggle_checkin_error',
-                    sprintf(
-                        esc_html__(
-                        // @codingStandardsIgnoreStart
-                            'Supposedly we created a new checkin object for registration %1$s at datetime %2$s, but we can\'t find it.',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        ),
-                        $reg_id,
-                        $dtt_id
-                    )
-                )
-            );
-        }
-        $get_request = new WP_REST_Request(
-            'GET',
-            '/' . EED_Core_Rest_Api::ee_api_namespace . 'v' . $version . '/checkins/' . $checkin->ID()
-        );
-        $get_request->set_url_params(
-            array(
-                'id' => $checkin->ID(),
-            )
-        );
-        return Read::handleRequestGetOne($get_request, $version, 'Checkin');
-    }
+	/**
+	 * Toggles whether the user is checked in or not.
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @return WP_Error|WP_REST_Response
+	 */
+	protected function createCheckinCheckoutObject(WP_REST_Request $request, $version)
+	{
+		$reg_id = $request->get_param('REG_ID');
+		$dtt_id = $request->get_param('DTT_ID');
+		$force = $request->get_param('force');
+		if ($force == 'true') {
+			$force = true;
+		} else {
+			$force = false;
+		}
+		$reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
+		if (! $reg instanceof EE_Registration) {
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_registration_toggle_checkin_invalid_id',
+					sprintf(
+						esc_html__(
+							'You cannot checkin registration with ID %1$s because it doesn\'t exist.',
+							'event_espresso'
+						),
+						$reg_id
+					),
+					array('status' => 422)
+				)
+			);
+		}
+		if (! EE_Capabilities::instance()->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)) {
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_user_cannot_toggle_checkin',
+					sprintf(
+						esc_html__('You are not allowed to checkin registration with ID %1$s.', 'event_espresso'),
+						$reg_id
+					),
+					array('status' => 403)
+				)
+			);
+		}
+		$success = $reg->toggle_checkin_status($dtt_id, ! $force);
+		if ($success === false) {
+			// check if we know they can't check in because they're not approved and we aren't forcing
+			if (! $reg->is_approved() && ! $force) {
+				// rely on EE_Error::add_error messages to have been added to give more data about why it failed
+				return $this->sendResponse(
+					new WP_Error(
+						'rest_toggle_checkin_failed',
+						esc_html__(
+						// @codingStandardsIgnoreStart
+							'Registration check-in failed because the registration is not approved / awaiting review. You may attempt to force checking in though.',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						)
+					)
+				);
+			}
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_toggle_checkin_failed_not_forceable',
+					esc_html__('Registration checkin failed. Please see additional error data.', 'event_espresso')
+				)
+			);
+		}
+		$checkin = EEM_Checkin::instance()->get_one(
+			array(
+				array(
+					'REG_ID' => $reg_id,
+					'DTT_ID' => $dtt_id,
+				),
+				'order_by' => array(
+					'CHK_timestamp' => 'DESC',
+				),
+			)
+		);
+		if (! $checkin instanceof EE_Checkin) {
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_toggle_checkin_error',
+					sprintf(
+						esc_html__(
+						// @codingStandardsIgnoreStart
+							'Supposedly we created a new checkin object for registration %1$s at datetime %2$s, but we can\'t find it.',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						),
+						$reg_id,
+						$dtt_id
+					)
+				)
+			);
+		}
+		$get_request = new WP_REST_Request(
+			'GET',
+			'/' . EED_Core_Rest_Api::ee_api_namespace . 'v' . $version . '/checkins/' . $checkin->ID()
+		);
+		$get_request->set_url_params(
+			array(
+				'id' => $checkin->ID(),
+			)
+		);
+		return Read::handleRequestGetOne($get_request, $version, 'Checkin');
+	}
 }

core/libraries/plugin_api/EE_Register_Model_Extensions.lib.php

Indentation +135 added lines, -135 removed lines

@@ -14,150 +14,150 @@
  */
 class EE_Register_Model_Extensions implements EEI_Plugin_API
 {
-    protected static array $_registry = [];
+	protected static array $_registry = [];
 
-    protected static array $_extensions = [];
+	protected static array $_extensions = [];
 
 
-    /**
-     * register method for setting up model extensions
-     *
-     * @param string $addon_name            unique id for the extensions being setup
-     * @param array  $setup_args            {
-     * @return bool
-     * @throws EE_Error
-     * @type  array  $model_extension_paths array of folders containing DB model extensions, where each file follows
-     *                                      the models naming convention, which is:
-     *                                      EEME_{your_plugin_slug}_model_name_extended}.model_ext.php.
-     *                                      Where {your_plugin_slug} is really anything you want (but something having
-     *                                      to do with your addon, like 'Calendar' or '3D_View') and
-     *                                      model_name_extended} is the model extended.
-     *                                      The class contained in teh file should extend
-     *                                      EEME_Base_{model_name_extended}.model_ext.php.
-     *                                      Where {your_plugin_slug} is really anything you want (but something
-     *                                      having to do with your addon, like 'Calendar' or '3D_View') and
-     *                                      {model_name_extended} is the model extended. The class contained in teh
-     *                                      file should extend EEME_Base
-     * @type array   $class_extension_paths array of folders containing DB class extensions, where each file follows
-     *                                      the model class extension naming convention, which is:
-     *                                      EEE_{your_plugin_slug}_model_name_extended}.class_ext.php.
-     *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
-     *                                      and model_name_extended} is the name of the model extended, eg
-     *                                      'Attendee','Event',etc.
-     *                                      The class contained in the file should extend EEE_Base_Class
-     *                                      ._{model_name_extended}.class_ext.php.
-     *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
-     *                                      and {model_name_extended} is the name of the model extended, eg
-     *                                      'Attendee','Event',etc. The class contained in the file should extend
-     *                                      EEE_Base_Class.
-     *                                      }
-     *
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (
-            empty($addon_name)
-            || ! is_array($setup_args)
-            || (
-                empty($setup_args['model_extension_paths'])
-                && empty($setup_args['class_extension_paths'])
-            )
-        ) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Model extensions with EE_Register_Model_Extensions::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_extension_paths" (an array of full server paths to folders that contain model extensions), and "class_extension_paths" (an array of full server paths to folders that contain class extensions)',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 * register method for setting up model extensions
+	 *
+	 * @param string $addon_name            unique id for the extensions being setup
+	 * @param array  $setup_args            {
+	 * @return bool
+	 * @throws EE_Error
+	 * @type  array  $model_extension_paths array of folders containing DB model extensions, where each file follows
+	 *                                      the models naming convention, which is:
+	 *                                      EEME_{your_plugin_slug}_model_name_extended}.model_ext.php.
+	 *                                      Where {your_plugin_slug} is really anything you want (but something having
+	 *                                      to do with your addon, like 'Calendar' or '3D_View') and
+	 *                                      model_name_extended} is the model extended.
+	 *                                      The class contained in teh file should extend
+	 *                                      EEME_Base_{model_name_extended}.model_ext.php.
+	 *                                      Where {your_plugin_slug} is really anything you want (but something
+	 *                                      having to do with your addon, like 'Calendar' or '3D_View') and
+	 *                                      {model_name_extended} is the model extended. The class contained in teh
+	 *                                      file should extend EEME_Base
+	 * @type array   $class_extension_paths array of folders containing DB class extensions, where each file follows
+	 *                                      the model class extension naming convention, which is:
+	 *                                      EEE_{your_plugin_slug}_model_name_extended}.class_ext.php.
+	 *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
+	 *                                      and model_name_extended} is the name of the model extended, eg
+	 *                                      'Attendee','Event',etc.
+	 *                                      The class contained in the file should extend EEE_Base_Class
+	 *                                      ._{model_name_extended}.class_ext.php.
+	 *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
+	 *                                      and {model_name_extended} is the name of the model extended, eg
+	 *                                      'Attendee','Event',etc. The class contained in the file should extend
+	 *                                      EEE_Base_Class.
+	 *                                      }
+	 *
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (
+			empty($addon_name)
+			|| ! is_array($setup_args)
+			|| (
+				empty($setup_args['model_extension_paths'])
+				&& empty($setup_args['class_extension_paths'])
+			)
+		) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Model extensions with EE_Register_Model_Extensions::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_extension_paths" (an array of full server paths to folders that contain model extensions), and "class_extension_paths" (an array of full server paths to folders that contain class extensions)',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $addon_name ])) {
-            return true;
-        }
-        /** @var Request $request */
-        $request = LoaderFactory::getShared(Request::class);
-        if ($request->isActivation()) {
-            return false;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $addon_name ])) {
+			return true;
+		}
+		/** @var Request $request */
+		$request = LoaderFactory::getShared(Request::class);
+		if ($request->isActivation()) {
+			return false;
+		}
 
-        // check correct loading
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'An attempt was made to register "%1$s" as a Model extension has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.%2$s Hook Status: %2$s "AHEE__EE_System__load_espresso_addons" : %3$s %2$s "AHEE__EE_Admin__loaded" : %4$s%2$s',
-                        'event_espresso'
-                    ),
-                    $addon_name,
-                    '<br />',
-                    did_action('AHEE__EE_System__load_espresso_addons') ? 'action done' : 'action NOT done',
-                    did_action('AHEE__EE_Admin__loaded') ? 'action done' : 'action NOT done'
-                ),
-                '4.3'
-            );
-            return false;
-        }
+		// check correct loading
+		if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'An attempt was made to register "%1$s" as a Model extension has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.%2$s Hook Status: %2$s "AHEE__EE_System__load_espresso_addons" : %3$s %2$s "AHEE__EE_Admin__loaded" : %4$s%2$s',
+						'event_espresso'
+					),
+					$addon_name,
+					'<br />',
+					did_action('AHEE__EE_System__load_espresso_addons') ? 'action done' : 'action NOT done',
+					did_action('AHEE__EE_Admin__loaded') ? 'action done' : 'action NOT done'
+				),
+				'4.3'
+			);
+			return false;
+		}
 
-        self::$_registry[ $addon_name ]   = $setup_args;
-        self::$_extensions[ $addon_name ] = [];
+		self::$_registry[ $addon_name ]   = $setup_args;
+		self::$_extensions[ $addon_name ] = [];
 
-        if (isset($setup_args['model_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_extension_paths']);
-            // remove all files that are not PHP
-            foreach ($class_to_filepath_map as $class => $path) {
-                if (substr($path, strlen($path) - 3) !== 'php') {
-                    unset($class_to_filepath_map[ $class ]);
-                }
-            }
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $addon_name ]['models'][ $classname ] = new $classname();
-            }
-            unset($setup_args['model_extension_paths']);
-        }
-        if (isset($setup_args['class_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_extension_paths']);
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $addon_name ]['classes'][ $classname ] = new $classname();
-            }
-            unset($setup_args['class_extension_paths']);
-        }
-        foreach ($setup_args as $unknown_key => $unknown_config) {
-            throw new EE_Error(
-                sprintf(esc_html__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
-            );
-        }
-        return true;
-    }
+		if (isset($setup_args['model_extension_paths'])) {
+			require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_extension_paths']);
+			// remove all files that are not PHP
+			foreach ($class_to_filepath_map as $class => $path) {
+				if (substr($path, strlen($path) - 3) !== 'php') {
+					unset($class_to_filepath_map[ $class ]);
+				}
+			}
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			foreach (array_keys($class_to_filepath_map) as $classname) {
+				self::$_extensions[ $addon_name ]['models'][ $classname ] = new $classname();
+			}
+			unset($setup_args['model_extension_paths']);
+		}
+		if (isset($setup_args['class_extension_paths'])) {
+			require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_extension_paths']);
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			foreach (array_keys($class_to_filepath_map) as $classname) {
+				self::$_extensions[ $addon_name ]['classes'][ $classname ] = new $classname();
+			}
+			unset($setup_args['class_extension_paths']);
+		}
+		foreach ($setup_args as $unknown_key => $unknown_config) {
+			throw new EE_Error(
+				sprintf(esc_html__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
+			);
+		}
+		return true;
+	}
 
 
-    /**
-     * deregister
-     *
-     * @param string $addon_name
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        if (isset(self::$_registry[ $addon_name ])) {
-            unset(self::$_registry[ $addon_name ]);
-            foreach (self::$_extensions[ $addon_name ] as $extension_of_type) {
-                foreach ($extension_of_type as $extension) {
-                    $extension->deregister();
-                }
-            }
-        }
-    }
+	/**
+	 * deregister
+	 *
+	 * @param string $addon_name
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		if (isset(self::$_registry[ $addon_name ])) {
+			unset(self::$_registry[ $addon_name ]);
+			foreach (self::$_extensions[ $addon_name ] as $extension_of_type) {
+				foreach ($extension_of_type as $extension) {
+					$extension->deregister();
+				}
+			}
+		}
+	}
 
 
-    public static function reset(): void
-    {
-        self::$_registry = [];
-        self::$_extensions = [];
-    }
+	public static function reset(): void
+	{
+		self::$_registry = [];
+		self::$_extensions = [];
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -73,7 +73,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $addon_name ])) {
+        if (isset(self::$_registry[$addon_name])) {
             return true;
         }
         /** @var Request $request */
@@ -83,7 +83,7 @@ 
         }
 
         // check correct loading
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
             EE_Error::doing_it_wrong(
                 __METHOD__,
                 sprintf(
@@ -101,30 +101,30 @@ 
             return false;
         }
 
-        self::$_registry[ $addon_name ]   = $setup_args;
-        self::$_extensions[ $addon_name ] = [];
+        self::$_registry[$addon_name]   = $setup_args;
+        self::$_extensions[$addon_name] = [];
 
         if (isset($setup_args['model_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
+            require_once(EE_LIBRARIES.'plugin_api/db/EEME_Base.lib.php');
             $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_extension_paths']);
             // remove all files that are not PHP
             foreach ($class_to_filepath_map as $class => $path) {
                 if (substr($path, strlen($path) - 3) !== 'php') {
-                    unset($class_to_filepath_map[ $class ]);
+                    unset($class_to_filepath_map[$class]);
                 }
             }
             EEH_Autoloader::register_autoloader($class_to_filepath_map);
             foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $addon_name ]['models'][ $classname ] = new $classname();
+                self::$_extensions[$addon_name]['models'][$classname] = new $classname();
             }
             unset($setup_args['model_extension_paths']);
         }
         if (isset($setup_args['class_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
+            require_once(EE_LIBRARIES.'plugin_api/db/EEE_Base_Class.lib.php');
             $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_extension_paths']);
             EEH_Autoloader::register_autoloader($class_to_filepath_map);
             foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $addon_name ]['classes'][ $classname ] = new $classname();
+                self::$_extensions[$addon_name]['classes'][$classname] = new $classname();
             }
             unset($setup_args['class_extension_paths']);
         }
@@ -144,9 +144,9 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        if (isset(self::$_registry[ $addon_name ])) {
-            unset(self::$_registry[ $addon_name ]);
-            foreach (self::$_extensions[ $addon_name ] as $extension_of_type) {
+        if (isset(self::$_registry[$addon_name])) {
+            unset(self::$_registry[$addon_name]);
+            foreach (self::$_extensions[$addon_name] as $extension_of_type) {
                 foreach ($extension_of_type as $extension) {
                     $extension->deregister();
                 }

core/libraries/plugin_api/EE_Register_Addon.lib.php

Indentation +1255 added lines, -1255 removed lines

@@ -24,1259 +24,1259 @@
  */
 class EE_Register_Addon implements EEI_Plugin_API
 {
-    /**
-     * possibly truncated version of the EE core version string
-     *
-     * @var string
-     */
-    protected static $_core_version = '';
-
-    /**
-     * Holds values for registered addons
-     *
-     * @var array
-     */
-    protected static $_settings = [];
-
-    /**
-     * @var  array $_incompatible_addons keys are addon SLUGS
-     *                                   (first argument passed to EE_Register_Addon::register()), keys are
-     *                                   their MINIMUM VERSION (with all 5 parts. Eg 1.2.3.rc.004).
-     *                                   Generally this should be used sparingly, as we don't want to muddle up
-     *                                   EE core with knowledge of ALL the addons out there.
-     *                                   If you want NO versions of an addon to run with a certain version of core,
-     *                                   it's usually best to define the addon's "min_core_version" as part of its call
-     *                                   to EE_Register_Addon::register(), rather than using this array with a super
-     *                                   high value for its minimum plugin version.
-     */
-    protected static $_incompatible_addons = [
-        'Multi_Event_Registration' => '2.0.11.rc.002',
-        'Promotions'               => '1.0.0.rc.084',
-    ];
-
-    /**
-     * @var LoaderInterface
-     */
-    protected static $loader;
-
-
-    /**
-     * We should always be comparing core to a version like '4.3.0.rc.000',
-     * not just '4.3.0'.
-     * So if the addon developer doesn't provide that full version string,
-     * fill in the blanks for them
-     *
-     * @param string $min_core_version
-     * @return string always like '4.3.0.rc.000'
-     */
-    protected static function _effective_version(string $min_core_version): string
-    {
-        // versions: 4 . 3 . 1 . p . 123
-        // offsets:    0 . 1 . 2 . 3 . 4
-        $version_parts = explode('.', $min_core_version);
-        // check they specified the micro version (after 2nd period)
-        if (! isset($version_parts[2])) {
-            $version_parts[2] = '0';
-        }
-        // if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
-        // soon we can assume that's 'rc', but this current version is 'alpha'
-        if (! isset($version_parts[3])) {
-            $version_parts[3] = 'dev';
-        }
-        if (! isset($version_parts[4])) {
-            $version_parts[4] = '000';
-        }
-        return implode('.', $version_parts);
-    }
-
-
-    /**
-     * Returns whether or not the min core version requirement of the addon is met
-     *
-     * @param string $min_core_version    the minimum core version required by the addon
-     * @param string $actual_core_version the actual core version, optional
-     * @return bool
-     */
-    public static function _meets_min_core_version_requirement(
-        string $min_core_version,
-        string $actual_core_version = EVENT_ESPRESSO_VERSION
-    ): bool {
-        return version_compare(
-            self::_effective_version($actual_core_version),
-            self::_effective_version($min_core_version),
-            '>='
-        );
-    }
-
-
-    /**
-     * Method for registering new EE_Addons.
-     * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE
-     * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it
-     * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon
-     * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after
-     * 'activate_plugin', it registers the addon still, but its components are not registered
-     * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do
-     * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns
-     * (so that we can detect that the addon has activated on the subsequent request)
-     *
-     * @param string                  $addon_name                       [Required] the EE_Addon's name.
-     * @param array                   $setup_args                       {
-     *                                                                  An array of arguments provided for registering
-     *                                                                  the message type.
-     * @type  string                  $class_name                       the addon's main file name.
-     *                                                                  If left blank, generated from the addon name,
-     *                                                                  changes something like "calendar" to
-     *                                                                  "EE_Calendar"
-     * @type string                   $min_core_version                 the minimum version of EE Core that the
-     *                                                                  addon will work with. eg "4.8.1.rc.084"
-     * @type string                   $version                          the "software" version for the addon. eg
-     *                                                                  "1.0.0.p" for a first stable release, or
-     *                                                                  "1.0.0.rc.043" for a version in progress
-     * @type string                   $main_file_path                   the full server path to the main file
-     *                                                                  loaded directly by WP
-     * @type DomainInterface          $domain                           child class of
-     *                                                                  EventEspresso\core\domain\DomainBase
-     * @type string                   $domain_fqcn                      Fully Qualified Class Name
-     *                                                                  for the addon's Domain class
-     *                                                                  (see EventEspresso\core\domain\Domain)
-     * @type string                   $admin_path                       full server path to the folder where the
-     *                                                                  addon\'s admin files reside
-     * @type string                   $admin_callback                   a method to be called when the EE Admin is
-     *                                                                  first invoked, can be used for hooking into
-     *                                                                  any admin page
-     * @type string                   $config_section                   the section name for this addon's
-     *                                                                  configuration settings section
-     *                                                                  (defaults to "addons")
-     * @type string                   $config_class                     the class name for this addon's
-     *                                                                  configuration settings object
-     * @type string                   $config_name                      the class name for this addon's
-     *                                                                  configuration settings object
-     * @type string                   $autoloader_paths                 [Required] an array of class names and the full
-     *                                                                  server paths to those files.
-     * @type string                   $autoloader_folders               an array of  "full server paths" for any
-     *                                                                  folders containing classes that might be
-     *                                                                  invoked by the addon
-     * @type string                   $dms_paths                        [Required] an array of full server paths to
-     *                                                                  folders that contain data migration scripts.
-     *                                                                  The key should be the EE_Addon class name that
-     *                                                                  this set of data migration scripts belongs to.
-     *                                                                  If the EE_Addon class is namespaced, then this
-     *                                                                  needs to be the Fully Qualified Class Name
-     * @type string                   $module_paths                     an array of full server paths to any
-     *                                                                  EED_Modules used by the addon
-     * @type string                   $shortcode_paths                  an array of full server paths to folders
-     *                                                                  that contain EES_Shortcodes
-     * @type string                   $widget_paths                     an array of full server paths to folders
-     *                                                                  that contain WP_Widgets
-     * @type array                    $capabilities                     an array indexed by role name
-     *                                                                  (i.e administrator,author ) and the values
-     *                                                                  are an array of caps to add to the role.
-     *                                                                  'administrator' => array(
-     *                                                                  'read_addon',
-     *                                                                  'edit_addon',
-     *                                                                  etc.
-     *                                                                  ).
-     * @type EE_Meta_Capability_Map[] $capability_maps                  an array of EE_Meta_Capability_Map object
-     *                                                                  for any addons that need to register any
-     *                                                                  special meta mapped capabilities.  Should
-     *                                                                  be indexed where the key is the
-     *                                                                  EE_Meta_Capability_Map class name and the
-     *                                                                  values are the arguments sent to the class.
-     * @type array                    $model_paths                      array of folders containing DB models
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since                                                           4.3.0
-     * @see                                                             EE_Register_Model
-     * @type array                    $class_paths                      array of folders containing DB classes
-     * @see                                                             EE_Register_Model
-     * @type array                    $model_extension_paths            array of folders containing DB model
-     *                                                                  extensions
-     * @see                                                             EE_Register_Model_Extension
-     * @type array                    $class_extension_paths            array of folders containing DB class
-     *                                                                  extensions
-     * @see                                                             EE_Register_Model_Extension
-     * @type array message_types {
-     *                                                                  An array of message types with the key as
-     *                                                                  the message type name and the values as
-     *                                                                  below:
-     * @type string                   $mtfilename                       [Required] The filename of the message type
-     *                                                                  being registered. This will be the main
-     *                                                                  EE_{Message Type Name}_message_type class.
-     *                                                                  for example:
-     *                                                                  EE_Declined_Registration_message_type.class.php
-     * @type array                    $autoloadpaths                    [Required] An array of paths to add to the
-     *                                                                  messages autoloader for the new message type.
-     * @type array                    $messengers_to_activate_with      An array of messengers that this message
-     *                                                                  type should activate with. Each value in
-     *                                                                  the
-     *                                                                  array
-     *                                                                  should match the name property of a
-     *                                                                  EE_messenger. Optional.
-     * @type array                    $messengers_to_validate_with      An array of messengers that this message
-     *                                                                  type should validate with. Each value in
-     *                                                                  the
-     *                                                                  array
-     *                                                                  should match the name property of an
-     *                                                                  EE_messenger.
-     *                                                                  Optional.
-     *                                                                  }
-     * @type array                    $custom_post_types
-     * @type array                    $custom_taxonomies
-     * @type array                    $payment_method_paths             each element is the folder containing the
-     *                                                                  EE_PMT_Base child class
-     *                                                                  (eg,
-     *                                                                  '/wp-content/plugins/my_plugin/Payomatic/'
-     *                                                                  which contains the files
-     *                                                                  EE_PMT_Payomatic.pm.php)
-     * @type array                    $default_terms
-     * @type array                    $namespace                        {
-     *                                                                  An array with two items for registering the
-     *                                                                  addon's namespace. (If, for some reason, you
-     *                                                                  require additional namespaces,
-     *                                                                  use
-     *                                                                  EventEspresso\core\Psr4Autoloader::addNamespace()
-     *                                                                  directly)
-     * @see                                                             EventEspresso\core\Psr4Autoloader::addNamespace()
-     * @type string                   $FQNS                             the namespace prefix
-     * @type string                   $DIR                              a base directory for class files in the
-     *                                                                  namespace.
-     *                                                                  }
-     *                                                                  }
-     * @type string                   $privacy_policies                 FQNSs (namespaces, each of which contains only
-     *                                                                  privacy policy classes) or FQCNs (specific
-     *                                                                  classnames of privacy policy classes)
-     * @type string                   $personal_data_exporters          FQNSs (namespaces, each of which contains only
-     *                                                                  privacy policy classes) or FQCNs (specific
-     *                                                                  classnames of privacy policy classes)
-     * @type string                   $personal_data_erasers            FQNSs (namespaces, each of which contains only
-     *                                                                  privacy policy classes) or FQCNs (specific
-     *                                                                  classnames of privacy policy classes)
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        // $addon_name = basename($addon_name);
-        if (! self::$loader instanceof LoaderInterface) {
-            self::$loader = LoaderFactory::getLoader();
-        }
-        // make sure this was called in the right place!
-        if (
-            ! did_action('activate_plugin')
-            && (
-                ! did_action('AHEE__EE_System__load_espresso_addons')
-                || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
-            )
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                ),
-                '4.3.0'
-            );
-            return false;
-        }
-        // required fields MUST be present, so let's make sure they are.
-        EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
-        // get class name for addon
-        $class_name = EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
-        // setup $_settings array from incoming values.
-        $addon_settings = EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
-        // allow early addon setup or modification of addon api settings
-        self::$_settings = (array) apply_filters(
-            'FHEE__EE_Register_Addon__register',
-            self::$_settings,
-            $addon_name,
-            $class_name,
-            $setup_args
-        );
-        // does this addon work with this version of core or WordPress ?
-        // does this addon work with this version of core or WordPress ?
-        if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
-            return false;
-        }
-        // register namespaces
-        EE_Register_Addon::_setup_namespaces($addon_settings);
-        // check if this is an activation request
-        if (EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
-            // dont bother setting up the rest of the addon atm
-            return false;
-        }
-        // we need cars
-        EE_Register_Addon::_setup_autoloaders($addon_name);
-        // register new models and extensions
-        EE_Register_Addon::_register_models_and_extensions($addon_name);
-        // setup DMS
-        EE_Register_Addon::_register_data_migration_scripts($addon_name);
-        // if config_class is present let's register config.
-        EE_Register_Addon::_register_config($addon_name);
-        // register admin pages
-        EE_Register_Addon::_register_admin_pages($addon_name);
-        // add to list of modules to be registered
-        EE_Register_Addon::_register_modules($addon_name);
-        // add to list of shortcodes to be registered
-        EE_Register_Addon::_register_shortcodes($addon_name);
-        // add to list of widgets to be registered
-        EE_Register_Addon::_register_widgets($addon_name);
-        // register capability related stuff.
-        EE_Register_Addon::_register_capabilities($addon_name);
-        // any message type to register?
-        EE_Register_Addon::_register_message_types($addon_name);
-        // any custom post type/ custom capabilities or default terms to register
-        EE_Register_Addon::_register_custom_post_types($addon_name);
-        // and any payment methods
-        EE_Register_Addon::_register_payment_methods($addon_name);
-        // and privacy policy generators
-        EE_Register_Addon::registerPrivacyPolicies($addon_name);
-        // and privacy policy generators
-        EE_Register_Addon::registerPersonalDataExporters($addon_name);
-        // and privacy policy generators
-        EE_Register_Addon::registerPersonalDataErasers($addon_name);
-        EE_Register_Addon::registerLicense($addon_name);
-        // load and instantiate main addon class
-        $addon = EE_Register_Addon::_load_and_init_addon_class($addon_name);
-        // delay calling after_registration hook on each addon until after all add-ons have been registered.
-        add_action('AHEE__EE_System__load_espresso_addons__complete', [$addon, 'after_registration'], 999);
-        return $addon instanceof EE_Addon;
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _verify_parameters(string $addon_name, array $setup_args)
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || empty($setup_args)) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
-                    'event_espresso'
-                )
-            );
-        }
-        if (empty($setup_args['main_file_path'])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
-                        'event_espresso'
-                    ),
-                    implode(',', array_keys($setup_args))
-                )
-            );
-        }
-        // check that addon has not already been registered with that name
-        if (isset(self::$_settings[ $addon_name ]) && ! did_action('activate_plugin')) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return string
-     */
-    private static function _parse_class_name(string $addon_name, array $setup_args): string
-    {
-        if (empty($setup_args['class_name'])) {
-            // generate one by first separating name with spaces
-            $class_name = str_replace(['-', '_'], ' ', trim($addon_name));
-            // capitalize, then replace spaces with underscores
-            $class_name = str_replace(' ', '_', ucwords($class_name));
-        } else {
-            $class_name = $setup_args['class_name'];
-        }
-        // check if classname is fully  qualified or is a legacy classname already prefixed with 'EE_'
-        return strpos($class_name, '\\') || strpos($class_name, 'EE_') === 0
-            ? $class_name
-            : 'EE_' . $class_name;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return array
-     */
-    private static function _get_addon_settings(string $class_name, array $setup_args): array
-    {
-        // setup $_settings array from incoming values.
-        $addon_settings = [
-            // generated from the addon name, changes something like "calendar" to "EE_Calendar"
-            'class_name'            => $class_name,
-            // the addon slug for use in URLs, etc
-            'plugin_slug'           => isset($setup_args['plugin_slug'])
-                ? (string) $setup_args['plugin_slug']
-                : sanitize_key($class_name),
-            // page slug to be used when generating the "Settings" link on the WP plugin page
-            'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
-                ? (string) $setup_args['plugin_action_slug']
-                : '',
-            // the "software" version for the addon
-            'version'               => isset($setup_args['version'])
-                ? (string) $setup_args['version']
-                : '',
-            // the minimum version of EE Core that the addon will work with
-            'min_core_version'      => isset($setup_args['min_core_version'])
-                ? (string) $setup_args['min_core_version']
-                : '',
-            // the minimum version of WordPress that the addon will work with
-            'min_wp_version'        => isset($setup_args['min_wp_version'])
-                ? (string) $setup_args['min_wp_version']
-                : EE_MIN_WP_VER_REQUIRED,
-            // full server path to main file (file loaded directly by WP)
-            'main_file_path'        => isset($setup_args['main_file_path'])
-                ? (string) $setup_args['main_file_path']
-                : '',
-            // instance of \EventEspresso\core\domain\DomainInterface
-            'domain'                => isset($setup_args['domain']) && $setup_args['domain'] instanceof DomainInterface
-                ? $setup_args['domain']
-                : null,
-            // Fully Qualified Class Name for the addon's Domain class
-            'domain_fqcn'           => isset($setup_args['domain_fqcn'])
-                ? (string) $setup_args['domain_fqcn']
-                : '',
-            // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
-            'admin_path'            => isset($setup_args['admin_path'])
-                ? (string) $setup_args['admin_path']
-                : '',
-            // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
-            'admin_callback'        => isset($setup_args['admin_callback'])
-                ? (string) $setup_args['admin_callback']
-                : '',
-            // the section name for this addon's configuration settings section (defaults to "addons")
-            'config_section'        => isset($setup_args['config_section'])
-                ? (string) $setup_args['config_section']
-                : 'addons',
-            // the class name for this addon's configuration settings object
-            'config_class'          => isset($setup_args['config_class'])
-                ? (string) $setup_args['config_class']
-                : '',
-            // the name given to the config for this addons' configuration settings object (optional)
-            'config_name'           => isset($setup_args['config_name'])
-                ? (string) $setup_args['config_name']
-                : '',
-            // an array of "class names" => "full server paths" for any classes that might be invoked by the addon
-            'autoloader_paths'      => isset($setup_args['autoloader_paths'])
-                ? (array) $setup_args['autoloader_paths']
-                : [],
-            // an array of  "full server paths" for any folders containing classes that might be invoked by the addon
-            'autoloader_folders'    => isset($setup_args['autoloader_folders'])
-                ? (array) $setup_args['autoloader_folders']
-                : [],
-            // array of full server paths to any EE_DMS data migration scripts used by the addon.
-            // The key should be the EE_Addon class name that this set of data migration scripts belongs to.
-            // If the EE_Addon class is namespaced, then this needs to be the Fully Qualified Class Name
-            'dms_paths'             => isset($setup_args['dms_paths'])
-                ? (array) $setup_args['dms_paths']
-                : [],
-            // array of full server paths to any EED_Modules used by the addon
-            'module_paths'          => isset($setup_args['module_paths'])
-                ? (array) $setup_args['module_paths']
-                : [],
-            // array of full server paths to any EES_Shortcodes used by the addon
-            'shortcode_paths'       => isset($setup_args['shortcode_paths'])
-                ? (array) $setup_args['shortcode_paths']
-                : [],
-            'shortcode_fqcns'       => isset($setup_args['shortcode_fqcns'])
-                ? (array) $setup_args['shortcode_fqcns']
-                : [],
-            // array of full server paths to any WP_Widgets used by the addon
-            'widget_paths'          => isset($setup_args['widget_paths'])
-                ? (array) $setup_args['widget_paths']
-                : [],
-            'message_types'         => isset($setup_args['message_types'])
-                ? (array) $setup_args['message_types']
-                : [],
-            'capabilities'          => isset($setup_args['capabilities'])
-                ? (array) $setup_args['capabilities']
-                : [],
-            'capability_maps'       => isset($setup_args['capability_maps'])
-                ? (array) $setup_args['capability_maps']
-                : [],
-            'model_paths'           => isset($setup_args['model_paths'])
-                ? (array) $setup_args['model_paths']
-                : [],
-            'class_paths'           => isset($setup_args['class_paths'])
-                ? (array) $setup_args['class_paths']
-                : [],
-            'model_extension_paths' => isset($setup_args['model_extension_paths'])
-                ? (array) $setup_args['model_extension_paths']
-                : [],
-            'class_extension_paths' => isset($setup_args['class_extension_paths'])
-                ? (array) $setup_args['class_extension_paths']
-                : [],
-            'custom_post_types'     => isset($setup_args['custom_post_types'])
-                ? (array) $setup_args['custom_post_types']
-                : [],
-            'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
-                ? (array) $setup_args['custom_taxonomies']
-                : [],
-            'payment_method_paths'  => isset($setup_args['payment_method_paths'])
-                ? (array) $setup_args['payment_method_paths']
-                : [],
-            'default_terms'         => isset($setup_args['default_terms'])
-                ? (array) $setup_args['default_terms']
-                : [],
-            // if not empty, inserts a new table row after this plugin's row on the WP Plugins page
-            // that can be used for adding upgrading/marketing info
-            'plugins_page_row'      => isset($setup_args['plugins_page_row'])
-                ? (array) $setup_args['plugins_page_row']
-                : [],
-            'namespace'             => isset(
-                $setup_args['namespace']['FQNS'],
-                $setup_args['namespace']['DIR']
-            )
-                ? (array) $setup_args['namespace']
-                : [],
-            'privacy_policies'      => isset($setup_args['privacy_policies'])
-                ? (array) $setup_args['privacy_policies']
-                : [],
-            'license'               => isset($setup_args['license'])
-                ? (array) $setup_args['license']
-                : [],
-        ];
-        // if plugin_action_slug is NOT set, but an admin page path IS set,
-        // then let's just use the plugin_slug since that will be used for linking to the admin page
-        $addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
-                                                && ! empty($addon_settings['admin_path'])
-            ? $addon_settings['plugin_slug']
-            : $addon_settings['plugin_action_slug'];
-        // full server path to main file (file loaded directly by WP)
-        $addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
-        return $addon_settings;
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return bool
-     */
-    private static function _addon_is_compatible(string $addon_name, array $addon_settings): bool
-    {
-        global $wp_version;
-        $incompatibility_message = '';
-        // check whether this addon version is compatible with EE core
-        if (
-            isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
-            && ! self::_meets_min_core_version_requirement(
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
-                $addon_settings['version']
-            )
-        ) {
-            $incompatibility_message = sprintf(
-                esc_html__(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.',
-                    'event_espresso'
-                ),
-                $addon_name,
-                '<br />',
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } elseif (
-            ! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
-        ) {
-            $incompatibility_message = sprintf(
-                esc_html__(
-                    '%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
-                    'event_espresso'
-                ),
-                $addon_name,
-                self::_effective_version($addon_settings['min_core_version']),
-                self::_effective_version(espresso_version()),
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } elseif (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
-            $incompatibility_message = sprintf(
-                esc_html__(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
-                    'event_espresso'
-                ),
-                $addon_name,
-                $addon_settings['min_wp_version'],
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        }
-        if (! empty($incompatibility_message)) {
-            // remove 'activate' from the REQUEST
-            // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
-            /** @var RequestInterface $request */
-            $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            $request->unSetRequestParam('activate', true);
-            if (current_user_can('activate_plugins')) {
-                // show an error message indicating the plugin didn't activate properly
-                EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
-            }
-            unset($_GET['activate'], $_REQUEST['activate']);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
-            }
-            deactivate_plugins(plugin_basename($addon_settings['main_file_path']));
-            // BAIL FROM THE ADDON REGISTRATION PROCESS
-            return false;
-        }
-        // addon IS compatible
-        return true;
-    }
-
-
-    /**
-     * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
-     *
-     * @param array $addon_settings
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _setup_namespaces(array $addon_settings)
-    {
-        //
-        if (
-            isset(
-                $addon_settings['namespace']['FQNS'],
-                $addon_settings['namespace']['DIR']
-            )
-        ) {
-            EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
-                $addon_settings['namespace']['FQNS'],
-                $addon_settings['namespace']['DIR']
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _addon_activation(string $addon_name, array $addon_settings): bool
-    {
-        // this is an activation request
-        if (did_action('activate_plugin')) {
-            // to find if THIS is the addon that was activated, just check if we have already registered it or not
-            // (as the newly-activated addon wasn't around the first time addons were registered).
-            if (
-                ! isset(self::$_settings[ $addon_name ])
-                || (isset(self::$_settings[ $addon_name ])
-                    && ! isset(self::$_settings[ $addon_name ]['class_name'])
-                )
-            ) {
-                self::$_settings[ $addon_name ] = $addon_settings;
-                $addon                          = self::_load_and_init_addon_class($addon_name);
-                $addon->set_activation_indicator_option();
-                // dont bother setting up the rest of the addon.
-                // we know it was just activated and the request will end soon
-            }
-            return true;
-        }
-        // make sure addon settings are set correctly without overwriting anything existing
-        if (isset(self::$_settings[ $addon_name ])) {
-            self::$_settings[ $addon_name ] += $addon_settings;
-        } else {
-            self::$_settings[ $addon_name ] = $addon_settings;
-        }
-        return false;
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _setup_autoloaders(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_paths'])) {
-            // setup autoloader for single file
-            EEH_Autoloader::instance()->register_autoloader(self::$_settings[ $addon_name ]['autoloader_paths']);
-        }
-        // setup autoloaders for folders
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_folders'])) {
-            foreach ((array) self::$_settings[ $addon_name ]['autoloader_folders'] as $autoloader_folder) {
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
-            }
-        }
-    }
-
-
-    /**
-     * register new models and extensions
-     *
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_models_and_extensions(string $addon_name)
-    {
-        // register new models
-        if (
-            ! empty(self::$_settings[ $addon_name ]['model_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_paths'])
-        ) {
-            EE_Register_Model::register(
-                $addon_name,
-                [
-                    'model_paths' => self::$_settings[ $addon_name ]['model_paths'],
-                    'class_paths' => self::$_settings[ $addon_name ]['class_paths'],
-                ]
-            );
-        }
-        // register model extensions
-        if (
-            ! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
-        ) {
-            EE_Register_Model_Extensions::register(
-                $addon_name,
-                [
-                    'model_extension_paths' => self::$_settings[ $addon_name ]['model_extension_paths'],
-                    'class_extension_paths' => self::$_settings[ $addon_name ]['class_extension_paths'],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_data_migration_scripts(string $addon_name)
-    {
-        // setup DMS
-        if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
-            EE_Register_Data_Migration_Scripts::register(
-                $addon_name,
-                ['dms_paths' => self::$_settings[ $addon_name ]['dms_paths']]
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_config(string $addon_name)
-    {
-        // if config_class is present let's register config.
-        if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
-            EE_Register_Config::register(
-                self::$_settings[ $addon_name ]['config_class'],
-                [
-                    'config_section' => self::$_settings[ $addon_name ]['config_section'],
-                    'config_name'    => self::$_settings[ $addon_name ]['config_name'],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_admin_pages(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
-            EE_Register_Admin_Page::register(
-                $addon_name,
-                ['page_path' => self::$_settings[ $addon_name ]['admin_path']]
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_modules(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
-            EE_Register_Module::register(
-                $addon_name,
-                ['module_paths' => self::$_settings[ $addon_name ]['module_paths']]
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_shortcodes(string $addon_name)
-    {
-        if (
-            ! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
-        ) {
-            EE_Register_Shortcode::register(
-                $addon_name,
-                [
-                    'shortcode_paths' => self::$_settings[ $addon_name ]['shortcode_paths'] ?? [],
-                    'shortcode_fqcns' => self::$_settings[ $addon_name ]['shortcode_fqcns'] ?? [],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_widgets(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
-            EE_Register_Widget::register(
-                $addon_name,
-                ['widget_paths' => self::$_settings[ $addon_name ]['widget_paths']]
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_capabilities(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['capabilities'])) {
-            EE_Register_Capabilities::register(
-                $addon_name,
-                [
-                    'capabilities'    => self::$_settings[ $addon_name ]['capabilities'],
-                    'capability_maps' => self::$_settings[ $addon_name ]['capability_maps'],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     */
-    private static function _register_message_types(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
-            add_action(
-                'EE_Brewing_Regular___messages_caf',
-                ['EE_Register_Addon', 'register_message_types']
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_custom_post_types(string $addon_name)
-    {
-        if (
-            ! empty(self::$_settings[ $addon_name ]['custom_post_types'])
-            || ! empty(self::$_settings[ $addon_name ]['custom_taxonomies'])
-        ) {
-            EE_Register_CPT::register(
-                $addon_name,
-                [
-                    'cpts'          => self::$_settings[ $addon_name ]['custom_post_types'],
-                    'cts'           => self::$_settings[ $addon_name ]['custom_taxonomies'],
-                    'default_terms' => self::$_settings[ $addon_name ]['default_terms'],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    private static function _register_payment_methods(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
-            EE_Register_Payment_Method::register(
-                $addon_name,
-                ['payment_method_paths' => self::$_settings[ $addon_name ]['payment_method_paths']]
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     */
-    private static function registerPrivacyPolicies(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['privacy_policies'])) {
-            EE_Register_Privacy_Policy::register(
-                $addon_name,
-                self::$_settings[ $addon_name ]['privacy_policies']
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     */
-    private static function registerPersonalDataExporters(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['personal_data_exporters'])) {
-            EE_Register_Personal_Data_Eraser::register(
-                $addon_name,
-                self::$_settings[ $addon_name ]['personal_data_exporters']
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     */
-    private static function registerPersonalDataErasers(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['personal_data_erasers'])) {
-            EE_Register_Personal_Data_Eraser::register(
-                $addon_name,
-                self::$_settings[ $addon_name ]['personal_data_erasers']
-            );
-        }
-    }
-
-
-    /**
-     * Loads and instantiates the EE_Addon class and adds it onto the registry
-     *
-     * @param string $addon_name
-     * @return EE_Addon
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    private static function _load_and_init_addon_class(string $addon_name): EE_Addon
-    {
-        $addon = self::$loader->getShared(
-            self::$_settings[ $addon_name ]['class_name'],
-            ['EE_Registry::create(addon)' => true]
-        );
-        if (! $addon instanceof EE_Addon) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__('The "%1$s" EE_Addon class failed to instantiate!', 'event_espresso'),
-                    self::$_settings[ $addon_name ]['class_name']
-                )
-            );
-        }
-        // setter inject dep map if required
-        if ($addon->dependencyMap() === null) {
-            $addon->setDependencyMap(self::$loader->getShared('EE_Dependency_Map'));
-        }
-        // setter inject domain if required
-        EE_Register_Addon::injectAddonDomain($addon_name, $addon);
-
-        $addon->set_name($addon_name);
-        $addon->set_plugin_slug(self::$_settings[ $addon_name ]['plugin_slug']);
-        $addon->set_plugin_basename(self::$_settings[ $addon_name ]['plugin_basename']);
-        $addon->set_main_plugin_file(self::$_settings[ $addon_name ]['main_file_path']);
-        $addon->set_plugin_action_slug(self::$_settings[ $addon_name ]['plugin_action_slug']);
-        $addon->set_plugins_page_row(self::$_settings[ $addon_name ]['plugins_page_row']);
-        $addon->set_version(self::$_settings[ $addon_name ]['version']);
-        $addon->set_min_core_version(self::_effective_version(self::$_settings[ $addon_name ]['min_core_version']));
-        $addon->set_config_section(self::$_settings[ $addon_name ]['config_section']);
-        $addon->set_config_class(self::$_settings[ $addon_name ]['config_class']);
-        $addon->set_config_name(self::$_settings[ $addon_name ]['config_name']);
-        do_action(
-            'AHEE__EE_Register_Addon___load_and_init_addon_class',
-            $addon,
-            $addon_name,
-            self::$_settings
-        );
-        // unfortunately this can't be hooked in upon construction,
-        // because we don't have the plugin's mainfile path upon construction.
-        register_deactivation_hook($addon->get_main_plugin_file(), [$addon, 'deactivation']);
-        // call any additional admin_callback functions during load_admin_controller hook
-        if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
-            add_action(
-                'AHEE__EE_System__load_controllers__load_admin_controllers',
-                [$addon, self::$_settings[ $addon_name ]['admin_callback']]
-            );
-        }
-        return $addon;
-    }
-
-
-    /**
-     * @param string   $addon_name
-     * @param EE_Addon $addon
-     * @since   4.10.13.p
-     */
-    private static function injectAddonDomain(string $addon_name, EE_Addon $addon)
-    {
-        if ($addon instanceof RequiresDomainInterface && $addon->domain() === null) {
-            // using supplied Domain object
-            $domain = self::$_settings[ $addon_name ]['domain'] instanceof DomainInterface
-                ? self::$_settings[ $addon_name ]['domain']
-                : null;
-            // or construct one using Domain FQCN
-            if ($domain === null && self::$_settings[ $addon_name ]['domain_fqcn'] !== '') {
-                $domain = self::$loader->getShared(
-                    self::$_settings[ $addon_name ]['domain_fqcn'],
-                    [
-                        new EventEspresso\core\domain\values\FilePath(
-                            self::$_settings[ $addon_name ]['main_file_path']
-                        ),
-                        EventEspresso\core\domain\values\Version::fromString(
-                            self::$_settings[ $addon_name ]['version']
-                        ),
-                    ]
-                );
-            }
-            if ($domain instanceof DomainInterface) {
-                $addon->setDomain($domain);
-            }
-        }
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 5.0.0.p
-     */
-    public static function load_pue_update()
-    {
-    }
-
-
-    /**
-     * Callback for EE_Brewing_Regular__messages_caf hook used to register message types.
-     *
-     * @return void
-     * @throws EE_Error
-     * @since 4.4.0
-     */
-    public static function register_message_types()
-    {
-        foreach (self::$_settings as $settings) {
-            if (! empty($settings['message_types'])) {
-                foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
-                    EE_Register_Message_Type::register($message_type, $message_type_settings);
-                }
-            }
-        }
-    }
-
-
-    private static function registerLicense($addon_name)
-    {
-        $addon_settings = self::$_settings[ $addon_name ] ?? [];
-        if (empty($addon_settings)) {
-            return;
-        }
-        $license_data = isset($addon_settings['license']) ? (array) $addon_settings['license'] : [];
-        // copy known values from addon settings to license data if anything's missing
-        $license_data += [
-            'main_file_path'   => $addon_settings['main_file_path'] ?? '',
-            'min_core_version' => $addon_settings['min_core_version'] ?? '',
-            'plugin_id'        => 0, // no corresponding value in addon settings
-            'plugin_slug'      => $addon_settings['plugin_slug'] ?? '',
-            'version'          => $addon_settings['version'] ?? '',
-        ];
-        EventEspresso\core\services\licensing\AddonLicense::register($addon_name, $license_data);
-    }
-
-
-    /**
-     * This deregisters an addon that was previously registered with a specific addon_name.
-     *
-     * @param string $addon_name the name for the addon that was previously registered
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since    4.3.0
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        if (isset(self::$_settings[ $addon_name ]['class_name'])) {
-            try {
-                do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
-                $class_name = self::$_settings[ $addon_name ]['class_name'];
-                if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
-                    // setup DMS
-                    EE_Register_Data_Migration_Scripts::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
-                    // register admin page
-                    EE_Register_Admin_Page::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
-                    // add to list of modules to be registered
-                    EE_Register_Module::deregister($addon_name);
-                }
-                if (
-                    ! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
-                ) {
-                    // add to list of shortcodes to be registered
-                    EE_Register_Shortcode::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
-                    // if config_class present let's register config.
-                    EE_Register_Config::deregister(self::$_settings[ $addon_name ]['config_class']);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
-                    // add to list of widgets to be registered
-                    EE_Register_Widget::deregister($addon_name);
-                }
-                if (
-                    ! empty(self::$_settings[ $addon_name ]['model_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['class_paths'])
-                ) {
-                    // add to list of shortcodes to be registered
-                    EE_Register_Model::deregister($addon_name);
-                }
-                if (
-                    ! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
-                ) {
-                    // add to list of shortcodes to be registered
-                    EE_Register_Model_Extensions::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
-                    foreach ((array) self::$_settings[ $addon_name ]['message_types'] as $message_type => $message_type_settings) {
-                        EE_Register_Message_Type::deregister($message_type);
-                    }
-                }
-                // deregister capabilities for addon
-                if (
-                    ! empty(self::$_settings[ $addon_name ]['capabilities'])
-                    || ! empty(self::$_settings[ $addon_name ]['capability_maps'])
-                ) {
-                    EE_Register_Capabilities::deregister($addon_name);
-                }
-                // deregister custom_post_types for addon
-                if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])) {
-                    EE_Register_CPT::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
-                    EE_Register_Payment_Method::deregister($addon_name);
-                }
-                $addon = EE_Registry::instance()->getAddon($class_name);
-                if ($addon instanceof EE_Addon) {
-                    remove_action(
-                        'deactivate_' . $addon->get_main_plugin_file_basename(),
-                        [$addon, 'deactivation']
-                    );
-                    remove_action(
-                        'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-                        [$addon, 'initialize_db_if_no_migrations_required']
-                    );
-                    // remove `after_registration` call
-                    remove_action(
-                        'AHEE__EE_System__load_espresso_addons__complete',
-                        [$addon, 'after_registration'],
-                        999
-                    );
-                }
-                EE_Registry::instance()->removeAddon($class_name);
-                LoaderFactory::getLoader()->remove($class_name);
-            } catch (OutOfBoundsException $addon_not_yet_registered_exception) {
-                // the add-on was not yet registered in the registry,
-                // so RegistryContainer::__get() throws this exception.
-                // also no need to worry about this or log it,
-                // it's ok to deregister an add-on before its registered in the registry
-            } catch (Exception $e) {
-                new ExceptionLogger($e);
-            }
-            unset(self::$_settings[ $addon_name ]);
-            do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
-        }
-    }
-
-
-    public static function reset(): void
-    {
-        EE_Register_Addon::$_settings = [];
-    }
-
-
-    public static function resetAll(): void
-    {
-        // EE_Register_Addon::reset();
-        EE_Register_Admin_Page::reset();
-        EE_Register_Capabilities::reset();
-        EE_Register_Config::reset();
-        EE_Register_CPT::reset();
-        EE_Register_Data_Migration_Scripts::reset();
-        EE_Register_Message_Type::reset();
-        EE_Register_Messages_Shortcode_Library::reset();
-        EE_Register_Messages_Template_Pack::reset();
-        EE_Register_Messages_Template_Variations::reset();
-        EE_Register_Model::reset();
-        EE_Register_Model_Extensions::reset();
-        EE_Register_Module::reset();
-        EE_Register_Payment_Method::reset();
-        EE_Register_Personal_Data_Eraser::reset();
-        EE_Register_Personal_Data_Exporter::reset();
-        EE_Register_Privacy_Policy::reset();
-        EE_Register_Shortcode::reset();
-        EE_Register_Widget::reset();
-    }
+	/**
+	 * possibly truncated version of the EE core version string
+	 *
+	 * @var string
+	 */
+	protected static $_core_version = '';
+
+	/**
+	 * Holds values for registered addons
+	 *
+	 * @var array
+	 */
+	protected static $_settings = [];
+
+	/**
+	 * @var  array $_incompatible_addons keys are addon SLUGS
+	 *                                   (first argument passed to EE_Register_Addon::register()), keys are
+	 *                                   their MINIMUM VERSION (with all 5 parts. Eg 1.2.3.rc.004).
+	 *                                   Generally this should be used sparingly, as we don't want to muddle up
+	 *                                   EE core with knowledge of ALL the addons out there.
+	 *                                   If you want NO versions of an addon to run with a certain version of core,
+	 *                                   it's usually best to define the addon's "min_core_version" as part of its call
+	 *                                   to EE_Register_Addon::register(), rather than using this array with a super
+	 *                                   high value for its minimum plugin version.
+	 */
+	protected static $_incompatible_addons = [
+		'Multi_Event_Registration' => '2.0.11.rc.002',
+		'Promotions'               => '1.0.0.rc.084',
+	];
+
+	/**
+	 * @var LoaderInterface
+	 */
+	protected static $loader;
+
+
+	/**
+	 * We should always be comparing core to a version like '4.3.0.rc.000',
+	 * not just '4.3.0'.
+	 * So if the addon developer doesn't provide that full version string,
+	 * fill in the blanks for them
+	 *
+	 * @param string $min_core_version
+	 * @return string always like '4.3.0.rc.000'
+	 */
+	protected static function _effective_version(string $min_core_version): string
+	{
+		// versions: 4 . 3 . 1 . p . 123
+		// offsets:    0 . 1 . 2 . 3 . 4
+		$version_parts = explode('.', $min_core_version);
+		// check they specified the micro version (after 2nd period)
+		if (! isset($version_parts[2])) {
+			$version_parts[2] = '0';
+		}
+		// if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
+		// soon we can assume that's 'rc', but this current version is 'alpha'
+		if (! isset($version_parts[3])) {
+			$version_parts[3] = 'dev';
+		}
+		if (! isset($version_parts[4])) {
+			$version_parts[4] = '000';
+		}
+		return implode('.', $version_parts);
+	}
+
+
+	/**
+	 * Returns whether or not the min core version requirement of the addon is met
+	 *
+	 * @param string $min_core_version    the minimum core version required by the addon
+	 * @param string $actual_core_version the actual core version, optional
+	 * @return bool
+	 */
+	public static function _meets_min_core_version_requirement(
+		string $min_core_version,
+		string $actual_core_version = EVENT_ESPRESSO_VERSION
+	): bool {
+		return version_compare(
+			self::_effective_version($actual_core_version),
+			self::_effective_version($min_core_version),
+			'>='
+		);
+	}
+
+
+	/**
+	 * Method for registering new EE_Addons.
+	 * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE
+	 * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it
+	 * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon
+	 * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after
+	 * 'activate_plugin', it registers the addon still, but its components are not registered
+	 * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do
+	 * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns
+	 * (so that we can detect that the addon has activated on the subsequent request)
+	 *
+	 * @param string                  $addon_name                       [Required] the EE_Addon's name.
+	 * @param array                   $setup_args                       {
+	 *                                                                  An array of arguments provided for registering
+	 *                                                                  the message type.
+	 * @type  string                  $class_name                       the addon's main file name.
+	 *                                                                  If left blank, generated from the addon name,
+	 *                                                                  changes something like "calendar" to
+	 *                                                                  "EE_Calendar"
+	 * @type string                   $min_core_version                 the minimum version of EE Core that the
+	 *                                                                  addon will work with. eg "4.8.1.rc.084"
+	 * @type string                   $version                          the "software" version for the addon. eg
+	 *                                                                  "1.0.0.p" for a first stable release, or
+	 *                                                                  "1.0.0.rc.043" for a version in progress
+	 * @type string                   $main_file_path                   the full server path to the main file
+	 *                                                                  loaded directly by WP
+	 * @type DomainInterface          $domain                           child class of
+	 *                                                                  EventEspresso\core\domain\DomainBase
+	 * @type string                   $domain_fqcn                      Fully Qualified Class Name
+	 *                                                                  for the addon's Domain class
+	 *                                                                  (see EventEspresso\core\domain\Domain)
+	 * @type string                   $admin_path                       full server path to the folder where the
+	 *                                                                  addon\'s admin files reside
+	 * @type string                   $admin_callback                   a method to be called when the EE Admin is
+	 *                                                                  first invoked, can be used for hooking into
+	 *                                                                  any admin page
+	 * @type string                   $config_section                   the section name for this addon's
+	 *                                                                  configuration settings section
+	 *                                                                  (defaults to "addons")
+	 * @type string                   $config_class                     the class name for this addon's
+	 *                                                                  configuration settings object
+	 * @type string                   $config_name                      the class name for this addon's
+	 *                                                                  configuration settings object
+	 * @type string                   $autoloader_paths                 [Required] an array of class names and the full
+	 *                                                                  server paths to those files.
+	 * @type string                   $autoloader_folders               an array of  "full server paths" for any
+	 *                                                                  folders containing classes that might be
+	 *                                                                  invoked by the addon
+	 * @type string                   $dms_paths                        [Required] an array of full server paths to
+	 *                                                                  folders that contain data migration scripts.
+	 *                                                                  The key should be the EE_Addon class name that
+	 *                                                                  this set of data migration scripts belongs to.
+	 *                                                                  If the EE_Addon class is namespaced, then this
+	 *                                                                  needs to be the Fully Qualified Class Name
+	 * @type string                   $module_paths                     an array of full server paths to any
+	 *                                                                  EED_Modules used by the addon
+	 * @type string                   $shortcode_paths                  an array of full server paths to folders
+	 *                                                                  that contain EES_Shortcodes
+	 * @type string                   $widget_paths                     an array of full server paths to folders
+	 *                                                                  that contain WP_Widgets
+	 * @type array                    $capabilities                     an array indexed by role name
+	 *                                                                  (i.e administrator,author ) and the values
+	 *                                                                  are an array of caps to add to the role.
+	 *                                                                  'administrator' => array(
+	 *                                                                  'read_addon',
+	 *                                                                  'edit_addon',
+	 *                                                                  etc.
+	 *                                                                  ).
+	 * @type EE_Meta_Capability_Map[] $capability_maps                  an array of EE_Meta_Capability_Map object
+	 *                                                                  for any addons that need to register any
+	 *                                                                  special meta mapped capabilities.  Should
+	 *                                                                  be indexed where the key is the
+	 *                                                                  EE_Meta_Capability_Map class name and the
+	 *                                                                  values are the arguments sent to the class.
+	 * @type array                    $model_paths                      array of folders containing DB models
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since                                                           4.3.0
+	 * @see                                                             EE_Register_Model
+	 * @type array                    $class_paths                      array of folders containing DB classes
+	 * @see                                                             EE_Register_Model
+	 * @type array                    $model_extension_paths            array of folders containing DB model
+	 *                                                                  extensions
+	 * @see                                                             EE_Register_Model_Extension
+	 * @type array                    $class_extension_paths            array of folders containing DB class
+	 *                                                                  extensions
+	 * @see                                                             EE_Register_Model_Extension
+	 * @type array message_types {
+	 *                                                                  An array of message types with the key as
+	 *                                                                  the message type name and the values as
+	 *                                                                  below:
+	 * @type string                   $mtfilename                       [Required] The filename of the message type
+	 *                                                                  being registered. This will be the main
+	 *                                                                  EE_{Message Type Name}_message_type class.
+	 *                                                                  for example:
+	 *                                                                  EE_Declined_Registration_message_type.class.php
+	 * @type array                    $autoloadpaths                    [Required] An array of paths to add to the
+	 *                                                                  messages autoloader for the new message type.
+	 * @type array                    $messengers_to_activate_with      An array of messengers that this message
+	 *                                                                  type should activate with. Each value in
+	 *                                                                  the
+	 *                                                                  array
+	 *                                                                  should match the name property of a
+	 *                                                                  EE_messenger. Optional.
+	 * @type array                    $messengers_to_validate_with      An array of messengers that this message
+	 *                                                                  type should validate with. Each value in
+	 *                                                                  the
+	 *                                                                  array
+	 *                                                                  should match the name property of an
+	 *                                                                  EE_messenger.
+	 *                                                                  Optional.
+	 *                                                                  }
+	 * @type array                    $custom_post_types
+	 * @type array                    $custom_taxonomies
+	 * @type array                    $payment_method_paths             each element is the folder containing the
+	 *                                                                  EE_PMT_Base child class
+	 *                                                                  (eg,
+	 *                                                                  '/wp-content/plugins/my_plugin/Payomatic/'
+	 *                                                                  which contains the files
+	 *                                                                  EE_PMT_Payomatic.pm.php)
+	 * @type array                    $default_terms
+	 * @type array                    $namespace                        {
+	 *                                                                  An array with two items for registering the
+	 *                                                                  addon's namespace. (If, for some reason, you
+	 *                                                                  require additional namespaces,
+	 *                                                                  use
+	 *                                                                  EventEspresso\core\Psr4Autoloader::addNamespace()
+	 *                                                                  directly)
+	 * @see                                                             EventEspresso\core\Psr4Autoloader::addNamespace()
+	 * @type string                   $FQNS                             the namespace prefix
+	 * @type string                   $DIR                              a base directory for class files in the
+	 *                                                                  namespace.
+	 *                                                                  }
+	 *                                                                  }
+	 * @type string                   $privacy_policies                 FQNSs (namespaces, each of which contains only
+	 *                                                                  privacy policy classes) or FQCNs (specific
+	 *                                                                  classnames of privacy policy classes)
+	 * @type string                   $personal_data_exporters          FQNSs (namespaces, each of which contains only
+	 *                                                                  privacy policy classes) or FQCNs (specific
+	 *                                                                  classnames of privacy policy classes)
+	 * @type string                   $personal_data_erasers            FQNSs (namespaces, each of which contains only
+	 *                                                                  privacy policy classes) or FQCNs (specific
+	 *                                                                  classnames of privacy policy classes)
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		// $addon_name = basename($addon_name);
+		if (! self::$loader instanceof LoaderInterface) {
+			self::$loader = LoaderFactory::getLoader();
+		}
+		// make sure this was called in the right place!
+		if (
+			! did_action('activate_plugin')
+			&& (
+				! did_action('AHEE__EE_System__load_espresso_addons')
+				|| did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
+			)
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
+						'event_espresso'
+					),
+					$addon_name
+				),
+				'4.3.0'
+			);
+			return false;
+		}
+		// required fields MUST be present, so let's make sure they are.
+		EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
+		// get class name for addon
+		$class_name = EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
+		// setup $_settings array from incoming values.
+		$addon_settings = EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
+		// allow early addon setup or modification of addon api settings
+		self::$_settings = (array) apply_filters(
+			'FHEE__EE_Register_Addon__register',
+			self::$_settings,
+			$addon_name,
+			$class_name,
+			$setup_args
+		);
+		// does this addon work with this version of core or WordPress ?
+		// does this addon work with this version of core or WordPress ?
+		if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
+			return false;
+		}
+		// register namespaces
+		EE_Register_Addon::_setup_namespaces($addon_settings);
+		// check if this is an activation request
+		if (EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
+			// dont bother setting up the rest of the addon atm
+			return false;
+		}
+		// we need cars
+		EE_Register_Addon::_setup_autoloaders($addon_name);
+		// register new models and extensions
+		EE_Register_Addon::_register_models_and_extensions($addon_name);
+		// setup DMS
+		EE_Register_Addon::_register_data_migration_scripts($addon_name);
+		// if config_class is present let's register config.
+		EE_Register_Addon::_register_config($addon_name);
+		// register admin pages
+		EE_Register_Addon::_register_admin_pages($addon_name);
+		// add to list of modules to be registered
+		EE_Register_Addon::_register_modules($addon_name);
+		// add to list of shortcodes to be registered
+		EE_Register_Addon::_register_shortcodes($addon_name);
+		// add to list of widgets to be registered
+		EE_Register_Addon::_register_widgets($addon_name);
+		// register capability related stuff.
+		EE_Register_Addon::_register_capabilities($addon_name);
+		// any message type to register?
+		EE_Register_Addon::_register_message_types($addon_name);
+		// any custom post type/ custom capabilities or default terms to register
+		EE_Register_Addon::_register_custom_post_types($addon_name);
+		// and any payment methods
+		EE_Register_Addon::_register_payment_methods($addon_name);
+		// and privacy policy generators
+		EE_Register_Addon::registerPrivacyPolicies($addon_name);
+		// and privacy policy generators
+		EE_Register_Addon::registerPersonalDataExporters($addon_name);
+		// and privacy policy generators
+		EE_Register_Addon::registerPersonalDataErasers($addon_name);
+		EE_Register_Addon::registerLicense($addon_name);
+		// load and instantiate main addon class
+		$addon = EE_Register_Addon::_load_and_init_addon_class($addon_name);
+		// delay calling after_registration hook on each addon until after all add-ons have been registered.
+		add_action('AHEE__EE_System__load_espresso_addons__complete', [$addon, 'after_registration'], 999);
+		return $addon instanceof EE_Addon;
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _verify_parameters(string $addon_name, array $setup_args)
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || empty($setup_args)) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
+					'event_espresso'
+				)
+			);
+		}
+		if (empty($setup_args['main_file_path'])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
+						'event_espresso'
+					),
+					implode(',', array_keys($setup_args))
+				)
+			);
+		}
+		// check that addon has not already been registered with that name
+		if (isset(self::$_settings[ $addon_name ]) && ! did_action('activate_plugin')) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
+						'event_espresso'
+					),
+					$addon_name
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return string
+	 */
+	private static function _parse_class_name(string $addon_name, array $setup_args): string
+	{
+		if (empty($setup_args['class_name'])) {
+			// generate one by first separating name with spaces
+			$class_name = str_replace(['-', '_'], ' ', trim($addon_name));
+			// capitalize, then replace spaces with underscores
+			$class_name = str_replace(' ', '_', ucwords($class_name));
+		} else {
+			$class_name = $setup_args['class_name'];
+		}
+		// check if classname is fully  qualified or is a legacy classname already prefixed with 'EE_'
+		return strpos($class_name, '\\') || strpos($class_name, 'EE_') === 0
+			? $class_name
+			: 'EE_' . $class_name;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return array
+	 */
+	private static function _get_addon_settings(string $class_name, array $setup_args): array
+	{
+		// setup $_settings array from incoming values.
+		$addon_settings = [
+			// generated from the addon name, changes something like "calendar" to "EE_Calendar"
+			'class_name'            => $class_name,
+			// the addon slug for use in URLs, etc
+			'plugin_slug'           => isset($setup_args['plugin_slug'])
+				? (string) $setup_args['plugin_slug']
+				: sanitize_key($class_name),
+			// page slug to be used when generating the "Settings" link on the WP plugin page
+			'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
+				? (string) $setup_args['plugin_action_slug']
+				: '',
+			// the "software" version for the addon
+			'version'               => isset($setup_args['version'])
+				? (string) $setup_args['version']
+				: '',
+			// the minimum version of EE Core that the addon will work with
+			'min_core_version'      => isset($setup_args['min_core_version'])
+				? (string) $setup_args['min_core_version']
+				: '',
+			// the minimum version of WordPress that the addon will work with
+			'min_wp_version'        => isset($setup_args['min_wp_version'])
+				? (string) $setup_args['min_wp_version']
+				: EE_MIN_WP_VER_REQUIRED,
+			// full server path to main file (file loaded directly by WP)
+			'main_file_path'        => isset($setup_args['main_file_path'])
+				? (string) $setup_args['main_file_path']
+				: '',
+			// instance of \EventEspresso\core\domain\DomainInterface
+			'domain'                => isset($setup_args['domain']) && $setup_args['domain'] instanceof DomainInterface
+				? $setup_args['domain']
+				: null,
+			// Fully Qualified Class Name for the addon's Domain class
+			'domain_fqcn'           => isset($setup_args['domain_fqcn'])
+				? (string) $setup_args['domain_fqcn']
+				: '',
+			// path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
+			'admin_path'            => isset($setup_args['admin_path'])
+				? (string) $setup_args['admin_path']
+				: '',
+			// a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
+			'admin_callback'        => isset($setup_args['admin_callback'])
+				? (string) $setup_args['admin_callback']
+				: '',
+			// the section name for this addon's configuration settings section (defaults to "addons")
+			'config_section'        => isset($setup_args['config_section'])
+				? (string) $setup_args['config_section']
+				: 'addons',
+			// the class name for this addon's configuration settings object
+			'config_class'          => isset($setup_args['config_class'])
+				? (string) $setup_args['config_class']
+				: '',
+			// the name given to the config for this addons' configuration settings object (optional)
+			'config_name'           => isset($setup_args['config_name'])
+				? (string) $setup_args['config_name']
+				: '',
+			// an array of "class names" => "full server paths" for any classes that might be invoked by the addon
+			'autoloader_paths'      => isset($setup_args['autoloader_paths'])
+				? (array) $setup_args['autoloader_paths']
+				: [],
+			// an array of  "full server paths" for any folders containing classes that might be invoked by the addon
+			'autoloader_folders'    => isset($setup_args['autoloader_folders'])
+				? (array) $setup_args['autoloader_folders']
+				: [],
+			// array of full server paths to any EE_DMS data migration scripts used by the addon.
+			// The key should be the EE_Addon class name that this set of data migration scripts belongs to.
+			// If the EE_Addon class is namespaced, then this needs to be the Fully Qualified Class Name
+			'dms_paths'             => isset($setup_args['dms_paths'])
+				? (array) $setup_args['dms_paths']
+				: [],
+			// array of full server paths to any EED_Modules used by the addon
+			'module_paths'          => isset($setup_args['module_paths'])
+				? (array) $setup_args['module_paths']
+				: [],
+			// array of full server paths to any EES_Shortcodes used by the addon
+			'shortcode_paths'       => isset($setup_args['shortcode_paths'])
+				? (array) $setup_args['shortcode_paths']
+				: [],
+			'shortcode_fqcns'       => isset($setup_args['shortcode_fqcns'])
+				? (array) $setup_args['shortcode_fqcns']
+				: [],
+			// array of full server paths to any WP_Widgets used by the addon
+			'widget_paths'          => isset($setup_args['widget_paths'])
+				? (array) $setup_args['widget_paths']
+				: [],
+			'message_types'         => isset($setup_args['message_types'])
+				? (array) $setup_args['message_types']
+				: [],
+			'capabilities'          => isset($setup_args['capabilities'])
+				? (array) $setup_args['capabilities']
+				: [],
+			'capability_maps'       => isset($setup_args['capability_maps'])
+				? (array) $setup_args['capability_maps']
+				: [],
+			'model_paths'           => isset($setup_args['model_paths'])
+				? (array) $setup_args['model_paths']
+				: [],
+			'class_paths'           => isset($setup_args['class_paths'])
+				? (array) $setup_args['class_paths']
+				: [],
+			'model_extension_paths' => isset($setup_args['model_extension_paths'])
+				? (array) $setup_args['model_extension_paths']
+				: [],
+			'class_extension_paths' => isset($setup_args['class_extension_paths'])
+				? (array) $setup_args['class_extension_paths']
+				: [],
+			'custom_post_types'     => isset($setup_args['custom_post_types'])
+				? (array) $setup_args['custom_post_types']
+				: [],
+			'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
+				? (array) $setup_args['custom_taxonomies']
+				: [],
+			'payment_method_paths'  => isset($setup_args['payment_method_paths'])
+				? (array) $setup_args['payment_method_paths']
+				: [],
+			'default_terms'         => isset($setup_args['default_terms'])
+				? (array) $setup_args['default_terms']
+				: [],
+			// if not empty, inserts a new table row after this plugin's row on the WP Plugins page
+			// that can be used for adding upgrading/marketing info
+			'plugins_page_row'      => isset($setup_args['plugins_page_row'])
+				? (array) $setup_args['plugins_page_row']
+				: [],
+			'namespace'             => isset(
+				$setup_args['namespace']['FQNS'],
+				$setup_args['namespace']['DIR']
+			)
+				? (array) $setup_args['namespace']
+				: [],
+			'privacy_policies'      => isset($setup_args['privacy_policies'])
+				? (array) $setup_args['privacy_policies']
+				: [],
+			'license'               => isset($setup_args['license'])
+				? (array) $setup_args['license']
+				: [],
+		];
+		// if plugin_action_slug is NOT set, but an admin page path IS set,
+		// then let's just use the plugin_slug since that will be used for linking to the admin page
+		$addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
+												&& ! empty($addon_settings['admin_path'])
+			? $addon_settings['plugin_slug']
+			: $addon_settings['plugin_action_slug'];
+		// full server path to main file (file loaded directly by WP)
+		$addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
+		return $addon_settings;
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return bool
+	 */
+	private static function _addon_is_compatible(string $addon_name, array $addon_settings): bool
+	{
+		global $wp_version;
+		$incompatibility_message = '';
+		// check whether this addon version is compatible with EE core
+		if (
+			isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
+			&& ! self::_meets_min_core_version_requirement(
+				EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+				$addon_settings['version']
+			)
+		) {
+			$incompatibility_message = sprintf(
+				esc_html__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.',
+					'event_espresso'
+				),
+				$addon_name,
+				'<br />',
+				EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} elseif (
+			! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
+		) {
+			$incompatibility_message = sprintf(
+				esc_html__(
+					'%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
+					'event_espresso'
+				),
+				$addon_name,
+				self::_effective_version($addon_settings['min_core_version']),
+				self::_effective_version(espresso_version()),
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} elseif (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
+			$incompatibility_message = sprintf(
+				esc_html__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
+					'event_espresso'
+				),
+				$addon_name,
+				$addon_settings['min_wp_version'],
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		}
+		if (! empty($incompatibility_message)) {
+			// remove 'activate' from the REQUEST
+			// so WP doesn't erroneously tell the user the plugin activated fine when it didn't
+			/** @var RequestInterface $request */
+			$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			$request->unSetRequestParam('activate', true);
+			if (current_user_can('activate_plugins')) {
+				// show an error message indicating the plugin didn't activate properly
+				EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
+			}
+			unset($_GET['activate'], $_REQUEST['activate']);
+			if (! function_exists('deactivate_plugins')) {
+				require_once ABSPATH . 'wp-admin/includes/plugin.php';
+			}
+			deactivate_plugins(plugin_basename($addon_settings['main_file_path']));
+			// BAIL FROM THE ADDON REGISTRATION PROCESS
+			return false;
+		}
+		// addon IS compatible
+		return true;
+	}
+
+
+	/**
+	 * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
+	 *
+	 * @param array $addon_settings
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _setup_namespaces(array $addon_settings)
+	{
+		//
+		if (
+			isset(
+				$addon_settings['namespace']['FQNS'],
+				$addon_settings['namespace']['DIR']
+			)
+		) {
+			EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
+				$addon_settings['namespace']['FQNS'],
+				$addon_settings['namespace']['DIR']
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _addon_activation(string $addon_name, array $addon_settings): bool
+	{
+		// this is an activation request
+		if (did_action('activate_plugin')) {
+			// to find if THIS is the addon that was activated, just check if we have already registered it or not
+			// (as the newly-activated addon wasn't around the first time addons were registered).
+			if (
+				! isset(self::$_settings[ $addon_name ])
+				|| (isset(self::$_settings[ $addon_name ])
+					&& ! isset(self::$_settings[ $addon_name ]['class_name'])
+				)
+			) {
+				self::$_settings[ $addon_name ] = $addon_settings;
+				$addon                          = self::_load_and_init_addon_class($addon_name);
+				$addon->set_activation_indicator_option();
+				// dont bother setting up the rest of the addon.
+				// we know it was just activated and the request will end soon
+			}
+			return true;
+		}
+		// make sure addon settings are set correctly without overwriting anything existing
+		if (isset(self::$_settings[ $addon_name ])) {
+			self::$_settings[ $addon_name ] += $addon_settings;
+		} else {
+			self::$_settings[ $addon_name ] = $addon_settings;
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _setup_autoloaders(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['autoloader_paths'])) {
+			// setup autoloader for single file
+			EEH_Autoloader::instance()->register_autoloader(self::$_settings[ $addon_name ]['autoloader_paths']);
+		}
+		// setup autoloaders for folders
+		if (! empty(self::$_settings[ $addon_name ]['autoloader_folders'])) {
+			foreach ((array) self::$_settings[ $addon_name ]['autoloader_folders'] as $autoloader_folder) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
+			}
+		}
+	}
+
+
+	/**
+	 * register new models and extensions
+	 *
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_models_and_extensions(string $addon_name)
+	{
+		// register new models
+		if (
+			! empty(self::$_settings[ $addon_name ]['model_paths'])
+			|| ! empty(self::$_settings[ $addon_name ]['class_paths'])
+		) {
+			EE_Register_Model::register(
+				$addon_name,
+				[
+					'model_paths' => self::$_settings[ $addon_name ]['model_paths'],
+					'class_paths' => self::$_settings[ $addon_name ]['class_paths'],
+				]
+			);
+		}
+		// register model extensions
+		if (
+			! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
+			|| ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+		) {
+			EE_Register_Model_Extensions::register(
+				$addon_name,
+				[
+					'model_extension_paths' => self::$_settings[ $addon_name ]['model_extension_paths'],
+					'class_extension_paths' => self::$_settings[ $addon_name ]['class_extension_paths'],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_data_migration_scripts(string $addon_name)
+	{
+		// setup DMS
+		if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+			EE_Register_Data_Migration_Scripts::register(
+				$addon_name,
+				['dms_paths' => self::$_settings[ $addon_name ]['dms_paths']]
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_config(string $addon_name)
+	{
+		// if config_class is present let's register config.
+		if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+			EE_Register_Config::register(
+				self::$_settings[ $addon_name ]['config_class'],
+				[
+					'config_section' => self::$_settings[ $addon_name ]['config_section'],
+					'config_name'    => self::$_settings[ $addon_name ]['config_name'],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_admin_pages(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+			EE_Register_Admin_Page::register(
+				$addon_name,
+				['page_path' => self::$_settings[ $addon_name ]['admin_path']]
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_modules(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+			EE_Register_Module::register(
+				$addon_name,
+				['module_paths' => self::$_settings[ $addon_name ]['module_paths']]
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_shortcodes(string $addon_name)
+	{
+		if (
+			! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
+			|| ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+		) {
+			EE_Register_Shortcode::register(
+				$addon_name,
+				[
+					'shortcode_paths' => self::$_settings[ $addon_name ]['shortcode_paths'] ?? [],
+					'shortcode_fqcns' => self::$_settings[ $addon_name ]['shortcode_fqcns'] ?? [],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_widgets(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+			EE_Register_Widget::register(
+				$addon_name,
+				['widget_paths' => self::$_settings[ $addon_name ]['widget_paths']]
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_capabilities(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['capabilities'])) {
+			EE_Register_Capabilities::register(
+				$addon_name,
+				[
+					'capabilities'    => self::$_settings[ $addon_name ]['capabilities'],
+					'capability_maps' => self::$_settings[ $addon_name ]['capability_maps'],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 */
+	private static function _register_message_types(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
+			add_action(
+				'EE_Brewing_Regular___messages_caf',
+				['EE_Register_Addon', 'register_message_types']
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_custom_post_types(string $addon_name)
+	{
+		if (
+			! empty(self::$_settings[ $addon_name ]['custom_post_types'])
+			|| ! empty(self::$_settings[ $addon_name ]['custom_taxonomies'])
+		) {
+			EE_Register_CPT::register(
+				$addon_name,
+				[
+					'cpts'          => self::$_settings[ $addon_name ]['custom_post_types'],
+					'cts'           => self::$_settings[ $addon_name ]['custom_taxonomies'],
+					'default_terms' => self::$_settings[ $addon_name ]['default_terms'],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	private static function _register_payment_methods(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+			EE_Register_Payment_Method::register(
+				$addon_name,
+				['payment_method_paths' => self::$_settings[ $addon_name ]['payment_method_paths']]
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 */
+	private static function registerPrivacyPolicies(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['privacy_policies'])) {
+			EE_Register_Privacy_Policy::register(
+				$addon_name,
+				self::$_settings[ $addon_name ]['privacy_policies']
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 */
+	private static function registerPersonalDataExporters(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['personal_data_exporters'])) {
+			EE_Register_Personal_Data_Eraser::register(
+				$addon_name,
+				self::$_settings[ $addon_name ]['personal_data_exporters']
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 */
+	private static function registerPersonalDataErasers(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['personal_data_erasers'])) {
+			EE_Register_Personal_Data_Eraser::register(
+				$addon_name,
+				self::$_settings[ $addon_name ]['personal_data_erasers']
+			);
+		}
+	}
+
+
+	/**
+	 * Loads and instantiates the EE_Addon class and adds it onto the registry
+	 *
+	 * @param string $addon_name
+	 * @return EE_Addon
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	private static function _load_and_init_addon_class(string $addon_name): EE_Addon
+	{
+		$addon = self::$loader->getShared(
+			self::$_settings[ $addon_name ]['class_name'],
+			['EE_Registry::create(addon)' => true]
+		);
+		if (! $addon instanceof EE_Addon) {
+			throw new DomainException(
+				sprintf(
+					esc_html__('The "%1$s" EE_Addon class failed to instantiate!', 'event_espresso'),
+					self::$_settings[ $addon_name ]['class_name']
+				)
+			);
+		}
+		// setter inject dep map if required
+		if ($addon->dependencyMap() === null) {
+			$addon->setDependencyMap(self::$loader->getShared('EE_Dependency_Map'));
+		}
+		// setter inject domain if required
+		EE_Register_Addon::injectAddonDomain($addon_name, $addon);
+
+		$addon->set_name($addon_name);
+		$addon->set_plugin_slug(self::$_settings[ $addon_name ]['plugin_slug']);
+		$addon->set_plugin_basename(self::$_settings[ $addon_name ]['plugin_basename']);
+		$addon->set_main_plugin_file(self::$_settings[ $addon_name ]['main_file_path']);
+		$addon->set_plugin_action_slug(self::$_settings[ $addon_name ]['plugin_action_slug']);
+		$addon->set_plugins_page_row(self::$_settings[ $addon_name ]['plugins_page_row']);
+		$addon->set_version(self::$_settings[ $addon_name ]['version']);
+		$addon->set_min_core_version(self::_effective_version(self::$_settings[ $addon_name ]['min_core_version']));
+		$addon->set_config_section(self::$_settings[ $addon_name ]['config_section']);
+		$addon->set_config_class(self::$_settings[ $addon_name ]['config_class']);
+		$addon->set_config_name(self::$_settings[ $addon_name ]['config_name']);
+		do_action(
+			'AHEE__EE_Register_Addon___load_and_init_addon_class',
+			$addon,
+			$addon_name,
+			self::$_settings
+		);
+		// unfortunately this can't be hooked in upon construction,
+		// because we don't have the plugin's mainfile path upon construction.
+		register_deactivation_hook($addon->get_main_plugin_file(), [$addon, 'deactivation']);
+		// call any additional admin_callback functions during load_admin_controller hook
+		if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
+			add_action(
+				'AHEE__EE_System__load_controllers__load_admin_controllers',
+				[$addon, self::$_settings[ $addon_name ]['admin_callback']]
+			);
+		}
+		return $addon;
+	}
+
+
+	/**
+	 * @param string   $addon_name
+	 * @param EE_Addon $addon
+	 * @since   4.10.13.p
+	 */
+	private static function injectAddonDomain(string $addon_name, EE_Addon $addon)
+	{
+		if ($addon instanceof RequiresDomainInterface && $addon->domain() === null) {
+			// using supplied Domain object
+			$domain = self::$_settings[ $addon_name ]['domain'] instanceof DomainInterface
+				? self::$_settings[ $addon_name ]['domain']
+				: null;
+			// or construct one using Domain FQCN
+			if ($domain === null && self::$_settings[ $addon_name ]['domain_fqcn'] !== '') {
+				$domain = self::$loader->getShared(
+					self::$_settings[ $addon_name ]['domain_fqcn'],
+					[
+						new EventEspresso\core\domain\values\FilePath(
+							self::$_settings[ $addon_name ]['main_file_path']
+						),
+						EventEspresso\core\domain\values\Version::fromString(
+							self::$_settings[ $addon_name ]['version']
+						),
+					]
+				);
+			}
+			if ($domain instanceof DomainInterface) {
+				$addon->setDomain($domain);
+			}
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 5.0.0.p
+	 */
+	public static function load_pue_update()
+	{
+	}
+
+
+	/**
+	 * Callback for EE_Brewing_Regular__messages_caf hook used to register message types.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 */
+	public static function register_message_types()
+	{
+		foreach (self::$_settings as $settings) {
+			if (! empty($settings['message_types'])) {
+				foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
+					EE_Register_Message_Type::register($message_type, $message_type_settings);
+				}
+			}
+		}
+	}
+
+
+	private static function registerLicense($addon_name)
+	{
+		$addon_settings = self::$_settings[ $addon_name ] ?? [];
+		if (empty($addon_settings)) {
+			return;
+		}
+		$license_data = isset($addon_settings['license']) ? (array) $addon_settings['license'] : [];
+		// copy known values from addon settings to license data if anything's missing
+		$license_data += [
+			'main_file_path'   => $addon_settings['main_file_path'] ?? '',
+			'min_core_version' => $addon_settings['min_core_version'] ?? '',
+			'plugin_id'        => 0, // no corresponding value in addon settings
+			'plugin_slug'      => $addon_settings['plugin_slug'] ?? '',
+			'version'          => $addon_settings['version'] ?? '',
+		];
+		EventEspresso\core\services\licensing\AddonLicense::register($addon_name, $license_data);
+	}
+
+
+	/**
+	 * This deregisters an addon that was previously registered with a specific addon_name.
+	 *
+	 * @param string $addon_name the name for the addon that was previously registered
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since    4.3.0
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		if (isset(self::$_settings[ $addon_name ]['class_name'])) {
+			try {
+				do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
+				$class_name = self::$_settings[ $addon_name ]['class_name'];
+				if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+					// setup DMS
+					EE_Register_Data_Migration_Scripts::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+					// register admin page
+					EE_Register_Admin_Page::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+					// add to list of modules to be registered
+					EE_Register_Module::deregister($addon_name);
+				}
+				if (
+					! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
+					|| ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+				) {
+					// add to list of shortcodes to be registered
+					EE_Register_Shortcode::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+					// if config_class present let's register config.
+					EE_Register_Config::deregister(self::$_settings[ $addon_name ]['config_class']);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+					// add to list of widgets to be registered
+					EE_Register_Widget::deregister($addon_name);
+				}
+				if (
+					! empty(self::$_settings[ $addon_name ]['model_paths'])
+					|| ! empty(self::$_settings[ $addon_name ]['class_paths'])
+				) {
+					// add to list of shortcodes to be registered
+					EE_Register_Model::deregister($addon_name);
+				}
+				if (
+					! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
+					|| ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+				) {
+					// add to list of shortcodes to be registered
+					EE_Register_Model_Extensions::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
+					foreach ((array) self::$_settings[ $addon_name ]['message_types'] as $message_type => $message_type_settings) {
+						EE_Register_Message_Type::deregister($message_type);
+					}
+				}
+				// deregister capabilities for addon
+				if (
+					! empty(self::$_settings[ $addon_name ]['capabilities'])
+					|| ! empty(self::$_settings[ $addon_name ]['capability_maps'])
+				) {
+					EE_Register_Capabilities::deregister($addon_name);
+				}
+				// deregister custom_post_types for addon
+				if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])) {
+					EE_Register_CPT::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+					EE_Register_Payment_Method::deregister($addon_name);
+				}
+				$addon = EE_Registry::instance()->getAddon($class_name);
+				if ($addon instanceof EE_Addon) {
+					remove_action(
+						'deactivate_' . $addon->get_main_plugin_file_basename(),
+						[$addon, 'deactivation']
+					);
+					remove_action(
+						'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+						[$addon, 'initialize_db_if_no_migrations_required']
+					);
+					// remove `after_registration` call
+					remove_action(
+						'AHEE__EE_System__load_espresso_addons__complete',
+						[$addon, 'after_registration'],
+						999
+					);
+				}
+				EE_Registry::instance()->removeAddon($class_name);
+				LoaderFactory::getLoader()->remove($class_name);
+			} catch (OutOfBoundsException $addon_not_yet_registered_exception) {
+				// the add-on was not yet registered in the registry,
+				// so RegistryContainer::__get() throws this exception.
+				// also no need to worry about this or log it,
+				// it's ok to deregister an add-on before its registered in the registry
+			} catch (Exception $e) {
+				new ExceptionLogger($e);
+			}
+			unset(self::$_settings[ $addon_name ]);
+			do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
+		}
+	}
+
+
+	public static function reset(): void
+	{
+		EE_Register_Addon::$_settings = [];
+	}
+
+
+	public static function resetAll(): void
+	{
+		// EE_Register_Addon::reset();
+		EE_Register_Admin_Page::reset();
+		EE_Register_Capabilities::reset();
+		EE_Register_Config::reset();
+		EE_Register_CPT::reset();
+		EE_Register_Data_Migration_Scripts::reset();
+		EE_Register_Message_Type::reset();
+		EE_Register_Messages_Shortcode_Library::reset();
+		EE_Register_Messages_Template_Pack::reset();
+		EE_Register_Messages_Template_Variations::reset();
+		EE_Register_Model::reset();
+		EE_Register_Model_Extensions::reset();
+		EE_Register_Module::reset();
+		EE_Register_Payment_Method::reset();
+		EE_Register_Personal_Data_Eraser::reset();
+		EE_Register_Personal_Data_Exporter::reset();
+		EE_Register_Privacy_Policy::reset();
+		EE_Register_Shortcode::reset();
+		EE_Register_Widget::reset();
+	}
 }

Spacing +110 added lines, -110 removed lines

@@ -75,15 +75,15 @@ 
         // offsets:    0 . 1 . 2 . 3 . 4
         $version_parts = explode('.', $min_core_version);
         // check they specified the micro version (after 2nd period)
-        if (! isset($version_parts[2])) {
+        if ( ! isset($version_parts[2])) {
             $version_parts[2] = '0';
         }
         // if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
         // soon we can assume that's 'rc', but this current version is 'alpha'
-        if (! isset($version_parts[3])) {
+        if ( ! isset($version_parts[3])) {
             $version_parts[3] = 'dev';
         }
-        if (! isset($version_parts[4])) {
+        if ( ! isset($version_parts[4])) {
             $version_parts[4] = '000';
         }
         return implode('.', $version_parts);
@@ -260,7 +260,7 @@ 
     public static function register(string $addon_name = '', array $setup_args = []): bool
     {
         // $addon_name = basename($addon_name);
-        if (! self::$loader instanceof LoaderInterface) {
+        if ( ! self::$loader instanceof LoaderInterface) {
             self::$loader = LoaderFactory::getLoader();
         }
         // make sure this was called in the right place!
@@ -300,7 +300,7 @@ 
         );
         // does this addon work with this version of core or WordPress ?
         // does this addon work with this version of core or WordPress ?
-        if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
+        if ( ! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
             return false;
         }
         // register namespaces
@@ -378,7 +378,7 @@ 
             );
         }
         // check that addon has not already been registered with that name
-        if (isset(self::$_settings[ $addon_name ]) && ! did_action('activate_plugin')) {
+        if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -410,7 +410,7 @@ 
         // check if classname is fully  qualified or is a legacy classname already prefixed with 'EE_'
         return strpos($class_name, '\\') || strpos($class_name, 'EE_') === 0
             ? $class_name
-            : 'EE_' . $class_name;
+            : 'EE_'.$class_name;
     }
 
 
@@ -580,9 +580,9 @@ 
         $incompatibility_message = '';
         // check whether this addon version is compatible with EE core
         if (
-            isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
+            isset(EE_Register_Addon::$_incompatible_addons[$addon_name])
             && ! self::_meets_min_core_version_requirement(
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+                EE_Register_Addon::$_incompatible_addons[$addon_name],
                 $addon_settings['version']
             )
         ) {
@@ -593,7 +593,7 @@ 
                 ),
                 $addon_name,
                 '<br />',
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+                EE_Register_Addon::$_incompatible_addons[$addon_name],
                 '<span style="font-weight: bold; color: #D54E21;">',
                 '</span><br />'
             );
@@ -625,7 +625,7 @@ 
                 '</span><br />'
             );
         }
-        if (! empty($incompatibility_message)) {
+        if ( ! empty($incompatibility_message)) {
             // remove 'activate' from the REQUEST
             // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
             /** @var RequestInterface $request */
@@ -636,8 +636,8 @@ 
                 EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
             }
             unset($_GET['activate'], $_REQUEST['activate']);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
+            if ( ! function_exists('deactivate_plugins')) {
+                require_once ABSPATH.'wp-admin/includes/plugin.php';
             }
             deactivate_plugins(plugin_basename($addon_settings['main_file_path']));
             // BAIL FROM THE ADDON REGISTRATION PROCESS
@@ -687,12 +687,12 @@ 
             // to find if THIS is the addon that was activated, just check if we have already registered it or not
             // (as the newly-activated addon wasn't around the first time addons were registered).
             if (
-                ! isset(self::$_settings[ $addon_name ])
-                || (isset(self::$_settings[ $addon_name ])
-                    && ! isset(self::$_settings[ $addon_name ]['class_name'])
+                ! isset(self::$_settings[$addon_name])
+                || (isset(self::$_settings[$addon_name])
+                    && ! isset(self::$_settings[$addon_name]['class_name'])
                 )
             ) {
-                self::$_settings[ $addon_name ] = $addon_settings;
+                self::$_settings[$addon_name] = $addon_settings;
                 $addon                          = self::_load_and_init_addon_class($addon_name);
                 $addon->set_activation_indicator_option();
                 // dont bother setting up the rest of the addon.
@@ -701,10 +701,10 @@ 
             return true;
         }
         // make sure addon settings are set correctly without overwriting anything existing
-        if (isset(self::$_settings[ $addon_name ])) {
-            self::$_settings[ $addon_name ] += $addon_settings;
+        if (isset(self::$_settings[$addon_name])) {
+            self::$_settings[$addon_name] += $addon_settings;
         } else {
-            self::$_settings[ $addon_name ] = $addon_settings;
+            self::$_settings[$addon_name] = $addon_settings;
         }
         return false;
     }
@@ -717,13 +717,13 @@ 
      */
     private static function _setup_autoloaders(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
             // setup autoloader for single file
-            EEH_Autoloader::instance()->register_autoloader(self::$_settings[ $addon_name ]['autoloader_paths']);
+            EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']);
         }
         // setup autoloaders for folders
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_folders'])) {
-            foreach ((array) self::$_settings[ $addon_name ]['autoloader_folders'] as $autoloader_folder) {
+        if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
+            foreach ((array) self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
                 EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
             }
         }
@@ -741,27 +741,27 @@ 
     {
         // register new models
         if (
-            ! empty(self::$_settings[ $addon_name ]['model_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_paths'])
+            ! empty(self::$_settings[$addon_name]['model_paths'])
+            || ! empty(self::$_settings[$addon_name]['class_paths'])
         ) {
             EE_Register_Model::register(
                 $addon_name,
                 [
-                    'model_paths' => self::$_settings[ $addon_name ]['model_paths'],
-                    'class_paths' => self::$_settings[ $addon_name ]['class_paths'],
+                    'model_paths' => self::$_settings[$addon_name]['model_paths'],
+                    'class_paths' => self::$_settings[$addon_name]['class_paths'],
                 ]
             );
         }
         // register model extensions
         if (
-            ! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+            ! empty(self::$_settings[$addon_name]['model_extension_paths'])
+            || ! empty(self::$_settings[$addon_name]['class_extension_paths'])
         ) {
             EE_Register_Model_Extensions::register(
                 $addon_name,
                 [
-                    'model_extension_paths' => self::$_settings[ $addon_name ]['model_extension_paths'],
-                    'class_extension_paths' => self::$_settings[ $addon_name ]['class_extension_paths'],
+                    'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'],
+                    'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'],
                 ]
             );
         }
@@ -776,10 +776,10 @@ 
     private static function _register_data_migration_scripts(string $addon_name)
     {
         // setup DMS
-        if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
             EE_Register_Data_Migration_Scripts::register(
                 $addon_name,
-                ['dms_paths' => self::$_settings[ $addon_name ]['dms_paths']]
+                ['dms_paths' => self::$_settings[$addon_name]['dms_paths']]
             );
         }
     }
@@ -793,12 +793,12 @@ 
     private static function _register_config(string $addon_name)
     {
         // if config_class is present let's register config.
-        if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+        if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
             EE_Register_Config::register(
-                self::$_settings[ $addon_name ]['config_class'],
+                self::$_settings[$addon_name]['config_class'],
                 [
-                    'config_section' => self::$_settings[ $addon_name ]['config_section'],
-                    'config_name'    => self::$_settings[ $addon_name ]['config_name'],
+                    'config_section' => self::$_settings[$addon_name]['config_section'],
+                    'config_name'    => self::$_settings[$addon_name]['config_name'],
                 ]
             );
         }
@@ -812,10 +812,10 @@ 
      */
     private static function _register_admin_pages(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+        if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
             EE_Register_Admin_Page::register(
                 $addon_name,
-                ['page_path' => self::$_settings[ $addon_name ]['admin_path']]
+                ['page_path' => self::$_settings[$addon_name]['admin_path']]
             );
         }
     }
@@ -828,10 +828,10 @@ 
      */
     private static function _register_modules(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
             EE_Register_Module::register(
                 $addon_name,
-                ['module_paths' => self::$_settings[ $addon_name ]['module_paths']]
+                ['module_paths' => self::$_settings[$addon_name]['module_paths']]
             );
         }
     }
@@ -845,14 +845,14 @@ 
     private static function _register_shortcodes(string $addon_name)
     {
         if (
-            ! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+            ! empty(self::$_settings[$addon_name]['shortcode_paths'])
+            || ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
         ) {
             EE_Register_Shortcode::register(
                 $addon_name,
                 [
-                    'shortcode_paths' => self::$_settings[ $addon_name ]['shortcode_paths'] ?? [],
-                    'shortcode_fqcns' => self::$_settings[ $addon_name ]['shortcode_fqcns'] ?? [],
+                    'shortcode_paths' => self::$_settings[$addon_name]['shortcode_paths'] ?? [],
+                    'shortcode_fqcns' => self::$_settings[$addon_name]['shortcode_fqcns'] ?? [],
                 ]
             );
         }
@@ -866,10 +866,10 @@ 
      */
     private static function _register_widgets(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
             EE_Register_Widget::register(
                 $addon_name,
-                ['widget_paths' => self::$_settings[ $addon_name ]['widget_paths']]
+                ['widget_paths' => self::$_settings[$addon_name]['widget_paths']]
             );
         }
     }
@@ -882,12 +882,12 @@ 
      */
     private static function _register_capabilities(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['capabilities'])) {
+        if ( ! empty(self::$_settings[$addon_name]['capabilities'])) {
             EE_Register_Capabilities::register(
                 $addon_name,
                 [
-                    'capabilities'    => self::$_settings[ $addon_name ]['capabilities'],
-                    'capability_maps' => self::$_settings[ $addon_name ]['capability_maps'],
+                    'capabilities'    => self::$_settings[$addon_name]['capabilities'],
+                    'capability_maps' => self::$_settings[$addon_name]['capability_maps'],
                 ]
             );
         }
@@ -900,7 +900,7 @@ 
      */
     private static function _register_message_types(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
+        if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
             add_action(
                 'EE_Brewing_Regular___messages_caf',
                 ['EE_Register_Addon', 'register_message_types']
@@ -917,15 +917,15 @@ 
     private static function _register_custom_post_types(string $addon_name)
     {
         if (
-            ! empty(self::$_settings[ $addon_name ]['custom_post_types'])
-            || ! empty(self::$_settings[ $addon_name ]['custom_taxonomies'])
+            ! empty(self::$_settings[$addon_name]['custom_post_types'])
+            || ! empty(self::$_settings[$addon_name]['custom_taxonomies'])
         ) {
             EE_Register_CPT::register(
                 $addon_name,
                 [
-                    'cpts'          => self::$_settings[ $addon_name ]['custom_post_types'],
-                    'cts'           => self::$_settings[ $addon_name ]['custom_taxonomies'],
-                    'default_terms' => self::$_settings[ $addon_name ]['default_terms'],
+                    'cpts'          => self::$_settings[$addon_name]['custom_post_types'],
+                    'cts'           => self::$_settings[$addon_name]['custom_taxonomies'],
+                    'default_terms' => self::$_settings[$addon_name]['default_terms'],
                 ]
             );
         }
@@ -943,10 +943,10 @@ 
      */
     private static function _register_payment_methods(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
             EE_Register_Payment_Method::register(
                 $addon_name,
-                ['payment_method_paths' => self::$_settings[ $addon_name ]['payment_method_paths']]
+                ['payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths']]
             );
         }
     }
@@ -962,10 +962,10 @@ 
      */
     private static function registerPrivacyPolicies(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['privacy_policies'])) {
+        if ( ! empty(self::$_settings[$addon_name]['privacy_policies'])) {
             EE_Register_Privacy_Policy::register(
                 $addon_name,
-                self::$_settings[ $addon_name ]['privacy_policies']
+                self::$_settings[$addon_name]['privacy_policies']
             );
         }
     }
@@ -977,10 +977,10 @@ 
      */
     private static function registerPersonalDataExporters(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['personal_data_exporters'])) {
+        if ( ! empty(self::$_settings[$addon_name]['personal_data_exporters'])) {
             EE_Register_Personal_Data_Eraser::register(
                 $addon_name,
-                self::$_settings[ $addon_name ]['personal_data_exporters']
+                self::$_settings[$addon_name]['personal_data_exporters']
             );
         }
     }
@@ -992,10 +992,10 @@ 
      */
     private static function registerPersonalDataErasers(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['personal_data_erasers'])) {
+        if ( ! empty(self::$_settings[$addon_name]['personal_data_erasers'])) {
             EE_Register_Personal_Data_Eraser::register(
                 $addon_name,
-                self::$_settings[ $addon_name ]['personal_data_erasers']
+                self::$_settings[$addon_name]['personal_data_erasers']
             );
         }
     }
@@ -1013,14 +1013,14 @@ 
     private static function _load_and_init_addon_class(string $addon_name): EE_Addon
     {
         $addon = self::$loader->getShared(
-            self::$_settings[ $addon_name ]['class_name'],
+            self::$_settings[$addon_name]['class_name'],
             ['EE_Registry::create(addon)' => true]
         );
-        if (! $addon instanceof EE_Addon) {
+        if ( ! $addon instanceof EE_Addon) {
             throw new DomainException(
                 sprintf(
                     esc_html__('The "%1$s" EE_Addon class failed to instantiate!', 'event_espresso'),
-                    self::$_settings[ $addon_name ]['class_name']
+                    self::$_settings[$addon_name]['class_name']
                 )
             );
         }
@@ -1032,16 +1032,16 @@ 
         EE_Register_Addon::injectAddonDomain($addon_name, $addon);
 
         $addon->set_name($addon_name);
-        $addon->set_plugin_slug(self::$_settings[ $addon_name ]['plugin_slug']);
-        $addon->set_plugin_basename(self::$_settings[ $addon_name ]['plugin_basename']);
-        $addon->set_main_plugin_file(self::$_settings[ $addon_name ]['main_file_path']);
-        $addon->set_plugin_action_slug(self::$_settings[ $addon_name ]['plugin_action_slug']);
-        $addon->set_plugins_page_row(self::$_settings[ $addon_name ]['plugins_page_row']);
-        $addon->set_version(self::$_settings[ $addon_name ]['version']);
-        $addon->set_min_core_version(self::_effective_version(self::$_settings[ $addon_name ]['min_core_version']));
-        $addon->set_config_section(self::$_settings[ $addon_name ]['config_section']);
-        $addon->set_config_class(self::$_settings[ $addon_name ]['config_class']);
-        $addon->set_config_name(self::$_settings[ $addon_name ]['config_name']);
+        $addon->set_plugin_slug(self::$_settings[$addon_name]['plugin_slug']);
+        $addon->set_plugin_basename(self::$_settings[$addon_name]['plugin_basename']);
+        $addon->set_main_plugin_file(self::$_settings[$addon_name]['main_file_path']);
+        $addon->set_plugin_action_slug(self::$_settings[$addon_name]['plugin_action_slug']);
+        $addon->set_plugins_page_row(self::$_settings[$addon_name]['plugins_page_row']);
+        $addon->set_version(self::$_settings[$addon_name]['version']);
+        $addon->set_min_core_version(self::_effective_version(self::$_settings[$addon_name]['min_core_version']));
+        $addon->set_config_section(self::$_settings[$addon_name]['config_section']);
+        $addon->set_config_class(self::$_settings[$addon_name]['config_class']);
+        $addon->set_config_name(self::$_settings[$addon_name]['config_name']);
         do_action(
             'AHEE__EE_Register_Addon___load_and_init_addon_class',
             $addon,
@@ -1052,10 +1052,10 @@ 
         // because we don't have the plugin's mainfile path upon construction.
         register_deactivation_hook($addon->get_main_plugin_file(), [$addon, 'deactivation']);
         // call any additional admin_callback functions during load_admin_controller hook
-        if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
+        if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) {
             add_action(
                 'AHEE__EE_System__load_controllers__load_admin_controllers',
-                [$addon, self::$_settings[ $addon_name ]['admin_callback']]
+                [$addon, self::$_settings[$addon_name]['admin_callback']]
             );
         }
         return $addon;
@@ -1071,19 +1071,19 @@ 
     {
         if ($addon instanceof RequiresDomainInterface && $addon->domain() === null) {
             // using supplied Domain object
-            $domain = self::$_settings[ $addon_name ]['domain'] instanceof DomainInterface
-                ? self::$_settings[ $addon_name ]['domain']
+            $domain = self::$_settings[$addon_name]['domain'] instanceof DomainInterface
+                ? self::$_settings[$addon_name]['domain']
                 : null;
             // or construct one using Domain FQCN
-            if ($domain === null && self::$_settings[ $addon_name ]['domain_fqcn'] !== '') {
+            if ($domain === null && self::$_settings[$addon_name]['domain_fqcn'] !== '') {
                 $domain = self::$loader->getShared(
-                    self::$_settings[ $addon_name ]['domain_fqcn'],
+                    self::$_settings[$addon_name]['domain_fqcn'],
                     [
                         new EventEspresso\core\domain\values\FilePath(
-                            self::$_settings[ $addon_name ]['main_file_path']
+                            self::$_settings[$addon_name]['main_file_path']
                         ),
                         EventEspresso\core\domain\values\Version::fromString(
-                            self::$_settings[ $addon_name ]['version']
+                            self::$_settings[$addon_name]['version']
                         ),
                     ]
                 );
@@ -1114,7 +1114,7 @@ 
     public static function register_message_types()
     {
         foreach (self::$_settings as $settings) {
-            if (! empty($settings['message_types'])) {
+            if ( ! empty($settings['message_types'])) {
                 foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
                     EE_Register_Message_Type::register($message_type, $message_type_settings);
                 }
@@ -1125,7 +1125,7 @@ 
 
     private static function registerLicense($addon_name)
     {
-        $addon_settings = self::$_settings[ $addon_name ] ?? [];
+        $addon_settings = self::$_settings[$addon_name] ?? [];
         if (empty($addon_settings)) {
             return;
         }
@@ -1154,74 +1154,74 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        if (isset(self::$_settings[ $addon_name ]['class_name'])) {
+        if (isset(self::$_settings[$addon_name]['class_name'])) {
             try {
                 do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
-                $class_name = self::$_settings[ $addon_name ]['class_name'];
-                if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+                $class_name = self::$_settings[$addon_name]['class_name'];
+                if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
                     // setup DMS
                     EE_Register_Data_Migration_Scripts::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+                if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
                     // register admin page
                     EE_Register_Admin_Page::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
                     // add to list of modules to be registered
                     EE_Register_Module::deregister($addon_name);
                 }
                 if (
-                    ! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+                    ! empty(self::$_settings[$addon_name]['shortcode_paths'])
+                    || ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
                 ) {
                     // add to list of shortcodes to be registered
                     EE_Register_Shortcode::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+                if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
                     // if config_class present let's register config.
-                    EE_Register_Config::deregister(self::$_settings[ $addon_name ]['config_class']);
+                    EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
                     // add to list of widgets to be registered
                     EE_Register_Widget::deregister($addon_name);
                 }
                 if (
-                    ! empty(self::$_settings[ $addon_name ]['model_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['class_paths'])
+                    ! empty(self::$_settings[$addon_name]['model_paths'])
+                    || ! empty(self::$_settings[$addon_name]['class_paths'])
                 ) {
                     // add to list of shortcodes to be registered
                     EE_Register_Model::deregister($addon_name);
                 }
                 if (
-                    ! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+                    ! empty(self::$_settings[$addon_name]['model_extension_paths'])
+                    || ! empty(self::$_settings[$addon_name]['class_extension_paths'])
                 ) {
                     // add to list of shortcodes to be registered
                     EE_Register_Model_Extensions::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
-                    foreach ((array) self::$_settings[ $addon_name ]['message_types'] as $message_type => $message_type_settings) {
+                if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
+                    foreach ((array) self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) {
                         EE_Register_Message_Type::deregister($message_type);
                     }
                 }
                 // deregister capabilities for addon
                 if (
-                    ! empty(self::$_settings[ $addon_name ]['capabilities'])
-                    || ! empty(self::$_settings[ $addon_name ]['capability_maps'])
+                    ! empty(self::$_settings[$addon_name]['capabilities'])
+                    || ! empty(self::$_settings[$addon_name]['capability_maps'])
                 ) {
                     EE_Register_Capabilities::deregister($addon_name);
                 }
                 // deregister custom_post_types for addon
-                if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])) {
+                if ( ! empty(self::$_settings[$addon_name]['custom_post_types'])) {
                     EE_Register_CPT::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
                     EE_Register_Payment_Method::deregister($addon_name);
                 }
                 $addon = EE_Registry::instance()->getAddon($class_name);
                 if ($addon instanceof EE_Addon) {
                     remove_action(
-                        'deactivate_' . $addon->get_main_plugin_file_basename(),
+                        'deactivate_'.$addon->get_main_plugin_file_basename(),
                         [$addon, 'deactivation']
                     );
                     remove_action(
@@ -1245,7 +1245,7 @@ 
             } catch (Exception $e) {
                 new ExceptionLogger($e);
             }
-            unset(self::$_settings[ $addon_name ]);
+            unset(self::$_settings[$addon_name]);
             do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
         }
     }

core/libraries/shortcodes/EE_Line_Item_Shortcodes.lib.php

Indentation +51 added lines, -51 removed lines

@@ -16,65 +16,65 @@
  */
 class EE_Line_Item_Shortcodes extends EE_Shortcodes
 {
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Line Item Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to line items', 'event_espresso');
-        $this->_shortcodes = array(
-            '[LINE_ITEM_NAME]' => esc_html__('Outputs the line item name.', 'event_espresso'),
-            '[LINE_ITEM_DESCRIPTION]' => esc_html__('Outputs a the description for the line item.', 'event_espresso'),
-            '[LINE_ITEM_QUANTITY]' => esc_html__('Outputs the quantity for this line item.', 'event_espresso'),
-            '[LINE_ITEM_AMOUNT]' => esc_html__(
-                'This will either output the unit price for a line item if its not a percent, or the percent of the line item (if it is percent).',
-                'event_espresso'
-            ),
-            '[LINE_ITEM_TOTAL]' => esc_html__('This outputs the line item total.', 'event_espresso'),
-            '[LINE_ITEM_TAXABLE_*]' => esc_html__(
-                'This attribute type shortcode allows users to indicate what to output if a line item is taxable or not.  One can use the key "symbol=" with the shortcode to indicate what they\'d like to represent a taxable line item.  So doing something like <code>[LINE_ITEM_TAXABLE_* symbol="*"]</code> means that when the line item is parsed, if it\'s taxable the "*" symbol will be returned.  The default symbol if no attribute is included is the "*" symbol.',
-                'event_espresso'
-            ),
-        );
-    }
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Line Item Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to line items', 'event_espresso');
+		$this->_shortcodes = array(
+			'[LINE_ITEM_NAME]' => esc_html__('Outputs the line item name.', 'event_espresso'),
+			'[LINE_ITEM_DESCRIPTION]' => esc_html__('Outputs a the description for the line item.', 'event_espresso'),
+			'[LINE_ITEM_QUANTITY]' => esc_html__('Outputs the quantity for this line item.', 'event_espresso'),
+			'[LINE_ITEM_AMOUNT]' => esc_html__(
+				'This will either output the unit price for a line item if its not a percent, or the percent of the line item (if it is percent).',
+				'event_espresso'
+			),
+			'[LINE_ITEM_TOTAL]' => esc_html__('This outputs the line item total.', 'event_espresso'),
+			'[LINE_ITEM_TAXABLE_*]' => esc_html__(
+				'This attribute type shortcode allows users to indicate what to output if a line item is taxable or not.  One can use the key "symbol=" with the shortcode to indicate what they\'d like to represent a taxable line item.  So doing something like <code>[LINE_ITEM_TAXABLE_* symbol="*"]</code> means that when the line item is parsed, if it\'s taxable the "*" symbol will be returned.  The default symbol if no attribute is included is the "*" symbol.',
+				'event_espresso'
+			),
+		);
+	}
 
 
-    /**
-     * @param string $shortcode
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    protected function _parser($shortcode)
-    {
-        // ensure that the incoming object IS a line item.  If it isn't then bail early.
-        if (! $this->_data instanceof EE_Line_Item) {
-            return '';
-        }
+	/**
+	 * @param string $shortcode
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	protected function _parser($shortcode)
+	{
+		// ensure that the incoming object IS a line item.  If it isn't then bail early.
+		if (! $this->_data instanceof EE_Line_Item) {
+			return '';
+		}
 
-        $line_item = $this->_data;
+		$line_item = $this->_data;
 
-        switch ($shortcode) {
-            case '[LINE_ITEM_NAME]':
-                return $line_item->name();
+		switch ($shortcode) {
+			case '[LINE_ITEM_NAME]':
+				return $line_item->name();
 
-            case '[LINE_ITEM_DESCRIPTION]':
-                return $line_item->desc();
+			case '[LINE_ITEM_DESCRIPTION]':
+				return $line_item->desc();
 
-            case '[LINE_ITEM_QUANTITY]':
-                return $line_item->quantity();
+			case '[LINE_ITEM_QUANTITY]':
+				return $line_item->quantity();
 
-            case '[LINE_ITEM_AMOUNT]':
-                return $line_item->is_percent() ? $line_item->percent() . '%' : $line_item->unit_price_no_code();
+			case '[LINE_ITEM_AMOUNT]':
+				return $line_item->is_percent() ? $line_item->percent() . '%' : $line_item->unit_price_no_code();
 
-            case '[LINE_ITEM_TOTAL]':
-                return $line_item->total_no_code();
-        }
+			case '[LINE_ITEM_TOTAL]':
+				return $line_item->total_no_code();
+		}
 
-        if (strpos($shortcode, '[LINE_ITEM_TAXABLE_*') !== false) {
-            $attrs = $this->_get_shortcode_attrs($shortcode);
-            if ($line_item->is_taxable()) {
-                return ! empty($attrs['symbol']) ? $attrs['symbol'] : '*';
-            }
-        }
+		if (strpos($shortcode, '[LINE_ITEM_TAXABLE_*') !== false) {
+			$attrs = $this->_get_shortcode_attrs($shortcode);
+			if ($line_item->is_taxable()) {
+				return ! empty($attrs['symbol']) ? $attrs['symbol'] : '*';
+			}
+		}
 
-        return '';
-    }
+		return '';
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -45,7 +45,7 @@ 
     protected function _parser($shortcode)
     {
         // ensure that the incoming object IS a line item.  If it isn't then bail early.
-        if (! $this->_data instanceof EE_Line_Item) {
+        if ( ! $this->_data instanceof EE_Line_Item) {
             return '';
         }
 
@@ -62,7 +62,7 @@ 
                 return $line_item->quantity();
 
             case '[LINE_ITEM_AMOUNT]':
-                return $line_item->is_percent() ? $line_item->percent() . '%' : $line_item->unit_price_no_code();
+                return $line_item->is_percent() ? $line_item->percent().'%' : $line_item->unit_price_no_code();
 
             case '[LINE_ITEM_TOTAL]':
                 return $line_item->total_no_code();

core/libraries/shortcodes/EE_Event_Meta_Shortcodes.lib.php

Indentation +30 added lines, -30 removed lines

@@ -30,43 +30,43 @@
  */
 class EE_Event_Meta_Shortcodes extends EE_Shortcodes
 {
-    public function __construct()
-    {
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		parent::__construct();
+	}
 
 
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Event Meta Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes related to Event Meta data', 'event_espresso');
-        $this->_shortcodes = array();
-    }
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Event Meta Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes related to Event Meta data', 'event_espresso');
+		$this->_shortcodes = array();
+	}
 
 
-    /**
-     * We have to overload the parent parser method because of the dynamic nature of custom event meta
-     *
-     * @param  string      $shortcode Incoming shortcode
-     * @param array|object $data      incoming data object/array
-     * @return string            parsed code.
-     */
-    public function parser(string $shortcode, $data, $extra_data = []): string
-    {
+	/**
+	 * We have to overload the parent parser method because of the dynamic nature of custom event meta
+	 *
+	 * @param  string      $shortcode Incoming shortcode
+	 * @param array|object $data      incoming data object/array
+	 * @return string            parsed code.
+	 */
+	public function parser(string $shortcode, $data, $extra_data = []): string
+	{
 
-        // all shortcodes will be checked in the post_meta table (assuming the shortcode matches the post_meta key);
-        if (empty($this->_data['ID'])) {
-            return '';
-        } // need the event id to do anything!
+		// all shortcodes will be checked in the post_meta table (assuming the shortcode matches the post_meta key);
+		if (empty($this->_data['ID'])) {
+			return '';
+		} // need the event id to do anything!
 
-        $meta = get_post_meta($this->_data['ID'], $shortcode, true);
+		$meta = get_post_meta($this->_data['ID'], $shortcode, true);
 
-        return ! empty($meta) ? $meta : '';
-    }
+		return ! empty($meta) ? $meta : '';
+	}
 
 
-    protected function _parser($shortcode)
-    {
-        return '';
-    }
+	protected function _parser($shortcode)
+	{
+		return '';
+	}
 }