eventespresso / event-espresso-core

core/db_models/EEM_Datetime.model.php

Spacing +20 added lines, -20 removed lines

@@ -121,7 +121,7 @@ 
                 ),
             ],
         ];
-        $this->_model_relations        = [
+        $this->_model_relations = [
             'Ticket'          => new EE_HABTM_Relation('Datetime_Ticket'),
             'Event'           => new EE_Belongs_To_Relation(),
             'Checkin'         => new EE_Has_Many_Relation(),
@@ -131,19 +131,19 @@ 
         $this->model_chain_to_password = $path_to_event_model;
         $this->_model_chain_to_wp_user = $path_to_event_model;
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_read] =
             new EE_Restriction_Generator_Event_Related_Public(
                 $path_to_event_model
             );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] =
             new EE_Restriction_Generator_Event_Related_Protected(
                 $path_to_event_model
             );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] =
             new EE_Restriction_Generator_Event_Related_Protected(
                 $path_to_event_model
             );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] =
             new EE_Restriction_Generator_Event_Related_Protected(
                 $path_to_event_model,
                 EEM_Base::caps_edit
@@ -185,7 +185,7 @@ 
          * @param int $end_data Unix timestamp representing now + 30 days in seconds.
          * @return int Unix timestamp
          */
-        $end_date       = apply_filters(
+        $end_date = apply_filters(
             'FHEE__EEM_Datetime__create_new_blank_datetime__end_date',
             $this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS
         );
@@ -251,10 +251,10 @@ 
      */
     private function validateStartAndEndTimeForBlankDate(array $start_time, array $end_time)
     {
-        if (! is_array($start_time)) {
+        if ( ! is_array($start_time)) {
             throw new InvalidDataTypeException('start_time', $start_time, 'array');
         }
-        if (! is_array($end_time)) {
+        if ( ! is_array($end_time)) {
             throw new InvalidDataTypeException('end_time', $end_time, 'array');
         }
         if (count($start_time) !== 2) {
@@ -289,7 +289,7 @@ 
      */
     public function get_all_event_dates($EVT_ID = 0)
     {
-        if (! $EVT_ID) { // on add_new_event event_id gets set to 0
+        if ( ! $EVT_ID) { // on add_new_event event_id gets set to 0
             return $this->create_new_blank_datetime();
         }
         $results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
@@ -426,7 +426,7 @@ 
             $query_params,
             EEM_Base::default_where_conditions_this_only
         );
-        $query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
+        $query_params = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
         return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
     }
 
@@ -587,14 +587,14 @@ 
         $query_params['group_by'] = ['dtt_year', 'dtt_month'];
         $query_params             = $this->addOrderByQueryParams($query_params, 'DTT_EVT_start', 'DESC');
 
-        $query_interval    = EEH_DTT_Helper::get_sql_query_interval_for_offset(
+        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset(
             $this->get_timezone(),
             'DTT_EVT_start'
         );
         $columns_to_select = [
-            'dtt_year'      => ['YEAR(' . $query_interval . ')', '%s'],
-            'dtt_month'     => ['MONTHNAME(' . $query_interval . ')', '%s'],
-            'dtt_month_num' => ['MONTH(' . $query_interval . ')', '%s'],
+            'dtt_year'      => ['YEAR('.$query_interval.')', '%s'],
+            'dtt_month'     => ['MONTHNAME('.$query_interval.')', '%s'],
+            'dtt_month_num' => ['MONTH('.$query_interval.')', '%s'],
         ];
         return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
     }
@@ -676,17 +676,17 @@ 
                 ['DTT_EVT_end' => ['<', time()]]
             ),
         ];
-        if (! empty($stati_to_include)) {
+        if ( ! empty($stati_to_include)) {
             foreach (array_keys($status_query_args) as $status) {
-                if (! in_array($status, $stati_to_include, true)) {
-                    unset($status_query_args[ $status ]);
+                if ( ! in_array($status, $stati_to_include, true)) {
+                    unset($status_query_args[$status]);
                 }
             }
         }
         // loop through and query counts for each stati.
         $status_query_results = [];
         foreach ($status_query_args as $status => $status_where_conditions) {
-            $status_query_results[ $status ] = EEM_Datetime::count(
+            $status_query_results[$status] = EEM_Datetime::count(
                 [$status_where_conditions],
                 'DTT_ID',
                 true
@@ -707,7 +707,7 @@ 
     public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = [])
     {
         $count = $this->get_datetime_counts_by_status([$status], $query_params);
-        return ! empty($count[ $status ]) ? $count[ $status ] : 0;
+        return ! empty($count[$status]) ? $count[$status] : 0;
     }
 
 
@@ -806,7 +806,7 @@ 
      */
     private function addExpiredWhereParams(array $where_params, bool $include_expired = true)
     {
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $where_params['DTT_EVT_end'] = ['>=', current_time('mysql', true)];
         }
         return $where_params;

Indentation +839 added lines, -839 removed lines

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

core/services/routing/Route.php

Spacing +2 added lines, -2 removed lines

@@ -251,7 +251,7 @@ 
     private function loadDataNode()
     {
         $data_node_fqcn = $this->dataNodeClass();
-        if (! empty($data_node_fqcn)) {
+        if ( ! empty($data_node_fqcn)) {
             $data_node = $this->loader->getShared($data_node_fqcn);
             $this->setDataNode($data_node);
         }
@@ -279,7 +279,7 @@ 
      */
     private function verifyIsHandled($handled)
     {
-        if (! is_bool($handled)) {
+        if ( ! is_bool($handled)) {
             throw new DomainException(
                 esc_html__(
                     'Route::requestHandler() must return a boolean to indicate whether the request has been handled or not.',

Indentation +267 added lines, -267 removed lines

@@ -28,271 +28,271 @@
  */
 abstract class Route implements RouteInterface, RequiresCapCheckInterface
 {
-    /**
-     * @var AssetManagerInterface $asset_manager
-     */
-    protected $asset_manager;
-
-    /**
-     * @var EE_Dependency_Map $dependency_map
-     */
-    protected $dependency_map;
-
-    /**
-     * @var JsonDataNode $data_node
-     */
-    protected $data_node;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * @var RouteMatchSpecificationInterface $specification
-     */
-    protected $specification;
-
-    /**
-     * @var boolean $handled
-     */
-    private $handled = false;
-
-    /**
-     * @var array $default_dependencies
-     */
-    protected static $default_dependencies = [
-        'EE_Dependency_Map'                           => EE_Dependency_Map::load_from_cache,
-        'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
-        'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-    ];
-
-    /**
-     * @var array $full_dependencies
-     */
-    protected static $full_dependencies = [
-        'EE_Dependency_Map'                             => EE_Dependency_Map::load_from_cache,
-        'EventEspresso\core\services\loaders\Loader'    => EE_Dependency_Map::load_from_cache,
-        'EventEspresso\core\services\request\Request'   => EE_Dependency_Map::load_from_cache,
-        'EventEspresso\core\services\json\JsonDataNode' => EE_Dependency_Map::load_from_cache,
-        RouteMatchSpecificationInterface::class         => EE_Dependency_Map::load_from_cache,
-    ];
-
-
-    /**
-     * Route constructor.
-     *
-     * @param EE_Dependency_Map                     $dependency_map
-     * @param LoaderInterface                       $loader
-     * @param RequestInterface                      $request
-     * @param JsonDataNode|null                     $data_node
-     * @param RouteMatchSpecificationInterface|null $specification
-     */
-    public function __construct(
-        EE_Dependency_Map $dependency_map,
-        LoaderInterface $loader,
-        RequestInterface $request,
-        JsonDataNode $data_node = null,
-        RouteMatchSpecificationInterface $specification = null
-    ) {
-        $this->dependency_map = $dependency_map;
-        $this->data_node      = $data_node;
-        $this->loader         = $loader;
-        $this->request        = $request;
-        $this->setSpecification($specification);
-    }
-
-
-    /**
-     * @return void
-     */
-    abstract protected function registerDependencies();
-
-
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     */
-    abstract protected function requestHandler(): bool;
-
-
-    /**
-     * called just before matchesCurrentRequest()
-     * and allows Route to perform any setup required such as calling setSpecification()
-     *
-     * @return void
-     */
-    public function initialize()
-    {
-        // do nothing by default
-    }
-
-
-    /**
-     * returns true if the current request matches this route
-     * child classes can override and use Request directly to match route with request
-     * or supply a RouteMatchSpecification class and just use the below
-     *
-     * @return bool
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        return $this->specification instanceof RouteMatchSpecificationInterface
-               && $this->specification->isMatchingRoute();
-    }
-
-
-    /**
-     * returns the FQCN for this route's JsonDataNode
-     *
-     * @return string
-     */
-    protected function dataNodeClass(): string
-    {
-        return '';
-    }
-
-
-    public function getCapCheck()
-    {
-        return new PublicCapabilities('', 'access Event Espresso route');
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function getDefaultDependencies(): array
-    {
-        return self::$default_dependencies;
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function getFullDependencies(): array
-    {
-        return self::$full_dependencies;
-    }
-
-
-    /**
-     * @param JsonDataNode|null $data_node
-     */
-    protected function setDataNode(JsonDataNode $data_node = null)
-    {
-        $this->data_node = $data_node;
-    }
-
-
-    /**
-     * @param RouteMatchSpecificationInterface|null $specification
-     */
-    protected function setSpecification(RouteMatchSpecificationInterface $specification = null)
-    {
-        $this->specification = $specification;
-    }
-
-
-    /**
-     * @return JsonDataNode
-     */
-    public function dataNode(): ?JsonDataNode
-    {
-        return $this->data_node;
-    }
-
-
-    /**
-     * runs route requestHandler() if
-     *      - route has not previously been handled
-     *      - route specification matches for current request
-     * sets route handled property based on results returned by requestHandler()
-     *
-     * @return bool
-     */
-    public function handleRequest(): bool
-    {
-        if ($this->isNotHandled()) {
-            $this->initialize();
-            if ($this->matchesCurrentRequest()) {
-                do_action('AHEE__EventEspresso_core_domain_entities_routes_handlers_Route__handleRequest', $this);
-                $this->registerDependencies();
-                $this->loadDataNode();
-                $this->verifyIsHandled($this->requestHandler());
-            }
-        }
-        return $this->handled;
-    }
-
-
-    /**
-     * @return bool
-     */
-    final public function isHandled(): bool
-    {
-        return $this->handled;
-    }
-
-
-    /**
-     * @return bool
-     */
-    final public function isNotHandled(): bool
-    {
-        return ! $this->handled;
-    }
-
-
-    /**
-     * @return void
-     */
-    private function loadDataNode()
-    {
-        $data_node_fqcn = $this->dataNodeClass();
-        if (! empty($data_node_fqcn)) {
-            $data_node = $this->loader->getShared($data_node_fqcn);
-            $this->setDataNode($data_node);
-        }
-    }
-
-
-    /**
-     * @param string $domain_fqcn
-     */
-    public function initializeBaristaForDomain(string $domain_fqcn)
-    {
-        if (apply_filters('FHEE__load_Barista', true)) {
-            /** @var BaristaFactory $factory */
-            $factory = $this->loader->getShared(BaristaFactory::class);
-            $barista = $factory->createFromDomainClass($domain_fqcn);
-            if ($barista instanceof BaristaInterface) {
-                $barista->initialize();
-            }
-        }
-    }
-
-
-    /**
-     * @var bool
-     */
-    private function verifyIsHandled($handled)
-    {
-        if (! is_bool($handled)) {
-            throw new DomainException(
-                esc_html__(
-                    'Route::requestHandler() must return a boolean to indicate whether the request has been handled or not.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->handled = filter_var($handled, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * @var AssetManagerInterface $asset_manager
+	 */
+	protected $asset_manager;
+
+	/**
+	 * @var EE_Dependency_Map $dependency_map
+	 */
+	protected $dependency_map;
+
+	/**
+	 * @var JsonDataNode $data_node
+	 */
+	protected $data_node;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * @var RouteMatchSpecificationInterface $specification
+	 */
+	protected $specification;
+
+	/**
+	 * @var boolean $handled
+	 */
+	private $handled = false;
+
+	/**
+	 * @var array $default_dependencies
+	 */
+	protected static $default_dependencies = [
+		'EE_Dependency_Map'                           => EE_Dependency_Map::load_from_cache,
+		'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
+		'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+	];
+
+	/**
+	 * @var array $full_dependencies
+	 */
+	protected static $full_dependencies = [
+		'EE_Dependency_Map'                             => EE_Dependency_Map::load_from_cache,
+		'EventEspresso\core\services\loaders\Loader'    => EE_Dependency_Map::load_from_cache,
+		'EventEspresso\core\services\request\Request'   => EE_Dependency_Map::load_from_cache,
+		'EventEspresso\core\services\json\JsonDataNode' => EE_Dependency_Map::load_from_cache,
+		RouteMatchSpecificationInterface::class         => EE_Dependency_Map::load_from_cache,
+	];
+
+
+	/**
+	 * Route constructor.
+	 *
+	 * @param EE_Dependency_Map                     $dependency_map
+	 * @param LoaderInterface                       $loader
+	 * @param RequestInterface                      $request
+	 * @param JsonDataNode|null                     $data_node
+	 * @param RouteMatchSpecificationInterface|null $specification
+	 */
+	public function __construct(
+		EE_Dependency_Map $dependency_map,
+		LoaderInterface $loader,
+		RequestInterface $request,
+		JsonDataNode $data_node = null,
+		RouteMatchSpecificationInterface $specification = null
+	) {
+		$this->dependency_map = $dependency_map;
+		$this->data_node      = $data_node;
+		$this->loader         = $loader;
+		$this->request        = $request;
+		$this->setSpecification($specification);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	abstract protected function registerDependencies();
+
+
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 */
+	abstract protected function requestHandler(): bool;
+
+
+	/**
+	 * called just before matchesCurrentRequest()
+	 * and allows Route to perform any setup required such as calling setSpecification()
+	 *
+	 * @return void
+	 */
+	public function initialize()
+	{
+		// do nothing by default
+	}
+
+
+	/**
+	 * returns true if the current request matches this route
+	 * child classes can override and use Request directly to match route with request
+	 * or supply a RouteMatchSpecification class and just use the below
+	 *
+	 * @return bool
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		return $this->specification instanceof RouteMatchSpecificationInterface
+			   && $this->specification->isMatchingRoute();
+	}
+
+
+	/**
+	 * returns the FQCN for this route's JsonDataNode
+	 *
+	 * @return string
+	 */
+	protected function dataNodeClass(): string
+	{
+		return '';
+	}
+
+
+	public function getCapCheck()
+	{
+		return new PublicCapabilities('', 'access Event Espresso route');
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function getDefaultDependencies(): array
+	{
+		return self::$default_dependencies;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function getFullDependencies(): array
+	{
+		return self::$full_dependencies;
+	}
+
+
+	/**
+	 * @param JsonDataNode|null $data_node
+	 */
+	protected function setDataNode(JsonDataNode $data_node = null)
+	{
+		$this->data_node = $data_node;
+	}
+
+
+	/**
+	 * @param RouteMatchSpecificationInterface|null $specification
+	 */
+	protected function setSpecification(RouteMatchSpecificationInterface $specification = null)
+	{
+		$this->specification = $specification;
+	}
+
+
+	/**
+	 * @return JsonDataNode
+	 */
+	public function dataNode(): ?JsonDataNode
+	{
+		return $this->data_node;
+	}
+
+
+	/**
+	 * runs route requestHandler() if
+	 *      - route has not previously been handled
+	 *      - route specification matches for current request
+	 * sets route handled property based on results returned by requestHandler()
+	 *
+	 * @return bool
+	 */
+	public function handleRequest(): bool
+	{
+		if ($this->isNotHandled()) {
+			$this->initialize();
+			if ($this->matchesCurrentRequest()) {
+				do_action('AHEE__EventEspresso_core_domain_entities_routes_handlers_Route__handleRequest', $this);
+				$this->registerDependencies();
+				$this->loadDataNode();
+				$this->verifyIsHandled($this->requestHandler());
+			}
+		}
+		return $this->handled;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	final public function isHandled(): bool
+	{
+		return $this->handled;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	final public function isNotHandled(): bool
+	{
+		return ! $this->handled;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function loadDataNode()
+	{
+		$data_node_fqcn = $this->dataNodeClass();
+		if (! empty($data_node_fqcn)) {
+			$data_node = $this->loader->getShared($data_node_fqcn);
+			$this->setDataNode($data_node);
+		}
+	}
+
+
+	/**
+	 * @param string $domain_fqcn
+	 */
+	public function initializeBaristaForDomain(string $domain_fqcn)
+	{
+		if (apply_filters('FHEE__load_Barista', true)) {
+			/** @var BaristaFactory $factory */
+			$factory = $this->loader->getShared(BaristaFactory::class);
+			$barista = $factory->createFromDomainClass($domain_fqcn);
+			if ($barista instanceof BaristaInterface) {
+				$barista->initialize();
+			}
+		}
+	}
+
+
+	/**
+	 * @var bool
+	 */
+	private function verifyIsHandled($handled)
+	{
+		if (! is_bool($handled)) {
+			throw new DomainException(
+				esc_html__(
+					'Route::requestHandler() must return a boolean to indicate whether the request has been handled or not.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->handled = filter_var($handled, FILTER_VALIDATE_BOOLEAN);
+	}
 }

core/services/addon/AddonManager.php

Spacing +2 added lines, -2 removed lines

@@ -80,7 +80,7 @@ 
     {
         // set autoloaders for all of the classes implementing the legacy EEI_Plugin_API
         // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'plugin_api');
     }
 
 
@@ -120,7 +120,7 @@ 
     private function registerAddon(AddonApiVersion $addon)
     {
         // first register addon namespace so that FQCNs resolve correctly
-        $this->psr4_loader->addNamespace($addon->getNamespace(), dirname($addon->mainFile()) . '/src/');
+        $this->psr4_loader->addNamespace($addon->getNamespace(), dirname($addon->mainFile()).'/src/');
         // then allow add-on to perform any other setup that relied on PSR4 autoloading
         $addon->initialize();
         // now register each addon based on it's API version

Indentation +79 added lines, -79 removed lines

@@ -23,95 +23,95 @@
  */
 class AddonManager
 {
-    private AddonCollection          $addons;
+	private AddonCollection          $addons;
 
-    private IncompatibleAddonHandler $incompatible_addon_handler;
+	private IncompatibleAddonHandler $incompatible_addon_handler;
 
-    private Psr4Autoloader           $psr4_loader;
+	private Psr4Autoloader           $psr4_loader;
 
-    private RegisterV1Addon          $register_v1_addon;
+	private RegisterV1Addon          $register_v1_addon;
 
-    private ThirdPartyPluginHandler  $third_party_plugin_handler;
+	private ThirdPartyPluginHandler  $third_party_plugin_handler;
 
 
-    /**
-     * AddonManager constructor.
-     *
-     * @param AddonCollection          $addons
-     * @param Psr4Autoloader           $psr4_loader
-     * @param RegisterV1Addon          $register_v1_addon
-     * @param IncompatibleAddonHandler $incompatible_addon_handler
-     * @param ThirdPartyPluginHandler  $third_party_plugin_handler
-     */
-    public function __construct(
-        AddonCollection $addons,
-        Psr4Autoloader $psr4_loader,
-        RegisterV1Addon $register_v1_addon,
-        IncompatibleAddonHandler $incompatible_addon_handler,
-        ThirdPartyPluginHandler $third_party_plugin_handler
-    ) {
-        $this->addons                     = $addons;
-        $this->psr4_loader                = $psr4_loader;
-        $this->register_v1_addon          = $register_v1_addon;
-        $this->incompatible_addon_handler = $incompatible_addon_handler;
-        $this->third_party_plugin_handler = $third_party_plugin_handler;
-    }
+	/**
+	 * AddonManager constructor.
+	 *
+	 * @param AddonCollection          $addons
+	 * @param Psr4Autoloader           $psr4_loader
+	 * @param RegisterV1Addon          $register_v1_addon
+	 * @param IncompatibleAddonHandler $incompatible_addon_handler
+	 * @param ThirdPartyPluginHandler  $third_party_plugin_handler
+	 */
+	public function __construct(
+		AddonCollection $addons,
+		Psr4Autoloader $psr4_loader,
+		RegisterV1Addon $register_v1_addon,
+		IncompatibleAddonHandler $incompatible_addon_handler,
+		ThirdPartyPluginHandler $third_party_plugin_handler
+	) {
+		$this->addons                     = $addons;
+		$this->psr4_loader                = $psr4_loader;
+		$this->register_v1_addon          = $register_v1_addon;
+		$this->incompatible_addon_handler = $incompatible_addon_handler;
+		$this->third_party_plugin_handler = $third_party_plugin_handler;
+	}
 
 
-    /**
-     * @throws Exception
-     */
-    public function initialize()
-    {
-        // set autoloaders for all of the classes implementing the legacy EEI_Plugin_API
-        // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
-    }
+	/**
+	 * @throws Exception
+	 */
+	public function initialize()
+	{
+		// set autoloaders for all of the classes implementing the legacy EEI_Plugin_API
+		// which provide helpers for EE plugin authors to more easily register certain components with EE.
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+	}
 
 
-    /**
-     * @throws Exception
-     * @throws Throwable
-     */
-    public function loadAddons()
-    {
-        try {
-            $this->incompatible_addon_handler->deactivateIncompatibleAddons();
-            // legacy add-on API
-            do_action('AHEE__EE_System__load_espresso_addons');
-            // new add-on API that uses versioning
-            do_action(
-                'AHEE__EventEspresso_core_services_addon_AddonManager__initialize__addons',
-                $this->addons,
-                espresso_version()
-            );
-            // addons are responsible for loading their AddonApiVersion into the AddonCollection
-            foreach ($this->addons as $addon) {
-                if ($addon instanceof AddonApiVersion) {
-                    $this->registerAddon($addon);
-                }
-            }
-            $this->third_party_plugin_handler->loadPlugins();
-            do_action('AHEE__EE_System__load_espresso_addons__complete');
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
+	/**
+	 * @throws Exception
+	 * @throws Throwable
+	 */
+	public function loadAddons()
+	{
+		try {
+			$this->incompatible_addon_handler->deactivateIncompatibleAddons();
+			// legacy add-on API
+			do_action('AHEE__EE_System__load_espresso_addons');
+			// new add-on API that uses versioning
+			do_action(
+				'AHEE__EventEspresso_core_services_addon_AddonManager__initialize__addons',
+				$this->addons,
+				espresso_version()
+			);
+			// addons are responsible for loading their AddonApiVersion into the AddonCollection
+			foreach ($this->addons as $addon) {
+				if ($addon instanceof AddonApiVersion) {
+					$this->registerAddon($addon);
+				}
+			}
+			$this->third_party_plugin_handler->loadPlugins();
+			do_action('AHEE__EE_System__load_espresso_addons__complete');
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
 
 
-    /**
-     * @param AddonApiVersion $addon
-     * @throws EE_Error
-     */
-    private function registerAddon(AddonApiVersion $addon)
-    {
-        // first register addon namespace so that FQCNs resolve correctly
-        $this->psr4_loader->addNamespace($addon->getNamespace(), dirname($addon->mainFile()) . '/src/');
-        // then allow add-on to perform any other setup that relied on PSR4 autoloading
-        $addon->initialize();
-        // now register each addon based on it's API version
-        if ($addon instanceof AddonApiV1) {
-            $this->register_v1_addon->register($addon);
-        }
-    }
+	/**
+	 * @param AddonApiVersion $addon
+	 * @throws EE_Error
+	 */
+	private function registerAddon(AddonApiVersion $addon)
+	{
+		// first register addon namespace so that FQCNs resolve correctly
+		$this->psr4_loader->addNamespace($addon->getNamespace(), dirname($addon->mainFile()) . '/src/');
+		// then allow add-on to perform any other setup that relied on PSR4 autoloading
+		$addon->initialize();
+		// now register each addon based on it's API version
+		if ($addon instanceof AddonApiV1) {
+			$this->register_v1_addon->register($addon);
+		}
+	}
 }

core/services/addon/api/IncompatibleAddonHandler.php

Spacing +4 added lines, -4 removed lines

@@ -43,14 +43,14 @@ 
         string $load_callback,
         string $plugin_file_constant
     ) {
-        if (! defined($version_constant)) {
+        if ( ! defined($version_constant)) {
             return;
         }
         $addon_version = constant($version_constant);
         if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
             remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
-            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(constant($plugin_file_constant)));
             unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
@@ -64,7 +64,7 @@ 
                     $min_version_required
                 ),
                 __FILE__,
-                __FUNCTION__ . "({$addon_name})",
+                __FUNCTION__."({$addon_name})",
                 __LINE__
             );
             EE_Error::get_notices(false, true);

Indentation +74 added lines, -74 removed lines

@@ -6,80 +6,80 @@
 
 class IncompatibleAddonHandler
 {
-    /**
-     * @return void
-     */
-    public function deactivateIncompatibleAddons()
-    {
-        static $done = false;
-        if ($done) {
-            return;
-        }
-        $this->deactivateIncompatibleAddon(
-            'Wait Lists',
-            'EE_WAIT_LISTS_VERSION',
-            '1.0.0.beta.074',
-            'load_espresso_wait_lists',
-            'EE_WAIT_LISTS_PLUGIN_FILE'
-        );
-        $this->deactivateIncompatibleAddon(
-            'Automated Upcoming Event Notifications',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
-            '1.0.0.beta.091',
-            'load_espresso_automated_upcoming_event_notification',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
-        );
-        // $this->deactivateIncompatibleAddon(
-        //     'WP Users Integration',
-        //     'EE_WPUSERS_VERSION',
-        //     '2.1.0.rc.003',
-        //     'load_ee_core_wpusers',
-        //     'EE_WPUSERS_PLUGIN_FILE'
-        // );
-        $done = true;
-    }
+	/**
+	 * @return void
+	 */
+	public function deactivateIncompatibleAddons()
+	{
+		static $done = false;
+		if ($done) {
+			return;
+		}
+		$this->deactivateIncompatibleAddon(
+			'Wait Lists',
+			'EE_WAIT_LISTS_VERSION',
+			'1.0.0.beta.074',
+			'load_espresso_wait_lists',
+			'EE_WAIT_LISTS_PLUGIN_FILE'
+		);
+		$this->deactivateIncompatibleAddon(
+			'Automated Upcoming Event Notifications',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
+			'1.0.0.beta.091',
+			'load_espresso_automated_upcoming_event_notification',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
+		);
+		// $this->deactivateIncompatibleAddon(
+		//     'WP Users Integration',
+		//     'EE_WPUSERS_VERSION',
+		//     '2.1.0.rc.003',
+		//     'load_ee_core_wpusers',
+		//     'EE_WPUSERS_PLUGIN_FILE'
+		// );
+		$done = true;
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param string $version_constant
-     * @param string $min_version_required
-     * @param string $load_callback
-     * @param string $plugin_file_constant
-     * @return void
-     */
-    private function deactivateIncompatibleAddon(
-        string $addon_name,
-        string $version_constant,
-        string $min_version_required,
-        string $load_callback,
-        string $plugin_file_constant
-    ) {
-        if (! defined($version_constant)) {
-            return;
-        }
-        $addon_version = constant($version_constant);
-        if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
-            remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
-            }
-            deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
-            unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
-                        'event_espresso'
-                    ),
-                    $addon_name,
-                    $min_version_required
-                ),
-                __FILE__,
-                __FUNCTION__ . "({$addon_name})",
-                __LINE__
-            );
-            EE_Error::get_notices(false, true);
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @param string $version_constant
+	 * @param string $min_version_required
+	 * @param string $load_callback
+	 * @param string $plugin_file_constant
+	 * @return void
+	 */
+	private function deactivateIncompatibleAddon(
+		string $addon_name,
+		string $version_constant,
+		string $min_version_required,
+		string $load_callback,
+		string $plugin_file_constant
+	) {
+		if (! defined($version_constant)) {
+			return;
+		}
+		$addon_version = constant($version_constant);
+		if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
+			remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
+			if (! function_exists('deactivate_plugins')) {
+				require_once ABSPATH . 'wp-admin/includes/plugin.php';
+			}
+			deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
+			unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
+						'event_espresso'
+					),
+					$addon_name,
+					$min_version_required
+				),
+				__FILE__,
+				__FUNCTION__ . "({$addon_name})",
+				__LINE__
+			);
+			EE_Error::get_notices(false, true);
+		}
+	}
 }

core/services/addon/api/AddonApiVersion.php

Indentation +282 added lines, -282 removed lines

@@ -19,286 +19,286 @@
  */
 abstract class AddonApiVersion
 {
-    const V1 = 1;
-
-    /**
-     * @var int one of the API_VERSION_* constants from above
-     */
-    private $api_version;
-
-    /**
-     * @var DomainInterface
-     */
-    private $domain;
-
-    /**
-     * @var Version minimum version of EE core that the add-on will work with
-     */
-    private $min_core_version;
-
-    /**
-     * @var Version minimum version of WP core that the add-on will work with
-     */
-    private $min_wp_version;
-
-    /**
-     * @var string  PascalCase identifier for the add-on.
-     *              IMPORTANT! there must be a class of the same name in the root of the add-ons /src/domain/ folder
-     */
-    private $name;
-
-    /**
-     * @var string
-     */
-    private $addon_namespace;
-
-    /**
-     * @var FilePath
-     */
-    private $main_file;
-
-    /**
-     * @var string
-     */
-    private $slug;
-
-    /**
-     * @var Version the current add-on version
-     */
-    private $version;
-
-
-    /**
-     * Bootstrap constructor.
-     *
-     * @param string $slug
-     * @param string $name
-     * @param string $namespace
-     * @param string $version
-     * @param string $min_core_version
-     * @param string $main_file
-     * @param int    $api_version
-     */
-    protected function __construct(
-        string $slug,
-        string $name,
-        string $namespace,
-        string $version,
-        string $min_core_version,
-        string $main_file,
-        int $api_version
-    ) {
-        $this->setSlug($slug);
-        $this->setName($name);
-        $this->setNamespace($namespace);
-        $this->setMinCoreVersion($min_core_version);
-        $this->setMainFile($main_file);
-        $this->setVersion($version);
-        $this->setApiVersion($api_version);
-    }
-
-
-    /**
-     * @return void
-     */
-    public function initialize(): void
-    {
-        $this->domain = DomainFactory::create(
-            "{$this->addon_namespace}\\domain\\Domain",
-            $this->main_file,
-            $this->version
-        );
-    }
-
-
-    /**
-     * @return int[]
-     */
-    private function validApiVersions(): array
-    {
-        return [
-            AddonApiVersion::V1,
-        ];
-    }
-
-
-    /**
-     * @param int $api_version
-     */
-    private function setApiVersion(int $api_version): void
-    {
-        if (! in_array($api_version, $this->validApiVersions())) {
-            throw new DomainException(
-                esc_html__(
-                    'Invalid Add-on API Version! Please use one of the EventEspresso\core\domain\entities\addon\Bootstrap class constants',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->api_version = $api_version;
-    }
-
-
-    /**
-     * @param string $main_file
-     */
-    public function setMainFile(string $main_file): void
-    {
-        $this->main_file = new FilePath($main_file);
-    }
-
-
-    /**
-     * @param string $min_core_version
-     */
-    private function setMinCoreVersion(string $min_core_version): void
-    {
-        $this->min_core_version = Version::fromString($min_core_version);
-    }
-
-
-    /**
-     * @param string $name
-     */
-    public function setName(string $name): void
-    {
-        $this->name = $name;
-    }
-
-
-    /**
-     * @param string $namespace
-     */
-    private function setNamespace(string $namespace): void
-    {
-        $this->addon_namespace = $namespace;
-    }
-
-
-    /**
-     * @param string $slug
-     */
-    private function setSlug(string $slug): void
-    {
-        $valid_slug = sanitize_key($slug);
-        if ($slug !== $valid_slug) {
-            throw new DomainException(
-                esc_html__(
-                    'Invalid Add-on "slug"! Please ensure that slug only uses lowercase characters and dashes.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->slug = $valid_slug;
-    }
-
-
-    /**
-     * @param string $version
-     */
-    public function setVersion(string $version): void
-    {
-        $this->version = Version::fromString($version);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function apiVersion(): int
-    {
-        return $this->api_version;
-    }
-
-
-    /**
-     * @return DomainInterface
-     */
-    public function domain(): DomainInterface
-    {
-        return $this->domain;
-    }
-
-
-    /**
-     * @return Version|null
-     */
-    public function minCoreVersion(): ?Version
-    {
-        return $this->min_core_version;
-    }
-
-
-    /**
-     * @return Version|null
-     */
-    public function minWpVersion(): ?Version
-    {
-        return $this->min_wp_version;
-    }
-
-
-    /**
-     * @param string $min_wp_version
-     */
-    public function setMinWpVersion(string $min_wp_version = EE_MIN_WP_VER_REQUIRED): void
-    {
-        $this->min_wp_version = Version::fromString($min_wp_version);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function name(): string
-    {
-        return $this->name;
-    }
-
-
-    /**
-     * FQCN for the domain's EE_Addon class
-     *
-     * @return string
-     */
-    public function fqcn(): string
-    {
-        return "{$this->addon_namespace}\\domain\\{$this->name}";
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getNamespace(): string
-    {
-        return $this->addon_namespace;
-    }
-
-
-    /**
-     * @return FilePath
-     */
-    public function mainFile(): FilePath
-    {
-        return $this->main_file;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug(): string
-    {
-        return $this->slug;
-    }
-
-
-    /**
-     * @return Version
-     */
-    public function version(): Version
-    {
-        return $this->version;
-    }
+	const V1 = 1;
+
+	/**
+	 * @var int one of the API_VERSION_* constants from above
+	 */
+	private $api_version;
+
+	/**
+	 * @var DomainInterface
+	 */
+	private $domain;
+
+	/**
+	 * @var Version minimum version of EE core that the add-on will work with
+	 */
+	private $min_core_version;
+
+	/**
+	 * @var Version minimum version of WP core that the add-on will work with
+	 */
+	private $min_wp_version;
+
+	/**
+	 * @var string  PascalCase identifier for the add-on.
+	 *              IMPORTANT! there must be a class of the same name in the root of the add-ons /src/domain/ folder
+	 */
+	private $name;
+
+	/**
+	 * @var string
+	 */
+	private $addon_namespace;
+
+	/**
+	 * @var FilePath
+	 */
+	private $main_file;
+
+	/**
+	 * @var string
+	 */
+	private $slug;
+
+	/**
+	 * @var Version the current add-on version
+	 */
+	private $version;
+
+
+	/**
+	 * Bootstrap constructor.
+	 *
+	 * @param string $slug
+	 * @param string $name
+	 * @param string $namespace
+	 * @param string $version
+	 * @param string $min_core_version
+	 * @param string $main_file
+	 * @param int    $api_version
+	 */
+	protected function __construct(
+		string $slug,
+		string $name,
+		string $namespace,
+		string $version,
+		string $min_core_version,
+		string $main_file,
+		int $api_version
+	) {
+		$this->setSlug($slug);
+		$this->setName($name);
+		$this->setNamespace($namespace);
+		$this->setMinCoreVersion($min_core_version);
+		$this->setMainFile($main_file);
+		$this->setVersion($version);
+		$this->setApiVersion($api_version);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function initialize(): void
+	{
+		$this->domain = DomainFactory::create(
+			"{$this->addon_namespace}\\domain\\Domain",
+			$this->main_file,
+			$this->version
+		);
+	}
+
+
+	/**
+	 * @return int[]
+	 */
+	private function validApiVersions(): array
+	{
+		return [
+			AddonApiVersion::V1,
+		];
+	}
+
+
+	/**
+	 * @param int $api_version
+	 */
+	private function setApiVersion(int $api_version): void
+	{
+		if (! in_array($api_version, $this->validApiVersions())) {
+			throw new DomainException(
+				esc_html__(
+					'Invalid Add-on API Version! Please use one of the EventEspresso\core\domain\entities\addon\Bootstrap class constants',
+					'event_espresso'
+				)
+			);
+		}
+		$this->api_version = $api_version;
+	}
+
+
+	/**
+	 * @param string $main_file
+	 */
+	public function setMainFile(string $main_file): void
+	{
+		$this->main_file = new FilePath($main_file);
+	}
+
+
+	/**
+	 * @param string $min_core_version
+	 */
+	private function setMinCoreVersion(string $min_core_version): void
+	{
+		$this->min_core_version = Version::fromString($min_core_version);
+	}
+
+
+	/**
+	 * @param string $name
+	 */
+	public function setName(string $name): void
+	{
+		$this->name = $name;
+	}
+
+
+	/**
+	 * @param string $namespace
+	 */
+	private function setNamespace(string $namespace): void
+	{
+		$this->addon_namespace = $namespace;
+	}
+
+
+	/**
+	 * @param string $slug
+	 */
+	private function setSlug(string $slug): void
+	{
+		$valid_slug = sanitize_key($slug);
+		if ($slug !== $valid_slug) {
+			throw new DomainException(
+				esc_html__(
+					'Invalid Add-on "slug"! Please ensure that slug only uses lowercase characters and dashes.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->slug = $valid_slug;
+	}
+
+
+	/**
+	 * @param string $version
+	 */
+	public function setVersion(string $version): void
+	{
+		$this->version = Version::fromString($version);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function apiVersion(): int
+	{
+		return $this->api_version;
+	}
+
+
+	/**
+	 * @return DomainInterface
+	 */
+	public function domain(): DomainInterface
+	{
+		return $this->domain;
+	}
+
+
+	/**
+	 * @return Version|null
+	 */
+	public function minCoreVersion(): ?Version
+	{
+		return $this->min_core_version;
+	}
+
+
+	/**
+	 * @return Version|null
+	 */
+	public function minWpVersion(): ?Version
+	{
+		return $this->min_wp_version;
+	}
+
+
+	/**
+	 * @param string $min_wp_version
+	 */
+	public function setMinWpVersion(string $min_wp_version = EE_MIN_WP_VER_REQUIRED): void
+	{
+		$this->min_wp_version = Version::fromString($min_wp_version);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function name(): string
+	{
+		return $this->name;
+	}
+
+
+	/**
+	 * FQCN for the domain's EE_Addon class
+	 *
+	 * @return string
+	 */
+	public function fqcn(): string
+	{
+		return "{$this->addon_namespace}\\domain\\{$this->name}";
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getNamespace(): string
+	{
+		return $this->addon_namespace;
+	}
+
+
+	/**
+	 * @return FilePath
+	 */
+	public function mainFile(): FilePath
+	{
+		return $this->main_file;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug(): string
+	{
+		return $this->slug;
+	}
+
+
+	/**
+	 * @return Version
+	 */
+	public function version(): Version
+	{
+		return $this->version;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -127,7 +127,7 @@
      */
     private function setApiVersion(int $api_version): void
     {
-        if (! in_array($api_version, $this->validApiVersions())) {
+        if ( ! in_array($api_version, $this->validApiVersions())) {
             throw new DomainException(
                 esc_html__(
                     'Invalid Add-on API Version! Please use one of the EventEspresso\core\domain\entities\addon\Bootstrap class constants',

core/services/addon/api/ThirdPartyPluginHandler.php

Spacing +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
             && ! function_exists('json_basic_auth_handler')
             && ! function_exists('json_basic_auth_error')
         ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
+            include_once EE_THIRD_PARTY.'wp-api-basic-auth/basic-auth.php';
         }
     }
 }

Indentation +39 added lines, -39 removed lines

@@ -7,43 +7,43 @@
 class ThirdPartyPluginHandler
 {
 
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-
-    /**
-     * ThirdPartyPluginHandler constructor.
-     *
-     * @param RequestInterface $request
-     */
-    public function __construct(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
-
-
-    public function loadPlugins()
-    {
-        $this->wpApiBasicAuth();
-    }
-
-
-    private function wpApiBasicAuth()
-    {
-        // if the WP API basic auth plugin isn't already loaded, load it now.
-        // We want it for mobile apps. Just include the entire plugin
-        // also, don't load the basic auth when a plugin is getting activated, because
-        // it could be the basic auth plugin, and it doesn't check if its methods are already defined
-        // and causes a fatal error
-        if (
-            ($this->request->isWordPressApi() || $this->request->isApi())
-            && ! $this->request->isActivation()
-            && ! function_exists('json_basic_auth_handler')
-            && ! function_exists('json_basic_auth_error')
-        ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
-        }
-    }
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+
+	/**
+	 * ThirdPartyPluginHandler constructor.
+	 *
+	 * @param RequestInterface $request
+	 */
+	public function __construct(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
+
+
+	public function loadPlugins()
+	{
+		$this->wpApiBasicAuth();
+	}
+
+
+	private function wpApiBasicAuth()
+	{
+		// if the WP API basic auth plugin isn't already loaded, load it now.
+		// We want it for mobile apps. Just include the entire plugin
+		// also, don't load the basic auth when a plugin is getting activated, because
+		// it could be the basic auth plugin, and it doesn't check if its methods are already defined
+		// and causes a fatal error
+		if (
+			($this->request->isWordPressApi() || $this->request->isApi())
+			&& ! $this->request->isActivation()
+			&& ! function_exists('json_basic_auth_handler')
+			&& ! function_exists('json_basic_auth_error')
+		) {
+			include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
+		}
+	}
 }

core/services/addon/api/v1/LegacyModelApi.php

Indentation +91 added lines, -91 removed lines

@@ -5,95 +5,95 @@
 class LegacyModelApi
 {
 
-    /**
-     * @var string path to EE_* entity classes
-     */
-    private $entity_classes;
-
-    /**
-     * @var string path to EEM_* entity model classes
-     */
-    private $entity_models;
-
-    /**
-     * @var string path to EEE_* entity class extensions
-     */
-    private $entity_class_extensions;
-
-    /**
-     * @var string path to EEME_* entity model class extensions
-     */
-    private $entity_model_extensions;
-
-
-    /**
-     * @return string
-     */
-    public function entityClasses(): string
-    {
-        return $this->entity_classes;
-    }
-
-
-    /**
-     * @param string $entity_classes
-     */
-    public function addEntityClasses(string $entity_classes): void
-    {
-        $this->entity_classes = $entity_classes;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function entityModels(): string
-    {
-        return $this->entity_models;
-    }
-
-
-    /**
-     * @param string $entity_models
-     */
-    public function addEntityModels(string $entity_models): void
-    {
-        $this->entity_models = $entity_models;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function entityClassExtensions(): string
-    {
-        return $this->entity_class_extensions;
-    }
-
-
-    /**
-     * @param string $entity_class_extensions
-     */
-    public function addEntityClassExtensions(string $entity_class_extensions): void
-    {
-        $this->entity_class_extensions = $entity_class_extensions;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function entityModelExtensions(): string
-    {
-        return $this->entity_model_extensions;
-    }
-
-
-    /**
-     * @param string $entity_model_extensions
-     */
-    public function addEntityModelExtensions(string $entity_model_extensions): void
-    {
-        $this->entity_model_extensions = $entity_model_extensions;
-    }
+	/**
+	 * @var string path to EE_* entity classes
+	 */
+	private $entity_classes;
+
+	/**
+	 * @var string path to EEM_* entity model classes
+	 */
+	private $entity_models;
+
+	/**
+	 * @var string path to EEE_* entity class extensions
+	 */
+	private $entity_class_extensions;
+
+	/**
+	 * @var string path to EEME_* entity model class extensions
+	 */
+	private $entity_model_extensions;
+
+
+	/**
+	 * @return string
+	 */
+	public function entityClasses(): string
+	{
+		return $this->entity_classes;
+	}
+
+
+	/**
+	 * @param string $entity_classes
+	 */
+	public function addEntityClasses(string $entity_classes): void
+	{
+		$this->entity_classes = $entity_classes;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function entityModels(): string
+	{
+		return $this->entity_models;
+	}
+
+
+	/**
+	 * @param string $entity_models
+	 */
+	public function addEntityModels(string $entity_models): void
+	{
+		$this->entity_models = $entity_models;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function entityClassExtensions(): string
+	{
+		return $this->entity_class_extensions;
+	}
+
+
+	/**
+	 * @param string $entity_class_extensions
+	 */
+	public function addEntityClassExtensions(string $entity_class_extensions): void
+	{
+		$this->entity_class_extensions = $entity_class_extensions;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function entityModelExtensions(): string
+	{
+		return $this->entity_model_extensions;
+	}
+
+
+	/**
+	 * @param string $entity_model_extensions
+	 */
+	public function addEntityModelExtensions(string $entity_model_extensions): void
+	{
+		$this->entity_model_extensions = $entity_model_extensions;
+	}
 }

core/services/addon/api/v1/RegisterAddon.php

Indentation +22 added lines, -22 removed lines

@@ -8,26 +8,26 @@
 
 class RegisterAddon
 {
-    /**
-     * @param AddonApiV1 $addon
-     * @throws EE_Error
-     */
-    public function register(AddonApiV1 $addon)
-    {
-        EE_Register_Addon::register(
-            $addon->fqcn(),
-            [
-                'version'               => $addon->version(),
-                'plugin_slug'           => $addon->slug(),
-                'min_core_version'      => $addon->minCoreVersion(),
-                'min_wp_version'        => $addon->minWpVersion(),
-                'main_file_path'        => $addon->mainFile(),
-                'dms_paths'             => [$addon->dataMigrationScripts()],
-                'class_paths'           => [$addon->entityClasses()],
-                'model_paths'           => [$addon->entityModels()],
-                'class_extension_paths' => [$addon->entityClassExtensions()],
-                'model_extension_paths' => [$addon->entityModelExtensions()],
-            ]
-        );
-    }
+	/**
+	 * @param AddonApiV1 $addon
+	 * @throws EE_Error
+	 */
+	public function register(AddonApiV1 $addon)
+	{
+		EE_Register_Addon::register(
+			$addon->fqcn(),
+			[
+				'version'               => $addon->version(),
+				'plugin_slug'           => $addon->slug(),
+				'min_core_version'      => $addon->minCoreVersion(),
+				'min_wp_version'        => $addon->minWpVersion(),
+				'main_file_path'        => $addon->mainFile(),
+				'dms_paths'             => [$addon->dataMigrationScripts()],
+				'class_paths'           => [$addon->entityClasses()],
+				'model_paths'           => [$addon->entityModels()],
+				'class_extension_paths' => [$addon->entityClassExtensions()],
+				'model_extension_paths' => [$addon->entityModelExtensions()],
+			]
+		);
+	}
 }

core/services/addon/api/v1/AddonApi.php

Indentation +131 added lines, -131 removed lines

@@ -7,135 +7,135 @@
 class AddonApi extends AddonApiVersion
 {
 
-    /**
-     * @var DataMigrationApi
-     */
-    private $data_migration_api;
-
-    /**
-     * @var LegacyModelApi
-     */
-    private $legacy_model_api;
-
-
-    /**
-     * Bootstrap constructor.
-     *
-     * @param string $slug
-     * @param string $name
-     * @param string $namespace
-     * @param string $version
-     * @param string $min_core_version
-     * @param string $main_file
-     */
-    public function __construct(
-        string $slug,
-        string $name,
-        string $namespace,
-        string $version,
-        string $min_core_version,
-        string $main_file
-    ) {
-        parent::__construct(
-            $slug,
-            $name,
-            $namespace,
-            $version,
-            $min_core_version,
-            $main_file,
-            AddonApiVersion::V1
-        );
-        $this->legacy_model_api = new LegacyModelApi();
-        $this->data_migration_api = new DataMigrationApi();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function dataMigrationScripts(): string
-    {
-        return $this->data_migration_api->dataMigrationScripts();
-    }
-
-
-    /**
-     * @param string $data_migration_scripts
-     */
-    public function addDataMigrationScripts(string $data_migration_scripts): void
-    {
-        $this->data_migration_api->addDataMigrationScripts($data_migration_scripts);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function entityClasses(): string
-    {
-        return $this->legacy_model_api->entityClasses();
-    }
-
-
-    /**
-     * @param string $entity_classes
-     */
-    public function addEntityClasses(string $entity_classes): void
-    {
-        $this->legacy_model_api->addEntityClasses($entity_classes);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function entityModels(): string
-    {
-        return $this->legacy_model_api->entityModels();
-    }
-
-
-    /**
-     * @param string $entity_models
-     */
-    public function addEntityModels(string $entity_models): void
-    {
-        $this->legacy_model_api->addEntityModels($entity_models);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function entityClassExtensions(): string
-    {
-        return $this->legacy_model_api->entityClassExtensions();
-    }
-
-
-    /**
-     * @param string $entity_class_extensions
-     */
-    public function addEntityClassExtensions(string $entity_class_extensions): void
-    {
-        $this->legacy_model_api->addEntityClassExtensions($entity_class_extensions);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function entityModelExtensions(): string
-    {
-        return $this->legacy_model_api->entityModelExtensions();
-    }
-
-
-    /**
-     * @param string $entity_model_extensions
-     */
-    public function addEntityModelExtensions(string $entity_model_extensions): void
-    {
-        $this->legacy_model_api->addEntityModelExtensions($entity_model_extensions);
-    }
+	/**
+	 * @var DataMigrationApi
+	 */
+	private $data_migration_api;
+
+	/**
+	 * @var LegacyModelApi
+	 */
+	private $legacy_model_api;
+
+
+	/**
+	 * Bootstrap constructor.
+	 *
+	 * @param string $slug
+	 * @param string $name
+	 * @param string $namespace
+	 * @param string $version
+	 * @param string $min_core_version
+	 * @param string $main_file
+	 */
+	public function __construct(
+		string $slug,
+		string $name,
+		string $namespace,
+		string $version,
+		string $min_core_version,
+		string $main_file
+	) {
+		parent::__construct(
+			$slug,
+			$name,
+			$namespace,
+			$version,
+			$min_core_version,
+			$main_file,
+			AddonApiVersion::V1
+		);
+		$this->legacy_model_api = new LegacyModelApi();
+		$this->data_migration_api = new DataMigrationApi();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function dataMigrationScripts(): string
+	{
+		return $this->data_migration_api->dataMigrationScripts();
+	}
+
+
+	/**
+	 * @param string $data_migration_scripts
+	 */
+	public function addDataMigrationScripts(string $data_migration_scripts): void
+	{
+		$this->data_migration_api->addDataMigrationScripts($data_migration_scripts);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function entityClasses(): string
+	{
+		return $this->legacy_model_api->entityClasses();
+	}
+
+
+	/**
+	 * @param string $entity_classes
+	 */
+	public function addEntityClasses(string $entity_classes): void
+	{
+		$this->legacy_model_api->addEntityClasses($entity_classes);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function entityModels(): string
+	{
+		return $this->legacy_model_api->entityModels();
+	}
+
+
+	/**
+	 * @param string $entity_models
+	 */
+	public function addEntityModels(string $entity_models): void
+	{
+		$this->legacy_model_api->addEntityModels($entity_models);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function entityClassExtensions(): string
+	{
+		return $this->legacy_model_api->entityClassExtensions();
+	}
+
+
+	/**
+	 * @param string $entity_class_extensions
+	 */
+	public function addEntityClassExtensions(string $entity_class_extensions): void
+	{
+		$this->legacy_model_api->addEntityClassExtensions($entity_class_extensions);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function entityModelExtensions(): string
+	{
+		return $this->legacy_model_api->entityModelExtensions();
+	}
+
+
+	/**
+	 * @param string $entity_model_extensions
+	 */
+	public function addEntityModelExtensions(string $entity_model_extensions): void
+	{
+		$this->legacy_model_api->addEntityModelExtensions($entity_model_extensions);
+	}
 }