eventespresso / event-espresso-core

core/domain/services/capabilities/PublicCapabilities.php

Indentation +7 added lines, -7 removed lines

@@ -20,13 +20,13 @@
 {
 
 
-    /**
-     * @return string
-     */
-    public function capability()
-    {
-        return '';
-    }
+	/**
+	 * @return string
+	 */
+	public function capability()
+	{
+		return '';
+	}
 
 
 }

modules/gateways/Invoice/lib/invoice_functions.php

Spacing +4 added lines, -4 removed lines

@@ -8,9 +8,9 @@ 
  * @param $class_file
  * @return array
  */
-function espresso_invoice_template_files( $class_file) {
+function espresso_invoice_template_files($class_file) {
 	// read our template dir and build an array of files
-	$dhandle = opendir(dirname($class_file) . '/lib/templates/css/'); //If the template files have been moved to the uploads folder
+	$dhandle = opendir(dirname($class_file).'/lib/templates/css/'); //If the template files have been moved to the uploads folder
 	//} else return FALSE;
 
 	$files = array();
@@ -50,8 +50,8 @@ 
  * @param string $selected
  * @return string
  */
-function espresso_invoice_is_selected( $input_item, $selected='') {
-	if ( $input_item === $selected ) {
+function espresso_invoice_is_selected($input_item, $selected = '') {
+	if ($input_item === $selected) {
 		return 'selected="selected"';
 	} else {
 		return '';

admin_pages/registrations/EE_Registrations_List_Table.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -227,7 +227,7 @@
      *    _get_table_filters
      *
      * @access protected
-     * @return array
+     * @return string[]
      */
     protected function _get_table_filters()
     {

Indentation +965 added lines, -965 removed lines

@@ -24,1046 +24,1046 @@
 {
 
 
-    /**
-     * @var array
-     */
-    private $_status;
+	/**
+	 * @var array
+	 */
+	private $_status;
 
 
-    /**
-     * An array of transaction details for the related transaction to the registration being processed.
-     * This is set via the _set_related_details method.
-     *
-     * @var array
-     */
-    protected $_transaction_details = array();
+	/**
+	 * An array of transaction details for the related transaction to the registration being processed.
+	 * This is set via the _set_related_details method.
+	 *
+	 * @var array
+	 */
+	protected $_transaction_details = array();
 
 
-    /**
-     * An array of event details for the related event to the registration being processed.
-     * This is set via the _set_related_details method.
-     *
-     * @var array
-     */
-    protected $_event_details = array();
+	/**
+	 * An array of event details for the related event to the registration being processed.
+	 * This is set via the _set_related_details method.
+	 *
+	 * @var array
+	 */
+	protected $_event_details = array();
 
 
-    /**
-     * @param \Registrations_Admin_Page $admin_page
-     */
-    public function __construct(Registrations_Admin_Page $admin_page)
-    {
-        if (! empty($_GET['event_id'])) {
-            $extra_query_args = array();
-            foreach ($admin_page->get_views() as $key => $view_details) {
-                $extra_query_args[ $view_details['slug'] ] = array('event_id' => $_GET['event_id']);
-            }
-            $this->_views = $admin_page->get_list_table_view_RLs($extra_query_args);
-        }
-        parent::__construct($admin_page);
-        $this->_status = $this->_admin_page->get_registration_status_array();
-    }
+	/**
+	 * @param \Registrations_Admin_Page $admin_page
+	 */
+	public function __construct(Registrations_Admin_Page $admin_page)
+	{
+		if (! empty($_GET['event_id'])) {
+			$extra_query_args = array();
+			foreach ($admin_page->get_views() as $key => $view_details) {
+				$extra_query_args[ $view_details['slug'] ] = array('event_id' => $_GET['event_id']);
+			}
+			$this->_views = $admin_page->get_list_table_view_RLs($extra_query_args);
+		}
+		parent::__construct($admin_page);
+		$this->_status = $this->_admin_page->get_registration_status_array();
+	}
 
 
-    /**
-     *    _setup_data
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->_admin_page->get_registrations($this->_per_page);
-        $this->_all_data_count = $this->_admin_page->get_registrations($this->_per_page, true, false, false);
-    }
+	/**
+	 *    _setup_data
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->_admin_page->get_registrations($this->_per_page);
+		$this->_all_data_count = $this->_admin_page->get_registrations($this->_per_page, true, false, false);
+	}
 
 
-    /**
-     *    _set_properties
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => __('registration', 'event_espresso'),
-            'plural'   => __('registrations', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-        $ID_column_name = __('ID', 'event_espresso');
-        $ID_column_name .= ' : <span class="show-on-mobile-view-only" style="float:none">';
-        $ID_column_name .= __('Registrant Name', 'event_espresso');
-        $ID_column_name .= '</span> ';
-        if (isset($_GET['event_id'])) {
-            $this->_columns = array(
-                'cb'               => '<input type="checkbox" />', // Render a checkbox instead of text
-                '_REG_ID'          => $ID_column_name,
-                'ATT_fname'        => __('Name', 'event_espresso'),
-                'ATT_email'        => __('Email', 'event_espresso'),
-                '_REG_date'        => __('Reg Date', 'event_espresso'),
-                'PRC_amount'       => __('TKT Price', 'event_espresso'),
-                '_REG_final_price' => __('Final Price', 'event_espresso'),
-                'TXN_total'        => __('Total Txn', 'event_espresso'),
-                'TXN_paid'         => __('Paid', 'event_espresso'),
-                'actions'          => __('Actions', 'event_espresso'),
-            );
-            $this->_bottom_buttons = array(
-                'report' => array(
-                    'route'         => 'registrations_report',
-                    'extra_request' => array(
-                        'EVT_ID'     => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null,
-                        'return_url' => urlencode("//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}"),
-                    ),
-                ),
-            );
-        } else {
-            $this->_columns = array(
-                'cb'               => '<input type="checkbox" />', // Render a checkbox instead of text
-                '_REG_ID'          => $ID_column_name,
-                'ATT_fname'        => __('Name', 'event_espresso'),
-                '_REG_date'        => __('TXN Date', 'event_espresso'),
-                'event_name'       => __('Event', 'event_espresso'),
-                'DTT_EVT_start'    => __('Event Date', 'event_espresso'),
-                '_REG_final_price' => __('Price', 'event_espresso'),
-                '_REG_paid'        => __('Paid', 'event_espresso'),
-                'actions'          => __('Actions', 'event_espresso'),
-            );
-            $this->_bottom_buttons = array(
-                'report_all' => array(
-                    'route'         => 'registrations_report',
-                    'extra_request' => array(
-                        'return_url' => urlencode("//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}"),
-                    ),
-                ),
-            );
-        }
-        $this->_bottom_buttons['report_filtered'] = array(
-            'route'         => 'registrations_report',
-            'extra_request' => array(
-                'use_filters' => true,
-                'return_url'  => urlencode("//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}"),
-            ),
-        );
-        $filters = array_diff_key(
-            $this->_req_data,
-            array_flip(
-                array(
-                    'page',
-                    'action',
-                    'default_nonce',
-                )
-            )
-        );
-        if (!empty($filters)) {
-            $this->_bottom_buttons['report_filtered']['extra_request']['filters'] = $filters;
-        }
-        $this->_primary_column = '_REG_ID';
-        $this->_sortable_columns = array(
-            '_REG_date'     => array('_REG_date' => true),   // true means its already sorted
-            /**
-             * Allows users to change the default sort if they wish.
-             * Returning a falsey on this filter will result in the default sort to be by firstname rather than last
-             * name.
-             */
-            'ATT_fname'     => array(
-                'FHEE__EE_Registrations_List_Table___set_properties__default_sort_by_registration_last_name',
-                true,
-                $this,
-            )
-                ? array('ATT_lname' => false)
-                : array('ATT_fname' => false),
-            'event_name'    => array('event_name' => false),
-            'DTT_EVT_start' => array('DTT_EVT_start' => false),
-            '_REG_ID'       => array('_REG_ID' => false),
-        );
-        $this->_hidden_columns = array();
-    }
+	/**
+	 *    _set_properties
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => __('registration', 'event_espresso'),
+			'plural'   => __('registrations', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+		$ID_column_name = __('ID', 'event_espresso');
+		$ID_column_name .= ' : <span class="show-on-mobile-view-only" style="float:none">';
+		$ID_column_name .= __('Registrant Name', 'event_espresso');
+		$ID_column_name .= '</span> ';
+		if (isset($_GET['event_id'])) {
+			$this->_columns = array(
+				'cb'               => '<input type="checkbox" />', // Render a checkbox instead of text
+				'_REG_ID'          => $ID_column_name,
+				'ATT_fname'        => __('Name', 'event_espresso'),
+				'ATT_email'        => __('Email', 'event_espresso'),
+				'_REG_date'        => __('Reg Date', 'event_espresso'),
+				'PRC_amount'       => __('TKT Price', 'event_espresso'),
+				'_REG_final_price' => __('Final Price', 'event_espresso'),
+				'TXN_total'        => __('Total Txn', 'event_espresso'),
+				'TXN_paid'         => __('Paid', 'event_espresso'),
+				'actions'          => __('Actions', 'event_espresso'),
+			);
+			$this->_bottom_buttons = array(
+				'report' => array(
+					'route'         => 'registrations_report',
+					'extra_request' => array(
+						'EVT_ID'     => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null,
+						'return_url' => urlencode("//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}"),
+					),
+				),
+			);
+		} else {
+			$this->_columns = array(
+				'cb'               => '<input type="checkbox" />', // Render a checkbox instead of text
+				'_REG_ID'          => $ID_column_name,
+				'ATT_fname'        => __('Name', 'event_espresso'),
+				'_REG_date'        => __('TXN Date', 'event_espresso'),
+				'event_name'       => __('Event', 'event_espresso'),
+				'DTT_EVT_start'    => __('Event Date', 'event_espresso'),
+				'_REG_final_price' => __('Price', 'event_espresso'),
+				'_REG_paid'        => __('Paid', 'event_espresso'),
+				'actions'          => __('Actions', 'event_espresso'),
+			);
+			$this->_bottom_buttons = array(
+				'report_all' => array(
+					'route'         => 'registrations_report',
+					'extra_request' => array(
+						'return_url' => urlencode("//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}"),
+					),
+				),
+			);
+		}
+		$this->_bottom_buttons['report_filtered'] = array(
+			'route'         => 'registrations_report',
+			'extra_request' => array(
+				'use_filters' => true,
+				'return_url'  => urlencode("//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}"),
+			),
+		);
+		$filters = array_diff_key(
+			$this->_req_data,
+			array_flip(
+				array(
+					'page',
+					'action',
+					'default_nonce',
+				)
+			)
+		);
+		if (!empty($filters)) {
+			$this->_bottom_buttons['report_filtered']['extra_request']['filters'] = $filters;
+		}
+		$this->_primary_column = '_REG_ID';
+		$this->_sortable_columns = array(
+			'_REG_date'     => array('_REG_date' => true),   // true means its already sorted
+			/**
+			 * Allows users to change the default sort if they wish.
+			 * Returning a falsey on this filter will result in the default sort to be by firstname rather than last
+			 * name.
+			 */
+			'ATT_fname'     => array(
+				'FHEE__EE_Registrations_List_Table___set_properties__default_sort_by_registration_last_name',
+				true,
+				$this,
+			)
+				? array('ATT_lname' => false)
+				: array('ATT_fname' => false),
+			'event_name'    => array('event_name' => false),
+			'DTT_EVT_start' => array('DTT_EVT_start' => false),
+			'_REG_ID'       => array('_REG_ID' => false),
+		);
+		$this->_hidden_columns = array();
+	}
 
 
-    /**
-     * This simply sets up the row class for the table rows.
-     * Allows for easier overriding of child methods for setting up sorting.
-     *
-     * @param  EE_Registration $item the current item
-     * @return string
-     */
-    protected function _get_row_class($item)
-    {
-        $class = parent::_get_row_class($item);
-        // add status class
-        $class .= ' ee-status-strip reg-status-' . $item->status_ID();
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
+	/**
+	 * This simply sets up the row class for the table rows.
+	 * Allows for easier overriding of child methods for setting up sorting.
+	 *
+	 * @param  EE_Registration $item the current item
+	 * @return string
+	 */
+	protected function _get_row_class($item)
+	{
+		$class = parent::_get_row_class($item);
+		// add status class
+		$class .= ' ee-status-strip reg-status-' . $item->status_ID();
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
 
 
-    /**
-     * Set the $_transaction_details property if not set yet.
-     *
-     * @param EE_Registration $registration
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _set_related_details(EE_Registration $registration)
-    {
-        $transaction = $registration->get_first_related('Transaction');
-        $status = $transaction instanceof EE_Transaction ? $transaction->status_ID()
-            : EEM_Transaction::failed_status_code;
-        $this->_transaction_details = array(
-            'transaction' => $transaction,
-            'status'      => $status,
-            'id'          => $transaction instanceof EE_Transaction ? $transaction->ID() : 0,
-            'title_attr'  => sprintf(
-                __('View Transaction Details (%s)', 'event_espresso'),
-                EEH_Template::pretty_status($status, false, 'sentence')
-            ),
-        );
-        try {
-            $event = $registration->event();
-        } catch (EntityNotFoundException $e) {
-            $event = null;
-        }
-        $status = $event instanceof EE_Event ? $event->get_active_status() : EE_Datetime::inactive;
-        $this->_event_details = array(
-            'event'      => $event,
-            'status'     => $status,
-            'id'         => $event instanceof EE_Event ? $event->ID() : 0,
-            'title_attr' => sprintf(
-                __('Edit Event (%s)', 'event_espresso'),
-                EEH_Template::pretty_status($status, false, 'sentence')
-            ),
-        );
-    }
+	/**
+	 * Set the $_transaction_details property if not set yet.
+	 *
+	 * @param EE_Registration $registration
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _set_related_details(EE_Registration $registration)
+	{
+		$transaction = $registration->get_first_related('Transaction');
+		$status = $transaction instanceof EE_Transaction ? $transaction->status_ID()
+			: EEM_Transaction::failed_status_code;
+		$this->_transaction_details = array(
+			'transaction' => $transaction,
+			'status'      => $status,
+			'id'          => $transaction instanceof EE_Transaction ? $transaction->ID() : 0,
+			'title_attr'  => sprintf(
+				__('View Transaction Details (%s)', 'event_espresso'),
+				EEH_Template::pretty_status($status, false, 'sentence')
+			),
+		);
+		try {
+			$event = $registration->event();
+		} catch (EntityNotFoundException $e) {
+			$event = null;
+		}
+		$status = $event instanceof EE_Event ? $event->get_active_status() : EE_Datetime::inactive;
+		$this->_event_details = array(
+			'event'      => $event,
+			'status'     => $status,
+			'id'         => $event instanceof EE_Event ? $event->ID() : 0,
+			'title_attr' => sprintf(
+				__('Edit Event (%s)', 'event_espresso'),
+				EEH_Template::pretty_status($status, false, 'sentence')
+			),
+		);
+	}
 
 
-    /**
-     *    _get_table_filters
-     *
-     * @access protected
-     * @return array
-     */
-    protected function _get_table_filters()
-    {
-        $filters = array();
-        // todo we're currently using old functions here. We need to move things into the Events_Admin_Page() class as
-        // methods.
-        $cur_date = isset($this->_req_data['month_range']) ? $this->_req_data['month_range'] : '';
-        $cur_category = isset($this->_req_data['EVT_CAT']) ? $this->_req_data['EVT_CAT'] : -1;
-        $reg_status = isset($this->_req_data['_reg_status']) ? $this->_req_data['_reg_status'] : '';
-        $filters[] = EEH_Form_Fields::generate_registration_months_dropdown($cur_date, $reg_status, $cur_category);
-        $filters[] = EEH_Form_Fields::generate_event_category_dropdown($cur_category);
-        $status = array();
-        $status[] = array('id' => 0, 'text' => __('Select Status', 'event_espresso'));
-        foreach ($this->_status as $key => $value) {
-            $status[] = array('id' => $key, 'text' => $value);
-        }
-        if ($this->_view !== 'incomplete') {
-            $filters[] = EEH_Form_Fields::select_input(
-                '_reg_status',
-                $status,
-                isset($this->_req_data['_reg_status']) ? strtoupper(sanitize_key($this->_req_data['_reg_status']))
-                    : ''
-            );
-        }
-        if (isset($this->_req_data['event_id'])) {
-            $filters[] = EEH_Form_Fields::hidden_input('event_id', $this->_req_data['event_id'], 'reg_event_id');
-        }
-        return $filters;
-    }
+	/**
+	 *    _get_table_filters
+	 *
+	 * @access protected
+	 * @return array
+	 */
+	protected function _get_table_filters()
+	{
+		$filters = array();
+		// todo we're currently using old functions here. We need to move things into the Events_Admin_Page() class as
+		// methods.
+		$cur_date = isset($this->_req_data['month_range']) ? $this->_req_data['month_range'] : '';
+		$cur_category = isset($this->_req_data['EVT_CAT']) ? $this->_req_data['EVT_CAT'] : -1;
+		$reg_status = isset($this->_req_data['_reg_status']) ? $this->_req_data['_reg_status'] : '';
+		$filters[] = EEH_Form_Fields::generate_registration_months_dropdown($cur_date, $reg_status, $cur_category);
+		$filters[] = EEH_Form_Fields::generate_event_category_dropdown($cur_category);
+		$status = array();
+		$status[] = array('id' => 0, 'text' => __('Select Status', 'event_espresso'));
+		foreach ($this->_status as $key => $value) {
+			$status[] = array('id' => $key, 'text' => $value);
+		}
+		if ($this->_view !== 'incomplete') {
+			$filters[] = EEH_Form_Fields::select_input(
+				'_reg_status',
+				$status,
+				isset($this->_req_data['_reg_status']) ? strtoupper(sanitize_key($this->_req_data['_reg_status']))
+					: ''
+			);
+		}
+		if (isset($this->_req_data['event_id'])) {
+			$filters[] = EEH_Form_Fields::hidden_input('event_id', $this->_req_data['event_id'], 'reg_event_id');
+		}
+		return $filters;
+	}
 
 
-    /**
-     *    _add_view_counts
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_total_registrations();
-        $this->_views['month']['count'] = $this->_total_registrations_this_month();
-        $this->_views['today']['count'] = $this->_total_registrations_today();
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_registrations',
-            'espresso_registrations_trash_registrations'
-        )) {
-            $this->_views['incomplete']['count'] = $this->_total_registrations('incomplete');
-            $this->_views['trash']['count'] = $this->_total_registrations('trash');
-        }
-    }
+	/**
+	 *    _add_view_counts
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_total_registrations();
+		$this->_views['month']['count'] = $this->_total_registrations_this_month();
+		$this->_views['today']['count'] = $this->_total_registrations_today();
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_registrations',
+			'espresso_registrations_trash_registrations'
+		)) {
+			$this->_views['incomplete']['count'] = $this->_total_registrations('incomplete');
+			$this->_views['trash']['count'] = $this->_total_registrations('trash');
+		}
+	}
 
 
-    /**
-     * _total_registrations
-     *
-     * @access protected
-     * @param string $view
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _total_registrations($view = '')
-    {
-        $_where = array();
-        $EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
-        if ($EVT_ID) {
-            $_where['EVT_ID'] = $EVT_ID;
-        }
-        switch ($view) {
-            case 'trash':
-                return EEM_Registration::instance()->count_deleted(array($_where));
-                break;
-            case 'incomplete':
-                $_where['STS_ID'] = EEM_Registration::status_id_incomplete;
-                break;
-            default:
-                $_where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
-        }
-        return EEM_Registration::instance()->count(array($_where));
-    }
+	/**
+	 * _total_registrations
+	 *
+	 * @access protected
+	 * @param string $view
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _total_registrations($view = '')
+	{
+		$_where = array();
+		$EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
+		if ($EVT_ID) {
+			$_where['EVT_ID'] = $EVT_ID;
+		}
+		switch ($view) {
+			case 'trash':
+				return EEM_Registration::instance()->count_deleted(array($_where));
+				break;
+			case 'incomplete':
+				$_where['STS_ID'] = EEM_Registration::status_id_incomplete;
+				break;
+			default:
+				$_where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
+		}
+		return EEM_Registration::instance()->count(array($_where));
+	}
 
 
-    /**
-     * _total_registrations_this_month
-     *
-     * @access protected
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _total_registrations_this_month()
-    {
-        $EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
-        $_where = $EVT_ID ? array('EVT_ID' => $EVT_ID) : array();
-        $this_year_r = date('Y', current_time('timestamp'));
-        $time_start = ' 00:00:00';
-        $time_end = ' 23:59:59';
-        $this_month_r = date('m', current_time('timestamp'));
-        $days_this_month = date('t', current_time('timestamp'));
-        // setup date query.
-        $beginning_string = EEM_Registration::instance()->convert_datetime_for_query(
-            'REG_date',
-            $this_year_r . '-' . $this_month_r . '-01' . ' ' . $time_start,
-            'Y-m-d H:i:s'
-        );
-        $end_string = EEM_Registration::instance()->convert_datetime_for_query(
-            'REG_date',
-            $this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' ' . $time_end,
-            'Y-m-d H:i:s'
-        );
-        $_where['REG_date'] = array(
-            'BETWEEN',
-            array(
-                $beginning_string,
-                $end_string,
-            ),
-        );
-        $_where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
-        return EEM_Registration::instance()->count(array($_where));
-    }
+	/**
+	 * _total_registrations_this_month
+	 *
+	 * @access protected
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _total_registrations_this_month()
+	{
+		$EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
+		$_where = $EVT_ID ? array('EVT_ID' => $EVT_ID) : array();
+		$this_year_r = date('Y', current_time('timestamp'));
+		$time_start = ' 00:00:00';
+		$time_end = ' 23:59:59';
+		$this_month_r = date('m', current_time('timestamp'));
+		$days_this_month = date('t', current_time('timestamp'));
+		// setup date query.
+		$beginning_string = EEM_Registration::instance()->convert_datetime_for_query(
+			'REG_date',
+			$this_year_r . '-' . $this_month_r . '-01' . ' ' . $time_start,
+			'Y-m-d H:i:s'
+		);
+		$end_string = EEM_Registration::instance()->convert_datetime_for_query(
+			'REG_date',
+			$this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' ' . $time_end,
+			'Y-m-d H:i:s'
+		);
+		$_where['REG_date'] = array(
+			'BETWEEN',
+			array(
+				$beginning_string,
+				$end_string,
+			),
+		);
+		$_where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
+		return EEM_Registration::instance()->count(array($_where));
+	}
 
 
-    /**
-     * _total_registrations_today
-     *
-     * @access protected
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _total_registrations_today()
-    {
-        $EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
-        $_where = $EVT_ID ? array('EVT_ID' => $EVT_ID) : array();
-        $current_date = date('Y-m-d', current_time('timestamp'));
-        $time_start = ' 00:00:00';
-        $time_end = ' 23:59:59';
-        $_where['REG_date'] = array(
-            'BETWEEN',
-            array(
-                EEM_Registration::instance()->convert_datetime_for_query(
-                    'REG_date',
-                    $current_date . $time_start,
-                    'Y-m-d H:i:s'
-                ),
-                EEM_Registration::instance()->convert_datetime_for_query(
-                    'REG_date',
-                    $current_date . $time_end,
-                    'Y-m-d H:i:s'
-                ),
-            ),
-        );
-        $_where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
-        return EEM_Registration::instance()->count(array($_where));
-    }
+	/**
+	 * _total_registrations_today
+	 *
+	 * @access protected
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _total_registrations_today()
+	{
+		$EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
+		$_where = $EVT_ID ? array('EVT_ID' => $EVT_ID) : array();
+		$current_date = date('Y-m-d', current_time('timestamp'));
+		$time_start = ' 00:00:00';
+		$time_end = ' 23:59:59';
+		$_where['REG_date'] = array(
+			'BETWEEN',
+			array(
+				EEM_Registration::instance()->convert_datetime_for_query(
+					'REG_date',
+					$current_date . $time_start,
+					'Y-m-d H:i:s'
+				),
+				EEM_Registration::instance()->convert_datetime_for_query(
+					'REG_date',
+					$current_date . $time_end,
+					'Y-m-d H:i:s'
+				),
+			),
+		);
+		$_where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
+		return EEM_Registration::instance()->count(array($_where));
+	}
 
 
-    /**
-     * column_cb
-     *
-     * @access public
-     * @param \EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_cb($item)
-    {
-        /** checkbox/lock **/
-        $transaction = $item->get_first_related('Transaction');
-        $payment_count = $transaction instanceof EE_Transaction
-            ? $transaction->count_related('Payment')
-            : 0;
-        return $payment_count > 0
-               || ! EE_Registry::instance()->CAP->current_user_can(
-                   'ee_edit_registration',
-                   'registration_list_table_checkbox_input',
-                   $item->ID()
-               )
-            ? sprintf('<input type="checkbox" name="_REG_ID[]" value="%1$d" />', $item->ID())
-              . '<span class="ee-lock-icon"></span>'
-            : sprintf('<input type="checkbox" name="_REG_ID[]" value="%1$d" />', $item->ID());
-    }
+	/**
+	 * column_cb
+	 *
+	 * @access public
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_cb($item)
+	{
+		/** checkbox/lock **/
+		$transaction = $item->get_first_related('Transaction');
+		$payment_count = $transaction instanceof EE_Transaction
+			? $transaction->count_related('Payment')
+			: 0;
+		return $payment_count > 0
+			   || ! EE_Registry::instance()->CAP->current_user_can(
+				   'ee_edit_registration',
+				   'registration_list_table_checkbox_input',
+				   $item->ID()
+			   )
+			? sprintf('<input type="checkbox" name="_REG_ID[]" value="%1$d" />', $item->ID())
+			  . '<span class="ee-lock-icon"></span>'
+			: sprintf('<input type="checkbox" name="_REG_ID[]" value="%1$d" />', $item->ID());
+	}
 
 
-    /**
-     * column__REG_ID
-     *
-     * @access public
-     * @param \EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column__REG_ID(EE_Registration $item)
-    {
-        $attendee = $item->attendee();
-        $content = $item->ID();
-        $content .= '<div class="show-on-mobile-view-only">';
-        $content .= '<br>';
-        $content .= $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
-        $content .= '&nbsp;' . sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
-        $content .= '<br>' . sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
-        $content .= '</div>';
-        return $content;
-    }
+	/**
+	 * column__REG_ID
+	 *
+	 * @access public
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column__REG_ID(EE_Registration $item)
+	{
+		$attendee = $item->attendee();
+		$content = $item->ID();
+		$content .= '<div class="show-on-mobile-view-only">';
+		$content .= '<br>';
+		$content .= $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
+		$content .= '&nbsp;' . sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
+		$content .= '<br>' . sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
+		$content .= '</div>';
+		return $content;
+	}
 
 
-    /**
-     * column__REG_date
-     *
-     * @access public
-     * @param \EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column__REG_date(EE_Registration $item)
-    {
-        $this->_set_related_details($item);
-        // Build row actions
-        $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'view_transaction',
-                'TXN_ID' => $this->_transaction_details['id'],
-            ),
-            TXN_ADMIN_URL
-        );
-        $view_link = EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_transaction',
-            'espresso_transactions_view_transaction'
-        )
-            ? '<a class="ee-status-color-'
-              . $this->_transaction_details['status']
-              . '" href="'
-              . $view_lnk_url
-              . '" title="'
-              . esc_attr($this->_transaction_details['title_attr'])
-              . '">'
-              . $item->get_i18n_datetime('REG_date')
-              . '</a>' : $item->get_i18n_datetime('REG_date');
-        $view_link .= '<br><span class="ee-status-text-small">'
-                      . EEH_Template::pretty_status($this->_transaction_details['status'], false, 'sentence')
-                      . '</span>';
-        return $view_link;
-    }
+	/**
+	 * column__REG_date
+	 *
+	 * @access public
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column__REG_date(EE_Registration $item)
+	{
+		$this->_set_related_details($item);
+		// Build row actions
+		$view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'view_transaction',
+				'TXN_ID' => $this->_transaction_details['id'],
+			),
+			TXN_ADMIN_URL
+		);
+		$view_link = EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_transaction',
+			'espresso_transactions_view_transaction'
+		)
+			? '<a class="ee-status-color-'
+			  . $this->_transaction_details['status']
+			  . '" href="'
+			  . $view_lnk_url
+			  . '" title="'
+			  . esc_attr($this->_transaction_details['title_attr'])
+			  . '">'
+			  . $item->get_i18n_datetime('REG_date')
+			  . '</a>' : $item->get_i18n_datetime('REG_date');
+		$view_link .= '<br><span class="ee-status-text-small">'
+					  . EEH_Template::pretty_status($this->_transaction_details['status'], false, 'sentence')
+					  . '</span>';
+		return $view_link;
+	}
 
 
-    /**
-     * column_event_name
-     *
-     * @access public
-     * @param \EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_event_name(EE_Registration $item)
-    {
-        $this->_set_related_details($item);
-        // page=espresso_events&action=edit_event&EVT_ID=2&edit_event_nonce=cf3a7e5b62
-        $EVT_ID = $item->event_ID();
-        $event_name = $item->event_name();
-        $event_name = $event_name ? $event_name : __("No Associated Event", 'event_espresso');
-        $event_name = wp_trim_words($event_name, 30, '...');
-        if ($EVT_ID) {
-            $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'edit', 'post' => $EVT_ID),
-                EVENTS_ADMIN_URL
-            );
-            $edit_event = EE_Registry::instance()->CAP->current_user_can('ee_edit_event', 'edit_event', $EVT_ID)
-                ? '<a class="ee-status-color-'
-                  . $this->_event_details['status']
-                  . '" href="'
-                  . $edit_event_url
-                  . '" title="'
-                  . esc_attr($this->_event_details['title_attr'])
-                  . '">'
-                  . $event_name
-                  . '</a>' : $event_name;
-            $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(array('event_id' => $EVT_ID), REG_ADMIN_URL);
-            $actions['event_filter'] = '<a href="' . $edit_event_url . '" title="';
-            $actions['event_filter'] .= sprintf(
-                esc_attr__('Filter this list to only show registrations for %s', 'event_espresso'),
-                $event_name
-            );
-            $actions['event_filter'] .= '">' . __('View Registrations', 'event_espresso') . '</a>';
-        } else {
-            $edit_event = $event_name;
-            $actions['event_filter'] = '';
-        }
-        return sprintf('%1$s %2$s', $edit_event, $this->row_actions($actions));
-    }
+	/**
+	 * column_event_name
+	 *
+	 * @access public
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_event_name(EE_Registration $item)
+	{
+		$this->_set_related_details($item);
+		// page=espresso_events&action=edit_event&EVT_ID=2&edit_event_nonce=cf3a7e5b62
+		$EVT_ID = $item->event_ID();
+		$event_name = $item->event_name();
+		$event_name = $event_name ? $event_name : __("No Associated Event", 'event_espresso');
+		$event_name = wp_trim_words($event_name, 30, '...');
+		if ($EVT_ID) {
+			$edit_event_url = EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'edit', 'post' => $EVT_ID),
+				EVENTS_ADMIN_URL
+			);
+			$edit_event = EE_Registry::instance()->CAP->current_user_can('ee_edit_event', 'edit_event', $EVT_ID)
+				? '<a class="ee-status-color-'
+				  . $this->_event_details['status']
+				  . '" href="'
+				  . $edit_event_url
+				  . '" title="'
+				  . esc_attr($this->_event_details['title_attr'])
+				  . '">'
+				  . $event_name
+				  . '</a>' : $event_name;
+			$edit_event_url = EE_Admin_Page::add_query_args_and_nonce(array('event_id' => $EVT_ID), REG_ADMIN_URL);
+			$actions['event_filter'] = '<a href="' . $edit_event_url . '" title="';
+			$actions['event_filter'] .= sprintf(
+				esc_attr__('Filter this list to only show registrations for %s', 'event_espresso'),
+				$event_name
+			);
+			$actions['event_filter'] .= '">' . __('View Registrations', 'event_espresso') . '</a>';
+		} else {
+			$edit_event = $event_name;
+			$actions['event_filter'] = '';
+		}
+		return sprintf('%1$s %2$s', $edit_event, $this->row_actions($actions));
+	}
 
 
-    /**
-     * column_DTT_EVT_start
-     *
-     * @access public
-     * @param \EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_DTT_EVT_start(EE_Registration $item)
-    {
-        $datetime_strings = array();
-        $ticket = $item->ticket(true);
-        if ($ticket instanceof EE_Ticket) {
-            $remove_defaults = array('default_where_conditions' => 'none');
-            $datetimes = $ticket->datetimes($remove_defaults);
-            foreach ($datetimes as $datetime) {
-                $datetime_strings[] = $datetime->get_i18n_datetime('DTT_EVT_start');
-            }
-            return $this->generateDisplayForDatetimes($datetime_strings);
-        }
-        return __('There is no ticket on this registration', 'event_espresso');
-    }
+	/**
+	 * column_DTT_EVT_start
+	 *
+	 * @access public
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_DTT_EVT_start(EE_Registration $item)
+	{
+		$datetime_strings = array();
+		$ticket = $item->ticket(true);
+		if ($ticket instanceof EE_Ticket) {
+			$remove_defaults = array('default_where_conditions' => 'none');
+			$datetimes = $ticket->datetimes($remove_defaults);
+			foreach ($datetimes as $datetime) {
+				$datetime_strings[] = $datetime->get_i18n_datetime('DTT_EVT_start');
+			}
+			return $this->generateDisplayForDatetimes($datetime_strings);
+		}
+		return __('There is no ticket on this registration', 'event_espresso');
+	}
 
 
-    /**
-     * Receives an array of datetime strings to display and converts them to the html container for the column.
-     *
-     * @param array $datetime_strings
-     * @return string
-     */
-    public function generateDisplayForDateTimes(array $datetime_strings)
-    {
-        $content = '<div class="ee-registration-event-datetimes-container">';
-        $expand_toggle = count($datetime_strings) > 1
-            ? ' <span title="' . esc_attr__('Click to view all dates', 'event_espresso')
-              . '" class="ee-js ee-more-datetimes-toggle dashicons dashicons-plus"></span>'
-            : '';
-        // get first item for initial visibility
-        $content .= '<div class="left">' . array_shift($datetime_strings) . '</div>';
-        $content .= $expand_toggle;
-        if ($datetime_strings) {
-            $content .= '<div style="clear:both"></div>';
-            $content .= '<div class="ee-registration-event-datetimes-container more-items hidden">';
-            $content .= implode("<br />", $datetime_strings);
-            $content .= '</div>';
-        }
-        $content .= '</div>';
-        return $content;
-    }
+	/**
+	 * Receives an array of datetime strings to display and converts them to the html container for the column.
+	 *
+	 * @param array $datetime_strings
+	 * @return string
+	 */
+	public function generateDisplayForDateTimes(array $datetime_strings)
+	{
+		$content = '<div class="ee-registration-event-datetimes-container">';
+		$expand_toggle = count($datetime_strings) > 1
+			? ' <span title="' . esc_attr__('Click to view all dates', 'event_espresso')
+			  . '" class="ee-js ee-more-datetimes-toggle dashicons dashicons-plus"></span>'
+			: '';
+		// get first item for initial visibility
+		$content .= '<div class="left">' . array_shift($datetime_strings) . '</div>';
+		$content .= $expand_toggle;
+		if ($datetime_strings) {
+			$content .= '<div style="clear:both"></div>';
+			$content .= '<div class="ee-registration-event-datetimes-container more-items hidden">';
+			$content .= implode("<br />", $datetime_strings);
+			$content .= '</div>';
+		}
+		$content .= '</div>';
+		return $content;
+	}
 
 
-    /**
-     * column_ATT_fname
-     *
-     * @access public
-     * @param \EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_ATT_fname(EE_Registration $item)
-    {
-        $attendee = $item->attendee();
-        $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action'  => 'view_registration',
-                '_REG_ID' => $item->ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
-        $link = EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registration',
-            'espresso_registrations_view_registration',
-            $item->ID()
-        )
-            ? '<a href="'
-              . $edit_lnk_url
-              . '" title="'
-              . esc_attr__('View Registration Details', 'event_espresso')
-              . '">'
-              . $attendee_name
-              . '</a>' : $attendee_name;
-        $link .= $item->count() === 1
-            ? '&nbsp;<sup><div class="dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8"></div></sup>' : '';
-        $t = $item->get_first_related('Transaction');
-        $payment_count = $t instanceof EE_Transaction ? $t->count_related('Payment') : 0;
-        // append group count to name
-        $link .= '&nbsp;' . sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
-        // append reg_code
-        $link .= '<br>' . sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
-        // reg status text for accessibility
-        $link .= '<br><span class="ee-status-text-small">'
-                 . EEH_Template::pretty_status($item->status_ID(), false, 'sentence')
-                 . '</span>';
-        $action = [ '_REG_ID' => $item->ID() ];
-        if (isset($this->_req_data['event_id'])) {
-            $action['event_id'] = $item->event_ID();
-        }
-        // trash/restore/delete actions
-        $actions = array();
-        if ($this->_view !== 'trash'
-            && $payment_count === 0
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_registration',
-                'espresso_registrations_trash_registrations',
-                $item->ID()
-            )) {
-            $action['action'] = 'trash_registrations';
-            $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                $action,
-                REG_ADMIN_URL
-            );
-            $actions['trash'] = '<a href="'
-                                . $trash_lnk_url
-                                . '" title="'
-                                . esc_attr__('Trash Registration', 'event_espresso')
-                                . '">' . __('Trash', 'event_espresso') . '</a>';
-        } elseif ($this->_view === 'trash') {
-            // restore registration link
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_registration',
-                'espresso_registrations_restore_registrations',
-                $item->ID()
-            )) {
-                $action['action'] = 'restore_registrations';
-                $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                    $action,
-                    REG_ADMIN_URL
-                );
-                $actions['restore'] = '<a href="'
-                                      . $restore_lnk_url
-                                      . '" title="'
-                                      . esc_attr__('Restore Registration', 'event_espresso') . '">'
-                                      . __('Restore', 'event_espresso') . '</a>';
-            }
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_registration',
-                'espresso_registrations_ee_delete_registrations',
-                $item->ID()
-            )) {
-                $action['action'] = 'delete_registrations';
-                $delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                    $action,
-                    REG_ADMIN_URL
-                );
-                $actions['delete'] = '<a href="'
-                                     . $delete_lnk_url
-                                     . '" title="'
-                                     . esc_attr__('Delete Registration Permanently', 'event_espresso')
-                                     . '">'
-                                     . __('Delete', 'event_espresso')
-                                     . '</a>';
-            }
-        }
-        return sprintf('%1$s %2$s', $link, $this->row_actions($actions));
-    }
+	/**
+	 * column_ATT_fname
+	 *
+	 * @access public
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_ATT_fname(EE_Registration $item)
+	{
+		$attendee = $item->attendee();
+		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action'  => 'view_registration',
+				'_REG_ID' => $item->ID(),
+			),
+			REG_ADMIN_URL
+		);
+		$attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
+		$link = EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registration',
+			'espresso_registrations_view_registration',
+			$item->ID()
+		)
+			? '<a href="'
+			  . $edit_lnk_url
+			  . '" title="'
+			  . esc_attr__('View Registration Details', 'event_espresso')
+			  . '">'
+			  . $attendee_name
+			  . '</a>' : $attendee_name;
+		$link .= $item->count() === 1
+			? '&nbsp;<sup><div class="dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8"></div></sup>' : '';
+		$t = $item->get_first_related('Transaction');
+		$payment_count = $t instanceof EE_Transaction ? $t->count_related('Payment') : 0;
+		// append group count to name
+		$link .= '&nbsp;' . sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
+		// append reg_code
+		$link .= '<br>' . sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
+		// reg status text for accessibility
+		$link .= '<br><span class="ee-status-text-small">'
+				 . EEH_Template::pretty_status($item->status_ID(), false, 'sentence')
+				 . '</span>';
+		$action = [ '_REG_ID' => $item->ID() ];
+		if (isset($this->_req_data['event_id'])) {
+			$action['event_id'] = $item->event_ID();
+		}
+		// trash/restore/delete actions
+		$actions = array();
+		if ($this->_view !== 'trash'
+			&& $payment_count === 0
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_registration',
+				'espresso_registrations_trash_registrations',
+				$item->ID()
+			)) {
+			$action['action'] = 'trash_registrations';
+			$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+				$action,
+				REG_ADMIN_URL
+			);
+			$actions['trash'] = '<a href="'
+								. $trash_lnk_url
+								. '" title="'
+								. esc_attr__('Trash Registration', 'event_espresso')
+								. '">' . __('Trash', 'event_espresso') . '</a>';
+		} elseif ($this->_view === 'trash') {
+			// restore registration link
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_registration',
+				'espresso_registrations_restore_registrations',
+				$item->ID()
+			)) {
+				$action['action'] = 'restore_registrations';
+				$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+					$action,
+					REG_ADMIN_URL
+				);
+				$actions['restore'] = '<a href="'
+									  . $restore_lnk_url
+									  . '" title="'
+									  . esc_attr__('Restore Registration', 'event_espresso') . '">'
+									  . __('Restore', 'event_espresso') . '</a>';
+			}
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_registration',
+				'espresso_registrations_ee_delete_registrations',
+				$item->ID()
+			)) {
+				$action['action'] = 'delete_registrations';
+				$delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+					$action,
+					REG_ADMIN_URL
+				);
+				$actions['delete'] = '<a href="'
+									 . $delete_lnk_url
+									 . '" title="'
+									 . esc_attr__('Delete Registration Permanently', 'event_espresso')
+									 . '">'
+									 . __('Delete', 'event_espresso')
+									 . '</a>';
+			}
+		}
+		return sprintf('%1$s %2$s', $link, $this->row_actions($actions));
+	}
 
 
-    /**
-     * column_ATT_email
-     *
-     * @access public
-     * @param \EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_ATT_email(EE_Registration $item)
-    {
-        $attendee = $item->get_first_related('Attendee');
-        return ! $attendee instanceof EE_Attendee ? __('No attached contact record.', 'event_espresso')
-            : $attendee->email();
-    }
+	/**
+	 * column_ATT_email
+	 *
+	 * @access public
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_ATT_email(EE_Registration $item)
+	{
+		$attendee = $item->get_first_related('Attendee');
+		return ! $attendee instanceof EE_Attendee ? __('No attached contact record.', 'event_espresso')
+			: $attendee->email();
+	}
 
 
-    /**
-     * column__REG_count
-     *
-     * @access public
-     * @param \EE_Registration $item
-     * @return string
-     */
-    public function column__REG_count(EE_Registration $item)
-    {
-        return sprintf(__('%1$s / %2$s', 'event_espresso'), $item->count(), $item->group_size());
-    }
+	/**
+	 * column__REG_count
+	 *
+	 * @access public
+	 * @param \EE_Registration $item
+	 * @return string
+	 */
+	public function column__REG_count(EE_Registration $item)
+	{
+		return sprintf(__('%1$s / %2$s', 'event_espresso'), $item->count(), $item->group_size());
+	}
 
 
-    /**
-     * column_PRC_amount
-     *
-     * @access public
-     * @param \EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_PRC_amount(EE_Registration $item)
-    {
-        $ticket = $item->ticket();
-        $content = isset($_GET['event_id']) && $ticket instanceof EE_Ticket ? '<span class="TKT_name">'
-                                                                              . $ticket->name()
-                                                                              . '</span><br />' : '';
-        if ($item->final_price() > 0) {
-            $content .= '<span class="reg-pad-rght">' . $item->pretty_final_price() . '</span>';
-        } else {
-            // free event
-            $content .= '<span class="reg-overview-free-event-spn reg-pad-rght">'
-                        . __('free', 'event_espresso')
-                        . '</span>';
-        }
-        return $content;
-    }
+	/**
+	 * column_PRC_amount
+	 *
+	 * @access public
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_PRC_amount(EE_Registration $item)
+	{
+		$ticket = $item->ticket();
+		$content = isset($_GET['event_id']) && $ticket instanceof EE_Ticket ? '<span class="TKT_name">'
+																			  . $ticket->name()
+																			  . '</span><br />' : '';
+		if ($item->final_price() > 0) {
+			$content .= '<span class="reg-pad-rght">' . $item->pretty_final_price() . '</span>';
+		} else {
+			// free event
+			$content .= '<span class="reg-overview-free-event-spn reg-pad-rght">'
+						. __('free', 'event_espresso')
+						. '</span>';
+		}
+		return $content;
+	}
 
 
-    /**
-     * column__REG_final_price
-     *
-     * @access public
-     * @param \EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column__REG_final_price(EE_Registration $item)
-    {
-        $ticket = $item->ticket();
-        $content = isset($_GET['event_id']) || ! $ticket instanceof EE_Ticket
-            ? ''
-            : '<span class="TKT_name">'
-              . $ticket->name()
-              . '</span><br />';
-        $content .= '<span class="reg-pad-rght">' . $item->pretty_final_price() . '</span>';
-        return $content;
-    }
+	/**
+	 * column__REG_final_price
+	 *
+	 * @access public
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column__REG_final_price(EE_Registration $item)
+	{
+		$ticket = $item->ticket();
+		$content = isset($_GET['event_id']) || ! $ticket instanceof EE_Ticket
+			? ''
+			: '<span class="TKT_name">'
+			  . $ticket->name()
+			  . '</span><br />';
+		$content .= '<span class="reg-pad-rght">' . $item->pretty_final_price() . '</span>';
+		return $content;
+	}
 
 
-    /**
-     * column__REG_paid
-     *
-     * @access public
-     * @param \EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column__REG_paid(EE_Registration $item)
-    {
-        $payment_method = $item->payment_method();
-        $payment_method_name = $payment_method instanceof EE_Payment_Method ? $payment_method->admin_name()
-            : __('Unknown', 'event_espresso');
-        $content = '<span class="reg-pad-rght">' . $item->pretty_paid() . '</span>';
-        if ($item->paid() > 0) {
-            $content .= '<br><span class="ee-status-text-small">'
-                        . sprintf(
-                            __('...via %s', 'event_espresso'),
-                            $payment_method_name
-                        )
-                        . '</span>';
-        }
-        return $content;
-    }
+	/**
+	 * column__REG_paid
+	 *
+	 * @access public
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column__REG_paid(EE_Registration $item)
+	{
+		$payment_method = $item->payment_method();
+		$payment_method_name = $payment_method instanceof EE_Payment_Method ? $payment_method->admin_name()
+			: __('Unknown', 'event_espresso');
+		$content = '<span class="reg-pad-rght">' . $item->pretty_paid() . '</span>';
+		if ($item->paid() > 0) {
+			$content .= '<br><span class="ee-status-text-small">'
+						. sprintf(
+							__('...via %s', 'event_espresso'),
+							$payment_method_name
+						)
+						. '</span>';
+		}
+		return $content;
+	}
 
 
-    /**
-     * column_TXN_total
-     *
-     * @access public
-     * @param \EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_TXN_total(EE_Registration $item)
-    {
-        if ($item->transaction()) {
-            $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action' => 'view_transaction',
-                    'TXN_ID' => $item->transaction_ID(),
-                ),
-                TXN_ADMIN_URL
-            );
-            return EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_transaction',
-                'espresso_transactions_view_transaction',
-                $item->transaction_ID()
-            )
-                ? '<span class="reg-pad-rght"><a class="status-'
-                  . $item->transaction()->status_ID()
-                  . '" href="'
-                  . $view_txn_lnk_url
-                  . '"  title="'
-                  . esc_attr__('View Transaction', 'event_espresso')
-                  . '">'
-                  . $item->transaction()->pretty_total()
-                  . '</a></span>' : '<span class="reg-pad-rght">' . $item->transaction()->pretty_total() . '</span>';
-        } else {
-            return __("None", "event_espresso");
-        }
-    }
+	/**
+	 * column_TXN_total
+	 *
+	 * @access public
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_TXN_total(EE_Registration $item)
+	{
+		if ($item->transaction()) {
+			$view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action' => 'view_transaction',
+					'TXN_ID' => $item->transaction_ID(),
+				),
+				TXN_ADMIN_URL
+			);
+			return EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_transaction',
+				'espresso_transactions_view_transaction',
+				$item->transaction_ID()
+			)
+				? '<span class="reg-pad-rght"><a class="status-'
+				  . $item->transaction()->status_ID()
+				  . '" href="'
+				  . $view_txn_lnk_url
+				  . '"  title="'
+				  . esc_attr__('View Transaction', 'event_espresso')
+				  . '">'
+				  . $item->transaction()->pretty_total()
+				  . '</a></span>' : '<span class="reg-pad-rght">' . $item->transaction()->pretty_total() . '</span>';
+		} else {
+			return __("None", "event_espresso");
+		}
+	}
 
 
-    /**
-     * column_TXN_paid
-     *
-     * @access public
-     * @param \EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_TXN_paid(EE_Registration $item)
-    {
-        if ($item->count() === 1) {
-            $transaction = $item->transaction() ? $item->transaction() : EE_Transaction::new_instance();
-            if ($transaction->paid() >= $transaction->total()) {
-                return '<span class="reg-pad-rght"><div class="dashicons dashicons-yes green-icon"></div></span>';
-            } else {
-                $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action' => 'view_transaction',
-                        'TXN_ID' => $item->transaction_ID(),
-                    ),
-                    TXN_ADMIN_URL
-                );
-                return EE_Registry::instance()->CAP->current_user_can(
-                    'ee_read_transaction',
-                    'espresso_transactions_view_transaction',
-                    $item->transaction_ID()
-                )
-                    ? '<span class="reg-pad-rght"><a class="status-'
-                      . $transaction->status_ID()
-                      . '" href="'
-                      . $view_txn_lnk_url
-                      . '"  title="'
-                      . esc_attr__('View Transaction', 'event_espresso')
-                      . '">'
-                      . $item->transaction()->pretty_paid()
-                      . '</a><span>' : '<span class="reg-pad-rght">' . $item->transaction()->pretty_paid() . '</span>';
-            }
-        }
-        return '&nbsp;';
-    }
+	/**
+	 * column_TXN_paid
+	 *
+	 * @access public
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_TXN_paid(EE_Registration $item)
+	{
+		if ($item->count() === 1) {
+			$transaction = $item->transaction() ? $item->transaction() : EE_Transaction::new_instance();
+			if ($transaction->paid() >= $transaction->total()) {
+				return '<span class="reg-pad-rght"><div class="dashicons dashicons-yes green-icon"></div></span>';
+			} else {
+				$view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action' => 'view_transaction',
+						'TXN_ID' => $item->transaction_ID(),
+					),
+					TXN_ADMIN_URL
+				);
+				return EE_Registry::instance()->CAP->current_user_can(
+					'ee_read_transaction',
+					'espresso_transactions_view_transaction',
+					$item->transaction_ID()
+				)
+					? '<span class="reg-pad-rght"><a class="status-'
+					  . $transaction->status_ID()
+					  . '" href="'
+					  . $view_txn_lnk_url
+					  . '"  title="'
+					  . esc_attr__('View Transaction', 'event_espresso')
+					  . '">'
+					  . $item->transaction()->pretty_paid()
+					  . '</a><span>' : '<span class="reg-pad-rght">' . $item->transaction()->pretty_paid() . '</span>';
+			}
+		}
+		return '&nbsp;';
+	}
 
 
-    /**
-     * column_actions
-     *
-     * @access public
-     * @param \EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_actions(EE_Registration $item)
-    {
-        $actions = array();
-        $attendee = $item->attendee();
-        $this->_set_related_details($item);
-        // Build row actions
-        $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action'  => 'view_registration',
-                '_REG_ID' => $item->ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'edit_attendee',
-                'post'   => $item->attendee_ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        // page=attendees&event_admin_reports=resend_email&registration_id=43653465634&event_id=2&form_action=resend_email
-        // $resend_reg_lnk_url_params = array( 'action'=>'resend_registration', '_REG_ID'=>$item->REG_ID );
-        $resend_reg_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action'  => 'resend_registration',
-                '_REG_ID' => $item->ID(),
-            ),
-            REG_ADMIN_URL,
-            true
-        );
-        // Build row actions
-        $actions['view_lnk'] = EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registration',
-            'espresso_registrations_view_registration',
-            $item->ID()
-        ) ? '<li><a href="'
-            . $view_lnk_url
-            . '" title="'
-            . esc_attr__('View Registration Details', 'event_espresso')
-            . '" class="tiny-text">
+	/**
+	 * column_actions
+	 *
+	 * @access public
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_actions(EE_Registration $item)
+	{
+		$actions = array();
+		$attendee = $item->attendee();
+		$this->_set_related_details($item);
+		// Build row actions
+		$view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action'  => 'view_registration',
+				'_REG_ID' => $item->ID(),
+			),
+			REG_ADMIN_URL
+		);
+		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'edit_attendee',
+				'post'   => $item->attendee_ID(),
+			),
+			REG_ADMIN_URL
+		);
+		// page=attendees&event_admin_reports=resend_email&registration_id=43653465634&event_id=2&form_action=resend_email
+		// $resend_reg_lnk_url_params = array( 'action'=>'resend_registration', '_REG_ID'=>$item->REG_ID );
+		$resend_reg_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action'  => 'resend_registration',
+				'_REG_ID' => $item->ID(),
+			),
+			REG_ADMIN_URL,
+			true
+		);
+		// Build row actions
+		$actions['view_lnk'] = EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registration',
+			'espresso_registrations_view_registration',
+			$item->ID()
+		) ? '<li><a href="'
+			. $view_lnk_url
+			. '" title="'
+			. esc_attr__('View Registration Details', 'event_espresso')
+			. '" class="tiny-text">
 				<div class="dashicons dashicons-clipboard"></div>
 			</a>
 			</li>'
-            : '';
-        $actions['edit_lnk'] = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_contacts',
-            'espresso_registrations_edit_attendee'
-        )
-                               && $attendee instanceof EE_Attendee
-            ? '
+			: '';
+		$actions['edit_lnk'] = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_contacts',
+			'espresso_registrations_edit_attendee'
+		)
+							   && $attendee instanceof EE_Attendee
+			? '
 			<li>
 			<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Contact Details', 'event_espresso') . '" class="tiny-text">
+			  . esc_attr__('Edit Contact Details', 'event_espresso') . '" class="tiny-text">
 				<div class="ee-icon ee-icon-user-edit ee-icon-size-16"></div>
 			</a>
 			</li>' : '';
-        $actions['resend_reg_lnk'] = $attendee instanceof EE_Attendee
-                                     && EE_Registry::instance()->CAP->current_user_can(
-                                         'ee_send_message',
-                                         'espresso_registrations_resend_registration',
-                                         $item->ID()
-                                     )
-            ? '
+		$actions['resend_reg_lnk'] = $attendee instanceof EE_Attendee
+									 && EE_Registry::instance()->CAP->current_user_can(
+										 'ee_send_message',
+										 'espresso_registrations_resend_registration',
+										 $item->ID()
+									 )
+			? '
 			<li>
 			<a href="'
-              . $resend_reg_lnk_url
-              . '" title="'
-              . esc_attr__('Resend Registration Details', 'event_espresso')
-              . '" class="tiny-text">
+			  . $resend_reg_lnk_url
+			  . '" title="'
+			  . esc_attr__('Resend Registration Details', 'event_espresso')
+			  . '" class="tiny-text">
 				<div class="dashicons dashicons-email-alt"></div>
 			</a>
 			</li>' : '';
-        // page=transactions&action=view_transaction&txn=256&_wpnonce=6414da4dbb
-        $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'view_transaction',
-                'TXN_ID' => $this->_transaction_details['id'],
-            ),
-            TXN_ADMIN_URL
-        );
-        $actions['view_txn_lnk'] = EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_transaction',
-            'espresso_transactions_view_transaction',
-            $this->_transaction_details['id']
-        )
-            ? '
+		// page=transactions&action=view_transaction&txn=256&_wpnonce=6414da4dbb
+		$view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'view_transaction',
+				'TXN_ID' => $this->_transaction_details['id'],
+			),
+			TXN_ADMIN_URL
+		);
+		$actions['view_txn_lnk'] = EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_transaction',
+			'espresso_transactions_view_transaction',
+			$this->_transaction_details['id']
+		)
+			? '
 			<li>
 			<a class="ee-status-color-'
-              . $this->_transaction_details['status']
-              . ' tiny-text" href="'
-              . $view_txn_lnk_url
-              . '"  title="'
-              . $this->_transaction_details['title_attr']
-              . '">
+			  . $this->_transaction_details['status']
+			  . ' tiny-text" href="'
+			  . $view_txn_lnk_url
+			  . '"  title="'
+			  . $this->_transaction_details['title_attr']
+			  . '">
 				<div class="dashicons dashicons-cart"></div>
 			</a>
 			</li>' : '';
-        // invoice link
-        $actions['dl_invoice_lnk'] = '';
-        $dl_invoice_lnk_url = $item->invoice_url();
-        // only show invoice link if message type is active.
-        if ($attendee instanceof EE_Attendee
-            && $item->is_primary_registrant()
-            && EEH_MSG_Template::is_mt_active('invoice')
-        ) {
-            $actions['dl_invoice_lnk'] = '
+		// invoice link
+		$actions['dl_invoice_lnk'] = '';
+		$dl_invoice_lnk_url = $item->invoice_url();
+		// only show invoice link if message type is active.
+		if ($attendee instanceof EE_Attendee
+			&& $item->is_primary_registrant()
+			&& EEH_MSG_Template::is_mt_active('invoice')
+		) {
+			$actions['dl_invoice_lnk'] = '
 		<li>
 			<a title="'
-                                         . esc_attr__('View Transaction Invoice', 'event_espresso')
-                                         . '" target="_blank" href="'
-                                         . $dl_invoice_lnk_url
-                                         . '" class="tiny-text">
+										 . esc_attr__('View Transaction Invoice', 'event_espresso')
+										 . '" target="_blank" href="'
+										 . $dl_invoice_lnk_url
+										 . '" class="tiny-text">
 				<span class="dashicons dashicons-media-spreadsheet ee-icon-size-18"></span>
 			</a>
 		</li>';
-        }
-        $actions['filtered_messages_link'] = '';
-        // message list table link (filtered by REG_ID
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
-            $actions['filtered_messages_link'] = '<li>'
-                                                 . EEH_MSG_Template::get_message_action_link(
-                                                     'see_notifications_for',
-                                                     null,
-                                                     array('_REG_ID' => $item->ID())
-                                                 ) . '</li>';
-        }
-        $actions = apply_filters('FHEE__EE_Registrations_List_Table__column_actions__actions', $actions, $item, $this);
-        return $this->_action_string(implode('', $actions), $item, 'ul', 'reg-overview-actions-ul');
-    }
+		}
+		$actions['filtered_messages_link'] = '';
+		// message list table link (filtered by REG_ID
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
+			$actions['filtered_messages_link'] = '<li>'
+												 . EEH_MSG_Template::get_message_action_link(
+													 'see_notifications_for',
+													 null,
+													 array('_REG_ID' => $item->ID())
+												 ) . '</li>';
+		}
+		$actions = apply_filters('FHEE__EE_Registrations_List_Table__column_actions__actions', $actions, $item, $this);
+		return $this->_action_string(implode('', $actions), $item, 'ul', 'reg-overview-actions-ul');
+	}
 }

Spacing +29 added lines, -29 removed lines

@@ -53,10 +53,10 @@ 
      */
     public function __construct(Registrations_Admin_Page $admin_page)
     {
-        if (! empty($_GET['event_id'])) {
+        if ( ! empty($_GET['event_id'])) {
             $extra_query_args = array();
             foreach ($admin_page->get_views() as $key => $view_details) {
-                $extra_query_args[ $view_details['slug'] ] = array('event_id' => $_GET['event_id']);
+                $extra_query_args[$view_details['slug']] = array('event_id' => $_GET['event_id']);
             }
             $this->_views = $admin_page->get_list_table_view_RLs($extra_query_args);
         }
@@ -156,12 +156,12 @@ 
                 )
             )
         );
-        if (!empty($filters)) {
+        if ( ! empty($filters)) {
             $this->_bottom_buttons['report_filtered']['extra_request']['filters'] = $filters;
         }
         $this->_primary_column = '_REG_ID';
         $this->_sortable_columns = array(
-            '_REG_date'     => array('_REG_date' => true),   // true means its already sorted
+            '_REG_date'     => array('_REG_date' => true), // true means its already sorted
             /**
              * Allows users to change the default sort if they wish.
              * Returning a falsey on this filter will result in the default sort to be by firstname rather than last
@@ -193,7 +193,7 @@ 
     {
         $class = parent::_get_row_class($item);
         // add status class
-        $class .= ' ee-status-strip reg-status-' . $item->status_ID();
+        $class .= ' ee-status-strip reg-status-'.$item->status_ID();
         if ($this->_has_checkbox_column) {
             $class .= ' has-checkbox-column';
         }
@@ -358,12 +358,12 @@ 
         // setup date query.
         $beginning_string = EEM_Registration::instance()->convert_datetime_for_query(
             'REG_date',
-            $this_year_r . '-' . $this_month_r . '-01' . ' ' . $time_start,
+            $this_year_r.'-'.$this_month_r.'-01'.' '.$time_start,
             'Y-m-d H:i:s'
         );
         $end_string = EEM_Registration::instance()->convert_datetime_for_query(
             'REG_date',
-            $this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' ' . $time_end,
+            $this_year_r.'-'.$this_month_r.'-'.$days_this_month.' '.$time_end,
             'Y-m-d H:i:s'
         );
         $_where['REG_date'] = array(
@@ -400,12 +400,12 @@ 
             array(
                 EEM_Registration::instance()->convert_datetime_for_query(
                     'REG_date',
-                    $current_date . $time_start,
+                    $current_date.$time_start,
                     'Y-m-d H:i:s'
                 ),
                 EEM_Registration::instance()->convert_datetime_for_query(
                     'REG_date',
-                    $current_date . $time_end,
+                    $current_date.$time_end,
                     'Y-m-d H:i:s'
                 ),
             ),
@@ -465,8 +465,8 @@ 
         $content .= '<div class="show-on-mobile-view-only">';
         $content .= '<br>';
         $content .= $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
-        $content .= '&nbsp;' . sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
-        $content .= '<br>' . sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
+        $content .= '&nbsp;'.sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
+        $content .= '<br>'.sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
         $content .= '</div>';
         return $content;
     }
@@ -551,12 +551,12 @@ 
                   . $event_name
                   . '</a>' : $event_name;
             $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(array('event_id' => $EVT_ID), REG_ADMIN_URL);
-            $actions['event_filter'] = '<a href="' . $edit_event_url . '" title="';
+            $actions['event_filter'] = '<a href="'.$edit_event_url.'" title="';
             $actions['event_filter'] .= sprintf(
                 esc_attr__('Filter this list to only show registrations for %s', 'event_espresso'),
                 $event_name
             );
-            $actions['event_filter'] .= '">' . __('View Registrations', 'event_espresso') . '</a>';
+            $actions['event_filter'] .= '">'.__('View Registrations', 'event_espresso').'</a>';
         } else {
             $edit_event = $event_name;
             $actions['event_filter'] = '';
@@ -603,11 +603,11 @@ 
     {
         $content = '<div class="ee-registration-event-datetimes-container">';
         $expand_toggle = count($datetime_strings) > 1
-            ? ' <span title="' . esc_attr__('Click to view all dates', 'event_espresso')
+            ? ' <span title="'.esc_attr__('Click to view all dates', 'event_espresso')
               . '" class="ee-js ee-more-datetimes-toggle dashicons dashicons-plus"></span>'
             : '';
         // get first item for initial visibility
-        $content .= '<div class="left">' . array_shift($datetime_strings) . '</div>';
+        $content .= '<div class="left">'.array_shift($datetime_strings).'</div>';
         $content .= $expand_toggle;
         if ($datetime_strings) {
             $content .= '<div style="clear:both"></div>';
@@ -660,14 +660,14 @@ 
         $t = $item->get_first_related('Transaction');
         $payment_count = $t instanceof EE_Transaction ? $t->count_related('Payment') : 0;
         // append group count to name
-        $link .= '&nbsp;' . sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
+        $link .= '&nbsp;'.sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
         // append reg_code
-        $link .= '<br>' . sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
+        $link .= '<br>'.sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
         // reg status text for accessibility
         $link .= '<br><span class="ee-status-text-small">'
                  . EEH_Template::pretty_status($item->status_ID(), false, 'sentence')
                  . '</span>';
-        $action = [ '_REG_ID' => $item->ID() ];
+        $action = ['_REG_ID' => $item->ID()];
         if (isset($this->_req_data['event_id'])) {
             $action['event_id'] = $item->event_ID();
         }
@@ -689,7 +689,7 @@ 
                                 . $trash_lnk_url
                                 . '" title="'
                                 . esc_attr__('Trash Registration', 'event_espresso')
-                                . '">' . __('Trash', 'event_espresso') . '</a>';
+                                . '">'.__('Trash', 'event_espresso').'</a>';
         } elseif ($this->_view === 'trash') {
             // restore registration link
             if (EE_Registry::instance()->CAP->current_user_can(
@@ -705,8 +705,8 @@ 
                 $actions['restore'] = '<a href="'
                                       . $restore_lnk_url
                                       . '" title="'
-                                      . esc_attr__('Restore Registration', 'event_espresso') . '">'
-                                      . __('Restore', 'event_espresso') . '</a>';
+                                      . esc_attr__('Restore Registration', 'event_espresso').'">'
+                                      . __('Restore', 'event_espresso').'</a>';
             }
             if (EE_Registry::instance()->CAP->current_user_can(
                 'ee_delete_registration',
@@ -779,7 +779,7 @@ 
                                                                               . $ticket->name()
                                                                               . '</span><br />' : '';
         if ($item->final_price() > 0) {
-            $content .= '<span class="reg-pad-rght">' . $item->pretty_final_price() . '</span>';
+            $content .= '<span class="reg-pad-rght">'.$item->pretty_final_price().'</span>';
         } else {
             // free event
             $content .= '<span class="reg-overview-free-event-spn reg-pad-rght">'
@@ -806,7 +806,7 @@ 
             : '<span class="TKT_name">'
               . $ticket->name()
               . '</span><br />';
-        $content .= '<span class="reg-pad-rght">' . $item->pretty_final_price() . '</span>';
+        $content .= '<span class="reg-pad-rght">'.$item->pretty_final_price().'</span>';
         return $content;
     }
 
@@ -824,7 +824,7 @@ 
         $payment_method = $item->payment_method();
         $payment_method_name = $payment_method instanceof EE_Payment_Method ? $payment_method->admin_name()
             : __('Unknown', 'event_espresso');
-        $content = '<span class="reg-pad-rght">' . $item->pretty_paid() . '</span>';
+        $content = '<span class="reg-pad-rght">'.$item->pretty_paid().'</span>';
         if ($item->paid() > 0) {
             $content .= '<br><span class="ee-status-text-small">'
                         . sprintf(
@@ -872,7 +872,7 @@ 
                   . esc_attr__('View Transaction', 'event_espresso')
                   . '">'
                   . $item->transaction()->pretty_total()
-                  . '</a></span>' : '<span class="reg-pad-rght">' . $item->transaction()->pretty_total() . '</span>';
+                  . '</a></span>' : '<span class="reg-pad-rght">'.$item->transaction()->pretty_total().'</span>';
         } else {
             return __("None", "event_espresso");
         }
@@ -918,7 +918,7 @@ 
                       . esc_attr__('View Transaction', 'event_espresso')
                       . '">'
                       . $item->transaction()->pretty_paid()
-                      . '</a><span>' : '<span class="reg-pad-rght">' . $item->transaction()->pretty_paid() . '</span>';
+                      . '</a><span>' : '<span class="reg-pad-rght">'.$item->transaction()->pretty_paid().'</span>';
             }
         }
         return '&nbsp;';
@@ -988,8 +988,8 @@ 
                                && $attendee instanceof EE_Attendee
             ? '
 			<li>
-			<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Contact Details', 'event_espresso') . '" class="tiny-text">
+			<a href="' . $edit_lnk_url.'" title="'
+              . esc_attr__('Edit Contact Details', 'event_espresso').'" class="tiny-text">
 				<div class="ee-icon ee-icon-user-edit ee-icon-size-16"></div>
 			</a>
 			</li>' : '';
@@ -1061,7 +1061,7 @@ 
                                                      'see_notifications_for',
                                                      null,
                                                      array('_REG_ID' => $item->ID())
-                                                 ) . '</li>';
+                                                 ).'</li>';
         }
         $actions = apply_filters('FHEE__EE_Registrations_List_Table__column_actions__actions', $actions, $item, $this);
         return $this->_action_string(implode('', $actions), $item, 'ul', 'reg-overview-actions-ul');

core/EE_Capabilities.core.php

Doc Comments +3 added lines, -3 removed lines

@@ -805,7 +805,7 @@ 
      * @since                        4.5.0
      *
      * @param string $meta_cap   What meta capability is this mapping.
-     * @param array  $map_values array {
+     * @param string[]  $map_values array {
      *                           //array of values that MUST match a count of 4.  It's okay to send an empty string for
      *                           capabilities that don't get mapped to.
      *
@@ -880,8 +880,8 @@ 
      * @since 4.6.x
      *
      * @param $caps
-     * @param $cap
-     * @param $user_id
+     * @param string $cap
+     * @param integer $user_id
      * @param $args
      *
      * @return array

Spacing +46 added lines, -46 removed lines

@@ -80,7 +80,7 @@ 
     public static function instance()
     {
         // check if instantiated, and if not do so.
-        if (! self::$_instance instanceof EE_Capabilities) {
+        if ( ! self::$_instance instanceof EE_Capabilities) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -110,7 +110,7 @@ 
      */
     public function init_caps($reset = false)
     {
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
             return false;
         }
         $this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN);
@@ -155,7 +155,7 @@ 
             $this->_get_default_meta_caps_array()
         );
         // add filter for map_meta_caps but only if models can query.
-        if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
+        if ( ! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
             add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
         }
     }
@@ -314,11 +314,11 @@ 
         if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
             // loop through our _meta_caps array
             foreach ($this->_meta_caps as $meta_map) {
-                if (! $meta_map instanceof EE_Meta_Capability_Map) {
+                if ( ! $meta_map instanceof EE_Meta_Capability_Map) {
                     continue;
                 }
                 // don't load models if there is no object ID in the args
-                if (! empty($args[0])) {
+                if ( ! empty($args[0])) {
                     $meta_map->ensure_is_model();
                 }
                 $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
@@ -652,7 +652,7 @@ 
     public function addCaps(array $capabilities_to_add)
     {
         // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
+        if ( ! $this->setupCapabilitiesMap()) {
             return false;
         }
         // and filter the array so others can get in on the fun during resets
@@ -667,7 +667,7 @@ 
         foreach ($capabilities_to_add as $role => $caps_for_role) {
             if (is_array($caps_for_role)) {
                 foreach ($caps_for_role as $cap) {
-                    if (! $this->capHasBeenAddedToRole($role, $cap)
+                    if ( ! $this->capHasBeenAddedToRole($role, $cap)
                         && $this->add_cap_to_role($role, $cap, true, false)
                     ) {
                         $update_capabilities_map = true;
@@ -693,7 +693,7 @@ 
     public function removeCaps($caps_map)
     {
         // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
+        if ( ! $this->setupCapabilitiesMap()) {
             return false;
         }
         $update_capabilities_map = false;
@@ -752,7 +752,7 @@ 
         $orig_role = $role;
         $role = $role instanceof WP_Role ? $role : get_role($role);
         // if the role isn't available then we create it.
-        if (! $role instanceof WP_Role) {
+        if ( ! $role instanceof WP_Role) {
             // if a plugin wants to create a specific role name then they should create the role before
             // EE_Capabilities does.  Otherwise this function will create the role name from the slug:
             // - removes any `ee_` namespacing from the start of the slug.
@@ -763,12 +763,12 @@ 
         }
         if ($role instanceof WP_Role) {
             // don't do anything if the capabilities map can not be initialized
-            if (! $this->setupCapabilitiesMap()) {
+            if ( ! $this->setupCapabilitiesMap()) {
                 return false;
             }
-            if (! $this->capHasBeenAddedToRole($role->name, $cap)) {
+            if ( ! $this->capHasBeenAddedToRole($role->name, $cap)) {
                 $role->add_cap($cap, $grant);
-                $this->capabilities_map[ $role->name ][] = $cap;
+                $this->capabilities_map[$role->name][] = $cap;
                 $this->updateCapabilitiesMap($update_capabilities_map);
                 return true;
             }
@@ -792,14 +792,14 @@ 
     public function remove_cap_from_role($role, $cap, $update_capabilities_map = true)
     {
         // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
+        if ( ! $this->setupCapabilitiesMap()) {
             return false;
         }
 
         $role = $role instanceof WP_Role ? $role : get_role($role);
         if ($role instanceof WP_Role && $index = $this->capHasBeenAddedToRole($role->name, $cap, true)) {
             $role->remove_cap($cap);
-            unset($this->capabilities_map[ $role->name ][ $index ]);
+            unset($this->capabilities_map[$role->name][$index]);
             $this->updateCapabilitiesMap($update_capabilities_map);
             return true;
         }
@@ -815,8 +815,8 @@ 
      */
     private function capHasBeenAddedToRole($role_name = '', $cap = '', $get_index = false)
     {
-        if (isset($this->capabilities_map[ $role_name ])
-            && ($index = array_search($cap, $this->capabilities_map[ $role_name ], true)) !== false
+        if (isset($this->capabilities_map[$role_name])
+            && ($index = array_search($cap, $this->capabilities_map[$role_name], true)) !== false
         ) {
             return $get_index ? $index : true;
         }
@@ -843,7 +843,7 @@ 
     public function current_user_can($cap, $context, $id = 0)
     {
         // apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
+        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__'.$context, $cap, $id);
         $filtered_cap = apply_filters(
             'FHEE__EE_Capabilities__current_user_can__cap',
             $filtered_cap,
@@ -871,7 +871,7 @@ 
     public function user_can($user, $cap, $context, $id = 0)
     {
         // apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
+        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__'.$context, $cap, $user, $id);
         $filtered_cap = apply_filters(
             'FHEE__EE_Capabilities__user_can__cap',
             $filtered_cap,
@@ -910,7 +910,7 @@ 
             : current_user_can($blog_id, $cap);
         // apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
         $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
+            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__'.$context,
             $user_can,
             $blog_id,
             $cap,
@@ -939,14 +939,14 @@ 
      */
     public function get_ee_capabilities($role = 'administrator')
     {
-        if (! $this->initialized) {
+        if ( ! $this->initialized) {
             $this->init_caps();
         }
         if (empty($role)) {
             return $this->capabilities_map;
         }
-        return isset($this->capabilities_map[ $role ])
-            ? $this->capabilities_map[ $role ]
+        return isset($this->capabilities_map[$role])
+            ? $this->capabilities_map[$role]
             : array();
     }
 
@@ -977,7 +977,7 @@ 
                         'event_espresso'
                     ),
                     '$reset',
-                    __METHOD__ . '()',
+                    __METHOD__.'()',
                     'EE_Capabilities::init_caps()',
                     'true'
                 ),
@@ -1051,7 +1051,7 @@ 
                         'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
                         'event_espresso'
                     ),
-                    '<br>' . print_r($map_values, true)
+                    '<br>'.print_r($map_values, true)
                 )
             );
         }
@@ -1091,7 +1091,7 @@ 
         // error proof if the name has EEM in it
         $this->_model_name = str_replace('EEM', '', $this->_model_name);
         $this->_model = EE_Registry::instance()->load_model($this->_model_name);
-        if (! $this->_model instanceof EEM_Base) {
+        if ( ! $this->_model instanceof EEM_Base) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -1177,7 +1177,7 @@ 
 
         // okay it is a meta cap so let's first remove that cap from the $caps array.
         if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
+            unset($caps[$key]);
         }
 
         // cast $user_id to int for later explicit comparisons
@@ -1186,11 +1186,11 @@ 
         /** @var EE_Base_Class $obj */
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         // if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
+        if ( ! $obj instanceof EE_Base_Class) {
             $caps[] = 'do_not_allow';
             return $caps;
         }
-        $caps[] = $cap . 's';
+        $caps[] = $cap.'s';
         if ($obj instanceof EE_CPT_Base) {
             // if the item author is set and the user is the author...
             if ($obj->wp_user() && $user_id === $obj->wp_user()) {
@@ -1200,12 +1200,12 @@ 
                 }
             } else {
                 // the user is trying to edit someone else's obj
-                if (! empty($this->others_cap)) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
-                if (! empty($this->published_cap) && $obj->status() === 'publish') {
+                if ( ! empty($this->published_cap) && $obj->status() === 'publish') {
                     $caps[] = $this->published_cap;
-                } elseif (! empty($this->private_cap) && $obj->status() === 'private') {
+                } elseif ( ! empty($this->private_cap) && $obj->status() === 'private') {
                     $caps[] = $this->private_cap;
                 }
             }
@@ -1221,8 +1221,8 @@ 
                     EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
                 }
             }
-            if (! $has_cap) {
-                if (! empty($this->others_cap)) {
+            if ( ! $has_cap) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
             }
@@ -1301,7 +1301,7 @@ 
 
         // okay it is a meta cap so let's first remove that cap from the $caps array.
         if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
+            unset($caps[$key]);
         }
 
         // cast $user_id to int for later explicit comparisons
@@ -1309,12 +1309,12 @@ 
 
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         // if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
+        if ( ! $obj instanceof EE_Base_Class) {
             $caps[] = 'do_not_allow';
             return $caps;
         }
 
-        $caps[] = $cap . 's';
+        $caps[] = $cap.'s';
         if ($obj instanceof EE_CPT_Base) {
             $status_obj = get_post_status_object($obj->status());
             if ($status_obj->public) {
@@ -1322,7 +1322,7 @@ 
             }
             // if the item author is set and the user is not the author...
             if ($obj->wp_user() && $obj->wp_user() !== $user_id) {
-                if (! empty($this->others_cap)) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
             }
@@ -1346,11 +1346,11 @@ 
                     EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
                 }
             }
-            if (! $has_cap) {
-                if (! empty($this->private_cap)) {
+            if ( ! $has_cap) {
+                if ( ! empty($this->private_cap)) {
                     $caps[] = $this->private_cap;
                 }
-                if (! empty($this->others_cap)) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
             }
@@ -1396,7 +1396,7 @@ 
 
         // okay it is a meta cap so let's first remove that cap from the $caps array.
         if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
+            unset($caps[$key]);
         }
 
         // cast $user_id to int for later explicit comparisons
@@ -1404,11 +1404,11 @@ 
 
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         // if no obj then let's just do cap
-        if (! $obj instanceof EE_Message_Template_Group) {
+        if ( ! $obj instanceof EE_Message_Template_Group) {
             $caps[] = 'do_not_allow';
             return $caps;
         }
-        $caps[] = $cap . 's';
+        $caps[] = $cap.'s';
         $is_global = $obj->is_global();
         if ($obj->wp_user() && $obj->wp_user() === $user_id) {
             if ($is_global) {
@@ -1459,15 +1459,15 @@ 
         }
         // okay it is a meta cap so let's first remove that cap from the $caps array.
         if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
+            unset($caps[$key]);
         }
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         // if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
+        if ( ! $obj instanceof EE_Base_Class) {
             $caps[] = 'do_not_allow';
             return $caps;
         }
-        $caps[] = $cap . 's';
+        $caps[] = $cap.'s';
         $is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
         $is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
         if ($is_system) {

Indentation +1369 added lines, -1369 removed lines

@@ -14,981 +14,981 @@ 
 final class EE_Capabilities extends EE_Base
 {
 
-    /**
-     * the name of the wp option used to store caps previously initialized
-     */
-    const option_name = 'ee_caps_initialized';
-
-    /**
-     * instance of EE_Capabilities object
-     *
-     * @var EE_Capabilities
-     */
-    private static $_instance;
-
-
-    /**
-     * This is a map of caps that correspond to a default WP_Role.
-     * Array is indexed by Role and values are ee capabilities.
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    private $capabilities_map = array();
-
-    /**
-     * This used to hold an array of EE_Meta_Capability_Map objects
-     * that define the granular capabilities mapped to for a user depending on context.
-     *
-     * @var EE_Meta_Capability_Map[]
-     */
-    private $_meta_caps = array();
-
-    /**
-     * The internal $capabilities_map needs to be initialized before it can be used.
-     * This flag tracks whether that has happened or not.
-     * But for this to work, we need three states to indicate:
-     *      initialization has not occurred at all
-     *      initialization has started but is not complete
-     *      initialization is complete
-     * The reason this is needed is because the addCaps() method
-     * normally requires the $capabilities_map to be initialized,
-     * but is also used during the initialization process.
-     * So:
-     *      If initialized === null, init_caps() will be called before any other methods will run.
-     *      If initialized === false, then init_caps() is in the process of running it's logic.
-     *      If initialized === true, then init_caps() has completed the initialization process.
-     *
-     * @var boolean|null $initialized
-     */
-    private $initialized;
-
-    /**
-     * @var boolean $reset
-     */
-    private $reset = false;
-
-
-    /**
-     * singleton method used to instantiate class object
-     *
-     * @since 4.5.0
-     *
-     * @return EE_Capabilities
-     */
-    public static function instance()
-    {
-        // check if instantiated, and if not do so.
-        if (! self::$_instance instanceof EE_Capabilities) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * private constructor
-     *
-     * @since 4.5.0
-     */
-    private function __construct()
-    {
-    }
-
-
-    /**
-     * This delays the initialization of the capabilities class until EE_System core is loaded and ready.
-     *
-     * @param bool $reset allows for resetting the default capabilities saved on roles.  Note that this doesn't
-     *                    actually REMOVE any capabilities from existing roles, it just resaves defaults roles and
-     *                    ensures that they are up to date.
-     *
-     * @since 4.5.0
-     * @return bool
-     * @throws EE_Error
-     */
-    public function init_caps($reset = false)
-    {
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-            return false;
-        }
-        $this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN);
-        // if reset, then completely delete the cache option and clear the $capabilities_map property.
-        if ($this->reset) {
-            $this->initialized = null;
-            $this->capabilities_map = array();
-            delete_option(self::option_name);
-        }
-        if ($this->initialized === null) {
-            $this->initialized = false;
-            do_action(
-                'AHEE__EE_Capabilities__init_caps__before_initialization',
-                $this->reset
-            );
-            $this->addCaps($this->_init_caps_map());
-            $this->_set_meta_caps();
-            do_action(
-                'AHEE__EE_Capabilities__init_caps__after_initialization',
-                $this->capabilities_map
-            );
-            $this->initialized = true;
-        }
-        // reset $this->reset so that it's not stuck on true if init_caps() gets called again
-        $this->reset = false;
-        return true;
-    }
-
-
-    /**
-     * This sets the meta caps property.
-     *
-     * @since 4.5.0
-     * @return void
-     * @throws EE_Error
-     */
-    private function _set_meta_caps()
-    {
-        // get default meta caps and filter the returned array
-        $this->_meta_caps = apply_filters(
-            'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
-            $this->_get_default_meta_caps_array()
-        );
-        // add filter for map_meta_caps but only if models can query.
-        if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
-            add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
-        }
-    }
-
-
-    /**
-     * This builds and returns the default meta_caps array only once.
-     *
-     * @since  4.8.28.rc.012
-     * @return array
-     * @throws EE_Error
-     */
-    private function _get_default_meta_caps_array()
-    {
-        static $default_meta_caps = array();
-        // make sure we're only ever initializing the default _meta_caps array once if it's empty.
-        if (empty($default_meta_caps)) {
-            $default_meta_caps = array(
-                // edits
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_event',
-                    array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_venue',
-                    array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_registration',
-                    array('Registration', '', 'ee_edit_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_checkin',
-                    array('Registration', '', 'ee_edit_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_edit_message',
-                    array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_default_ticket',
-                    array('Ticket', '', 'ee_edit_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_edit_question',
-                    array('Question', '', '', 'ee_edit_system_questions')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_edit_question_group',
-                    array('Question_Group', '', '', 'ee_edit_system_question_groups')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_payment_method',
-                    array('Payment_Method', '', 'ee_edit_others_payment_methods', '')
-                ),
-                // reads
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_event',
-                    array('Event', '', 'ee_read_others_events', 'ee_read_private_events')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_venue',
-                    array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_registration',
-                    array('Registration', '', 'ee_read_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_checkin',
-                    array('Registration', '', 'ee_read_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_read_message',
-                    array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_default_ticket',
-                    array('Ticket', '', 'ee_read_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_payment_method',
-                    array('Payment_Method', '', 'ee_read_others_payment_methods', '')
-                ),
-                // deletes
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_event',
-                    array(
-                        'Event',
-                        'ee_delete_published_events',
-                        'ee_delete_others_events',
-                        'ee_delete_private_events',
-                    )
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_venue',
-                    array(
-                        'Venue',
-                        'ee_delete_published_venues',
-                        'ee_delete_others_venues',
-                        'ee_delete_private_venues',
-                    )
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_registration',
-                    array('Registration', '', 'ee_delete_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_checkin',
-                    array('Registration', '', 'ee_delete_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_delete_message',
-                    array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_default_ticket',
-                    array('Ticket', '', 'ee_delete_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_delete_question',
-                    array('Question', '', '', 'delete_system_questions')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_delete_question_group',
-                    array('Question_Group', '', '', 'delete_system_question_groups')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_payment_method',
-                    array('Payment_Method', '', 'ee_delete_others_payment_methods', '')
-                ),
-            );
-        }
-        return $default_meta_caps;
-    }
-
-
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * The actual logic is carried out by implementer classes in their definition of _map_meta_caps.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array actual users capabilities
-     * @throws EE_Error
-     */
-    public function map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
-            // loop through our _meta_caps array
-            foreach ($this->_meta_caps as $meta_map) {
-                if (! $meta_map instanceof EE_Meta_Capability_Map) {
-                    continue;
-                }
-                // don't load models if there is no object ID in the args
-                if (! empty($args[0])) {
-                    $meta_map->ensure_is_model();
-                }
-                $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
-            }
-        }
-        return $caps;
-    }
-
-
-    /**
-     * This sets up and returns the initial capabilities map for Event Espresso
-     * Note this array is filtered.
-     * It is assumed that all available EE capabilities are assigned to the administrator role.
-     *
-     * @since 4.5.0
-     *
-     * @return array
-     */
-    private function _init_caps_map()
-    {
-        return apply_filters(
-            'FHEE__EE_Capabilities__init_caps_map__caps',
-            array(
-                'administrator'           => array(
-                    // basic access
-                    'ee_read_ee',
-                    // gateways
-                    /**
-                     * note that with payment method capabilities, although we've implemented
-                     * capability mapping which will be used for accessing payment methods owned by
-                     * other users.  This is not fully implemented yet in the payment method ui.
-                     * Currently only the "plural" caps are in active use.
-                     * (Specific payment method caps are in use as well).
-                     **/
-                    'ee_manage_gateways',
-                    'ee_read_payment_methods',
-                    'ee_read_others_payment_methods',
-                    'ee_edit_payment_methods',
-                    'ee_edit_others_payment_methods',
-                    'ee_delete_payment_methods',
-                    // events
-                    'ee_publish_events',
-                    'ee_read_private_events',
-                    'ee_read_others_events',
-                    'ee_read_events',
-                    'ee_edit_events',
-                    'ee_edit_published_events',
-                    'ee_edit_others_events',
-                    'ee_edit_private_events',
-                    'ee_delete_published_events',
-                    'ee_delete_private_events',
-                    'ee_delete_events',
-                    'ee_delete_others_events',
-                    // event categories
-                    'ee_manage_event_categories',
-                    'ee_edit_event_category',
-                    'ee_delete_event_category',
-                    'ee_assign_event_category',
-                    // venues
-                    'ee_publish_venues',
-                    'ee_read_venues',
-                    'ee_read_others_venues',
-                    'ee_read_private_venues',
-                    'ee_edit_venues',
-                    'ee_edit_others_venues',
-                    'ee_edit_published_venues',
-                    'ee_edit_private_venues',
-                    'ee_delete_venues',
-                    'ee_delete_others_venues',
-                    'ee_delete_private_venues',
-                    'ee_delete_published_venues',
-                    // venue categories
-                    'ee_manage_venue_categories',
-                    'ee_edit_venue_category',
-                    'ee_delete_venue_category',
-                    'ee_assign_venue_category',
-                    // contacts
-                    'ee_read_contacts',
-                    'ee_edit_contacts',
-                    'ee_delete_contacts',
-                    // registrations
-                    'ee_read_registrations',
-                    'ee_read_others_registrations',
-                    'ee_edit_registrations',
-                    'ee_edit_others_registrations',
-                    'ee_delete_registrations',
-                    'ee_delete_others_registrations',
-                    // checkins
-                    'ee_read_others_checkins',
-                    'ee_read_checkins',
-                    'ee_edit_checkins',
-                    'ee_edit_others_checkins',
-                    'ee_delete_checkins',
-                    'ee_delete_others_checkins',
-                    // transactions && payments
-                    'ee_read_transaction',
-                    'ee_read_transactions',
-                    'ee_edit_payments',
-                    'ee_delete_payments',
-                    // messages
-                    'ee_read_messages',
-                    'ee_read_others_messages',
-                    'ee_read_global_messages',
-                    'ee_edit_global_messages',
-                    'ee_edit_messages',
-                    'ee_edit_others_messages',
-                    'ee_delete_messages',
-                    'ee_delete_others_messages',
-                    'ee_delete_global_messages',
-                    'ee_send_message',
-                    // tickets
-                    'ee_read_default_tickets',
-                    'ee_read_others_default_tickets',
-                    'ee_edit_default_tickets',
-                    'ee_edit_others_default_tickets',
-                    'ee_delete_default_tickets',
-                    'ee_delete_others_default_tickets',
-                    // prices
-                    'ee_edit_default_price',
-                    'ee_edit_default_prices',
-                    'ee_delete_default_price',
-                    'ee_delete_default_prices',
-                    'ee_edit_default_price_type',
-                    'ee_edit_default_price_types',
-                    'ee_delete_default_price_type',
-                    'ee_delete_default_price_types',
-                    'ee_read_default_prices',
-                    'ee_read_default_price_types',
-                    // registration form
-                    'ee_edit_questions',
-                    'ee_edit_system_questions',
-                    'ee_read_questions',
-                    'ee_delete_questions',
-                    'ee_edit_question_groups',
-                    'ee_read_question_groups',
-                    'ee_edit_system_question_groups',
-                    'ee_delete_question_groups',
-                    // event_type taxonomy
-                    'ee_assign_event_type',
-                    'ee_manage_event_types',
-                    'ee_edit_event_type',
-                    'ee_delete_event_type',
-                ),
-                'ee_events_administrator' => array(
-                    // core wp caps
-                    'read',
-                    'read_private_pages',
-                    'read_private_posts',
-                    'edit_users',
-                    'edit_posts',
-                    'edit_pages',
-                    'edit_published_posts',
-                    'edit_published_pages',
-                    'edit_private_pages',
-                    'edit_private_posts',
-                    'edit_others_posts',
-                    'edit_others_pages',
-                    'publish_posts',
-                    'publish_pages',
-                    'delete_posts',
-                    'delete_pages',
-                    'delete_private_pages',
-                    'delete_private_posts',
-                    'delete_published_pages',
-                    'delete_published_posts',
-                    'delete_others_posts',
-                    'delete_others_pages',
-                    'manage_categories',
-                    'manage_links',
-                    'moderate_comments',
-                    'unfiltered_html',
-                    'upload_files',
-                    'export',
-                    'import',
-                    'list_users',
-                    'level_1', // required if user with this role shows up in author dropdowns
-                    // basic ee access
-                    'ee_read_ee',
-                    // events
-                    'ee_publish_events',
-                    'ee_read_private_events',
-                    'ee_read_others_events',
-                    'ee_read_event',
-                    'ee_read_events',
-                    'ee_edit_event',
-                    'ee_edit_events',
-                    'ee_edit_published_events',
-                    'ee_edit_others_events',
-                    'ee_edit_private_events',
-                    'ee_delete_published_events',
-                    'ee_delete_private_events',
-                    'ee_delete_event',
-                    'ee_delete_events',
-                    'ee_delete_others_events',
-                    // event categories
-                    'ee_manage_event_categories',
-                    'ee_edit_event_category',
-                    'ee_delete_event_category',
-                    'ee_assign_event_category',
-                    // venues
-                    'ee_publish_venues',
-                    'ee_read_venue',
-                    'ee_read_venues',
-                    'ee_read_others_venues',
-                    'ee_read_private_venues',
-                    'ee_edit_venue',
-                    'ee_edit_venues',
-                    'ee_edit_others_venues',
-                    'ee_edit_published_venues',
-                    'ee_edit_private_venues',
-                    'ee_delete_venue',
-                    'ee_delete_venues',
-                    'ee_delete_others_venues',
-                    'ee_delete_private_venues',
-                    'ee_delete_published_venues',
-                    // venue categories
-                    'ee_manage_venue_categories',
-                    'ee_edit_venue_category',
-                    'ee_delete_venue_category',
-                    'ee_assign_venue_category',
-                    // contacts
-                    'ee_read_contacts',
-                    'ee_edit_contacts',
-                    'ee_delete_contacts',
-                    // registrations
-                    'ee_read_registrations',
-                    'ee_read_others_registrations',
-                    'ee_edit_registration',
-                    'ee_edit_registrations',
-                    'ee_edit_others_registrations',
-                    'ee_delete_registration',
-                    'ee_delete_registrations',
-                    'ee_delete_others_registrations',
-                    // checkins
-                    'ee_read_others_checkins',
-                    'ee_read_checkins',
-                    'ee_edit_checkins',
-                    'ee_edit_others_checkins',
-                    'ee_delete_checkins',
-                    'ee_delete_others_checkins',
-                    // transactions && payments
-                    'ee_read_transaction',
-                    'ee_read_transactions',
-                    'ee_edit_payments',
-                    'ee_delete_payments',
-                    // messages
-                    'ee_read_messages',
-                    'ee_read_others_messages',
-                    'ee_read_global_messages',
-                    'ee_edit_global_messages',
-                    'ee_edit_messages',
-                    'ee_edit_others_messages',
-                    'ee_delete_messages',
-                    'ee_delete_others_messages',
-                    'ee_delete_global_messages',
-                    'ee_send_message',
-                    // tickets
-                    'ee_read_default_tickets',
-                    'ee_read_others_default_tickets',
-                    'ee_edit_default_tickets',
-                    'ee_edit_others_default_tickets',
-                    'ee_delete_default_tickets',
-                    'ee_delete_others_default_tickets',
-                    // prices
-                    'ee_edit_default_price',
-                    'ee_edit_default_prices',
-                    'ee_delete_default_price',
-                    'ee_delete_default_prices',
-                    'ee_edit_default_price_type',
-                    'ee_edit_default_price_types',
-                    'ee_delete_default_price_type',
-                    'ee_delete_default_price_types',
-                    'ee_read_default_prices',
-                    'ee_read_default_price_types',
-                    // registration form
-                    'ee_edit_questions',
-                    'ee_edit_system_questions',
-                    'ee_read_questions',
-                    'ee_delete_questions',
-                    'ee_edit_question_groups',
-                    'ee_read_question_groups',
-                    'ee_edit_system_question_groups',
-                    'ee_delete_question_groups',
-                    // event_type taxonomy
-                    'ee_assign_event_type',
-                    'ee_manage_event_types',
-                    'ee_edit_event_type',
-                    'ee_delete_event_type',
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    private function setupCapabilitiesMap()
-    {
-        // if the initialization process hasn't even started, then we need to call init_caps()
-        if ($this->initialized === null) {
-            return $this->init_caps();
-        }
-        // unless resetting, get caps from db if we haven't already
-        $this->capabilities_map = $this->reset || ! empty($this->capabilities_map)
-            ? $this->capabilities_map
-            : get_option(self::option_name, array());
-        return true;
-    }
-
-
-    /**
-     * @param bool $update
-     * @return bool
-     */
-    private function updateCapabilitiesMap($update = true)
-    {
-        return $update ? update_option(self::option_name, $this->capabilities_map) : false;
-    }
-
-
-    /**
-     * Adds capabilities to roles.
-     *
-     * @since 4.9.42
-     * @param array $capabilities_to_add array of capabilities to add, indexed by roles.
-     *                                   Note that this should ONLY be called on activation hook
-     *                                   otherwise the caps will be added on every request.
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function addCaps(array $capabilities_to_add)
-    {
-        // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
-            return false;
-        }
-        // and filter the array so others can get in on the fun during resets
-        $capabilities_to_add = apply_filters(
-            'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
-            $capabilities_to_add,
-            $this->reset,
-            $this->capabilities_map
-        );
-        $update_capabilities_map = false;
-        // if not reset, see what caps are new for each role. if they're new, add them.
-        foreach ($capabilities_to_add as $role => $caps_for_role) {
-            if (is_array($caps_for_role)) {
-                foreach ($caps_for_role as $cap) {
-                    if (! $this->capHasBeenAddedToRole($role, $cap)
-                        && $this->add_cap_to_role($role, $cap, true, false)
-                    ) {
-                        $update_capabilities_map = true;
-                    }
-                }
-            }
-        }
-        // now let's just save the cap that has been set but only if there's been a change.
-        $updated = $this->updateCapabilitiesMap($update_capabilities_map);
-        $this->flushWpUser($updated);
-        do_action('AHEE__EE_Capabilities__addCaps__complete', $this->capabilities_map, $updated);
-        return $updated;
-    }
-
-
-    /**
-     * Loops through the capabilities map and removes the role caps specified by the incoming array
-     *
-     * @param array $caps_map map of capabilities to be removed (indexed by roles)
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function removeCaps($caps_map)
-    {
-        // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
-            return false;
-        }
-        $update_capabilities_map = false;
-        foreach ($caps_map as $role => $caps_for_role) {
-            if (is_array($caps_for_role)) {
-                foreach ($caps_for_role as $cap) {
-                    if ($this->capHasBeenAddedToRole($role, $cap)
-                        && $this->remove_cap_from_role($role, $cap, false)
-                    ) {
-                        $update_capabilities_map = true;
-                    }
-                }
-            }
-        }
-        // maybe resave the caps
-        $updated = $this->updateCapabilitiesMap($update_capabilities_map);
-        $this->flushWpUser($updated);
-        return $updated;
-    }
-
-
-    /**
-     * This ensures that the WP User object cached on the $current_user global in WP has the latest capabilities from
-     * the roles on that user.
-     *
-     * @param bool $flush Default is to flush the WP_User object.  If false, then this method effectively does nothing.
-     */
-    private function flushWpUser($flush = true)
-    {
-        if ($flush) {
-            $user = wp_get_current_user();
-            if ($user instanceof WP_User) {
-                $user->get_role_caps();
-            }
-        }
-    }
-
-
-    /**
-     * This method sets a capability on a role.  Note this should only be done on activation, or if you have something
-     * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note.
-     * this is a wrapper for $wp_role->add_cap()
-     *
-     * @see   wp-includes/capabilities.php
-     * @since 4.5.0
-     * @param string|WP_Role $role  A WordPress role the capability is being added to
-     * @param string         $cap   The capability being added to the role
-     * @param bool           $grant Whether to grant access to this cap on this role.
-     * @param bool           $update_capabilities_map
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function add_cap_to_role($role, $cap, $grant = true, $update_capabilities_map = true)
-    {
-        // capture incoming value for $role because we may need it to create a new WP_Role
-        $orig_role = $role;
-        $role = $role instanceof WP_Role ? $role : get_role($role);
-        // if the role isn't available then we create it.
-        if (! $role instanceof WP_Role) {
-            // if a plugin wants to create a specific role name then they should create the role before
-            // EE_Capabilities does.  Otherwise this function will create the role name from the slug:
-            // - removes any `ee_` namespacing from the start of the slug.
-            // - replaces `_` with ` ` (empty space).
-            // - sentence case on the resulting string.
-            $role_label = ucwords(str_replace(array('ee_', '_'), array('', ' '), $orig_role));
-            $role = add_role($orig_role, $role_label);
-        }
-        if ($role instanceof WP_Role) {
-            // don't do anything if the capabilities map can not be initialized
-            if (! $this->setupCapabilitiesMap()) {
-                return false;
-            }
-            if (! $this->capHasBeenAddedToRole($role->name, $cap)) {
-                $role->add_cap($cap, $grant);
-                $this->capabilities_map[ $role->name ][] = $cap;
-                $this->updateCapabilitiesMap($update_capabilities_map);
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Functions similarly to add_cap_to_role except removes cap from given role.
-     * Wrapper for $wp_role->remove_cap()
-     *
-     * @see   wp-includes/capabilities.php
-     * @since 4.5.0
-     * @param string|WP_Role $role A WordPress role the capability is being removed from.
-     * @param string         $cap  The capability being removed
-     * @param bool           $update_capabilities_map
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function remove_cap_from_role($role, $cap, $update_capabilities_map = true)
-    {
-        // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
-            return false;
-        }
-
-        $role = $role instanceof WP_Role ? $role : get_role($role);
-        if ($role instanceof WP_Role && $index = $this->capHasBeenAddedToRole($role->name, $cap, true)) {
-            $role->remove_cap($cap);
-            unset($this->capabilities_map[ $role->name ][ $index ]);
-            $this->updateCapabilitiesMap($update_capabilities_map);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * @param string $role_name
-     * @param string $cap
-     * @param bool   $get_index
-     * @return bool|mixed
-     */
-    private function capHasBeenAddedToRole($role_name = '', $cap = '', $get_index = false)
-    {
-        if (isset($this->capabilities_map[ $role_name ])
-            && ($index = array_search($cap, $this->capabilities_map[ $role_name ], true)) !== false
-        ) {
-            return $get_index ? $index : true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Wrapper for the native WP current_user_can() method.
-     * This is provided as a handy method for a couple things:
-     * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
-     * write those filters wherever current_user_can is called).
-     * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
-     *
-     * @since 4.5.0
-     *
-     * @param string $cap     The cap being checked.
-     * @param string $context The context where the current_user_can is being called from.
-     * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
-     *                        filters.
-     *
-     * @return bool  Whether user can or not.
-     */
-    public function current_user_can($cap, $context, $id = 0)
-    {
-        // apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
-        $filtered_cap = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can__cap',
-            $filtered_cap,
-            $context,
-            $cap,
-            $id
-        );
-        return ! empty($id)
-            ? current_user_can($filtered_cap, $id)
-            : current_user_can($filtered_cap);
-    }
-
-
-    /**
-     * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class.
-     *
-     * @param int|WP_User $user    Either the user_id or a WP_User object
-     * @param string      $cap     The capability string being checked
-     * @param string      $context The context where the user_can is being called from (used in filters).
-     * @param int         $id      Optional. Id for item where user_can is being called from ( used in map_meta_cap()
-     *                             filters)
-     *
-     * @return bool Whether user can or not.
-     */
-    public function user_can($user, $cap, $context, $id = 0)
-    {
-        // apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
-        $filtered_cap = apply_filters(
-            'FHEE__EE_Capabilities__user_can__cap',
-            $filtered_cap,
-            $context,
-            $cap,
-            $user,
-            $id
-        );
-        return ! empty($id)
-            ? user_can($user, $filtered_cap, $id)
-            : user_can($user, $filtered_cap);
-    }
-
-
-    /**
-     * Wrapper for the native WP current_user_can_for_blog() method.
-     * This is provided as a handy method for a couple things:
-     * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
-     * write those filters wherever current_user_can is called).
-     * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
-     *
-     * @since 4.5.0
-     *
-     * @param int    $blog_id The blog id that is being checked for.
-     * @param string $cap     The cap being checked.
-     * @param string $context The context where the current_user_can is being called from.
-     * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
-     *                        filters.
-     *
-     * @return bool  Whether user can or not.
-     */
-    public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0)
-    {
-        $user_can = ! empty($id)
-            ? current_user_can_for_blog($blog_id, $cap, $id)
-            : current_user_can($blog_id, $cap);
-        // apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
-            $user_can,
-            $blog_id,
-            $cap,
-            $id
-        );
-        $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can',
-            $user_can,
-            $context,
-            $blog_id,
-            $cap,
-            $id
-        );
-        return $user_can;
-    }
-
-
-    /**
-     * This helper method just returns an array of registered EE capabilities.
-     *
-     * @since 4.5.0
-     * @param string $role If empty then the entire role/capability map is returned.
-     *                     Otherwise just the capabilities for the given role are returned.
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_ee_capabilities($role = 'administrator')
-    {
-        if (! $this->initialized) {
-            $this->init_caps();
-        }
-        if (empty($role)) {
-            return $this->capabilities_map;
-        }
-        return isset($this->capabilities_map[ $role ])
-            ? $this->capabilities_map[ $role ]
-            : array();
-    }
-
-
-    /**
-     * @deprecated 4.9.42
-     * @param bool  $reset      If you need to reset Event Espresso's capabilities,
-     *                          then please use the init_caps() method with the "$reset" parameter set to "true"
-     * @param array $caps_map   Optional.
-     *                          Can be used to send a custom map of roles and capabilities for setting them up.
-     *                          Note that this should ONLY be called on activation hook or some other one-time
-     *                          task otherwise the caps will be added on every request.
-     * @return void
-     * @throws EE_Error
-     */
-    public function init_role_caps($reset = false, $caps_map = array())
-    {
-        // If this method is called directly and reset is set as 'true',
-        // then display a doing it wrong notice, because we want resets to go through init_caps()
-        // to guarantee that everything is set up correctly.
-        // This prevents the capabilities map getting reset incorrectly by direct calls to this method.
-        if ($reset) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" parameter for the "%2$s" method is deprecated. If you need to reset Event Espresso\'s capabilities, then please use the "%3$s" method with the "%1$s" parameter set to "%4$s".',
-                        'event_espresso'
-                    ),
-                    '$reset',
-                    __METHOD__ . '()',
-                    'EE_Capabilities::init_caps()',
-                    'true'
-                ),
-                '4.9.42',
-                '5.0.0'
-            );
-        }
-        $this->addCaps($caps_map);
-    }
+	/**
+	 * the name of the wp option used to store caps previously initialized
+	 */
+	const option_name = 'ee_caps_initialized';
+
+	/**
+	 * instance of EE_Capabilities object
+	 *
+	 * @var EE_Capabilities
+	 */
+	private static $_instance;
+
+
+	/**
+	 * This is a map of caps that correspond to a default WP_Role.
+	 * Array is indexed by Role and values are ee capabilities.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	private $capabilities_map = array();
+
+	/**
+	 * This used to hold an array of EE_Meta_Capability_Map objects
+	 * that define the granular capabilities mapped to for a user depending on context.
+	 *
+	 * @var EE_Meta_Capability_Map[]
+	 */
+	private $_meta_caps = array();
+
+	/**
+	 * The internal $capabilities_map needs to be initialized before it can be used.
+	 * This flag tracks whether that has happened or not.
+	 * But for this to work, we need three states to indicate:
+	 *      initialization has not occurred at all
+	 *      initialization has started but is not complete
+	 *      initialization is complete
+	 * The reason this is needed is because the addCaps() method
+	 * normally requires the $capabilities_map to be initialized,
+	 * but is also used during the initialization process.
+	 * So:
+	 *      If initialized === null, init_caps() will be called before any other methods will run.
+	 *      If initialized === false, then init_caps() is in the process of running it's logic.
+	 *      If initialized === true, then init_caps() has completed the initialization process.
+	 *
+	 * @var boolean|null $initialized
+	 */
+	private $initialized;
+
+	/**
+	 * @var boolean $reset
+	 */
+	private $reset = false;
+
+
+	/**
+	 * singleton method used to instantiate class object
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return EE_Capabilities
+	 */
+	public static function instance()
+	{
+		// check if instantiated, and if not do so.
+		if (! self::$_instance instanceof EE_Capabilities) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * private constructor
+	 *
+	 * @since 4.5.0
+	 */
+	private function __construct()
+	{
+	}
+
+
+	/**
+	 * This delays the initialization of the capabilities class until EE_System core is loaded and ready.
+	 *
+	 * @param bool $reset allows for resetting the default capabilities saved on roles.  Note that this doesn't
+	 *                    actually REMOVE any capabilities from existing roles, it just resaves defaults roles and
+	 *                    ensures that they are up to date.
+	 *
+	 * @since 4.5.0
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function init_caps($reset = false)
+	{
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+			return false;
+		}
+		$this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN);
+		// if reset, then completely delete the cache option and clear the $capabilities_map property.
+		if ($this->reset) {
+			$this->initialized = null;
+			$this->capabilities_map = array();
+			delete_option(self::option_name);
+		}
+		if ($this->initialized === null) {
+			$this->initialized = false;
+			do_action(
+				'AHEE__EE_Capabilities__init_caps__before_initialization',
+				$this->reset
+			);
+			$this->addCaps($this->_init_caps_map());
+			$this->_set_meta_caps();
+			do_action(
+				'AHEE__EE_Capabilities__init_caps__after_initialization',
+				$this->capabilities_map
+			);
+			$this->initialized = true;
+		}
+		// reset $this->reset so that it's not stuck on true if init_caps() gets called again
+		$this->reset = false;
+		return true;
+	}
+
+
+	/**
+	 * This sets the meta caps property.
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _set_meta_caps()
+	{
+		// get default meta caps and filter the returned array
+		$this->_meta_caps = apply_filters(
+			'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
+			$this->_get_default_meta_caps_array()
+		);
+		// add filter for map_meta_caps but only if models can query.
+		if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
+			add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
+		}
+	}
+
+
+	/**
+	 * This builds and returns the default meta_caps array only once.
+	 *
+	 * @since  4.8.28.rc.012
+	 * @return array
+	 * @throws EE_Error
+	 */
+	private function _get_default_meta_caps_array()
+	{
+		static $default_meta_caps = array();
+		// make sure we're only ever initializing the default _meta_caps array once if it's empty.
+		if (empty($default_meta_caps)) {
+			$default_meta_caps = array(
+				// edits
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_event',
+					array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_venue',
+					array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_registration',
+					array('Registration', '', 'ee_edit_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_checkin',
+					array('Registration', '', 'ee_edit_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_edit_message',
+					array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_default_ticket',
+					array('Ticket', '', 'ee_edit_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_edit_question',
+					array('Question', '', '', 'ee_edit_system_questions')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_edit_question_group',
+					array('Question_Group', '', '', 'ee_edit_system_question_groups')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_payment_method',
+					array('Payment_Method', '', 'ee_edit_others_payment_methods', '')
+				),
+				// reads
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_event',
+					array('Event', '', 'ee_read_others_events', 'ee_read_private_events')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_venue',
+					array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_registration',
+					array('Registration', '', 'ee_read_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_checkin',
+					array('Registration', '', 'ee_read_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_read_message',
+					array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_default_ticket',
+					array('Ticket', '', 'ee_read_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_payment_method',
+					array('Payment_Method', '', 'ee_read_others_payment_methods', '')
+				),
+				// deletes
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_event',
+					array(
+						'Event',
+						'ee_delete_published_events',
+						'ee_delete_others_events',
+						'ee_delete_private_events',
+					)
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_venue',
+					array(
+						'Venue',
+						'ee_delete_published_venues',
+						'ee_delete_others_venues',
+						'ee_delete_private_venues',
+					)
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_registration',
+					array('Registration', '', 'ee_delete_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_checkin',
+					array('Registration', '', 'ee_delete_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_delete_message',
+					array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_default_ticket',
+					array('Ticket', '', 'ee_delete_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_delete_question',
+					array('Question', '', '', 'delete_system_questions')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_delete_question_group',
+					array('Question_Group', '', '', 'delete_system_question_groups')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_payment_method',
+					array('Payment_Method', '', 'ee_delete_others_payment_methods', '')
+				),
+			);
+		}
+		return $default_meta_caps;
+	}
+
+
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * The actual logic is carried out by implementer classes in their definition of _map_meta_caps.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array actual users capabilities
+	 * @throws EE_Error
+	 */
+	public function map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
+			// loop through our _meta_caps array
+			foreach ($this->_meta_caps as $meta_map) {
+				if (! $meta_map instanceof EE_Meta_Capability_Map) {
+					continue;
+				}
+				// don't load models if there is no object ID in the args
+				if (! empty($args[0])) {
+					$meta_map->ensure_is_model();
+				}
+				$caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
+			}
+		}
+		return $caps;
+	}
+
+
+	/**
+	 * This sets up and returns the initial capabilities map for Event Espresso
+	 * Note this array is filtered.
+	 * It is assumed that all available EE capabilities are assigned to the administrator role.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return array
+	 */
+	private function _init_caps_map()
+	{
+		return apply_filters(
+			'FHEE__EE_Capabilities__init_caps_map__caps',
+			array(
+				'administrator'           => array(
+					// basic access
+					'ee_read_ee',
+					// gateways
+					/**
+					 * note that with payment method capabilities, although we've implemented
+					 * capability mapping which will be used for accessing payment methods owned by
+					 * other users.  This is not fully implemented yet in the payment method ui.
+					 * Currently only the "plural" caps are in active use.
+					 * (Specific payment method caps are in use as well).
+					 **/
+					'ee_manage_gateways',
+					'ee_read_payment_methods',
+					'ee_read_others_payment_methods',
+					'ee_edit_payment_methods',
+					'ee_edit_others_payment_methods',
+					'ee_delete_payment_methods',
+					// events
+					'ee_publish_events',
+					'ee_read_private_events',
+					'ee_read_others_events',
+					'ee_read_events',
+					'ee_edit_events',
+					'ee_edit_published_events',
+					'ee_edit_others_events',
+					'ee_edit_private_events',
+					'ee_delete_published_events',
+					'ee_delete_private_events',
+					'ee_delete_events',
+					'ee_delete_others_events',
+					// event categories
+					'ee_manage_event_categories',
+					'ee_edit_event_category',
+					'ee_delete_event_category',
+					'ee_assign_event_category',
+					// venues
+					'ee_publish_venues',
+					'ee_read_venues',
+					'ee_read_others_venues',
+					'ee_read_private_venues',
+					'ee_edit_venues',
+					'ee_edit_others_venues',
+					'ee_edit_published_venues',
+					'ee_edit_private_venues',
+					'ee_delete_venues',
+					'ee_delete_others_venues',
+					'ee_delete_private_venues',
+					'ee_delete_published_venues',
+					// venue categories
+					'ee_manage_venue_categories',
+					'ee_edit_venue_category',
+					'ee_delete_venue_category',
+					'ee_assign_venue_category',
+					// contacts
+					'ee_read_contacts',
+					'ee_edit_contacts',
+					'ee_delete_contacts',
+					// registrations
+					'ee_read_registrations',
+					'ee_read_others_registrations',
+					'ee_edit_registrations',
+					'ee_edit_others_registrations',
+					'ee_delete_registrations',
+					'ee_delete_others_registrations',
+					// checkins
+					'ee_read_others_checkins',
+					'ee_read_checkins',
+					'ee_edit_checkins',
+					'ee_edit_others_checkins',
+					'ee_delete_checkins',
+					'ee_delete_others_checkins',
+					// transactions && payments
+					'ee_read_transaction',
+					'ee_read_transactions',
+					'ee_edit_payments',
+					'ee_delete_payments',
+					// messages
+					'ee_read_messages',
+					'ee_read_others_messages',
+					'ee_read_global_messages',
+					'ee_edit_global_messages',
+					'ee_edit_messages',
+					'ee_edit_others_messages',
+					'ee_delete_messages',
+					'ee_delete_others_messages',
+					'ee_delete_global_messages',
+					'ee_send_message',
+					// tickets
+					'ee_read_default_tickets',
+					'ee_read_others_default_tickets',
+					'ee_edit_default_tickets',
+					'ee_edit_others_default_tickets',
+					'ee_delete_default_tickets',
+					'ee_delete_others_default_tickets',
+					// prices
+					'ee_edit_default_price',
+					'ee_edit_default_prices',
+					'ee_delete_default_price',
+					'ee_delete_default_prices',
+					'ee_edit_default_price_type',
+					'ee_edit_default_price_types',
+					'ee_delete_default_price_type',
+					'ee_delete_default_price_types',
+					'ee_read_default_prices',
+					'ee_read_default_price_types',
+					// registration form
+					'ee_edit_questions',
+					'ee_edit_system_questions',
+					'ee_read_questions',
+					'ee_delete_questions',
+					'ee_edit_question_groups',
+					'ee_read_question_groups',
+					'ee_edit_system_question_groups',
+					'ee_delete_question_groups',
+					// event_type taxonomy
+					'ee_assign_event_type',
+					'ee_manage_event_types',
+					'ee_edit_event_type',
+					'ee_delete_event_type',
+				),
+				'ee_events_administrator' => array(
+					// core wp caps
+					'read',
+					'read_private_pages',
+					'read_private_posts',
+					'edit_users',
+					'edit_posts',
+					'edit_pages',
+					'edit_published_posts',
+					'edit_published_pages',
+					'edit_private_pages',
+					'edit_private_posts',
+					'edit_others_posts',
+					'edit_others_pages',
+					'publish_posts',
+					'publish_pages',
+					'delete_posts',
+					'delete_pages',
+					'delete_private_pages',
+					'delete_private_posts',
+					'delete_published_pages',
+					'delete_published_posts',
+					'delete_others_posts',
+					'delete_others_pages',
+					'manage_categories',
+					'manage_links',
+					'moderate_comments',
+					'unfiltered_html',
+					'upload_files',
+					'export',
+					'import',
+					'list_users',
+					'level_1', // required if user with this role shows up in author dropdowns
+					// basic ee access
+					'ee_read_ee',
+					// events
+					'ee_publish_events',
+					'ee_read_private_events',
+					'ee_read_others_events',
+					'ee_read_event',
+					'ee_read_events',
+					'ee_edit_event',
+					'ee_edit_events',
+					'ee_edit_published_events',
+					'ee_edit_others_events',
+					'ee_edit_private_events',
+					'ee_delete_published_events',
+					'ee_delete_private_events',
+					'ee_delete_event',
+					'ee_delete_events',
+					'ee_delete_others_events',
+					// event categories
+					'ee_manage_event_categories',
+					'ee_edit_event_category',
+					'ee_delete_event_category',
+					'ee_assign_event_category',
+					// venues
+					'ee_publish_venues',
+					'ee_read_venue',
+					'ee_read_venues',
+					'ee_read_others_venues',
+					'ee_read_private_venues',
+					'ee_edit_venue',
+					'ee_edit_venues',
+					'ee_edit_others_venues',
+					'ee_edit_published_venues',
+					'ee_edit_private_venues',
+					'ee_delete_venue',
+					'ee_delete_venues',
+					'ee_delete_others_venues',
+					'ee_delete_private_venues',
+					'ee_delete_published_venues',
+					// venue categories
+					'ee_manage_venue_categories',
+					'ee_edit_venue_category',
+					'ee_delete_venue_category',
+					'ee_assign_venue_category',
+					// contacts
+					'ee_read_contacts',
+					'ee_edit_contacts',
+					'ee_delete_contacts',
+					// registrations
+					'ee_read_registrations',
+					'ee_read_others_registrations',
+					'ee_edit_registration',
+					'ee_edit_registrations',
+					'ee_edit_others_registrations',
+					'ee_delete_registration',
+					'ee_delete_registrations',
+					'ee_delete_others_registrations',
+					// checkins
+					'ee_read_others_checkins',
+					'ee_read_checkins',
+					'ee_edit_checkins',
+					'ee_edit_others_checkins',
+					'ee_delete_checkins',
+					'ee_delete_others_checkins',
+					// transactions && payments
+					'ee_read_transaction',
+					'ee_read_transactions',
+					'ee_edit_payments',
+					'ee_delete_payments',
+					// messages
+					'ee_read_messages',
+					'ee_read_others_messages',
+					'ee_read_global_messages',
+					'ee_edit_global_messages',
+					'ee_edit_messages',
+					'ee_edit_others_messages',
+					'ee_delete_messages',
+					'ee_delete_others_messages',
+					'ee_delete_global_messages',
+					'ee_send_message',
+					// tickets
+					'ee_read_default_tickets',
+					'ee_read_others_default_tickets',
+					'ee_edit_default_tickets',
+					'ee_edit_others_default_tickets',
+					'ee_delete_default_tickets',
+					'ee_delete_others_default_tickets',
+					// prices
+					'ee_edit_default_price',
+					'ee_edit_default_prices',
+					'ee_delete_default_price',
+					'ee_delete_default_prices',
+					'ee_edit_default_price_type',
+					'ee_edit_default_price_types',
+					'ee_delete_default_price_type',
+					'ee_delete_default_price_types',
+					'ee_read_default_prices',
+					'ee_read_default_price_types',
+					// registration form
+					'ee_edit_questions',
+					'ee_edit_system_questions',
+					'ee_read_questions',
+					'ee_delete_questions',
+					'ee_edit_question_groups',
+					'ee_read_question_groups',
+					'ee_edit_system_question_groups',
+					'ee_delete_question_groups',
+					// event_type taxonomy
+					'ee_assign_event_type',
+					'ee_manage_event_types',
+					'ee_edit_event_type',
+					'ee_delete_event_type',
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	private function setupCapabilitiesMap()
+	{
+		// if the initialization process hasn't even started, then we need to call init_caps()
+		if ($this->initialized === null) {
+			return $this->init_caps();
+		}
+		// unless resetting, get caps from db if we haven't already
+		$this->capabilities_map = $this->reset || ! empty($this->capabilities_map)
+			? $this->capabilities_map
+			: get_option(self::option_name, array());
+		return true;
+	}
+
+
+	/**
+	 * @param bool $update
+	 * @return bool
+	 */
+	private function updateCapabilitiesMap($update = true)
+	{
+		return $update ? update_option(self::option_name, $this->capabilities_map) : false;
+	}
+
+
+	/**
+	 * Adds capabilities to roles.
+	 *
+	 * @since 4.9.42
+	 * @param array $capabilities_to_add array of capabilities to add, indexed by roles.
+	 *                                   Note that this should ONLY be called on activation hook
+	 *                                   otherwise the caps will be added on every request.
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function addCaps(array $capabilities_to_add)
+	{
+		// don't do anything if the capabilities map can not be initialized
+		if (! $this->setupCapabilitiesMap()) {
+			return false;
+		}
+		// and filter the array so others can get in on the fun during resets
+		$capabilities_to_add = apply_filters(
+			'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
+			$capabilities_to_add,
+			$this->reset,
+			$this->capabilities_map
+		);
+		$update_capabilities_map = false;
+		// if not reset, see what caps are new for each role. if they're new, add them.
+		foreach ($capabilities_to_add as $role => $caps_for_role) {
+			if (is_array($caps_for_role)) {
+				foreach ($caps_for_role as $cap) {
+					if (! $this->capHasBeenAddedToRole($role, $cap)
+						&& $this->add_cap_to_role($role, $cap, true, false)
+					) {
+						$update_capabilities_map = true;
+					}
+				}
+			}
+		}
+		// now let's just save the cap that has been set but only if there's been a change.
+		$updated = $this->updateCapabilitiesMap($update_capabilities_map);
+		$this->flushWpUser($updated);
+		do_action('AHEE__EE_Capabilities__addCaps__complete', $this->capabilities_map, $updated);
+		return $updated;
+	}
+
+
+	/**
+	 * Loops through the capabilities map and removes the role caps specified by the incoming array
+	 *
+	 * @param array $caps_map map of capabilities to be removed (indexed by roles)
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function removeCaps($caps_map)
+	{
+		// don't do anything if the capabilities map can not be initialized
+		if (! $this->setupCapabilitiesMap()) {
+			return false;
+		}
+		$update_capabilities_map = false;
+		foreach ($caps_map as $role => $caps_for_role) {
+			if (is_array($caps_for_role)) {
+				foreach ($caps_for_role as $cap) {
+					if ($this->capHasBeenAddedToRole($role, $cap)
+						&& $this->remove_cap_from_role($role, $cap, false)
+					) {
+						$update_capabilities_map = true;
+					}
+				}
+			}
+		}
+		// maybe resave the caps
+		$updated = $this->updateCapabilitiesMap($update_capabilities_map);
+		$this->flushWpUser($updated);
+		return $updated;
+	}
+
+
+	/**
+	 * This ensures that the WP User object cached on the $current_user global in WP has the latest capabilities from
+	 * the roles on that user.
+	 *
+	 * @param bool $flush Default is to flush the WP_User object.  If false, then this method effectively does nothing.
+	 */
+	private function flushWpUser($flush = true)
+	{
+		if ($flush) {
+			$user = wp_get_current_user();
+			if ($user instanceof WP_User) {
+				$user->get_role_caps();
+			}
+		}
+	}
+
+
+	/**
+	 * This method sets a capability on a role.  Note this should only be done on activation, or if you have something
+	 * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note.
+	 * this is a wrapper for $wp_role->add_cap()
+	 *
+	 * @see   wp-includes/capabilities.php
+	 * @since 4.5.0
+	 * @param string|WP_Role $role  A WordPress role the capability is being added to
+	 * @param string         $cap   The capability being added to the role
+	 * @param bool           $grant Whether to grant access to this cap on this role.
+	 * @param bool           $update_capabilities_map
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function add_cap_to_role($role, $cap, $grant = true, $update_capabilities_map = true)
+	{
+		// capture incoming value for $role because we may need it to create a new WP_Role
+		$orig_role = $role;
+		$role = $role instanceof WP_Role ? $role : get_role($role);
+		// if the role isn't available then we create it.
+		if (! $role instanceof WP_Role) {
+			// if a plugin wants to create a specific role name then they should create the role before
+			// EE_Capabilities does.  Otherwise this function will create the role name from the slug:
+			// - removes any `ee_` namespacing from the start of the slug.
+			// - replaces `_` with ` ` (empty space).
+			// - sentence case on the resulting string.
+			$role_label = ucwords(str_replace(array('ee_', '_'), array('', ' '), $orig_role));
+			$role = add_role($orig_role, $role_label);
+		}
+		if ($role instanceof WP_Role) {
+			// don't do anything if the capabilities map can not be initialized
+			if (! $this->setupCapabilitiesMap()) {
+				return false;
+			}
+			if (! $this->capHasBeenAddedToRole($role->name, $cap)) {
+				$role->add_cap($cap, $grant);
+				$this->capabilities_map[ $role->name ][] = $cap;
+				$this->updateCapabilitiesMap($update_capabilities_map);
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Functions similarly to add_cap_to_role except removes cap from given role.
+	 * Wrapper for $wp_role->remove_cap()
+	 *
+	 * @see   wp-includes/capabilities.php
+	 * @since 4.5.0
+	 * @param string|WP_Role $role A WordPress role the capability is being removed from.
+	 * @param string         $cap  The capability being removed
+	 * @param bool           $update_capabilities_map
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function remove_cap_from_role($role, $cap, $update_capabilities_map = true)
+	{
+		// don't do anything if the capabilities map can not be initialized
+		if (! $this->setupCapabilitiesMap()) {
+			return false;
+		}
+
+		$role = $role instanceof WP_Role ? $role : get_role($role);
+		if ($role instanceof WP_Role && $index = $this->capHasBeenAddedToRole($role->name, $cap, true)) {
+			$role->remove_cap($cap);
+			unset($this->capabilities_map[ $role->name ][ $index ]);
+			$this->updateCapabilitiesMap($update_capabilities_map);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param string $role_name
+	 * @param string $cap
+	 * @param bool   $get_index
+	 * @return bool|mixed
+	 */
+	private function capHasBeenAddedToRole($role_name = '', $cap = '', $get_index = false)
+	{
+		if (isset($this->capabilities_map[ $role_name ])
+			&& ($index = array_search($cap, $this->capabilities_map[ $role_name ], true)) !== false
+		) {
+			return $get_index ? $index : true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Wrapper for the native WP current_user_can() method.
+	 * This is provided as a handy method for a couple things:
+	 * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
+	 * write those filters wherever current_user_can is called).
+	 * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $cap     The cap being checked.
+	 * @param string $context The context where the current_user_can is being called from.
+	 * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
+	 *                        filters.
+	 *
+	 * @return bool  Whether user can or not.
+	 */
+	public function current_user_can($cap, $context, $id = 0)
+	{
+		// apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
+		$filtered_cap = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can__cap',
+			$filtered_cap,
+			$context,
+			$cap,
+			$id
+		);
+		return ! empty($id)
+			? current_user_can($filtered_cap, $id)
+			: current_user_can($filtered_cap);
+	}
+
+
+	/**
+	 * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class.
+	 *
+	 * @param int|WP_User $user    Either the user_id or a WP_User object
+	 * @param string      $cap     The capability string being checked
+	 * @param string      $context The context where the user_can is being called from (used in filters).
+	 * @param int         $id      Optional. Id for item where user_can is being called from ( used in map_meta_cap()
+	 *                             filters)
+	 *
+	 * @return bool Whether user can or not.
+	 */
+	public function user_can($user, $cap, $context, $id = 0)
+	{
+		// apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
+		$filtered_cap = apply_filters(
+			'FHEE__EE_Capabilities__user_can__cap',
+			$filtered_cap,
+			$context,
+			$cap,
+			$user,
+			$id
+		);
+		return ! empty($id)
+			? user_can($user, $filtered_cap, $id)
+			: user_can($user, $filtered_cap);
+	}
+
+
+	/**
+	 * Wrapper for the native WP current_user_can_for_blog() method.
+	 * This is provided as a handy method for a couple things:
+	 * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
+	 * write those filters wherever current_user_can is called).
+	 * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param int    $blog_id The blog id that is being checked for.
+	 * @param string $cap     The cap being checked.
+	 * @param string $context The context where the current_user_can is being called from.
+	 * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
+	 *                        filters.
+	 *
+	 * @return bool  Whether user can or not.
+	 */
+	public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0)
+	{
+		$user_can = ! empty($id)
+			? current_user_can_for_blog($blog_id, $cap, $id)
+			: current_user_can($blog_id, $cap);
+		// apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$user_can = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
+			$user_can,
+			$blog_id,
+			$cap,
+			$id
+		);
+		$user_can = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can_for_blog__user_can',
+			$user_can,
+			$context,
+			$blog_id,
+			$cap,
+			$id
+		);
+		return $user_can;
+	}
+
+
+	/**
+	 * This helper method just returns an array of registered EE capabilities.
+	 *
+	 * @since 4.5.0
+	 * @param string $role If empty then the entire role/capability map is returned.
+	 *                     Otherwise just the capabilities for the given role are returned.
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_ee_capabilities($role = 'administrator')
+	{
+		if (! $this->initialized) {
+			$this->init_caps();
+		}
+		if (empty($role)) {
+			return $this->capabilities_map;
+		}
+		return isset($this->capabilities_map[ $role ])
+			? $this->capabilities_map[ $role ]
+			: array();
+	}
+
+
+	/**
+	 * @deprecated 4.9.42
+	 * @param bool  $reset      If you need to reset Event Espresso's capabilities,
+	 *                          then please use the init_caps() method with the "$reset" parameter set to "true"
+	 * @param array $caps_map   Optional.
+	 *                          Can be used to send a custom map of roles and capabilities for setting them up.
+	 *                          Note that this should ONLY be called on activation hook or some other one-time
+	 *                          task otherwise the caps will be added on every request.
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function init_role_caps($reset = false, $caps_map = array())
+	{
+		// If this method is called directly and reset is set as 'true',
+		// then display a doing it wrong notice, because we want resets to go through init_caps()
+		// to guarantee that everything is set up correctly.
+		// This prevents the capabilities map getting reset incorrectly by direct calls to this method.
+		if ($reset) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'The "%1$s" parameter for the "%2$s" method is deprecated. If you need to reset Event Espresso\'s capabilities, then please use the "%3$s" method with the "%1$s" parameter set to "%4$s".',
+						'event_espresso'
+					),
+					'$reset',
+					__METHOD__ . '()',
+					'EE_Capabilities::init_caps()',
+					'true'
+				),
+				'4.9.42',
+				'5.0.0'
+			);
+		}
+		$this->addCaps($caps_map);
+	}
 }
 
 
@@ -1005,142 +1005,142 @@ 
 abstract class EE_Meta_Capability_Map
 {
 
-    public $meta_cap;
-
-    /**
-     * @var EEM_Base
-     */
-    protected $_model;
-
-    protected $_model_name;
-
-    public $published_cap = '';
-
-    public $others_cap = '';
-
-    public $private_cap = '';
-
-
-    /**
-     * constructor.
-     * Receives the setup arguments for the map.
-     *
-     * @since                        4.5.0
-     *
-     * @param string $meta_cap   What meta capability is this mapping.
-     * @param array  $map_values array {
-     *                           //array of values that MUST match a count of 4.  It's okay to send an empty string for
-     *                           capabilities that don't get mapped to.
-     *
-     * @type         $map_values [0] string A string representing the model name. Required.  String's
-     *                               should always be used when Menu Maps are registered via the
-     *                               plugin API as models are not allowed to be instantiated when
-     *                               in maintenance mode 2 (migrations).
-     * @type         $map_values [1] string represents the capability used for published. Optional.
-     * @type         $map_values [2] string represents the capability used for "others". Optional.
-     * @type         $map_values [3] string represents the capability used for private. Optional.
-     *                               }
-     * @throws EE_Error
-     */
-    public function __construct($meta_cap, $map_values)
-    {
-        $this->meta_cap = $meta_cap;
-        // verify there are four args in the $map_values array;
-        if (count($map_values) !== 4) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
-                        'event_espresso'
-                    ),
-                    '<br>' . print_r($map_values, true)
-                )
-            );
-        }
-        // set properties
-        $this->_model = null;
-        $this->_model_name = $map_values[0];
-        $this->published_cap = (string) $map_values[1];
-        $this->others_cap = (string) $map_values[2];
-        $this->private_cap = (string) $map_values[3];
-    }
-
-    /**
-     * Makes it so this object stops filtering caps
-     */
-    public function remove_filters()
-    {
-        remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10);
-    }
-
-
-    /**
-     * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class
-     *
-     * @since 4.5.0
-     * @throws EE_Error
-     *
-     * @return void
-     */
-    public function ensure_is_model()
-    {
-        // is it already instantiated?
-        if ($this->_model instanceof EEM_Base) {
-            return;
-        }
-        // ensure model name is string
-        $this->_model_name = (string) $this->_model_name;
-        // error proof if the name has EEM in it
-        $this->_model_name = str_replace('EEM', '', $this->_model_name);
-        $this->_model = EE_Registry::instance()->load_model($this->_model_name);
-        if (! $this->_model instanceof EEM_Base) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    $this->_model
-                )
-            );
-        }
-    }
-
-
-    /**
-     *
-     * @see   EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
-     * @since 4.6.x
-     *
-     * @param $caps
-     * @param $cap
-     * @param $user_id
-     * @param $args
-     *
-     * @return array
-     */
-    public function map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        return $this->_map_meta_caps($caps, $cap, $user_id, $args);
-    }
-
-
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    abstract protected function _map_meta_caps($caps, $cap, $user_id, $args);
+	public $meta_cap;
+
+	/**
+	 * @var EEM_Base
+	 */
+	protected $_model;
+
+	protected $_model_name;
+
+	public $published_cap = '';
+
+	public $others_cap = '';
+
+	public $private_cap = '';
+
+
+	/**
+	 * constructor.
+	 * Receives the setup arguments for the map.
+	 *
+	 * @since                        4.5.0
+	 *
+	 * @param string $meta_cap   What meta capability is this mapping.
+	 * @param array  $map_values array {
+	 *                           //array of values that MUST match a count of 4.  It's okay to send an empty string for
+	 *                           capabilities that don't get mapped to.
+	 *
+	 * @type         $map_values [0] string A string representing the model name. Required.  String's
+	 *                               should always be used when Menu Maps are registered via the
+	 *                               plugin API as models are not allowed to be instantiated when
+	 *                               in maintenance mode 2 (migrations).
+	 * @type         $map_values [1] string represents the capability used for published. Optional.
+	 * @type         $map_values [2] string represents the capability used for "others". Optional.
+	 * @type         $map_values [3] string represents the capability used for private. Optional.
+	 *                               }
+	 * @throws EE_Error
+	 */
+	public function __construct($meta_cap, $map_values)
+	{
+		$this->meta_cap = $meta_cap;
+		// verify there are four args in the $map_values array;
+		if (count($map_values) !== 4) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
+						'event_espresso'
+					),
+					'<br>' . print_r($map_values, true)
+				)
+			);
+		}
+		// set properties
+		$this->_model = null;
+		$this->_model_name = $map_values[0];
+		$this->published_cap = (string) $map_values[1];
+		$this->others_cap = (string) $map_values[2];
+		$this->private_cap = (string) $map_values[3];
+	}
+
+	/**
+	 * Makes it so this object stops filtering caps
+	 */
+	public function remove_filters()
+	{
+		remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10);
+	}
+
+
+	/**
+	 * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class
+	 *
+	 * @since 4.5.0
+	 * @throws EE_Error
+	 *
+	 * @return void
+	 */
+	public function ensure_is_model()
+	{
+		// is it already instantiated?
+		if ($this->_model instanceof EEM_Base) {
+			return;
+		}
+		// ensure model name is string
+		$this->_model_name = (string) $this->_model_name;
+		// error proof if the name has EEM in it
+		$this->_model_name = str_replace('EEM', '', $this->_model_name);
+		$this->_model = EE_Registry::instance()->load_model($this->_model_name);
+		if (! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s',
+						'event_espresso'
+					),
+					get_class($this),
+					$this->_model
+				)
+			);
+		}
+	}
+
+
+	/**
+	 *
+	 * @see   EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
+	 * @since 4.6.x
+	 *
+	 * @param $caps
+	 * @param $cap
+	 * @param $user_id
+	 * @param $args
+	 *
+	 * @return array
+	 */
+	public function map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		return $this->_map_meta_caps($caps, $cap, $user_id, $args);
+	}
+
+
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	abstract protected function _map_meta_caps($caps, $cap, $user_id, $args);
 }
 
 
@@ -1156,81 +1156,81 @@ 
 class EE_Meta_Capability_Map_Edit extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        // only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        // okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
-        }
-
-        // cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        /** @var EE_Base_Class $obj */
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        // if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-        $caps[] = $cap . 's';
-        if ($obj instanceof EE_CPT_Base) {
-            // if the item author is set and the user is the author...
-            if ($obj->wp_user() && $user_id === $obj->wp_user()) {
-                // if obj is published...
-                if ($obj->status() === 'publish') {
-                    $caps[] = $this->published_cap;
-                }
-            } else {
-                // the user is trying to edit someone else's obj
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-                if (! empty($this->published_cap) && $obj->status() === 'publish') {
-                    $caps[] = $this->published_cap;
-                } elseif (! empty($this->private_cap) && $obj->status() === 'private') {
-                    $caps[] = $this->private_cap;
-                }
-            }
-        } else {
-            // not a cpt object so handled differently
-            $has_cap = false;
-            try {
-                $has_cap = method_exists($obj, 'wp_user')
-                           && $obj->wp_user()
-                           && $obj->wp_user() === $user_id;
-            } catch (Exception $e) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            if (! $has_cap) {
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		// only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		// okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[ $key ]);
+		}
+
+		// cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		/** @var EE_Base_Class $obj */
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		// if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+		$caps[] = $cap . 's';
+		if ($obj instanceof EE_CPT_Base) {
+			// if the item author is set and the user is the author...
+			if ($obj->wp_user() && $user_id === $obj->wp_user()) {
+				// if obj is published...
+				if ($obj->status() === 'publish') {
+					$caps[] = $this->published_cap;
+				}
+			} else {
+				// the user is trying to edit someone else's obj
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+				if (! empty($this->published_cap) && $obj->status() === 'publish') {
+					$caps[] = $this->published_cap;
+				} elseif (! empty($this->private_cap) && $obj->status() === 'private') {
+					$caps[] = $this->private_cap;
+				}
+			}
+		} else {
+			// not a cpt object so handled differently
+			$has_cap = false;
+			try {
+				$has_cap = method_exists($obj, 'wp_user')
+						   && $obj->wp_user()
+						   && $obj->wp_user() === $user_id;
+			} catch (Exception $e) {
+				if (WP_DEBUG) {
+					EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			if (! $has_cap) {
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1247,24 +1247,24 @@ 
 class EE_Meta_Capability_Map_Delete extends EE_Meta_Capability_Map_Edit
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        return parent::_map_meta_caps($caps, $cap, $user_id, $args);
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		return parent::_map_meta_caps($caps, $cap, $user_id, $args);
+	}
 }
 
 
@@ -1280,85 +1280,85 @@ 
 class EE_Meta_Capability_Map_Read extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        // only process if we're checking our mapped cap;
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        // okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
-        }
-
-        // cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        // if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-
-        $caps[] = $cap . 's';
-        if ($obj instanceof EE_CPT_Base) {
-            $status_obj = get_post_status_object($obj->status());
-            if ($status_obj->public) {
-                return $caps;
-            }
-            // if the item author is set and the user is not the author...
-            if ($obj->wp_user() && $obj->wp_user() !== $user_id) {
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-            // yes this means that if users created the private post, they are able to see it regardless of private cap.
-            if ($status_obj->private
-                && ! empty($this->private_cap)
-                && $obj->wp_user() !== $user_id
-            ) {
-                // the user is trying to view a private object for an object they don't own.
-                $caps[] = $this->private_cap;
-            }
-        } else {
-            // not a cpt object so handled differently
-            $has_cap = false;
-            try {
-                $has_cap = method_exists($obj, 'wp_user')
-                           && $obj->wp_user()
-                           && $obj->wp_user() === $user_id;
-            } catch (Exception $e) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            if (! $has_cap) {
-                if (! empty($this->private_cap)) {
-                    $caps[] = $this->private_cap;
-                }
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		// only process if we're checking our mapped cap;
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		// okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[ $key ]);
+		}
+
+		// cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		// if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+
+		$caps[] = $cap . 's';
+		if ($obj instanceof EE_CPT_Base) {
+			$status_obj = get_post_status_object($obj->status());
+			if ($status_obj->public) {
+				return $caps;
+			}
+			// if the item author is set and the user is not the author...
+			if ($obj->wp_user() && $obj->wp_user() !== $user_id) {
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+			// yes this means that if users created the private post, they are able to see it regardless of private cap.
+			if ($status_obj->private
+				&& ! empty($this->private_cap)
+				&& $obj->wp_user() !== $user_id
+			) {
+				// the user is trying to view a private object for an object they don't own.
+				$caps[] = $this->private_cap;
+			}
+		} else {
+			// not a cpt object so handled differently
+			$has_cap = false;
+			try {
+				$has_cap = method_exists($obj, 'wp_user')
+						   && $obj->wp_user()
+						   && $obj->wp_user() === $user_id;
+			} catch (Exception $e) {
+				if (WP_DEBUG) {
+					EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			if (! $has_cap) {
+				if (! empty($this->private_cap)) {
+					$caps[] = $this->private_cap;
+				}
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1375,56 +1375,56 @@ 
 class EE_Meta_Capability_Map_Messages_Cap extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        // only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        // okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
-        }
-
-        // cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        // if no obj then let's just do cap
-        if (! $obj instanceof EE_Message_Template_Group) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-        $caps[] = $cap . 's';
-        $is_global = $obj->is_global();
-        if ($obj->wp_user() && $obj->wp_user() === $user_id) {
-            if ($is_global) {
-                $caps[] = $this->private_cap;
-            }
-        } else {
-            if ($is_global) {
-                $caps[] = $this->private_cap;
-            } else {
-                $caps[] = $this->others_cap;
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		// only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		// okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[ $key ]);
+		}
+
+		// cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		// if no obj then let's just do cap
+		if (! $obj instanceof EE_Message_Template_Group) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+		$caps[] = $cap . 's';
+		$is_global = $obj->is_global();
+		if ($obj->wp_user() && $obj->wp_user() === $user_id) {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
+			}
+		} else {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
+			} else {
+				$caps[] = $this->others_cap;
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1441,40 +1441,40 @@ 
 class EE_Meta_Capability_Map_Registration_Form_Cap extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        // only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-        // okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
-        }
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        // if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-        $caps[] = $cap . 's';
-        $is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
-        $is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
-        if ($is_system) {
-            $caps[] = $this->private_cap;
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		// only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+		// okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[ $key ]);
+		}
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		// if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+		$caps[] = $cap . 's';
+		$is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
+		$is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
+		if ($is_system) {
+			$caps[] = $this->private_cap;
+		}
+		return $caps;
+	}
 }

caffeinated/admin/extend/transactions/Extend_Transactions_Admin_Page.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -198,7 +198,7 @@
      *
      * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
      *
-     * @return int
+     * @return string
      */
     private function _revenue_per_event_report($period = '-1 month')
     {

Indentation +235 added lines, -235 removed lines

@@ -16,239 +16,239 @@
 {
 
 
-    /**
-     * This is used to hold the reports template data which is setup early in the request.
-     *
-     * @type array
-     */
-    protected $_reports_template_data = array();
-
-    /**
-     * @Constructor
-     * @access public
-     *
-     * @param bool $routing
-     *
-     * @return \Extend_Transactions_Admin_Page
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/');
-        define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/');
-        define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/');
-    }
-
-
-    /**
-     *    _extend_page_config
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions';
-
-        $new_page_routes = array(
-            'reports' => array(
-                'func'       => '_transaction_reports',
-                'capability' => 'ee_read_transactions',
-            ),
-        );
-
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-
-        $new_page_config = array(
-            'reports' => array(
-                'nav'           => array(
-                    'label' => __('Reports', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'help_tabs'     => array(
-                    'transactions_reports_help_tab' => array(
-                        'title'    => __('Transaction Reports', 'event_espresso'),
-                        'filename' => 'transactions_reports',
-                    ),
-                ),
-                /*'help_tour' => array( 'Transaction_Reports_Help_Tour' ),*/
-                'require_nonce' => false,
-            ),
-        );
-        $this->_page_config = array_merge($this->_page_config, $new_page_config);
-    }
-
-
-    /**
-     *    load_scripts_styles_reports
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles_reports()
-    {
-        wp_register_script(
-            'ee-txn-reports-js',
-            TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js',
-            array('google-charts'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-txn-reports-js');
-        $this->_transaction_reports_js_setup();
-        EE_Registry::$i18n_js_strings['currency_format'] = EEH_Money::get_format_for_google_charts();
-    }
-
-
-    /**
-     * This is called when javascript is being enqueued to setup the various data needed for the reports js.
-     * Also $this->{$_reports_template_data} property is set for later usage by the _transaction_reports method.
-     */
-    protected function _transaction_reports_js_setup()
-    {
-        $this->_reports_template_data['admin_reports'][] = $this->_revenue_per_day_report();
-        $this->_reports_template_data['admin_reports'][] = $this->_revenue_per_event_report();
-    }
-
-
-    /**
-     * _transaction_reports
-     *    generates Business Reports regarding Transactions
-     *
-     * @return void
-     */
-    protected function _transaction_reports()
-    {
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
-        $this->_admin_page_title = __('Transactions', 'event_espresso');
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $template_path,
-            $this->_reports_template_data,
-            true
-        );
-
-        // the final template wrapper
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * _revenue_per_day_report
-     * generates Business Report showing Total Revenue per Day.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     *
-     * @return string
-     */
-    private function _revenue_per_day_report($period = '-1 month')
-    {
-
-        $report_ID = 'txn-admin-revenue-per-day-report-dv';
-
-        $TXN = EEM_Transaction::instance();
-
-        $results = $TXN->get_revenue_per_day_report($period);
-        $results = (array) $results;
-        $revenue = array();
-        $subtitle = '';
-
-        if ($results) {
-            $revenue[] = array(
-                __('Date (only shows dates that have a revenue greater than 1)', 'event_espresso'),
-                __('Total Revenue', 'event_espresso'),
-            );
-            foreach ($results as $result) {
-                $revenue[] = array($result->txnDate, (float) $result->revenue);
-            }
-
-            // setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $ending_date = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $subtitle = sprintf(
-                _x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'),
-                $ending_date->format('Y-m-d')
-            );
-        }
-
-        $report_title = esc_html__('Total Revenue per Day', 'event_espresso');
-
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'revenue'   => $revenue,
-            'noResults' => empty($revenue) || count($revenue) === 1,
-            'noTxnMsg'  => sprintf(
-                __('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>',
-                '</p>'
-            ),
-        );
-        wp_localize_script('ee-txn-reports-js', 'txnRevPerDay', $report_params);
-
-        return $report_ID;
-    }
-
-
-    /**
-     * _revenue_per_event_report
-     * generates Business Report showing total revenue per event.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     *
-     * @return int
-     */
-    private function _revenue_per_event_report($period = '-1 month')
-    {
-
-        $report_ID = 'txn-admin-revenue-per-event-report-dv';
-
-        $TXN = EEM_Transaction::instance();
-        $results = $TXN->get_revenue_per_event_report($period);
-        $results = (array) $results;
-        $revenue = array();
-        $subtitle = '';
-
-        if ($results) {
-            $revenue[] = array(
-                __('Event (only events that have a revenue greater than 1 are shown)', 'event_espresso'),
-                __('Total Revenue', 'event_espresso'),
-            );
-            foreach ($results as $result) {
-                if ($result->revenue > 1) {
-                    $event_name = stripslashes(html_entity_decode($result->event_name, ENT_QUOTES, 'UTF-8'));
-                    $event_name = wp_trim_words($event_name, 5, '...');
-                    $revenue[] = array($event_name, (float) $result->revenue);
-                }
-            }
-
-            // setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $ending_date = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $subtitle = sprintf(
-                _x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'),
-                $ending_date->format('Y-m-d')
-            );
-        }
-
-        $report_title = esc_html__('Total Revenue per Event', 'event_espresso');
-
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'revenue'   => $revenue,
-            'noResults' => empty($revenue),
-            'noTxnMsg'  => sprintf(
-                __('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>',
-                '</p>'
-            ),
-        );
-        wp_localize_script('ee-txn-reports-js', 'txnRevPerEvent', $report_params);
-
-        return $report_ID;
-    }
+	/**
+	 * This is used to hold the reports template data which is setup early in the request.
+	 *
+	 * @type array
+	 */
+	protected $_reports_template_data = array();
+
+	/**
+	 * @Constructor
+	 * @access public
+	 *
+	 * @param bool $routing
+	 *
+	 * @return \Extend_Transactions_Admin_Page
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/');
+		define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/');
+		define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/');
+	}
+
+
+	/**
+	 *    _extend_page_config
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions';
+
+		$new_page_routes = array(
+			'reports' => array(
+				'func'       => '_transaction_reports',
+				'capability' => 'ee_read_transactions',
+			),
+		);
+
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+
+		$new_page_config = array(
+			'reports' => array(
+				'nav'           => array(
+					'label' => __('Reports', 'event_espresso'),
+					'order' => 20,
+				),
+				'help_tabs'     => array(
+					'transactions_reports_help_tab' => array(
+						'title'    => __('Transaction Reports', 'event_espresso'),
+						'filename' => 'transactions_reports',
+					),
+				),
+				/*'help_tour' => array( 'Transaction_Reports_Help_Tour' ),*/
+				'require_nonce' => false,
+			),
+		);
+		$this->_page_config = array_merge($this->_page_config, $new_page_config);
+	}
+
+
+	/**
+	 *    load_scripts_styles_reports
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles_reports()
+	{
+		wp_register_script(
+			'ee-txn-reports-js',
+			TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js',
+			array('google-charts'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-txn-reports-js');
+		$this->_transaction_reports_js_setup();
+		EE_Registry::$i18n_js_strings['currency_format'] = EEH_Money::get_format_for_google_charts();
+	}
+
+
+	/**
+	 * This is called when javascript is being enqueued to setup the various data needed for the reports js.
+	 * Also $this->{$_reports_template_data} property is set for later usage by the _transaction_reports method.
+	 */
+	protected function _transaction_reports_js_setup()
+	{
+		$this->_reports_template_data['admin_reports'][] = $this->_revenue_per_day_report();
+		$this->_reports_template_data['admin_reports'][] = $this->_revenue_per_event_report();
+	}
+
+
+	/**
+	 * _transaction_reports
+	 *    generates Business Reports regarding Transactions
+	 *
+	 * @return void
+	 */
+	protected function _transaction_reports()
+	{
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+		$this->_admin_page_title = __('Transactions', 'event_espresso');
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$template_path,
+			$this->_reports_template_data,
+			true
+		);
+
+		// the final template wrapper
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * _revenue_per_day_report
+	 * generates Business Report showing Total Revenue per Day.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 *
+	 * @return string
+	 */
+	private function _revenue_per_day_report($period = '-1 month')
+	{
+
+		$report_ID = 'txn-admin-revenue-per-day-report-dv';
+
+		$TXN = EEM_Transaction::instance();
+
+		$results = $TXN->get_revenue_per_day_report($period);
+		$results = (array) $results;
+		$revenue = array();
+		$subtitle = '';
+
+		if ($results) {
+			$revenue[] = array(
+				__('Date (only shows dates that have a revenue greater than 1)', 'event_espresso'),
+				__('Total Revenue', 'event_espresso'),
+			);
+			foreach ($results as $result) {
+				$revenue[] = array($result->txnDate, (float) $result->revenue);
+			}
+
+			// setup the date range.
+			$beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$ending_date = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$subtitle = sprintf(
+				_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'),
+				$ending_date->format('Y-m-d')
+			);
+		}
+
+		$report_title = esc_html__('Total Revenue per Day', 'event_espresso');
+
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'revenue'   => $revenue,
+			'noResults' => empty($revenue) || count($revenue) === 1,
+			'noTxnMsg'  => sprintf(
+				__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
+				'<h2>' . $report_title . '</h2><p>',
+				'</p>'
+			),
+		);
+		wp_localize_script('ee-txn-reports-js', 'txnRevPerDay', $report_params);
+
+		return $report_ID;
+	}
+
+
+	/**
+	 * _revenue_per_event_report
+	 * generates Business Report showing total revenue per event.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 *
+	 * @return int
+	 */
+	private function _revenue_per_event_report($period = '-1 month')
+	{
+
+		$report_ID = 'txn-admin-revenue-per-event-report-dv';
+
+		$TXN = EEM_Transaction::instance();
+		$results = $TXN->get_revenue_per_event_report($period);
+		$results = (array) $results;
+		$revenue = array();
+		$subtitle = '';
+
+		if ($results) {
+			$revenue[] = array(
+				__('Event (only events that have a revenue greater than 1 are shown)', 'event_espresso'),
+				__('Total Revenue', 'event_espresso'),
+			);
+			foreach ($results as $result) {
+				if ($result->revenue > 1) {
+					$event_name = stripslashes(html_entity_decode($result->event_name, ENT_QUOTES, 'UTF-8'));
+					$event_name = wp_trim_words($event_name, 5, '...');
+					$revenue[] = array($event_name, (float) $result->revenue);
+				}
+			}
+
+			// setup the date range.
+			$beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$ending_date = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$subtitle = sprintf(
+				_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'),
+				$ending_date->format('Y-m-d')
+			);
+		}
+
+		$report_title = esc_html__('Total Revenue per Event', 'event_espresso');
+
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'revenue'   => $revenue,
+			'noResults' => empty($revenue),
+			'noTxnMsg'  => sprintf(
+				__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
+				'<h2>' . $report_title . '</h2><p>',
+				'</p>'
+			),
+		);
+		wp_localize_script('ee-txn-reports-js', 'txnRevPerEvent', $report_params);
+
+		return $report_ID;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -34,9 +34,9 @@ 
     public function __construct($routing = true)
     {
         parent::__construct($routing);
-        define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/');
-        define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/');
-        define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/');
+        define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND.'transactions/templates/');
+        define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND.'transactions/assets/');
+        define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'transactions/assets/');
     }
 
 
@@ -48,7 +48,7 @@ 
      */
     protected function _extend_page_config()
     {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions';
+        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND.'transactions';
 
         $new_page_routes = array(
             'reports' => array(
@@ -89,7 +89,7 @@ 
     {
         wp_register_script(
             'ee-txn-reports-js',
-            TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js',
+            TXN_CAF_ASSETS_URL.'ee-transaction-admin-reports.js',
             array('google-charts'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -119,7 +119,7 @@ 
      */
     protected function _transaction_reports()
     {
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+        $template_path = EE_ADMIN_TEMPLATE.'admin_reports.template.php';
         $this->_admin_page_title = __('Transactions', 'event_espresso');
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
             $template_path,
@@ -162,7 +162,7 @@ 
             }
 
             // setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+            $beginning_date = new DateTime('now'.$period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $ending_date = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $subtitle = sprintf(
                 _x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
@@ -181,7 +181,7 @@ 
             'noResults' => empty($revenue) || count($revenue) === 1,
             'noTxnMsg'  => sprintf(
                 __('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>',
+                '<h2>'.$report_title.'</h2><p>',
                 '</p>'
             ),
         );
@@ -224,7 +224,7 @@ 
             }
 
             // setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+            $beginning_date = new DateTime('now'.$period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $ending_date = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $subtitle = sprintf(
                 _x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
@@ -243,7 +243,7 @@ 
             'noResults' => empty($revenue),
             'noTxnMsg'  => sprintf(
                 __('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>',
+                '<h2>'.$report_title.'</h2><p>',
                 '</p>'
             ),
         );

caffeinated/EE_Caf_Messages.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
      *
      * @param  array $dir_ref original array of paths
      *
-     * @return array           appended paths
+     * @return string[]           appended paths
      */
     public function messages_autoload_paths($dir_ref)
     {
@@ -701,7 +701,7 @@ 
      * @param EE_Question[]  $questions        An array of questions indexed by answer id.
      * @param EE_Answer[]    $answers          An array of answer objects
      * @param string         $template         Template content to be parsed.
-     * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
+     * @param string[]          $valid_shortcodes Valid shortcodes for the template being parsed.
      * @param array          $extra_data       Extra data that might be used when parsing the template.
      */
     protected function _parse_question_list_for_primary_or_recipient_registration(

Indentation +799 added lines, -799 removed lines

@@ -13,803 +13,803 @@
 {
 
 
-    /**
-     * constructor.
-     */
-    public function __construct()
-    {
-        $this->_caf_hooks();
-    }
-
-
-    /**
-     * Contains all the hooks filters for setting up caffeinated messages functionality.
-     *
-     * @since 4.3.2
-     *
-     * @return void
-     */
-    private function _caf_hooks()
-    {
-        add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5);
-        add_filter(
-            'FHEE__EE_Email_messenger__get_validator_config',
-            array($this, 'email_messenger_validator_config'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Email_messenger__get_template_fields',
-            array($this, 'email_messenger_template_fields'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Html_messenger__get_template_fields',
-            array($this, 'html_messenger_template_fields'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Html_messenger__get_validator_config',
-            array($this, 'html_messenger_validator_config'),
-            5,
-            2
-        );
-        add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2);
-        add_filter(
-            'FHEE__EE_Pdf_messenger__get_validator_config',
-            array($this, 'pdf_messenger_validator_config'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Messages_Template_Pack__get_specific_template__contents',
-            array($this, 'new_default_templates'),
-            5,
-            7
-        );
-        add_filter(
-            'FHEE__EE_Messages_Base__get_valid_shortcodes',
-            array($this, 'message_types_valid_shortcodes'),
-            5,
-            2
-        );
-
-        // shortcode parsers
-        add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2);
-        add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5);
-        add_filter(
-            'FHEE__EE_Recipient_List_Shortcodes__shortcodes',
-            array($this, 'additional_recipient_details_shortcodes'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Recipient_List_Shortcodes__parser_after',
-            array($this, 'additional_recipient_details_parser'),
-            5,
-            5
-        );
-        add_filter(
-            'FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes',
-            array($this, 'additional_primary_registration_details_shortcodes'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Primary_Registration_List_Shortcodes__parser_after',
-            array($this, 'additional_primary_registration_details_parser'),
-            5,
-            5
-        );
-
-        /**
-         * @since 4.2.0
-         */
-        add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2);
-        add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5);
-
-        /**
-         * @since 4.3.0
-         */
-        // eat our own dog food!
-        add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types'));
-        add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes'));
-        do_action('EE_Brewing_Regular___messages_caf');
-    }
-
-
-    /**
-     * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the
-     * messages system.
-     *
-     * @param  array $dir_ref original array of paths
-     *
-     * @return array           appended paths
-     */
-    public function messages_autoload_paths($dir_ref)
-    {
-        $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
-
-        return $dir_ref;
-    }
-
-
-    public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]'),
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]'),
-        );
-
-        return $validator_config;
-    }
-
-
-    public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]'),
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]'),
-        );
-
-        return $validator_config;
-    }
-
-
-    public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]'),
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]'),
-        );
-
-        return $validator_config;
-    }
-
-
-    public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]'),
-        );
-
-        return $template_fields;
-    }
-
-
-    public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]'),
-        );
-
-        return $template_fields;
-    }
-
-
-    public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]'),
-        );
-
-        return $template_fields;
-    }
-
-
-    public function new_default_templates(
-        $contents,
-        $actual_path,
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $field,
-        $context,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-
-        // we're only modifying templates for the default template pack
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
-            return $contents;
-        }
-
-        // the template file name we're replacing contents for.
-        $template_file_prefix = $field . '_' . $context;
-        $msg_prefix = $messenger->name . '_' . $message_type->name . '_';
-
-        $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
-
-        if ($messenger->name == 'email' && $message_type->name == 'registration') {
-            switch ($template_file_prefix) {
-                case 'question_list_admin':
-                case 'question_list_attendee':
-                case 'question_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'question_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'attendee_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'attendee_list_admin':
-                    $path = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
-                    $contents = EEH_Template::display_template(
-                        $path,
-                        array(),
-                        true
-                    );
-                    break;
-
-                case 'attendee_list_attendee':
-                    $contents = '';
-                    break;
-
-                case 'event_list_attendee':
-                    $path = $base_path . $msg_prefix . 'event_list_attendee.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
-            switch ($template_file_prefix) {
-                case 'content_attendee':
-                    $path = $base_path . $msg_prefix . 'content.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'newsletter_content_attendee':
-                    $path = $base_path . $msg_prefix . 'newsletter_content.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'newsletter_subject_attendee':
-                    $path = $base_path . $msg_prefix . 'subject.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
-            switch ($template_file_prefix) {
-                case 'attendee_list_purchaser':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        }
-
-        return $contents;
-    }
-
-
-    public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg)
-    {
-        // make sure question_list and question are ONLY added for the core message types.  Any other message types will have to explicitly set question_list as a valid shortcode.
-        $include_with = array(
-            'registration',
-            'cancelled_registration',
-            'declined_registration',
-            'not_approved_registration',
-            'payment_declined',
-            'payment_failed',
-            'payment_cancelled',
-            'payment',
-            'payment_reminder',
-            'pending_approval',
-            'registration_summary',
-            'invoice',
-            'receipt',
-        );
-        if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
-            $contexts = array_keys($msg->get_contexts());
-            foreach ($contexts as $context) {
-                $valid_shortcodes[ $context ][] = 'question_list';
-                $valid_shortcodes[ $context ][] = 'question';
-            }
-        }
-
-        return $valid_shortcodes;
-    }
-
-
-    public function additional_attendee_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[ANSWER_*]'] = __(
-            'This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-
-        if (strpos($shortcode, '[ANSWER_*') === false
-            || ! isset($extra_data['data']->questions)
-            || ! isset($extra_data['data']->registrations)
-        ) {
-            return $parsed;
-        }
-
-        // let's get the question from the code.
-        $shortcode = str_replace('[ANSWER_*', '', $shortcode);
-        $shortcode = trim(str_replace(']', '', $shortcode));
-
-        $registration = $data instanceof EE_Registration ? $data : null;
-        $registration = ! $registration instanceof EE_Registration && is_array(
-            $extra_data
-        ) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration;
-
-        $aee = $data instanceof EE_Messages_Addressee ? $data : null;
-        $aee = ! $aee instanceof EE_Messages_Addressee && is_array(
-            $extra_data
-        ) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
-
-        if (! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-
-        // now let's figure out which question has this text.
-        foreach ($aee->questions as $ansid => $question) {
-            if ($question instanceof EE_Question
-                && trim($question->display_text()) == trim($shortcode)
-                && isset($aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ])
-            ) {
-                return $aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]->get_pretty(
-                    'ANS_value',
-                    'no_wpautop'
-                );
-            }
-        }
-
-        // nothing!
-        return $parsed;
-    }
-
-
-    /**
-     * Callback for additional shortcodes filter for adding additional datetime shortcodes.
-     *
-     * @since  4.2
-     *
-     * @param  array                  $shortcodes         array of shortcodes and
-     *                                                    descriptions
-     * @param  EE_Datetime_Shortcodes $shortcode_parser   EE_Shortcodes object
-     *
-     * @return array                                        array of shortcodes and
-     *                                                        descriptions
-     */
-    public function additional_datetime_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[DTT_NAME]'] = __(
-            'This will be parsed to the Title given for a Datetime',
-            'event_espresso'
-        );
-        $shortcodes['[DTT_DESCRIPTION]'] = __(
-            'This will be parsed to the description for a Datetime',
-            'event_espresso'
-        );
-        $shortcodes['[DTT_NAME_OR_DATES]'] = __(
-            'When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    /**
-     * Callback for additional shortcodes parser filter used for adding parser for new
-     * Datetime shortcodes
-     *
-     * @since  4.2
-     *
-     * @param  string                 $parsed     The finished parsed string for the given shortcode.
-     * @param  string                 $shortcode  The shortcode being parsed.
-     * @param  object                 $data       The incoming data object for the Shortcode Parser.
-     * @param  object                 $extra_data The incoming extra date object for the Shortcode
-     *                                            Parser.
-     * @param  EE_Datetime_Shortcodes $shortcode_parser
-     *
-     * @return string                   The new parsed string.
-     */
-    public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-
-        if (! $data instanceof EE_Datetime) {
-            return ''; // get out because we can only parse with the datetime object.
-        }
-
-        switch ($shortcode) {
-            case '[DTT_NAME]':
-                return $data->name();
-                break;
-            case '[DTT_DESCRIPTION]':
-                return $data->description();
-                break;
-            case '[DTT_NAME_OR_DATES]':
-                return $data->get_dtt_display_name(true);
-                break;
-            default:
-                return $parsed;
-                break;
-        }
-    }
-
-
-    public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[RECIPIENT_QUESTION_LIST]'] = __(
-            'This is used to indicate where you want the list of questions and answers to show for the person receiving the message.',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    /**
-     * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter).
-     *
-     * @param string         $parsed           The original parsed content for the shortcode
-     * @param string         $shortcode        The shortcode being parsed
-     * @param array          $data             The shortcode parser data array
-     * @param array          $extra_data       The shortcode parser extra data array
-     * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
-     *
-     * @return string
-     */
-    public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-
-        if (array($data) && ! isset($data['data'])) {
-            return $parsed;
-        }
-
-        $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
-
-        if (! $recipient instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-
-        switch ($shortcode) {
-            case '[RECIPIENT_QUESTION_LIST]':
-                $att = $recipient->att_obj;
-                $registrations_on_attendee = $att instanceof EE_Attendee
-                    ? $recipient->attendees[ $att->ID() ]['reg_objs']
-                    : array();
-                $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
-                $answers = array();
-
-                $template = is_array($data['template']) && isset($data['template']['question_list'])
-                    ? $data['template']['question_list']
-                    : $extra_data['template']['question_list'];
-                $valid_shortcodes = array('question');
-
-                // if the context is main_content then get all answers for all registrations on this attendee
-                if ($data['data'] instanceof EE_Messages_Addressee) {
-                    foreach ($registrations_on_attendee as $reg) {
-                        if ($reg instanceof EE_Registration) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
-                                : array();
-                            foreach ($anss as $ans) {
-                                if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
-                                }
-                            }
-                        }
-                    }
-                }
-
-                // if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event.
-                if ($data['data'] instanceof EE_Event) {
-                    $event = $data['data'];
-                    foreach ($registrations_on_attendee as $reg) {
-                        if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
-                                : array();
-                            foreach ($anss as $ans) {
-                                if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
-                                }
-                            }
-                        }
-                    }
-                }
-
-                $questions = $questions = isset($recipient->questions) ? $recipient->questions : array();
-
-                // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
-                // object on it.
-                if (! isset($extra_data['data'])) {
-                    $extra_data['data'] = $recipient;
-                }
-
-                return $this->_parse_question_list_for_primary_or_recipient_registration(
-                    $shortcode_parser,
-                    $questions,
-                    $answers,
-                    $template,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-                break;
-
-            default:
-                return $parsed;
-                break;
-        }
-    }
-
-
-    public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __(
-            'This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    /**
-     * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter).
-     *
-     * @param string         $parsed           The original parsed content for the shortcode
-     * @param string         $shortcode        The shortcode being parsed
-     * @param array          $data             The shortcode parser data array
-     * @param array          $extra_data       The shortcode parser extra data array
-     * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
-     *
-     * @return string
-     */
-    public function additional_primary_registration_details_parser(
-        $parsed,
-        $shortcode,
-        $data,
-        $extra_data,
-        $shortcode_parser
-    ) {
-        if (array($data) && ! isset($data['data'])) {
-            return $parsed;
-        }
-
-        $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
-
-        if (! $recipient instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-
-        switch ($shortcode) {
-            case '[PRIMARY_REGISTRANT_QUESTION_LIST]':
-                if (! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                $registration = $recipient->primary_reg_obj;
-                $answers = isset($recipient->registrations[ $registration->ID() ]['ans_objs'])
-                    ? $recipient->registrations[ $registration->ID() ]['ans_objs']
-                    : array();
-                if (empty($answers)) {
-                    return '';
-                }
-                $template = is_array($data['template']) && isset($data['template']['question_list'])
-                    ? $data['template']['question_list']
-                    : $extra_data['template']['question_list'];
-                $valid_shortcodes = array('question');
-                $answers = $recipient->registrations[ $registration->ID() ]['ans_objs'];
-                $questions = isset($recipient->questions) ? $recipient->questions : array();
-                // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
-                // object on it.
-                if (! isset($extra_data['data'])) {
-                    $extra_data['data'] = $recipient;
-                }
-                return $this->_parse_question_list_for_primary_or_recipient_registration(
-                    $shortcode_parser,
-                    $questions,
-                    $answers,
-                    $template,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-                break;
-
-            default:
-                return $parsed;
-                break;
-        }
-    }
-
-
-    /**
-     * Takes care of registering the  message types that are only available in caffeinated EE.
-     *
-     * @since   4.3.2
-     *
-     * @return  void
-     */
-    public function register_caf_message_types()
-    {
-        // register newsletter message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Newsletter_message_type.class.php',
-            'autoloadpaths'                                    => array(
-                EE_CAF_LIBRARIES . 'messages/message_type/newsletter/',
-            ),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('newsletter', $setup_args);
-
-        // register payment reminder message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Reminder_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_reminder', $setup_args);
-
-        // register payment declined message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Declined_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_declined', $setup_args);
-
-        // register registration declined message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Declined_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('declined_registration', $setup_args);
-
-        // register registration cancelled message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Cancelled_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('cancelled_registration', $setup_args);
-
-
-        // register payment failed message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Failed_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_failed', $setup_args);
-
-        // register payment declined message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Cancelled_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_cancelled', $setup_args);
-    }
-
-
-    /**
-     * Takes care of registering the  shortcode libraries implemented with caffeinated EE and set up related items.
-     *
-     * @since   4.3.2
-     *
-     * @return void
-     */
-    public function register_caf_shortcodes()
-    {
-        $setup_args = array(
-            'autoloadpaths'                 => array(
-                EE_CAF_LIBRARIES . 'shortcodes/',
-            ),
-            'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
-            'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
-            'list_type_shortcodes'          => array('[NEWSLETTER_CONTENT]'),
-        );
-        EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args);
-    }
-
-
-    /**
-     * Parses a question list shortcode using given data and template
-     *
-     * @param \EE_Shortcodes $shortcode_parser
-     * @param EE_Question[]  $questions        An array of questions indexed by answer id.
-     * @param EE_Answer[]    $answers          An array of answer objects
-     * @param string         $template         Template content to be parsed.
-     * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
-     * @param array          $extra_data       Extra data that might be used when parsing the template.
-     */
-    protected function _parse_question_list_for_primary_or_recipient_registration(
-        $shortcode_parser,
-        $questions,
-        $answers,
-        $template,
-        $valid_shortcodes,
-        $extra_data
-    ) {
-        $question_list = '';
-        /** @var EEH_Parse_Shortcodes $shortcode_helper */
-        $shortcode_helper = $shortcode_parser->get_shortcode_helper();
-        foreach ($answers as $answer) {
-            if ($answer instanceof EE_Answer) {
-                // first see if the question is in our $questions array. If not then try to get from answer object.
-                $question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null;
-                $question = ! $question instanceof EE_Question ? $answer->question() : $question;
-                if (! $question instanceof EE_Question
-                    || (
-                        $question instanceof EE_Question
-                        && $question->admin_only()
-                    )
-                ) {
-                    continue;
-                }
-                $question_list .= $shortcode_helper->parse_question_list_template(
-                    $template,
-                    $answer,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-            }
-        }
-        return $question_list;
-    }
+	/**
+	 * constructor.
+	 */
+	public function __construct()
+	{
+		$this->_caf_hooks();
+	}
+
+
+	/**
+	 * Contains all the hooks filters for setting up caffeinated messages functionality.
+	 *
+	 * @since 4.3.2
+	 *
+	 * @return void
+	 */
+	private function _caf_hooks()
+	{
+		add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5);
+		add_filter(
+			'FHEE__EE_Email_messenger__get_validator_config',
+			array($this, 'email_messenger_validator_config'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Email_messenger__get_template_fields',
+			array($this, 'email_messenger_template_fields'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Html_messenger__get_template_fields',
+			array($this, 'html_messenger_template_fields'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Html_messenger__get_validator_config',
+			array($this, 'html_messenger_validator_config'),
+			5,
+			2
+		);
+		add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2);
+		add_filter(
+			'FHEE__EE_Pdf_messenger__get_validator_config',
+			array($this, 'pdf_messenger_validator_config'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Messages_Template_Pack__get_specific_template__contents',
+			array($this, 'new_default_templates'),
+			5,
+			7
+		);
+		add_filter(
+			'FHEE__EE_Messages_Base__get_valid_shortcodes',
+			array($this, 'message_types_valid_shortcodes'),
+			5,
+			2
+		);
+
+		// shortcode parsers
+		add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2);
+		add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5);
+		add_filter(
+			'FHEE__EE_Recipient_List_Shortcodes__shortcodes',
+			array($this, 'additional_recipient_details_shortcodes'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Recipient_List_Shortcodes__parser_after',
+			array($this, 'additional_recipient_details_parser'),
+			5,
+			5
+		);
+		add_filter(
+			'FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes',
+			array($this, 'additional_primary_registration_details_shortcodes'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Primary_Registration_List_Shortcodes__parser_after',
+			array($this, 'additional_primary_registration_details_parser'),
+			5,
+			5
+		);
+
+		/**
+		 * @since 4.2.0
+		 */
+		add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2);
+		add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5);
+
+		/**
+		 * @since 4.3.0
+		 */
+		// eat our own dog food!
+		add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types'));
+		add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes'));
+		do_action('EE_Brewing_Regular___messages_caf');
+	}
+
+
+	/**
+	 * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the
+	 * messages system.
+	 *
+	 * @param  array $dir_ref original array of paths
+	 *
+	 * @return array           appended paths
+	 */
+	public function messages_autoload_paths($dir_ref)
+	{
+		$dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
+
+		return $dir_ref;
+	}
+
+
+	public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]'),
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]'),
+		);
+
+		return $validator_config;
+	}
+
+
+	public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]'),
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]'),
+		);
+
+		return $validator_config;
+	}
+
+
+	public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]'),
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]'),
+		);
+
+		return $validator_config;
+	}
+
+
+	public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]'),
+		);
+
+		return $template_fields;
+	}
+
+
+	public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]'),
+		);
+
+		return $template_fields;
+	}
+
+
+	public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]'),
+		);
+
+		return $template_fields;
+	}
+
+
+	public function new_default_templates(
+		$contents,
+		$actual_path,
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$field,
+		$context,
+		EE_Messages_Template_Pack $template_pack
+	) {
+
+		// we're only modifying templates for the default template pack
+		if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+			return $contents;
+		}
+
+		// the template file name we're replacing contents for.
+		$template_file_prefix = $field . '_' . $context;
+		$msg_prefix = $messenger->name . '_' . $message_type->name . '_';
+
+		$base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
+
+		if ($messenger->name == 'email' && $message_type->name == 'registration') {
+			switch ($template_file_prefix) {
+				case 'question_list_admin':
+				case 'question_list_attendee':
+				case 'question_list_primary_attendee':
+					$path = $base_path . $msg_prefix . 'question_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'attendee_list_primary_attendee':
+					$path = $base_path . $msg_prefix . 'attendee_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'attendee_list_admin':
+					$path = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
+					$contents = EEH_Template::display_template(
+						$path,
+						array(),
+						true
+					);
+					break;
+
+				case 'attendee_list_attendee':
+					$contents = '';
+					break;
+
+				case 'event_list_attendee':
+					$path = $base_path . $msg_prefix . 'event_list_attendee.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		} elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
+			switch ($template_file_prefix) {
+				case 'content_attendee':
+					$path = $base_path . $msg_prefix . 'content.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'newsletter_content_attendee':
+					$path = $base_path . $msg_prefix . 'newsletter_content.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'newsletter_subject_attendee':
+					$path = $base_path . $msg_prefix . 'subject.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		} elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
+			switch ($template_file_prefix) {
+				case 'attendee_list_purchaser':
+					$path = $base_path . $msg_prefix . 'attendee_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		}
+
+		return $contents;
+	}
+
+
+	public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg)
+	{
+		// make sure question_list and question are ONLY added for the core message types.  Any other message types will have to explicitly set question_list as a valid shortcode.
+		$include_with = array(
+			'registration',
+			'cancelled_registration',
+			'declined_registration',
+			'not_approved_registration',
+			'payment_declined',
+			'payment_failed',
+			'payment_cancelled',
+			'payment',
+			'payment_reminder',
+			'pending_approval',
+			'registration_summary',
+			'invoice',
+			'receipt',
+		);
+		if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
+			$contexts = array_keys($msg->get_contexts());
+			foreach ($contexts as $context) {
+				$valid_shortcodes[ $context ][] = 'question_list';
+				$valid_shortcodes[ $context ][] = 'question';
+			}
+		}
+
+		return $valid_shortcodes;
+	}
+
+
+	public function additional_attendee_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[ANSWER_*]'] = __(
+			'This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+
+		if (strpos($shortcode, '[ANSWER_*') === false
+			|| ! isset($extra_data['data']->questions)
+			|| ! isset($extra_data['data']->registrations)
+		) {
+			return $parsed;
+		}
+
+		// let's get the question from the code.
+		$shortcode = str_replace('[ANSWER_*', '', $shortcode);
+		$shortcode = trim(str_replace(']', '', $shortcode));
+
+		$registration = $data instanceof EE_Registration ? $data : null;
+		$registration = ! $registration instanceof EE_Registration && is_array(
+			$extra_data
+		) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration;
+
+		$aee = $data instanceof EE_Messages_Addressee ? $data : null;
+		$aee = ! $aee instanceof EE_Messages_Addressee && is_array(
+			$extra_data
+		) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
+
+		if (! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+
+		// now let's figure out which question has this text.
+		foreach ($aee->questions as $ansid => $question) {
+			if ($question instanceof EE_Question
+				&& trim($question->display_text()) == trim($shortcode)
+				&& isset($aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ])
+			) {
+				return $aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]->get_pretty(
+					'ANS_value',
+					'no_wpautop'
+				);
+			}
+		}
+
+		// nothing!
+		return $parsed;
+	}
+
+
+	/**
+	 * Callback for additional shortcodes filter for adding additional datetime shortcodes.
+	 *
+	 * @since  4.2
+	 *
+	 * @param  array                  $shortcodes         array of shortcodes and
+	 *                                                    descriptions
+	 * @param  EE_Datetime_Shortcodes $shortcode_parser   EE_Shortcodes object
+	 *
+	 * @return array                                        array of shortcodes and
+	 *                                                        descriptions
+	 */
+	public function additional_datetime_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[DTT_NAME]'] = __(
+			'This will be parsed to the Title given for a Datetime',
+			'event_espresso'
+		);
+		$shortcodes['[DTT_DESCRIPTION]'] = __(
+			'This will be parsed to the description for a Datetime',
+			'event_espresso'
+		);
+		$shortcodes['[DTT_NAME_OR_DATES]'] = __(
+			'When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Callback for additional shortcodes parser filter used for adding parser for new
+	 * Datetime shortcodes
+	 *
+	 * @since  4.2
+	 *
+	 * @param  string                 $parsed     The finished parsed string for the given shortcode.
+	 * @param  string                 $shortcode  The shortcode being parsed.
+	 * @param  object                 $data       The incoming data object for the Shortcode Parser.
+	 * @param  object                 $extra_data The incoming extra date object for the Shortcode
+	 *                                            Parser.
+	 * @param  EE_Datetime_Shortcodes $shortcode_parser
+	 *
+	 * @return string                   The new parsed string.
+	 */
+	public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+
+		if (! $data instanceof EE_Datetime) {
+			return ''; // get out because we can only parse with the datetime object.
+		}
+
+		switch ($shortcode) {
+			case '[DTT_NAME]':
+				return $data->name();
+				break;
+			case '[DTT_DESCRIPTION]':
+				return $data->description();
+				break;
+			case '[DTT_NAME_OR_DATES]':
+				return $data->get_dtt_display_name(true);
+				break;
+			default:
+				return $parsed;
+				break;
+		}
+	}
+
+
+	public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[RECIPIENT_QUESTION_LIST]'] = __(
+			'This is used to indicate where you want the list of questions and answers to show for the person receiving the message.',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter).
+	 *
+	 * @param string         $parsed           The original parsed content for the shortcode
+	 * @param string         $shortcode        The shortcode being parsed
+	 * @param array          $data             The shortcode parser data array
+	 * @param array          $extra_data       The shortcode parser extra data array
+	 * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
+	 *
+	 * @return string
+	 */
+	public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+
+		if (array($data) && ! isset($data['data'])) {
+			return $parsed;
+		}
+
+		$recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
+
+		if (! $recipient instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+
+		switch ($shortcode) {
+			case '[RECIPIENT_QUESTION_LIST]':
+				$att = $recipient->att_obj;
+				$registrations_on_attendee = $att instanceof EE_Attendee
+					? $recipient->attendees[ $att->ID() ]['reg_objs']
+					: array();
+				$registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
+				$answers = array();
+
+				$template = is_array($data['template']) && isset($data['template']['question_list'])
+					? $data['template']['question_list']
+					: $extra_data['template']['question_list'];
+				$valid_shortcodes = array('question');
+
+				// if the context is main_content then get all answers for all registrations on this attendee
+				if ($data['data'] instanceof EE_Messages_Addressee) {
+					foreach ($registrations_on_attendee as $reg) {
+						if ($reg instanceof EE_Registration) {
+							$anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
+								? $recipient->registrations[ $reg->ID() ]['ans_objs']
+								: array();
+							foreach ($anss as $ans) {
+								if ($ans instanceof EE_Answer) {
+									$answers[ $ans->ID() ] = $ans;
+								}
+							}
+						}
+					}
+				}
+
+				// if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event.
+				if ($data['data'] instanceof EE_Event) {
+					$event = $data['data'];
+					foreach ($registrations_on_attendee as $reg) {
+						if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
+							$anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
+								? $recipient->registrations[ $reg->ID() ]['ans_objs']
+								: array();
+							foreach ($anss as $ans) {
+								if ($ans instanceof EE_Answer) {
+									$answers[ $ans->ID() ] = $ans;
+								}
+							}
+						}
+					}
+				}
+
+				$questions = $questions = isset($recipient->questions) ? $recipient->questions : array();
+
+				// if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
+				// object on it.
+				if (! isset($extra_data['data'])) {
+					$extra_data['data'] = $recipient;
+				}
+
+				return $this->_parse_question_list_for_primary_or_recipient_registration(
+					$shortcode_parser,
+					$questions,
+					$answers,
+					$template,
+					$valid_shortcodes,
+					$extra_data
+				);
+				break;
+
+			default:
+				return $parsed;
+				break;
+		}
+	}
+
+
+	public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __(
+			'This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter).
+	 *
+	 * @param string         $parsed           The original parsed content for the shortcode
+	 * @param string         $shortcode        The shortcode being parsed
+	 * @param array          $data             The shortcode parser data array
+	 * @param array          $extra_data       The shortcode parser extra data array
+	 * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
+	 *
+	 * @return string
+	 */
+	public function additional_primary_registration_details_parser(
+		$parsed,
+		$shortcode,
+		$data,
+		$extra_data,
+		$shortcode_parser
+	) {
+		if (array($data) && ! isset($data['data'])) {
+			return $parsed;
+		}
+
+		$recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
+
+		if (! $recipient instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+
+		switch ($shortcode) {
+			case '[PRIMARY_REGISTRANT_QUESTION_LIST]':
+				if (! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				$registration = $recipient->primary_reg_obj;
+				$answers = isset($recipient->registrations[ $registration->ID() ]['ans_objs'])
+					? $recipient->registrations[ $registration->ID() ]['ans_objs']
+					: array();
+				if (empty($answers)) {
+					return '';
+				}
+				$template = is_array($data['template']) && isset($data['template']['question_list'])
+					? $data['template']['question_list']
+					: $extra_data['template']['question_list'];
+				$valid_shortcodes = array('question');
+				$answers = $recipient->registrations[ $registration->ID() ]['ans_objs'];
+				$questions = isset($recipient->questions) ? $recipient->questions : array();
+				// if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
+				// object on it.
+				if (! isset($extra_data['data'])) {
+					$extra_data['data'] = $recipient;
+				}
+				return $this->_parse_question_list_for_primary_or_recipient_registration(
+					$shortcode_parser,
+					$questions,
+					$answers,
+					$template,
+					$valid_shortcodes,
+					$extra_data
+				);
+				break;
+
+			default:
+				return $parsed;
+				break;
+		}
+	}
+
+
+	/**
+	 * Takes care of registering the  message types that are only available in caffeinated EE.
+	 *
+	 * @since   4.3.2
+	 *
+	 * @return  void
+	 */
+	public function register_caf_message_types()
+	{
+		// register newsletter message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Newsletter_message_type.class.php',
+			'autoloadpaths'                                    => array(
+				EE_CAF_LIBRARIES . 'messages/message_type/newsletter/',
+			),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('newsletter', $setup_args);
+
+		// register payment reminder message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Reminder_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_reminder', $setup_args);
+
+		// register payment declined message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Declined_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_declined', $setup_args);
+
+		// register registration declined message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Declined_Registration_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('declined_registration', $setup_args);
+
+		// register registration cancelled message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Cancelled_Registration_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('cancelled_registration', $setup_args);
+
+
+		// register payment failed message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Failed_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_failed', $setup_args);
+
+		// register payment declined message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Cancelled_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_cancelled', $setup_args);
+	}
+
+
+	/**
+	 * Takes care of registering the  shortcode libraries implemented with caffeinated EE and set up related items.
+	 *
+	 * @since   4.3.2
+	 *
+	 * @return void
+	 */
+	public function register_caf_shortcodes()
+	{
+		$setup_args = array(
+			'autoloadpaths'                 => array(
+				EE_CAF_LIBRARIES . 'shortcodes/',
+			),
+			'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
+			'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
+			'list_type_shortcodes'          => array('[NEWSLETTER_CONTENT]'),
+		);
+		EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args);
+	}
+
+
+	/**
+	 * Parses a question list shortcode using given data and template
+	 *
+	 * @param \EE_Shortcodes $shortcode_parser
+	 * @param EE_Question[]  $questions        An array of questions indexed by answer id.
+	 * @param EE_Answer[]    $answers          An array of answer objects
+	 * @param string         $template         Template content to be parsed.
+	 * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
+	 * @param array          $extra_data       Extra data that might be used when parsing the template.
+	 */
+	protected function _parse_question_list_for_primary_or_recipient_registration(
+		$shortcode_parser,
+		$questions,
+		$answers,
+		$template,
+		$valid_shortcodes,
+		$extra_data
+	) {
+		$question_list = '';
+		/** @var EEH_Parse_Shortcodes $shortcode_helper */
+		$shortcode_helper = $shortcode_parser->get_shortcode_helper();
+		foreach ($answers as $answer) {
+			if ($answer instanceof EE_Answer) {
+				// first see if the question is in our $questions array. If not then try to get from answer object.
+				$question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null;
+				$question = ! $question instanceof EE_Question ? $answer->question() : $question;
+				if (! $question instanceof EE_Question
+					|| (
+						$question instanceof EE_Question
+						&& $question->admin_only()
+					)
+				) {
+					continue;
+				}
+				$question_list .= $shortcode_helper->parse_question_list_template(
+					$template,
+					$answer,
+					$valid_shortcodes,
+					$extra_data
+				);
+			}
+		}
+		return $question_list;
+	}
 }

Spacing +44 added lines, -44 removed lines

@@ -130,7 +130,7 @@ 
      */
     public function messages_autoload_paths($dir_ref)
     {
-        $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
+        $dir_ref[] = EE_CAF_LIBRARIES.'shortcodes/';
 
         return $dir_ref;
     }
@@ -246,32 +246,32 @@ 
     ) {
 
         // we're only modifying templates for the default template pack
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+        if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) {
             return $contents;
         }
 
         // the template file name we're replacing contents for.
-        $template_file_prefix = $field . '_' . $context;
-        $msg_prefix = $messenger->name . '_' . $message_type->name . '_';
+        $template_file_prefix = $field.'_'.$context;
+        $msg_prefix = $messenger->name.'_'.$message_type->name.'_';
 
-        $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
+        $base_path = EE_CAF_LIBRARIES.'messages/defaults/default/';
 
         if ($messenger->name == 'email' && $message_type->name == 'registration') {
             switch ($template_file_prefix) {
                 case 'question_list_admin':
                 case 'question_list_attendee':
                 case 'question_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'question_list.template.php';
+                    $path = $base_path.$msg_prefix.'question_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'attendee_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
+                    $path = $base_path.$msg_prefix.'attendee_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'attendee_list_admin':
-                    $path = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
+                    $path = $base_path.$msg_prefix.'attendee_list_admin.template.php';
                     $contents = EEH_Template::display_template(
                         $path,
                         array(),
@@ -284,31 +284,31 @@ 
                     break;
 
                 case 'event_list_attendee':
-                    $path = $base_path . $msg_prefix . 'event_list_attendee.template.php';
+                    $path = $base_path.$msg_prefix.'event_list_attendee.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
         } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
             switch ($template_file_prefix) {
                 case 'content_attendee':
-                    $path = $base_path . $msg_prefix . 'content.template.php';
+                    $path = $base_path.$msg_prefix.'content.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'newsletter_content_attendee':
-                    $path = $base_path . $msg_prefix . 'newsletter_content.template.php';
+                    $path = $base_path.$msg_prefix.'newsletter_content.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'newsletter_subject_attendee':
-                    $path = $base_path . $msg_prefix . 'subject.template.php';
+                    $path = $base_path.$msg_prefix.'subject.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
         } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
             switch ($template_file_prefix) {
                 case 'attendee_list_purchaser':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
+                    $path = $base_path.$msg_prefix.'attendee_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
@@ -339,8 +339,8 @@ 
         if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
             $contexts = array_keys($msg->get_contexts());
             foreach ($contexts as $context) {
-                $valid_shortcodes[ $context ][] = 'question_list';
-                $valid_shortcodes[ $context ][] = 'question';
+                $valid_shortcodes[$context][] = 'question_list';
+                $valid_shortcodes[$context][] = 'question';
             }
         }
 
@@ -383,7 +383,7 @@ 
             $extra_data
         ) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
 
-        if (! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
+        if ( ! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
             return $parsed;
         }
 
@@ -391,9 +391,9 @@ 
         foreach ($aee->questions as $ansid => $question) {
             if ($question instanceof EE_Question
                 && trim($question->display_text()) == trim($shortcode)
-                && isset($aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ])
+                && isset($aee->registrations[$registration->ID()]['ans_objs'][$ansid])
             ) {
-                return $aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]->get_pretty(
+                return $aee->registrations[$registration->ID()]['ans_objs'][$ansid]->get_pretty(
                     'ANS_value',
                     'no_wpautop'
                 );
@@ -454,7 +454,7 @@ 
     public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
     {
 
-        if (! $data instanceof EE_Datetime) {
+        if ( ! $data instanceof EE_Datetime) {
             return ''; // get out because we can only parse with the datetime object.
         }
 
@@ -507,7 +507,7 @@ 
         $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
         $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
 
-        if (! $recipient instanceof EE_Messages_Addressee) {
+        if ( ! $recipient instanceof EE_Messages_Addressee) {
             return $parsed;
         }
 
@@ -515,7 +515,7 @@ 
             case '[RECIPIENT_QUESTION_LIST]':
                 $att = $recipient->att_obj;
                 $registrations_on_attendee = $att instanceof EE_Attendee
-                    ? $recipient->attendees[ $att->ID() ]['reg_objs']
+                    ? $recipient->attendees[$att->ID()]['reg_objs']
                     : array();
                 $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
                 $answers = array();
@@ -529,12 +529,12 @@ 
                 if ($data['data'] instanceof EE_Messages_Addressee) {
                     foreach ($registrations_on_attendee as $reg) {
                         if ($reg instanceof EE_Registration) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
+                            $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs'])
+                                ? $recipient->registrations[$reg->ID()]['ans_objs']
                                 : array();
                             foreach ($anss as $ans) {
                                 if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
+                                    $answers[$ans->ID()] = $ans;
                                 }
                             }
                         }
@@ -546,12 +546,12 @@ 
                     $event = $data['data'];
                     foreach ($registrations_on_attendee as $reg) {
                         if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
+                            $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs'])
+                                ? $recipient->registrations[$reg->ID()]['ans_objs']
                                 : array();
                             foreach ($anss as $ans) {
                                 if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
+                                    $answers[$ans->ID()] = $ans;
                                 }
                             }
                         }
@@ -562,7 +562,7 @@ 
 
                 // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
                 // object on it.
-                if (! isset($extra_data['data'])) {
+                if ( ! isset($extra_data['data'])) {
                     $extra_data['data'] = $recipient;
                 }
 
@@ -619,18 +619,18 @@ 
         $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
         $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
 
-        if (! $recipient instanceof EE_Messages_Addressee) {
+        if ( ! $recipient instanceof EE_Messages_Addressee) {
             return $parsed;
         }
 
         switch ($shortcode) {
             case '[PRIMARY_REGISTRANT_QUESTION_LIST]':
-                if (! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
+                if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
                     return '';
                 }
                 $registration = $recipient->primary_reg_obj;
-                $answers = isset($recipient->registrations[ $registration->ID() ]['ans_objs'])
-                    ? $recipient->registrations[ $registration->ID() ]['ans_objs']
+                $answers = isset($recipient->registrations[$registration->ID()]['ans_objs'])
+                    ? $recipient->registrations[$registration->ID()]['ans_objs']
                     : array();
                 if (empty($answers)) {
                     return '';
@@ -639,11 +639,11 @@ 
                     ? $data['template']['question_list']
                     : $extra_data['template']['question_list'];
                 $valid_shortcodes = array('question');
-                $answers = $recipient->registrations[ $registration->ID() ]['ans_objs'];
+                $answers = $recipient->registrations[$registration->ID()]['ans_objs'];
                 $questions = isset($recipient->questions) ? $recipient->questions : array();
                 // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
                 // object on it.
-                if (! isset($extra_data['data'])) {
+                if ( ! isset($extra_data['data'])) {
                     $extra_data['data'] = $recipient;
                 }
                 return $this->_parse_question_list_for_primary_or_recipient_registration(
@@ -676,7 +676,7 @@ 
         $setup_args = array(
             'mtfilename'                                       => 'EE_Newsletter_message_type.class.php',
             'autoloadpaths'                                    => array(
-                EE_CAF_LIBRARIES . 'messages/message_type/newsletter/',
+                EE_CAF_LIBRARIES.'messages/message_type/newsletter/',
             ),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
@@ -687,7 +687,7 @@ 
         // register payment reminder message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Reminder_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_reminder/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -697,7 +697,7 @@ 
         // register payment declined message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Declined_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_declined/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -707,7 +707,7 @@ 
         // register registration declined message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Declined_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/declined_registration/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -717,7 +717,7 @@ 
         // register registration cancelled message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Cancelled_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/cancelled_registration/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -728,7 +728,7 @@ 
         // register payment failed message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Failed_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_failed/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -738,7 +738,7 @@ 
         // register payment declined message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Cancelled_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_cancelled/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -758,7 +758,7 @@ 
     {
         $setup_args = array(
             'autoloadpaths'                 => array(
-                EE_CAF_LIBRARIES . 'shortcodes/',
+                EE_CAF_LIBRARIES.'shortcodes/',
             ),
             'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
             'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
@@ -792,9 +792,9 @@ 
         foreach ($answers as $answer) {
             if ($answer instanceof EE_Answer) {
                 // first see if the question is in our $questions array. If not then try to get from answer object.
-                $question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null;
+                $question = isset($questions[$answer->ID()]) ? $questions[$answer->ID()] : null;
                 $question = ! $question instanceof EE_Question ? $answer->question() : $question;
-                if (! $question instanceof EE_Question
+                if ( ! $question instanceof EE_Question
                     || (
                         $question instanceof EE_Question
                         && $question->admin_only()

core/db_models/EEM_Datetime.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -529,7 +529,7 @@
     /**
      * 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
+     * @param  string[] $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.

Indentation +751 added lines, -751 removed lines

@@ -13,755 +13,755 @@
 class EEM_Datetime extends EEM_Soft_Delete_Base
 {
 
-    /**
-     * @var EEM_Datetime $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string $timezone A string representing the timezone we want to set for returned Date Time Strings
-     *                         (and any incoming timezone data that gets saved).
-     *                         Note this just sends the timezone info to the date time model field objects.
-     *                         Default is NULL
-     *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item           = esc_html__('Datetime', 'event_espresso');
-        $this->plural_item             = esc_html__('Datetimes', 'event_espresso');
-        $this->_tables                 = array(
-            'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
-        );
-        $this->_fields                 = array(
-            'Datetime' => array(
-                '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'
-                ),
-                'DTT_name'        => new EE_Plain_Text_Field(
-                    'DTT_name',
-                    esc_html__('Datetime Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'DTT_description' => new EE_Post_Content_Field(
-                    'DTT_description',
-                    esc_html__('Description for Datetime', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'DTT_EVT_start'   => new EE_Datetime_Field(
-                    'DTT_EVT_start',
-                    esc_html__('Start time/date of Event', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'DTT_EVT_end'     => new EE_Datetime_Field(
-                    'DTT_EVT_end',
-                    esc_html__('End time/date of Event', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'DTT_reg_limit'   => new EE_Infinite_Integer_Field(
-                    'DTT_reg_limit',
-                    esc_html__('Registration Limit for this time', 'event_espresso'),
-                    true,
-                    EE_INF
-                ),
-                'DTT_sold'        => new EE_Integer_Field(
-                    'DTT_sold',
-                    esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'DTT_reserved'    => new EE_Integer_Field(
-                    'DTT_reserved',
-                    esc_html__('Quantity of tickets reserved, but not yet fully purchased', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'DTT_is_primary'  => new EE_Boolean_Field(
-                    'DTT_is_primary',
-                    esc_html__('Flag indicating datetime is primary one for event', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'DTT_order'       => new EE_Integer_Field(
-                    'DTT_order',
-                    esc_html__('The order in which the Datetime is displayed', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'DTT_parent'      => new EE_Integer_Field(
-                    'DTT_parent',
-                    esc_html__('Indicates what DTT_ID is the parent of this DTT_ID', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'DTT_deleted'     => new EE_Trashed_Flag_Field(
-                    'DTT_deleted',
-                    esc_html__('Flag indicating datetime is archived', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations        = array(
-            '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(),
-        );
-        $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 Unixtimestamp representing now + 30 days in seconds.
-         * @return int unixtimestamp
-         */
-        $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 Unixtimestamp representing now + 30 days in seconds.
-         * @return int unixtimestamp
-         */
-        $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(
-            array(
-                'DTT_EVT_start' => $start_date,
-                'DTT_EVT_end'   => $end_date,
-                'DTT_order'     => 1,
-                'DTT_reg_limit' => EE_INF,
-            ),
-            $timezone_string
-        );
-        /**
-         * Filters the initial start time and format for the new EE_Datetime instance.
-         *
-         * @param array $start_time An array having size 2.  First element is the time, second element is the time
-         *                          format.
-         * @return array
-         */
-        $start_time = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__start_time',
-            ['8am', 'ga']
-        );
-        /**
-         * Filters the initial end time and format for the new EE_Datetime instance.
-         *
-         * @param array $end_time An array having size 2.  First element is the time, second element is the time
-         *                        format
-         * @return array
-         */
-        $end_time = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__end_time',
-            ['5pm', 'ga']
-        );
-        $this->validateStartAndEndTimeForBlankDate($start_time, $end_time);
-        $blank_datetime->set_start_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_start',
-                $start_time[0],
-                $start_time[1],
-                $timezone_string
-            )
-        );
-        $blank_datetime->set_end_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_end',
-                $end_time[0],
-                $end_time[1],
-                $timezone_string
-            )
-        );
-        return array($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($start_time, $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
-     */
-    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(
-        $EVT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        // sanitize EVT_ID
-        $EVT_ID         = absint($EVT_ID);
-        $old_assumption = $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);
-        $where_params = array('Event.EVT_ID' => $EVT_ID);
-        $query_params = ! empty($limit)
-            ? array(
-                $where_params,
-                'limit'                    => $limit,
-                'order_by'                 => array('DTT_order' => 'ASC'),
-                'default_where_conditions' => 'none',
-            )
-            : array(
-                $where_params,
-                'order_by'                 => array('DTT_order' => 'ASC'),
-                'default_where_conditions' => 'none',
-            );
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * 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($EVT_ID = 0, $limit = null)
-    {
-        return $this->get_all(
-            array(
-                array('Event.EVT_ID' => $EVT_ID),
-                'limit'                    => $limit,
-                'order_by'                 => array('DTT_EVT_start' => 'ASC'),
-                'default_where_conditions' => 'none',
-            )
-        );
-    }
-
-
-    /**
-     * @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($EVT_ID, $include_expired = false, $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(
-        $EVT_ID,
-        $try_to_exclude_expired = true,
-        $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(
-        $EVT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        // sanitize EVT_ID
-        $EVT_ID         = absint($EVT_ID);
-        $old_assumption = $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);
-        $query_params = array(
-            array(
-                'Event.EVT_ID' => $EVT_ID
-            ),
-            'order_by' => array(
-                'DTT_EVT_start' => 'asc'
-            ),
-            'default_where_conditions' => EEM_Base::default_where_conditions_this_only
-        );
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * 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(
-        $TKT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        // sanitize TKT_ID
-        $TKT_ID         = absint($TKT_ID);
-        $old_assumption = $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);
-        $query_params = array(array('Ticket.TKT_ID' => $TKT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * 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(
-        $TKT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        // sanitize id.
-        $TKT_ID         = absint($TKT_ID);
-        $old_assumption = $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);
-        $where_params = array('Ticket.TKT_ID' => $TKT_ID);
-        $query_params = array($where_params, 'order_by' => array('DTT_order' => 'ASC'));
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * 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($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 EE_Base_Class[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     */
-    public function get_dtt_months_and_years($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'] = array('>', $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,
-                    array('DTT_EVT_end' => array('>', $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']  = array('<', $current_time_for_DTT_EVT_end);
-                $where_params['Event.EVT_ID'] = array('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'] = array('<', $current_time_for_DTT_EVT_start);
-                $where_params['DTT_EVT_end']   = array('>', $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'] = array('!=', 'publish');
-                break;
-        }
-        $query_params[0]          = $where_params;
-        $query_params['group_by'] = array('dtt_year', 'dtt_month');
-        $query_params['order_by'] = array('DTT_EVT_start' => 'DESC');
-        $query_interval           = EEH_DTT_Helper::get_sql_query_interval_for_offset(
-            $this->get_timezone(),
-            'DTT_EVT_start'
-        );
-        $columns_to_select        = array(
-            'dtt_year'      => array('YEAR(' . $query_interval . ')', '%s'),
-            'dtt_month'     => array('MONTHNAME(' . $query_interval . ')', '%s'),
-            'dtt_month_num' => array('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
-     */
-    public function update_sold($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.
-     */
-    public function sum_tickets_currently_available_at_datetime($DTT_ID, array $query_params = array())
-    {
-        $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(), array $query_params = array())
-    {
-        // only accept where conditions for this query.
-        $_where            = isset($query_params[0]) ? $query_params[0] : array();
-        $status_query_args = array(
-            EE_Datetime::active   => array_merge(
-                $_where,
-                array('DTT_EVT_start' => array('<', time()), 'DTT_EVT_end' => array('>', time()))
-            ),
-            EE_Datetime::upcoming => array_merge(
-                $_where,
-                array('DTT_EVT_start' => array('>', time()))
-            ),
-            EE_Datetime::expired  => array_merge(
-                $_where,
-                array('DTT_EVT_end' => array('<', 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 = array();
-        foreach ($status_query_args as $status => $status_where_conditions) {
-            $status_query_results[ $status ] = EEM_Datetime::count(
-                array($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 = array())
-    {
-        $count = $this->get_datetime_counts_by_status(array($status), $query_params);
-        return ! empty($count[ $status ]) ? $count[ $status ] : 0;
-    }
+	/**
+	 * @var EEM_Datetime $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string $timezone A string representing the timezone we want to set for returned Date Time Strings
+	 *                         (and any incoming timezone data that gets saved).
+	 *                         Note this just sends the timezone info to the date time model field objects.
+	 *                         Default is NULL
+	 *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item           = esc_html__('Datetime', 'event_espresso');
+		$this->plural_item             = esc_html__('Datetimes', 'event_espresso');
+		$this->_tables                 = array(
+			'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
+		);
+		$this->_fields                 = array(
+			'Datetime' => array(
+				'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'
+				),
+				'DTT_name'        => new EE_Plain_Text_Field(
+					'DTT_name',
+					esc_html__('Datetime Name', 'event_espresso'),
+					false,
+					''
+				),
+				'DTT_description' => new EE_Post_Content_Field(
+					'DTT_description',
+					esc_html__('Description for Datetime', 'event_espresso'),
+					false,
+					''
+				),
+				'DTT_EVT_start'   => new EE_Datetime_Field(
+					'DTT_EVT_start',
+					esc_html__('Start time/date of Event', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'DTT_EVT_end'     => new EE_Datetime_Field(
+					'DTT_EVT_end',
+					esc_html__('End time/date of Event', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'DTT_reg_limit'   => new EE_Infinite_Integer_Field(
+					'DTT_reg_limit',
+					esc_html__('Registration Limit for this time', 'event_espresso'),
+					true,
+					EE_INF
+				),
+				'DTT_sold'        => new EE_Integer_Field(
+					'DTT_sold',
+					esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
+					true,
+					0
+				),
+				'DTT_reserved'    => new EE_Integer_Field(
+					'DTT_reserved',
+					esc_html__('Quantity of tickets reserved, but not yet fully purchased', 'event_espresso'),
+					false,
+					0
+				),
+				'DTT_is_primary'  => new EE_Boolean_Field(
+					'DTT_is_primary',
+					esc_html__('Flag indicating datetime is primary one for event', 'event_espresso'),
+					false,
+					false
+				),
+				'DTT_order'       => new EE_Integer_Field(
+					'DTT_order',
+					esc_html__('The order in which the Datetime is displayed', 'event_espresso'),
+					false,
+					0
+				),
+				'DTT_parent'      => new EE_Integer_Field(
+					'DTT_parent',
+					esc_html__('Indicates what DTT_ID is the parent of this DTT_ID', 'event_espresso'),
+					true,
+					0
+				),
+				'DTT_deleted'     => new EE_Trashed_Flag_Field(
+					'DTT_deleted',
+					esc_html__('Flag indicating datetime is archived', 'event_espresso'),
+					false,
+					false
+				),
+			),
+		);
+		$this->_model_relations        = array(
+			'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(),
+		);
+		$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 Unixtimestamp representing now + 30 days in seconds.
+		 * @return int unixtimestamp
+		 */
+		$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 Unixtimestamp representing now + 30 days in seconds.
+		 * @return int unixtimestamp
+		 */
+		$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(
+			array(
+				'DTT_EVT_start' => $start_date,
+				'DTT_EVT_end'   => $end_date,
+				'DTT_order'     => 1,
+				'DTT_reg_limit' => EE_INF,
+			),
+			$timezone_string
+		);
+		/**
+		 * Filters the initial start time and format for the new EE_Datetime instance.
+		 *
+		 * @param array $start_time An array having size 2.  First element is the time, second element is the time
+		 *                          format.
+		 * @return array
+		 */
+		$start_time = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__start_time',
+			['8am', 'ga']
+		);
+		/**
+		 * Filters the initial end time and format for the new EE_Datetime instance.
+		 *
+		 * @param array $end_time An array having size 2.  First element is the time, second element is the time
+		 *                        format
+		 * @return array
+		 */
+		$end_time = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__end_time',
+			['5pm', 'ga']
+		);
+		$this->validateStartAndEndTimeForBlankDate($start_time, $end_time);
+		$blank_datetime->set_start_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_start',
+				$start_time[0],
+				$start_time[1],
+				$timezone_string
+			)
+		);
+		$blank_datetime->set_end_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_end',
+				$end_time[0],
+				$end_time[1],
+				$timezone_string
+			)
+		);
+		return array($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($start_time, $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
+	 */
+	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(
+		$EVT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		// sanitize EVT_ID
+		$EVT_ID         = absint($EVT_ID);
+		$old_assumption = $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);
+		$where_params = array('Event.EVT_ID' => $EVT_ID);
+		$query_params = ! empty($limit)
+			? array(
+				$where_params,
+				'limit'                    => $limit,
+				'order_by'                 => array('DTT_order' => 'ASC'),
+				'default_where_conditions' => 'none',
+			)
+			: array(
+				$where_params,
+				'order_by'                 => array('DTT_order' => 'ASC'),
+				'default_where_conditions' => 'none',
+			);
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * 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($EVT_ID = 0, $limit = null)
+	{
+		return $this->get_all(
+			array(
+				array('Event.EVT_ID' => $EVT_ID),
+				'limit'                    => $limit,
+				'order_by'                 => array('DTT_EVT_start' => 'ASC'),
+				'default_where_conditions' => 'none',
+			)
+		);
+	}
+
+
+	/**
+	 * @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($EVT_ID, $include_expired = false, $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(
+		$EVT_ID,
+		$try_to_exclude_expired = true,
+		$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(
+		$EVT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		// sanitize EVT_ID
+		$EVT_ID         = absint($EVT_ID);
+		$old_assumption = $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);
+		$query_params = array(
+			array(
+				'Event.EVT_ID' => $EVT_ID
+			),
+			'order_by' => array(
+				'DTT_EVT_start' => 'asc'
+			),
+			'default_where_conditions' => EEM_Base::default_where_conditions_this_only
+		);
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * 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(
+		$TKT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		// sanitize TKT_ID
+		$TKT_ID         = absint($TKT_ID);
+		$old_assumption = $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);
+		$query_params = array(array('Ticket.TKT_ID' => $TKT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * 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(
+		$TKT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		// sanitize id.
+		$TKT_ID         = absint($TKT_ID);
+		$old_assumption = $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);
+		$where_params = array('Ticket.TKT_ID' => $TKT_ID);
+		$query_params = array($where_params, 'order_by' => array('DTT_order' => 'ASC'));
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * 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($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 EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 */
+	public function get_dtt_months_and_years($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'] = array('>', $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,
+					array('DTT_EVT_end' => array('>', $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']  = array('<', $current_time_for_DTT_EVT_end);
+				$where_params['Event.EVT_ID'] = array('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'] = array('<', $current_time_for_DTT_EVT_start);
+				$where_params['DTT_EVT_end']   = array('>', $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'] = array('!=', 'publish');
+				break;
+		}
+		$query_params[0]          = $where_params;
+		$query_params['group_by'] = array('dtt_year', 'dtt_month');
+		$query_params['order_by'] = array('DTT_EVT_start' => 'DESC');
+		$query_interval           = EEH_DTT_Helper::get_sql_query_interval_for_offset(
+			$this->get_timezone(),
+			'DTT_EVT_start'
+		);
+		$columns_to_select        = array(
+			'dtt_year'      => array('YEAR(' . $query_interval . ')', '%s'),
+			'dtt_month'     => array('MONTHNAME(' . $query_interval . ')', '%s'),
+			'dtt_month_num' => array('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
+	 */
+	public function update_sold($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.
+	 */
+	public function sum_tickets_currently_available_at_datetime($DTT_ID, array $query_params = array())
+	{
+		$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(), array $query_params = array())
+	{
+		// only accept where conditions for this query.
+		$_where            = isset($query_params[0]) ? $query_params[0] : array();
+		$status_query_args = array(
+			EE_Datetime::active   => array_merge(
+				$_where,
+				array('DTT_EVT_start' => array('<', time()), 'DTT_EVT_end' => array('>', time()))
+			),
+			EE_Datetime::upcoming => array_merge(
+				$_where,
+				array('DTT_EVT_start' => array('>', time()))
+			),
+			EE_Datetime::expired  => array_merge(
+				$_where,
+				array('DTT_EVT_end' => array('<', 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 = array();
+		foreach ($status_query_args as $status => $status_where_conditions) {
+			$status_query_results[ $status ] = EEM_Datetime::count(
+				array($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 = array())
+	{
+		$count = $this->get_datetime_counts_by_status(array($status), $query_params);
+		return ! empty($count[ $status ]) ? $count[ $status ] : 0;
+	}
 }

Spacing +21 added lines, -21 removed lines

@@ -121,7 +121,7 @@ 
                 ),
             ),
         );
-        $this->_model_relations        = array(
+        $this->_model_relations = array(
             'Ticket'  => new EE_HABTM_Relation('Datetime_Ticket'),
             'Event'   => new EE_Belongs_To_Relation(),
             'Checkin' => new EE_Has_Many_Relation(),
@@ -131,16 +131,16 @@ 
         $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(
+        $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(
+        $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(
+        $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(
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model,
             EEM_Base::caps_edit
         );
@@ -246,10 +246,10 @@ 
      */
     private function validateStartAndEndTimeForBlankDate($start_time, $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) {
@@ -283,7 +283,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);
@@ -329,7 +329,7 @@ 
                 'order_by'                 => array('DTT_order' => 'ASC'),
                 'default_where_conditions' => 'none',
             );
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -448,7 +448,7 @@ 
             ),
             'default_where_conditions' => EEM_Base::default_where_conditions_this_only
         );
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -486,7 +486,7 @@ 
         $old_assumption = $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);
         $query_params = array(array('Ticket.TKT_ID' => $TKT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -526,7 +526,7 @@ 
         $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
         $where_params = array('Ticket.TKT_ID' => $TKT_ID);
         $query_params = array($where_params, 'order_by' => array('DTT_order' => 'ASC'));
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -649,10 +649,10 @@ 
             $this->get_timezone(),
             'DTT_EVT_start'
         );
-        $columns_to_select        = array(
-            'dtt_year'      => array('YEAR(' . $query_interval . ')', '%s'),
-            'dtt_month'     => array('MONTHNAME(' . $query_interval . ')', '%s'),
-            'dtt_month_num' => array('MONTH(' . $query_interval . ')', '%s'),
+        $columns_to_select = array(
+            'dtt_year'      => array('YEAR('.$query_interval.')', '%s'),
+            'dtt_month'     => array('MONTHNAME('.$query_interval.')', '%s'),
+            'dtt_month_num' => array('MONTH('.$query_interval.')', '%s'),
         );
         return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
     }
@@ -731,17 +731,17 @@ 
                 array('DTT_EVT_end' => array('<', 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 = array();
         foreach ($status_query_args as $status => $status_where_conditions) {
-            $status_query_results[ $status ] = EEM_Datetime::count(
+            $status_query_results[$status] = EEM_Datetime::count(
                 array($status_where_conditions),
                 'DTT_ID',
                 true
@@ -762,6 +762,6 @@ 
     public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = array())
     {
         $count = $this->get_datetime_counts_by_status(array($status), $query_params);
-        return ! empty($count[ $status ]) ? $count[ $status ] : 0;
+        return ! empty($count[$status]) ? $count[$status] : 0;
     }
 }

public/Espresso_Arabica_2014/content-espresso_events-datetimes.php

Spacing +4 added lines, -4 removed lines

@@ -1,15 +1,15 @@
 <?php
 //echo '<br/><h6 style="color:#2EA2CC;">'. __FILE__ . ' &nbsp; <span style="font-weight:normal;color:#E76700"> Line #: ' . __LINE__ . '</span></h6>';
 
-if ( is_single() || ( is_archive() && espresso_display_datetimes_in_event_list() ) ) :
+if (is_single() || (is_archive() && espresso_display_datetimes_in_event_list())) :
 global $post;
-do_action( 'AHEE_event_details_before_event_date', $post );
+do_action('AHEE_event_details_before_event_date', $post);
 ?>
 	<div class="event-datetimes">
-		<?php espresso_list_of_event_dates( $post->ID );?>
+		<?php espresso_list_of_event_dates($post->ID); ?>
 	</div>
 	<!-- .event-datetimes -->
 <?php
-do_action( 'AHEE_event_details_after_event_date', $post );
+do_action('AHEE_event_details_after_event_date', $post);
 endif;
 ?>
\ No newline at end of file

core/db_classes/EE_Message.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -697,7 +697,7 @@
     /**
      * Gets any error message.
      *
-     * @return mixed|null
+     * @return string
      */
     public function error_message()
     {

Indentation +867 added lines, -867 removed lines

@@ -10,875 +10,875 @@
 class EE_Message extends EE_Base_Class implements EEI_Admin_Links
 {
 
-    /**
-     * @deprecated 4.9.0  Added for backward compat with add-on's
-     * @type null
-     */
-    public $template_pack;
-
-    /**
-     * @deprecated 4.9.0 Added for backward compat with add-on's
-     * @type null
-     */
-    public $template_variation;
-
-    /**
-     * @deprecated 4.9.0 Added for backward compat with add-on's
-     * @type string
-     */
-    public $content = '';
-
-
-    /**
-     * @type EE_messenger $_messenger
-     */
-    protected $_messenger = null;
-
-    /**
-     * @type EE_message_type $_message_type
-     */
-    protected $_message_type = null;
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @param array  $date_formats incoming date formats in an array.  First value is the date_format, second is time
-     *                             format.
-     * @return EE_Message
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        // if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
-        if (! $has_object) {
-            EE_Registry::instance()->load_helper('URL');
-            $props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
-        }
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Gets MSG_token
-     *
-     * @return int
-     */
-    public function MSG_token()
-    {
-        return $this->get('MSG_token');
-    }
-
-
-    /**
-     * Sets MSG_token
-     *
-     * @param int $MSG_token
-     */
-    public function set_MSG_token($MSG_token)
-    {
-        $this->set('MSG_token', $MSG_token);
-    }
-
-
-    /**
-     * Gets GRP_ID
-     *
-     * @return int
-     */
-    public function GRP_ID()
-    {
-        return $this->get('GRP_ID');
-    }
-
-
-    /**
-     * Sets GRP_ID
-     *
-     * @param int $GRP_ID
-     */
-    public function set_GRP_ID($GRP_ID)
-    {
-        $this->set('GRP_ID', $GRP_ID);
-    }
-
-
-    /**
-     * Gets TXN_ID
-     *
-     * @return int
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * Sets TXN_ID
-     *
-     * @param int $TXN_ID
-     */
-    public function set_TXN_ID($TXN_ID)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * Gets messenger
-     *
-     * @return string
-     */
-    public function messenger()
-    {
-        return $this->get('MSG_messenger');
-    }
-
-
-    /**
-     * Sets messenger
-     *
-     * @param string $messenger
-     */
-    public function set_messenger($messenger)
-    {
-        $this->set('MSG_messenger', $messenger);
-    }
-
-
-    /**
-     * Returns corresponding messenger object for the set messenger on this message
-     *
-     * @return EE_messenger | null
-     */
-    public function messenger_object()
-    {
-        return $this->_messenger;
-    }
-
-
-    /**
-     * Sets messenger
-     *
-     * @param EE_messenger $messenger
-     */
-    public function set_messenger_object(EE_messenger $messenger)
-    {
-        $this->_messenger = $messenger;
-    }
-
-
-    /**
-     * validates messenger
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function valid_messenger($throw_exceptions = false)
-    {
-        if ($this->_messenger instanceof EE_messenger) {
-            return true;
-        }
-        if ($throw_exceptions) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The "%1$s" messenger set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
-                        'event_espresso'
-                    ),
-                    $this->messenger()
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * This returns the set localized label for the messenger on this message.
-     * Note, if unable to retrieve the EE_messenger object then will just return the messenger slug saved
-     * with this message.
-     *
-     * @param   bool $plural whether to return the plural label or not.
-     * @return string
-     */
-    public function messenger_label($plural = false)
-    {
-        $label_type = $plural ? 'plural' : 'singular';
-        $messenger = $this->messenger_object();
-        return $messenger instanceof EE_messenger ? $messenger->label[ $label_type ] : $this->messenger();
-    }
-
-
-    /**
-     * Gets message_type
-     *
-     * @return string
-     */
-    public function message_type()
-    {
-        return $this->get('MSG_message_type');
-    }
-
-
-    /**
-     * Sets message_type
-     *
-     * @param string $message_type
-     */
-    public function set_message_type($message_type)
-    {
-        $this->set('MSG_message_type', $message_type);
-    }
-
-
-    /**
-     * Returns the message type object for the set message type on this message
-     *
-     * @return EE_message_type | null
-     */
-    public function message_type_object()
-    {
-        return $this->_message_type;
-    }
-
-
-    /**
-     * Sets message_type
-     *
-     * @param EE_message_type $message_type
-     * @param bool            $set_priority   This indicates whether to set the priority to whatever the priority is on
-     *                                        the message type or not.
-     */
-    public function set_message_type_object(EE_message_type $message_type, $set_priority = false)
-    {
-        $this->_message_type = $message_type;
-        if ($set_priority) {
-            $this->set_priority($this->_message_type->get_priority());
-        }
-    }
-
-
-    /**
-     * validates message_type
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function valid_message_type($throw_exceptions = false)
-    {
-        if ($this->_message_type instanceof EE_message_type) {
-            return true;
-        }
-        if ($throw_exceptions) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The %1$s message type set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
-                        'event_espresso'
-                    ),
-                    $this->message_type()
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * validates messenger and message_type (that they are valid EE_messenger and EE_message_type objects).
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_valid($throw_exceptions = false)
-    {
-        if ($this->valid_messenger($throw_exceptions) && $this->valid_message_type($throw_exceptions)) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * This validates whether the internal messenger and message type objects are valid for sending.
-     * Three checks are done:
-     * 1. There is a valid messenger object.
-     * 2. There is a valid message type object.
-     * 3. The message type object is active for the messenger.
-     *
-     * @throws EE_Error  But only if $throw_exceptions is set to true.
-     * @param bool $throw_exceptions
-     * @return bool
-     */
-    public function is_valid_for_sending_or_generation($throw_exceptions = false)
-    {
-        $valid = false;
-        if ($this->is_valid($throw_exceptions)) {
-            /** @var EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            $valid = $message_resource_manager->is_message_type_active_for_messenger(
-                $this->messenger(),
-                $this->message_type()
-            );
-            if (! $valid && $throw_exceptions) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'The %1$s message type is not a valid message type for the %2$s messenger so it will not be sent.',
-                            'event_espresso'
-                        ),
-                        $this->message_type(),
-                        $this->messenger()
-                    )
-                );
-            }
-        }
-        return $valid;
-    }
-
-
-    /**
-     * This returns the set localized label for the message type on this message.
-     * Note, if unable to retrieve the EE_message_type object then will just return the message type slug saved
-     * with this message.
-     *
-     * @param   bool $plural whether to return the plural label or not.
-     * @return string
-     */
-    public function message_type_label($plural = false)
-    {
-        $label_type = $plural ? 'plural' : 'singular';
-        $message_type = $this->message_type_object();
-        return $message_type instanceof EE_message_type
-            ? $message_type->label[ $label_type ]
-            : str_replace(
-                '_',
-                ' ',
-                $this->message_type()
-            );
-    }
-
-
-    /**
-     * Gets context
-     *
-     * @return string
-     */
-    public function context()
-    {
-        return $this->get('MSG_context');
-    }
-
-
-    /**
-     * This returns the corresponding localized label for the given context slug, if possible from installed message
-     * types. Otherwise, this will just return the set context slug on this object.
-     *
-     * @return string
-     */
-    public function context_label()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $contexts = $message_resource_manager->get_all_contexts();
-        return isset($contexts[ $this->context() ]) ? $contexts[ $this->context() ] : $this->context();
-    }
-
-
-    /**
-     * Sets context
-     *
-     * @param string $context
-     */
-    public function set_context($context)
-    {
-        $this->set('MSG_context', $context);
-    }
-
-
-    /**
-     * Gets recipient_ID
-     *
-     * @return int
-     */
-    public function recipient_ID()
-    {
-        return $this->get('MSG_recipient_ID');
-    }
-
-
-    /**
-     * Sets recipient_ID
-     *
-     * @param string $recipient_ID
-     */
-    public function set_recipient_ID($recipient_ID)
-    {
-        $this->set('MSG_recipient_ID', $recipient_ID);
-    }
-
-
-    /**
-     * Gets recipient_type
-     *
-     * @return string
-     */
-    public function recipient_type()
-    {
-        return $this->get('MSG_recipient_type');
-    }
-
-
-    /**
-     * Return the related object matching the recipient type and ID.
-     *
-     * @return EE_Base_Class | null
-     */
-    public function recipient_object()
-    {
-        if (! $this->recipient_type() || ! $this->recipient_ID()) {
-            return null;
-        }
-
-        return $this->get_first_related($this->recipient_type());
-    }
-
-
-    /**
-     * Sets recipient_type
-     *
-     * @param string $recipient_type
-     */
-    public function set_recipient_type($recipient_type)
-    {
-        $this->set('MSG_recipient_type', $recipient_type);
-    }
-
-
-    /**
-     * Gets content
-     *
-     * @return string
-     */
-    public function content()
-    {
-        return $this->get('MSG_content');
-    }
-
-
-    /**
-     * Sets content
-     *
-     * @param string $content
-     */
-    public function set_content($content)
-    {
-        $this->set('MSG_content', $content);
-    }
-
-
-    /**
-     * Gets subject
-     *
-     * @return string
-     */
-    public function subject()
-    {
-        return $this->get('MSG_subject');
-    }
-
-
-    /**
-     * Sets subject
-     *
-     * @param string $subject
-     */
-    public function set_subject($subject)
-    {
-        $this->set('MSG_subject', $subject);
-    }
-
-
-    /**
-     * Gets to
-     *
-     * @return string
-     */
-    public function to()
-    {
-        $to = $this->get('MSG_to');
-        return empty($to) ? __('No recipient', 'event_espresso') : $to;
-    }
-
-
-    /**
-     * Sets to
-     *
-     * @param string $to
-     */
-    public function set_to($to)
-    {
-        $this->set('MSG_to', $to);
-    }
-
-
-    /**
-     * Gets from
-     *
-     * @return string
-     */
-    public function from()
-    {
-        return $this->get('MSG_from');
-    }
-
-
-    /**
-     * Sets from
-     *
-     * @param string $from
-     */
-    public function set_from($from)
-    {
-        $this->set('MSG_from', $from);
-    }
-
-
-    /**
-     * Gets priority
-     *
-     * @return int
-     */
-    public function priority()
-    {
-        return $this->get('MSG_priority');
-    }
-
-
-    /**
-     * Sets priority
-     * Note.  Send Now Messengers always override any priority that may be set on a Message.  So
-     * this method calls the send_now method to verify that.
-     *
-     * @param int $priority
-     */
-    public function set_priority($priority)
-    {
-        $priority = $this->send_now() ? EEM_Message::priority_high : $priority;
-        parent::set('MSG_priority', $priority);
-    }
-
-
-    /**
-     * Overrides parent::set method so we can capture any sets for priority.
-     *
-     * @see parent::set() for phpdocs
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        if ($field_name === 'MSG_priority') {
-            $this->set_priority($field_value);
-        }
-        parent::set($field_name, $field_value, $use_default);
-    }
-
-
-    /**
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function send_now()
-    {
-        $send_now = $this->valid_messenger() && $this->messenger_object()->send_now() ? EEM_Message::priority_high
-            : $this->priority();
-        return $send_now === EEM_Message::priority_high ? true : false;
-    }
-
-
-    /**
-     * Gets STS_ID
-     *
-     * @return string
-     */
-    public function STS_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * Sets STS_ID
-     *
-     * @param string $STS_ID
-     */
-    public function set_STS_ID($STS_ID)
-    {
-        $this->set('STS_ID', $STS_ID);
-    }
-
-
-    /**
-     * Gets created
-     *
-     * @return string
-     */
-    public function created()
-    {
-        return $this->get('MSG_created');
-    }
-
-
-    /**
-     * Sets created
-     *
-     * @param string $created
-     */
-    public function set_created($created)
-    {
-        $this->set('MSG_created', $created);
-    }
-
-
-    /**
-     * Gets modified
-     *
-     * @return string
-     */
-    public function modified()
-    {
-        return $this->get('MSG_modified');
-    }
-
-
-    /**
-     * Sets modified
-     *
-     * @param string $modified
-     */
-    public function set_modified($modified)
-    {
-        $this->set('MSG_modified', $modified);
-    }
-
-
-    /**
-     * Sets generation data for this message.
-     *
-     * @param mixed $data
-     */
-    public function set_generation_data($data)
-    {
-        $this->set_field_or_extra_meta('MSG_generation_data', $data);
-    }
-
-
-    /**
-     * Returns any set generation data for this message.
-     *
-     * @return mixed|null
-     */
-    public function get_generation_data()
-    {
-        return $this->get_field_or_extra_meta('MSG_generation_data');
-    }
-
-
-    /**
-     * Gets any error message.
-     *
-     * @return mixed|null
-     */
-    public function error_message()
-    {
-        return $this->get_field_or_extra_meta('MSG_error');
-    }
-
-
-    /**
-     * Sets an error message.
-     *
-     * @param $message
-     * @return bool|int
-     */
-    public function set_error_message($message)
-    {
-        return $this->set_field_or_extra_meta('MSG_error', $message);
-    }
-
-
-    /**
-     * This retrieves the associated template pack with this message.
-     *
-     * @return EE_Messages_Template_Pack | null
-     */
-    public function get_template_pack()
-    {
-        /**
-         * This is deprecated functionality that will be removed eventually but included here now for backward compat.
-         */
-        if (! empty($this->template_pack)) {
-            return $this->template_pack;
-        }
-        /** @type EE_Message_Template_Group $grp */
-        $grp = $this->get_first_related('Message_Template_Group');
-        // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
-            $grp = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->messenger(),
-                        'MTP_message_type' => $this->message_type(),
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-        }
-
-        return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack() : null;
-    }
-
-
-    /**
-     * Retrieves the variation used for generating this message.
-     *
-     * @return string
-     */
-    public function get_template_pack_variation()
-    {
-        /**
-         * This is deprecated functionality that will be removed eventually but included here now for backward compat.
-         */
-        if (! empty($this->template_variation)) {
-            return $this->template_variation;
-        }
-
-        /** @type EE_Message_Template_Group $grp */
-        $grp = $this->get_first_related('Message_Template_Group');
-
-        // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
-            $grp = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->messenger(),
-                        'MTP_message_type' => $this->message_type(),
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-        }
-
-        return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack_variation() : '';
-    }
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    public function get_admin_details_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        EE_Registry::instance()->load_helper('MSG_Template');
-        switch ($this->STS_ID()) {
-            case EEM_Message::status_failed:
-            case EEM_Message::status_debug_only:
-                return EEH_MSG_Template::generate_error_display_trigger($this);
-                break;
-
-            case EEM_Message::status_sent:
-                return EEH_MSG_Template::generate_browser_trigger($this);
-                break;
-
-            default:
-                return '';
-        }
-    }
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     */
-    public function get_admin_edit_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_messages',
-                'action' => 'settings',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_messages',
-                'action' => 'default',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * This sets the EEM_Message::status_messenger_executing class on the message and the appropriate error message for
-     * it.
-     * Note this also SAVES the current message object to the db because it adds an error message to accompany the
-     * status.
-     *
-     */
-    public function set_messenger_is_executing()
-    {
-        $this->set_STS_ID(EEM_Message::status_messenger_executing);
-        $this->set_error_message(
-            esc_html__(
-                'A message with this status indicates that there was a problem that occurred while the message was being
+	/**
+	 * @deprecated 4.9.0  Added for backward compat with add-on's
+	 * @type null
+	 */
+	public $template_pack;
+
+	/**
+	 * @deprecated 4.9.0 Added for backward compat with add-on's
+	 * @type null
+	 */
+	public $template_variation;
+
+	/**
+	 * @deprecated 4.9.0 Added for backward compat with add-on's
+	 * @type string
+	 */
+	public $content = '';
+
+
+	/**
+	 * @type EE_messenger $_messenger
+	 */
+	protected $_messenger = null;
+
+	/**
+	 * @type EE_message_type $_message_type
+	 */
+	protected $_message_type = null;
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @param array  $date_formats incoming date formats in an array.  First value is the date_format, second is time
+	 *                             format.
+	 * @return EE_Message
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		// if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
+		if (! $has_object) {
+			EE_Registry::instance()->load_helper('URL');
+			$props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
+		}
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Gets MSG_token
+	 *
+	 * @return int
+	 */
+	public function MSG_token()
+	{
+		return $this->get('MSG_token');
+	}
+
+
+	/**
+	 * Sets MSG_token
+	 *
+	 * @param int $MSG_token
+	 */
+	public function set_MSG_token($MSG_token)
+	{
+		$this->set('MSG_token', $MSG_token);
+	}
+
+
+	/**
+	 * Gets GRP_ID
+	 *
+	 * @return int
+	 */
+	public function GRP_ID()
+	{
+		return $this->get('GRP_ID');
+	}
+
+
+	/**
+	 * Sets GRP_ID
+	 *
+	 * @param int $GRP_ID
+	 */
+	public function set_GRP_ID($GRP_ID)
+	{
+		$this->set('GRP_ID', $GRP_ID);
+	}
+
+
+	/**
+	 * Gets TXN_ID
+	 *
+	 * @return int
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * Sets TXN_ID
+	 *
+	 * @param int $TXN_ID
+	 */
+	public function set_TXN_ID($TXN_ID)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * Gets messenger
+	 *
+	 * @return string
+	 */
+	public function messenger()
+	{
+		return $this->get('MSG_messenger');
+	}
+
+
+	/**
+	 * Sets messenger
+	 *
+	 * @param string $messenger
+	 */
+	public function set_messenger($messenger)
+	{
+		$this->set('MSG_messenger', $messenger);
+	}
+
+
+	/**
+	 * Returns corresponding messenger object for the set messenger on this message
+	 *
+	 * @return EE_messenger | null
+	 */
+	public function messenger_object()
+	{
+		return $this->_messenger;
+	}
+
+
+	/**
+	 * Sets messenger
+	 *
+	 * @param EE_messenger $messenger
+	 */
+	public function set_messenger_object(EE_messenger $messenger)
+	{
+		$this->_messenger = $messenger;
+	}
+
+
+	/**
+	 * validates messenger
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function valid_messenger($throw_exceptions = false)
+	{
+		if ($this->_messenger instanceof EE_messenger) {
+			return true;
+		}
+		if ($throw_exceptions) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The "%1$s" messenger set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
+						'event_espresso'
+					),
+					$this->messenger()
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * This returns the set localized label for the messenger on this message.
+	 * Note, if unable to retrieve the EE_messenger object then will just return the messenger slug saved
+	 * with this message.
+	 *
+	 * @param   bool $plural whether to return the plural label or not.
+	 * @return string
+	 */
+	public function messenger_label($plural = false)
+	{
+		$label_type = $plural ? 'plural' : 'singular';
+		$messenger = $this->messenger_object();
+		return $messenger instanceof EE_messenger ? $messenger->label[ $label_type ] : $this->messenger();
+	}
+
+
+	/**
+	 * Gets message_type
+	 *
+	 * @return string
+	 */
+	public function message_type()
+	{
+		return $this->get('MSG_message_type');
+	}
+
+
+	/**
+	 * Sets message_type
+	 *
+	 * @param string $message_type
+	 */
+	public function set_message_type($message_type)
+	{
+		$this->set('MSG_message_type', $message_type);
+	}
+
+
+	/**
+	 * Returns the message type object for the set message type on this message
+	 *
+	 * @return EE_message_type | null
+	 */
+	public function message_type_object()
+	{
+		return $this->_message_type;
+	}
+
+
+	/**
+	 * Sets message_type
+	 *
+	 * @param EE_message_type $message_type
+	 * @param bool            $set_priority   This indicates whether to set the priority to whatever the priority is on
+	 *                                        the message type or not.
+	 */
+	public function set_message_type_object(EE_message_type $message_type, $set_priority = false)
+	{
+		$this->_message_type = $message_type;
+		if ($set_priority) {
+			$this->set_priority($this->_message_type->get_priority());
+		}
+	}
+
+
+	/**
+	 * validates message_type
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function valid_message_type($throw_exceptions = false)
+	{
+		if ($this->_message_type instanceof EE_message_type) {
+			return true;
+		}
+		if ($throw_exceptions) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The %1$s message type set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
+						'event_espresso'
+					),
+					$this->message_type()
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * validates messenger and message_type (that they are valid EE_messenger and EE_message_type objects).
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_valid($throw_exceptions = false)
+	{
+		if ($this->valid_messenger($throw_exceptions) && $this->valid_message_type($throw_exceptions)) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * This validates whether the internal messenger and message type objects are valid for sending.
+	 * Three checks are done:
+	 * 1. There is a valid messenger object.
+	 * 2. There is a valid message type object.
+	 * 3. The message type object is active for the messenger.
+	 *
+	 * @throws EE_Error  But only if $throw_exceptions is set to true.
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 */
+	public function is_valid_for_sending_or_generation($throw_exceptions = false)
+	{
+		$valid = false;
+		if ($this->is_valid($throw_exceptions)) {
+			/** @var EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$valid = $message_resource_manager->is_message_type_active_for_messenger(
+				$this->messenger(),
+				$this->message_type()
+			);
+			if (! $valid && $throw_exceptions) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'The %1$s message type is not a valid message type for the %2$s messenger so it will not be sent.',
+							'event_espresso'
+						),
+						$this->message_type(),
+						$this->messenger()
+					)
+				);
+			}
+		}
+		return $valid;
+	}
+
+
+	/**
+	 * This returns the set localized label for the message type on this message.
+	 * Note, if unable to retrieve the EE_message_type object then will just return the message type slug saved
+	 * with this message.
+	 *
+	 * @param   bool $plural whether to return the plural label or not.
+	 * @return string
+	 */
+	public function message_type_label($plural = false)
+	{
+		$label_type = $plural ? 'plural' : 'singular';
+		$message_type = $this->message_type_object();
+		return $message_type instanceof EE_message_type
+			? $message_type->label[ $label_type ]
+			: str_replace(
+				'_',
+				' ',
+				$this->message_type()
+			);
+	}
+
+
+	/**
+	 * Gets context
+	 *
+	 * @return string
+	 */
+	public function context()
+	{
+		return $this->get('MSG_context');
+	}
+
+
+	/**
+	 * This returns the corresponding localized label for the given context slug, if possible from installed message
+	 * types. Otherwise, this will just return the set context slug on this object.
+	 *
+	 * @return string
+	 */
+	public function context_label()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$contexts = $message_resource_manager->get_all_contexts();
+		return isset($contexts[ $this->context() ]) ? $contexts[ $this->context() ] : $this->context();
+	}
+
+
+	/**
+	 * Sets context
+	 *
+	 * @param string $context
+	 */
+	public function set_context($context)
+	{
+		$this->set('MSG_context', $context);
+	}
+
+
+	/**
+	 * Gets recipient_ID
+	 *
+	 * @return int
+	 */
+	public function recipient_ID()
+	{
+		return $this->get('MSG_recipient_ID');
+	}
+
+
+	/**
+	 * Sets recipient_ID
+	 *
+	 * @param string $recipient_ID
+	 */
+	public function set_recipient_ID($recipient_ID)
+	{
+		$this->set('MSG_recipient_ID', $recipient_ID);
+	}
+
+
+	/**
+	 * Gets recipient_type
+	 *
+	 * @return string
+	 */
+	public function recipient_type()
+	{
+		return $this->get('MSG_recipient_type');
+	}
+
+
+	/**
+	 * Return the related object matching the recipient type and ID.
+	 *
+	 * @return EE_Base_Class | null
+	 */
+	public function recipient_object()
+	{
+		if (! $this->recipient_type() || ! $this->recipient_ID()) {
+			return null;
+		}
+
+		return $this->get_first_related($this->recipient_type());
+	}
+
+
+	/**
+	 * Sets recipient_type
+	 *
+	 * @param string $recipient_type
+	 */
+	public function set_recipient_type($recipient_type)
+	{
+		$this->set('MSG_recipient_type', $recipient_type);
+	}
+
+
+	/**
+	 * Gets content
+	 *
+	 * @return string
+	 */
+	public function content()
+	{
+		return $this->get('MSG_content');
+	}
+
+
+	/**
+	 * Sets content
+	 *
+	 * @param string $content
+	 */
+	public function set_content($content)
+	{
+		$this->set('MSG_content', $content);
+	}
+
+
+	/**
+	 * Gets subject
+	 *
+	 * @return string
+	 */
+	public function subject()
+	{
+		return $this->get('MSG_subject');
+	}
+
+
+	/**
+	 * Sets subject
+	 *
+	 * @param string $subject
+	 */
+	public function set_subject($subject)
+	{
+		$this->set('MSG_subject', $subject);
+	}
+
+
+	/**
+	 * Gets to
+	 *
+	 * @return string
+	 */
+	public function to()
+	{
+		$to = $this->get('MSG_to');
+		return empty($to) ? __('No recipient', 'event_espresso') : $to;
+	}
+
+
+	/**
+	 * Sets to
+	 *
+	 * @param string $to
+	 */
+	public function set_to($to)
+	{
+		$this->set('MSG_to', $to);
+	}
+
+
+	/**
+	 * Gets from
+	 *
+	 * @return string
+	 */
+	public function from()
+	{
+		return $this->get('MSG_from');
+	}
+
+
+	/**
+	 * Sets from
+	 *
+	 * @param string $from
+	 */
+	public function set_from($from)
+	{
+		$this->set('MSG_from', $from);
+	}
+
+
+	/**
+	 * Gets priority
+	 *
+	 * @return int
+	 */
+	public function priority()
+	{
+		return $this->get('MSG_priority');
+	}
+
+
+	/**
+	 * Sets priority
+	 * Note.  Send Now Messengers always override any priority that may be set on a Message.  So
+	 * this method calls the send_now method to verify that.
+	 *
+	 * @param int $priority
+	 */
+	public function set_priority($priority)
+	{
+		$priority = $this->send_now() ? EEM_Message::priority_high : $priority;
+		parent::set('MSG_priority', $priority);
+	}
+
+
+	/**
+	 * Overrides parent::set method so we can capture any sets for priority.
+	 *
+	 * @see parent::set() for phpdocs
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		if ($field_name === 'MSG_priority') {
+			$this->set_priority($field_value);
+		}
+		parent::set($field_name, $field_value, $use_default);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function send_now()
+	{
+		$send_now = $this->valid_messenger() && $this->messenger_object()->send_now() ? EEM_Message::priority_high
+			: $this->priority();
+		return $send_now === EEM_Message::priority_high ? true : false;
+	}
+
+
+	/**
+	 * Gets STS_ID
+	 *
+	 * @return string
+	 */
+	public function STS_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * Sets STS_ID
+	 *
+	 * @param string $STS_ID
+	 */
+	public function set_STS_ID($STS_ID)
+	{
+		$this->set('STS_ID', $STS_ID);
+	}
+
+
+	/**
+	 * Gets created
+	 *
+	 * @return string
+	 */
+	public function created()
+	{
+		return $this->get('MSG_created');
+	}
+
+
+	/**
+	 * Sets created
+	 *
+	 * @param string $created
+	 */
+	public function set_created($created)
+	{
+		$this->set('MSG_created', $created);
+	}
+
+
+	/**
+	 * Gets modified
+	 *
+	 * @return string
+	 */
+	public function modified()
+	{
+		return $this->get('MSG_modified');
+	}
+
+
+	/**
+	 * Sets modified
+	 *
+	 * @param string $modified
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('MSG_modified', $modified);
+	}
+
+
+	/**
+	 * Sets generation data for this message.
+	 *
+	 * @param mixed $data
+	 */
+	public function set_generation_data($data)
+	{
+		$this->set_field_or_extra_meta('MSG_generation_data', $data);
+	}
+
+
+	/**
+	 * Returns any set generation data for this message.
+	 *
+	 * @return mixed|null
+	 */
+	public function get_generation_data()
+	{
+		return $this->get_field_or_extra_meta('MSG_generation_data');
+	}
+
+
+	/**
+	 * Gets any error message.
+	 *
+	 * @return mixed|null
+	 */
+	public function error_message()
+	{
+		return $this->get_field_or_extra_meta('MSG_error');
+	}
+
+
+	/**
+	 * Sets an error message.
+	 *
+	 * @param $message
+	 * @return bool|int
+	 */
+	public function set_error_message($message)
+	{
+		return $this->set_field_or_extra_meta('MSG_error', $message);
+	}
+
+
+	/**
+	 * This retrieves the associated template pack with this message.
+	 *
+	 * @return EE_Messages_Template_Pack | null
+	 */
+	public function get_template_pack()
+	{
+		/**
+		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
+		 */
+		if (! empty($this->template_pack)) {
+			return $this->template_pack;
+		}
+		/** @type EE_Message_Template_Group $grp */
+		$grp = $this->get_first_related('Message_Template_Group');
+		// if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
+		if (! $grp instanceof EE_Message_Template_Group) {
+			$grp = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->messenger(),
+						'MTP_message_type' => $this->message_type(),
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+		}
+
+		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack() : null;
+	}
+
+
+	/**
+	 * Retrieves the variation used for generating this message.
+	 *
+	 * @return string
+	 */
+	public function get_template_pack_variation()
+	{
+		/**
+		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
+		 */
+		if (! empty($this->template_variation)) {
+			return $this->template_variation;
+		}
+
+		/** @type EE_Message_Template_Group $grp */
+		$grp = $this->get_first_related('Message_Template_Group');
+
+		// if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
+		if (! $grp instanceof EE_Message_Template_Group) {
+			$grp = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->messenger(),
+						'MTP_message_type' => $this->message_type(),
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+		}
+
+		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack_variation() : '';
+	}
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_details_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		EE_Registry::instance()->load_helper('MSG_Template');
+		switch ($this->STS_ID()) {
+			case EEM_Message::status_failed:
+			case EEM_Message::status_debug_only:
+				return EEH_MSG_Template::generate_error_display_trigger($this);
+				break;
+
+			case EEM_Message::status_sent:
+				return EEH_MSG_Template::generate_browser_trigger($this);
+				break;
+
+			default:
+				return '';
+		}
+	}
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_messages',
+				'action' => 'settings',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_messages',
+				'action' => 'default',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * This sets the EEM_Message::status_messenger_executing class on the message and the appropriate error message for
+	 * it.
+	 * Note this also SAVES the current message object to the db because it adds an error message to accompany the
+	 * status.
+	 *
+	 */
+	public function set_messenger_is_executing()
+	{
+		$this->set_STS_ID(EEM_Message::status_messenger_executing);
+		$this->set_error_message(
+			esc_html__(
+				'A message with this status indicates that there was a problem that occurred while the message was being
                 processed by the messenger.  It is still possible that the message was sent successfully, but at some
                 point during the processing there was a failure.  This usually is indicative of a timeout issue with PHP 
                 or memory limits being reached.  If you see this repeatedly you may want to consider upgrading the memory 
                 available to PHP on your server.',
-                'event_espresso'
-            )
-        );
-    }
+				'event_espresso'
+			)
+		);
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -51,7 +51,7 @@ 
     {
         $has_object = parent::_check_for_object($props_n_values, __CLASS__);
         // if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
-        if (! $has_object) {
+        if ( ! $has_object) {
             EE_Registry::instance()->load_helper('URL');
             $props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
         }
@@ -219,7 +219,7 @@ 
     {
         $label_type = $plural ? 'plural' : 'singular';
         $messenger = $this->messenger_object();
-        return $messenger instanceof EE_messenger ? $messenger->label[ $label_type ] : $this->messenger();
+        return $messenger instanceof EE_messenger ? $messenger->label[$label_type] : $this->messenger();
     }
 
 
@@ -336,7 +336,7 @@ 
                 $this->messenger(),
                 $this->message_type()
             );
-            if (! $valid && $throw_exceptions) {
+            if ( ! $valid && $throw_exceptions) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -366,7 +366,7 @@ 
         $label_type = $plural ? 'plural' : 'singular';
         $message_type = $this->message_type_object();
         return $message_type instanceof EE_message_type
-            ? $message_type->label[ $label_type ]
+            ? $message_type->label[$label_type]
             : str_replace(
                 '_',
                 ' ',
@@ -397,7 +397,7 @@ 
         /** @type EE_Message_Resource_Manager $message_resource_manager */
         $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $contexts = $message_resource_manager->get_all_contexts();
-        return isset($contexts[ $this->context() ]) ? $contexts[ $this->context() ] : $this->context();
+        return isset($contexts[$this->context()]) ? $contexts[$this->context()] : $this->context();
     }
 
 
@@ -452,7 +452,7 @@ 
      */
     public function recipient_object()
     {
-        if (! $this->recipient_type() || ! $this->recipient_ID()) {
+        if ( ! $this->recipient_type() || ! $this->recipient_ID()) {
             return null;
         }
 
@@ -736,13 +736,13 @@ 
         /**
          * This is deprecated functionality that will be removed eventually but included here now for backward compat.
          */
-        if (! empty($this->template_pack)) {
+        if ( ! empty($this->template_pack)) {
             return $this->template_pack;
         }
         /** @type EE_Message_Template_Group $grp */
         $grp = $this->get_first_related('Message_Template_Group');
         // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
+        if ( ! $grp instanceof EE_Message_Template_Group) {
             $grp = EEM_Message_Template_Group::instance()->get_one(
                 array(
                     array(
@@ -768,7 +768,7 @@ 
         /**
          * This is deprecated functionality that will be removed eventually but included here now for backward compat.
          */
-        if (! empty($this->template_variation)) {
+        if ( ! empty($this->template_variation)) {
             return $this->template_variation;
         }
 
@@ -776,7 +776,7 @@ 
         $grp = $this->get_first_related('Message_Template_Group');
 
         // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
+        if ( ! $grp instanceof EE_Message_Template_Group) {
             $grp = EEM_Message_Template_Group::instance()->get_one(
                 array(
                     array(