eventespresso / event-espresso-core

core/db_models/EEM_Message.model.php

Spacing +8 added lines, -8 removed lines

@@ -126,7 +126,7 @@ 
             self::priority_low    => esc_html__('low', 'event_espresso'),
         );
 
-        $this->_fields          = array(
+        $this->_fields = array(
             'Message' => array(
                 'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
                 'MSG_token'          => new EE_Plain_Text_Field(
@@ -436,7 +436,7 @@ 
                         );
                         break;
                     default:
-                        $query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
+                        $query_params[0]['AND**filter_by']['OR**filter_by_'.$request_key][$model_name.'.'.$request_key] = $request_value;
                         break;
                 }
             }
@@ -499,8 +499,8 @@ 
         if ($label_parts) {
             // prepend to the last element of $label_parts an "and".
             if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
+                $label_parts_index_to_prepend = count($label_parts) - 1;
+                $label_parts[$label_parts_index_to_prepend] = 'and'.$label_parts[$label_parts_index_to_prepend];
             }
 
             $pretty_label .= sprintf(
@@ -560,7 +560,7 @@ 
             $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
         }
 
-        if (! is_null($set_debug)) {
+        if ( ! is_null($set_debug)) {
             $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
         }
 
@@ -627,13 +627,13 @@ 
             )
         );
 
-        if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
+        if ( ! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
             global $wpdb;
             $number_deleted = $wpdb->query('
                 DELETE
-                FROM ' . $this->table() . '
+                FROM ' . $this->table().'
                 WHERE
-                    MSG_ID IN (' . implode(",", $message_ids_to_delete) . ')
+                    MSG_ID IN (' . implode(",", $message_ids_to_delete).')
             ');
         }
 

Indentation +640 added lines, -640 removed lines

@@ -12,649 +12,649 @@
  */
 class EEM_Message extends EEM_Base implements EEI_Query_Filter
 {
-    // private instance of the Message object
-    protected static $_instance = null;
-
-
-    /**
-     * This priority indicates a message should be generated and sent ASAP
-     *
-     * @type int
-     */
-    const priority_high = 10;
-
-
-    /**
-     * This priority indicates a message should be generated ASAP and queued for sending.
-     *
-     * @type
-     */
-    const priority_medium = 20;
-
-
-    /**
-     * This priority indicates a message should be queued for generating.
-     *
-     * @type int
-     */
-    const priority_low = 30;
-
-
-    /**
-     * indicates this message was sent at the time modified
-     */
-    const status_sent = 'MSN';
-
-
-    /**
-     * indicates this message is waiting to be sent
-     */
-    const status_idle = 'MID';
-
-
-    /**
-     * indicates an attempt was a made to send this message
-     * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
-     * appear to the end user.
-     */
-    const status_failed = 'MFL';
-
-
-    /**
-     * indicates the message has been flagged for resending (at the time modified).
-     */
-    const status_resend = 'MRS';
-
-
-    /**
-     * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
-     * this status when added to the queue.
-     */
-    const status_incomplete = 'MIC';
-
-
-    /**
-     * Indicates everything was generated fine for the message, however, the messenger was unable to send.
-     * This status means that its possible to retry sending the message.
-     */
-    const status_retry = 'MRT';
-
-
-    /**
-     * This is used for more informational messages that may not indicate anything is broken but still cannot be
-     * generated or sent correctly. An example of a message that would get flagged this way would be when a not
-     * approved message was queued for generation, but at time of generation, the attached registration(s) are
-     * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
-     * in the db and be viewable in the message activity list table when the messages system is in debug mode.
-     *
-     * @see EEM_Message::debug()
-     */
-    const status_debug_only = 'MDO';
-
-
-    /**
-     * This status is given to messages it is processed by the messenger send method.
-     * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
-     * indicative of a PHP timeout or memory limit issue.
-     */
-    const status_messenger_executing = 'MEX';
-
-
-    /**
-     *    Private constructor to prevent direct creation.
-     *
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
-     *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
-     *                         the date time model field objects.  Default is null (and will be assumed using the set
-     *                         timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Message', 'event_espresso');
-        $this->plural_item   = esc_html__('Messages', 'event_espresso');
-
-        $this->_tables = array(
-            'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
-        );
-
-        $allowed_priority = array(
-            self::priority_high   => esc_html__('high', 'event_espresso'),
-            self::priority_medium => esc_html__('medium', 'event_espresso'),
-            self::priority_low    => esc_html__('low', 'event_espresso'),
-        );
-
-        $this->_fields          = array(
-            'Message' => array(
-                'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
-                'MSG_token'          => new EE_Plain_Text_Field(
-                    'MSG_token',
-                    esc_html__(
-                        'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
-                        'event_espresso'
-                    ),
-                    false,
-                    EEH_URL::generate_unique_token()
-                ),
-                'GRP_ID'             => new EE_Foreign_Key_Int_Field(
-                    'GRP_ID',
-                    esc_html__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
-                    true,
-                    0,
-                    'Message_Template_Group'
-                ),
-                'TXN_ID'             => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__(
-                        'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
-                        'event_espresso'
-                    ),
-                    true,
-                    0,
-                    'Transaction'
-                ),
-                'MSG_messenger'      => new EE_Plain_Text_Field(
-                    'MSG_messenger',
-                    esc_html__(
-                        'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
-                        'event_espresso'
-                    ),
-                    false,
-                    'email'
-                ),
-                'MSG_message_type'   => new EE_Plain_Text_Field(
-                    'MSG_message_type',
-                    esc_html__('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
-                    false,
-                    'receipt'
-                ),
-                'MSG_context'        => new EE_Plain_Text_Field('MSG_context', esc_html__('Context', 'event_espresso'), false),
-                'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
-                    'MSG_recipient_ID',
-                    esc_html__('Recipient ID', 'event_espresso'),
-                    true,
-                    null,
-                    array('Registration', 'Attendee', 'WP_User')
-                ),
-                'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
-                    'MSG_recipient_type',
-                    esc_html__('Recipient Type', 'event_espresso'),
-                    true,
-                    null,
-                    array('Registration', 'Attendee', 'WP_User')
-                ),
-                'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_content',
-                    esc_html__('Content', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_to',
-                    esc_html__('Address To', 'event_espresso'),
-                    true
-                ),
-                'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_from',
-                    esc_html__('Address From', 'event_espresso'),
-                    true
-                ),
-                'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_subject',
-                    esc_html__('Subject', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_priority'       => new EE_Enum_Integer_Field(
-                    'MSG_priority',
-                    esc_html__('Priority', 'event_espresso'),
-                    false,
-                    self::priority_low,
-                    $allowed_priority
-                ),
-                'STS_ID'             => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    esc_html__('Status', 'event_espresso'),
-                    false,
-                    self::status_incomplete,
-                    'Status'
-                ),
-                'MSG_created'        => new EE_Datetime_Field(
-                    'MSG_created',
-                    esc_html__('Created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'MSG_modified'       => new EE_Datetime_Field(
-                    'MSG_modified',
-                    esc_html__('Modified', 'event_espresso'),
-                    true,
-                    EE_Datetime_Field::now
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Attendee'               => new EE_Belongs_To_Any_Relation(),
-            'Registration'           => new EE_Belongs_To_Any_Relation(),
-            'WP_User'                => new EE_Belongs_To_Any_Relation(),
-            'Message_Template_Group' => new EE_Belongs_To_Relation(),
-            'Transaction'            => new EE_Belongs_To_Relation(),
-        );
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return EE_Message
-     * @throws EE_Error
-     */
-    public function create_default_object()
-    {
-        /** @type EE_Message $message */
-        $message = parent::create_default_object();
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values
-     * @return EE_Message
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        /** @type EE_Message $message */
-        $message = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given attendee.
-     *
-     * @param EE_Attendee|int $attendee
-     * @param string          $message_type the message type slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function message_sent_for_attendee($attendee, $message_type)
-    {
-        $attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
-        return $this->exists(array(
-            array(
-                'Attendee.ATT_ID'  => $attendee_ID,
-                'MSG_message_type' => $message_type,
-                'STS_ID'           => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given registration
-     *
-     * @param EE_Registration|int $registration
-     * @param string              $message_type the message type slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function message_sent_for_registration($registration, $message_type)
-    {
-        $registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
-        return $this->exists(array(
-            array(
-                'Registration.REG_ID' => $registrationID,
-                'MSG_message_type'    => $message_type,
-                'STS_ID'              => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * This retrieves an EE_Message object from the db matching the given token string.
-     *
-     * @param string $token
-     * @return EE_Message
-     * @throws EE_Error
-     */
-    public function get_one_by_token($token)
-    {
-        return $this->get_one(array(
-            array(
-                'MSG_token' => $token,
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns stati that indicate the message HAS been sent
-     *
-     * @return array of strings for possible stati
-     */
-    public function stati_indicating_sent()
-    {
-        return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
-    }
-
-
-    /**
-     * Returns stati that indicate the message is waiting to be sent.
-     *
-     * @return array of strings for possible stati.
-     */
-    public function stati_indicating_to_send()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__stati_indicating_to_send',
-            array(self::status_idle, self::status_resend)
-        );
-    }
-
-
-    /**
-     * Returns stati that indicate the message has failed sending
-     *
-     * @return array  array of strings for possible stati.
-     */
-    public function stati_indicating_failed_sending()
-    {
-        $failed_stati = array(
-            self::status_failed,
-            self::status_retry,
-            self::status_messenger_executing,
-        );
-        // if WP_DEBUG is set, then let's include debug_only fails
-        if (WP_DEBUG) {
-            $failed_stati[] = self::status_debug_only;
-        }
-        return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
-    }
-
-
-    /**
-     * Returns filterable array of all EEM_Message statuses.
-     *
-     * @return array
-     */
-    public function all_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__all_statuses',
-            array(
-                EEM_Message::status_sent,
-                EEM_Message::status_incomplete,
-                EEM_Message::status_idle,
-                EEM_Message::status_resend,
-                EEM_Message::status_retry,
-                EEM_Message::status_failed,
-                EEM_Message::status_messenger_executing,
-                EEM_Message::status_debug_only,
-            )
-        );
-    }
-
-    /**
-     * Detects any specific query variables in the request and uses those to setup appropriate
-     * filter for any queries.
-     *
-     * @return array
-     */
-    public function filter_by_query_params()
-    {
-        /** @var RequestInterface $request */
-        $request = EEM_Base::$loader->getShared(RequestInterface::class);
-        // expected possible query_vars, the key in this array matches an expected key in the request,
-        // the value, matches the corresponding EEM_Base child reference.
-        $expected_vars   = $this->_expected_vars_for_query_inject();
-        $query_params[0] = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $request_value = $request->getRequestParam($request_key);
-            if ($request_value) {
-                // special case
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
-                            'Transaction.Registration.REG_ID' => $request_value,
-                        );
-                        break;
-                    case 'EVT_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
-                            'Transaction.Registration.EVT_ID' => $request_value,
-                        );
-                        break;
-                    default:
-                        $query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
-                        break;
-                }
-            }
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_pretty_label_for_results()
-    {
-        /** @var RequestInterface $request */
-        $request = EEM_Base::$loader->getShared(RequestInterface::class);
-        $expected_vars = $this->_expected_vars_for_query_inject();
-        $pretty_label  = '';
-        $label_parts   = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $model_name = strpos($model_name, 'EEM_', true) === 0 ? $model_name : "EEM_{$model_name}";
-            $model = EEM_Base::$loader->getShared($model_name);
-            $model_field_value = $request->getRequestParam($request_key);
-            if ($model instanceof EEM_Base && $model_field_value !== '') {
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Registration with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'ATT_ID':
-                        /** @var EE_Attendee $attendee */
-                        $attendee      = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $attendee instanceof EE_Attendee
-                            ? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
-                            : sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'ID':
-                        /** @var EE_WP_User $wpUser */
-                        $wpUser        = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $wpUser instanceof EE_WP_User
-                            ? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
-                            : sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'TXN_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Transaction with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'EVT_ID':
-                        /** @var EE_Event $Event */
-                        $Event         = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $Event instanceof EE_Event
-                            ? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
-                            : sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                }
-            }
-        }
-
-        if ($label_parts) {
-            // prepend to the last element of $label_parts an "and".
-            if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
-            }
-
-            $pretty_label .= sprintf(
-                esc_html_x(
-                    'Showing messages for %s',
-                    'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
-                    'event_espresso'
-                ),
-                implode(', ', $label_parts)
-            );
-        }
-        return $pretty_label;
-    }
-
-
-    /**
-     * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
-     * The array is in the format:
-     * array(
-     *  {$field_name} => {$model_name}
-     * );
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    protected function _expected_vars_for_query_inject()
-    {
-        return array(
-            '_REG_ID' => 'Registration',
-            'ATT_ID'  => 'Attendee',
-            'ID'      => 'WP_User',
-            'TXN_ID'  => 'Transaction',
-            'EVT_ID'  => 'Event',
-        );
-    }
-
-
-    /**
-     * This returns whether EEM_Message is in debug mode or not.
-     * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
-     * generating/sending messages. Debug mode can be set by either:
-     * 1. Sending in a value for the $set_debug argument
-     * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
-     * 3. Overriding the above via the provided filter.
-     *
-     * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
-     *                                  provided boolean. When no argument is provided (default null) then the debug
-     *                                  mode will be returned.
-     * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
-     */
-    public static function debug($set_debug = null)
-    {
-        static $is_debugging = null;
-
-        // initialize (use constant if set).
-        if (is_null($set_debug) && is_null($is_debugging)) {
-            $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
-        }
-
-        if (! is_null($set_debug)) {
-            $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
-        }
-
-        // return filtered value
-        return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
-    }
-
-
-    /**
-     * Deletes old messages meeting certain criteria for removal from the database.
-     * By default, this will delete messages that:
-     * - are older than the value of the delete_threshold in months.
-     * - have a STS_ID other than EEM_Message::status_idle
-     *
-     * @param int $delete_threshold This integer will be used to set the boundary for what messages are deleted in
-     *                              months.
-     * @return bool|false|int Either the number of records affected or false if there was an error (you can call
-     *                              $wpdb->last_error to find out what the error was.
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function delete_old_messages($delete_threshold = 6)
-    {
-        $number_deleted = 0;
-        /**
-         * Allows code to change the boundary for what messages are kept.
-         * Uses the value of the `delete_threshold` variable by default.
-         *
-         * @param int $seconds seconds that will be subtracted from the timestamp for now.
-         * @return int
-         */
-        $time_to_leave_alone = absint(
-            apply_filters(
-                'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
-                ((int) $delete_threshold) * MONTH_IN_SECONDS
-            )
-        );
-
-
-        /**
-         * Allows code to change what message stati are ignored when deleting.
-         * Defaults to only ignore EEM_Message::status_idle messages.
-         *
-         * @param string $message_stati_to_keep  An array of message statuses that will be ignored when deleting.
-         */
-        $message_stati_to_keep = (array) apply_filters(
-            'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
-            array(
-                EEM_Message::status_idle
-            )
-        );
-
-        // first get all the ids of messages being deleted
-        $message_ids_to_delete = EEM_Message::instance()->get_col(
-            array(
-                0 => array(
-                    'STS_ID' => array('NOT_IN', $message_stati_to_keep),
-                    'MSG_modified' => array('<', time() - $time_to_leave_alone)
-                ),
-                'limit' => apply_filters(
-                    'EEM_Message__delete_old_messages__limit',
-                    2000,
-                    $delete_threshold
-                )
-            )
-        );
-
-        if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
-            global $wpdb;
-            $number_deleted = $wpdb->query('
+	// private instance of the Message object
+	protected static $_instance = null;
+
+
+	/**
+	 * This priority indicates a message should be generated and sent ASAP
+	 *
+	 * @type int
+	 */
+	const priority_high = 10;
+
+
+	/**
+	 * This priority indicates a message should be generated ASAP and queued for sending.
+	 *
+	 * @type
+	 */
+	const priority_medium = 20;
+
+
+	/**
+	 * This priority indicates a message should be queued for generating.
+	 *
+	 * @type int
+	 */
+	const priority_low = 30;
+
+
+	/**
+	 * indicates this message was sent at the time modified
+	 */
+	const status_sent = 'MSN';
+
+
+	/**
+	 * indicates this message is waiting to be sent
+	 */
+	const status_idle = 'MID';
+
+
+	/**
+	 * indicates an attempt was a made to send this message
+	 * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
+	 * appear to the end user.
+	 */
+	const status_failed = 'MFL';
+
+
+	/**
+	 * indicates the message has been flagged for resending (at the time modified).
+	 */
+	const status_resend = 'MRS';
+
+
+	/**
+	 * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
+	 * this status when added to the queue.
+	 */
+	const status_incomplete = 'MIC';
+
+
+	/**
+	 * Indicates everything was generated fine for the message, however, the messenger was unable to send.
+	 * This status means that its possible to retry sending the message.
+	 */
+	const status_retry = 'MRT';
+
+
+	/**
+	 * This is used for more informational messages that may not indicate anything is broken but still cannot be
+	 * generated or sent correctly. An example of a message that would get flagged this way would be when a not
+	 * approved message was queued for generation, but at time of generation, the attached registration(s) are
+	 * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
+	 * in the db and be viewable in the message activity list table when the messages system is in debug mode.
+	 *
+	 * @see EEM_Message::debug()
+	 */
+	const status_debug_only = 'MDO';
+
+
+	/**
+	 * This status is given to messages it is processed by the messenger send method.
+	 * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
+	 * indicative of a PHP timeout or memory limit issue.
+	 */
+	const status_messenger_executing = 'MEX';
+
+
+	/**
+	 *    Private constructor to prevent direct creation.
+	 *
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
+	 *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
+	 *                         the date time model field objects.  Default is null (and will be assumed using the set
+	 *                         timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Message', 'event_espresso');
+		$this->plural_item   = esc_html__('Messages', 'event_espresso');
+
+		$this->_tables = array(
+			'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
+		);
+
+		$allowed_priority = array(
+			self::priority_high   => esc_html__('high', 'event_espresso'),
+			self::priority_medium => esc_html__('medium', 'event_espresso'),
+			self::priority_low    => esc_html__('low', 'event_espresso'),
+		);
+
+		$this->_fields          = array(
+			'Message' => array(
+				'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
+				'MSG_token'          => new EE_Plain_Text_Field(
+					'MSG_token',
+					esc_html__(
+						'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
+						'event_espresso'
+					),
+					false,
+					EEH_URL::generate_unique_token()
+				),
+				'GRP_ID'             => new EE_Foreign_Key_Int_Field(
+					'GRP_ID',
+					esc_html__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
+					true,
+					0,
+					'Message_Template_Group'
+				),
+				'TXN_ID'             => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__(
+						'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
+						'event_espresso'
+					),
+					true,
+					0,
+					'Transaction'
+				),
+				'MSG_messenger'      => new EE_Plain_Text_Field(
+					'MSG_messenger',
+					esc_html__(
+						'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
+						'event_espresso'
+					),
+					false,
+					'email'
+				),
+				'MSG_message_type'   => new EE_Plain_Text_Field(
+					'MSG_message_type',
+					esc_html__('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
+					false,
+					'receipt'
+				),
+				'MSG_context'        => new EE_Plain_Text_Field('MSG_context', esc_html__('Context', 'event_espresso'), false),
+				'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
+					'MSG_recipient_ID',
+					esc_html__('Recipient ID', 'event_espresso'),
+					true,
+					null,
+					array('Registration', 'Attendee', 'WP_User')
+				),
+				'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
+					'MSG_recipient_type',
+					esc_html__('Recipient Type', 'event_espresso'),
+					true,
+					null,
+					array('Registration', 'Attendee', 'WP_User')
+				),
+				'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_content',
+					esc_html__('Content', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
+					'MSG_to',
+					esc_html__('Address To', 'event_espresso'),
+					true
+				),
+				'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
+					'MSG_from',
+					esc_html__('Address From', 'event_espresso'),
+					true
+				),
+				'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_subject',
+					esc_html__('Subject', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_priority'       => new EE_Enum_Integer_Field(
+					'MSG_priority',
+					esc_html__('Priority', 'event_espresso'),
+					false,
+					self::priority_low,
+					$allowed_priority
+				),
+				'STS_ID'             => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					esc_html__('Status', 'event_espresso'),
+					false,
+					self::status_incomplete,
+					'Status'
+				),
+				'MSG_created'        => new EE_Datetime_Field(
+					'MSG_created',
+					esc_html__('Created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'MSG_modified'       => new EE_Datetime_Field(
+					'MSG_modified',
+					esc_html__('Modified', 'event_espresso'),
+					true,
+					EE_Datetime_Field::now
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Attendee'               => new EE_Belongs_To_Any_Relation(),
+			'Registration'           => new EE_Belongs_To_Any_Relation(),
+			'WP_User'                => new EE_Belongs_To_Any_Relation(),
+			'Message_Template_Group' => new EE_Belongs_To_Relation(),
+			'Transaction'            => new EE_Belongs_To_Relation(),
+		);
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return EE_Message
+	 * @throws EE_Error
+	 */
+	public function create_default_object()
+	{
+		/** @type EE_Message $message */
+		$message = parent::create_default_object();
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values
+	 * @return EE_Message
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		/** @type EE_Message $message */
+		$message = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given attendee.
+	 *
+	 * @param EE_Attendee|int $attendee
+	 * @param string          $message_type the message type slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function message_sent_for_attendee($attendee, $message_type)
+	{
+		$attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
+		return $this->exists(array(
+			array(
+				'Attendee.ATT_ID'  => $attendee_ID,
+				'MSG_message_type' => $message_type,
+				'STS_ID'           => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given registration
+	 *
+	 * @param EE_Registration|int $registration
+	 * @param string              $message_type the message type slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function message_sent_for_registration($registration, $message_type)
+	{
+		$registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
+		return $this->exists(array(
+			array(
+				'Registration.REG_ID' => $registrationID,
+				'MSG_message_type'    => $message_type,
+				'STS_ID'              => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * This retrieves an EE_Message object from the db matching the given token string.
+	 *
+	 * @param string $token
+	 * @return EE_Message
+	 * @throws EE_Error
+	 */
+	public function get_one_by_token($token)
+	{
+		return $this->get_one(array(
+			array(
+				'MSG_token' => $token,
+			),
+		));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message HAS been sent
+	 *
+	 * @return array of strings for possible stati
+	 */
+	public function stati_indicating_sent()
+	{
+		return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message is waiting to be sent.
+	 *
+	 * @return array of strings for possible stati.
+	 */
+	public function stati_indicating_to_send()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__stati_indicating_to_send',
+			array(self::status_idle, self::status_resend)
+		);
+	}
+
+
+	/**
+	 * Returns stati that indicate the message has failed sending
+	 *
+	 * @return array  array of strings for possible stati.
+	 */
+	public function stati_indicating_failed_sending()
+	{
+		$failed_stati = array(
+			self::status_failed,
+			self::status_retry,
+			self::status_messenger_executing,
+		);
+		// if WP_DEBUG is set, then let's include debug_only fails
+		if (WP_DEBUG) {
+			$failed_stati[] = self::status_debug_only;
+		}
+		return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
+	}
+
+
+	/**
+	 * Returns filterable array of all EEM_Message statuses.
+	 *
+	 * @return array
+	 */
+	public function all_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__all_statuses',
+			array(
+				EEM_Message::status_sent,
+				EEM_Message::status_incomplete,
+				EEM_Message::status_idle,
+				EEM_Message::status_resend,
+				EEM_Message::status_retry,
+				EEM_Message::status_failed,
+				EEM_Message::status_messenger_executing,
+				EEM_Message::status_debug_only,
+			)
+		);
+	}
+
+	/**
+	 * Detects any specific query variables in the request and uses those to setup appropriate
+	 * filter for any queries.
+	 *
+	 * @return array
+	 */
+	public function filter_by_query_params()
+	{
+		/** @var RequestInterface $request */
+		$request = EEM_Base::$loader->getShared(RequestInterface::class);
+		// expected possible query_vars, the key in this array matches an expected key in the request,
+		// the value, matches the corresponding EEM_Base child reference.
+		$expected_vars   = $this->_expected_vars_for_query_inject();
+		$query_params[0] = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$request_value = $request->getRequestParam($request_key);
+			if ($request_value) {
+				// special case
+				switch ($request_key) {
+					case '_REG_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
+							'Transaction.Registration.REG_ID' => $request_value,
+						);
+						break;
+					case 'EVT_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
+							'Transaction.Registration.EVT_ID' => $request_value,
+						);
+						break;
+					default:
+						$query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
+						break;
+				}
+			}
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_pretty_label_for_results()
+	{
+		/** @var RequestInterface $request */
+		$request = EEM_Base::$loader->getShared(RequestInterface::class);
+		$expected_vars = $this->_expected_vars_for_query_inject();
+		$pretty_label  = '';
+		$label_parts   = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$model_name = strpos($model_name, 'EEM_', true) === 0 ? $model_name : "EEM_{$model_name}";
+			$model = EEM_Base::$loader->getShared($model_name);
+			$model_field_value = $request->getRequestParam($request_key);
+			if ($model instanceof EEM_Base && $model_field_value !== '') {
+				switch ($request_key) {
+					case '_REG_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Registration with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'ATT_ID':
+						/** @var EE_Attendee $attendee */
+						$attendee      = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $attendee instanceof EE_Attendee
+							? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
+							: sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'ID':
+						/** @var EE_WP_User $wpUser */
+						$wpUser        = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $wpUser instanceof EE_WP_User
+							? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
+							: sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'TXN_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Transaction with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'EVT_ID':
+						/** @var EE_Event $Event */
+						$Event         = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $Event instanceof EE_Event
+							? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
+							: sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
+						break;
+				}
+			}
+		}
+
+		if ($label_parts) {
+			// prepend to the last element of $label_parts an "and".
+			if (count($label_parts) > 1) {
+				$label_parts_index_to_prepend               = count($label_parts) - 1;
+				$label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
+			}
+
+			$pretty_label .= sprintf(
+				esc_html_x(
+					'Showing messages for %s',
+					'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
+					'event_espresso'
+				),
+				implode(', ', $label_parts)
+			);
+		}
+		return $pretty_label;
+	}
+
+
+	/**
+	 * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
+	 * The array is in the format:
+	 * array(
+	 *  {$field_name} => {$model_name}
+	 * );
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	protected function _expected_vars_for_query_inject()
+	{
+		return array(
+			'_REG_ID' => 'Registration',
+			'ATT_ID'  => 'Attendee',
+			'ID'      => 'WP_User',
+			'TXN_ID'  => 'Transaction',
+			'EVT_ID'  => 'Event',
+		);
+	}
+
+
+	/**
+	 * This returns whether EEM_Message is in debug mode or not.
+	 * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
+	 * generating/sending messages. Debug mode can be set by either:
+	 * 1. Sending in a value for the $set_debug argument
+	 * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
+	 * 3. Overriding the above via the provided filter.
+	 *
+	 * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
+	 *                                  provided boolean. When no argument is provided (default null) then the debug
+	 *                                  mode will be returned.
+	 * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
+	 */
+	public static function debug($set_debug = null)
+	{
+		static $is_debugging = null;
+
+		// initialize (use constant if set).
+		if (is_null($set_debug) && is_null($is_debugging)) {
+			$is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
+		}
+
+		if (! is_null($set_debug)) {
+			$is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
+		}
+
+		// return filtered value
+		return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
+	}
+
+
+	/**
+	 * Deletes old messages meeting certain criteria for removal from the database.
+	 * By default, this will delete messages that:
+	 * - are older than the value of the delete_threshold in months.
+	 * - have a STS_ID other than EEM_Message::status_idle
+	 *
+	 * @param int $delete_threshold This integer will be used to set the boundary for what messages are deleted in
+	 *                              months.
+	 * @return bool|false|int Either the number of records affected or false if there was an error (you can call
+	 *                              $wpdb->last_error to find out what the error was.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function delete_old_messages($delete_threshold = 6)
+	{
+		$number_deleted = 0;
+		/**
+		 * Allows code to change the boundary for what messages are kept.
+		 * Uses the value of the `delete_threshold` variable by default.
+		 *
+		 * @param int $seconds seconds that will be subtracted from the timestamp for now.
+		 * @return int
+		 */
+		$time_to_leave_alone = absint(
+			apply_filters(
+				'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
+				((int) $delete_threshold) * MONTH_IN_SECONDS
+			)
+		);
+
+
+		/**
+		 * Allows code to change what message stati are ignored when deleting.
+		 * Defaults to only ignore EEM_Message::status_idle messages.
+		 *
+		 * @param string $message_stati_to_keep  An array of message statuses that will be ignored when deleting.
+		 */
+		$message_stati_to_keep = (array) apply_filters(
+			'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
+			array(
+				EEM_Message::status_idle
+			)
+		);
+
+		// first get all the ids of messages being deleted
+		$message_ids_to_delete = EEM_Message::instance()->get_col(
+			array(
+				0 => array(
+					'STS_ID' => array('NOT_IN', $message_stati_to_keep),
+					'MSG_modified' => array('<', time() - $time_to_leave_alone)
+				),
+				'limit' => apply_filters(
+					'EEM_Message__delete_old_messages__limit',
+					2000,
+					$delete_threshold
+				)
+			)
+		);
+
+		if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
+			global $wpdb;
+			$number_deleted = $wpdb->query('
                 DELETE
                 FROM ' . $this->table() . '
                 WHERE
                     MSG_ID IN (' . implode(",", $message_ids_to_delete) . ')
             ');
-        }
-
-        /**
-         * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
-         * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
-         * below.
-         */
-        if ($number_deleted !== false) {
-            do_action('AHEE__EEM_Message__delete_old_messages__after_successful_deletion', $message_ids_to_delete, $number_deleted);
-        } else {
-            do_action('AHEE__EEM_Message__delete_old_messages__after_deletion_fail', $message_ids_to_delete, $number_deleted);
-        }
-        return $number_deleted;
-    }
+		}
+
+		/**
+		 * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
+		 * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
+		 * below.
+		 */
+		if ($number_deleted !== false) {
+			do_action('AHEE__EEM_Message__delete_old_messages__after_successful_deletion', $message_ids_to_delete, $number_deleted);
+		} else {
+			do_action('AHEE__EEM_Message__delete_old_messages__after_deletion_fail', $message_ids_to_delete, $number_deleted);
+		}
+		return $number_deleted;
+	}
 }

core/db_models/fields/EE_Field_With_Model_Name.php

Spacing +2 added lines, -2 removed lines

@@ -79,10 +79,10 @@
         $model_names = [];
         if (is_array($this->_model_name_pointed_to)) {
             foreach ($this->_model_name_pointed_to as $model_name) {
-                $model_names[] = "EE_" . $model_name;
+                $model_names[] = "EE_".$model_name;
             }
         } else {
-            $model_names = ["EE_" . $this->_model_name_pointed_to];
+            $model_names = ["EE_".$this->_model_name_pointed_to];
         }
         return $model_names;
     }

Indentation +80 added lines, -80 removed lines

@@ -8,94 +8,94 @@
  */
 abstract class EE_Field_With_Model_Name extends EE_Model_Field_Base
 {
-    /**
-     * Usually the name of a single model. However, as in the case for custom post types,
-     * it can actually be an array of models
-     *
-     * @var string[]
-     */
-    protected $_model_name_pointed_to;
+	/**
+	 * Usually the name of a single model. However, as in the case for custom post types,
+	 * it can actually be an array of models
+	 *
+	 * @var string[]
+	 */
+	protected $_model_name_pointed_to;
 
 
-    /**
-     * @param string          $table_column  name of column for field
-     * @param string          $nicename      should be internationalized with __('blah','event_espresso')
-     * @param boolean         $nullable
-     * @param int|string      $default_value data type should match field type
-     * @param string|string[] $model_name    eg 'Event','Answer','Term', etc.
-     *                                       Basically its the model class's name without the "EEM_"
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
-    {
-        $this->_model_name_pointed_to = (array) $model_name;
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-    }
+	/**
+	 * @param string          $table_column  name of column for field
+	 * @param string          $nicename      should be internationalized with __('blah','event_espresso')
+	 * @param boolean         $nullable
+	 * @param int|string      $default_value data type should match field type
+	 * @param string|string[] $model_name    eg 'Event','Answer','Term', etc.
+	 *                                       Basically its the model class's name without the "EEM_"
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
+	{
+		$this->_model_name_pointed_to = (array) $model_name;
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+	}
 
 
-    /**
-     * Returns the name of the model(s) pointed to
-     *
-     * @return string[] string or array of strings
-     * @deprecated since version 4.6.7
-     */
-    public function get_model_name_pointed_to(): array
-    {
-        EE_Error::doing_it_wrong(
-            'get_model_name_pointed_to',
-            esc_html__(
-                'This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array',
-                'event_espresso'
-            ),
-            '4.6.7'
-        );
-        return $this->_model_name_pointed_to;
-    }
+	/**
+	 * Returns the name of the model(s) pointed to
+	 *
+	 * @return string[] string or array of strings
+	 * @deprecated since version 4.6.7
+	 */
+	public function get_model_name_pointed_to(): array
+	{
+		EE_Error::doing_it_wrong(
+			'get_model_name_pointed_to',
+			esc_html__(
+				'This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array',
+				'event_espresso'
+			),
+			'4.6.7'
+		);
+		return $this->_model_name_pointed_to;
+	}
 
 
-    /**
-     * Gets the model names pointed to by this field, always as an array
-     * (even if there's only one)
-     *
-     * @return string[] of model names pointed to by this field
-     */
-    public function get_model_names_pointed_to(): array
-    {
-        return is_array($this->_model_name_pointed_to)
-            ? $this->_model_name_pointed_to
-            : [$this->_model_name_pointed_to];
-    }
+	/**
+	 * Gets the model names pointed to by this field, always as an array
+	 * (even if there's only one)
+	 *
+	 * @return string[] of model names pointed to by this field
+	 */
+	public function get_model_names_pointed_to(): array
+	{
+		return is_array($this->_model_name_pointed_to)
+			? $this->_model_name_pointed_to
+			: [$this->_model_name_pointed_to];
+	}
 
 
-    /**
-     * Returns the model's classname (eg EE_Event instead of just Event)
-     *
-     * @return string[]
-     */
-    public function get_model_class_names_pointed_to(): array
-    {
-        $model_names = [];
-        if (is_array($this->_model_name_pointed_to)) {
-            foreach ($this->_model_name_pointed_to as $model_name) {
-                $model_names[] = "EE_" . $model_name;
-            }
-        } else {
-            $model_names = ["EE_" . $this->_model_name_pointed_to];
-        }
-        return $model_names;
-    }
+	/**
+	 * Returns the model's classname (eg EE_Event instead of just Event)
+	 *
+	 * @return string[]
+	 */
+	public function get_model_class_names_pointed_to(): array
+	{
+		$model_names = [];
+		if (is_array($this->_model_name_pointed_to)) {
+			foreach ($this->_model_name_pointed_to as $model_name) {
+				$model_names[] = "EE_" . $model_name;
+			}
+		} else {
+			$model_names = ["EE_" . $this->_model_name_pointed_to];
+		}
+		return $model_names;
+	}
 
 
-    /**
-     * @param int|EE_Base_Class $model_obj
-     * @return bool
-     */
-    public function is_model_obj_of_type_pointed_to($model_obj): bool
-    {
-        foreach ($this->get_model_class_names_pointed_to() as $model_obj_classname) {
-            if ($model_obj instanceof $model_obj_classname) {
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * @param int|EE_Base_Class $model_obj
+	 * @return bool
+	 */
+	public function is_model_obj_of_type_pointed_to($model_obj): bool
+	{
+		foreach ($this->get_model_class_names_pointed_to() as $model_obj_classname) {
+			if ($model_obj instanceof $model_obj_classname) {
+				return true;
+			}
+		}
+		return false;
+	}
 }

core/db_models/fields/EE_WP_Post_Type_Field.php.php

Indentation +8 added lines, -8 removed lines

@@ -5,12 +5,12 @@
  */
 class EE_WP_Post_Type_Field extends EE_DB_Only_Text_Field
 {
-    /**
-     * @param string $post_type the exact string to be used for the post type
-     *                          of all these post type model objects/rows
-     */
-    public function __construct($post_type)
-    {
-        parent::__construct('post_type', esc_html__("Post Type", 'event_espresso'), false, $post_type);
-    }
+	/**
+	 * @param string $post_type the exact string to be used for the post type
+	 *                          of all these post type model objects/rows
+	 */
+	public function __construct($post_type)
+	{
+		parent::__construct('post_type', esc_html__("Post Type", 'event_espresso'), false, $post_type);
+	}
 }

core/db_models/EEM_Currency_Payment_Method.model.php

Spacing +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
             'Payment_Method' => new EE_Belongs_To_Relation(),
         ];
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
         $this->_caps_slug                                         = 'payment_methods';
         parent::__construct($timezone);
     }

Indentation +39 added lines, -39 removed lines

@@ -9,44 +9,44 @@
  */
 class EEM_Currency_Payment_Method extends EEM_Base
 {
-    protected static ?EEM_Currency_Payment_Method $_instance = null;
+	protected static ?EEM_Currency_Payment_Method $_instance = null;
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item    = esc_html__('Currency Usable by Payment Method', 'event_espresso');
-        $this->plural_item      = esc_html__('Currencies Usable by Payment Methods', 'event_espresso');
-        $this->_tables          = [
-            'Currency_Payment_Method' => new EE_Primary_Table('esp_currency_payment_method', 'CPM_ID'),
-        ];
-        $this->_fields          = [
-            'Currency_Payment_Method' => [
-                'CPM_ID'   => new EE_Primary_Key_Int_Field(
-                    'CPM_ID',
-                    esc_html__('Currency to Payment Method LInk ID', 'event_espresso')
-                ),
-                'CUR_code' => new EE_Foreign_Key_String_Field(
-                    'CUR_code',
-                    esc_html__('Currency Code', 'event_espresso'),
-                    false,
-                    '',
-                    'Currency'
-                ),
-                'PMD_ID'   => new EE_Foreign_Key_Int_Field(
-                    'PMD_ID',
-                    esc_html__('Paymetn Method ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Payment_Method'
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Currency'       => new EE_Belongs_To_Relation(),
-            'Payment_Method' => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->_caps_slug                                         = 'payment_methods';
-        parent::__construct($timezone);
-    }
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item    = esc_html__('Currency Usable by Payment Method', 'event_espresso');
+		$this->plural_item      = esc_html__('Currencies Usable by Payment Methods', 'event_espresso');
+		$this->_tables          = [
+			'Currency_Payment_Method' => new EE_Primary_Table('esp_currency_payment_method', 'CPM_ID'),
+		];
+		$this->_fields          = [
+			'Currency_Payment_Method' => [
+				'CPM_ID'   => new EE_Primary_Key_Int_Field(
+					'CPM_ID',
+					esc_html__('Currency to Payment Method LInk ID', 'event_espresso')
+				),
+				'CUR_code' => new EE_Foreign_Key_String_Field(
+					'CUR_code',
+					esc_html__('Currency Code', 'event_espresso'),
+					false,
+					'',
+					'Currency'
+				),
+				'PMD_ID'   => new EE_Foreign_Key_Int_Field(
+					'PMD_ID',
+					esc_html__('Paymetn Method ID', 'event_espresso'),
+					false,
+					0,
+					'Payment_Method'
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Currency'       => new EE_Belongs_To_Relation(),
+			'Payment_Method' => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->_caps_slug                                         = 'payment_methods';
+		parent::__construct($timezone);
+	}
 }

core/services/form/meta/inputs/Button.php

Indentation +45 added lines, -45 removed lines

@@ -4,49 +4,49 @@
 
 class Button
 {
-    /**
-     * indicates that the HTML input type is 'button'
-     */
-    public const TYPE_BUTTON = 'button';
-
-    /**
-     * indicates that the HTML input type is 'reset'
-     */
-    public const TYPE_BUTTON_RESET = 'reset';
-
-    /**
-     * indicates that the HTML input type is 'submit'
-     */
-    public const TYPE_BUTTON_SUBMIT = 'submit';
-
-
-    /**
-     * @var array
-     */
-    private $valid_type_options;
-
-
-    public function __construct()
-    {
-        $this->valid_type_options = apply_filters(
-            'FHEE__EventEspresso_core_services_form_meta_inputs_Button__valid_type_options',
-            [
-                Button::TYPE_BUTTON        => esc_html__('Button', 'event_espresso'),
-                Button::TYPE_BUTTON_RESET  => esc_html__('Reset Button', 'event_espresso'),
-                Button::TYPE_BUTTON_SUBMIT => esc_html__('Submit Button', 'event_espresso'),
-            ]
-        );
-    }
-
-
-    /**
-     * @param bool $constants_only
-     * @return array
-     */
-    public function validTypeOptions(bool $constants_only = false): array
-    {
-        return $constants_only
-            ? array_keys($this->valid_type_options)
-            : $this->valid_type_options;
-    }
+	/**
+	 * indicates that the HTML input type is 'button'
+	 */
+	public const TYPE_BUTTON = 'button';
+
+	/**
+	 * indicates that the HTML input type is 'reset'
+	 */
+	public const TYPE_BUTTON_RESET = 'reset';
+
+	/**
+	 * indicates that the HTML input type is 'submit'
+	 */
+	public const TYPE_BUTTON_SUBMIT = 'submit';
+
+
+	/**
+	 * @var array
+	 */
+	private $valid_type_options;
+
+
+	public function __construct()
+	{
+		$this->valid_type_options = apply_filters(
+			'FHEE__EventEspresso_core_services_form_meta_inputs_Button__valid_type_options',
+			[
+				Button::TYPE_BUTTON        => esc_html__('Button', 'event_espresso'),
+				Button::TYPE_BUTTON_RESET  => esc_html__('Reset Button', 'event_espresso'),
+				Button::TYPE_BUTTON_SUBMIT => esc_html__('Submit Button', 'event_espresso'),
+			]
+		);
+	}
+
+
+	/**
+	 * @param bool $constants_only
+	 * @return array
+	 */
+	public function validTypeOptions(bool $constants_only = false): array
+	{
+		return $constants_only
+			? array_keys($this->valid_type_options)
+			: $this->valid_type_options;
+	}
 }

core/services/form/meta/inputs/DateTime.php

Indentation +77 added lines, -77 removed lines

@@ -5,81 +5,81 @@
 class DateTime
 {
 
-    /**
-     * indicates that the HTML input type is 'date'
-     */
-    public const TYPE_DATE = 'date';
-
-    /**
-     * indicates that the HTML input type is 'datetime-local'
-     */
-    public const TYPE_DATETIME_LOCAL = 'datetime-local';
-
-    /**
-     * indicates that the HTML input type is 'month'
-     */
-    public const TYPE_MONTH = 'month';
-
-    /**
-     * indicates that the HTML input type is 'time'
-     */
-    public const TYPE_TIME = 'time';
-
-    /**
-     * indicates that the HTML input type is 'week'
-     */
-    public const TYPE_WEEK = 'week';
-
-    // CUSTOM EE DATE TYPES
-
-    /**
-     * indicates that the input is an HTML dropdown used for selecting the day for a date
-     */
-    public const TYPE_SELECT_DAY = 'day-select';
-
-    /**
-     * indicates that the input is an HTML dropdown used for selecting the month for a date
-     */
-    public const TYPE_SELECT_MONTH = 'month-select';
-
-    /**
-     * indicates that the input is an HTML dropdown used for selecting the year for a date
-     */
-    public const TYPE_SELECT_YEAR = 'year-select';
-
-
-    /**
-     * @var array
-     */
-    private $valid_type_options;
-
-
-    public function __construct()
-    {
-        $this->valid_type_options = apply_filters(
-            'FHEE__EventEspresso_core_services_form_meta_inputs_DateTime__valid_type_options',
-            [
-                DateTime::TYPE_DATE           => esc_html__('Date Picker', 'event_espresso'),
-                DateTime::TYPE_DATETIME_LOCAL => esc_html__('Local Date Picker', 'event_espresso'),
-                DateTime::TYPE_MONTH          => esc_html__('Month Picker', 'event_espresso'),
-                DateTime::TYPE_TIME           => esc_html__('Time Picker', 'event_espresso'),
-                DateTime::TYPE_WEEK           => esc_html__('Week Picker', 'event_espresso'),
-                DateTime::TYPE_SELECT_DAY     => esc_html__('Day Selector', 'event_espresso'),
-                DateTime::TYPE_SELECT_MONTH   => esc_html__('Month Selector', 'event_espresso'),
-                DateTime::TYPE_SELECT_YEAR    => esc_html__('Year Selector', 'event_espresso'),
-            ]
-        );
-    }
-
-
-    /**
-     * @param bool $constants_only
-     * @return array
-     */
-    public function validTypeOptions(bool $constants_only = false): array
-    {
-        return $constants_only
-            ? array_keys($this->valid_type_options)
-            : $this->valid_type_options;
-    }
+	/**
+	 * indicates that the HTML input type is 'date'
+	 */
+	public const TYPE_DATE = 'date';
+
+	/**
+	 * indicates that the HTML input type is 'datetime-local'
+	 */
+	public const TYPE_DATETIME_LOCAL = 'datetime-local';
+
+	/**
+	 * indicates that the HTML input type is 'month'
+	 */
+	public const TYPE_MONTH = 'month';
+
+	/**
+	 * indicates that the HTML input type is 'time'
+	 */
+	public const TYPE_TIME = 'time';
+
+	/**
+	 * indicates that the HTML input type is 'week'
+	 */
+	public const TYPE_WEEK = 'week';
+
+	// CUSTOM EE DATE TYPES
+
+	/**
+	 * indicates that the input is an HTML dropdown used for selecting the day for a date
+	 */
+	public const TYPE_SELECT_DAY = 'day-select';
+
+	/**
+	 * indicates that the input is an HTML dropdown used for selecting the month for a date
+	 */
+	public const TYPE_SELECT_MONTH = 'month-select';
+
+	/**
+	 * indicates that the input is an HTML dropdown used for selecting the year for a date
+	 */
+	public const TYPE_SELECT_YEAR = 'year-select';
+
+
+	/**
+	 * @var array
+	 */
+	private $valid_type_options;
+
+
+	public function __construct()
+	{
+		$this->valid_type_options = apply_filters(
+			'FHEE__EventEspresso_core_services_form_meta_inputs_DateTime__valid_type_options',
+			[
+				DateTime::TYPE_DATE           => esc_html__('Date Picker', 'event_espresso'),
+				DateTime::TYPE_DATETIME_LOCAL => esc_html__('Local Date Picker', 'event_espresso'),
+				DateTime::TYPE_MONTH          => esc_html__('Month Picker', 'event_espresso'),
+				DateTime::TYPE_TIME           => esc_html__('Time Picker', 'event_espresso'),
+				DateTime::TYPE_WEEK           => esc_html__('Week Picker', 'event_espresso'),
+				DateTime::TYPE_SELECT_DAY     => esc_html__('Day Selector', 'event_espresso'),
+				DateTime::TYPE_SELECT_MONTH   => esc_html__('Month Selector', 'event_espresso'),
+				DateTime::TYPE_SELECT_YEAR    => esc_html__('Year Selector', 'event_espresso'),
+			]
+		);
+	}
+
+
+	/**
+	 * @param bool $constants_only
+	 * @return array
+	 */
+	public function validTypeOptions(bool $constants_only = false): array
+	{
+		return $constants_only
+			? array_keys($this->valid_type_options)
+			: $this->valid_type_options;
+	}
 }

core/services/form/meta/inputs/Number.php

Indentation +45 added lines, -45 removed lines

@@ -5,49 +5,49 @@
 class Number
 {
 
-    /**
-     * indicates that the HTML input type is 'number' whose value is a decimal (float)
-     */
-    public const TYPE_FLOAT = 'decimal';
-
-    /**
-     * indicates that the HTML input type is 'number' whose value is an integer (whole number)
-     */
-    public const TYPE_INT = 'integer';
-
-    /**
-     * indicates that the HTML input type is 'range'
-     */
-    public const TYPE_RANGE = 'range';
-
-
-    /**
-     * @var array
-     */
-    private $valid_type_options;
-
-
-    public function __construct()
-    {
-        $this->valid_type_options = apply_filters(
-            'FHEE__EventEspresso_core_services_form_meta_inputs_Number__valid_type_options',
-            [
-                Number::TYPE_FLOAT => esc_html__('Decimal Number', 'event_espresso'),
-                Number::TYPE_INT   => esc_html__('Integer (Whole) Number', 'event_espresso'),
-                Number::TYPE_RANGE => esc_html__('Number Range', 'event_espresso'),
-            ]
-        );
-    }
-
-
-    /**
-     * @param bool $constants_only
-     * @return array
-     */
-    public function validTypeOptions(bool $constants_only = false): array
-    {
-        return $constants_only
-            ? array_keys($this->valid_type_options)
-            : $this->valid_type_options;
-    }
+	/**
+	 * indicates that the HTML input type is 'number' whose value is a decimal (float)
+	 */
+	public const TYPE_FLOAT = 'decimal';
+
+	/**
+	 * indicates that the HTML input type is 'number' whose value is an integer (whole number)
+	 */
+	public const TYPE_INT = 'integer';
+
+	/**
+	 * indicates that the HTML input type is 'range'
+	 */
+	public const TYPE_RANGE = 'range';
+
+
+	/**
+	 * @var array
+	 */
+	private $valid_type_options;
+
+
+	public function __construct()
+	{
+		$this->valid_type_options = apply_filters(
+			'FHEE__EventEspresso_core_services_form_meta_inputs_Number__valid_type_options',
+			[
+				Number::TYPE_FLOAT => esc_html__('Decimal Number', 'event_espresso'),
+				Number::TYPE_INT   => esc_html__('Integer (Whole) Number', 'event_espresso'),
+				Number::TYPE_RANGE => esc_html__('Number Range', 'event_espresso'),
+			]
+		);
+	}
+
+
+	/**
+	 * @param bool $constants_only
+	 * @return array
+	 */
+	public function validTypeOptions(bool $constants_only = false): array
+	{
+		return $constants_only
+			? array_keys($this->valid_type_options)
+			: $this->valid_type_options;
+	}
 }

core/services/form/meta/inputs/Select.php

Indentation +55 added lines, -55 removed lines

@@ -5,59 +5,59 @@
 class Select
 {
 
-    /**
-     * indicates that the input is an HTML dropdown (select input) that accepts only one value
-     */
-    public const TYPE_SELECT = 'select';
-
-    /**
-     * indicates that the input is an HTML dropdown (select input) that accepts multiple values
-     */
-    public const TYPE_SELECT_MULTI = 'select-multi';
-
-    // CUSTOM EE SELECT TYPES
-
-    /**
-     * indicates that input is an HTML dropdown (select input)
-     * populated with names of countries that are enabled for the site
-     */
-    public const TYPE_SELECT_COUNTRY = 'select-country';
-
-    /**
-     * indicates that the input is an HTML dropdown (select input)
-     * populated with names of states for the countries that are enabled for the site
-     */
-    public const TYPE_SELECT_STATE = 'select-state';
-
-
-    /**
-     * @var array
-     */
-    private $valid_type_options;
-
-
-    public function __construct()
-    {
-        $this->valid_type_options = apply_filters(
-            'FHEE__EventEspresso_core_services_form_meta_inputs_Select__valid_type_options',
-            [
-                Select::TYPE_SELECT         => esc_html__('Dropdown', 'event_espresso'),
-                Select::TYPE_SELECT_MULTI   => esc_html__('Multi-Select Dropdown', 'event_espresso'),
-                Select::TYPE_SELECT_COUNTRY => esc_html__('Country Selector', 'event_espresso'),
-                Select::TYPE_SELECT_STATE   => esc_html__('State Selector', 'event_espresso'),
-            ]
-        );
-    }
-
-
-    /**
-     * @param bool $constants_only
-     * @return array
-     */
-    public function validTypeOptions(bool $constants_only = false): array
-    {
-        return $constants_only
-            ? array_keys($this->valid_type_options)
-            : $this->valid_type_options;
-    }
+	/**
+	 * indicates that the input is an HTML dropdown (select input) that accepts only one value
+	 */
+	public const TYPE_SELECT = 'select';
+
+	/**
+	 * indicates that the input is an HTML dropdown (select input) that accepts multiple values
+	 */
+	public const TYPE_SELECT_MULTI = 'select-multi';
+
+	// CUSTOM EE SELECT TYPES
+
+	/**
+	 * indicates that input is an HTML dropdown (select input)
+	 * populated with names of countries that are enabled for the site
+	 */
+	public const TYPE_SELECT_COUNTRY = 'select-country';
+
+	/**
+	 * indicates that the input is an HTML dropdown (select input)
+	 * populated with names of states for the countries that are enabled for the site
+	 */
+	public const TYPE_SELECT_STATE = 'select-state';
+
+
+	/**
+	 * @var array
+	 */
+	private $valid_type_options;
+
+
+	public function __construct()
+	{
+		$this->valid_type_options = apply_filters(
+			'FHEE__EventEspresso_core_services_form_meta_inputs_Select__valid_type_options',
+			[
+				Select::TYPE_SELECT         => esc_html__('Dropdown', 'event_espresso'),
+				Select::TYPE_SELECT_MULTI   => esc_html__('Multi-Select Dropdown', 'event_espresso'),
+				Select::TYPE_SELECT_COUNTRY => esc_html__('Country Selector', 'event_espresso'),
+				Select::TYPE_SELECT_STATE   => esc_html__('State Selector', 'event_espresso'),
+			]
+		);
+	}
+
+
+	/**
+	 * @param bool $constants_only
+	 * @return array
+	 */
+	public function validTypeOptions(bool $constants_only = false): array
+	{
+		return $constants_only
+			? array_keys($this->valid_type_options)
+			: $this->valid_type_options;
+	}
 }

core/services/form/meta/inputs/Phone.php

Indentation +93 added lines, -93 removed lines

@@ -5,109 +5,109 @@
 class Phone
 {
 
-    /**
-     * indicates that the HTML input type is 'tel'
-     */
-    public const INPUT_TYPE = 'tel';
+	/**
+	 * indicates that the HTML input type is 'tel'
+	 */
+	public const INPUT_TYPE = 'tel';
 
-    /**
-     * indicates that the 'tel' input regex pattern is for a US formatted phone number, examples:
-     *      ##########
-     *      ###-###-####
-     *      ### ### ####
-     *      (###)-###-####
-     *      (###) ###-####
-     *
-     * captures the intl code to the first group (+1) and the rest of the number to group 2
-     *      +1 (###) ###-####
-     */
-    public const PATTERN_US = '(\+?\d{1,3})?[\ \-]?(\(?\d{3}\)?[\ \-]?\d{3}[\ \-]?\d{4})';
+	/**
+	 * indicates that the 'tel' input regex pattern is for a US formatted phone number, examples:
+	 *      ##########
+	 *      ###-###-####
+	 *      ### ### ####
+	 *      (###)-###-####
+	 *      (###) ###-####
+	 *
+	 * captures the intl code to the first group (+1) and the rest of the number to group 2
+	 *      +1 (###) ###-####
+	 */
+	public const PATTERN_US = '(\+?\d{1,3})?[\ \-]?(\(?\d{3}\)?[\ \-]?\d{3}[\ \-]?\d{4})';
 
-    /**
-     * indicates that the 'tel' input regex pattern is for a UK formatted phone number, examples:
-     *      (###) #### ####
-     *      (####) ### ####
-     *      (#####) ## ####
-     *
-     * captures the intl code to the first group (+44) and the rest of the number to group 2
-     *      +44 (###) #### ####
-     */
-    public const PATTERN_UK = '(\+?44)?[\ ]?(\(?(?:(?:\d{3,5})|(?:\d{4} \d{2}))\)?[\-\ ]?\d{2,4}[\-\ ]?\d{2,4})';
+	/**
+	 * indicates that the 'tel' input regex pattern is for a UK formatted phone number, examples:
+	 *      (###) #### ####
+	 *      (####) ### ####
+	 *      (#####) ## ####
+	 *
+	 * captures the intl code to the first group (+44) and the rest of the number to group 2
+	 *      +44 (###) #### ####
+	 */
+	public const PATTERN_UK = '(\+?44)?[\ ]?(\(?(?:(?:\d{3,5})|(?:\d{4} \d{2}))\)?[\-\ ]?\d{2,4}[\-\ ]?\d{2,4})';
 
-    /**
-     * indicates that the 'tel' input regex pattern is for a France formatted phone number, examples:
-     *      0# ## ## ## ##
-     *      0### ## ## ##
-     *
-     * captures the intl code to the first group (+33) and the rest of the number to group 2
-     *      +33 # ## ## ## ##
-     *      0033 # ## ## ## ##
-     */
-    public const PATTERN_FR = '((?:\+|00)33)?[\ \.\-]*((?:(?:\(0\)[\ \.\-]{0,3})?|0)[1-9](?:(?:[\ \.\-]?\d{2}){4}|\d{2}(?:[\ \.\-]?\d{3}){2}))';
+	/**
+	 * indicates that the 'tel' input regex pattern is for a France formatted phone number, examples:
+	 *      0# ## ## ## ##
+	 *      0### ## ## ##
+	 *
+	 * captures the intl code to the first group (+33) and the rest of the number to group 2
+	 *      +33 # ## ## ## ##
+	 *      0033 # ## ## ## ##
+	 */
+	public const PATTERN_FR = '((?:\+|00)33)?[\ \.\-]*((?:(?:\(0\)[\ \.\-]{0,3})?|0)[1-9](?:(?:[\ \.\-]?\d{2}){4}|\d{2}(?:[\ \.\-]?\d{3}){2}))';
 
-    /**
-     * indicates that the 'tel' input regex pattern is for a German formatted phone number, examples:
-     *      (0##) ####-####
-     *      (0###) ####-####
-     *      (0####) ###-####
-     *      (03####) ##-####
-     *
-     * captures the intl code to the first group (+49) and the rest of the number to group 2
-     *      +49 (0##) ####-####
-     */
-    public const PATTERN_DE = '(\+?49)?[\ \.\-]?(\(?(?:[\d \-\)\–\/\(]+){6,}\)?(?:[\ \.\-–\/]?)(?:[\d]+))';
+	/**
+	 * indicates that the 'tel' input regex pattern is for a German formatted phone number, examples:
+	 *      (0##) ####-####
+	 *      (0###) ####-####
+	 *      (0####) ###-####
+	 *      (03####) ##-####
+	 *
+	 * captures the intl code to the first group (+49) and the rest of the number to group 2
+	 *      +49 (0##) ####-####
+	 */
+	public const PATTERN_DE = '(\+?49)?[\ \.\-]?(\(?(?:[\d \-\)\–\/\(]+){6,}\)?(?:[\ \.\-–\/]?)(?:[\d]+))';
 
-    /**
-     * @var array
-     */
-    private $regex_patterns;
+	/**
+	 * @var array
+	 */
+	private $regex_patterns;
 
-    /**
-     * @var array
-     */
-    private $valid_type_options;
+	/**
+	 * @var array
+	 */
+	private $valid_type_options;
 
 
-    /**
-     * Phone constructor.
-     */
-    public function __construct()
-    {
-        $this->regex_patterns     = (array) apply_filters(
-            'FHEE__EventEspresso_core_services_form_meta_inputs_Phone__regex_patterns',
-            [
-                'de_DE' => Phone::PATTERN_DE,
-                'fr_FR' => Phone::PATTERN_FR,
-                'en_UK' => Phone::PATTERN_UK,
-                'en_US' => Phone::PATTERN_US,
-            ]
-        );
-        $this->valid_type_options = apply_filters(
-            'FHEE__EventEspresso_core_services_form_meta_inputs_Phone__valid_type_options',
-            [
-                Phone::INPUT_TYPE => esc_html__('Phone Number', 'event_espresso'),
-            ]
-        );
-    }
+	/**
+	 * Phone constructor.
+	 */
+	public function __construct()
+	{
+		$this->regex_patterns     = (array) apply_filters(
+			'FHEE__EventEspresso_core_services_form_meta_inputs_Phone__regex_patterns',
+			[
+				'de_DE' => Phone::PATTERN_DE,
+				'fr_FR' => Phone::PATTERN_FR,
+				'en_UK' => Phone::PATTERN_UK,
+				'en_US' => Phone::PATTERN_US,
+			]
+		);
+		$this->valid_type_options = apply_filters(
+			'FHEE__EventEspresso_core_services_form_meta_inputs_Phone__valid_type_options',
+			[
+				Phone::INPUT_TYPE => esc_html__('Phone Number', 'event_espresso'),
+			]
+		);
+	}
 
 
-    /**
-     * @return array
-     */
-    public function regexPatterns(): array
-    {
-        return $this->regex_patterns;
-    }
+	/**
+	 * @return array
+	 */
+	public function regexPatterns(): array
+	{
+		return $this->regex_patterns;
+	}
 
 
-    /**
-     * @param bool $constants_only
-     * @return array
-     */
-    public function validTypeOptions(bool $constants_only = false): array
-    {
-        return $constants_only
-            ? array_keys($this->valid_type_options)
-            : $this->valid_type_options;
-    }
+	/**
+	 * @param bool $constants_only
+	 * @return array
+	 */
+	public function validTypeOptions(bool $constants_only = false): array
+	{
+		return $constants_only
+			? array_keys($this->valid_type_options)
+			: $this->valid_type_options;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
      */
     public function __construct()
     {
-        $this->regex_patterns     = (array) apply_filters(
+        $this->regex_patterns = (array) apply_filters(
             'FHEE__EventEspresso_core_services_form_meta_inputs_Phone__regex_patterns',
             [
                 'de_DE' => Phone::PATTERN_DE,