eventespresso / event-espresso-core

acceptance_tests/Helpers/CountrySettingsAdmin.php

Unused Use Statements -1 removed lines

@@ -1,7 +1,6 @@
 <?php
 namespace EventEspresso\Codeception\helpers;
 
-use Page\CoreAdmin;
 use Page\CountrySettingsAdmin as CountrySettings;
 
 trait CountrySettingsAdmin

Indentation +47 added lines, -47 removed lines

@@ -6,59 +6,59 @@
 
 trait CountrySettingsAdmin
 {
-    /**
-     * Instructs the actor to browse to the country settings page.
-     * Assumes the actor is already logged in.
-     * @param string $additional_params
-     */
-    public function amOnCountrySettingsAdminPage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(CountrySettings::url($additional_params));
-    }
+	/**
+	 * Instructs the actor to browse to the country settings page.
+	 * Assumes the actor is already logged in.
+	 * @param string $additional_params
+	 */
+	public function amOnCountrySettingsAdminPage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(CountrySettings::url($additional_params));
+	}
 
 
-    /**
-     * Instructs the actor to select the given decimal places radio option.
-     * Assumes the actor is already on the country settings page.
-     * @param string $decimal_places
-     * @param string $country_code
-     */
-    public function setCurrencyDecimalPlacesTo($decimal_places = '2', $country_code = 'US')
-    {
-        $this->actor()->click(CountrySettings::currencyDecimalPlacesRadioField($decimal_places, $country_code));
-    }
+	/**
+	 * Instructs the actor to select the given decimal places radio option.
+	 * Assumes the actor is already on the country settings page.
+	 * @param string $decimal_places
+	 * @param string $country_code
+	 */
+	public function setCurrencyDecimalPlacesTo($decimal_places = '2', $country_code = 'US')
+	{
+		$this->actor()->click(CountrySettings::currencyDecimalPlacesRadioField($decimal_places, $country_code));
+	}
 
 
-    /**
-     * Instructs the actor to select the given decimal mark radio option.
-     * Assumes the actor is already on the country settings page.
-     * @param string $decimal_mark
-     */
-    public function setCurrencyDecimalMarkTo($decimal_mark = '.')
-    {
-        $this->actor()->click(CountrySettings::currencyDecimalMarkRadioField($decimal_mark));
-    }
+	/**
+	 * Instructs the actor to select the given decimal mark radio option.
+	 * Assumes the actor is already on the country settings page.
+	 * @param string $decimal_mark
+	 */
+	public function setCurrencyDecimalMarkTo($decimal_mark = '.')
+	{
+		$this->actor()->click(CountrySettings::currencyDecimalMarkRadioField($decimal_mark));
+	}
 
 
-    /**
-     * Instructs the actor to select the given thousands separator radio option.
-     * Assumes the actor is already on the country settings page.
-     * @param string $thousands_seperator
-     */
-    public function setCurrencyThousandsSeparatorTo($thousands_seperator = ',')
-    {
-        $this->actor()->click(CountrySettings::currencyThousandsSeparatorField($thousands_seperator));
-    }
+	/**
+	 * Instructs the actor to select the given thousands separator radio option.
+	 * Assumes the actor is already on the country settings page.
+	 * @param string $thousands_seperator
+	 */
+	public function setCurrencyThousandsSeparatorTo($thousands_seperator = ',')
+	{
+		$this->actor()->click(CountrySettings::currencyThousandsSeparatorField($thousands_seperator));
+	}
 
 
-    /**
-     * Clicks the country settings submit button.
-     * Assumes the actor is on the country settings admin page.
-     */
-    public function saveCountrySettings()
-    {
-        $this->actor()->click(CountrySettings::COUNTRY_SETTINGS_SAVE_BUTTON);
-        //no indicator on the page when stuff has been updated so just give a bit of time for it to finish.
-        $this->actor()->wait(10);
-    }
+	/**
+	 * Clicks the country settings submit button.
+	 * Assumes the actor is on the country settings admin page.
+	 */
+	public function saveCountrySettings()
+	{
+		$this->actor()->click(CountrySettings::COUNTRY_SETTINGS_SAVE_BUTTON);
+		//no indicator on the page when stuff has been updated so just give a bit of time for it to finish.
+		$this->actor()->wait(10);
+	}
 }
\ No newline at end of file

acceptance_tests/Page/CountrySettingsAdmin.php

Indentation +38 added lines, -38 removed lines

@@ -14,51 +14,51 @@
 {
 
 
-    const COUNTRY_SETTINGS_SAVE_BUTTON = '#country_settings_save_2';
+	const COUNTRY_SETTINGS_SAVE_BUTTON = '#country_settings_save_2';
 
 
 
-    /**
-     * Return the url for the country settings admin page.
-     * @param string $additional_params
-     * @return string
-     */
-    public static function url($additional_params = '')
-    {
-        return self::adminUrl('espresso_general_settings', 'country_settings', $additional_params);
-    }
+	/**
+	 * Return the url for the country settings admin page.
+	 * @param string $additional_params
+	 * @return string
+	 */
+	public static function url($additional_params = '')
+	{
+		return self::adminUrl('espresso_general_settings', 'country_settings', $additional_params);
+	}
 
 
-    /**
-     * Return the decimal places (precision) radio field locator for selection.
-     * @param int    $decimal_place_value
-     * @param string $country_code
-     * @return string
-     */
-    public static function currencyDecimalPlacesRadioField($decimal_place_value = 2, $country_code = 'US')
-    {
-        return "//input[@id='CNT_cur_dec_plc-$country_code-$decimal_place_value']";
-    }
+	/**
+	 * Return the decimal places (precision) radio field locator for selection.
+	 * @param int    $decimal_place_value
+	 * @param string $country_code
+	 * @return string
+	 */
+	public static function currencyDecimalPlacesRadioField($decimal_place_value = 2, $country_code = 'US')
+	{
+		return "//input[@id='CNT_cur_dec_plc-$country_code-$decimal_place_value']";
+	}
 
 
-    /**
-     * Return the currency decimal mark field locator for selection.
-     * @param string $decimal_mark
-     * @return string
-     */
-    public static function currencyDecimalMarkRadioField($decimal_mark = '.')
-    {
-        return "//input[@class='CNT_cur_dec_mrk' and @value='$decimal_mark']";
-    }
+	/**
+	 * Return the currency decimal mark field locator for selection.
+	 * @param string $decimal_mark
+	 * @return string
+	 */
+	public static function currencyDecimalMarkRadioField($decimal_mark = '.')
+	{
+		return "//input[@class='CNT_cur_dec_mrk' and @value='$decimal_mark']";
+	}
 
 
-    /**
-     * Return the currency thousands separator field locator for selection.
-     * @param string $thousands_separator
-     * @return string
-     */
-    public static function currencyThousandsSeparatorField($thousands_separator = ',')
-    {
-        return "//input[@class='CNT_cur_thsnds' and @value='$thousands_separator']";
-    }
+	/**
+	 * Return the currency thousands separator field locator for selection.
+	 * @param string $thousands_separator
+	 * @return string
+	 */
+	public static function currencyThousandsSeparatorField($thousands_separator = ',')
+	{
+		return "//input[@class='CNT_cur_thsnds' and @value='$thousands_separator']";
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_Email_Field.php

Indentation +31 added lines, -31 removed lines

@@ -16,38 +16,38 @@
 {
 
 
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @throws InvalidArgumentException
-     */
-    public function __construct($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nice_name, $nullable, $default_value);
-        $this->setSchemaFormat('email');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nice_name, $nullable, $default_value);
+		$this->setSchemaFormat('email');
+	}
 
 
 
-    /**
-     * In form inputs, we should have called htmlentities and addslashes() on form inputs,
-     * so we need to undo that on setting of these fields
-     *
-     * @param string $email_address
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function prepare_for_set($email_address)
-    {
-        try {
-            $email_address = EmailAddressFactory::create($email_address);
-            return $email_address->get();
-        } catch (EmailValidationException $e) {
-            return '';
-        }
-    }
+	/**
+	 * In form inputs, we should have called htmlentities and addslashes() on form inputs,
+	 * so we need to undo that on setting of these fields
+	 *
+	 * @param string $email_address
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function prepare_for_set($email_address)
+	{
+		try {
+			$email_address = EmailAddressFactory::create($email_address);
+			return $email_address->get();
+		} catch (EmailValidationException $e) {
+			return '';
+		}
+	}
 }

core/domain/services/factories/FactoryInterface.php

Indentation +5 added lines, -5 removed lines

@@ -15,11 +15,11 @@
 interface FactoryInterface
 {
 
-    /**
-     * @param mixed $arguments
-     * @return mixed
-     */
-    public static function create($arguments);
+	/**
+	 * @param mixed $arguments
+	 * @return mixed
+	 */
+	public static function create($arguments);
 
 
 }

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;
 
 /**

Indentation +399 added lines, -399 removed lines

@@ -12,411 +12,411 @@
 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'
-                ),
-            ),
-            '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';
-        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'
+				),
+			),
+			'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';
+		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));
+	}
 }

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;

caffeinated/admin/extend/messages/espresso_events_Messages_Hooks_Extend.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
      *
      * @param  EE_Event $event EE event object
      * @param  array    $data  The request data from the form
-     * @return bool success or fail
+     * @return integer success or fail
      * @throws EE_Error
      */
     public function attach_evt_message_templates($event, $data)

Indentation +267 added lines, -267 removed lines

@@ -12,276 +12,276 @@
  */
 class espresso_events_Messages_Hooks_Extend extends espresso_events_Messages_Hooks
 {
-    /**
-     * espresso_events_Messages_Hooks_Extend constructor.
-     *
-     * @param \EE_Admin_Page $admin_page
-     */
-    public function __construct(EE_Admin_Page $admin_page)
-    {
-        /**
-         * Add cap restriction ... metaboxes should not show if user does not have the ability to edit_custom_messages
-         */
-        if (! EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_messages',
-            'messages_events_editor_metabox'
-        )) {
-            return;
-        }
-        add_filter(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            array($this, 'caf_updates'),
-            10
-        );
-        add_action(
-            'AHEE__Extend_Events_Admin_Page___duplicate_event__after',
-            array($this, 'duplicate_custom_message_settings'),
-            10,
-            2
-        );
-        parent::__construct($admin_page);
-    }
-
-
-    /**
-     * extending the properties set in espresso_events_Messages_Hooks
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _extend_properties()
-    {
-        define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'messages/assets/');
-        $this->_ajax_func = array(
-            'ee_msgs_create_new_custom' => 'create_new_custom',
-        );
-        $this->_metaboxes = array(
-            0 => array(
-                'page_route' => array('edit', 'create_new'),
-                'func'       => 'messages_metabox',
-                'label'      => esc_html__('Notifications', 'event_espresso'),
-                'priority'   => 'high',
-            ),
-        );
-
-        // see explanation for layout in EE_Admin_Hooks
-        $this->_scripts_styles = array(
-            'registers' => array(
-                'events_msg_admin'     => array(
-                    'url'     => EE_MSGS_EXTEND_ASSETS_URL . 'events_messages_admin.js',
-                    'depends' => array('ee-dialog', 'ee-parse-uri', 'ee-serialize-full-array'),
-                ),
-                'events_msg_admin_css' => array(
-                    'url'  => EE_MSGS_EXTEND_ASSETS_URL . 'ee_msg_events_admin.css',
-                    'type' => 'css',
-                ),
-            ),
-            'enqueues'  => array(
-                'events_msg_admin'     => array('edit', 'create_new'),
-                'events_msg_admin_css' => array('edit', 'create_new'),
-            ),
-        );
-    }
-
-
-    public function caf_updates($update_callbacks)
-    {
-        $update_callbacks[] = array($this, 'attach_evt_message_templates');
-        return $update_callbacks;
-    }
-
-
-    /**
-     * Handles attaching Message Templates to the Event on save.
-     *
-     * @param  EE_Event $event EE event object
-     * @param  array    $data  The request data from the form
-     * @return bool success or fail
-     * @throws EE_Error
-     */
-    public function attach_evt_message_templates($event, $data)
-    {
-        // first we remove all existing relations on the Event for message types.
-        $event->_remove_relations('Message_Template_Group');
-        // now let's just loop through the selected templates and add relations!
-        if (isset($data['event_message_templates_relation'])) {
-            foreach ($data['event_message_templates_relation'] as $grp_ID) {
-                $event->_add_relation_to($grp_ID, 'Message_Template_Group');
-            }
-        }
-        // now save
-        return $event->save();
-    }
-
-
-    /**
-     * @param $event
-     * @param $callback_args
-     * @return string
-     * @throws \EE_Error
-     */
-    public function messages_metabox($event, $callback_args)
-    {
-        // let's get the active messengers (b/c messenger objects have the active message templates)
-        // convert 'evt_id' to 'EVT_ID'
-        $this->_req_data['EVT_ID'] = isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null;
-        $this->_req_data['EVT_ID'] = isset($this->_req_data['post']) && empty($this->_req_data['EVT_ID'])
-            ? $this->_req_data['post']
-            : $this->_req_data['EVT_ID'];
-
-        $this->_req_data['EVT_ID'] = empty($this->_req_data['EVT_ID']) && isset($this->_req_data['evt_id'])
-            ? $this->_req_data['evt_id']
-            : $this->_req_data['EVT_ID'];
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_messengers = $message_resource_manager->active_messengers();
-        $tabs = array();
-
-        // empty messengers?
-        // Note message types will always have at least one available because every messenger has a default message type
-        // associated with it (payment) if no other message types are selected.
-        if (empty($active_messengers)) {
-            $msg_activate_url = EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'settings'),
-                EE_MSG_ADMIN_URL
-            );
-            $error_msg = sprintf(
-                esc_html__(
-                    'There are no active messengers. So no notifications will go out for %1$sany%2$s events.  You will want to %3$sActivate a Messenger%4$s.',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>',
-                '<a href="' . $msg_activate_url . '">',
-                '</a>'
-            );
-            $error_content = '<div class="error"><p>' . $error_msg . '</p></div>';
-            $internal_content = '<div id="messages-error"><p>' . $error_msg . '</p></div>';
-
-            echo $error_content;
-            echo $internal_content;
-            return '';
-        }
-
-        $event_id = isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null;
-        // get content for active messengers
-        foreach ($active_messengers as $name => $messenger) {
-            // first check if there are any active message types for this messenger.
-            $active_mts = $message_resource_manager->get_active_message_types_for_messenger($name);
-            if (empty($active_mts)) {
-                continue;
-            }
-
-            $tab_content = $messenger->get_messenger_admin_page_content(
-                'events',
-                'edit',
-                array('event' => $event_id)
-            );
-
-            if (! empty($tab_content)) {
-                $tabs[ $name ] = $tab_content;
-            }
-        }
-
-
-        // we want this to be tabbed content so let's use the EEH_Tabbed_Content::display helper.
-        $tabbed_content = EEH_Tabbed_Content::display($tabs);
-        if ($tabbed_content instanceof WP_Error) {
-            $tabbed_content = $tabbed_content->get_error_message();
-        }
-
-        $notices = '
+	/**
+	 * espresso_events_Messages_Hooks_Extend constructor.
+	 *
+	 * @param \EE_Admin_Page $admin_page
+	 */
+	public function __construct(EE_Admin_Page $admin_page)
+	{
+		/**
+		 * Add cap restriction ... metaboxes should not show if user does not have the ability to edit_custom_messages
+		 */
+		if (! EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_messages',
+			'messages_events_editor_metabox'
+		)) {
+			return;
+		}
+		add_filter(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			array($this, 'caf_updates'),
+			10
+		);
+		add_action(
+			'AHEE__Extend_Events_Admin_Page___duplicate_event__after',
+			array($this, 'duplicate_custom_message_settings'),
+			10,
+			2
+		);
+		parent::__construct($admin_page);
+	}
+
+
+	/**
+	 * extending the properties set in espresso_events_Messages_Hooks
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _extend_properties()
+	{
+		define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'messages/assets/');
+		$this->_ajax_func = array(
+			'ee_msgs_create_new_custom' => 'create_new_custom',
+		);
+		$this->_metaboxes = array(
+			0 => array(
+				'page_route' => array('edit', 'create_new'),
+				'func'       => 'messages_metabox',
+				'label'      => esc_html__('Notifications', 'event_espresso'),
+				'priority'   => 'high',
+			),
+		);
+
+		// see explanation for layout in EE_Admin_Hooks
+		$this->_scripts_styles = array(
+			'registers' => array(
+				'events_msg_admin'     => array(
+					'url'     => EE_MSGS_EXTEND_ASSETS_URL . 'events_messages_admin.js',
+					'depends' => array('ee-dialog', 'ee-parse-uri', 'ee-serialize-full-array'),
+				),
+				'events_msg_admin_css' => array(
+					'url'  => EE_MSGS_EXTEND_ASSETS_URL . 'ee_msg_events_admin.css',
+					'type' => 'css',
+				),
+			),
+			'enqueues'  => array(
+				'events_msg_admin'     => array('edit', 'create_new'),
+				'events_msg_admin_css' => array('edit', 'create_new'),
+			),
+		);
+	}
+
+
+	public function caf_updates($update_callbacks)
+	{
+		$update_callbacks[] = array($this, 'attach_evt_message_templates');
+		return $update_callbacks;
+	}
+
+
+	/**
+	 * Handles attaching Message Templates to the Event on save.
+	 *
+	 * @param  EE_Event $event EE event object
+	 * @param  array    $data  The request data from the form
+	 * @return bool success or fail
+	 * @throws EE_Error
+	 */
+	public function attach_evt_message_templates($event, $data)
+	{
+		// first we remove all existing relations on the Event for message types.
+		$event->_remove_relations('Message_Template_Group');
+		// now let's just loop through the selected templates and add relations!
+		if (isset($data['event_message_templates_relation'])) {
+			foreach ($data['event_message_templates_relation'] as $grp_ID) {
+				$event->_add_relation_to($grp_ID, 'Message_Template_Group');
+			}
+		}
+		// now save
+		return $event->save();
+	}
+
+
+	/**
+	 * @param $event
+	 * @param $callback_args
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function messages_metabox($event, $callback_args)
+	{
+		// let's get the active messengers (b/c messenger objects have the active message templates)
+		// convert 'evt_id' to 'EVT_ID'
+		$this->_req_data['EVT_ID'] = isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null;
+		$this->_req_data['EVT_ID'] = isset($this->_req_data['post']) && empty($this->_req_data['EVT_ID'])
+			? $this->_req_data['post']
+			: $this->_req_data['EVT_ID'];
+
+		$this->_req_data['EVT_ID'] = empty($this->_req_data['EVT_ID']) && isset($this->_req_data['evt_id'])
+			? $this->_req_data['evt_id']
+			: $this->_req_data['EVT_ID'];
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_messengers = $message_resource_manager->active_messengers();
+		$tabs = array();
+
+		// empty messengers?
+		// Note message types will always have at least one available because every messenger has a default message type
+		// associated with it (payment) if no other message types are selected.
+		if (empty($active_messengers)) {
+			$msg_activate_url = EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'settings'),
+				EE_MSG_ADMIN_URL
+			);
+			$error_msg = sprintf(
+				esc_html__(
+					'There are no active messengers. So no notifications will go out for %1$sany%2$s events.  You will want to %3$sActivate a Messenger%4$s.',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>',
+				'<a href="' . $msg_activate_url . '">',
+				'</a>'
+			);
+			$error_content = '<div class="error"><p>' . $error_msg . '</p></div>';
+			$internal_content = '<div id="messages-error"><p>' . $error_msg . '</p></div>';
+
+			echo $error_content;
+			echo $internal_content;
+			return '';
+		}
+
+		$event_id = isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null;
+		// get content for active messengers
+		foreach ($active_messengers as $name => $messenger) {
+			// first check if there are any active message types for this messenger.
+			$active_mts = $message_resource_manager->get_active_message_types_for_messenger($name);
+			if (empty($active_mts)) {
+				continue;
+			}
+
+			$tab_content = $messenger->get_messenger_admin_page_content(
+				'events',
+				'edit',
+				array('event' => $event_id)
+			);
+
+			if (! empty($tab_content)) {
+				$tabs[ $name ] = $tab_content;
+			}
+		}
+
+
+		// we want this to be tabbed content so let's use the EEH_Tabbed_Content::display helper.
+		$tabbed_content = EEH_Tabbed_Content::display($tabs);
+		if ($tabbed_content instanceof WP_Error) {
+			$tabbed_content = $tabbed_content->get_error_message();
+		}
+
+		$notices = '
 	<div id="espresso-ajax-loading" class="ajax-loader-grey">
 		<span class="ee-spinner ee-spin"></span><span class="hidden">'
-                   . esc_html__('loading...', 'event_espresso')
-                   . '</span>
+				   . esc_html__('loading...', 'event_espresso')
+				   . '</span>
 	</div>
 	<div class="ee-notices"></div>';
 
-        if (defined('DOING_AJAX')) {
-            return $tabbed_content;
-        }
-
-        do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__before_content');
-        echo $notices . '<div class="messages-tabs-content">' . $tabbed_content . '</div>';
-        do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__after_content');
-    }
-
-
-    /**
-     * Ajax callback for ee_msgs_create_new_custom ajax request.
-     * Takes incoming GRP_ID and name and description values from ajax request
-     * to create a new custom template based off of the incoming GRP_ID.
-     *
-     * @access public
-     * @return string either an html string will be returned or a success message
-     * @throws EE_Error
-     */
-    public function create_new_custom()
-    {
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
-            wp_die(__('You don\'t have privileges to do this action', 'event_espresso'));
-        }
-
-        // let's clean up the _POST global a bit for downstream usage of name and description.
-        $_POST['templateName'] = ! empty($this->_req_data['custom_template_args']['MTP_name'])
-            ? $this->_req_data['custom_template_args']['MTP_name']
-            : '';
-        $_POST['templateDescription'] = ! empty($this->_req_data['custom_template_args']['MTP_description'])
-            ? $this->_req_data['custom_template_args']['MTP_description']
-            : '';
-
-
-        // set EE_Admin_Page object (see method details in EE_Admin_Hooks parent
-        $this->_set_page_object();
-
-        // is this a template switch if so EE_Admin_Page child needs this object
-        $this->_page_object->set_hook_object($this);
-
-        $this->_page_object->add_message_template(
-            $this->_req_data['messageType'],
-            $this->_req_data['messenger'],
-            $this->_req_data['group_ID']
-        );
-    }
-
-
-    public function create_new_admin_footer()
-    {
-        $this->edit_admin_footer();
-    }
-
-
-    /**
-     * This is the dynamic method for this class
-     * that will end up hooking into the 'admin_footer' hook on the 'edit_event' route in the events page.
-     *
-     * @return string
-     * @throws DomainException
-     */
-    public function edit_admin_footer()
-    {
-        EEH_Template::display_template(
-            EE_CORE_CAF_ADMIN_EXTEND . 'messages/templates/create_custom_template_form.template.php'
-        );
-    }
-
-
-    /**
-     * Callback for AHEE__Extend_Events_Admin_Page___duplicate_event__after hook used to ensure new events duplicate
-     * the assigned custom message templates.
-     *
-     * @param EE_Event $new_event
-     * @param EE_Event $original_event
-     * @throws EE_Error
-     */
-    public function duplicate_custom_message_settings(EE_Event $new_event, EE_Event $original_event)
-    {
-        $message_template_groups = $original_event->get_many_related('Message_Template_Group');
-        foreach ($message_template_groups as $message_template_group) {
-            $new_event->_add_relation_to($message_template_group, 'Message_Template_Group');
-        }
-        // save new event
-        $new_event->save();
-    }
+		if (defined('DOING_AJAX')) {
+			return $tabbed_content;
+		}
+
+		do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__before_content');
+		echo $notices . '<div class="messages-tabs-content">' . $tabbed_content . '</div>';
+		do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__after_content');
+	}
+
+
+	/**
+	 * Ajax callback for ee_msgs_create_new_custom ajax request.
+	 * Takes incoming GRP_ID and name and description values from ajax request
+	 * to create a new custom template based off of the incoming GRP_ID.
+	 *
+	 * @access public
+	 * @return string either an html string will be returned or a success message
+	 * @throws EE_Error
+	 */
+	public function create_new_custom()
+	{
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
+			wp_die(__('You don\'t have privileges to do this action', 'event_espresso'));
+		}
+
+		// let's clean up the _POST global a bit for downstream usage of name and description.
+		$_POST['templateName'] = ! empty($this->_req_data['custom_template_args']['MTP_name'])
+			? $this->_req_data['custom_template_args']['MTP_name']
+			: '';
+		$_POST['templateDescription'] = ! empty($this->_req_data['custom_template_args']['MTP_description'])
+			? $this->_req_data['custom_template_args']['MTP_description']
+			: '';
+
+
+		// set EE_Admin_Page object (see method details in EE_Admin_Hooks parent
+		$this->_set_page_object();
+
+		// is this a template switch if so EE_Admin_Page child needs this object
+		$this->_page_object->set_hook_object($this);
+
+		$this->_page_object->add_message_template(
+			$this->_req_data['messageType'],
+			$this->_req_data['messenger'],
+			$this->_req_data['group_ID']
+		);
+	}
+
+
+	public function create_new_admin_footer()
+	{
+		$this->edit_admin_footer();
+	}
+
+
+	/**
+	 * This is the dynamic method for this class
+	 * that will end up hooking into the 'admin_footer' hook on the 'edit_event' route in the events page.
+	 *
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function edit_admin_footer()
+	{
+		EEH_Template::display_template(
+			EE_CORE_CAF_ADMIN_EXTEND . 'messages/templates/create_custom_template_form.template.php'
+		);
+	}
+
+
+	/**
+	 * Callback for AHEE__Extend_Events_Admin_Page___duplicate_event__after hook used to ensure new events duplicate
+	 * the assigned custom message templates.
+	 *
+	 * @param EE_Event $new_event
+	 * @param EE_Event $original_event
+	 * @throws EE_Error
+	 */
+	public function duplicate_custom_message_settings(EE_Event $new_event, EE_Event $original_event)
+	{
+		$message_template_groups = $original_event->get_many_related('Message_Template_Group');
+		foreach ($message_template_groups as $message_template_group) {
+			$new_event->_add_relation_to($message_template_group, 'Message_Template_Group');
+		}
+		// save new event
+		$new_event->save();
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -22,7 +22,7 @@ 
         /**
          * Add cap restriction ... metaboxes should not show if user does not have the ability to edit_custom_messages
          */
-        if (! EE_Registry::instance()->CAP->current_user_can(
+        if ( ! EE_Registry::instance()->CAP->current_user_can(
             'ee_edit_messages',
             'messages_events_editor_metabox'
         )) {
@@ -51,7 +51,7 @@ 
      */
     protected function _extend_properties()
     {
-        define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'messages/assets/');
+        define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'messages/assets/');
         $this->_ajax_func = array(
             'ee_msgs_create_new_custom' => 'create_new_custom',
         );
@@ -68,11 +68,11 @@ 
         $this->_scripts_styles = array(
             'registers' => array(
                 'events_msg_admin'     => array(
-                    'url'     => EE_MSGS_EXTEND_ASSETS_URL . 'events_messages_admin.js',
+                    'url'     => EE_MSGS_EXTEND_ASSETS_URL.'events_messages_admin.js',
                     'depends' => array('ee-dialog', 'ee-parse-uri', 'ee-serialize-full-array'),
                 ),
                 'events_msg_admin_css' => array(
-                    'url'  => EE_MSGS_EXTEND_ASSETS_URL . 'ee_msg_events_admin.css',
+                    'url'  => EE_MSGS_EXTEND_ASSETS_URL.'ee_msg_events_admin.css',
                     'type' => 'css',
                 ),
             ),
@@ -152,11 +152,11 @@ 
                 ),
                 '<strong>',
                 '</strong>',
-                '<a href="' . $msg_activate_url . '">',
+                '<a href="'.$msg_activate_url.'">',
                 '</a>'
             );
-            $error_content = '<div class="error"><p>' . $error_msg . '</p></div>';
-            $internal_content = '<div id="messages-error"><p>' . $error_msg . '</p></div>';
+            $error_content = '<div class="error"><p>'.$error_msg.'</p></div>';
+            $internal_content = '<div id="messages-error"><p>'.$error_msg.'</p></div>';
 
             echo $error_content;
             echo $internal_content;
@@ -178,8 +178,8 @@ 
                 array('event' => $event_id)
             );
 
-            if (! empty($tab_content)) {
-                $tabs[ $name ] = $tab_content;
+            if ( ! empty($tab_content)) {
+                $tabs[$name] = $tab_content;
             }
         }
 
@@ -203,7 +203,7 @@ 
         }
 
         do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__before_content');
-        echo $notices . '<div class="messages-tabs-content">' . $tabbed_content . '</div>';
+        echo $notices.'<div class="messages-tabs-content">'.$tabbed_content.'</div>';
         do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__after_content');
     }
 
@@ -219,7 +219,7 @@ 
      */
     public function create_new_custom()
     {
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
             wp_die(__('You don\'t have privileges to do this action', 'event_espresso'));
         }
 
@@ -262,7 +262,7 @@ 
     public function edit_admin_footer()
     {
         EEH_Template::display_template(
-            EE_CORE_CAF_ADMIN_EXTEND . 'messages/templates/create_custom_template_form.template.php'
+            EE_CORE_CAF_ADMIN_EXTEND.'messages/templates/create_custom_template_form.template.php'
         );
     }