eventespresso / event-espresso-core

core/services/dependencies/DependencyHandler.php

Indentation +13 added lines, -13 removed lines

@@ -7,19 +7,19 @@
 abstract class DependencyHandler implements DependencyHandlerInterface
 {
 
-    /**
-     * @var EE_Dependency_Map $dependency_map
-     */
-    protected $dependency_map;
+	/**
+	 * @var EE_Dependency_Map $dependency_map
+	 */
+	protected $dependency_map;
 
 
-    /**
-     * DependencyHandler constructor.
-     *
-     * @param EE_Dependency_Map $dependency_map
-     */
-    public function __construct(EE_Dependency_Map $dependency_map)
-    {
-        $this->dependency_map = $dependency_map;
-    }
+	/**
+	 * DependencyHandler constructor.
+	 *
+	 * @param EE_Dependency_Map $dependency_map
+	 */
+	public function __construct(EE_Dependency_Map $dependency_map)
+	{
+		$this->dependency_map = $dependency_map;
+	}
 }

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

Spacing +4 added lines, -4 removed lines

@@ -44,15 +44,15 @@ 
      */
     protected function getQueryResponse(string $field_key, array $where_params = [])
     {
-        if (! empty($where_params)) {
-            if (! array_key_exists('variables', $this->params)) {
+        if ( ! empty($where_params)) {
+            if ( ! array_key_exists('variables', $this->params)) {
                 $this->params['variables'] = [];
             }
             $this->params['variables']['where'] = $where_params;
         }
 
         $responseData = $this->makeGraphQLRequest($this->params);
-        return ! empty($responseData[ $field_key ]) ? $responseData[ $field_key ] : null;
+        return ! empty($responseData[$field_key]) ? $responseData[$field_key] : null;
     }
 
 
@@ -66,7 +66,7 @@ 
         $error = '';
         try {
             $response = graphql($data);
-            if (! empty($response['data'])) {
+            if ( ! empty($response['data'])) {
                 return $response['data'];
             }
             $error = ! empty($response['errors'])

Indentation +59 added lines, -59 removed lines

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

core/domain/EnqueueAssetsInterface.php

Indentation +35 added lines, -35 removed lines

@@ -4,45 +4,45 @@
 interface EnqueueAssetsInterface
 {
 
-    /**
-     * a place to register scripts and stylesheets with WordPress core
-     * IMPORTANT !!!
-     * ALL JavaScript files need to be registered for loading in the footer
-     * by setting the 5th parameter of wp_register_script() to ` true `
-     *
-     * @return void
-     */
-    public function registerScriptsAndStylesheets();
+	/**
+	 * a place to register scripts and stylesheets with WordPress core
+	 * IMPORTANT !!!
+	 * ALL JavaScript files need to be registered for loading in the footer
+	 * by setting the 5th parameter of wp_register_script() to ` true `
+	 *
+	 * @return void
+	 */
+	public function registerScriptsAndStylesheets();
 
-    /**
-     * a place to enqueue previously registered stylesheets
-     * this will be called during the wp_enqueue_scripts hook for frontend requests
-     *
-     * @return void
-     */
-    public function enqueueStylesheets();
+	/**
+	 * a place to enqueue previously registered stylesheets
+	 * this will be called during the wp_enqueue_scripts hook for frontend requests
+	 *
+	 * @return void
+	 */
+	public function enqueueStylesheets();
 
-    /**
-     * a place to enqueue previously registered stylesheets
-     * this will be called during the admin_enqueue_scripts hook for admin requests
-     *
-     * @return void
-     */
-    public function enqueueAdminStylesheets();
+	/**
+	 * a place to enqueue previously registered stylesheets
+	 * this will be called during the admin_enqueue_scripts hook for admin requests
+	 *
+	 * @return void
+	 */
+	public function enqueueAdminStylesheets();
 
-    /**
-     * a place to enqueue previously registered scripts for frontend requests
-     *
-     * @return void
-     */
-    public function enqueueScripts();
+	/**
+	 * a place to enqueue previously registered scripts for frontend requests
+	 *
+	 * @return void
+	 */
+	public function enqueueScripts();
 
-    /**
-     * a place to enqueue previously registered scripts for admin requests
-     *
-     * @return void
-     */
-    public function enqueueAdminScripts();
+	/**
+	 * a place to enqueue previously registered scripts for admin requests
+	 *
+	 * @return void
+	 */
+	public function enqueueAdminScripts();
 }
 // End of file EnqueueAssetsInterface.php
 // Location: EventEspresso\core\domain/EnqueueAssetsInterface.php

caffeinated/payment_methods/Paypal_Pro/help_tabs/payment_methods_overview_paypalpro.help_tab.php

Indentation +39 added lines, -39 removed lines

@@ -2,12 +2,12 @@ 
 <p><?php esc_html_e('Adjust the settings for the PayPal Pro payment gateway.', 'event_espresso'); ?></p>
 <p>
     <?php
-    printf(
-        esc_html__('See %1$shere%2$s for list of currencies supported by Paypal Pro.', 'event_espresso'),
-        "<a href='https://www.paypal.com/multicurrency' target='_blank' rel='noopener noreferrer'>",
-        "</a>"
-    );
-    ?>
+	printf(
+		esc_html__('See %1$shere%2$s for list of currencies supported by Paypal Pro.', 'event_espresso'),
+		"<a href='https://www.paypal.com/multicurrency' target='_blank' rel='noopener noreferrer'>",
+		"</a>"
+	);
+	?>
 </p>
 <p><strong><?php esc_html_e('PayPal Pro Settings', 'event_espresso'); ?></strong></p>
 <ul>
@@ -18,48 +18,48 @@ 
     <li>
         <strong><?php esc_html_e('PayPal API Username', 'event_espresso'); ?></strong><br/>
         <?php
-        printf(
-            esc_html__(
-                'Enter your API Username for PayPal. Learn how to find your %1$sAPI Username%2$s.',
-                'event_espresso'
-            ),
-            '<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Enter your API Username for PayPal. Learn how to find your %1$sAPI Username%2$s.',
+				'event_espresso'
+			),
+			'<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
+			'</a>'
+		);
+		?>
     </li>
     <li>
         <strong><?php esc_html_e('PayPal API Password', 'event_espresso'); ?></strong><br/>
         <?php
-        printf(
-            esc_html__(
-                'Enter your API Password for PayPal. Learn how to find your %1$sAPI Password%2$s.',
-                'event_espresso'
-            ),
-            '<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Enter your API Password for PayPal. Learn how to find your %1$sAPI Password%2$s.',
+				'event_espresso'
+			),
+			'<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
+			'</a>'
+		);
+		?>
     </li>
     <li>
         <strong><?php esc_html_e('PayPal API Signature', 'event_espresso'); ?></strong><br/>
         <?php
-        printf(
-            esc_html__(
-                'Enter your API Signature for PayPal. Learn how to find your %1$sAPI Signature%2$s.',
-                'event_espresso'
-            ),
-            '<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Enter your API Signature for PayPal. Learn how to find your %1$sAPI Signature%2$s.',
+				'event_espresso'
+			),
+			'<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
+			'</a>'
+		);
+		?>
     </li>
     <li>
         <strong><?php esc_html_e('Country Currency', 'event_espresso'); ?></strong><br/>
         <?php esc_html_e(
-            'Select the currency for your country. Payments will be accepted in this currency.',
-            'event_espresso'
-        ); ?>
+			'Select the currency for your country. Payments will be accepted in this currency.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Accepted Card Types', 'event_espresso'); ?></strong><br/>
@@ -68,9 +68,9 @@ 
     <li>
         <strong><?php esc_html_e('Use the Debugging Feature and the PayPal Sandbox', 'event_espresso'); ?></strong><br/>
         <?php esc_html_e(
-            'Specify if you want to test the payment gateway by submitting a test transaction. If this option is enabled, be sure to enter your PayPal sandbox credentials in the fields above. Be sure to turn this setting off when you are done testing.',
-            'event_espresso'
-        ); ?>
+			'Specify if you want to test the payment gateway by submitting a test transaction. If this option is enabled, be sure to enter your PayPal sandbox credentials in the fields above. Be sure to turn this setting off when you are done testing.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Button Image URL', 'event_espresso'); ?></strong><br/>

admin_pages/messages/help_tabs/messages_overview_types.help_tab.php

Indentation +18 added lines, -18 removed lines

@@ -1,15 +1,15 @@ 
 <p><strong><?php esc_html_e('Message Types', 'event_espresso'); ?></strong></p>
 <p>
     <?php
-    printf(
-        esc_html__(
-            'Messages are email notifications that are sent out by Event Espresso. Message Types are the %1$skinds%2$s of messages that get delivered.  They can be thought of as the "type" of package that is being delivered by the messenger. For example, Event Espresso comes with two Message Types attached to the Email Messenger:',
-            'event_espresso'
-        ),
-        '<em>',
-        '</em>'
-    );
-    ?>
+	printf(
+		esc_html__(
+			'Messages are email notifications that are sent out by Event Espresso. Message Types are the %1$skinds%2$s of messages that get delivered.  They can be thought of as the "type" of package that is being delivered by the messenger. For example, Event Espresso comes with two Message Types attached to the Email Messenger:',
+			'event_espresso'
+		),
+		'<em>',
+		'</em>'
+	);
+	?>
 </p>
 <ul>
     <li>
@@ -24,20 +24,20 @@ 
 <p><strong><?php esc_html_e('Contexts', 'event_espresso'); ?></strong></p>
 <p>
     <?php esc_html_e(
-        'Each Message Type (kind of message) has different contexts. Contexts are dynamic and typically represent recipients (individuals receiving email notifications). For example, when the Registration Confirmation message type is triggered, it will send out a message to the following recipients: Event Administrator, Primary Registrant, and Additional Registrants. On the other hand, the Payment Message Type has only two recipients: Event Administrator and Primary Registrant.',
-        'event_espresso'
-    ); ?>
+		'Each Message Type (kind of message) has different contexts. Contexts are dynamic and typically represent recipients (individuals receiving email notifications). For example, when the Registration Confirmation message type is triggered, it will send out a message to the following recipients: Event Administrator, Primary Registrant, and Additional Registrants. On the other hand, the Payment Message Type has only two recipients: Event Administrator and Primary Registrant.',
+		'event_espresso'
+	); ?>
 </p>
 <p>
     <?php esc_html_e(
-        'A message context can be deactivated by removing a recipient from the "TO" field. This will set the field to blank and you can save changes. Deactivated message contexts will appear in grey when viewed in the Messages Overview tab. To re-activate a message context, go to that message context and setup a recipient (using one of the available shortcodes) and save changes. This will reactivate the message context and it will appear as blue in the Messages Overview tab.',
-        'event_espresso'
-    ); ?>
+		'A message context can be deactivated by removing a recipient from the "TO" field. This will set the field to blank and you can save changes. Deactivated message contexts will appear in grey when viewed in the Messages Overview tab. To re-activate a message context, go to that message context and setup a recipient (using one of the available shortcodes) and save changes. This will reactivate the message context and it will appear as blue in the Messages Overview tab.',
+		'event_espresso'
+	); ?>
 </p>
 <p><strong><?php esc_html_e('Activation / Deactivation of Message Types', 'event_espresso'); ?></strong></p>
 <p>
     <?php esc_html_e(
-        'When a new install of Event Espresso is activated, all message types will be activated except for those for Cancelled and Declined registrations. The message types for Cancelled and Declined registrations can be easily activated through the Settings tab for Messages. Deactivating and re-activating Event Espresso will keep the current settings saved.',
-        'event_espresso'
-    ); ?>
+		'When a new install of Event Espresso is activated, all message types will be activated except for those for Cancelled and Declined registrations. The message types for Cancelled and Declined registrations can be easily activated through the Settings tab for Messages. Deactivating and re-activating Event Espresso will keep the current settings saved.',
+		'event_espresso'
+	); ?>
 </p>

admin_pages/payments/help_tabs/payment_methods_overview.help_tab.php

Spacing +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
                 'The URL of the button image for this payment method in the registration process. You may use any uploaded image on your website (click %s next to the field to select). If left blank, the default button image will be used.',
                 'event_espresso'
             ),
-            '<img src="' . admin_url('images/media-button-image.gif') . '">'
+            '<img src="'.admin_url('images/media-button-image.gif').'">'
         );
         ?>
     </li>

Indentation +37 added lines, -37 removed lines

@@ -12,62 +12,62 @@ 
         <strong><?php esc_html_e('Name', 'event_espresso'); ?></strong>
         <br>
         <?php esc_html_e(
-            'The name of the payment method as customers see it in the registration form, in emails, in receipts, etc.',
-            'event_espresso'
-        ); ?>
+			'The name of the payment method as customers see it in the registration form, in emails, in receipts, etc.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Description', 'event_espresso'); ?></strong>
         <br />
         <?php esc_html_e(
-            'The description of how to use the payment method as customers will see it. This is mostly only seen during registration.',
-            'event_espresso'
-        ); ?>
+			'The description of how to use the payment method as customers will see it. This is mostly only seen during registration.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Admin-Only Name', 'event_espresso'); ?></strong>
         <br />
         <?php esc_html_e(
-            'The name of the payment method as seen internally by site administrators and staff.',
-            'event_espresso'
-        ); ?>
+			'The name of the payment method as seen internally by site administrators and staff.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Admin-Only Description', 'event_espresso'); ?></strong>
         <br />
         <?php esc_html_e(
-            'The description of the payment method as seen internally by site administrators and staff.',
-            'event_espresso'
-        ); ?>
+			'The description of the payment method as seen internally by site administrators and staff.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Debug (sandbox) Mode', 'event_espresso'); ?></strong>
         <br />
         <?php esc_html_e(
-            'Many payment methods have a debug/sandbox mode where payments are not processed but are only simulated. This is helpful when setup and debugging.',
-            'event_espresso'
-        ); ?>
+			'Many payment methods have a debug/sandbox mode where payments are not processed but are only simulated. This is helpful when setup and debugging.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Open by Default', 'event_espresso'); ?></strong>
         <br />
         <?php esc_html_e(
-            'If checked, this payment method will be selected by default (assuming no other valid payment methods are also marked as open by default.)',
-            'event_espresso'
-        ); ?>
+			'If checked, this payment method will be selected by default (assuming no other valid payment methods are also marked as open by default.)',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Button URL', 'event_espresso'); ?></strong>
         <br />
         <?php
-        printf(
-            esc_html__(
-                'The URL of the button image for this payment method in the registration process. You may use any uploaded image on your website (click %s next to the field to select). If left blank, the default button image will be used.',
-                'event_espresso'
-            ),
-            '<img src="' . admin_url('images/media-button-image.gif') . '">'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'The URL of the button image for this payment method in the registration process. You may use any uploaded image on your website (click %s next to the field to select). If left blank, the default button image will be used.',
+				'event_espresso'
+			),
+			'<img src="' . admin_url('images/media-button-image.gif') . '">'
+		);
+		?>
     </li>
     <li>
         <strong><?php esc_html_e('Usable From', 'event_espresso'); ?></strong>
@@ -76,15 +76,15 @@ 
         <ul>
             <li>
                 <?php esc_html_e(
-                    'Front-end Registration Page: the payment method will appear as an option during the normal registration process to customers and they can use it to process payments.',
-                    'event_espresso'
-                ); ?>
+					'Front-end Registration Page: the payment method will appear as an option during the normal registration process to customers and they can use it to process payments.',
+					'event_espresso'
+				); ?>
             </li>
             <li>
                 <?php esc_html_e(
-                    'Admin Registration Page: when recording payments made from the transaction admin page, the payment method will appear as an option. Note: currently payments can only be RECORDED from the admin, they cannot be PROCESSED.',
-                    'event_espresso'
-                ); ?>
+					'Admin Registration Page: when recording payments made from the transaction admin page, the payment method will appear as an option. Note: currently payments can only be RECORDED from the admin, they cannot be PROCESSED.',
+					'event_espresso'
+				); ?>
             </li>
         </ul>
     </li>
@@ -92,14 +92,14 @@ 
 <strong><?php esc_html_e('Recommendations', 'event_espresso'); ?></strong>
 <br />
 <?php esc_html_e(
-    'To learn more about the options on this page, take a look at the different tabs that appear on the left side of the page.',
-    'event_espresso'
+	'To learn more about the options on this page, take a look at the different tabs that appear on the left side of the page.',
+	'event_espresso'
 ); ?>
 <p>
     <strong><?php esc_html_e('Screen Options', 'event_espresso'); ?></strong>
     <br />
     <?php esc_html_e(
-        'You can customize the information that is shown on this page by toggling the Screen Options tab. Then you can add or remove checkmarks to hide or show certain content.',
-        'event_espresso'
-    ); ?>
+		'You can customize the information that is shown on this page by toggling the Screen Options tab. Then you can add or remove checkmarks to hide or show certain content.',
+		'event_espresso'
+	); ?>
 </p>

core/domain/entities/routing/data_nodes/core/SitePermissions.php

Indentation +27 added lines, -27 removed lines

@@ -8,31 +8,31 @@
 
 class SitePermissions extends JsonDataNode
 {
-    const NODE_NAME = 'sitePermissions';
-
-    /**
-     * @var FeatureFlags
-     */
-    private $feature_flags;
-
-
-    /**
-     * @param FeatureFlags          $feature_flags
-     * @param JsonDataNodeValidator $validator
-     */
-    public function __construct(FeatureFlags $feature_flags, JsonDataNodeValidator $validator)
-    {
-        $this->feature_flags = $feature_flags;
-        parent::__construct($validator);
-        $this->setNodeName(SitePermissions::NODE_NAME);
-    }
-
-
-    /**
-     * @inheritDoc
-     */
-    public function initialize()
-    {
-        $this->setDataArray($this->feature_flags->getAllowedFeatures());
-    }
+	const NODE_NAME = 'sitePermissions';
+
+	/**
+	 * @var FeatureFlags
+	 */
+	private $feature_flags;
+
+
+	/**
+	 * @param FeatureFlags          $feature_flags
+	 * @param JsonDataNodeValidator $validator
+	 */
+	public function __construct(FeatureFlags $feature_flags, JsonDataNodeValidator $validator)
+	{
+		$this->feature_flags = $feature_flags;
+		parent::__construct($validator);
+		$this->setNodeName(SitePermissions::NODE_NAME);
+	}
+
+
+	/**
+	 * @inheritDoc
+	 */
+	public function initialize()
+	{
+		$this->setDataArray($this->feature_flags->getAllowedFeatures());
+	}
 }

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 +836 added lines, -836 removed lines

@@ -16,840 +16,840 @@
  */
 class EEM_Datetime extends EEM_Soft_Delete_Base
 {
-    protected static ?EEM_Datetime $_instance = null;
-
-
-    /**
-     * 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;
-    }
+	protected static ?EEM_Datetime $_instance = null;
+
+
+	/**
+	 * 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);
+	}
 }