eventespresso / event-espresso-core

core/domain/services/validation/email/strategies/InternationalDNS.php

Spacing +2 added lines, -2 removed lines

@@ -34,7 +34,7 @@ 
             $email_address,
             $this->getAtIndex($email_address)
         );
-        if (! checkdnsrr($domain, 'MX')) {
+        if ( ! checkdnsrr($domain, 'MX')) {
             // domain not found in MX records
             throw new EmailValidationException(
                 __(
@@ -45,7 +45,7 @@ 
                 )
             );
         }
-        if (! checkdnsrr($domain, 'A')) {
+        if ( ! checkdnsrr($domain, 'A')) {
             // domain not found in A records
             throw new EmailValidationException(
                 __(

Indentation +39 added lines, -39 removed lines

@@ -15,43 +15,43 @@
 class InternationalDNS extends International
 {
 
-    /**
-     * Validates the email in teh same way as the parent, but also
-     * verifies the domain exists.
-     *
-     * @param string $email_address
-     * @return bool
-     * @throws EmailValidationException
-     */
-    public function validate($email_address)
-    {
-        parent::validate($email_address);
-        $domain = $this->getDomainPartOfEmail(
-            $email_address,
-            $this->getAtIndex($email_address)
-        );
-        if (! checkdnsrr($domain, 'MX')) {
-            // domain not found in MX records
-            throw new EmailValidationException(
-                __(
-                // @codingStandardsIgnoreStart
-                    'Although the email address provided is formatted correctly, a valid "MX record" could not be located for that address and domain. Please enter a valid email address.',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                )
-            );
-        }
-        if (! checkdnsrr($domain, 'A')) {
-            // domain not found in A records
-            throw new EmailValidationException(
-                __(
-                // @codingStandardsIgnoreStart
-                    'Although the email address provided is formatted correctly, a valid "A record" could not be located for that address and domain. Please enter a valid email address.',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                )
-            );
-        }
-        return true;
-    }
+	/**
+	 * Validates the email in teh same way as the parent, but also
+	 * verifies the domain exists.
+	 *
+	 * @param string $email_address
+	 * @return bool
+	 * @throws EmailValidationException
+	 */
+	public function validate($email_address)
+	{
+		parent::validate($email_address);
+		$domain = $this->getDomainPartOfEmail(
+			$email_address,
+			$this->getAtIndex($email_address)
+		);
+		if (! checkdnsrr($domain, 'MX')) {
+			// domain not found in MX records
+			throw new EmailValidationException(
+				__(
+				// @codingStandardsIgnoreStart
+					'Although the email address provided is formatted correctly, a valid "MX record" could not be located for that address and domain. Please enter a valid email address.',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				)
+			);
+		}
+		if (! checkdnsrr($domain, 'A')) {
+			// domain not found in A records
+			throw new EmailValidationException(
+				__(
+				// @codingStandardsIgnoreStart
+					'Although the email address provided is formatted correctly, a valid "A record" could not be located for that address and domain. Please enter a valid email address.',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				)
+			);
+		}
+		return true;
+	}
 }

core/domain/services/validation/email/EmailValidatorInterface.php

Indentation +8 added lines, -8 removed lines

@@ -18,14 +18,14 @@
 interface EmailValidatorInterface
 {
 
-    /**
-     * Validates the supplied email address. If it is invalid, throws EmailValidationException
-     *
-     * @param string $email_address
-     * @return boolean
-     * @throws EmailValidationException
-     */
-    public function validate($email_address);
+	/**
+	 * Validates the supplied email address. If it is invalid, throws EmailValidationException
+	 *
+	 * @param string $email_address
+	 * @return boolean
+	 * @throws EmailValidationException
+	 */
+	public function validate($email_address);
 
 
 }

core/libraries/form_sections/strategies/validation/EE_Email_Validation_Strategy.strategy.php

Indentation +59 added lines, -59 removed lines

@@ -18,72 +18,72 @@
 {
 
 
-    /**
-     * @param string               $validation_error_message
-     */
-    public function __construct($validation_error_message = '')
-    {
-        if (! $validation_error_message) {
-            $validation_error_message = esc_html__('Please enter a valid email address.', 'event_espresso');
-        }
-        parent::__construct($validation_error_message);
-    }
+	/**
+	 * @param string               $validation_error_message
+	 */
+	public function __construct($validation_error_message = '')
+	{
+		if (! $validation_error_message) {
+			$validation_error_message = esc_html__('Please enter a valid email address.', 'event_espresso');
+		}
+		parent::__construct($validation_error_message);
+	}
 
 
 
-    /**
-     * just checks the field isn't blank
-     *
-     * @param $normalized_value
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Validation_Error
-     */
-    public function validate($normalized_value)
-    {
-        if ($normalized_value && ! $this->_validate_email($normalized_value)) {
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'required');
-        }
-        return true;
-    }
+	/**
+	 * just checks the field isn't blank
+	 *
+	 * @param $normalized_value
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Validation_Error
+	 */
+	public function validate($normalized_value)
+	{
+		if ($normalized_value && ! $this->_validate_email($normalized_value)) {
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'required');
+		}
+		return true;
+	}
 
 
 
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        return array('email' => true, 'messages' => array('email' => $this->get_validation_error_message()));
-    }
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		return array('email' => true, 'messages' => array('email' => $this->get_validation_error_message()));
+	}
 
 
 
-    /**
-     * Validate an email address.
-     * Provide email address (raw input)
-     *
-     * @param $email
-     * @return bool of whether the email is valid or not
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Validation_Error
-     */
-    private function _validate_email($email)
-    {
-        try {
-            EmailAddressFactory::create($email);
-        } catch (EmailValidationException $e) {
-            throw new EE_Validation_Error(
-                $e->getMessage(),
-                'invalid_email',
-                $this->_input,
-                $e
-            );
-        }
-        return true;
-    }
+	/**
+	 * Validate an email address.
+	 * Provide email address (raw input)
+	 *
+	 * @param $email
+	 * @return bool of whether the email is valid or not
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Validation_Error
+	 */
+	private function _validate_email($email)
+	{
+		try {
+			EmailAddressFactory::create($email);
+		} catch (EmailValidationException $e) {
+			throw new EE_Validation_Error(
+				$e->getMessage(),
+				'invalid_email',
+				$this->_input,
+				$e
+			);
+		}
+		return true;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
      */
     public function __construct($validation_error_message = '')
     {
-        if (! $validation_error_message) {
+        if ( ! $validation_error_message) {
             $validation_error_message = esc_html__('Please enter a valid email address.', 'event_espresso');
         }
         parent::__construct($validation_error_message);

core/db_models/EEM_Attendee.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -351,7 +351,7 @@
      * retrieve  a single attendee from db via their ID
      *
      * @param $ATT_ID
-     * @return mixed array on success, FALSE on fail
+     * @return EE_Base_Class|null array on success, FALSE on fail
      * @deprecated
      */
     public function get_attendee_by_ID($ATT_ID = false)

Unused Use Statements -1 removed lines

@@ -1,5 +1,4 @@
 <?php
-use EventEspresso\core\services\loaders\Loader;
 use EventEspresso\core\services\orm\ModelFieldFactory;
 
 /**

Spacing +3 added lines, -3 removed lines

@@ -284,8 +284,8 @@ 
      */
     public function get_attendee_field_for_system_question($system_question_string)
     {
-        return isset($this->_system_question_to_attendee_field_name[ $system_question_string ])
-            ? $this->_system_question_to_attendee_field_name[ $system_question_string ]
+        return isset($this->_system_question_to_attendee_field_name[$system_question_string])
+            ? $this->_system_question_to_attendee_field_name[$system_question_string]
             : null;
     }
 
@@ -353,7 +353,7 @@ 
             return false;
         }
         $attendee = $this->get_all(array($where_cols_n_values));
-        if (! empty($attendee)) {
+        if ( ! empty($attendee)) {
             return array_shift($attendee);
         }
         return false;

Indentation +418 added lines, -418 removed lines

@@ -12,430 +12,430 @@
 class EEM_Attendee extends EEM_CPT_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
-    /**
-     * QST_system for questions are strings not integers now,
-     * so these constants are deprecated.
-     * Please instead use the EEM_Attendee::system_question_* constants
-     *
-     * @deprecated
-     */
-    const fname_question_id = 1;
+	/**
+	 * QST_system for questions are strings not integers now,
+	 * so these constants are deprecated.
+	 * Please instead use the EEM_Attendee::system_question_* constants
+	 *
+	 * @deprecated
+	 */
+	const fname_question_id = 1;
 
-    /**
-     * @deprecated
-     */
-    const lname_question_id = 2;
+	/**
+	 * @deprecated
+	 */
+	const lname_question_id = 2;
 
 
-    /**
-     * @deprecated
-     */
-    const email_question_id = 3;
+	/**
+	 * @deprecated
+	 */
+	const email_question_id = 3;
 
 
-    /**
-     * @deprecated
-     */
-    const address_question_id = 4;
+	/**
+	 * @deprecated
+	 */
+	const address_question_id = 4;
 
 
-    /**
-     * @deprecated
-     */
-    const address2_question_id = 5;
-
-
-    /**
-     * @deprecated
-     */
-    const city_question_id = 6;
-
-
-    /**
-     * @deprecated
-     */
-    const state_question_id = 7;
-
-
-    /**
-     * @deprecated
-     */
-    const country_question_id = 8;
-
-
-    /**
-     * @deprecated
-     */
-    const zip_question_id = 9;
-
-
-    /**
-     * @deprecated
-     */
-    const phone_question_id = 10;
-
-    /**
-     * When looking for questions that correspond to attendee fields,
-     * look for the question with this QST_system value.
-     * These replace the old constants like EEM_Attendee::*_question_id
-     */
-    const system_question_fname = 'fname';
-
-    const system_question_lname = 'lname';
-
-    const system_question_email = 'email';
-
-    const system_question_address = 'address';
-
-    const system_question_address2 = 'address2';
-
-    const system_question_city = 'city';
-
-    const system_question_state = 'state';
-
-    const system_question_country = 'country';
-
-    const system_question_zip = 'zip';
-
-    const system_question_phone = 'phone';
-
-    /**
-     * Keys are all the EEM_Attendee::system_question_* constants, which are
-     * also all the values of QST_system in the questions table, and values
-     * are their corresponding Attendee field names
-     *
-     * @var array
-     */
-    protected $_system_question_to_attendee_field_name = array(
-        EEM_Attendee::system_question_fname    => 'ATT_fname',
-        EEM_Attendee::system_question_lname    => 'ATT_lname',
-        EEM_Attendee::system_question_email    => 'ATT_email',
-        EEM_Attendee::system_question_address  => 'ATT_address',
-        EEM_Attendee::system_question_address2 => 'ATT_address2',
-        EEM_Attendee::system_question_city     => 'ATT_city',
-        EEM_Attendee::system_question_state    => 'STA_ID',
-        EEM_Attendee::system_question_country  => 'CNT_ISO',
-        EEM_Attendee::system_question_zip      => 'ATT_zip',
-        EEM_Attendee::system_question_phone    => 'ATT_phone',
-    );
-
-
-
-    /**
-     * EEM_Attendee constructor.
-     *
-     * @param null              $timezone
-     * @param ModelFieldFactory $model_field_factory
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone = null, ModelFieldFactory $model_field_factory)
-    {
-        $this->singular_item = esc_html__('Attendee', 'event_espresso');
-        $this->plural_item = esc_html__('Attendees', 'event_espresso');
-        $this->_tables = array(
-            'Attendee_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Attendee_Meta' => new EE_Secondary_Table(
-                'esp_attendee_meta',
-                'ATTM_ID',
-                'ATT_ID'
-            ),
-        );
-        $this->_fields = array(
-            'Attendee_CPT'  => array(
-                'ATT_ID'        => $model_field_factory->createPrimaryKeyIntField(
-                    'ID',
-                    esc_html__('Attendee ID', 'event_espresso')
-                ),
-                'ATT_full_name' => $model_field_factory->createPlainTextField(
-                    'post_title',
-                    esc_html__('Attendee Full Name', 'event_espresso'),
-                    false,
-                    esc_html__('Unknown', 'event_espresso')
-                ),
-                'ATT_bio'       => $model_field_factory->createPostContentField(
-                    'post_content',
-                    esc_html__('Attendee Biography', 'event_espresso'),
-                    false,
-                    esc_html__('No Biography Provided', 'event_espresso')
-                ),
-                'ATT_slug'      => $model_field_factory->createSlugField(
-                    'post_name',
-                    esc_html__('Attendee URL Slug', 'event_espresso')
-                ),
-                'ATT_created'   => $model_field_factory->createDatetimeField(
-                    'post_date',
-                    esc_html__('Time Attendee Created', 'event_espresso')
-                ),
-                'ATT_short_bio' => $model_field_factory->createSimpleHtmlField(
-                    'post_excerpt',
-                    esc_html__('Attendee Short Biography', 'event_espresso'),
-                    true,
-                    esc_html__('No Biography Provided', 'event_espresso')
-                ),
-                'ATT_modified'  => $model_field_factory->createDatetimeField(
-                    'post_modified',
-                    esc_html__('Time Attendee Last Modified', 'event_espresso')
-                ),
-                'ATT_author'    => $model_field_factory->createWpUserField(
-                    'post_author',
-                    esc_html__('Creator ID of the first Event attended', 'event_espresso'),
-                    false
-                ),
-                'ATT_parent'    => $model_field_factory->createDbOnlyIntField(
-                    'post_parent',
-                    esc_html__('Parent Attendee (unused)', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'post_type'     => $model_field_factory->createWpPostTypeField('espresso_attendees'),
-                'status'        => $model_field_factory->createWpPostStatusField(
-                    'post_status',
-                    esc_html__('Attendee Status', 'event_espresso'),
-                    false,
-                    'publish'
-                ),
-                'password' => new EE_Password_Field(
-                    'post_password',
-                    __('Password', 'event_espresso'),
-                    false,
-                    '',
-                    array(
-                        'ATT_bio',
-                        'ATT_short_bio',
-                        'ATT_address',
-                        'ATT_address2',
-                        'ATT_city',
-                        'STA_ID',
-                        'CNT_ISO',
-                        'ATT_zip',
-                        'ATT_email',
-                        'ATT_phone'
-                    )
-                )
-            ),
-            'Attendee_Meta' => array(
-                'ATTM_ID'      => $model_field_factory->createDbOnlyIntField(
-                    'ATTM_ID',
-                    esc_html__('Attendee Meta Row ID', 'event_espresso'),
-                    false
-                ),
-                'ATT_ID_fk'    => $model_field_factory->createDbOnlyIntField(
-                    'ATT_ID',
-                    esc_html__('Foreign Key to Attendee in Post Table', 'event_espresso'),
-                    false
-                ),
-                'ATT_fname'    => $model_field_factory->createPlainTextField(
-                    'ATT_fname',
-                    esc_html__('First Name', 'event_espresso')
-                ),
-                'ATT_lname'    => $model_field_factory->createPlainTextField(
-                    'ATT_lname',
-                    esc_html__('Last Name', 'event_espresso')
-                ),
-                'ATT_address'  => $model_field_factory->createPlainTextField(
-                    'ATT_address',
-                    esc_html__('Address Part 1', 'event_espresso')
-                ),
-                'ATT_address2' => $model_field_factory->createPlainTextField(
-                    'ATT_address2',
-                    esc_html__('Address Part 2', 'event_espresso')
-                ),
-                'ATT_city'     => $model_field_factory->createPlainTextField(
-                    'ATT_city',
-                    esc_html__('City', 'event_espresso')
-                ),
-                'STA_ID'       => $model_field_factory->createForeignKeyIntField(
-                    'STA_ID',
-                    esc_html__('State', 'event_espresso'),
-                    true,
-                    0,
-                    'State'
-                ),
-                'CNT_ISO'      => $model_field_factory->createForeignKeyStringField(
-                    'CNT_ISO',
-                    esc_html__('Country', 'event_espresso'),
-                    true,
-                    '',
-                    'Country'
-                ),
-                'ATT_zip'      => $model_field_factory->createPlainTextField(
-                    'ATT_zip',
-                    esc_html__('ZIP/Postal Code', 'event_espresso')
-                ),
-                'ATT_email'    => $model_field_factory->createEmailField(
-                    'ATT_email',
-                    esc_html__('Email Address', 'event_espresso')
-                ),
-                'ATT_phone'    => $model_field_factory->createPlainTextField(
-                    'ATT_phone',
-                    esc_html__('Phone', 'event_espresso')
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration'      => new EE_Has_Many_Relation(),
-            'State'             => new EE_Belongs_To_Relation(),
-            'Country'           => new EE_Belongs_To_Relation(),
-            'Event'             => new EE_HABTM_Relation('Registration', false),
-            'WP_User'           => new EE_Belongs_To_Relation(),
-            'Message'           => new EE_Has_Many_Any_Relation(false),
-            // allow deletion of attendees even if they have messages in the queue for them.
-            'Term_Relationship' => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
-        );
-        $this->_caps_slug = 'contacts';
-        $this->model_chain_to_password = '';
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * Gets the name of the field on the attendee model corresponding to the system question string
-     * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name
-     *
-     * @param string $system_question_string
-     * @return string|null if not found
-     */
-    public function get_attendee_field_for_system_question($system_question_string)
-    {
-        return isset($this->_system_question_to_attendee_field_name[ $system_question_string ])
-            ? $this->_system_question_to_attendee_field_name[ $system_question_string ]
-            : null;
-    }
-
-
-
-    /**
-     * Gets mapping from esp_question.QST_system values to their corresponding attendee field names
-     *
-     * @return array
-     */
-    public function system_question_to_attendee_field_mapping()
-    {
-        return $this->_system_question_to_attendee_field_name;
-    }
-
-
-
-    /**
-     * Gets all the attendees for a transaction (by using the esp_registration as a join table)
-     *
-     * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID
-     * @return EE_Attendee[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_attendees_for_transaction($transaction_id_or_obj)
-    {
-        return $this->get_all(
-            array(
-                array(
-                    'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction
-                        ? $transaction_id_or_obj->ID()
-                        : $transaction_id_or_obj,
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * retrieve  a single attendee from db via their ID
-     *
-     * @param $ATT_ID
-     * @return mixed array on success, FALSE on fail
-     * @deprecated
-     */
-    public function get_attendee_by_ID($ATT_ID = false)
-    {
-        // retrieve a particular EE_Attendee
-        return $this->get_one_by_ID($ATT_ID);
-    }
-
-
-
-    /**
-     * retrieve  a single attendee from db via their ID
-     *
-     * @param array $where_cols_n_values
-     * @return mixed array on success, FALSE on fail
-     * @throws EE_Error
-     */
-    public function get_attendee($where_cols_n_values = array())
-    {
-        if (empty($where_cols_n_values)) {
-            return false;
-        }
-        $attendee = $this->get_all(array($where_cols_n_values));
-        if (! empty($attendee)) {
-            return array_shift($attendee);
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Search for an existing Attendee record in the DB
-     *
-     * @param array $where_cols_n_values
-     * @return bool|mixed
-     * @throws EE_Error
-     */
-    public function find_existing_attendee($where_cols_n_values = null)
-    {
-        // search by combo of first and last names plus the email address
-        $attendee_data_keys = array(
-            'ATT_fname' => $this->_ATT_fname,
-            'ATT_lname' => $this->_ATT_lname,
-            'ATT_email' => $this->_ATT_email,
-        );
-        // no search params means attendee object already exists.
-        $where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values)
-            ? $where_cols_n_values
-            : $attendee_data_keys;
-        $valid_data = true;
-        // check for required values
-        $valid_data = isset($where_cols_n_values['ATT_fname']) && ! empty($where_cols_n_values['ATT_fname'])
-            ? $valid_data
-            : false;
-        $valid_data = isset($where_cols_n_values['ATT_lname']) && ! empty($where_cols_n_values['ATT_lname'])
-            ? $valid_data
-            : false;
-        $valid_data = isset($where_cols_n_values['ATT_email']) && ! empty($where_cols_n_values['ATT_email'])
-            ? $valid_data
-            : false;
-        if ($valid_data) {
-            $attendee = $this->get_attendee($where_cols_n_values);
-            if ($attendee instanceof EE_Attendee) {
-                return $attendee;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Takes an incoming array of EE_Registration ids
-     * and sends back a list of corresponding non duplicate EE_Attendee objects.
-     *
-     * @since  4.3.0
-     * @param  array $ids array of EE_Registration ids
-     * @return EE_Attendee[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_array_of_contacts_from_reg_ids($ids)
-    {
-        $ids = (array) $ids;
-        $_where = array(
-            'Registration.REG_ID' => array('in', $ids),
-        );
-        return $this->get_all(array($_where));
-    }
+	/**
+	 * @deprecated
+	 */
+	const address2_question_id = 5;
+
+
+	/**
+	 * @deprecated
+	 */
+	const city_question_id = 6;
+
+
+	/**
+	 * @deprecated
+	 */
+	const state_question_id = 7;
+
+
+	/**
+	 * @deprecated
+	 */
+	const country_question_id = 8;
+
+
+	/**
+	 * @deprecated
+	 */
+	const zip_question_id = 9;
+
+
+	/**
+	 * @deprecated
+	 */
+	const phone_question_id = 10;
+
+	/**
+	 * When looking for questions that correspond to attendee fields,
+	 * look for the question with this QST_system value.
+	 * These replace the old constants like EEM_Attendee::*_question_id
+	 */
+	const system_question_fname = 'fname';
+
+	const system_question_lname = 'lname';
+
+	const system_question_email = 'email';
+
+	const system_question_address = 'address';
+
+	const system_question_address2 = 'address2';
+
+	const system_question_city = 'city';
+
+	const system_question_state = 'state';
+
+	const system_question_country = 'country';
+
+	const system_question_zip = 'zip';
+
+	const system_question_phone = 'phone';
+
+	/**
+	 * Keys are all the EEM_Attendee::system_question_* constants, which are
+	 * also all the values of QST_system in the questions table, and values
+	 * are their corresponding Attendee field names
+	 *
+	 * @var array
+	 */
+	protected $_system_question_to_attendee_field_name = array(
+		EEM_Attendee::system_question_fname    => 'ATT_fname',
+		EEM_Attendee::system_question_lname    => 'ATT_lname',
+		EEM_Attendee::system_question_email    => 'ATT_email',
+		EEM_Attendee::system_question_address  => 'ATT_address',
+		EEM_Attendee::system_question_address2 => 'ATT_address2',
+		EEM_Attendee::system_question_city     => 'ATT_city',
+		EEM_Attendee::system_question_state    => 'STA_ID',
+		EEM_Attendee::system_question_country  => 'CNT_ISO',
+		EEM_Attendee::system_question_zip      => 'ATT_zip',
+		EEM_Attendee::system_question_phone    => 'ATT_phone',
+	);
+
+
+
+	/**
+	 * EEM_Attendee constructor.
+	 *
+	 * @param null              $timezone
+	 * @param ModelFieldFactory $model_field_factory
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone = null, ModelFieldFactory $model_field_factory)
+	{
+		$this->singular_item = esc_html__('Attendee', 'event_espresso');
+		$this->plural_item = esc_html__('Attendees', 'event_espresso');
+		$this->_tables = array(
+			'Attendee_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Attendee_Meta' => new EE_Secondary_Table(
+				'esp_attendee_meta',
+				'ATTM_ID',
+				'ATT_ID'
+			),
+		);
+		$this->_fields = array(
+			'Attendee_CPT'  => array(
+				'ATT_ID'        => $model_field_factory->createPrimaryKeyIntField(
+					'ID',
+					esc_html__('Attendee ID', 'event_espresso')
+				),
+				'ATT_full_name' => $model_field_factory->createPlainTextField(
+					'post_title',
+					esc_html__('Attendee Full Name', 'event_espresso'),
+					false,
+					esc_html__('Unknown', 'event_espresso')
+				),
+				'ATT_bio'       => $model_field_factory->createPostContentField(
+					'post_content',
+					esc_html__('Attendee Biography', 'event_espresso'),
+					false,
+					esc_html__('No Biography Provided', 'event_espresso')
+				),
+				'ATT_slug'      => $model_field_factory->createSlugField(
+					'post_name',
+					esc_html__('Attendee URL Slug', 'event_espresso')
+				),
+				'ATT_created'   => $model_field_factory->createDatetimeField(
+					'post_date',
+					esc_html__('Time Attendee Created', 'event_espresso')
+				),
+				'ATT_short_bio' => $model_field_factory->createSimpleHtmlField(
+					'post_excerpt',
+					esc_html__('Attendee Short Biography', 'event_espresso'),
+					true,
+					esc_html__('No Biography Provided', 'event_espresso')
+				),
+				'ATT_modified'  => $model_field_factory->createDatetimeField(
+					'post_modified',
+					esc_html__('Time Attendee Last Modified', 'event_espresso')
+				),
+				'ATT_author'    => $model_field_factory->createWpUserField(
+					'post_author',
+					esc_html__('Creator ID of the first Event attended', 'event_espresso'),
+					false
+				),
+				'ATT_parent'    => $model_field_factory->createDbOnlyIntField(
+					'post_parent',
+					esc_html__('Parent Attendee (unused)', 'event_espresso'),
+					false,
+					0
+				),
+				'post_type'     => $model_field_factory->createWpPostTypeField('espresso_attendees'),
+				'status'        => $model_field_factory->createWpPostStatusField(
+					'post_status',
+					esc_html__('Attendee Status', 'event_espresso'),
+					false,
+					'publish'
+				),
+				'password' => new EE_Password_Field(
+					'post_password',
+					__('Password', 'event_espresso'),
+					false,
+					'',
+					array(
+						'ATT_bio',
+						'ATT_short_bio',
+						'ATT_address',
+						'ATT_address2',
+						'ATT_city',
+						'STA_ID',
+						'CNT_ISO',
+						'ATT_zip',
+						'ATT_email',
+						'ATT_phone'
+					)
+				)
+			),
+			'Attendee_Meta' => array(
+				'ATTM_ID'      => $model_field_factory->createDbOnlyIntField(
+					'ATTM_ID',
+					esc_html__('Attendee Meta Row ID', 'event_espresso'),
+					false
+				),
+				'ATT_ID_fk'    => $model_field_factory->createDbOnlyIntField(
+					'ATT_ID',
+					esc_html__('Foreign Key to Attendee in Post Table', 'event_espresso'),
+					false
+				),
+				'ATT_fname'    => $model_field_factory->createPlainTextField(
+					'ATT_fname',
+					esc_html__('First Name', 'event_espresso')
+				),
+				'ATT_lname'    => $model_field_factory->createPlainTextField(
+					'ATT_lname',
+					esc_html__('Last Name', 'event_espresso')
+				),
+				'ATT_address'  => $model_field_factory->createPlainTextField(
+					'ATT_address',
+					esc_html__('Address Part 1', 'event_espresso')
+				),
+				'ATT_address2' => $model_field_factory->createPlainTextField(
+					'ATT_address2',
+					esc_html__('Address Part 2', 'event_espresso')
+				),
+				'ATT_city'     => $model_field_factory->createPlainTextField(
+					'ATT_city',
+					esc_html__('City', 'event_espresso')
+				),
+				'STA_ID'       => $model_field_factory->createForeignKeyIntField(
+					'STA_ID',
+					esc_html__('State', 'event_espresso'),
+					true,
+					0,
+					'State'
+				),
+				'CNT_ISO'      => $model_field_factory->createForeignKeyStringField(
+					'CNT_ISO',
+					esc_html__('Country', 'event_espresso'),
+					true,
+					'',
+					'Country'
+				),
+				'ATT_zip'      => $model_field_factory->createPlainTextField(
+					'ATT_zip',
+					esc_html__('ZIP/Postal Code', 'event_espresso')
+				),
+				'ATT_email'    => $model_field_factory->createEmailField(
+					'ATT_email',
+					esc_html__('Email Address', 'event_espresso')
+				),
+				'ATT_phone'    => $model_field_factory->createPlainTextField(
+					'ATT_phone',
+					esc_html__('Phone', 'event_espresso')
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration'      => new EE_Has_Many_Relation(),
+			'State'             => new EE_Belongs_To_Relation(),
+			'Country'           => new EE_Belongs_To_Relation(),
+			'Event'             => new EE_HABTM_Relation('Registration', false),
+			'WP_User'           => new EE_Belongs_To_Relation(),
+			'Message'           => new EE_Has_Many_Any_Relation(false),
+			// allow deletion of attendees even if they have messages in the queue for them.
+			'Term_Relationship' => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
+		);
+		$this->_caps_slug = 'contacts';
+		$this->model_chain_to_password = '';
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * Gets the name of the field on the attendee model corresponding to the system question string
+	 * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name
+	 *
+	 * @param string $system_question_string
+	 * @return string|null if not found
+	 */
+	public function get_attendee_field_for_system_question($system_question_string)
+	{
+		return isset($this->_system_question_to_attendee_field_name[ $system_question_string ])
+			? $this->_system_question_to_attendee_field_name[ $system_question_string ]
+			: null;
+	}
+
+
+
+	/**
+	 * Gets mapping from esp_question.QST_system values to their corresponding attendee field names
+	 *
+	 * @return array
+	 */
+	public function system_question_to_attendee_field_mapping()
+	{
+		return $this->_system_question_to_attendee_field_name;
+	}
+
+
+
+	/**
+	 * Gets all the attendees for a transaction (by using the esp_registration as a join table)
+	 *
+	 * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID
+	 * @return EE_Attendee[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_attendees_for_transaction($transaction_id_or_obj)
+	{
+		return $this->get_all(
+			array(
+				array(
+					'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction
+						? $transaction_id_or_obj->ID()
+						: $transaction_id_or_obj,
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * retrieve  a single attendee from db via their ID
+	 *
+	 * @param $ATT_ID
+	 * @return mixed array on success, FALSE on fail
+	 * @deprecated
+	 */
+	public function get_attendee_by_ID($ATT_ID = false)
+	{
+		// retrieve a particular EE_Attendee
+		return $this->get_one_by_ID($ATT_ID);
+	}
+
+
+
+	/**
+	 * retrieve  a single attendee from db via their ID
+	 *
+	 * @param array $where_cols_n_values
+	 * @return mixed array on success, FALSE on fail
+	 * @throws EE_Error
+	 */
+	public function get_attendee($where_cols_n_values = array())
+	{
+		if (empty($where_cols_n_values)) {
+			return false;
+		}
+		$attendee = $this->get_all(array($where_cols_n_values));
+		if (! empty($attendee)) {
+			return array_shift($attendee);
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Search for an existing Attendee record in the DB
+	 *
+	 * @param array $where_cols_n_values
+	 * @return bool|mixed
+	 * @throws EE_Error
+	 */
+	public function find_existing_attendee($where_cols_n_values = null)
+	{
+		// search by combo of first and last names plus the email address
+		$attendee_data_keys = array(
+			'ATT_fname' => $this->_ATT_fname,
+			'ATT_lname' => $this->_ATT_lname,
+			'ATT_email' => $this->_ATT_email,
+		);
+		// no search params means attendee object already exists.
+		$where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values)
+			? $where_cols_n_values
+			: $attendee_data_keys;
+		$valid_data = true;
+		// check for required values
+		$valid_data = isset($where_cols_n_values['ATT_fname']) && ! empty($where_cols_n_values['ATT_fname'])
+			? $valid_data
+			: false;
+		$valid_data = isset($where_cols_n_values['ATT_lname']) && ! empty($where_cols_n_values['ATT_lname'])
+			? $valid_data
+			: false;
+		$valid_data = isset($where_cols_n_values['ATT_email']) && ! empty($where_cols_n_values['ATT_email'])
+			? $valid_data
+			: false;
+		if ($valid_data) {
+			$attendee = $this->get_attendee($where_cols_n_values);
+			if ($attendee instanceof EE_Attendee) {
+				return $attendee;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Takes an incoming array of EE_Registration ids
+	 * and sends back a list of corresponding non duplicate EE_Attendee objects.
+	 *
+	 * @since  4.3.0
+	 * @param  array $ids array of EE_Registration ids
+	 * @return EE_Attendee[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_array_of_contacts_from_reg_ids($ids)
+	{
+		$ids = (array) $ids;
+		$_where = array(
+			'Registration.REG_ID' => array('in', $ids),
+		);
+		return $this->get_all(array($_where));
+	}
 }

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

Doc Comments +1 added lines, -1 removed lines

@@ -456,7 +456,7 @@
      * be empty
      *
      * @since 4.3.1
-     * @return array
+     * @return string[]
      */
     private function _parse_from()
     {

Spacing +9 added lines, -9 removed lines

@@ -56,7 +56,7 @@ 
             ),
             '<code>wp_mail</code>'
         );
-        $this->label               = array(
+        $this->label = array(
             'singular' => esc_html__('email', 'event_espresso'),
             'plural'   => esc_html__('emails', 'event_espresso'),
         );
@@ -438,7 +438,7 @@ 
             $this->_body(),
             $this->_headers()
         );
-        if (! $success) {
+        if ( ! $success) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -482,8 +482,8 @@ 
         $this->_ensure_has_from_email_address();
         $from    = $this->_from;
         $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
+            'From:'.$from,
+            'Reply-To:'.$from,
             'Content-Type:text/html; charset=utf-8',
         );
 
@@ -492,8 +492,8 @@ 
          * cover back compat where there may be users who have saved cc values in their db for the newsletter message
          * type which they are no longer able to change.
          */
-        if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
-            $headers[] = 'cc: ' . $this->_cc;
+        if ( ! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
+            $headers[] = 'cc: '.$this->_cc;
         }
 
         // but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
@@ -600,7 +600,7 @@ 
             'from'      => $this->_from,
             'main_body' => wpautop($this->_content),
         );
-        $body                 = $this->_get_main_template($preview);
+        $body = $this->_get_main_template($preview);
 
         /**
          * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
@@ -610,10 +610,10 @@ 
          */
         if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
             // require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+            require_once EE_THIRD_PARTY.'cssinliner/vendor/autoload.php';
 
             // now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
+            if ( ! $preview || ($preview && defined('DOING_AJAX'))) {
                 $style = file_get_contents(
                     $this->get_variation(
                         $this->_tmp_pack,

Indentation +644 added lines, -644 removed lines

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

core/domain/services/event/EventSpacesCalculator.php

Doc Comments +1 added lines, -1 removed lines

@@ -164,7 +164,7 @@
 
 
     /**
-     * @param $ticket
+     * @param \EE_Base_Class $ticket
      * @throws DomainException
      * @throws EE_Error
      * @throws UnexpectedEntityException

Spacing +46 added lines, -46 removed lines

@@ -174,14 +174,14 @@ 
      */
     public function setActiveTickets(array $active_tickets = array())
     {
-        if (! empty($active_tickets)) {
+        if ( ! empty($active_tickets)) {
             foreach ($active_tickets as $active_ticket) {
                 $this->validateTicket($active_ticket);
             }
             // sort incoming array by ticket quantity (asc)
             usort(
                 $active_tickets,
-                function (EE_Ticket $a, EE_Ticket $b) {
+                function(EE_Ticket $a, EE_Ticket $b) {
                     if ($a->qty() === $b->qty()) {
                         return 0;
                     }
@@ -203,7 +203,7 @@ 
      */
     private function validateTicket($ticket)
     {
-        if (! $ticket instanceof EE_Ticket) {
+        if ( ! $ticket instanceof EE_Ticket) {
             throw new DomainException(
                 esc_html__(
                     'Invalid Ticket. Only EE_Ticket objects can be used to calculate event space availability.',
@@ -254,7 +254,7 @@ 
                 )
             );
         }
-        $this->datetimes[ $datetime->ID() ] = $datetime;
+        $this->datetimes[$datetime->ID()] = $datetime;
     }
 
 
@@ -327,7 +327,7 @@ 
         $this->tickets_sold = array();
         $this->total_spaces = array();
         $active_tickets = $this->getActiveTickets();
-        if (! empty($active_tickets)) {
+        if ( ! empty($active_tickets)) {
             foreach ($active_tickets as $ticket) {
                 $this->validateTicket($ticket);
                 // we need to index our data arrays using strings for the purpose of sorting,
@@ -349,16 +349,16 @@ 
                     // we are going to move all of our data into the following arrays:
                     // datetime spaces initially represents the reg limit for each datetime,
                     // but this will get adjusted as tickets are accounted for
-                    $this->datetime_spaces[ $datetime_identifier ] = $reg_limit;
+                    $this->datetime_spaces[$datetime_identifier] = $reg_limit;
                     // just an array of ticket IDs grouped by datetime
-                    $this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier;
+                    $this->datetime_tickets[$datetime_identifier][] = $ticket_identifier;
                     // and an array of datetime IDs grouped by ticket
-                    $this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier;
+                    $this->ticket_datetimes[$ticket_identifier][] = $datetime_identifier;
                 }
                 // total quantity of sold and reserved for each ticket
-                $this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved();
+                $this->tickets_sold[$ticket_identifier] = $ticket->sold() + $ticket->reserved();
                 // and the maximum ticket quantities for each ticket (adjusted for reg limit)
-                $this->ticket_quantities[ $ticket_identifier ] = $max_tickets;
+                $this->ticket_quantities[$ticket_identifier] = $max_tickets;
             }
         }
         // sort datetime spaces by reg limit, but maintain our string indexes
@@ -417,11 +417,11 @@ 
             \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
         }
         foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) {
-            if (isset($this->ticket_quantities[ $ticket_identifier ])) {
-                $this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold;
+            if (isset($this->ticket_quantities[$ticket_identifier])) {
+                $this->ticket_quantities[$ticket_identifier] -= $tickets_sold;
                 // don't let values go below zero
-                $this->ticket_quantities[ $ticket_identifier ] = max(
-                    $this->ticket_quantities[ $ticket_identifier ],
+                $this->ticket_quantities[$ticket_identifier] = max(
+                    $this->ticket_quantities[$ticket_identifier],
                     0
                 );
                 if ($this->debug) {
@@ -433,15 +433,15 @@ 
                     );
                 }
             }
-            if (isset($this->ticket_datetimes[ $ticket_identifier ])
-                && is_array($this->ticket_datetimes[ $ticket_identifier ])
+            if (isset($this->ticket_datetimes[$ticket_identifier])
+                && is_array($this->ticket_datetimes[$ticket_identifier])
             ) {
-                foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) {
-                    if (isset($this->ticket_quantities[ $ticket_identifier ])) {
-                        $this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold;
+                foreach ($this->ticket_datetimes[$ticket_identifier] as $ticket_datetime) {
+                    if (isset($this->ticket_quantities[$ticket_identifier])) {
+                        $this->datetime_spaces[$ticket_datetime] -= $tickets_sold;
                         // don't let values go below zero
-                        $this->datetime_spaces[ $ticket_datetime ] = max(
-                            $this->datetime_spaces[ $ticket_datetime ],
+                        $this->datetime_spaces[$ticket_datetime] = max(
+                            $this->datetime_spaces[$ticket_datetime],
                             0
                         );
                         if ($this->debug) {
@@ -466,11 +466,11 @@ 
     private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets)
     {
         // make sure a reg limit is set for the datetime
-        $reg_limit = isset($this->datetime_spaces[ $datetime_identifier ])
-            ? $this->datetime_spaces[ $datetime_identifier ]
+        $reg_limit = isset($this->datetime_spaces[$datetime_identifier])
+            ? $this->datetime_spaces[$datetime_identifier]
             : 0;
         // and bail if it is not
-        if (! $reg_limit) {
+        if ( ! $reg_limit) {
             if ($this->debug) {
                 \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__);
             }
@@ -487,7 +487,7 @@ 
         }
         // number of allocated spaces always starts at zero
         $spaces_allocated = 0;
-        $this->total_spaces[ $datetime_identifier ] = 0;
+        $this->total_spaces[$datetime_identifier] = 0;
         foreach ($tickets as $ticket_identifier) {
             $spaces_allocated = $this->calculateAvailableSpacesForTicket(
                 $datetime_identifier,
@@ -500,7 +500,7 @@ 
         $spaces_allocated = max($spaces_allocated, 0);
         if ($spaces_allocated) {
             // track any non-zero values
-            $this->total_spaces[ $datetime_identifier ] += $spaces_allocated;
+            $this->total_spaces[$datetime_identifier] += $spaces_allocated;
             if ($this->debug) {
                 \EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__);
             }
@@ -511,7 +511,7 @@ 
         }
         if ($this->debug) {
             \EEH_Debug_Tools::printr(
-                $this->total_spaces[ $datetime_identifier ],
+                $this->total_spaces[$datetime_identifier],
                 '$total_spaces',
                 __FILE__,
                 __LINE__
@@ -536,8 +536,8 @@ 
         $spaces_allocated
     ) {
         // make sure ticket quantity is set
-        $ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ])
-            ? $this->ticket_quantities[ $ticket_identifier ]
+        $ticket_quantity = isset($this->ticket_quantities[$ticket_identifier])
+            ? $this->ticket_quantities[$ticket_identifier]
             : 0;
         if ($this->debug) {
             \EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__);
@@ -567,7 +567,7 @@ 
                 //  or the maximum ticket quantity
                 $ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity);
                 // adjust the available quantity in our tracking array
-                $this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity;
+                $this->ticket_quantities[$ticket_identifier] -= $ticket_quantity;
                 // and increment spaces allocated for this datetime
                 $spaces_allocated += $ticket_quantity;
                 $at_capacity = $spaces_allocated >= $reg_limit;
@@ -624,14 +624,14 @@ 
                 $ticket_quantity
             );
             // skip to next ticket if nothing changed
-            if (! ($adjusted || $at_capacity)) {
+            if ( ! ($adjusted || $at_capacity)) {
                 continue;
             }
             // then all of it's tickets are now unavailable
             foreach ($datetime_tickets as $datetime_ticket) {
                 if (($ticket_identifier === $datetime_ticket || $at_capacity)
-                    && isset($this->ticket_quantities[ $datetime_ticket ])
-                    && $this->ticket_quantities[ $datetime_ticket ] > 0
+                    && isset($this->ticket_quantities[$datetime_ticket])
+                    && $this->ticket_quantities[$datetime_ticket] > 0
                 ) {
                     if ($this->debug) {
                         \EEH_Debug_Tools::printr(
@@ -645,14 +645,14 @@ 
                     // otherwise just subtract the ticket quantity
                     $new_quantity = $at_capacity
                         ? 0
-                        : $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity;
+                        : $this->ticket_quantities[$datetime_ticket] - $ticket_quantity;
                     // don't let ticket quantity go below zero
-                    $this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0);
+                    $this->ticket_quantities[$datetime_ticket] = max($new_quantity, 0);
                     if ($this->debug) {
                         \EEH_Debug_Tools::printr(
                             $at_capacity
                                 ? "0 because Datetime {$datetime_identifier} is at capacity"
-                                : "{$this->ticket_quantities[ $datetime_ticket ]}",
+                                : "{$this->ticket_quantities[$datetime_ticket]}",
                             " . . . . {$datetime_ticket} quantity set to ",
                             __FILE__,
                             __LINE__
@@ -661,8 +661,8 @@ 
                 }
                 // but we also need to adjust spaces for any other datetimes this ticket has access to
                 if ($datetime_ticket === $ticket_identifier) {
-                    if (isset($this->ticket_datetimes[ $datetime_ticket ])
-                        && is_array($this->ticket_datetimes[ $datetime_ticket ])
+                    if (isset($this->ticket_datetimes[$datetime_ticket])
+                        && is_array($this->ticket_datetimes[$datetime_ticket])
                     ) {
                         if ($this->debug) {
                             \EEH_Debug_Tools::printr(
@@ -672,7 +672,7 @@ 
                                 __LINE__
                             );
                         }
-                        foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) {
+                        foreach ($this->ticket_datetimes[$datetime_ticket] as $datetime) {
                             // don't adjust the current datetime twice
                             if ($datetime !== $datetime_identifier) {
                                 $this->adjustDatetimeSpaces(
@@ -692,24 +692,24 @@ 
     {
         // does datetime have spaces available?
         // and does the supplied ticket have access to this datetime ?
-        if ($this->datetime_spaces[ $datetime_identifier ] > 0
-            && isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ])
-            && in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true)
+        if ($this->datetime_spaces[$datetime_identifier] > 0
+            && isset($this->datetime_spaces[$datetime_identifier], $this->datetime_tickets[$datetime_identifier])
+            && in_array($ticket_identifier, $this->datetime_tickets[$datetime_identifier], true)
         ) {
             if ($this->debug) {
                 \EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__);
                 \EEH_Debug_Tools::printr(
-                    "{$this->datetime_spaces[ $datetime_identifier ]}",
+                    "{$this->datetime_spaces[$datetime_identifier]}",
                     " . . current  {$datetime_identifier} spaces available",
                     __FILE__,
                     __LINE__
                 );
             }
             // then decrement the available spaces for the datetime
-            $this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity;
+            $this->datetime_spaces[$datetime_identifier] -= $ticket_quantity;
             // but don't let quantities go below zero
-            $this->datetime_spaces[ $datetime_identifier ] = max(
-                $this->datetime_spaces[ $datetime_identifier ],
+            $this->datetime_spaces[$datetime_identifier] = max(
+                $this->datetime_spaces[$datetime_identifier],
                 0
             );
             if ($this->debug) {

Indentation +711 added lines, -711 removed lines

@@ -26,715 +26,715 @@
 class EventSpacesCalculator
 {
 
-    /**
-     * @var EE_Event $event
-     */
-    private $event;
-
-    /**
-     * @var array $datetime_query_params
-     */
-    private $datetime_query_params;
-
-    /**
-     * @var EE_Ticket[] $active_tickets
-     */
-    private $active_tickets = array();
-
-    /**
-     * @var EE_Datetime[] $datetimes
-     */
-    private $datetimes = array();
-
-    /**
-     * Array of Ticket IDs grouped by Datetime
-     *
-     * @var array $datetimes
-     */
-    private $datetime_tickets = array();
-
-    /**
-     * Max spaces for each Datetime (reg limit - previous sold)
-     *
-     * @var array $datetime_spaces
-     */
-    private $datetime_spaces = array();
-
-    /**
-     * Array of Datetime IDs grouped by Ticket
-     *
-     * @var array[] $ticket_datetimes
-     */
-    private $ticket_datetimes = array();
-
-    /**
-     * maximum ticket quantities for each ticket (adjusted for reg limit)
-     *
-     * @var array $ticket_quantities
-     */
-    private $ticket_quantities = array();
-
-    /**
-     * total quantity of sold and reserved for each ticket
-     *
-     * @var array $tickets_sold
-     */
-    private $tickets_sold = array();
-
-    /**
-     * total spaces available across all datetimes
-     *
-     * @var array $total_spaces
-     */
-    private $total_spaces = array();
-
-    /**
-     * @var boolean $debug
-     */
-    private $debug = false; // true false
-
-    /**
-     * @var null|int $spaces_remaining
-     */
-    private $spaces_remaining;
-
-    /**
-     * @var null|int $total_spaces_available
-     */
-    private $total_spaces_available;
-
-
-    /**
-     * EventSpacesCalculator constructor.
-     *
-     * @param EE_Event $event
-     * @param array    $datetime_query_params
-     * @throws EE_Error
-     */
-    public function __construct(EE_Event $event, array $datetime_query_params = array())
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1);
-            \EEH_Debug_Tools::printr((string) $event->ID(), 'For event', __FILE__, __LINE__);
-        }
-        $this->event = $event;
-        $this->datetime_query_params = $datetime_query_params + array('order_by' => array('DTT_reg_limit' => 'ASC'));
-        $this->setHooks();
-    }
-
-
-    /**
-     * @return void
-     */
-    private function setHooks()
-    {
-        add_action('AHEE__EE_Ticket__increase_sold', array($this, 'clearResults'));
-        add_action('AHEE__EE_Ticket__decrease_sold', array($this, 'clearResults'));
-        add_action('AHEE__EE_Datetime__increase_sold', array($this, 'clearResults'));
-        add_action('AHEE__EE_Datetime__decrease_sold', array($this, 'clearResults'));
-        add_action('AHEE__EE_Ticket__increase_reserved', array($this, 'clearResults'));
-        add_action('AHEE__EE_Ticket__decrease_reserved', array($this, 'clearResults'));
-        add_action('AHEE__EE_Datetime__increase_reserved', array($this, 'clearResults'));
-        add_action('AHEE__EE_Datetime__decrease_reserved', array($this, 'clearResults'));
-    }
-
-
-    /**
-     * @return void
-     */
-    public function clearResults()
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1);
-        }
-        $this->spaces_remaining = null;
-        $this->total_spaces_available = null;
-    }
-
-
-    /**
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function getActiveTickets()
-    {
-        if (empty($this->active_tickets)) {
-            $this->active_tickets = $this->event->tickets(
-                array(
-                    array('TKT_deleted' => false),
-                    'order_by' => array('TKT_qty' => 'ASC'),
-                )
-            );
-        }
-        return $this->active_tickets;
-    }
-
-
-    /**
-     * @param EE_Ticket[] $active_tickets
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function setActiveTickets(array $active_tickets = array())
-    {
-        if (! empty($active_tickets)) {
-            foreach ($active_tickets as $active_ticket) {
-                $this->validateTicket($active_ticket);
-            }
-            // sort incoming array by ticket quantity (asc)
-            usort(
-                $active_tickets,
-                function (EE_Ticket $a, EE_Ticket $b) {
-                    if ($a->qty() === $b->qty()) {
-                        return 0;
-                    }
-                    return ($a->qty() < $b->qty())
-                        ? -1
-                        : 1;
-                }
-            );
-        }
-        $this->active_tickets = $active_tickets;
-    }
-
-
-    /**
-     * @param $ticket
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws UnexpectedEntityException
-     */
-    private function validateTicket($ticket)
-    {
-        if (! $ticket instanceof EE_Ticket) {
-            throw new DomainException(
-                esc_html__(
-                    'Invalid Ticket. Only EE_Ticket objects can be used to calculate event space availability.',
-                    'event_espresso'
-                )
-            );
-        }
-        if ($ticket->get_event_ID() !== $this->event->ID()) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'An EE_Ticket for Event %1$d was supplied while calculating event space availability for Event %2$d.',
-                        'event_espresso'
-                    ),
-                    $ticket->get_event_ID(),
-                    $this->event->ID()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return EE_Datetime[]
-     */
-    public function getDatetimes()
-    {
-        return $this->datetimes;
-    }
-
-
-    /**
-     * @param EE_Datetime $datetime
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function setDatetime(EE_Datetime $datetime)
-    {
-        if ($datetime->event()->ID() !== $this->event->ID()) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'An EE_Datetime for Event %1$d was supplied while calculating event space availability for Event %2$d.',
-                        'event_espresso'
-                    ),
-                    $datetime->event()->ID(),
-                    $this->event->ID()
-                )
-            );
-        }
-        $this->datetimes[ $datetime->ID() ] = $datetime;
-    }
-
-
-    /**
-     * calculate spaces remaining based on "saleable" tickets
-     *
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function spacesRemaining()
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
-        }
-        if ($this->spaces_remaining === null) {
-            $this->initialize();
-            $this->spaces_remaining = $this->calculate();
-        }
-        return $this->spaces_remaining;
-    }
-
-
-    /**
-     * calculates total available spaces for an event with no regard for sold tickets
-     *
-     * @return int|float
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function totalSpacesAvailable()
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
-        }
-        if ($this->total_spaces_available === null) {
-            $this->initialize();
-            $this->total_spaces_available = $this->calculate(false);
-        }
-        return $this->total_spaces_available;
-    }
-
-
-    /**
-     * Loops through the active tickets for the event
-     * and builds a series of data arrays that will be used for calculating
-     * the total maximum available spaces, as well as the spaces remaining.
-     * Because ticket quantities affect datetime spaces and vice versa,
-     * we need to be constantly updating these data arrays as things change,
-     * which is the entire reason for their existence.
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function initialize()
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
-        }
-        $this->datetime_tickets = array();
-        $this->datetime_spaces = array();
-        $this->ticket_datetimes = array();
-        $this->ticket_quantities = array();
-        $this->tickets_sold = array();
-        $this->total_spaces = array();
-        $active_tickets = $this->getActiveTickets();
-        if (! empty($active_tickets)) {
-            foreach ($active_tickets as $ticket) {
-                $this->validateTicket($ticket);
-                // we need to index our data arrays using strings for the purpose of sorting,
-                // but we also need them to be unique, so  we'll just prepend a letter T to the ID
-                $ticket_identifier = "T{$ticket->ID()}";
-                // to start, we'll just consider the raw qty to be the maximum availability for this ticket,
-                // unless the ticket is past its "sell until" date, in which case the qty will be 0
-                $max_tickets = $ticket->is_expired() ? 0 : $ticket->qty();
-                // but we'll adjust that after looping over each datetime for the ticket and checking reg limits
-                $ticket_datetimes = $ticket->datetimes($this->datetime_query_params);
-                foreach ($ticket_datetimes as $datetime) {
-                    // save all datetimes
-                    $this->setDatetime($datetime);
-                    $datetime_identifier = "D{$datetime->ID()}";
-                    $reg_limit = $datetime->reg_limit();
-                    // ticket quantity can not exceed datetime reg limit
-                    $max_tickets = min($max_tickets, $reg_limit);
-                    // as described earlier, because we need to be able to constantly adjust numbers for things,
-                    // we are going to move all of our data into the following arrays:
-                    // datetime spaces initially represents the reg limit for each datetime,
-                    // but this will get adjusted as tickets are accounted for
-                    $this->datetime_spaces[ $datetime_identifier ] = $reg_limit;
-                    // just an array of ticket IDs grouped by datetime
-                    $this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier;
-                    // and an array of datetime IDs grouped by ticket
-                    $this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier;
-                }
-                // total quantity of sold and reserved for each ticket
-                $this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved();
-                // and the maximum ticket quantities for each ticket (adjusted for reg limit)
-                $this->ticket_quantities[ $ticket_identifier ] = $max_tickets;
-            }
-        }
-        // sort datetime spaces by reg limit, but maintain our string indexes
-        asort($this->datetime_spaces, SORT_NUMERIC);
-        // datetime tickets need to be sorted in the SAME order as the above array...
-        // so we'll just use array_merge() to take the structure of datetime_spaces
-        // but overwrite all of the data with that from datetime_tickets
-        $this->datetime_tickets = array_merge(
-            $this->datetime_spaces,
-            $this->datetime_tickets
-        );
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr($this->datetime_tickets, 'datetime_tickets', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr($this->ticket_quantities, 'ticket_quantities', __FILE__, __LINE__);
-        }
-    }
-
-
-    /**
-     * performs calculations on initialized data
-     *
-     * @param bool $consider_sold
-     * @return int|float
-     */
-    private function calculate($consider_sold = true)
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
-            \EEH_Debug_Tools::printr($consider_sold, '$consider_sold', __FILE__, __LINE__);
-        }
-        if ($consider_sold) {
-            // subtract amounts sold from all ticket quantities and datetime spaces
-            $this->adjustTicketQuantitiesDueToSales();
-        }
-        foreach ($this->datetime_tickets as $datetime_identifier => $tickets) {
-            $this->trackAvailableSpacesForDatetimes($datetime_identifier, $tickets);
-        }
-        // total spaces available is just the sum of the spaces available for each datetime
-        $spaces_remaining = array_sum($this->total_spaces);
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr($this->total_spaces, '$this->total_spaces', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr($this->tickets_sold, '$this->tickets_sold', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr($spaces_remaining, '$spaces_remaining', __FILE__, __LINE__);
-        }
-        return $spaces_remaining;
-    }
-
-
-    /**
-     * subtracts amount of  tickets sold from ticket quantities and datetime spaces
-     */
-    private function adjustTicketQuantitiesDueToSales()
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
-        }
-        foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) {
-            if (isset($this->ticket_quantities[ $ticket_identifier ])) {
-                $this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold;
-                // don't let values go below zero
-                $this->ticket_quantities[ $ticket_identifier ] = max(
-                    $this->ticket_quantities[ $ticket_identifier ],
-                    0
-                );
-                if ($this->debug) {
-                    \EEH_Debug_Tools::printr(
-                        "{$tickets_sold} sales for ticket {$ticket_identifier} ",
-                        'subtracting',
-                        __FILE__,
-                        __LINE__
-                    );
-                }
-            }
-            if (isset($this->ticket_datetimes[ $ticket_identifier ])
-                && is_array($this->ticket_datetimes[ $ticket_identifier ])
-            ) {
-                foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) {
-                    if (isset($this->ticket_quantities[ $ticket_identifier ])) {
-                        $this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold;
-                        // don't let values go below zero
-                        $this->datetime_spaces[ $ticket_datetime ] = max(
-                            $this->datetime_spaces[ $ticket_datetime ],
-                            0
-                        );
-                        if ($this->debug) {
-                            \EEH_Debug_Tools::printr(
-                                "{$tickets_sold} sales for datetime {$ticket_datetime} ",
-                                'subtracting',
-                                __FILE__,
-                                __LINE__
-                            );
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param string $datetime_identifier
-     * @param array  $tickets
-     */
-    private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets)
-    {
-        // make sure a reg limit is set for the datetime
-        $reg_limit = isset($this->datetime_spaces[ $datetime_identifier ])
-            ? $this->datetime_spaces[ $datetime_identifier ]
-            : 0;
-        // and bail if it is not
-        if (! $reg_limit) {
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__);
-            }
-            return;
-        }
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr($datetime_identifier, '* $datetime_identifier', __FILE__, __LINE__, 1);
-            \EEH_Debug_Tools::printr(
-                "{$reg_limit}",
-                'REG LIMIT',
-                __FILE__,
-                __LINE__
-            );
-        }
-        // number of allocated spaces always starts at zero
-        $spaces_allocated = 0;
-        $this->total_spaces[ $datetime_identifier ] = 0;
-        foreach ($tickets as $ticket_identifier) {
-            $spaces_allocated = $this->calculateAvailableSpacesForTicket(
-                $datetime_identifier,
-                $reg_limit,
-                $ticket_identifier,
-                $spaces_allocated
-            );
-        }
-        // spaces can't be negative
-        $spaces_allocated = max($spaces_allocated, 0);
-        if ($spaces_allocated) {
-            // track any non-zero values
-            $this->total_spaces[ $datetime_identifier ] += $spaces_allocated;
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__);
-            }
-        } else {
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr(' ', ' . NO TICKETS AVAILABLE FOR DATETIME', __FILE__, __LINE__);
-            }
-        }
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(
-                $this->total_spaces[ $datetime_identifier ],
-                '$total_spaces',
-                __FILE__,
-                __LINE__
-            );
-            \EEH_Debug_Tools::printr($this->ticket_quantities, '$ticket_quantities', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__);
-        }
-    }
-
-
-    /**
-     * @param string $datetime_identifier
-     * @param int    $reg_limit
-     * @param string $ticket_identifier
-     * @param int    $spaces_allocated
-     * @return int
-     */
-    private function calculateAvailableSpacesForTicket(
-        $datetime_identifier,
-        $reg_limit,
-        $ticket_identifier,
-        $spaces_allocated
-    ) {
-        // make sure ticket quantity is set
-        $ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ])
-            ? $this->ticket_quantities[ $ticket_identifier ]
-            : 0;
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr(
-                "{$ticket_quantity}",
-                "ticket $ticket_identifier quantity: ",
-                __FILE__,
-                __LINE__,
-                2
-            );
-        }
-        if ($ticket_quantity) {
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr(
-                    ($spaces_allocated <= $reg_limit)
-                        ? 'true'
-                        : 'false',
-                    ' . spaces_allocated <= reg_limit = ',
-                    __FILE__,
-                    __LINE__
-                );
-            }
-            // if the datetime is NOT at full capacity yet
-            if ($spaces_allocated <= $reg_limit) {
-                // then the maximum ticket quantity we can allocate is the lowest value of either:
-                //  the number of remaining spaces for the datetime, which is the limit - spaces already taken
-                //  or the maximum ticket quantity
-                $ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity);
-                // adjust the available quantity in our tracking array
-                $this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity;
-                // and increment spaces allocated for this datetime
-                $spaces_allocated += $ticket_quantity;
-                $at_capacity = $spaces_allocated >= $reg_limit;
-                if ($this->debug) {
-                    \EEH_Debug_Tools::printr(
-                        "{$ticket_quantity} {$ticket_identifier} tickets",
-                        ' > > allocate ',
-                        __FILE__,
-                        __LINE__,
-                        3
-                    );
-                    if ($at_capacity) {
-                        \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__, 3);
-                    }
-                }
-                // now adjust all other datetimes that allow access to this ticket
-                $this->adjustDatetimes(
-                    $datetime_identifier,
-                    $ticket_identifier,
-                    $ticket_quantity,
-                    $at_capacity
-                );
-            }
-        }
-        return $spaces_allocated;
-    }
-
-
-    /**
-     * subtracts ticket amounts from all datetime reg limits
-     * that allow access to the ticket specified,
-     * because that ticket could be used
-     * to attend any of the datetimes it has access to
-     *
-     * @param string $datetime_identifier
-     * @param string $ticket_identifier
-     * @param bool   $at_capacity
-     * @param int    $ticket_quantity
-     */
-    private function adjustDatetimes(
-        $datetime_identifier,
-        $ticket_identifier,
-        $ticket_quantity,
-        $at_capacity
-    ) {
-        /** @var array $datetime_tickets */
-        foreach ($this->datetime_tickets as $datetime_ID => $datetime_tickets) {
-            if ($datetime_ID !== $datetime_identifier || ! is_array($datetime_tickets)) {
-                continue;
-            }
-            $adjusted = $this->adjustDatetimeSpaces(
-                $datetime_ID,
-                $ticket_identifier,
-                $ticket_quantity
-            );
-            // skip to next ticket if nothing changed
-            if (! ($adjusted || $at_capacity)) {
-                continue;
-            }
-            // then all of it's tickets are now unavailable
-            foreach ($datetime_tickets as $datetime_ticket) {
-                if (($ticket_identifier === $datetime_ticket || $at_capacity)
-                    && isset($this->ticket_quantities[ $datetime_ticket ])
-                    && $this->ticket_quantities[ $datetime_ticket ] > 0
-                ) {
-                    if ($this->debug) {
-                        \EEH_Debug_Tools::printr(
-                            $datetime_ticket,
-                            ' . . . adjust ticket quantities for',
-                            __FILE__,
-                            __LINE__
-                        );
-                    }
-                    // if this datetime is at full capacity, set any tracked available quantities to zero
-                    // otherwise just subtract the ticket quantity
-                    $new_quantity = $at_capacity
-                        ? 0
-                        : $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity;
-                    // don't let ticket quantity go below zero
-                    $this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0);
-                    if ($this->debug) {
-                        \EEH_Debug_Tools::printr(
-                            $at_capacity
-                                ? "0 because Datetime {$datetime_identifier} is at capacity"
-                                : "{$this->ticket_quantities[ $datetime_ticket ]}",
-                            " . . . . {$datetime_ticket} quantity set to ",
-                            __FILE__,
-                            __LINE__
-                        );
-                    }
-                }
-                // but we also need to adjust spaces for any other datetimes this ticket has access to
-                if ($datetime_ticket === $ticket_identifier) {
-                    if (isset($this->ticket_datetimes[ $datetime_ticket ])
-                        && is_array($this->ticket_datetimes[ $datetime_ticket ])
-                    ) {
-                        if ($this->debug) {
-                            \EEH_Debug_Tools::printr(
-                                $datetime_ticket,
-                                ' . . adjust other Datetimes for',
-                                __FILE__,
-                                __LINE__
-                            );
-                        }
-                        foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) {
-                            // don't adjust the current datetime twice
-                            if ($datetime !== $datetime_identifier) {
-                                $this->adjustDatetimeSpaces(
-                                    $datetime,
-                                    $datetime_ticket,
-                                    $ticket_quantity
-                                );
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-    private function adjustDatetimeSpaces($datetime_identifier, $ticket_identifier, $ticket_quantity = 0)
-    {
-        // does datetime have spaces available?
-        // and does the supplied ticket have access to this datetime ?
-        if ($this->datetime_spaces[ $datetime_identifier ] > 0
-            && isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ])
-            && in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true)
-        ) {
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__);
-                \EEH_Debug_Tools::printr(
-                    "{$this->datetime_spaces[ $datetime_identifier ]}",
-                    " . . current  {$datetime_identifier} spaces available",
-                    __FILE__,
-                    __LINE__
-                );
-            }
-            // then decrement the available spaces for the datetime
-            $this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity;
-            // but don't let quantities go below zero
-            $this->datetime_spaces[ $datetime_identifier ] = max(
-                $this->datetime_spaces[ $datetime_identifier ],
-                0
-            );
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr(
-                    "{$ticket_quantity}",
-                    " . . . {$datetime_identifier} capacity reduced by",
-                    __FILE__,
-                    __LINE__
-                );
-            }
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * @var EE_Event $event
+	 */
+	private $event;
+
+	/**
+	 * @var array $datetime_query_params
+	 */
+	private $datetime_query_params;
+
+	/**
+	 * @var EE_Ticket[] $active_tickets
+	 */
+	private $active_tickets = array();
+
+	/**
+	 * @var EE_Datetime[] $datetimes
+	 */
+	private $datetimes = array();
+
+	/**
+	 * Array of Ticket IDs grouped by Datetime
+	 *
+	 * @var array $datetimes
+	 */
+	private $datetime_tickets = array();
+
+	/**
+	 * Max spaces for each Datetime (reg limit - previous sold)
+	 *
+	 * @var array $datetime_spaces
+	 */
+	private $datetime_spaces = array();
+
+	/**
+	 * Array of Datetime IDs grouped by Ticket
+	 *
+	 * @var array[] $ticket_datetimes
+	 */
+	private $ticket_datetimes = array();
+
+	/**
+	 * maximum ticket quantities for each ticket (adjusted for reg limit)
+	 *
+	 * @var array $ticket_quantities
+	 */
+	private $ticket_quantities = array();
+
+	/**
+	 * total quantity of sold and reserved for each ticket
+	 *
+	 * @var array $tickets_sold
+	 */
+	private $tickets_sold = array();
+
+	/**
+	 * total spaces available across all datetimes
+	 *
+	 * @var array $total_spaces
+	 */
+	private $total_spaces = array();
+
+	/**
+	 * @var boolean $debug
+	 */
+	private $debug = false; // true false
+
+	/**
+	 * @var null|int $spaces_remaining
+	 */
+	private $spaces_remaining;
+
+	/**
+	 * @var null|int $total_spaces_available
+	 */
+	private $total_spaces_available;
+
+
+	/**
+	 * EventSpacesCalculator constructor.
+	 *
+	 * @param EE_Event $event
+	 * @param array    $datetime_query_params
+	 * @throws EE_Error
+	 */
+	public function __construct(EE_Event $event, array $datetime_query_params = array())
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1);
+			\EEH_Debug_Tools::printr((string) $event->ID(), 'For event', __FILE__, __LINE__);
+		}
+		$this->event = $event;
+		$this->datetime_query_params = $datetime_query_params + array('order_by' => array('DTT_reg_limit' => 'ASC'));
+		$this->setHooks();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function setHooks()
+	{
+		add_action('AHEE__EE_Ticket__increase_sold', array($this, 'clearResults'));
+		add_action('AHEE__EE_Ticket__decrease_sold', array($this, 'clearResults'));
+		add_action('AHEE__EE_Datetime__increase_sold', array($this, 'clearResults'));
+		add_action('AHEE__EE_Datetime__decrease_sold', array($this, 'clearResults'));
+		add_action('AHEE__EE_Ticket__increase_reserved', array($this, 'clearResults'));
+		add_action('AHEE__EE_Ticket__decrease_reserved', array($this, 'clearResults'));
+		add_action('AHEE__EE_Datetime__increase_reserved', array($this, 'clearResults'));
+		add_action('AHEE__EE_Datetime__decrease_reserved', array($this, 'clearResults'));
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function clearResults()
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1);
+		}
+		$this->spaces_remaining = null;
+		$this->total_spaces_available = null;
+	}
+
+
+	/**
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function getActiveTickets()
+	{
+		if (empty($this->active_tickets)) {
+			$this->active_tickets = $this->event->tickets(
+				array(
+					array('TKT_deleted' => false),
+					'order_by' => array('TKT_qty' => 'ASC'),
+				)
+			);
+		}
+		return $this->active_tickets;
+	}
+
+
+	/**
+	 * @param EE_Ticket[] $active_tickets
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function setActiveTickets(array $active_tickets = array())
+	{
+		if (! empty($active_tickets)) {
+			foreach ($active_tickets as $active_ticket) {
+				$this->validateTicket($active_ticket);
+			}
+			// sort incoming array by ticket quantity (asc)
+			usort(
+				$active_tickets,
+				function (EE_Ticket $a, EE_Ticket $b) {
+					if ($a->qty() === $b->qty()) {
+						return 0;
+					}
+					return ($a->qty() < $b->qty())
+						? -1
+						: 1;
+				}
+			);
+		}
+		$this->active_tickets = $active_tickets;
+	}
+
+
+	/**
+	 * @param $ticket
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws UnexpectedEntityException
+	 */
+	private function validateTicket($ticket)
+	{
+		if (! $ticket instanceof EE_Ticket) {
+			throw new DomainException(
+				esc_html__(
+					'Invalid Ticket. Only EE_Ticket objects can be used to calculate event space availability.',
+					'event_espresso'
+				)
+			);
+		}
+		if ($ticket->get_event_ID() !== $this->event->ID()) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'An EE_Ticket for Event %1$d was supplied while calculating event space availability for Event %2$d.',
+						'event_espresso'
+					),
+					$ticket->get_event_ID(),
+					$this->event->ID()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return EE_Datetime[]
+	 */
+	public function getDatetimes()
+	{
+		return $this->datetimes;
+	}
+
+
+	/**
+	 * @param EE_Datetime $datetime
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function setDatetime(EE_Datetime $datetime)
+	{
+		if ($datetime->event()->ID() !== $this->event->ID()) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'An EE_Datetime for Event %1$d was supplied while calculating event space availability for Event %2$d.',
+						'event_espresso'
+					),
+					$datetime->event()->ID(),
+					$this->event->ID()
+				)
+			);
+		}
+		$this->datetimes[ $datetime->ID() ] = $datetime;
+	}
+
+
+	/**
+	 * calculate spaces remaining based on "saleable" tickets
+	 *
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function spacesRemaining()
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
+		}
+		if ($this->spaces_remaining === null) {
+			$this->initialize();
+			$this->spaces_remaining = $this->calculate();
+		}
+		return $this->spaces_remaining;
+	}
+
+
+	/**
+	 * calculates total available spaces for an event with no regard for sold tickets
+	 *
+	 * @return int|float
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function totalSpacesAvailable()
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
+		}
+		if ($this->total_spaces_available === null) {
+			$this->initialize();
+			$this->total_spaces_available = $this->calculate(false);
+		}
+		return $this->total_spaces_available;
+	}
+
+
+	/**
+	 * Loops through the active tickets for the event
+	 * and builds a series of data arrays that will be used for calculating
+	 * the total maximum available spaces, as well as the spaces remaining.
+	 * Because ticket quantities affect datetime spaces and vice versa,
+	 * we need to be constantly updating these data arrays as things change,
+	 * which is the entire reason for their existence.
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function initialize()
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
+		}
+		$this->datetime_tickets = array();
+		$this->datetime_spaces = array();
+		$this->ticket_datetimes = array();
+		$this->ticket_quantities = array();
+		$this->tickets_sold = array();
+		$this->total_spaces = array();
+		$active_tickets = $this->getActiveTickets();
+		if (! empty($active_tickets)) {
+			foreach ($active_tickets as $ticket) {
+				$this->validateTicket($ticket);
+				// we need to index our data arrays using strings for the purpose of sorting,
+				// but we also need them to be unique, so  we'll just prepend a letter T to the ID
+				$ticket_identifier = "T{$ticket->ID()}";
+				// to start, we'll just consider the raw qty to be the maximum availability for this ticket,
+				// unless the ticket is past its "sell until" date, in which case the qty will be 0
+				$max_tickets = $ticket->is_expired() ? 0 : $ticket->qty();
+				// but we'll adjust that after looping over each datetime for the ticket and checking reg limits
+				$ticket_datetimes = $ticket->datetimes($this->datetime_query_params);
+				foreach ($ticket_datetimes as $datetime) {
+					// save all datetimes
+					$this->setDatetime($datetime);
+					$datetime_identifier = "D{$datetime->ID()}";
+					$reg_limit = $datetime->reg_limit();
+					// ticket quantity can not exceed datetime reg limit
+					$max_tickets = min($max_tickets, $reg_limit);
+					// as described earlier, because we need to be able to constantly adjust numbers for things,
+					// we are going to move all of our data into the following arrays:
+					// datetime spaces initially represents the reg limit for each datetime,
+					// but this will get adjusted as tickets are accounted for
+					$this->datetime_spaces[ $datetime_identifier ] = $reg_limit;
+					// just an array of ticket IDs grouped by datetime
+					$this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier;
+					// and an array of datetime IDs grouped by ticket
+					$this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier;
+				}
+				// total quantity of sold and reserved for each ticket
+				$this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved();
+				// and the maximum ticket quantities for each ticket (adjusted for reg limit)
+				$this->ticket_quantities[ $ticket_identifier ] = $max_tickets;
+			}
+		}
+		// sort datetime spaces by reg limit, but maintain our string indexes
+		asort($this->datetime_spaces, SORT_NUMERIC);
+		// datetime tickets need to be sorted in the SAME order as the above array...
+		// so we'll just use array_merge() to take the structure of datetime_spaces
+		// but overwrite all of the data with that from datetime_tickets
+		$this->datetime_tickets = array_merge(
+			$this->datetime_spaces,
+			$this->datetime_tickets
+		);
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr($this->datetime_tickets, 'datetime_tickets', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr($this->ticket_quantities, 'ticket_quantities', __FILE__, __LINE__);
+		}
+	}
+
+
+	/**
+	 * performs calculations on initialized data
+	 *
+	 * @param bool $consider_sold
+	 * @return int|float
+	 */
+	private function calculate($consider_sold = true)
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
+			\EEH_Debug_Tools::printr($consider_sold, '$consider_sold', __FILE__, __LINE__);
+		}
+		if ($consider_sold) {
+			// subtract amounts sold from all ticket quantities and datetime spaces
+			$this->adjustTicketQuantitiesDueToSales();
+		}
+		foreach ($this->datetime_tickets as $datetime_identifier => $tickets) {
+			$this->trackAvailableSpacesForDatetimes($datetime_identifier, $tickets);
+		}
+		// total spaces available is just the sum of the spaces available for each datetime
+		$spaces_remaining = array_sum($this->total_spaces);
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr($this->total_spaces, '$this->total_spaces', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr($this->tickets_sold, '$this->tickets_sold', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr($spaces_remaining, '$spaces_remaining', __FILE__, __LINE__);
+		}
+		return $spaces_remaining;
+	}
+
+
+	/**
+	 * subtracts amount of  tickets sold from ticket quantities and datetime spaces
+	 */
+	private function adjustTicketQuantitiesDueToSales()
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
+		}
+		foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) {
+			if (isset($this->ticket_quantities[ $ticket_identifier ])) {
+				$this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold;
+				// don't let values go below zero
+				$this->ticket_quantities[ $ticket_identifier ] = max(
+					$this->ticket_quantities[ $ticket_identifier ],
+					0
+				);
+				if ($this->debug) {
+					\EEH_Debug_Tools::printr(
+						"{$tickets_sold} sales for ticket {$ticket_identifier} ",
+						'subtracting',
+						__FILE__,
+						__LINE__
+					);
+				}
+			}
+			if (isset($this->ticket_datetimes[ $ticket_identifier ])
+				&& is_array($this->ticket_datetimes[ $ticket_identifier ])
+			) {
+				foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) {
+					if (isset($this->ticket_quantities[ $ticket_identifier ])) {
+						$this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold;
+						// don't let values go below zero
+						$this->datetime_spaces[ $ticket_datetime ] = max(
+							$this->datetime_spaces[ $ticket_datetime ],
+							0
+						);
+						if ($this->debug) {
+							\EEH_Debug_Tools::printr(
+								"{$tickets_sold} sales for datetime {$ticket_datetime} ",
+								'subtracting',
+								__FILE__,
+								__LINE__
+							);
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $datetime_identifier
+	 * @param array  $tickets
+	 */
+	private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets)
+	{
+		// make sure a reg limit is set for the datetime
+		$reg_limit = isset($this->datetime_spaces[ $datetime_identifier ])
+			? $this->datetime_spaces[ $datetime_identifier ]
+			: 0;
+		// and bail if it is not
+		if (! $reg_limit) {
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__);
+			}
+			return;
+		}
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr($datetime_identifier, '* $datetime_identifier', __FILE__, __LINE__, 1);
+			\EEH_Debug_Tools::printr(
+				"{$reg_limit}",
+				'REG LIMIT',
+				__FILE__,
+				__LINE__
+			);
+		}
+		// number of allocated spaces always starts at zero
+		$spaces_allocated = 0;
+		$this->total_spaces[ $datetime_identifier ] = 0;
+		foreach ($tickets as $ticket_identifier) {
+			$spaces_allocated = $this->calculateAvailableSpacesForTicket(
+				$datetime_identifier,
+				$reg_limit,
+				$ticket_identifier,
+				$spaces_allocated
+			);
+		}
+		// spaces can't be negative
+		$spaces_allocated = max($spaces_allocated, 0);
+		if ($spaces_allocated) {
+			// track any non-zero values
+			$this->total_spaces[ $datetime_identifier ] += $spaces_allocated;
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__);
+			}
+		} else {
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr(' ', ' . NO TICKETS AVAILABLE FOR DATETIME', __FILE__, __LINE__);
+			}
+		}
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(
+				$this->total_spaces[ $datetime_identifier ],
+				'$total_spaces',
+				__FILE__,
+				__LINE__
+			);
+			\EEH_Debug_Tools::printr($this->ticket_quantities, '$ticket_quantities', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__);
+		}
+	}
+
+
+	/**
+	 * @param string $datetime_identifier
+	 * @param int    $reg_limit
+	 * @param string $ticket_identifier
+	 * @param int    $spaces_allocated
+	 * @return int
+	 */
+	private function calculateAvailableSpacesForTicket(
+		$datetime_identifier,
+		$reg_limit,
+		$ticket_identifier,
+		$spaces_allocated
+	) {
+		// make sure ticket quantity is set
+		$ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ])
+			? $this->ticket_quantities[ $ticket_identifier ]
+			: 0;
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr(
+				"{$ticket_quantity}",
+				"ticket $ticket_identifier quantity: ",
+				__FILE__,
+				__LINE__,
+				2
+			);
+		}
+		if ($ticket_quantity) {
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr(
+					($spaces_allocated <= $reg_limit)
+						? 'true'
+						: 'false',
+					' . spaces_allocated <= reg_limit = ',
+					__FILE__,
+					__LINE__
+				);
+			}
+			// if the datetime is NOT at full capacity yet
+			if ($spaces_allocated <= $reg_limit) {
+				// then the maximum ticket quantity we can allocate is the lowest value of either:
+				//  the number of remaining spaces for the datetime, which is the limit - spaces already taken
+				//  or the maximum ticket quantity
+				$ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity);
+				// adjust the available quantity in our tracking array
+				$this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity;
+				// and increment spaces allocated for this datetime
+				$spaces_allocated += $ticket_quantity;
+				$at_capacity = $spaces_allocated >= $reg_limit;
+				if ($this->debug) {
+					\EEH_Debug_Tools::printr(
+						"{$ticket_quantity} {$ticket_identifier} tickets",
+						' > > allocate ',
+						__FILE__,
+						__LINE__,
+						3
+					);
+					if ($at_capacity) {
+						\EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__, 3);
+					}
+				}
+				// now adjust all other datetimes that allow access to this ticket
+				$this->adjustDatetimes(
+					$datetime_identifier,
+					$ticket_identifier,
+					$ticket_quantity,
+					$at_capacity
+				);
+			}
+		}
+		return $spaces_allocated;
+	}
+
+
+	/**
+	 * subtracts ticket amounts from all datetime reg limits
+	 * that allow access to the ticket specified,
+	 * because that ticket could be used
+	 * to attend any of the datetimes it has access to
+	 *
+	 * @param string $datetime_identifier
+	 * @param string $ticket_identifier
+	 * @param bool   $at_capacity
+	 * @param int    $ticket_quantity
+	 */
+	private function adjustDatetimes(
+		$datetime_identifier,
+		$ticket_identifier,
+		$ticket_quantity,
+		$at_capacity
+	) {
+		/** @var array $datetime_tickets */
+		foreach ($this->datetime_tickets as $datetime_ID => $datetime_tickets) {
+			if ($datetime_ID !== $datetime_identifier || ! is_array($datetime_tickets)) {
+				continue;
+			}
+			$adjusted = $this->adjustDatetimeSpaces(
+				$datetime_ID,
+				$ticket_identifier,
+				$ticket_quantity
+			);
+			// skip to next ticket if nothing changed
+			if (! ($adjusted || $at_capacity)) {
+				continue;
+			}
+			// then all of it's tickets are now unavailable
+			foreach ($datetime_tickets as $datetime_ticket) {
+				if (($ticket_identifier === $datetime_ticket || $at_capacity)
+					&& isset($this->ticket_quantities[ $datetime_ticket ])
+					&& $this->ticket_quantities[ $datetime_ticket ] > 0
+				) {
+					if ($this->debug) {
+						\EEH_Debug_Tools::printr(
+							$datetime_ticket,
+							' . . . adjust ticket quantities for',
+							__FILE__,
+							__LINE__
+						);
+					}
+					// if this datetime is at full capacity, set any tracked available quantities to zero
+					// otherwise just subtract the ticket quantity
+					$new_quantity = $at_capacity
+						? 0
+						: $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity;
+					// don't let ticket quantity go below zero
+					$this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0);
+					if ($this->debug) {
+						\EEH_Debug_Tools::printr(
+							$at_capacity
+								? "0 because Datetime {$datetime_identifier} is at capacity"
+								: "{$this->ticket_quantities[ $datetime_ticket ]}",
+							" . . . . {$datetime_ticket} quantity set to ",
+							__FILE__,
+							__LINE__
+						);
+					}
+				}
+				// but we also need to adjust spaces for any other datetimes this ticket has access to
+				if ($datetime_ticket === $ticket_identifier) {
+					if (isset($this->ticket_datetimes[ $datetime_ticket ])
+						&& is_array($this->ticket_datetimes[ $datetime_ticket ])
+					) {
+						if ($this->debug) {
+							\EEH_Debug_Tools::printr(
+								$datetime_ticket,
+								' . . adjust other Datetimes for',
+								__FILE__,
+								__LINE__
+							);
+						}
+						foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) {
+							// don't adjust the current datetime twice
+							if ($datetime !== $datetime_identifier) {
+								$this->adjustDatetimeSpaces(
+									$datetime,
+									$datetime_ticket,
+									$ticket_quantity
+								);
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+
+	private function adjustDatetimeSpaces($datetime_identifier, $ticket_identifier, $ticket_quantity = 0)
+	{
+		// does datetime have spaces available?
+		// and does the supplied ticket have access to this datetime ?
+		if ($this->datetime_spaces[ $datetime_identifier ] > 0
+			&& isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ])
+			&& in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true)
+		) {
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__);
+				\EEH_Debug_Tools::printr(
+					"{$this->datetime_spaces[ $datetime_identifier ]}",
+					" . . current  {$datetime_identifier} spaces available",
+					__FILE__,
+					__LINE__
+				);
+			}
+			// then decrement the available spaces for the datetime
+			$this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity;
+			// but don't let quantities go below zero
+			$this->datetime_spaces[ $datetime_identifier ] = max(
+				$this->datetime_spaces[ $datetime_identifier ],
+				0
+			);
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr(
+					"{$ticket_quantity}",
+					" . . . {$datetime_identifier} capacity reduced by",
+					__FILE__,
+					__LINE__
+				);
+			}
+			return true;
+		}
+		return false;
+	}
 }

core/libraries/form_sections/strategies/display/EE_Number_Input_Display_Strategy.php

Doc Comments +3 added lines

@@ -64,6 +64,9 @@
     }
 
 
+    /**
+     * @param string $argument_label
+     */
     private function throwValidationException($argument_label, $argument_value)
     {
         throw new InvalidArgumentException(

Indentation +93 added lines, -93 removed lines

@@ -11,109 +11,109 @@
 class EE_Number_Input_Display_Strategy extends EE_Display_Strategy_Base
 {
 
-    /**
-     * minimum value for number field
-     *
-     * @var int|null $min
-     */
-    protected $min;
+	/**
+	 * minimum value for number field
+	 *
+	 * @var int|null $min
+	 */
+	protected $min;
 
-    /**
-     * maximum value for number field
-     *
-     * @var int|null $max
-     */
-    protected $max;
+	/**
+	 * maximum value for number field
+	 *
+	 * @var int|null $max
+	 */
+	protected $max;
 
 
-    /**
-     * This is used to set the "step" attribute for the html5 number input.
-     * Controls the increments on the input when incrementing or decrementing the value.
-     * Note:  Although the step attribute allows for the string "any" to be used, Firefox and Chrome will interpret that
-     * to increment by 1.  So although "any" is accepted as a value, it is converted to 1.
-     * @var float
-     */
-    protected $step;
+	/**
+	 * This is used to set the "step" attribute for the html5 number input.
+	 * Controls the increments on the input when incrementing or decrementing the value.
+	 * Note:  Although the step attribute allows for the string "any" to be used, Firefox and Chrome will interpret that
+	 * to increment by 1.  So although "any" is accepted as a value, it is converted to 1.
+	 * @var float
+	 */
+	protected $step;
 
 
-    /**
-     * EE_Number_Input_Display_Strategy constructor.
-     * Null is the default value for the incoming arguments because 0 is a valid value.  So we use null
-     * to indicate NOT setting this attribute.
-     *
-     * @param int|null $min
-     * @param int|null $max
-     * @param int|null $step
-     * @throws InvalidArgumentException
-     */
-    public function __construct($min = null, $max = null, $step = null)
-    {
-        $this->min = is_numeric($min) || $min === null
-            ? $min
-            : $this->throwValidationException('min', $min);
-        $this->max = is_numeric($max) || $max === null
-            ? $max
-            : $this->throwValidationException('max', $max);
-        $step = $step === 'any' ? 1 : $step;
-        $this->step = is_numeric($step) || $step === null
-            ? $step
-            : $this->throwValidationException('step', $step);
-    }
+	/**
+	 * EE_Number_Input_Display_Strategy constructor.
+	 * Null is the default value for the incoming arguments because 0 is a valid value.  So we use null
+	 * to indicate NOT setting this attribute.
+	 *
+	 * @param int|null $min
+	 * @param int|null $max
+	 * @param int|null $step
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($min = null, $max = null, $step = null)
+	{
+		$this->min = is_numeric($min) || $min === null
+			? $min
+			: $this->throwValidationException('min', $min);
+		$this->max = is_numeric($max) || $max === null
+			? $max
+			: $this->throwValidationException('max', $max);
+		$step = $step === 'any' ? 1 : $step;
+		$this->step = is_numeric($step) || $step === null
+			? $step
+			: $this->throwValidationException('step', $step);
+	}
 
 
-    private function throwValidationException($argument_label, $argument_value)
-    {
-        throw new InvalidArgumentException(
-            sprintf(
-                esc_html__(
-                    'The %1$s parameter value for %2$s must be numeric or null, %3$s was passed into the constructor.',
-                    'event_espresso'
-                ),
-                $argument_label,
-                __CLASS__,
-                $argument_value
-            )
-        );
-    }
+	private function throwValidationException($argument_label, $argument_value)
+	{
+		throw new InvalidArgumentException(
+			sprintf(
+				esc_html__(
+					'The %1$s parameter value for %2$s must be numeric or null, %3$s was passed into the constructor.',
+					'event_espresso'
+				),
+				$argument_label,
+				__CLASS__,
+				$argument_value
+			)
+		);
+	}
 
 
 
-    /**
-     * @return string of html to display the field
-     */
-    public function display()
-    {
-        $input = $this->_opening_tag('input');
-        $input .= $this->_attributes_string(
-            array_merge(
-                $this->_standard_attributes_array(),
-                $this->getNumberInputAttributes()
-            )
-        );
-        $input .= $this->_close_tag();
-        return $input;
-    }
+	/**
+	 * @return string of html to display the field
+	 */
+	public function display()
+	{
+		$input = $this->_opening_tag('input');
+		$input .= $this->_attributes_string(
+			array_merge(
+				$this->_standard_attributes_array(),
+				$this->getNumberInputAttributes()
+			)
+		);
+		$input .= $this->_close_tag();
+		return $input;
+	}
 
 
-    /**
-     * Return the attributes specific to this display strategy
-     * @return array
-     */
-    private function getNumberInputAttributes()
-    {
-        $attributes = array(
-            'type' => 'number',
-            'value' => $this->_input->raw_value_in_form()
-        );
-        if ($this->min !== null) {
-            $attributes['min'] = $this->min;
-        }
-        if ($this->max !== null) {
-            $attributes['max'] = $this->max;
-        }
-        if ($this->step !== null) {
-            $attributes['step'] = $this->step;
-        }
-        return $attributes;
-    }
+	/**
+	 * Return the attributes specific to this display strategy
+	 * @return array
+	 */
+	private function getNumberInputAttributes()
+	{
+		$attributes = array(
+			'type' => 'number',
+			'value' => $this->_input->raw_value_in_form()
+		);
+		if ($this->min !== null) {
+			$attributes['min'] = $this->min;
+		}
+		if ($this->max !== null) {
+			$attributes['max'] = $this->max;
+		}
+		if ($this->step !== null) {
+			$attributes['step'] = $this->step;
+		}
+		return $attributes;
+	}
 }

core/libraries/form_sections/inputs/EE_Float_Input.input.php

Indentation +29 added lines, -29 removed lines

@@ -11,33 +11,33 @@
 class EE_Float_Input extends EE_Form_Input_Base
 {
 
-    /**
-     * @param array $input_settings
-     * @throws InvalidArgumentException
-     */
-    public function __construct($input_settings = array())
-    {
-        $this->_set_display_strategy(
-            new EE_Number_Input_Display_Strategy(
-                isset($input_settings['min_value'])
-                    ? $input_settings['min_value']
-                    : null,
-                isset($input_settings['max_value'])
-                    ? $input_settings['max_value']
-                    : null,
-                isset($input_settings['step_value'])
-                    ? $input_settings['step_value']
-                    : null
-            )
-        );
-        $this->_set_normalization_strategy(new EE_Float_Normalization());
-        $this->_add_validation_strategy(
-            new EE_Float_Validation_Strategy(
-                isset($input_settings['validation_error_message'])
-                    ? $input_settings['validation_error_message']
-                    : null
-            )
-        );
-        parent::__construct($input_settings);
-    }
+	/**
+	 * @param array $input_settings
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($input_settings = array())
+	{
+		$this->_set_display_strategy(
+			new EE_Number_Input_Display_Strategy(
+				isset($input_settings['min_value'])
+					? $input_settings['min_value']
+					: null,
+				isset($input_settings['max_value'])
+					? $input_settings['max_value']
+					: null,
+				isset($input_settings['step_value'])
+					? $input_settings['step_value']
+					: null
+			)
+		);
+		$this->_set_normalization_strategy(new EE_Float_Normalization());
+		$this->_add_validation_strategy(
+			new EE_Float_Validation_Strategy(
+				isset($input_settings['validation_error_message'])
+					? $input_settings['validation_error_message']
+					: null
+			)
+		);
+		parent::__construct($input_settings);
+	}
 }

admin_pages/events/Events_Admin_List_Table.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -152,7 +152,7 @@
 
     /**
      * @param EE_Event $item
-     * @return mixed|string
+     * @return string
      * @throws EE_Error
      */
     public function column_id(EE_Event $item)

Spacing +29 added lines, -29 removed lines

@@ -112,7 +112,7 @@ 
         $class = parent::_get_row_class($item);
         // add status class
         $class .= $item instanceof EE_Event
-            ? ' ee-status-strip event-status-' . $item->get_active_status()
+            ? ' ee-status-strip event-status-'.$item->get_active_status()
             : '';
         if ($this->_has_checkbox_column) {
             $class .= ' has-checkbox-column';
@@ -141,7 +141,7 @@ 
      */
     public function column_cb($item)
     {
-        if (! $item instanceof EE_Event) {
+        if ( ! $item instanceof EE_Event) {
             return '';
         }
         $this->_dtt = $item->primary_datetime(); // set this for use in other columns
@@ -164,7 +164,7 @@ 
     public function column_id(EE_Event $item)
     {
         $content = $item->ID();
-        $content .= '  <span class="show-on-mobile-view-only">' . $item->name() . '</span>';
+        $content .= '  <span class="show-on-mobile-view-only">'.$item->name().'</span>';
         return $content;
     }
 
@@ -187,7 +187,7 @@ 
         $actions = $this->_column_name_action_setup($item);
         $status = ''; // $item->status() !== 'publish' ? ' (' . $item->status() . ')' : '';
         $content = '<strong><a class="row-title" href="'
-                   . $edit_link . '">'
+                   . $edit_link.'">'
                    . $item->name()
                    . '</a></strong>'
                    . $status;
@@ -216,7 +216,7 @@ 
     protected function _column_name_action_setup(EE_Event $item)
     {
         // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
+        if ( ! defined('REG_ADMIN_URL')) {
             define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
         }
         $actions = array();
@@ -233,8 +233,8 @@ 
                 'post'   => $item->ID(),
             );
             $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_link . '"'
-                               . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+            $actions['edit'] = '<a href="'.$edit_link.'"'
+                               . ' title="'.esc_attr__('Edit Event', 'event_espresso').'">'
                                . esc_html__('Edit', 'event_espresso')
                                . '</a>';
         }
@@ -253,8 +253,8 @@ 
                 'event_id' => $item->ID(),
             );
             $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $actions['attendees'] = '<a href="' . $attendees_link . '"'
-                                    . ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">'
+            $actions['attendees'] = '<a href="'.$attendees_link.'"'
+                                    . ' title="'.esc_attr__('View Registrations', 'event_espresso').'">'
                                     . esc_html__('Registrations', 'event_espresso')
                                     . '</a>';
         }
@@ -301,8 +301,8 @@ 
             );
         }
         $view_link = get_permalink($item->ID());
-        $actions['view'] = '<a href="' . $view_link . '"'
-                           . ' title="' . esc_attr__('View Event', 'event_espresso') . '">'
+        $actions['view'] = '<a href="'.$view_link.'"'
+                           . ' title="'.esc_attr__('View Event', 'event_espresso').'">'
                            . esc_html__('View', 'event_espresso')
                            . '</a>';
         if ($item->get('status') === 'trash') {
@@ -311,8 +311,8 @@ 
                 'espresso_events_restore_event',
                 $item->ID()
             )) {
-                $actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"'
-                                                 . ' title="' . esc_attr__('Restore from Trash', 'event_espresso')
+                $actions['restore_from_trash'] = '<a href="'.$restore_event_link.'"'
+                                                 . ' title="'.esc_attr__('Restore from Trash', 'event_espresso')
                                                  . '">'
                                                  . esc_html__('Restore from Trash', 'event_espresso')
                                                  . '</a>';
@@ -324,8 +324,8 @@ 
                     $item->ID()
                 )
             ) {
-                $actions['delete'] = '<a href="' . $delete_event_link . '"'
-                                     . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
+                $actions['delete'] = '<a href="'.$delete_event_link.'"'
+                                     . ' title="'.esc_attr__('Delete Permanently', 'event_espresso').'">'
                                      . esc_html__('Delete Permanently', 'event_espresso')
                                      . '</a>';
             }
@@ -335,8 +335,8 @@ 
                 'espresso_events_trash_event',
                 $item->ID()
             )) {
-                $actions['move to trash'] = '<a href="' . $trash_event_link . '"'
-                                            . ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">'
+                $actions['move to trash'] = '<a href="'.$trash_event_link.'"'
+                                            . ' title="'.esc_attr__('Trash Event', 'event_espresso').'">'
                                             . esc_html__('Trash', 'event_espresso')
                                             . '</a>';
             }
@@ -361,8 +361,8 @@ 
             'EVT_wp_user' => $item->wp_user(),
         );
         $filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
-        return $gravatar . '  <a href="' . $filter_url . '"'
-               . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
+        return $gravatar.'  <a href="'.$filter_url.'"'
+               . ' title="'.esc_attr__('Click to filter events by this author.', 'event_espresso').'">'
                . $event_author->display_name
                . '</a>';
     }
@@ -379,7 +379,7 @@ 
         return implode(
             ', ',
             array_map(
-                function (EE_Term $category) {
+                function(EE_Term $category) {
                     return $category->name();
                 },
                 $event_categories
@@ -454,7 +454,7 @@ 
                    'ee_read_registrations',
                    'espresso_registrations_view_registration'
                )
-            ? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
+            ? '<a href="'.$attendees_link.'">'.$registered_attendees.'</a>'
             : $registered_attendees;
     }
 
@@ -484,13 +484,13 @@ 
     public function column_actions(EE_Event $item)
     {
         // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
+        if ( ! defined('REG_ADMIN_URL')) {
             define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
         }
         $action_links = array();
         $view_link = get_permalink($item->ID());
-        $action_links[] = '<a href="' . $view_link . '"'
-                          . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">';
+        $action_links[] = '<a href="'.$view_link.'"'
+                          . ' title="'.esc_attr__('View Event', 'event_espresso').'" target="_blank">';
         $action_links[] = '<div class="dashicons dashicons-search"></div></a>';
         if (EE_Registry::instance()->CAP->current_user_can(
             'ee_edit_event',
@@ -502,8 +502,8 @@ 
                 'post'   => $item->ID(),
             );
             $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $action_links[] = '<a href="' . $edit_link . '"'
-                              . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+            $action_links[] = '<a href="'.$edit_link.'"'
+                              . ' title="'.esc_attr__('Edit Event', 'event_espresso').'">'
                               . '<div class="ee-icon ee-icon-calendar-edit"></div>'
                               . '</a>';
         }
@@ -521,8 +521,8 @@ 
                 'event_id' => $item->ID(),
             );
             $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $action_links[] = '<a href="' . $attendees_link . '"'
-                              . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">'
+            $action_links[] = '<a href="'.$attendees_link.'"'
+                              . ' title="'.esc_attr__('View Registrants', 'event_espresso').'">'
                               . '<div class="dashicons dashicons-groups"></div>'
                               . '</a>';
         }
@@ -557,7 +557,7 @@ 
         }
         $column_array = [];
         foreach ($this->_columns as $column => $column_label) {
-            $column_array[ $column ] = $column_label;
+            $column_array[$column] = $column_label;
             if ($column === 'venue') {
                 $column_array['event_category'] = esc_html__('Event Category', 'event_espresso');
             }

Indentation +549 added lines, -549 removed lines

@@ -15,553 +15,553 @@
 class Events_Admin_List_Table extends EE_Admin_List_Table
 {
 
-    /**
-     * @var EE_Datetime
-     */
-    private $_dtt;
-
-
-    /**
-     * Initial setup of data properties for the list table.
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->_admin_page->get_events($this->_per_page, $this->_current_page);
-        $this->_all_data_count = $this->_admin_page->get_events(0, 0, true);
-    }
-
-
-    /**
-     * Set up of additional properties for the list table.
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('event', 'event_espresso'),
-            'plural'   => esc_html__('events', 'event_espresso'),
-            'ajax'     => true, // for now
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-        $this->_columns = array(
-            'cb'              => '<input type="checkbox" />',
-            'id'              => esc_html__('ID', 'event_espresso'),
-            'name'            => esc_html__('Name', 'event_espresso'),
-            'author'          => esc_html__('Author', 'event_espresso'),
-            'venue'           => esc_html__('Venue', 'event_espresso'),
-            'start_date_time' => esc_html__('Event Start', 'event_espresso'),
-            'reg_begins'      => esc_html__('On Sale', 'event_espresso'),
-            'attendees'       => '<span class="dashicons dashicons-groups ee-icon-color-ee-green ee-icon-size-20">'
-                                 . '<span class="screen-reader-text">'
-                                 . esc_html__('Approved Registrations', 'event_espresso')
-                                 . '</span>'
-                                 . '</span>',
-            // 'tkts_sold' => esc_html__('Tickets Sold', 'event_espresso'),
-            'actions'         => esc_html__('Actions', 'event_espresso'),
-        );
-        $this->addConditionalColumns();
-        $this->_sortable_columns = array(
-            'id'              => array('EVT_ID' => true),
-            'name'            => array('EVT_name' => false),
-            'author'          => array('EVT_wp_user' => false),
-            'venue'           => array('Venue.VNU_name' => false),
-            'start_date_time' => array('Datetime.DTT_EVT_start' => false),
-            'reg_begins'      => array('Datetime.Ticket.TKT_start_date' => false),
-        );
-
-        $this->_primary_column = 'id';
-        $this->_hidden_columns = array('author', 'event_category');
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function _get_table_filters()
-    {
-        return array(); // no filters with decaf
-    }
-
-
-    /**
-     * Setup of views properties.
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_admin_page->total_events();
-        $this->_views['draft']['count'] = $this->_admin_page->total_events_draft();
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_events',
-            'espresso_events_trash_events'
-        )) {
-            $this->_views['trash']['count'] = $this->_admin_page->total_trashed_events();
-        }
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_row_class($item)
-    {
-        $class = parent::_get_row_class($item);
-        // add status class
-        $class .= $item instanceof EE_Event
-            ? ' ee-status-strip event-status-' . $item->get_active_status()
-            : '';
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_status(EE_Event $item)
-    {
-        return '<span class="ee-status-strip ee-status-strip-td event-status-'
-               . $item->get_active_status()
-               . '"></span>';
-    }
-
-
-    /**
-     * @param  EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_cb($item)
-    {
-        if (! $item instanceof EE_Event) {
-            return '';
-        }
-        $this->_dtt = $item->primary_datetime(); // set this for use in other columns
-        // does event have any attached registrations?
-        $regs = $item->count_related('Registration');
-        return $regs > 0 && $this->_view === 'trash'
-            ? '<span class="ee-lock-icon"></span>'
-            : sprintf(
-                '<input type="checkbox" name="EVT_IDs[]" value="%s" />',
-                $item->ID()
-            );
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return mixed|string
-     * @throws EE_Error
-     */
-    public function column_id(EE_Event $item)
-    {
-        $content = $item->ID();
-        $content .= '  <span class="show-on-mobile-view-only">' . $item->name() . '</span>';
-        return $content;
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_name(EE_Event $item)
-    {
-        $edit_query_args = array(
-            'action' => 'edit',
-            'post'   => $item->ID(),
-        );
-        $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-        $actions = $this->_column_name_action_setup($item);
-        $status = ''; // $item->status() !== 'publish' ? ' (' . $item->status() . ')' : '';
-        $content = '<strong><a class="row-title" href="'
-                   . $edit_link . '">'
-                   . $item->name()
-                   . '</a></strong>'
-                   . $status;
-        $content .= '<br><span class="ee-status-text-small">'
-                    . EEH_Template::pretty_status(
-                        $item->get_active_status(),
-                        false,
-                        'sentence'
-                    )
-                    . '</span>';
-        $content .= $this->row_actions($actions);
-        return $content;
-    }
-
-
-    /**
-     * Just a method for setting up the actions for the name column
-     *
-     * @param EE_Event $item
-     * @return array array of actions
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _column_name_action_setup(EE_Event $item)
-    {
-        // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
-            define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
-        }
-        $actions = array();
-        $restore_event_link = '';
-        $delete_event_link = '';
-        $trash_event_link = '';
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_event',
-            'espresso_events_edit',
-            $item->ID()
-        )) {
-            $edit_query_args = array(
-                'action' => 'edit',
-                'post'   => $item->ID(),
-            );
-            $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_link . '"'
-                               . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
-                               . esc_html__('Edit', 'event_espresso')
-                               . '</a>';
-        }
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registrations',
-            'espresso_registrations_view_registration'
-        )
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_event',
-                'espresso_registrations_view_registration',
-                $item->ID()
-            )
-        ) {
-            $attendees_query_args = array(
-                'action'   => 'default',
-                'event_id' => $item->ID(),
-            );
-            $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $actions['attendees'] = '<a href="' . $attendees_link . '"'
-                                    . ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">'
-                                    . esc_html__('Registrations', 'event_espresso')
-                                    . '</a>';
-        }
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_event',
-            'espresso_events_trash_event',
-            $item->ID()
-        )) {
-            $trash_event_query_args = array(
-                'action' => 'trash_event',
-                'EVT_ID' => $item->ID(),
-            );
-            $trash_event_link = EE_Admin_Page::add_query_args_and_nonce(
-                $trash_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_event',
-            'espresso_events_restore_event',
-            $item->ID()
-        )) {
-            $restore_event_query_args = array(
-                'action' => 'restore_event',
-                'EVT_ID' => $item->ID(),
-            );
-            $restore_event_link = EE_Admin_Page::add_query_args_and_nonce(
-                $restore_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_event',
-            'espresso_events_delete_event',
-            $item->ID()
-        )) {
-            $delete_event_query_args = array(
-                'action' => 'delete_event',
-                'EVT_ID' => $item->ID(),
-            );
-            $delete_event_link = EE_Admin_Page::add_query_args_and_nonce(
-                $delete_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        $view_link = get_permalink($item->ID());
-        $actions['view'] = '<a href="' . $view_link . '"'
-                           . ' title="' . esc_attr__('View Event', 'event_espresso') . '">'
-                           . esc_html__('View', 'event_espresso')
-                           . '</a>';
-        if ($item->get('status') === 'trash') {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_event',
-                'espresso_events_restore_event',
-                $item->ID()
-            )) {
-                $actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"'
-                                                 . ' title="' . esc_attr__('Restore from Trash', 'event_espresso')
-                                                 . '">'
-                                                 . esc_html__('Restore from Trash', 'event_espresso')
-                                                 . '</a>';
-            }
-            if ($item->count_related('Registration') === 0
-                && EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_event',
-                    'espresso_events_delete_event',
-                    $item->ID()
-                )
-            ) {
-                $actions['delete'] = '<a href="' . $delete_event_link . '"'
-                                     . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
-                                     . esc_html__('Delete Permanently', 'event_espresso')
-                                     . '</a>';
-            }
-        } else {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_event',
-                'espresso_events_trash_event',
-                $item->ID()
-            )) {
-                $actions['move to trash'] = '<a href="' . $trash_event_link . '"'
-                                            . ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">'
-                                            . esc_html__('Trash', 'event_espresso')
-                                            . '</a>';
-            }
-        }
-        return $actions;
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_author(EE_Event $item)
-    {
-        // user author info
-        $event_author = get_userdata($item->wp_user());
-        $gravatar = get_avatar($item->wp_user(), '15');
-        // filter link
-        $query_args = array(
-            'action'      => 'default',
-            'EVT_wp_user' => $item->wp_user(),
-        );
-        $filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
-        return $gravatar . '  <a href="' . $filter_url . '"'
-               . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
-               . $event_author->display_name
-               . '</a>';
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_event_category(EE_Event $event)
-    {
-        $event_categories = $event->get_all_event_categories();
-        return implode(
-            ', ',
-            array_map(
-                function (EE_Term $category) {
-                    return $category->name();
-                },
-                $event_categories
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_venue(EE_Event $item)
-    {
-        $venue = $item->get_first_related('Venue');
-        return ! empty($venue)
-            ? $venue->name()
-            : '';
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_start_date_time(EE_Event $item)
-    {
-        return $this->_dtt instanceof EE_Datetime
-            ? $this->_dtt->get_i18n_datetime('DTT_EVT_start')
-            : esc_html__('No Date was saved for this Event', 'event_espresso');
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_reg_begins(EE_Event $item)
-    {
-        $reg_start = $item->get_ticket_with_earliest_start_time();
-        return $reg_start instanceof EE_Ticket
-            ? $reg_start->get_i18n_datetime('TKT_start_date')
-            : esc_html__('No Tickets have been setup for this Event', 'event_espresso');
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return int|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_attendees(EE_Event $item)
-    {
-        $attendees_query_args = array(
-            'action'   => 'default',
-            'event_id' => $item->ID(),
-        );
-        $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-        $registered_attendees = EEM_Registration::instance()->get_event_registration_count($item->ID());
-        return EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_event',
-            'espresso_registrations_view_registration',
-            $item->ID()
-        )
-               && EE_Registry::instance()->CAP->current_user_can(
-                   'ee_read_registrations',
-                   'espresso_registrations_view_registration'
-               )
-            ? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
-            : $registered_attendees;
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_tkts_sold(EE_Event $item)
-    {
-        return EEM_Ticket::instance()->sum(array(array('Datetime.EVT_ID' => $item->ID())), 'TKT_sold');
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_actions(EE_Event $item)
-    {
-        // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
-            define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
-        }
-        $action_links = array();
-        $view_link = get_permalink($item->ID());
-        $action_links[] = '<a href="' . $view_link . '"'
-                          . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">';
-        $action_links[] = '<div class="dashicons dashicons-search"></div></a>';
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_event',
-            'espresso_events_edit',
-            $item->ID()
-        )) {
-            $edit_query_args = array(
-                'action' => 'edit',
-                'post'   => $item->ID(),
-            );
-            $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $action_links[] = '<a href="' . $edit_link . '"'
-                              . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
-                              . '<div class="ee-icon ee-icon-calendar-edit"></div>'
-                              . '</a>';
-        }
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registrations',
-            'espresso_registrations_view_registration'
-        ) && EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_event',
-            'espresso_registrations_view_registration',
-            $item->ID()
-        )
-        ) {
-            $attendees_query_args = array(
-                'action'   => 'default',
-                'event_id' => $item->ID(),
-            );
-            $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $action_links[] = '<a href="' . $attendees_link . '"'
-                              . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">'
-                              . '<div class="dashicons dashicons-groups"></div>'
-                              . '</a>';
-        }
-        $action_links = apply_filters(
-            'FHEE__Events_Admin_List_Table__column_actions__action_links',
-            $action_links,
-            $item
-        );
-        return $this->_action_string(
-            implode("\n\t", $action_links),
-            $item,
-            'div'
-        );
-    }
-
-
-    /**
-     * Helper for adding columns conditionally
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function addConditionalColumns()
-    {
-        $event_category_count = EEM_Term::instance()->count(
-            [['Term_Taxonomy.taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY]]
-        );
-        if ($event_category_count === 0) {
-            return;
-        }
-        $column_array = [];
-        foreach ($this->_columns as $column => $column_label) {
-            $column_array[ $column ] = $column_label;
-            if ($column === 'venue') {
-                $column_array['event_category'] = esc_html__('Event Category', 'event_espresso');
-            }
-        }
-        $this->_columns = $column_array;
-    }
+	/**
+	 * @var EE_Datetime
+	 */
+	private $_dtt;
+
+
+	/**
+	 * Initial setup of data properties for the list table.
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->_admin_page->get_events($this->_per_page, $this->_current_page);
+		$this->_all_data_count = $this->_admin_page->get_events(0, 0, true);
+	}
+
+
+	/**
+	 * Set up of additional properties for the list table.
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('event', 'event_espresso'),
+			'plural'   => esc_html__('events', 'event_espresso'),
+			'ajax'     => true, // for now
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+		$this->_columns = array(
+			'cb'              => '<input type="checkbox" />',
+			'id'              => esc_html__('ID', 'event_espresso'),
+			'name'            => esc_html__('Name', 'event_espresso'),
+			'author'          => esc_html__('Author', 'event_espresso'),
+			'venue'           => esc_html__('Venue', 'event_espresso'),
+			'start_date_time' => esc_html__('Event Start', 'event_espresso'),
+			'reg_begins'      => esc_html__('On Sale', 'event_espresso'),
+			'attendees'       => '<span class="dashicons dashicons-groups ee-icon-color-ee-green ee-icon-size-20">'
+								 . '<span class="screen-reader-text">'
+								 . esc_html__('Approved Registrations', 'event_espresso')
+								 . '</span>'
+								 . '</span>',
+			// 'tkts_sold' => esc_html__('Tickets Sold', 'event_espresso'),
+			'actions'         => esc_html__('Actions', 'event_espresso'),
+		);
+		$this->addConditionalColumns();
+		$this->_sortable_columns = array(
+			'id'              => array('EVT_ID' => true),
+			'name'            => array('EVT_name' => false),
+			'author'          => array('EVT_wp_user' => false),
+			'venue'           => array('Venue.VNU_name' => false),
+			'start_date_time' => array('Datetime.DTT_EVT_start' => false),
+			'reg_begins'      => array('Datetime.Ticket.TKT_start_date' => false),
+		);
+
+		$this->_primary_column = 'id';
+		$this->_hidden_columns = array('author', 'event_category');
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function _get_table_filters()
+	{
+		return array(); // no filters with decaf
+	}
+
+
+	/**
+	 * Setup of views properties.
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_admin_page->total_events();
+		$this->_views['draft']['count'] = $this->_admin_page->total_events_draft();
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_events',
+			'espresso_events_trash_events'
+		)) {
+			$this->_views['trash']['count'] = $this->_admin_page->total_trashed_events();
+		}
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_row_class($item)
+	{
+		$class = parent::_get_row_class($item);
+		// add status class
+		$class .= $item instanceof EE_Event
+			? ' ee-status-strip event-status-' . $item->get_active_status()
+			: '';
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_status(EE_Event $item)
+	{
+		return '<span class="ee-status-strip ee-status-strip-td event-status-'
+			   . $item->get_active_status()
+			   . '"></span>';
+	}
+
+
+	/**
+	 * @param  EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_cb($item)
+	{
+		if (! $item instanceof EE_Event) {
+			return '';
+		}
+		$this->_dtt = $item->primary_datetime(); // set this for use in other columns
+		// does event have any attached registrations?
+		$regs = $item->count_related('Registration');
+		return $regs > 0 && $this->_view === 'trash'
+			? '<span class="ee-lock-icon"></span>'
+			: sprintf(
+				'<input type="checkbox" name="EVT_IDs[]" value="%s" />',
+				$item->ID()
+			);
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return mixed|string
+	 * @throws EE_Error
+	 */
+	public function column_id(EE_Event $item)
+	{
+		$content = $item->ID();
+		$content .= '  <span class="show-on-mobile-view-only">' . $item->name() . '</span>';
+		return $content;
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_name(EE_Event $item)
+	{
+		$edit_query_args = array(
+			'action' => 'edit',
+			'post'   => $item->ID(),
+		);
+		$edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+		$actions = $this->_column_name_action_setup($item);
+		$status = ''; // $item->status() !== 'publish' ? ' (' . $item->status() . ')' : '';
+		$content = '<strong><a class="row-title" href="'
+				   . $edit_link . '">'
+				   . $item->name()
+				   . '</a></strong>'
+				   . $status;
+		$content .= '<br><span class="ee-status-text-small">'
+					. EEH_Template::pretty_status(
+						$item->get_active_status(),
+						false,
+						'sentence'
+					)
+					. '</span>';
+		$content .= $this->row_actions($actions);
+		return $content;
+	}
+
+
+	/**
+	 * Just a method for setting up the actions for the name column
+	 *
+	 * @param EE_Event $item
+	 * @return array array of actions
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _column_name_action_setup(EE_Event $item)
+	{
+		// todo: remove when attendees is active
+		if (! defined('REG_ADMIN_URL')) {
+			define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
+		}
+		$actions = array();
+		$restore_event_link = '';
+		$delete_event_link = '';
+		$trash_event_link = '';
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_event',
+			'espresso_events_edit',
+			$item->ID()
+		)) {
+			$edit_query_args = array(
+				'action' => 'edit',
+				'post'   => $item->ID(),
+			);
+			$edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+			$actions['edit'] = '<a href="' . $edit_link . '"'
+							   . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+							   . esc_html__('Edit', 'event_espresso')
+							   . '</a>';
+		}
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registrations',
+			'espresso_registrations_view_registration'
+		)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_event',
+				'espresso_registrations_view_registration',
+				$item->ID()
+			)
+		) {
+			$attendees_query_args = array(
+				'action'   => 'default',
+				'event_id' => $item->ID(),
+			);
+			$attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+			$actions['attendees'] = '<a href="' . $attendees_link . '"'
+									. ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">'
+									. esc_html__('Registrations', 'event_espresso')
+									. '</a>';
+		}
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_event',
+			'espresso_events_trash_event',
+			$item->ID()
+		)) {
+			$trash_event_query_args = array(
+				'action' => 'trash_event',
+				'EVT_ID' => $item->ID(),
+			);
+			$trash_event_link = EE_Admin_Page::add_query_args_and_nonce(
+				$trash_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_event',
+			'espresso_events_restore_event',
+			$item->ID()
+		)) {
+			$restore_event_query_args = array(
+				'action' => 'restore_event',
+				'EVT_ID' => $item->ID(),
+			);
+			$restore_event_link = EE_Admin_Page::add_query_args_and_nonce(
+				$restore_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_event',
+			'espresso_events_delete_event',
+			$item->ID()
+		)) {
+			$delete_event_query_args = array(
+				'action' => 'delete_event',
+				'EVT_ID' => $item->ID(),
+			);
+			$delete_event_link = EE_Admin_Page::add_query_args_and_nonce(
+				$delete_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		$view_link = get_permalink($item->ID());
+		$actions['view'] = '<a href="' . $view_link . '"'
+						   . ' title="' . esc_attr__('View Event', 'event_espresso') . '">'
+						   . esc_html__('View', 'event_espresso')
+						   . '</a>';
+		if ($item->get('status') === 'trash') {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_event',
+				'espresso_events_restore_event',
+				$item->ID()
+			)) {
+				$actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"'
+												 . ' title="' . esc_attr__('Restore from Trash', 'event_espresso')
+												 . '">'
+												 . esc_html__('Restore from Trash', 'event_espresso')
+												 . '</a>';
+			}
+			if ($item->count_related('Registration') === 0
+				&& EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_event',
+					'espresso_events_delete_event',
+					$item->ID()
+				)
+			) {
+				$actions['delete'] = '<a href="' . $delete_event_link . '"'
+									 . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
+									 . esc_html__('Delete Permanently', 'event_espresso')
+									 . '</a>';
+			}
+		} else {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_event',
+				'espresso_events_trash_event',
+				$item->ID()
+			)) {
+				$actions['move to trash'] = '<a href="' . $trash_event_link . '"'
+											. ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">'
+											. esc_html__('Trash', 'event_espresso')
+											. '</a>';
+			}
+		}
+		return $actions;
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_author(EE_Event $item)
+	{
+		// user author info
+		$event_author = get_userdata($item->wp_user());
+		$gravatar = get_avatar($item->wp_user(), '15');
+		// filter link
+		$query_args = array(
+			'action'      => 'default',
+			'EVT_wp_user' => $item->wp_user(),
+		);
+		$filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
+		return $gravatar . '  <a href="' . $filter_url . '"'
+			   . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
+			   . $event_author->display_name
+			   . '</a>';
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_event_category(EE_Event $event)
+	{
+		$event_categories = $event->get_all_event_categories();
+		return implode(
+			', ',
+			array_map(
+				function (EE_Term $category) {
+					return $category->name();
+				},
+				$event_categories
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_venue(EE_Event $item)
+	{
+		$venue = $item->get_first_related('Venue');
+		return ! empty($venue)
+			? $venue->name()
+			: '';
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_start_date_time(EE_Event $item)
+	{
+		return $this->_dtt instanceof EE_Datetime
+			? $this->_dtt->get_i18n_datetime('DTT_EVT_start')
+			: esc_html__('No Date was saved for this Event', 'event_espresso');
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_reg_begins(EE_Event $item)
+	{
+		$reg_start = $item->get_ticket_with_earliest_start_time();
+		return $reg_start instanceof EE_Ticket
+			? $reg_start->get_i18n_datetime('TKT_start_date')
+			: esc_html__('No Tickets have been setup for this Event', 'event_espresso');
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return int|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_attendees(EE_Event $item)
+	{
+		$attendees_query_args = array(
+			'action'   => 'default',
+			'event_id' => $item->ID(),
+		);
+		$attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+		$registered_attendees = EEM_Registration::instance()->get_event_registration_count($item->ID());
+		return EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_event',
+			'espresso_registrations_view_registration',
+			$item->ID()
+		)
+			   && EE_Registry::instance()->CAP->current_user_can(
+				   'ee_read_registrations',
+				   'espresso_registrations_view_registration'
+			   )
+			? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
+			: $registered_attendees;
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_tkts_sold(EE_Event $item)
+	{
+		return EEM_Ticket::instance()->sum(array(array('Datetime.EVT_ID' => $item->ID())), 'TKT_sold');
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_actions(EE_Event $item)
+	{
+		// todo: remove when attendees is active
+		if (! defined('REG_ADMIN_URL')) {
+			define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
+		}
+		$action_links = array();
+		$view_link = get_permalink($item->ID());
+		$action_links[] = '<a href="' . $view_link . '"'
+						  . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">';
+		$action_links[] = '<div class="dashicons dashicons-search"></div></a>';
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_event',
+			'espresso_events_edit',
+			$item->ID()
+		)) {
+			$edit_query_args = array(
+				'action' => 'edit',
+				'post'   => $item->ID(),
+			);
+			$edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+			$action_links[] = '<a href="' . $edit_link . '"'
+							  . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+							  . '<div class="ee-icon ee-icon-calendar-edit"></div>'
+							  . '</a>';
+		}
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registrations',
+			'espresso_registrations_view_registration'
+		) && EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_event',
+			'espresso_registrations_view_registration',
+			$item->ID()
+		)
+		) {
+			$attendees_query_args = array(
+				'action'   => 'default',
+				'event_id' => $item->ID(),
+			);
+			$attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+			$action_links[] = '<a href="' . $attendees_link . '"'
+							  . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">'
+							  . '<div class="dashicons dashicons-groups"></div>'
+							  . '</a>';
+		}
+		$action_links = apply_filters(
+			'FHEE__Events_Admin_List_Table__column_actions__action_links',
+			$action_links,
+			$item
+		);
+		return $this->_action_string(
+			implode("\n\t", $action_links),
+			$item,
+			'div'
+		);
+	}
+
+
+	/**
+	 * Helper for adding columns conditionally
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function addConditionalColumns()
+	{
+		$event_category_count = EEM_Term::instance()->count(
+			[['Term_Taxonomy.taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY]]
+		);
+		if ($event_category_count === 0) {
+			return;
+		}
+		$column_array = [];
+		foreach ($this->_columns as $column => $column_label) {
+			$column_array[ $column ] = $column_label;
+			if ($column === 'venue') {
+				$column_array['event_category'] = esc_html__('Event Category', 'event_espresso');
+			}
+		}
+		$this->_columns = $column_array;
+	}
 }