eventespresso / event-espresso-core

core/db_models/EEM_Registration.model.php

Indentation +868 added lines, -868 removed lines

@@ -14,817 +14,817 @@ 
 class EEM_Registration extends EEM_Soft_Delete_Base
 {
 
-    /**
-     * @var EEM_Registration $_instance
-     */
-    protected static $_instance;
-
-    /**
-     * Keys are the status IDs for registrations (eg, RAP, RCN, etc), and the values
-     * are status codes (eg, approved, cancelled, etc)
-     *
-     * @var array
-     */
-    private static $_reg_status;
-
-    /**
-     * The value of REG_count for a primary registrant
-     */
-    const PRIMARY_REGISTRANT_COUNT = 1;
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate an INCOMPLETE registration.
-     * Initial status for registrations when they are first created
-     * Payments are NOT allowed.
-     * Automatically toggled to whatever the default Event registration status is upon completion of the attendee
-     * information reg step NO space reserved. Registration is NOT active
-     */
-    const status_id_incomplete = 'RIC';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate an UNAPPROVED registration.
-     * Payments are NOT allowed.
-     * Event Admin must manually toggle STS_ID for it to change
-     * No space reserved.
-     * Registration is active
-     */
-    const status_id_not_approved = 'RNA';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate registration is PENDING_PAYMENT .
-     * Payments are allowed.
-     * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
-     * No space reserved.
-     * Registration is active
-     */
-    const status_id_pending_payment = 'RPP';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate registration is on the WAIT_LIST .
-     * Payments are allowed.
-     * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
-     * No space reserved.
-     * Registration is active
-     */
-    const status_id_wait_list = 'RWL';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate an APPROVED registration.
-     * the TXN may or may not be completed ( paid in full )
-     * Payments are allowed.
-     * A space IS reserved.
-     * Registration is active
-     */
-    const status_id_approved = 'RAP';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate a registration was CANCELLED by the attendee.
-     * Payments are NOT allowed.
-     * NO space reserved.
-     * Registration is NOT active
-     */
-    const status_id_cancelled = 'RCN';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate a registration was DECLINED by the Event Admin
-     * Payments are NOT allowed.
-     * No space reserved.
-     * Registration is NOT active
-     */
-    const status_id_declined = 'RDC';
-
-    /**
-     * @var TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-
-    /**
-     *    private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access protected
-     * @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
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-        $this->singular_item = esc_html__('Registration', 'event_espresso');
-        $this->plural_item = esc_html__('Registrations', 'event_espresso');
-        $this->_tables = array(
-            'Registration' => new EE_Primary_Table('esp_registration', 'REG_ID'),
-        );
-        $this->_fields = array(
-            'Registration' => array(
-                'REG_ID' => new EE_Primary_Key_Int_Field(
-                    'REG_ID',
-                    esc_html__('Registration ID', 'event_espresso')
-                ),
-                'EVT_ID' => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Event ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'ATT_ID' => new EE_Foreign_Key_Int_Field(
-                    'ATT_ID',
-                    esc_html__('Attendee ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Attendee'
-                ),
-                'TXN_ID' => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__('Transaction ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Transaction'
-                ),
-                'TKT_ID' => new EE_Foreign_Key_Int_Field(
-                    'TKT_ID',
-                    esc_html__('Ticket ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Ticket'
-                ),
-                'STS_ID' => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    esc_html__('Status ID', 'event_espresso'),
-                    false,
-                    EEM_Registration::status_id_incomplete,
-                    'Status'
-                ),
-                'REG_date' => new EE_Datetime_Field(
-                    'REG_date',
-                    esc_html__('Time registration occurred', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'REG_final_price' => new EE_Money_Field(
-                    'REG_final_price',
-                    esc_html__('Registration\'s share of the transaction total', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'REG_paid' => new EE_Money_Field(
-                    'REG_paid',
-                    esc_html__('Amount paid to date towards registration', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'REG_session' => new EE_Plain_Text_Field(
-                    'REG_session',
-                    esc_html__('Session ID of registration', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'REG_code' => new EE_Plain_Text_Field(
-                    'REG_code',
-                    esc_html__('Unique Code for this registration', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'REG_url_link' => new EE_Plain_Text_Field(
-                    'REG_url_link',
-                    esc_html__('String to be used in URL for identifying registration', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'REG_count' => new EE_Integer_Field(
-                    'REG_count',
-                    esc_html__('Count of this registration in the group registration ', 'event_espresso'),
-                    true,
-                    1
-                ),
-                'REG_group_size' => new EE_Integer_Field(
-                    'REG_group_size',
-                    esc_html__('Number of registrations on this group', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'REG_att_is_going' => new EE_Boolean_Field(
-                    'REG_att_is_going',
-                    esc_html__('Flag indicating the registrant plans on attending', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'REG_deleted' => new EE_Trashed_Flag_Field(
-                    'REG_deleted',
-                    esc_html__('Flag indicating if registration has been archived or not.', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Event' => new EE_Belongs_To_Relation(),
-            'Attendee' => new EE_Belongs_To_Relation(),
-            'Transaction' => new EE_Belongs_To_Relation(),
-            'Ticket' => new EE_Belongs_To_Relation(),
-            'Status' => new EE_Belongs_To_Relation(),
-            'Answer' => new EE_Has_Many_Relation(),
-            'Checkin' => new EE_Has_Many_Relation(),
-            'Registration_Payment' => new EE_Has_Many_Relation(),
-            'Payment' => new EE_HABTM_Relation('Registration_Payment'),
-            'Message' => new EE_Has_Many_Any_Relation(false)
-            // allow deletes even if there are messages in the queue related
-        );
-        $this->_model_chain_to_wp_user = 'Event';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * a list of ALL valid registration statuses currently in use within the system
-     * generated by combining the filterable active and inactive reg status arrays
-     *
-     * @return array
-     */
-    public static function reg_statuses()
-    {
-        return array_unique(
-            array_merge(
-                EEM_Registration::active_reg_statuses(),
-                EEM_Registration::inactive_reg_statuses()
-            )
-        );
-    }
-
-
-    /**
-     * reg_statuses_that_allow_payment
-     * a filterable list of registration statuses that allow a registrant to make a payment
-     *
-     * @access public
-     * @return array
-     */
-    public static function reg_statuses_that_allow_payment()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__reg_statuses_that_allow_payment',
-            array(
-                EEM_Registration::status_id_approved,
-                EEM_Registration::status_id_pending_payment,
-            )
-        );
-    }
-
-
-    /**
-     * active_reg_statuses
-     * a filterable list of registration statuses that are considered active
-     *
-     * @access public
-     * @return array
-     */
-    public static function active_reg_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__active_reg_statuses',
-            array(
-                EEM_Registration::status_id_approved,
-                EEM_Registration::status_id_pending_payment,
-                EEM_Registration::status_id_wait_list,
-                EEM_Registration::status_id_not_approved,
-            )
-        );
-    }
-
-
-    /**
-     * inactive_reg_statuses
-     * a filterable list of registration statuses that are not considered active
-     *
-     * @access public
-     * @return array
-     */
-    public static function inactive_reg_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__inactive_reg_statuses',
-            array(
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-            )
-        );
-    }
-
-
-    /**
-     *    closed_reg_statuses
-     *    a filterable list of registration statuses that are considered "closed"
-     * meaning they should not be considered in any calculations involving monies owing
-     *
-     * @access public
-     * @return array
-     */
-    public static function closed_reg_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__closed_reg_statuses',
-            array(
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_wait_list,
-            )
-        );
-    }
-
-
-    /**
-     *        get list of registration statuses
-     *
-     * @access public
-     * @param array $exclude The status ids to exclude from the returned results
-     * @param bool $translated If true will return the values as singular localized strings
-     * @return array
-     * @throws EE_Error
-     */
-    public static function reg_status_array($exclude = array(), $translated = false)
-    {
-        EEM_Registration::instance()->_get_registration_status_array($exclude);
-        return $translated
-            ? EEM_Status::instance()->localized_status(self::$_reg_status, false, 'sentence')
-            : self::$_reg_status;
-    }
-
-
-    /**
-     *    get list of registration statuses
-     *
-     * @access private
-     * @param array $exclude
-     * @return void
-     * @throws EE_Error
-     */
-    private function _get_registration_status_array($exclude = array())
-    {
-        // in the very rare circumstance that we are deleting a model's table's data
-        // and the table hasn't actually been created, this could have an error
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
-            $results = $wpdb->get_results(
-                "SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
-            );
-            self::$_reg_status = array();
-            foreach ($results as $status) {
-                if (!in_array($status->STS_ID, $exclude, true)) {
-                    self::$_reg_status[ $status->STS_ID ] = $status->STS_code;
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws EE_Error
-     */
-    protected function _get_table_analysis()
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                get_class($this)
-            )
-        );
-    }
-
-
-    /**
-     * This returns a wpdb->results array of all registration date month and years matching the incoming query params
-     * and grouped by month and year.
-     *
-     * @param  array $where_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_reg_months_and_years($where_params)
-    {
-        $query_params[0] = $where_params;
-        $query_params['group_by'] = array('reg_year', 'reg_month');
-        $query_params['order_by'] = array('REG_date' => 'DESC');
-        $columns_to_select = array(
-            'reg_year' => array('YEAR(REG_date)', '%s'),
-            'reg_month' => array('MONTHNAME(REG_date)', '%s'),
-        );
-        return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
-    }
-
-
-    /**
-     * retrieve ALL registrations for a particular Attendee from db
-     *
-     * @param int $ATT_ID
-     * @return EE_Base_Class[]|EE_Registration[]|null
-     * @throws EE_Error
-     */
-    public function get_all_registrations_for_attendee($ATT_ID = 0)
-    {
-        if (!$ATT_ID) {
-            return null;
-        }
-        return $this->get_all(array(array('ATT_ID' => $ATT_ID)));
-    }
-
-
-    /**
-     * Gets a registration given their REG_url_link. Yes, this should usually
-     * be passed via a GET parameter.
-     *
-     * @param string $REG_url_link
-     * @return EE_Base_Class|EE_Registration|null
-     * @throws EE_Error
-     */
-    public function get_registration_for_reg_url_link($REG_url_link)
-    {
-        if (!$REG_url_link) {
-            return null;
-        }
-        return $this->get_one(array(array('REG_url_link' => $REG_url_link)));
-    }
-
-
-    /**
-     *        retrieve registration for a specific transaction attendee from db
-     *
-     * @access        public
-     * @param    int $TXN_ID
-     * @param    int $ATT_ID
-     * @param    int $att_nmbr in case the ATT_ID is the same for multiple registrations (same details used) then the
-     *                         attendee number is required
-     * @return        mixed        array on success, FALSE on fail
-     * @throws EE_Error
-     */
-    public function get_registration_for_transaction_attendee($TXN_ID = 0, $ATT_ID = 0, $att_nmbr = 0)
-    {
-        return $this->get_one(array(
-            array(
-                'TXN_ID' => $TXN_ID,
-                'ATT_ID' => $ATT_ID,
-            ),
-            'limit' => array(min($att_nmbr - 1, 0), 1),
-        ));
-    }
-
-
-    /**
-     *        get the number of registrations per day  for the Registration Admin page Reports Tab.
-     *        (doesn't utilize models because it's a fairly specialized query)
-     *
-     * @access        public
-     * @param $period string which can be passed to php's strtotime function (eg "-1 month")
-     * @return stdClass[] with properties regDate and total
-     * @throws EE_Error
-     */
-    public function get_registrations_per_day_report($period = '-1 month')
-    {
-        $sql_date = $this->convert_datetime_for_query(
-            'REG_date',
-            date('Y-m-d H:i:s', strtotime($period)),
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where = array(
-            'REG_date' => array('>=', $sql_date),
-            'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
-        );
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
-            $where['Event.EVT_wp_user'] = get_current_user_id();
-        }
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
-        $results = $this->_get_all_wpdb_results(
-            array(
-                $where,
-                'group_by' => 'regDate',
-                'order_by' => array('REG_date' => 'ASC'),
-            ),
-            OBJECT,
-            array(
-                'regDate' => array('DATE(' . $query_interval . ')', '%s'),
-                'total' => array('count(REG_ID)', '%d'),
-            )
-        );
-        return $results;
-    }
-
-
-    /**
-     * Get the number of registrations per day including the count of registrations for each Registration Status.
-     * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
-     *
-     * @param string $period
-     * @return stdClass[] with properties Registration_REG_date and a column for each registration status as the STS_ID
-     * @throws EE_Error
-     *                    (i.e. RAP)
-     */
-    public function get_registrations_per_day_and_per_status_report($period = '-1 month')
-    {
-        global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
-        $event_table = $wpdb->posts;
-        $sql_date = date('Y-m-d H:i:s', strtotime($period));
-        // prepare the query interval for displaying offset
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'dates.REG_date');
-        // inner date query
-        $inner_date_query = "SELECT DISTINCT REG_date from {$registration_table} ";
-        $inner_where = ' WHERE';
-        // exclude events not authored by user if permissions in effect
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
-            $inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
-        }
-        $inner_where .= " REG_date >= '{$sql_date}'";
-        $inner_date_query .= $inner_where;
-        // start main query
-        $select = "SELECT DATE({$query_interval}) as Registration_REG_date, ";
-        $join = '';
-        $join_parts = array();
-        $select_parts = array();
-        // loop through registration stati to do parts for each status.
-        foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
-            if ($STS_ID === EEM_Registration::status_id_incomplete) {
-                continue;
-            }
-            $select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}";
-            $join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.REG_date = dates.REG_date AND {$STS_code}.STS_ID = '{$STS_ID}'";
-        }
-        // setup the selects
-        $select .= implode(', ', $select_parts);
-        $select .= " FROM ($inner_date_query) AS dates LEFT JOIN ";
-        // setup the joins
-        $join .= implode(' LEFT JOIN ', $join_parts);
-        // now let's put it all together
-        $query = $select . $join . ' GROUP BY Registration_REG_date';
-        // and execute it
-        return $wpdb->get_results($query, ARRAY_A);
-    }
-
-
-    /**
-     *        get the number of registrations per event  for the Registration Admin page Reports Tab
-     *
-     * @access        public
-     * @param $period string which can be passed to php's strtotime function (eg "-1 month")
-     * @return stdClass[] each with properties event_name, reg_limit, and total
-     * @throws EE_Error
-     */
-    public function get_registrations_per_event_report($period = '-1 month')
-    {
-        $date_sql = $this->convert_datetime_for_query(
-            'REG_date',
-            date('Y-m-d H:i:s', strtotime($period)),
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where = array(
-            'REG_date' => array('>=', $date_sql),
-            'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
-        );
-        if (
-            !EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_others_registrations',
-                'reg_per_event_report'
-            )
-        ) {
-            $where['Event.EVT_wp_user'] = get_current_user_id();
-        }
-        $results = $this->_get_all_wpdb_results(
-            array(
-            $where,
-            'group_by' => 'Event.EVT_name',
-            'order_by' => 'Event.EVT_name',
-            'limit' => array(0, 24),
-            ),
-            OBJECT,
-            array(
-                'event_name' => array('Event_CPT.post_title', '%s'),
-                'total' => array('COUNT(REG_ID)', '%s'),
-            )
-        );
-        return $results;
-    }
-
-
-    /**
-     * Get the number of registrations per event grouped by registration status.
-     * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
-     *
-     * @param string $period
-     * @return stdClass[] with properties `Registration_Event` and a column for each registration status as the STS_ID
-     * @throws EE_Error
-     *                    (i.e. RAP)
-     */
-    public function get_registrations_per_event_and_per_status_report($period = '-1 month')
-    {
-        global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
-        $event_table = $wpdb->posts;
-        $sql_date = date('Y-m-d H:i:s', strtotime($period));
-        // inner date query
-        $inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
-        $inner_where = ' WHERE';
-        // exclude events not authored by user if permissions in effect
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
-            $inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
-        }
-        $inner_where .= " REG_date >= '{$sql_date}'";
-        $inner_date_query .= $inner_where;
-        // build main query
-        $select = 'SELECT Event.post_title as Registration_Event, ';
-        $join = '';
-        $join_parts = array();
-        $select_parts = array();
-        // loop through registration stati to do parts for each status.
-        foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
-            if ($STS_ID === EEM_Registration::status_id_incomplete) {
-                continue;
-            }
-            $select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}";
-            $join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.EVT_ID = dates.EVT_ID AND {$STS_code}.STS_ID = '{$STS_ID}' AND {$STS_code}.REG_date = dates.REG_date";
-        }
-        // setup the selects
-        $select .= implode(', ', $select_parts);
-        $select .= " FROM ($inner_date_query) AS dates LEFT JOIN $event_table as Event ON Event.ID = dates.EVT_ID LEFT JOIN ";
-        // setup remaining joins
-        $join .= implode(' LEFT JOIN ', $join_parts);
-        // now put it all together
-        $query = $select . $join . ' GROUP BY Registration_Event';
-        // and execute
-        return $wpdb->get_results($query, ARRAY_A);
-    }
-
-
-    /**
-     * Returns the EE_Registration of the primary attendee on the transaction id provided
-     *
-     * @param int $TXN_ID
-     * @return EE_Base_Class|EE_Registration|null
-     * @throws EE_Error
-     */
-    public function get_primary_registration_for_transaction_ID($TXN_ID = 0)
-    {
-        if (!$TXN_ID) {
-            return null;
-        }
-        return $this->get_one(array(
-            array(
-                'TXN_ID' => $TXN_ID,
-                'REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT,
-            ),
-        ));
-    }
-
-
-    /**
-     *        get_event_registration_count
-     *
-     * @access public
-     * @param int $EVT_ID
-     * @param boolean $for_incomplete_payments
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_event_registration_count($EVT_ID, $for_incomplete_payments = false)
-    {
-        // we only count approved registrations towards registration limits
-        $query_params = array(array('EVT_ID' => $EVT_ID, 'STS_ID' => self::status_id_approved));
-        if ($for_incomplete_payments) {
-            $query_params[0]['Transaction.STS_ID'] = array('!=', EEM_Transaction::complete_status_code);
-        }
-        return $this->count($query_params);
-    }
-
-
-    /**
-     * Deletes all registrations with no transactions. Note that this needs to be very efficient
-     * and so it uses wpdb directly. Also, we can't put a limit on this because MySQL doesn't allow a limit on a delete
-     * when joining tables like this.
-     *
-     * @global WPDB $wpdb
-     * @return int number deleted
-     * @throws EE_Error
-     */
-    public function delete_registrations_with_no_transaction()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        return $wpdb->query(
-            'DELETE r FROM '
-            . $this->table()
-            . ' r LEFT JOIN '
-            . EEM_Transaction::instance()->table()
-            . ' t ON r.TXN_ID = t.TXN_ID WHERE t.TXN_ID IS NULL'
-        );
-    }
-
-
-    /**
-     *  Count registrations checked into (or out of) a datetime
-     *
-     * @param int $DTT_ID datetime ID
-     * @param boolean $checked_in whether to count registrations checked IN or OUT
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_registrations_checked_into_datetime($DTT_ID, $checked_in = true)
-    {
-        global $wpdb;
-        // subquery to get latest checkin
-        $query = $wpdb->prepare(
-            'SELECT '
-            . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
-            . '( SELECT '
-            . 'max( CHK_timestamp ) AS latest_checkin, '
-            . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' '
-            . 'WHERE DTT_ID=%d '
-            . 'GROUP BY REG_ID'
-            . ') AS most_recent_checkin_per_reg '
-            . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
-            . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
-            . 'WHERE '
-            . 'checkins.CHK_in=%d',
-            $DTT_ID,
-            $checked_in
-        );
-        return (int) $wpdb->get_var($query);
-    }
-
-
-    /**
-     *  Count registrations checked into (or out of) an event.
-     *
-     * @param int $EVT_ID event ID
-     * @param boolean $checked_in whether to count registrations checked IN or OUT
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_registrations_checked_into_event($EVT_ID, $checked_in = true)
-    {
-        global $wpdb;
-        // subquery to get latest checkin
-        $query = $wpdb->prepare(
-            'SELECT '
-            . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
-            . '( SELECT '
-            . 'max( CHK_timestamp ) AS latest_checkin, '
-            . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS c '
-            . 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d '
-            . 'ON c.DTT_ID=d.DTT_ID '
-            . 'WHERE d.EVT_ID=%d '
-            . 'GROUP BY REG_ID'
-            . ') AS most_recent_checkin_per_reg '
-            . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
-            . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
-            . 'WHERE '
-            . 'checkins.CHK_in=%d',
-            $EVT_ID,
-            $checked_in
-        );
-        return (int) $wpdb->get_var($query);
-    }
-
-
-    /**
-     * The purpose of this method is to retrieve an array of
-     * EE_Registration objects that represent the latest registration
-     * for each ATT_ID given in the function argument.
-     *
-     * @param array $attendee_ids
-     * @return EE_Base_Class[]|EE_Registration[]
-     * @throws EE_Error
-     */
-    public function get_latest_registration_for_each_of_given_contacts($attendee_ids = array())
-    {
-        // first do a native wp_query to get the latest REG_ID's matching these attendees.
-        global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
-        $attendee_table = $wpdb->posts;
-        $attendee_ids = is_array($attendee_ids)
-            ? array_map('absint', $attendee_ids)
-            : array((int) $attendee_ids);
-        $ATT_IDs = implode(',', $attendee_ids);
-        // first we do a query to get the registration ids
-        // (because a group by before order by causes the order by to be ignored.)
-        $registration_id_query = "
+	/**
+	 * @var EEM_Registration $_instance
+	 */
+	protected static $_instance;
+
+	/**
+	 * Keys are the status IDs for registrations (eg, RAP, RCN, etc), and the values
+	 * are status codes (eg, approved, cancelled, etc)
+	 *
+	 * @var array
+	 */
+	private static $_reg_status;
+
+	/**
+	 * The value of REG_count for a primary registrant
+	 */
+	const PRIMARY_REGISTRANT_COUNT = 1;
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate an INCOMPLETE registration.
+	 * Initial status for registrations when they are first created
+	 * Payments are NOT allowed.
+	 * Automatically toggled to whatever the default Event registration status is upon completion of the attendee
+	 * information reg step NO space reserved. Registration is NOT active
+	 */
+	const status_id_incomplete = 'RIC';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate an UNAPPROVED registration.
+	 * Payments are NOT allowed.
+	 * Event Admin must manually toggle STS_ID for it to change
+	 * No space reserved.
+	 * Registration is active
+	 */
+	const status_id_not_approved = 'RNA';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate registration is PENDING_PAYMENT .
+	 * Payments are allowed.
+	 * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
+	 * No space reserved.
+	 * Registration is active
+	 */
+	const status_id_pending_payment = 'RPP';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate registration is on the WAIT_LIST .
+	 * Payments are allowed.
+	 * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
+	 * No space reserved.
+	 * Registration is active
+	 */
+	const status_id_wait_list = 'RWL';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate an APPROVED registration.
+	 * the TXN may or may not be completed ( paid in full )
+	 * Payments are allowed.
+	 * A space IS reserved.
+	 * Registration is active
+	 */
+	const status_id_approved = 'RAP';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate a registration was CANCELLED by the attendee.
+	 * Payments are NOT allowed.
+	 * NO space reserved.
+	 * Registration is NOT active
+	 */
+	const status_id_cancelled = 'RCN';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate a registration was DECLINED by the Event Admin
+	 * Payments are NOT allowed.
+	 * No space reserved.
+	 * Registration is NOT active
+	 */
+	const status_id_declined = 'RDC';
+
+	/**
+	 * @var TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+
+	/**
+	 *    private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access protected
+	 * @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
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+		$this->singular_item = esc_html__('Registration', 'event_espresso');
+		$this->plural_item = esc_html__('Registrations', 'event_espresso');
+		$this->_tables = array(
+			'Registration' => new EE_Primary_Table('esp_registration', 'REG_ID'),
+		);
+		$this->_fields = array(
+			'Registration' => array(
+				'REG_ID' => new EE_Primary_Key_Int_Field(
+					'REG_ID',
+					esc_html__('Registration ID', 'event_espresso')
+				),
+				'EVT_ID' => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('Event ID', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'ATT_ID' => new EE_Foreign_Key_Int_Field(
+					'ATT_ID',
+					esc_html__('Attendee ID', 'event_espresso'),
+					false,
+					0,
+					'Attendee'
+				),
+				'TXN_ID' => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__('Transaction ID', 'event_espresso'),
+					false,
+					0,
+					'Transaction'
+				),
+				'TKT_ID' => new EE_Foreign_Key_Int_Field(
+					'TKT_ID',
+					esc_html__('Ticket ID', 'event_espresso'),
+					false,
+					0,
+					'Ticket'
+				),
+				'STS_ID' => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					esc_html__('Status ID', 'event_espresso'),
+					false,
+					EEM_Registration::status_id_incomplete,
+					'Status'
+				),
+				'REG_date' => new EE_Datetime_Field(
+					'REG_date',
+					esc_html__('Time registration occurred', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'REG_final_price' => new EE_Money_Field(
+					'REG_final_price',
+					esc_html__('Registration\'s share of the transaction total', 'event_espresso'),
+					false,
+					0
+				),
+				'REG_paid' => new EE_Money_Field(
+					'REG_paid',
+					esc_html__('Amount paid to date towards registration', 'event_espresso'),
+					false,
+					0
+				),
+				'REG_session' => new EE_Plain_Text_Field(
+					'REG_session',
+					esc_html__('Session ID of registration', 'event_espresso'),
+					false,
+					''
+				),
+				'REG_code' => new EE_Plain_Text_Field(
+					'REG_code',
+					esc_html__('Unique Code for this registration', 'event_espresso'),
+					false,
+					''
+				),
+				'REG_url_link' => new EE_Plain_Text_Field(
+					'REG_url_link',
+					esc_html__('String to be used in URL for identifying registration', 'event_espresso'),
+					false,
+					''
+				),
+				'REG_count' => new EE_Integer_Field(
+					'REG_count',
+					esc_html__('Count of this registration in the group registration ', 'event_espresso'),
+					true,
+					1
+				),
+				'REG_group_size' => new EE_Integer_Field(
+					'REG_group_size',
+					esc_html__('Number of registrations on this group', 'event_espresso'),
+					false,
+					1
+				),
+				'REG_att_is_going' => new EE_Boolean_Field(
+					'REG_att_is_going',
+					esc_html__('Flag indicating the registrant plans on attending', 'event_espresso'),
+					false,
+					false
+				),
+				'REG_deleted' => new EE_Trashed_Flag_Field(
+					'REG_deleted',
+					esc_html__('Flag indicating if registration has been archived or not.', 'event_espresso'),
+					false,
+					false
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Event' => new EE_Belongs_To_Relation(),
+			'Attendee' => new EE_Belongs_To_Relation(),
+			'Transaction' => new EE_Belongs_To_Relation(),
+			'Ticket' => new EE_Belongs_To_Relation(),
+			'Status' => new EE_Belongs_To_Relation(),
+			'Answer' => new EE_Has_Many_Relation(),
+			'Checkin' => new EE_Has_Many_Relation(),
+			'Registration_Payment' => new EE_Has_Many_Relation(),
+			'Payment' => new EE_HABTM_Relation('Registration_Payment'),
+			'Message' => new EE_Has_Many_Any_Relation(false)
+			// allow deletes even if there are messages in the queue related
+		);
+		$this->_model_chain_to_wp_user = 'Event';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * a list of ALL valid registration statuses currently in use within the system
+	 * generated by combining the filterable active and inactive reg status arrays
+	 *
+	 * @return array
+	 */
+	public static function reg_statuses()
+	{
+		return array_unique(
+			array_merge(
+				EEM_Registration::active_reg_statuses(),
+				EEM_Registration::inactive_reg_statuses()
+			)
+		);
+	}
+
+
+	/**
+	 * reg_statuses_that_allow_payment
+	 * a filterable list of registration statuses that allow a registrant to make a payment
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function reg_statuses_that_allow_payment()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__reg_statuses_that_allow_payment',
+			array(
+				EEM_Registration::status_id_approved,
+				EEM_Registration::status_id_pending_payment,
+			)
+		);
+	}
+
+
+	/**
+	 * active_reg_statuses
+	 * a filterable list of registration statuses that are considered active
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function active_reg_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__active_reg_statuses',
+			array(
+				EEM_Registration::status_id_approved,
+				EEM_Registration::status_id_pending_payment,
+				EEM_Registration::status_id_wait_list,
+				EEM_Registration::status_id_not_approved,
+			)
+		);
+	}
+
+
+	/**
+	 * inactive_reg_statuses
+	 * a filterable list of registration statuses that are not considered active
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function inactive_reg_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__inactive_reg_statuses',
+			array(
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+			)
+		);
+	}
+
+
+	/**
+	 *    closed_reg_statuses
+	 *    a filterable list of registration statuses that are considered "closed"
+	 * meaning they should not be considered in any calculations involving monies owing
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function closed_reg_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__closed_reg_statuses',
+			array(
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_wait_list,
+			)
+		);
+	}
+
+
+	/**
+	 *        get list of registration statuses
+	 *
+	 * @access public
+	 * @param array $exclude The status ids to exclude from the returned results
+	 * @param bool $translated If true will return the values as singular localized strings
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function reg_status_array($exclude = array(), $translated = false)
+	{
+		EEM_Registration::instance()->_get_registration_status_array($exclude);
+		return $translated
+			? EEM_Status::instance()->localized_status(self::$_reg_status, false, 'sentence')
+			: self::$_reg_status;
+	}
+
+
+	/**
+	 *    get list of registration statuses
+	 *
+	 * @access private
+	 * @param array $exclude
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _get_registration_status_array($exclude = array())
+	{
+		// in the very rare circumstance that we are deleting a model's table's data
+		// and the table hasn't actually been created, this could have an error
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
+			$results = $wpdb->get_results(
+				"SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
+			);
+			self::$_reg_status = array();
+			foreach ($results as $status) {
+				if (!in_array($status->STS_ID, $exclude, true)) {
+					self::$_reg_status[ $status->STS_ID ] = $status->STS_code;
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws EE_Error
+	 */
+	protected function _get_table_analysis()
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+				get_class($this)
+			)
+		);
+	}
+
+
+	/**
+	 * This returns a wpdb->results array of all registration date month and years matching the incoming query params
+	 * and grouped by month and year.
+	 *
+	 * @param  array $where_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_reg_months_and_years($where_params)
+	{
+		$query_params[0] = $where_params;
+		$query_params['group_by'] = array('reg_year', 'reg_month');
+		$query_params['order_by'] = array('REG_date' => 'DESC');
+		$columns_to_select = array(
+			'reg_year' => array('YEAR(REG_date)', '%s'),
+			'reg_month' => array('MONTHNAME(REG_date)', '%s'),
+		);
+		return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
+	}
+
+
+	/**
+	 * retrieve ALL registrations for a particular Attendee from db
+	 *
+	 * @param int $ATT_ID
+	 * @return EE_Base_Class[]|EE_Registration[]|null
+	 * @throws EE_Error
+	 */
+	public function get_all_registrations_for_attendee($ATT_ID = 0)
+	{
+		if (!$ATT_ID) {
+			return null;
+		}
+		return $this->get_all(array(array('ATT_ID' => $ATT_ID)));
+	}
+
+
+	/**
+	 * Gets a registration given their REG_url_link. Yes, this should usually
+	 * be passed via a GET parameter.
+	 *
+	 * @param string $REG_url_link
+	 * @return EE_Base_Class|EE_Registration|null
+	 * @throws EE_Error
+	 */
+	public function get_registration_for_reg_url_link($REG_url_link)
+	{
+		if (!$REG_url_link) {
+			return null;
+		}
+		return $this->get_one(array(array('REG_url_link' => $REG_url_link)));
+	}
+
+
+	/**
+	 *        retrieve registration for a specific transaction attendee from db
+	 *
+	 * @access        public
+	 * @param    int $TXN_ID
+	 * @param    int $ATT_ID
+	 * @param    int $att_nmbr in case the ATT_ID is the same for multiple registrations (same details used) then the
+	 *                         attendee number is required
+	 * @return        mixed        array on success, FALSE on fail
+	 * @throws EE_Error
+	 */
+	public function get_registration_for_transaction_attendee($TXN_ID = 0, $ATT_ID = 0, $att_nmbr = 0)
+	{
+		return $this->get_one(array(
+			array(
+				'TXN_ID' => $TXN_ID,
+				'ATT_ID' => $ATT_ID,
+			),
+			'limit' => array(min($att_nmbr - 1, 0), 1),
+		));
+	}
+
+
+	/**
+	 *        get the number of registrations per day  for the Registration Admin page Reports Tab.
+	 *        (doesn't utilize models because it's a fairly specialized query)
+	 *
+	 * @access        public
+	 * @param $period string which can be passed to php's strtotime function (eg "-1 month")
+	 * @return stdClass[] with properties regDate and total
+	 * @throws EE_Error
+	 */
+	public function get_registrations_per_day_report($period = '-1 month')
+	{
+		$sql_date = $this->convert_datetime_for_query(
+			'REG_date',
+			date('Y-m-d H:i:s', strtotime($period)),
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where = array(
+			'REG_date' => array('>=', $sql_date),
+			'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
+		);
+		if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
+			$where['Event.EVT_wp_user'] = get_current_user_id();
+		}
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
+		$results = $this->_get_all_wpdb_results(
+			array(
+				$where,
+				'group_by' => 'regDate',
+				'order_by' => array('REG_date' => 'ASC'),
+			),
+			OBJECT,
+			array(
+				'regDate' => array('DATE(' . $query_interval . ')', '%s'),
+				'total' => array('count(REG_ID)', '%d'),
+			)
+		);
+		return $results;
+	}
+
+
+	/**
+	 * Get the number of registrations per day including the count of registrations for each Registration Status.
+	 * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
+	 *
+	 * @param string $period
+	 * @return stdClass[] with properties Registration_REG_date and a column for each registration status as the STS_ID
+	 * @throws EE_Error
+	 *                    (i.e. RAP)
+	 */
+	public function get_registrations_per_day_and_per_status_report($period = '-1 month')
+	{
+		global $wpdb;
+		$registration_table = $wpdb->prefix . 'esp_registration';
+		$event_table = $wpdb->posts;
+		$sql_date = date('Y-m-d H:i:s', strtotime($period));
+		// prepare the query interval for displaying offset
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'dates.REG_date');
+		// inner date query
+		$inner_date_query = "SELECT DISTINCT REG_date from {$registration_table} ";
+		$inner_where = ' WHERE';
+		// exclude events not authored by user if permissions in effect
+		if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
+			$inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
+		}
+		$inner_where .= " REG_date >= '{$sql_date}'";
+		$inner_date_query .= $inner_where;
+		// start main query
+		$select = "SELECT DATE({$query_interval}) as Registration_REG_date, ";
+		$join = '';
+		$join_parts = array();
+		$select_parts = array();
+		// loop through registration stati to do parts for each status.
+		foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
+			if ($STS_ID === EEM_Registration::status_id_incomplete) {
+				continue;
+			}
+			$select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}";
+			$join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.REG_date = dates.REG_date AND {$STS_code}.STS_ID = '{$STS_ID}'";
+		}
+		// setup the selects
+		$select .= implode(', ', $select_parts);
+		$select .= " FROM ($inner_date_query) AS dates LEFT JOIN ";
+		// setup the joins
+		$join .= implode(' LEFT JOIN ', $join_parts);
+		// now let's put it all together
+		$query = $select . $join . ' GROUP BY Registration_REG_date';
+		// and execute it
+		return $wpdb->get_results($query, ARRAY_A);
+	}
+
+
+	/**
+	 *        get the number of registrations per event  for the Registration Admin page Reports Tab
+	 *
+	 * @access        public
+	 * @param $period string which can be passed to php's strtotime function (eg "-1 month")
+	 * @return stdClass[] each with properties event_name, reg_limit, and total
+	 * @throws EE_Error
+	 */
+	public function get_registrations_per_event_report($period = '-1 month')
+	{
+		$date_sql = $this->convert_datetime_for_query(
+			'REG_date',
+			date('Y-m-d H:i:s', strtotime($period)),
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where = array(
+			'REG_date' => array('>=', $date_sql),
+			'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
+		);
+		if (
+			!EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_others_registrations',
+				'reg_per_event_report'
+			)
+		) {
+			$where['Event.EVT_wp_user'] = get_current_user_id();
+		}
+		$results = $this->_get_all_wpdb_results(
+			array(
+			$where,
+			'group_by' => 'Event.EVT_name',
+			'order_by' => 'Event.EVT_name',
+			'limit' => array(0, 24),
+			),
+			OBJECT,
+			array(
+				'event_name' => array('Event_CPT.post_title', '%s'),
+				'total' => array('COUNT(REG_ID)', '%s'),
+			)
+		);
+		return $results;
+	}
+
+
+	/**
+	 * Get the number of registrations per event grouped by registration status.
+	 * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
+	 *
+	 * @param string $period
+	 * @return stdClass[] with properties `Registration_Event` and a column for each registration status as the STS_ID
+	 * @throws EE_Error
+	 *                    (i.e. RAP)
+	 */
+	public function get_registrations_per_event_and_per_status_report($period = '-1 month')
+	{
+		global $wpdb;
+		$registration_table = $wpdb->prefix . 'esp_registration';
+		$event_table = $wpdb->posts;
+		$sql_date = date('Y-m-d H:i:s', strtotime($period));
+		// inner date query
+		$inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
+		$inner_where = ' WHERE';
+		// exclude events not authored by user if permissions in effect
+		if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
+			$inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
+		}
+		$inner_where .= " REG_date >= '{$sql_date}'";
+		$inner_date_query .= $inner_where;
+		// build main query
+		$select = 'SELECT Event.post_title as Registration_Event, ';
+		$join = '';
+		$join_parts = array();
+		$select_parts = array();
+		// loop through registration stati to do parts for each status.
+		foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
+			if ($STS_ID === EEM_Registration::status_id_incomplete) {
+				continue;
+			}
+			$select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}";
+			$join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.EVT_ID = dates.EVT_ID AND {$STS_code}.STS_ID = '{$STS_ID}' AND {$STS_code}.REG_date = dates.REG_date";
+		}
+		// setup the selects
+		$select .= implode(', ', $select_parts);
+		$select .= " FROM ($inner_date_query) AS dates LEFT JOIN $event_table as Event ON Event.ID = dates.EVT_ID LEFT JOIN ";
+		// setup remaining joins
+		$join .= implode(' LEFT JOIN ', $join_parts);
+		// now put it all together
+		$query = $select . $join . ' GROUP BY Registration_Event';
+		// and execute
+		return $wpdb->get_results($query, ARRAY_A);
+	}
+
+
+	/**
+	 * Returns the EE_Registration of the primary attendee on the transaction id provided
+	 *
+	 * @param int $TXN_ID
+	 * @return EE_Base_Class|EE_Registration|null
+	 * @throws EE_Error
+	 */
+	public function get_primary_registration_for_transaction_ID($TXN_ID = 0)
+	{
+		if (!$TXN_ID) {
+			return null;
+		}
+		return $this->get_one(array(
+			array(
+				'TXN_ID' => $TXN_ID,
+				'REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT,
+			),
+		));
+	}
+
+
+	/**
+	 *        get_event_registration_count
+	 *
+	 * @access public
+	 * @param int $EVT_ID
+	 * @param boolean $for_incomplete_payments
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_event_registration_count($EVT_ID, $for_incomplete_payments = false)
+	{
+		// we only count approved registrations towards registration limits
+		$query_params = array(array('EVT_ID' => $EVT_ID, 'STS_ID' => self::status_id_approved));
+		if ($for_incomplete_payments) {
+			$query_params[0]['Transaction.STS_ID'] = array('!=', EEM_Transaction::complete_status_code);
+		}
+		return $this->count($query_params);
+	}
+
+
+	/**
+	 * Deletes all registrations with no transactions. Note that this needs to be very efficient
+	 * and so it uses wpdb directly. Also, we can't put a limit on this because MySQL doesn't allow a limit on a delete
+	 * when joining tables like this.
+	 *
+	 * @global WPDB $wpdb
+	 * @return int number deleted
+	 * @throws EE_Error
+	 */
+	public function delete_registrations_with_no_transaction()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		return $wpdb->query(
+			'DELETE r FROM '
+			. $this->table()
+			. ' r LEFT JOIN '
+			. EEM_Transaction::instance()->table()
+			. ' t ON r.TXN_ID = t.TXN_ID WHERE t.TXN_ID IS NULL'
+		);
+	}
+
+
+	/**
+	 *  Count registrations checked into (or out of) a datetime
+	 *
+	 * @param int $DTT_ID datetime ID
+	 * @param boolean $checked_in whether to count registrations checked IN or OUT
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_registrations_checked_into_datetime($DTT_ID, $checked_in = true)
+	{
+		global $wpdb;
+		// subquery to get latest checkin
+		$query = $wpdb->prepare(
+			'SELECT '
+			. 'COUNT( DISTINCT checkins.REG_ID ) '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+			. '( SELECT '
+			. 'max( CHK_timestamp ) AS latest_checkin, '
+			. 'REG_ID AS REG_ID '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' '
+			. 'WHERE DTT_ID=%d '
+			. 'GROUP BY REG_ID'
+			. ') AS most_recent_checkin_per_reg '
+			. 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
+			. 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
+			. 'WHERE '
+			. 'checkins.CHK_in=%d',
+			$DTT_ID,
+			$checked_in
+		);
+		return (int) $wpdb->get_var($query);
+	}
+
+
+	/**
+	 *  Count registrations checked into (or out of) an event.
+	 *
+	 * @param int $EVT_ID event ID
+	 * @param boolean $checked_in whether to count registrations checked IN or OUT
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_registrations_checked_into_event($EVT_ID, $checked_in = true)
+	{
+		global $wpdb;
+		// subquery to get latest checkin
+		$query = $wpdb->prepare(
+			'SELECT '
+			. 'COUNT( DISTINCT checkins.REG_ID ) '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+			. '( SELECT '
+			. 'max( CHK_timestamp ) AS latest_checkin, '
+			. 'REG_ID AS REG_ID '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' AS c '
+			. 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d '
+			. 'ON c.DTT_ID=d.DTT_ID '
+			. 'WHERE d.EVT_ID=%d '
+			. 'GROUP BY REG_ID'
+			. ') AS most_recent_checkin_per_reg '
+			. 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
+			. 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
+			. 'WHERE '
+			. 'checkins.CHK_in=%d',
+			$EVT_ID,
+			$checked_in
+		);
+		return (int) $wpdb->get_var($query);
+	}
+
+
+	/**
+	 * The purpose of this method is to retrieve an array of
+	 * EE_Registration objects that represent the latest registration
+	 * for each ATT_ID given in the function argument.
+	 *
+	 * @param array $attendee_ids
+	 * @return EE_Base_Class[]|EE_Registration[]
+	 * @throws EE_Error
+	 */
+	public function get_latest_registration_for_each_of_given_contacts($attendee_ids = array())
+	{
+		// first do a native wp_query to get the latest REG_ID's matching these attendees.
+		global $wpdb;
+		$registration_table = $wpdb->prefix . 'esp_registration';
+		$attendee_table = $wpdb->posts;
+		$attendee_ids = is_array($attendee_ids)
+			? array_map('absint', $attendee_ids)
+			: array((int) $attendee_ids);
+		$ATT_IDs = implode(',', $attendee_ids);
+		// first we do a query to get the registration ids
+		// (because a group by before order by causes the order by to be ignored.)
+		$registration_id_query = "
 			SELECT registrations.registration_ids as registration_id
 			FROM (
 				SELECT
@@ -838,61 +838,61 @@ 
 			  ) AS registrations
 			  GROUP BY registrations.attendee_ids
 		";
-        $registration_ids = $wpdb->get_results($registration_id_query, ARRAY_A);
-        if (empty($registration_ids)) {
-            return array();
-        }
-        $ids_for_model_query = array();
-        // let's flatten the ids so they can be used in the model query.
-        foreach ($registration_ids as $registration_id) {
-            if (isset($registration_id['registration_id'])) {
-                $ids_for_model_query[] = $registration_id['registration_id'];
-            }
-        }
-        // construct query
-        $_where = array(
-            'REG_ID' => array('IN', $ids_for_model_query),
-        );
-        return $this->get_all(array($_where));
-    }
-
-
-
-    /**
-     * returns a count of registrations for the supplied event having the status as specified
-     *
-     * @param int $EVT_ID
-     * @param array $statuses
-     * @return int
-     * @throws InvalidArgumentException
-     * @throws InvalidStatusException
-     * @throws EE_Error
-     */
-    public function event_reg_count_for_statuses($EVT_ID, $statuses = array())
-    {
-        $EVT_ID = absint($EVT_ID);
-        if (! $EVT_ID) {
-            throw new InvalidArgumentException(
-                esc_html__('An invalid Event ID was supplied.', 'event_espresso')
-            );
-        }
-        $statuses = is_array($statuses) ? $statuses : array($statuses);
-        $statuses = ! empty($statuses) ? $statuses : array(EEM_Registration::status_id_approved);
-        $valid_reg_statuses = EEM_Registration::reg_statuses();
-        foreach ($statuses as $status) {
-            if (! in_array($status, $valid_reg_statuses, true)) {
-                throw new InvalidStatusException($status, esc_html__('Registration', 'event_espresso'));
-            }
-        }
-        return $this->count(
-            array(
-                array(
-                    'EVT_ID' => $EVT_ID,
-                    'STS_ID' => array('IN', $statuses),
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
+		$registration_ids = $wpdb->get_results($registration_id_query, ARRAY_A);
+		if (empty($registration_ids)) {
+			return array();
+		}
+		$ids_for_model_query = array();
+		// let's flatten the ids so they can be used in the model query.
+		foreach ($registration_ids as $registration_id) {
+			if (isset($registration_id['registration_id'])) {
+				$ids_for_model_query[] = $registration_id['registration_id'];
+			}
+		}
+		// construct query
+		$_where = array(
+			'REG_ID' => array('IN', $ids_for_model_query),
+		);
+		return $this->get_all(array($_where));
+	}
+
+
+
+	/**
+	 * returns a count of registrations for the supplied event having the status as specified
+	 *
+	 * @param int $EVT_ID
+	 * @param array $statuses
+	 * @return int
+	 * @throws InvalidArgumentException
+	 * @throws InvalidStatusException
+	 * @throws EE_Error
+	 */
+	public function event_reg_count_for_statuses($EVT_ID, $statuses = array())
+	{
+		$EVT_ID = absint($EVT_ID);
+		if (! $EVT_ID) {
+			throw new InvalidArgumentException(
+				esc_html__('An invalid Event ID was supplied.', 'event_espresso')
+			);
+		}
+		$statuses = is_array($statuses) ? $statuses : array($statuses);
+		$statuses = ! empty($statuses) ? $statuses : array(EEM_Registration::status_id_approved);
+		$valid_reg_statuses = EEM_Registration::reg_statuses();
+		foreach ($statuses as $status) {
+			if (! in_array($status, $valid_reg_statuses, true)) {
+				throw new InvalidStatusException($status, esc_html__('Registration', 'event_espresso'));
+			}
+		}
+		return $this->count(
+			array(
+				array(
+					'EVT_ID' => $EVT_ID,
+					'STS_ID' => array('IN', $statuses),
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
 }

Spacing +25 added lines, -25 removed lines

@@ -370,14 +370,14 @@ 
         // and the table hasn't actually been created, this could have an error
         /** @type WPDB $wpdb */
         global $wpdb;
-        if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
+        if ($this->_get_table_analysis()->tableExists($wpdb->prefix.'esp_status')) {
             $results = $wpdb->get_results(
                 "SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
             );
             self::$_reg_status = array();
             foreach ($results as $status) {
-                if (!in_array($status->STS_ID, $exclude, true)) {
-                    self::$_reg_status[ $status->STS_ID ] = $status->STS_code;
+                if ( ! in_array($status->STS_ID, $exclude, true)) {
+                    self::$_reg_status[$status->STS_ID] = $status->STS_code;
                 }
             }
         }
@@ -434,7 +434,7 @@ 
      */
     public function get_all_registrations_for_attendee($ATT_ID = 0)
     {
-        if (!$ATT_ID) {
+        if ( ! $ATT_ID) {
             return null;
         }
         return $this->get_all(array(array('ATT_ID' => $ATT_ID)));
@@ -451,7 +451,7 @@ 
      */
     public function get_registration_for_reg_url_link($REG_url_link)
     {
-        if (!$REG_url_link) {
+        if ( ! $REG_url_link) {
             return null;
         }
         return $this->get_one(array(array('REG_url_link' => $REG_url_link)));
@@ -502,7 +502,7 @@ 
             'REG_date' => array('>=', $sql_date),
             'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
         );
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
             $where['Event.EVT_wp_user'] = get_current_user_id();
         }
         $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
@@ -514,7 +514,7 @@ 
             ),
             OBJECT,
             array(
-                'regDate' => array('DATE(' . $query_interval . ')', '%s'),
+                'regDate' => array('DATE('.$query_interval.')', '%s'),
                 'total' => array('count(REG_ID)', '%d'),
             )
         );
@@ -534,7 +534,7 @@ 
     public function get_registrations_per_day_and_per_status_report($period = '-1 month')
     {
         global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
+        $registration_table = $wpdb->prefix.'esp_registration';
         $event_table = $wpdb->posts;
         $sql_date = date('Y-m-d H:i:s', strtotime($period));
         // prepare the query interval for displaying offset
@@ -543,9 +543,9 @@ 
         $inner_date_query = "SELECT DISTINCT REG_date from {$registration_table} ";
         $inner_where = ' WHERE';
         // exclude events not authored by user if permissions in effect
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
             $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
-            $inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
+            $inner_where .= ' post_author = '.get_current_user_id().' AND';
         }
         $inner_where .= " REG_date >= '{$sql_date}'";
         $inner_date_query .= $inner_where;
@@ -568,7 +568,7 @@ 
         // setup the joins
         $join .= implode(' LEFT JOIN ', $join_parts);
         // now let's put it all together
-        $query = $select . $join . ' GROUP BY Registration_REG_date';
+        $query = $select.$join.' GROUP BY Registration_REG_date';
         // and execute it
         return $wpdb->get_results($query, ARRAY_A);
     }
@@ -595,7 +595,7 @@ 
             'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
         );
         if (
-            !EE_Registry::instance()->CAP->current_user_can(
+            ! EE_Registry::instance()->CAP->current_user_can(
                 'ee_read_others_registrations',
                 'reg_per_event_report'
             )
@@ -631,16 +631,16 @@ 
     public function get_registrations_per_event_and_per_status_report($period = '-1 month')
     {
         global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
+        $registration_table = $wpdb->prefix.'esp_registration';
         $event_table = $wpdb->posts;
         $sql_date = date('Y-m-d H:i:s', strtotime($period));
         // inner date query
         $inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
         $inner_where = ' WHERE';
         // exclude events not authored by user if permissions in effect
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
             $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
-            $inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
+            $inner_where .= ' post_author = '.get_current_user_id().' AND';
         }
         $inner_where .= " REG_date >= '{$sql_date}'";
         $inner_date_query .= $inner_where;
@@ -663,7 +663,7 @@ 
         // setup remaining joins
         $join .= implode(' LEFT JOIN ', $join_parts);
         // now put it all together
-        $query = $select . $join . ' GROUP BY Registration_Event';
+        $query = $select.$join.' GROUP BY Registration_Event';
         // and execute
         return $wpdb->get_results($query, ARRAY_A);
     }
@@ -678,7 +678,7 @@ 
      */
     public function get_primary_registration_for_transaction_ID($TXN_ID = 0)
     {
-        if (!$TXN_ID) {
+        if ( ! $TXN_ID) {
             return null;
         }
         return $this->get_one(array(
@@ -748,11 +748,11 @@ 
         $query = $wpdb->prepare(
             'SELECT '
             . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+            . 'FROM '.EEM_Checkin::instance()->table().' AS checkins INNER JOIN'
             . '( SELECT '
             . 'max( CHK_timestamp ) AS latest_checkin, '
             . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' '
+            . 'FROM '.EEM_Checkin::instance()->table().' '
             . 'WHERE DTT_ID=%d '
             . 'GROUP BY REG_ID'
             . ') AS most_recent_checkin_per_reg '
@@ -782,12 +782,12 @@ 
         $query = $wpdb->prepare(
             'SELECT '
             . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+            . 'FROM '.EEM_Checkin::instance()->table().' AS checkins INNER JOIN'
             . '( SELECT '
             . 'max( CHK_timestamp ) AS latest_checkin, '
             . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS c '
-            . 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d '
+            . 'FROM '.EEM_Checkin::instance()->table().' AS c '
+            . 'INNER JOIN '.EEM_Datetime::instance()->table().' AS d '
             . 'ON c.DTT_ID=d.DTT_ID '
             . 'WHERE d.EVT_ID=%d '
             . 'GROUP BY REG_ID'
@@ -816,7 +816,7 @@ 
     {
         // first do a native wp_query to get the latest REG_ID's matching these attendees.
         global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
+        $registration_table = $wpdb->prefix.'esp_registration';
         $attendee_table = $wpdb->posts;
         $attendee_ids = is_array($attendee_ids)
             ? array_map('absint', $attendee_ids)
@@ -871,7 +871,7 @@ 
     public function event_reg_count_for_statuses($EVT_ID, $statuses = array())
     {
         $EVT_ID = absint($EVT_ID);
-        if (! $EVT_ID) {
+        if ( ! $EVT_ID) {
             throw new InvalidArgumentException(
                 esc_html__('An invalid Event ID was supplied.', 'event_espresso')
             );
@@ -880,7 +880,7 @@ 
         $statuses = ! empty($statuses) ? $statuses : array(EEM_Registration::status_id_approved);
         $valid_reg_statuses = EEM_Registration::reg_statuses();
         foreach ($statuses as $status) {
-            if (! in_array($status, $valid_reg_statuses, true)) {
+            if ( ! in_array($status, $valid_reg_statuses, true)) {
                 throw new InvalidStatusException($status, esc_html__('Registration', 'event_espresso'));
             }
         }

core/db_models/EEM_Soft_Delete_Base.model.php

Spacing +4 added lines, -4 removed lines

@@ -32,7 +32,7 @@ 
      */
     protected function __construct($timezone = null)
     {
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+        if ( ! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
             $this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
         }
         parent::__construct($timezone);
@@ -133,7 +133,7 @@ 
     protected function _alter_query_params_so_only_trashed_items_included($query_params)
     {
         $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params[0][ $deletedFlagFieldName ] = true;
+        $query_params[0][$deletedFlagFieldName] = true;
         return $query_params;
     }
 
@@ -173,7 +173,7 @@ 
      */
     protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
     {
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = 'minimum';
         }
         return $query_params;
@@ -301,7 +301,7 @@ 
      */
     public function delete_or_restore_by_ID($delete = true, $ID = false)
     {
-        if (! $ID) {
+        if ( ! $ID) {
             return false;
         }
         if (

Indentation +360 added lines, -360 removed lines

@@ -27,364 +27,364 @@
 abstract class EEM_Soft_Delete_Base extends EEM_Base
 {
 
-    /**
-     * @param null $timezone
-     */
-    protected function __construct($timezone = null)
-    {
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            $this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
-        }
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * Searches for field on this model of type 'deleted_flag'. if it is found,
-     * returns it's name.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function deleted_field_name()
-    {
-        $field = $this->get_a_field_of_type('EE_Trashed_Flag_Field');
-        if ($field) {
-            return $field->get_name();
-        } else {
-            throw new EE_Error(sprintf(esc_html__(
-                'We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
-                'event_espresso'
-            ), get_class($this), get_class($this)));
-        }
-    }
-
-
-
-    /**
-     * Gets one item that's been deleted, according to $query_params
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Soft_Delete_Base_Class
-     */
-    public function get_one_deleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::get_one($query_params);
-    }
-
-
-
-    /**
-     * Gets one item from the DB, regardless of whether it's been soft-deleted or not
-     *
-     * @param array $query_params like EEM_base::get_all's $query_params
-     * @return EE_Soft_Delete_Base_Class
-     */
-    public function get_one_deleted_or_undeleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::get_one($query_params);
-    }
-
-
-
-    /**
-     * Gets the item indicated by its ID. But if it's soft-deleted, pretends it doesn't exist.
-     *
-     * @param int|string $id
-     * @return EE_Soft_Delete_Base_Class
-     */
-    public function get_one_by_ID_but_ignore_deleted($id)
-    {
-        return $this->get_one(
-            $this->alter_query_params_to_restrict_by_ID(
-                $id,
-                array('default_where_conditions' => 'default')
-            )
-        );
-    }
-
-
-
-    /**
-     * Counts all the deleted/trashed items
-     *
-     * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_count
-     * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
-     * @return int
-     */
-    public function count_deleted($query_params = null, $field_to_count = null, $distinct = false)
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::count($query_params, $field_to_count, $distinct);
-    }
-
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function _alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params[0][ $deletedFlagFieldName ] = true;
-        return $query_params;
-    }
-
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        return $this->_alter_query_params_so_only_trashed_items_included($query_params);
-    }
-
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    public function alter_query_params_so_deleted_and_undeleted_items_included($query_params = array())
-    {
-        return $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-    }
-
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
-    {
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = 'minimum';
-        }
-        return $query_params;
-    }
-
-
-
-    /**
-     * Counts all deleted and undeleted items
-     *
-     * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_count
-     * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
-     * @return int
-     */
-    public function count_deleted_and_undeleted($query_params = null, $field_to_count = null, $distinct = false)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::count($query_params, $field_to_count, $distinct);
-    }
-
-
-
-    /**
-     * Sum all the deleted items.
-     *
-     * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_sum
-     * @return int
-     */
-    public function sum_deleted($query_params = null, $field_to_sum = null)
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::sum($query_params, $field_to_sum);
-    }
-
-
-
-    /**
-     * Sums all the deleted and undeleted items.
-     *
-     * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_sum
-     * @return int
-     */
-    public function sum_deleted_and_undeleted($query_params = null, $field_to_sum = null)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        parent::sum($query_params, $field_to_sum);
-    }
-
-
-
-    /**
-     * Gets all deleted and undeleted mode objects from the db that meet the criteria, regardless of
-     * whether they've been soft-deleted or not
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Soft_Delete_Base_Class[]
-     */
-    public function get_all_deleted_and_undeleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::get_all($query_params);
-    }
-
-
-
-    /**
-     * For 'soft deletable' models, gets all which ARE deleted, according to conditions specified in $query_params.
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Soft_Delete_Base_Class[]
-     */
-    public function get_all_deleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::get_all($query_params);
-    }
-
-
-
-    /**
-     * Permanently deletes the selected rows. When selecting rows for deletion, ignores
-     * whether they've been soft-deleted or not. (ie, you don't have to soft-delete objects
-     * before you can permanently delete them).
-     * Because this will cause a real deletion, related models may block this deletion (ie, add an error
-     * and abort the delete)
-     *
-     * @param array   $query_params   @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
-     *                                that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
-     *                                which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
-     * @return boolean success
-     */
-    public function delete_permanently($query_params = array(), $allow_blocking = true)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::delete_permanently($query_params, $allow_blocking);
-    }
-
-
-
-    /**
-     * Restores a particular item by its ID (primary key). Ignores the fact whether the item
-     * has been soft-deleted or not.
-     *
-     * @param mixed $ID int if primary key is an int, string otherwise
-     * @return boolean success
-     */
-    public function restore_by_ID($ID = false)
-    {
-        return $this->delete_or_restore_by_ID(false, $ID);
-    }
-
-
-
-    /**
-     * For deleting or restoring a particular item. Note that this model is a SOFT-DELETABLE model! However,
-     * this function will ignore whether the items have been soft-deleted or not.
-     *
-     * @param boolean $delete true for delete, false for restore
-     * @param mixed   $ID     int if primary key is an int, string otherwise
-     * @return boolean
-     */
-    public function delete_or_restore_by_ID($delete = true, $ID = false)
-    {
-        if (! $ID) {
-            return false;
-        }
-        if (
-            $this->delete_or_restore(
-                $delete,
-                $this->alter_query_params_to_restrict_by_ID($ID)
-            )
-        ) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Overrides parent's 'delete' method to instead do a soft delete on all rows that
-     * meet the criteria in $where_col_n_values. This particular function ignores whether the items have been soft-deleted or not.
-     * Note: because this item will be soft-deleted only,
-     * doesn't block because of model dependencies
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param bool  $block_deletes
-     * @return boolean
-     */
-    public function delete($query_params = array(), $block_deletes = false)
-    {
-        // no matter what, we WON'T block soft deletes.
-        return $this->delete_or_restore(true, $query_params);
-    }
-
-
-
-    /**
-     * 'Un-deletes' the chosen items. Note that this model is a SOFT-DELETABLE model! That means that, by default, trashed/soft-deleted
-     * items are ignored in queries. However, this particular function ignores whether the items have been soft-deleted or not.
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return boolean
-     */
-    public function restore($query_params = array())
-    {
-        return $this->delete_or_restore(false, $query_params);
-    }
-
-
-
-    /**
-     * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
-     *
-     * @param boolean $delete       true to indicate deletion, false to indicate restoration
-     * @param array   $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return boolean
-     */
-    public function delete_or_restore($delete = true, $query_params = array())
-    {
-        $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        if ($this->update(array($deletedFlagFieldName => $delete), $query_params)) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Updates all the items of this model which match the $query params, regardless of whether
-     * they've been soft-deleted or not
-     *
-     * @param array   $fields_n_values         like EEM_Base::update's $fields_n_value
-     * @param array   $query_params            like EEM_base::get_all's $query_params
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
-     *                                         in this model's entity map according to $fields_n_values that match $query_params. This
-     *                                         obviously has some overhead, so you can disable it by setting this to FALSE, but
-     *                                         be aware that model objects being used could get out-of-sync with the database
-     * @return int number of items updated
-     */
-    public function update_deleted_and_undeleted($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return $this->update($fields_n_values, $query_params, $keep_model_objs_in_sync);
-    }
+	/**
+	 * @param null $timezone
+	 */
+	protected function __construct($timezone = null)
+	{
+		if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			$this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
+		}
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * Searches for field on this model of type 'deleted_flag'. if it is found,
+	 * returns it's name.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function deleted_field_name()
+	{
+		$field = $this->get_a_field_of_type('EE_Trashed_Flag_Field');
+		if ($field) {
+			return $field->get_name();
+		} else {
+			throw new EE_Error(sprintf(esc_html__(
+				'We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
+				'event_espresso'
+			), get_class($this), get_class($this)));
+		}
+	}
+
+
+
+	/**
+	 * Gets one item that's been deleted, according to $query_params
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Soft_Delete_Base_Class
+	 */
+	public function get_one_deleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::get_one($query_params);
+	}
+
+
+
+	/**
+	 * Gets one item from the DB, regardless of whether it's been soft-deleted or not
+	 *
+	 * @param array $query_params like EEM_base::get_all's $query_params
+	 * @return EE_Soft_Delete_Base_Class
+	 */
+	public function get_one_deleted_or_undeleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::get_one($query_params);
+	}
+
+
+
+	/**
+	 * Gets the item indicated by its ID. But if it's soft-deleted, pretends it doesn't exist.
+	 *
+	 * @param int|string $id
+	 * @return EE_Soft_Delete_Base_Class
+	 */
+	public function get_one_by_ID_but_ignore_deleted($id)
+	{
+		return $this->get_one(
+			$this->alter_query_params_to_restrict_by_ID(
+				$id,
+				array('default_where_conditions' => 'default')
+			)
+		);
+	}
+
+
+
+	/**
+	 * Counts all the deleted/trashed items
+	 *
+	 * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_count
+	 * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
+	 * @return int
+	 */
+	public function count_deleted($query_params = null, $field_to_count = null, $distinct = false)
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::count($query_params, $field_to_count, $distinct);
+	}
+
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function _alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		$deletedFlagFieldName = $this->deleted_field_name();
+		$query_params[0][ $deletedFlagFieldName ] = true;
+		return $query_params;
+	}
+
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		return $this->_alter_query_params_so_only_trashed_items_included($query_params);
+	}
+
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	public function alter_query_params_so_deleted_and_undeleted_items_included($query_params = array())
+	{
+		return $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+	}
+
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
+	{
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = 'minimum';
+		}
+		return $query_params;
+	}
+
+
+
+	/**
+	 * Counts all deleted and undeleted items
+	 *
+	 * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_count
+	 * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
+	 * @return int
+	 */
+	public function count_deleted_and_undeleted($query_params = null, $field_to_count = null, $distinct = false)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::count($query_params, $field_to_count, $distinct);
+	}
+
+
+
+	/**
+	 * Sum all the deleted items.
+	 *
+	 * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_sum
+	 * @return int
+	 */
+	public function sum_deleted($query_params = null, $field_to_sum = null)
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::sum($query_params, $field_to_sum);
+	}
+
+
+
+	/**
+	 * Sums all the deleted and undeleted items.
+	 *
+	 * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_sum
+	 * @return int
+	 */
+	public function sum_deleted_and_undeleted($query_params = null, $field_to_sum = null)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		parent::sum($query_params, $field_to_sum);
+	}
+
+
+
+	/**
+	 * Gets all deleted and undeleted mode objects from the db that meet the criteria, regardless of
+	 * whether they've been soft-deleted or not
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Soft_Delete_Base_Class[]
+	 */
+	public function get_all_deleted_and_undeleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::get_all($query_params);
+	}
+
+
+
+	/**
+	 * For 'soft deletable' models, gets all which ARE deleted, according to conditions specified in $query_params.
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Soft_Delete_Base_Class[]
+	 */
+	public function get_all_deleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::get_all($query_params);
+	}
+
+
+
+	/**
+	 * Permanently deletes the selected rows. When selecting rows for deletion, ignores
+	 * whether they've been soft-deleted or not. (ie, you don't have to soft-delete objects
+	 * before you can permanently delete them).
+	 * Because this will cause a real deletion, related models may block this deletion (ie, add an error
+	 * and abort the delete)
+	 *
+	 * @param array   $query_params   @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
+	 *                                that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
+	 *                                which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
+	 * @return boolean success
+	 */
+	public function delete_permanently($query_params = array(), $allow_blocking = true)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::delete_permanently($query_params, $allow_blocking);
+	}
+
+
+
+	/**
+	 * Restores a particular item by its ID (primary key). Ignores the fact whether the item
+	 * has been soft-deleted or not.
+	 *
+	 * @param mixed $ID int if primary key is an int, string otherwise
+	 * @return boolean success
+	 */
+	public function restore_by_ID($ID = false)
+	{
+		return $this->delete_or_restore_by_ID(false, $ID);
+	}
+
+
+
+	/**
+	 * For deleting or restoring a particular item. Note that this model is a SOFT-DELETABLE model! However,
+	 * this function will ignore whether the items have been soft-deleted or not.
+	 *
+	 * @param boolean $delete true for delete, false for restore
+	 * @param mixed   $ID     int if primary key is an int, string otherwise
+	 * @return boolean
+	 */
+	public function delete_or_restore_by_ID($delete = true, $ID = false)
+	{
+		if (! $ID) {
+			return false;
+		}
+		if (
+			$this->delete_or_restore(
+				$delete,
+				$this->alter_query_params_to_restrict_by_ID($ID)
+			)
+		) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Overrides parent's 'delete' method to instead do a soft delete on all rows that
+	 * meet the criteria in $where_col_n_values. This particular function ignores whether the items have been soft-deleted or not.
+	 * Note: because this item will be soft-deleted only,
+	 * doesn't block because of model dependencies
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param bool  $block_deletes
+	 * @return boolean
+	 */
+	public function delete($query_params = array(), $block_deletes = false)
+	{
+		// no matter what, we WON'T block soft deletes.
+		return $this->delete_or_restore(true, $query_params);
+	}
+
+
+
+	/**
+	 * 'Un-deletes' the chosen items. Note that this model is a SOFT-DELETABLE model! That means that, by default, trashed/soft-deleted
+	 * items are ignored in queries. However, this particular function ignores whether the items have been soft-deleted or not.
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return boolean
+	 */
+	public function restore($query_params = array())
+	{
+		return $this->delete_or_restore(false, $query_params);
+	}
+
+
+
+	/**
+	 * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
+	 *
+	 * @param boolean $delete       true to indicate deletion, false to indicate restoration
+	 * @param array   $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return boolean
+	 */
+	public function delete_or_restore($delete = true, $query_params = array())
+	{
+		$deletedFlagFieldName = $this->deleted_field_name();
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		if ($this->update(array($deletedFlagFieldName => $delete), $query_params)) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Updates all the items of this model which match the $query params, regardless of whether
+	 * they've been soft-deleted or not
+	 *
+	 * @param array   $fields_n_values         like EEM_Base::update's $fields_n_value
+	 * @param array   $query_params            like EEM_base::get_all's $query_params
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
+	 *                                         in this model's entity map according to $fields_n_values that match $query_params. This
+	 *                                         obviously has some overhead, so you can disable it by setting this to FALSE, but
+	 *                                         be aware that model objects being used could get out-of-sync with the database
+	 * @return int number of items updated
+	 */
+	public function update_deleted_and_undeleted($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return $this->update($fields_n_values, $query_params, $keep_model_objs_in_sync);
+	}
 }

core/helpers/EEH_HTML.helper.php

Indentation +862 added lines, -862 removed lines

@@ -1,876 +1,876 @@
 <?php
 
  /**
- *
- * Class EEH_HTML
- *
+  *
+  * Class EEH_HTML
+  *
   * Sometimes when writing PHP you need to generate some standard HTML,
   * but either not enough to warrant creating a template file,
   * or the amount of PHP conditionals and/or loops peppered throughout the HTML
   * just make it really ugly and difficult to read.
   * This class simply adds a bunch of methods for generating basic HTML tags.
   * Most of the methods have the same name as the HTML tag they generate, and most have the same set of parameters.
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author              Brent Christensen
- *
- *
- */
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author              Brent Christensen
+  *
+  *
+  */
 class EEH_HTML
 {
 
-    /**
-     *  instance of the EEH_Autoloader object
-     *  @var    $_instance
-     *  @access     private
-     */
-    private static $_instance;
-
-    /**
-     *  @var array  $_indent
-     *  @access     private
-     */
-    private static $_indent = array();
-
-
-
-    /**
-     *  @singleton method used to instantiate class object
-     *  @access public
-     *  @return EEH_HTML
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_HTML) {
-            self::$_instance = new EEH_HTML();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     *  class constructor
-     *
-     * @access    private
-     * @return \EEH_HTML
-     */
-    private function __construct()
-    {
-        // set some initial formatting for table indentation
-        EEH_HTML::$_indent = array(
-            'table'     => 0,
-            'thead' => 1,
-            'tbody' => 1,
-            'tr'    => 2,
-            'th'    => 3,
-            'td'    => 3,
-            'div'   => 0,
-            'h1'    => 0,
-            'h2'    => 0,
-            'h3'    => 0,
-            'h4'    => 0,
-            'h5'    => 0,
-            'h6'    => 0,
-            'p'     => 0,
-            'ul'    => 0,
-            'li'    => 1
-        );
-    }
-
-
-
-    /**
-     * Generates an opening HTML <XX> tag and adds any passed attributes
-     * if passed content, it will also add that, as well as the closing </XX> tag
-     *
-     * @access protected
-     * @param string $tag
-     * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @param bool   $force_close
-     * @return string
-     */
-    protected static function _open_tag(
-        $tag = 'div',
-        $content = '',
-        $id = '',
-        $class = '',
-        $style = '',
-        $other_attributes = '',
-        $force_close = false
-    ) {
-        $attributes = ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        $html = EEH_HTML::nl(0, $tag) . '<' . $tag . $attributes . '>';
-        $html .= ! empty($content) ? EEH_HTML::nl(1, $tag) . $content : '';
-        $indent = ! empty($content) || $force_close ? true : false;
-        $html .= ! empty($content) || $force_close ? EEH_HTML::_close_tag($tag, $id, $class, $indent) : '';
-        return $html;
-    }
-
-
-
-    /**
-     * Generates HTML closing </XX> tag - if passed the id or class attribute
-     * used for the opening tag, will append a comment
-     *
+	/**
+	 *  instance of the EEH_Autoloader object
+	 *  @var    $_instance
+	 *  @access     private
+	 */
+	private static $_instance;
+
+	/**
+	 *  @var array  $_indent
+	 *  @access     private
+	 */
+	private static $_indent = array();
+
+
+
+	/**
+	 *  @singleton method used to instantiate class object
+	 *  @access public
+	 *  @return EEH_HTML
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EEH_HTML) {
+			self::$_instance = new EEH_HTML();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 *  class constructor
+	 *
+	 * @access    private
+	 * @return \EEH_HTML
+	 */
+	private function __construct()
+	{
+		// set some initial formatting for table indentation
+		EEH_HTML::$_indent = array(
+			'table'     => 0,
+			'thead' => 1,
+			'tbody' => 1,
+			'tr'    => 2,
+			'th'    => 3,
+			'td'    => 3,
+			'div'   => 0,
+			'h1'    => 0,
+			'h2'    => 0,
+			'h3'    => 0,
+			'h4'    => 0,
+			'h5'    => 0,
+			'h6'    => 0,
+			'p'     => 0,
+			'ul'    => 0,
+			'li'    => 1
+		);
+	}
+
+
+
+	/**
+	 * Generates an opening HTML <XX> tag and adds any passed attributes
+	 * if passed content, it will also add that, as well as the closing </XX> tag
+	 *
+	 * @access protected
+	 * @param string $tag
+	 * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @param bool   $force_close
+	 * @return string
+	 */
+	protected static function _open_tag(
+		$tag = 'div',
+		$content = '',
+		$id = '',
+		$class = '',
+		$style = '',
+		$other_attributes = '',
+		$force_close = false
+	) {
+		$attributes = ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
+		$attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
+		$attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
+		$attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+		$html = EEH_HTML::nl(0, $tag) . '<' . $tag . $attributes . '>';
+		$html .= ! empty($content) ? EEH_HTML::nl(1, $tag) . $content : '';
+		$indent = ! empty($content) || $force_close ? true : false;
+		$html .= ! empty($content) || $force_close ? EEH_HTML::_close_tag($tag, $id, $class, $indent) : '';
+		return $html;
+	}
+
+
+
+	/**
+	 * Generates HTML closing </XX> tag - if passed the id or class attribute
+	 * used for the opening tag, will append a comment
+	 *
 *@access protected
-     * @param string $tag
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param bool   $indent
-     * @return string
-     */
-    protected static function _close_tag($tag = 'div', $id = '', $class = '', $indent = true)
-    {
-        $comment = '';
-        if ($id) {
-            $comment = EEH_HTML::comment('close ' . $id) . EEH_HTML::nl(0, $tag);
-        } elseif ($class) {
-            $comment = EEH_HTML::comment('close ' . $class) . EEH_HTML::nl(0, $tag);
-        }
-        $html = $indent ? EEH_HTML::nl(-1, $tag) : '';
-        $html .= '</' . $tag . '>' . $comment;
-        return $html;
-    }
-
-
-
-    /**
-     *  div - generates HTML opening <div> tag and adds any passed attributes
-     *  to add an id use:       echo EEH_HTML::div( 'this is some content', 'footer' );
-     *  to add a class use:     echo EEH_HTML::div( 'this is some content', '', 'float_left' );
-     *  to add a both an id and a class use:    echo EEH_HTML::div( 'this is some content', 'footer', 'float_left' );
-     *
-     * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function div($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('div', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-
-    /**
-     * Generates HTML closing </div> tag - if passed the id or class attribute used for the opening div tag, will append a comment
-     * usage: echo EEH_HTML::divx();
-     *
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function divx($id = '', $class = '')
-    {
-        return EEH_HTML::_close_tag('div', $id, $class);
-    }
-
-
-
-    /**
-     * Generates HTML <h1></h1> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h1( 'This is a Heading' );
-     *
-     * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h1($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('h1', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-
-    /**
-     * Generates HTML <h2></h2> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h2( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h2($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('h2', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-
-    /**
-     * Generates HTML <h3></h3> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h3( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h3($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('h3', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-
-    /**
-     * Generates HTML <h4></h4> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h4( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h4($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('h4', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-
-    /**
-     * Generates HTML <h5></h5> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h5( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h5($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('h5', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-
-    /**
-     * Generates HTML <h6></h6> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h6( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h6($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('h6', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-
-    /**
-     * Generates HTML <p></p> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::p( 'this is a paragraph' );
-     *
-     * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function p($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('p', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-
-    /**
-     *  ul - generates HTML opening <ul> tag and adds any passed attributes
-     *  usage:      echo EEH_HTML::ul( 'my-list-id', 'my-list-class' );
-     *
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function ul($id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('ul', '', $id, $class, $style, $other_attributes);
-    }
-
-
-
-    /**
-     * Generates HTML closing </ul> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
-     * usage: echo EEH_HTML::ulx();
-     *
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function ulx($id = '', $class = '')
-    {
-        return EEH_HTML::_close_tag('ul', $id, $class);
-    }
-
-
-
-    /**
-     * Generates HTML <li> tag, inserts content, and adds any passed attributes
-     * if passed content, it will also add that, as well as the closing </li> tag
-     * usage: echo EEH_HTML::li( 'this is a line item' );
-     *
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function li($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('li', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-
-    /**
-     * Generates HTML closing </li> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
-     * usage: echo EEH_HTML::lix();
-     *
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function lix($id = '', $class = '')
-    {
-        return EEH_HTML::_close_tag('li', $id, $class);
-    }
-
-
-
-    /**
-     *    table - generates an HTML <table> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::table();
-     *
-     * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function table($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('table', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-
-    /**
-     * tablex - generates an HTML </table> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
-     *
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function tablex($id = '', $class = '')
-    {
-        return EEH_HTML::_close_tag('table', $id, $class);
-    }
-
-
-
-    /**
-     *    thead - generates an HTML <thead> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::thead();
-     *
-     * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function thead($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('thead', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-
-    /**
-     * theadx - generates an HTML </thead> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
-     *
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function theadx($id = '', $class = '')
-    {
-        return EEH_HTML::_close_tag('thead', $id, $class);
-    }
-
-
-
-    /**
-     *    tbody - generates an HTML <tbody> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::tbody();
-     *
-     * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function tbody($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('tbody', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-
-    /**
-     * tbodyx - generates an HTML </tbody> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
-     *
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function tbodyx($id = '', $class = '')
-    {
-        return EEH_HTML::_close_tag('tbody', $id, $class);
-    }
-
-
-
-    /**
-     *    tr - generates an HTML <tr> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::tr();
-     *
-     * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function tr($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('tr', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-
-    /**
-     * trx - generates an HTML </tr> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
-     *
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function trx($id = '', $class = '')
-    {
-        return EEH_HTML::_close_tag('tr', $id, $class);
-    }
-
-
-
-    /**
-     *    th - generates an HTML <th> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::th();
-     *
-     * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function th($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('th', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-
-    /**
-     * thx - generates an HTML </th> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
-     *
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function thx($id = '', $class = '')
-    {
-        return EEH_HTML::_close_tag('th', $id, $class);
-    }
-
-
-
-    /**
-     *    td - generates an HTML <td> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::td();
-     *
-     * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function td($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_open_tag('td', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-
-    /**
-     * tdx - generates an HTML </td> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
-     *
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function tdx($id = '', $class = '')
-    {
-        return EEH_HTML::_close_tag('td', $id, $class);
-    }
-
-
-
-    /**
-     * no_row - for generating a "hidden" table row, good for embedding tables within tables
-     * generates a new table row with one td cell that spans however many columns you set
-     * removes all styles from the tr and td
-     *
-     * @param string $content
-     * @param int    $colspan
-     * @return string
-     */
-    public static function no_row($content = '', $colspan = 2)
-    {
-        return EEH_HTML::tr(
-            EEH_HTML::td($content, '', '', 'padding:0; border:none;', 'colspan="' . $colspan . '"'),
-            '',
-            '',
-            'padding:0; border:none;'
-        );
-    }
-
-
-
-    /**
-     * Generates HTML <label></label> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::span( 'this is some inline text' );
-     *
-     * @access public
-     * @param string $href URL to link to
-     * @param string $link_text - the text that will become "hyperlinked"
-     * @param string $title - html title attribute
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function link($href = '', $link_text = '', $title = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        $link_text = ! empty($link_text) ? $link_text : $href;
-        $attributes = ! empty($href) ? ' href="' . $href . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($title) ? ' title="' . esc_attr($title) . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return "<a{$attributes}>{$link_text}</a>";
-    }
-
-
-
-    /**
-     *    img - generates an HTML <img> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::img();
-     *
-     * @param string $src - html src attribute ie: the path or URL to the image
-     * @param string $alt - html alt attribute
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function img($src = '', $alt = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        $attributes = ! empty($src) ? ' src="' . esc_url_raw($src) . '"' : '';
-        $attributes .= ! empty($alt) ? ' alt="' . esc_attr($alt) . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return '<img' . $attributes  . '/>';
-    }
-
-
-
-    /**
-     * Generates HTML <label></label> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::span( 'this is some inline text' );
-     *
-     * @access protected
-     * @param string $tag
-     * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    protected static function _inline_tag($tag = 'span', $content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        $attributes = ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return '<' . $tag . ' ' . $attributes . '>'  . $content  . '</' . $tag . '>';
-    }
-
-
-
-    /**
-     * Generates HTML <label></label> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::span( 'this is some inline text' );
-     *
-     * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function label($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_inline_tag('label', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-
-    /**
-     * Generates HTML <span></span> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::span( 'this is some inline text' );
-     *
-     * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function span($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_inline_tag('span', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-
-    /**
-     * Generates HTML <span></span> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::span( 'this is some inline text' );
-     *
-     * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id - html id attribute
-     * @param string $class - html class attribute
-     * @param string $style - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function strong($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
-    {
-        return EEH_HTML::_inline_tag('strong', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-
-    /**
-     * Generates an html <--  comment --> tag
-     *  usage: echo comment( 'this is a comment' );
-     *
-     * @param string $comment
-     * @return string
-     */
-    public static function comment($comment = '')
-    {
-        return ! empty($comment) ? EEH_HTML::nl() . '<!-- ' . $comment . ' -->' : '';
-    }
-
-
-
-    /**
-     * br - generates a line break
-     *
-     * @param int $nmbr - the number of line breaks to return
-     * @return string
-     */
-    public static function br($nmbr = 1)
-    {
-        return str_repeat('<br />', $nmbr);
-    }
-
-
-
-    /**
-     * nbsp - generates non-breaking space entities based on number supplied
-     *
-     * @param int $nmbr - the number of non-breaking spaces to return
-     * @return string
-     */
-    public static function nbsp($nmbr = 1)
-    {
-        return str_repeat('&nbsp;', $nmbr);
-    }
-
-
-
-    /**
-     * sanitize_id
-     *
-     * functionally does the same as the wp_core function sanitize_key except it does NOT use
-     * strtolower and allows capitals.
-     *
-     * @param string $id
-     * @return string
-     */
-    public static function sanitize_id($id = '')
-    {
-        $key = str_replace(' ', '-', trim($id));
-        return preg_replace('/[^a-zA-Z0-9_\-]/', '', $key);
-    }
-
-
-
-    /**
-     * return a newline and tabs ("nl" stands for "new line")
-     *
-     * @param int    $indent the number of tabs to ADD to the current indent (can be negative or zero)
-     * @param string $tag
-     * @return string - newline character plus # of indents passed (can be + or -)
-     */
-    public static function nl($indent = 0, $tag = 'none')
-    {
-        $html = "\n";
-        EEH_HTML::indent($indent, $tag);
-        for ($x = 0; $x < EEH_HTML::$_indent[ $tag ]; $x++) {
-            $html .= "\t";
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * Changes the indents used in EEH_HTML::nl. Often its convenient to change
-     * the indentation level without actually creating a new line
-     *
-     * @param int    $indent can be negative to decrease the indentation level
-     * @param string $tag
-     */
-    public static function indent($indent, $tag = 'none')
-    {
-        static $default_indentation = false;
-        if (! $default_indentation) {
-            EEH_HTML::_set_default_indentation();
-            $default_indentation = true;
-        }
-        if (! isset(EEH_HTML::$_indent[ $tag ])) {
-            EEH_HTML::$_indent[ $tag ] = 0;
-        }
-        EEH_HTML::$_indent[ $tag ] += (int) $indent;
-        EEH_HTML::$_indent[ $tag ] = EEH_HTML::$_indent[ $tag ] >= 0 ? EEH_HTML::$_indent[ $tag ] : 0;
-    }
-
-
-    /**
-     *  class _set_default_indentation
-     *
-     * @access    private
-     */
-    private static function _set_default_indentation()
-    {
-        // set some initial formatting for table indentation
-        EEH_HTML::$_indent = array(
-            'none'  => 0,
-            'form'  => 0,
-            'radio'     => 0,
-            'checkbox'  => 0,
-            'select'    => 0,
-            'option' => 0,
-            'optgroup' => 0,
-            'table'     => 1,
-            'thead' => 2,
-            'tbody' => 2,
-            'tr'    => 3,
-            'th'    => 4,
-            'td'    => 4,
-            'div'   => 0,
-            'h1'    => 0,
-            'h2'    => 0,
-            'h3'    => 0,
-            'h4'    => 0,
-            'h5'    => 0,
-            'h6'    => 0,
-            'p'     => 0,
-            'ul'    => 0,
-            'li'    => 1
-        );
-    }
-
-
-
-    /**
-     * Retrieves the list of tags considered "simple", that are probably safe for
-     * use in inputs
-     * @global array $allowedtags
-     * @return array
-     */
-    public static function get_simple_tags()
-    {
-        global $allowedtags;
-        $tags_we_allow['p'] = array();
-        $tags_we_allow = array_merge_recursive(
-            $allowedtags,
-            array(
-                'ol' => array(),
-                'ul' => array(),
-                'li' => array(),
-                'br' => array(),
-                'p' => array(),
-                'a' => array('target')
-            )
-        );
-        return apply_filters('FHEE__EEH_HTML__get_simple_tags', $tags_we_allow);
-    }
+	 * @param string $tag
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param bool   $indent
+	 * @return string
+	 */
+	protected static function _close_tag($tag = 'div', $id = '', $class = '', $indent = true)
+	{
+		$comment = '';
+		if ($id) {
+			$comment = EEH_HTML::comment('close ' . $id) . EEH_HTML::nl(0, $tag);
+		} elseif ($class) {
+			$comment = EEH_HTML::comment('close ' . $class) . EEH_HTML::nl(0, $tag);
+		}
+		$html = $indent ? EEH_HTML::nl(-1, $tag) : '';
+		$html .= '</' . $tag . '>' . $comment;
+		return $html;
+	}
+
+
+
+	/**
+	 *  div - generates HTML opening <div> tag and adds any passed attributes
+	 *  to add an id use:       echo EEH_HTML::div( 'this is some content', 'footer' );
+	 *  to add a class use:     echo EEH_HTML::div( 'this is some content', '', 'float_left' );
+	 *  to add a both an id and a class use:    echo EEH_HTML::div( 'this is some content', 'footer', 'float_left' );
+	 *
+	 * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function div($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('div', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+
+	/**
+	 * Generates HTML closing </div> tag - if passed the id or class attribute used for the opening div tag, will append a comment
+	 * usage: echo EEH_HTML::divx();
+	 *
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function divx($id = '', $class = '')
+	{
+		return EEH_HTML::_close_tag('div', $id, $class);
+	}
+
+
+
+	/**
+	 * Generates HTML <h1></h1> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h1( 'This is a Heading' );
+	 *
+	 * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h1($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('h1', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+
+	/**
+	 * Generates HTML <h2></h2> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h2( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h2($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('h2', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+
+	/**
+	 * Generates HTML <h3></h3> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h3( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h3($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('h3', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+
+	/**
+	 * Generates HTML <h4></h4> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h4( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h4($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('h4', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+
+	/**
+	 * Generates HTML <h5></h5> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h5( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h5($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('h5', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+
+	/**
+	 * Generates HTML <h6></h6> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h6( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h6($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('h6', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+
+	/**
+	 * Generates HTML <p></p> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::p( 'this is a paragraph' );
+	 *
+	 * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function p($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('p', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+
+	/**
+	 *  ul - generates HTML opening <ul> tag and adds any passed attributes
+	 *  usage:      echo EEH_HTML::ul( 'my-list-id', 'my-list-class' );
+	 *
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function ul($id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('ul', '', $id, $class, $style, $other_attributes);
+	}
+
+
+
+	/**
+	 * Generates HTML closing </ul> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
+	 * usage: echo EEH_HTML::ulx();
+	 *
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function ulx($id = '', $class = '')
+	{
+		return EEH_HTML::_close_tag('ul', $id, $class);
+	}
+
+
+
+	/**
+	 * Generates HTML <li> tag, inserts content, and adds any passed attributes
+	 * if passed content, it will also add that, as well as the closing </li> tag
+	 * usage: echo EEH_HTML::li( 'this is a line item' );
+	 *
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function li($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('li', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+
+	/**
+	 * Generates HTML closing </li> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
+	 * usage: echo EEH_HTML::lix();
+	 *
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function lix($id = '', $class = '')
+	{
+		return EEH_HTML::_close_tag('li', $id, $class);
+	}
+
+
+
+	/**
+	 *    table - generates an HTML <table> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::table();
+	 *
+	 * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function table($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('table', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+
+	/**
+	 * tablex - generates an HTML </table> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
+	 *
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function tablex($id = '', $class = '')
+	{
+		return EEH_HTML::_close_tag('table', $id, $class);
+	}
+
+
+
+	/**
+	 *    thead - generates an HTML <thead> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::thead();
+	 *
+	 * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function thead($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('thead', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+
+	/**
+	 * theadx - generates an HTML </thead> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
+	 *
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function theadx($id = '', $class = '')
+	{
+		return EEH_HTML::_close_tag('thead', $id, $class);
+	}
+
+
+
+	/**
+	 *    tbody - generates an HTML <tbody> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::tbody();
+	 *
+	 * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function tbody($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('tbody', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+
+	/**
+	 * tbodyx - generates an HTML </tbody> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
+	 *
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function tbodyx($id = '', $class = '')
+	{
+		return EEH_HTML::_close_tag('tbody', $id, $class);
+	}
+
+
+
+	/**
+	 *    tr - generates an HTML <tr> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::tr();
+	 *
+	 * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function tr($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('tr', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+
+	/**
+	 * trx - generates an HTML </tr> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
+	 *
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function trx($id = '', $class = '')
+	{
+		return EEH_HTML::_close_tag('tr', $id, $class);
+	}
+
+
+
+	/**
+	 *    th - generates an HTML <th> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::th();
+	 *
+	 * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function th($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('th', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+
+	/**
+	 * thx - generates an HTML </th> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
+	 *
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function thx($id = '', $class = '')
+	{
+		return EEH_HTML::_close_tag('th', $id, $class);
+	}
+
+
+
+	/**
+	 *    td - generates an HTML <td> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::td();
+	 *
+	 * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function td($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_open_tag('td', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+
+	/**
+	 * tdx - generates an HTML </td> tag - if passed the id or class attribute used for the opening ul tag, will append a comment
+	 *
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function tdx($id = '', $class = '')
+	{
+		return EEH_HTML::_close_tag('td', $id, $class);
+	}
+
+
+
+	/**
+	 * no_row - for generating a "hidden" table row, good for embedding tables within tables
+	 * generates a new table row with one td cell that spans however many columns you set
+	 * removes all styles from the tr and td
+	 *
+	 * @param string $content
+	 * @param int    $colspan
+	 * @return string
+	 */
+	public static function no_row($content = '', $colspan = 2)
+	{
+		return EEH_HTML::tr(
+			EEH_HTML::td($content, '', '', 'padding:0; border:none;', 'colspan="' . $colspan . '"'),
+			'',
+			'',
+			'padding:0; border:none;'
+		);
+	}
+
+
+
+	/**
+	 * Generates HTML <label></label> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::span( 'this is some inline text' );
+	 *
+	 * @access public
+	 * @param string $href URL to link to
+	 * @param string $link_text - the text that will become "hyperlinked"
+	 * @param string $title - html title attribute
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function link($href = '', $link_text = '', $title = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		$link_text = ! empty($link_text) ? $link_text : $href;
+		$attributes = ! empty($href) ? ' href="' . $href . '"' : '';
+		$attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
+		$attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
+		$attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
+		$attributes .= ! empty($title) ? ' title="' . esc_attr($title) . '"' : '';
+		$attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+		return "<a{$attributes}>{$link_text}</a>";
+	}
+
+
+
+	/**
+	 *    img - generates an HTML <img> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::img();
+	 *
+	 * @param string $src - html src attribute ie: the path or URL to the image
+	 * @param string $alt - html alt attribute
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function img($src = '', $alt = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		$attributes = ! empty($src) ? ' src="' . esc_url_raw($src) . '"' : '';
+		$attributes .= ! empty($alt) ? ' alt="' . esc_attr($alt) . '"' : '';
+		$attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
+		$attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
+		$attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
+		$attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+		return '<img' . $attributes  . '/>';
+	}
+
+
+
+	/**
+	 * Generates HTML <label></label> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::span( 'this is some inline text' );
+	 *
+	 * @access protected
+	 * @param string $tag
+	 * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	protected static function _inline_tag($tag = 'span', $content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		$attributes = ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
+		$attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
+		$attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
+		$attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+		return '<' . $tag . ' ' . $attributes . '>'  . $content  . '</' . $tag . '>';
+	}
+
+
+
+	/**
+	 * Generates HTML <label></label> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::span( 'this is some inline text' );
+	 *
+	 * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function label($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_inline_tag('label', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+
+	/**
+	 * Generates HTML <span></span> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::span( 'this is some inline text' );
+	 *
+	 * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function span($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_inline_tag('span', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+
+	/**
+	 * Generates HTML <span></span> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::span( 'this is some inline text' );
+	 *
+	 * @param string $content - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id - html id attribute
+	 * @param string $class - html class attribute
+	 * @param string $style - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function strong($content = '', $id = '', $class = '', $style = '', $other_attributes = '')
+	{
+		return EEH_HTML::_inline_tag('strong', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+
+	/**
+	 * Generates an html <--  comment --> tag
+	 *  usage: echo comment( 'this is a comment' );
+	 *
+	 * @param string $comment
+	 * @return string
+	 */
+	public static function comment($comment = '')
+	{
+		return ! empty($comment) ? EEH_HTML::nl() . '<!-- ' . $comment . ' -->' : '';
+	}
+
+
+
+	/**
+	 * br - generates a line break
+	 *
+	 * @param int $nmbr - the number of line breaks to return
+	 * @return string
+	 */
+	public static function br($nmbr = 1)
+	{
+		return str_repeat('<br />', $nmbr);
+	}
+
+
+
+	/**
+	 * nbsp - generates non-breaking space entities based on number supplied
+	 *
+	 * @param int $nmbr - the number of non-breaking spaces to return
+	 * @return string
+	 */
+	public static function nbsp($nmbr = 1)
+	{
+		return str_repeat('&nbsp;', $nmbr);
+	}
+
+
+
+	/**
+	 * sanitize_id
+	 *
+	 * functionally does the same as the wp_core function sanitize_key except it does NOT use
+	 * strtolower and allows capitals.
+	 *
+	 * @param string $id
+	 * @return string
+	 */
+	public static function sanitize_id($id = '')
+	{
+		$key = str_replace(' ', '-', trim($id));
+		return preg_replace('/[^a-zA-Z0-9_\-]/', '', $key);
+	}
+
+
+
+	/**
+	 * return a newline and tabs ("nl" stands for "new line")
+	 *
+	 * @param int    $indent the number of tabs to ADD to the current indent (can be negative or zero)
+	 * @param string $tag
+	 * @return string - newline character plus # of indents passed (can be + or -)
+	 */
+	public static function nl($indent = 0, $tag = 'none')
+	{
+		$html = "\n";
+		EEH_HTML::indent($indent, $tag);
+		for ($x = 0; $x < EEH_HTML::$_indent[ $tag ]; $x++) {
+			$html .= "\t";
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * Changes the indents used in EEH_HTML::nl. Often its convenient to change
+	 * the indentation level without actually creating a new line
+	 *
+	 * @param int    $indent can be negative to decrease the indentation level
+	 * @param string $tag
+	 */
+	public static function indent($indent, $tag = 'none')
+	{
+		static $default_indentation = false;
+		if (! $default_indentation) {
+			EEH_HTML::_set_default_indentation();
+			$default_indentation = true;
+		}
+		if (! isset(EEH_HTML::$_indent[ $tag ])) {
+			EEH_HTML::$_indent[ $tag ] = 0;
+		}
+		EEH_HTML::$_indent[ $tag ] += (int) $indent;
+		EEH_HTML::$_indent[ $tag ] = EEH_HTML::$_indent[ $tag ] >= 0 ? EEH_HTML::$_indent[ $tag ] : 0;
+	}
+
+
+	/**
+	 *  class _set_default_indentation
+	 *
+	 * @access    private
+	 */
+	private static function _set_default_indentation()
+	{
+		// set some initial formatting for table indentation
+		EEH_HTML::$_indent = array(
+			'none'  => 0,
+			'form'  => 0,
+			'radio'     => 0,
+			'checkbox'  => 0,
+			'select'    => 0,
+			'option' => 0,
+			'optgroup' => 0,
+			'table'     => 1,
+			'thead' => 2,
+			'tbody' => 2,
+			'tr'    => 3,
+			'th'    => 4,
+			'td'    => 4,
+			'div'   => 0,
+			'h1'    => 0,
+			'h2'    => 0,
+			'h3'    => 0,
+			'h4'    => 0,
+			'h5'    => 0,
+			'h6'    => 0,
+			'p'     => 0,
+			'ul'    => 0,
+			'li'    => 1
+		);
+	}
+
+
+
+	/**
+	 * Retrieves the list of tags considered "simple", that are probably safe for
+	 * use in inputs
+	 * @global array $allowedtags
+	 * @return array
+	 */
+	public static function get_simple_tags()
+	{
+		global $allowedtags;
+		$tags_we_allow['p'] = array();
+		$tags_we_allow = array_merge_recursive(
+			$allowedtags,
+			array(
+				'ol' => array(),
+				'ul' => array(),
+				'li' => array(),
+				'br' => array(),
+				'p' => array(),
+				'a' => array('target')
+			)
+		);
+		return apply_filters('FHEE__EEH_HTML__get_simple_tags', $tags_we_allow);
+	}
 }

Spacing +36 added lines, -36 removed lines

@@ -43,7 +43,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_HTML) {
+        if ( ! self::$_instance instanceof EEH_HTML) {
             self::$_instance = new EEH_HTML();
         }
         return self::$_instance;
@@ -105,12 +105,12 @@ 
         $other_attributes = '',
         $force_close = false
     ) {
-        $attributes = ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        $html = EEH_HTML::nl(0, $tag) . '<' . $tag . $attributes . '>';
-        $html .= ! empty($content) ? EEH_HTML::nl(1, $tag) . $content : '';
+        $attributes = ! empty($id) ? ' id="'.EEH_HTML::sanitize_id($id).'"' : '';
+        $attributes .= ! empty($class) ? ' class="'.$class.'"' : '';
+        $attributes .= ! empty($style) ? ' style="'.$style.'"' : '';
+        $attributes .= ! empty($other_attributes) ? ' '.$other_attributes : '';
+        $html = EEH_HTML::nl(0, $tag).'<'.$tag.$attributes.'>';
+        $html .= ! empty($content) ? EEH_HTML::nl(1, $tag).$content : '';
         $indent = ! empty($content) || $force_close ? true : false;
         $html .= ! empty($content) || $force_close ? EEH_HTML::_close_tag($tag, $id, $class, $indent) : '';
         return $html;
@@ -133,12 +133,12 @@ 
     {
         $comment = '';
         if ($id) {
-            $comment = EEH_HTML::comment('close ' . $id) . EEH_HTML::nl(0, $tag);
+            $comment = EEH_HTML::comment('close '.$id).EEH_HTML::nl(0, $tag);
         } elseif ($class) {
-            $comment = EEH_HTML::comment('close ' . $class) . EEH_HTML::nl(0, $tag);
+            $comment = EEH_HTML::comment('close '.$class).EEH_HTML::nl(0, $tag);
         }
         $html = $indent ? EEH_HTML::nl(-1, $tag) : '';
-        $html .= '</' . $tag . '>' . $comment;
+        $html .= '</'.$tag.'>'.$comment;
         return $html;
     }
 
@@ -575,7 +575,7 @@ 
     public static function no_row($content = '', $colspan = 2)
     {
         return EEH_HTML::tr(
-            EEH_HTML::td($content, '', '', 'padding:0; border:none;', 'colspan="' . $colspan . '"'),
+            EEH_HTML::td($content, '', '', 'padding:0; border:none;', 'colspan="'.$colspan.'"'),
             '',
             '',
             'padding:0; border:none;'
@@ -601,12 +601,12 @@ 
     public static function link($href = '', $link_text = '', $title = '', $id = '', $class = '', $style = '', $other_attributes = '')
     {
         $link_text = ! empty($link_text) ? $link_text : $href;
-        $attributes = ! empty($href) ? ' href="' . $href . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($title) ? ' title="' . esc_attr($title) . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+        $attributes = ! empty($href) ? ' href="'.$href.'"' : '';
+        $attributes .= ! empty($id) ? ' id="'.EEH_HTML::sanitize_id($id).'"' : '';
+        $attributes .= ! empty($class) ? ' class="'.$class.'"' : '';
+        $attributes .= ! empty($style) ? ' style="'.$style.'"' : '';
+        $attributes .= ! empty($title) ? ' title="'.esc_attr($title).'"' : '';
+        $attributes .= ! empty($other_attributes) ? ' '.$other_attributes : '';
         return "<a{$attributes}>{$link_text}</a>";
     }
 
@@ -626,13 +626,13 @@ 
      */
     public static function img($src = '', $alt = '', $id = '', $class = '', $style = '', $other_attributes = '')
     {
-        $attributes = ! empty($src) ? ' src="' . esc_url_raw($src) . '"' : '';
-        $attributes .= ! empty($alt) ? ' alt="' . esc_attr($alt) . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return '<img' . $attributes  . '/>';
+        $attributes = ! empty($src) ? ' src="'.esc_url_raw($src).'"' : '';
+        $attributes .= ! empty($alt) ? ' alt="'.esc_attr($alt).'"' : '';
+        $attributes .= ! empty($id) ? ' id="'.EEH_HTML::sanitize_id($id).'"' : '';
+        $attributes .= ! empty($class) ? ' class="'.$class.'"' : '';
+        $attributes .= ! empty($style) ? ' style="'.$style.'"' : '';
+        $attributes .= ! empty($other_attributes) ? ' '.$other_attributes : '';
+        return '<img'.$attributes.'/>';
     }
 
 
@@ -652,11 +652,11 @@ 
      */
     protected static function _inline_tag($tag = 'span', $content = '', $id = '', $class = '', $style = '', $other_attributes = '')
     {
-        $attributes = ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return '<' . $tag . ' ' . $attributes . '>'  . $content  . '</' . $tag . '>';
+        $attributes = ! empty($id) ? ' id="'.EEH_HTML::sanitize_id($id).'"' : '';
+        $attributes .= ! empty($class) ? ' class="'.$class.'"' : '';
+        $attributes .= ! empty($style) ? ' style="'.$style.'"' : '';
+        $attributes .= ! empty($other_attributes) ? ' '.$other_attributes : '';
+        return '<'.$tag.' '.$attributes.'>'.$content.'</'.$tag.'>';
     }
 
 
@@ -724,7 +724,7 @@ 
      */
     public static function comment($comment = '')
     {
-        return ! empty($comment) ? EEH_HTML::nl() . '<!-- ' . $comment . ' -->' : '';
+        return ! empty($comment) ? EEH_HTML::nl().'<!-- '.$comment.' -->' : '';
     }
 
 
@@ -783,7 +783,7 @@ 
     {
         $html = "\n";
         EEH_HTML::indent($indent, $tag);
-        for ($x = 0; $x < EEH_HTML::$_indent[ $tag ]; $x++) {
+        for ($x = 0; $x < EEH_HTML::$_indent[$tag]; $x++) {
             $html .= "\t";
         }
         return $html;
@@ -801,15 +801,15 @@ 
     public static function indent($indent, $tag = 'none')
     {
         static $default_indentation = false;
-        if (! $default_indentation) {
+        if ( ! $default_indentation) {
             EEH_HTML::_set_default_indentation();
             $default_indentation = true;
         }
-        if (! isset(EEH_HTML::$_indent[ $tag ])) {
-            EEH_HTML::$_indent[ $tag ] = 0;
+        if ( ! isset(EEH_HTML::$_indent[$tag])) {
+            EEH_HTML::$_indent[$tag] = 0;
         }
-        EEH_HTML::$_indent[ $tag ] += (int) $indent;
-        EEH_HTML::$_indent[ $tag ] = EEH_HTML::$_indent[ $tag ] >= 0 ? EEH_HTML::$_indent[ $tag ] : 0;
+        EEH_HTML::$_indent[$tag] += (int) $indent;
+        EEH_HTML::$_indent[$tag] = EEH_HTML::$_indent[$tag] >= 0 ? EEH_HTML::$_indent[$tag] : 0;
     }
 
 

core/helpers/EEH_Class_Tools.helper.php

Indentation +114 added lines, -114 removed lines

@@ -12,131 +12,131 @@
 class EEH_Class_Tools
 {
 
-    public static $i = 0;
-    public static $file_line = null;
+	public static $i = 0;
+	public static $file_line = null;
 
-    /**
-     *  get_called_class - for PHP versions < 5.3
-     *
-     *  @access     public
-     *  @author origins:  http://stackoverflow.com/a/1542045
-     *  return string
-     */
-    public static function get_called_class()
-    {
-        $backtrace = debug_backtrace();
-        if (isset($backtrace[2]) && is_array($backtrace[2]) && isset($backtrace[2]['class']) && ! isset($backtrace[2]['file'])) {
-            return $backtrace[2]['class'];
-        } elseif (isset($backtrace[3]) && is_array($backtrace[3]) && isset($backtrace[3]['class']) && ! isset($backtrace[3]['file'])) {
-            return $backtrace[3]['class'];
-        } elseif (isset($backtrace[2]) && is_array($backtrace[2]) && isset($backtrace[2]['file']) && isset($backtrace[2]['line'])) {
-            if (self::$file_line == $backtrace[2]['file'] . $backtrace[2]['line']) {
-                self::$i++;
-            } else {
-                self::$i = 0;
-                self::$file_line = $backtrace[2]['file'] . $backtrace[2]['line'];
-            }
-            // was  class method called via call_user_func ?
-            if ($backtrace[2]['function'] == 'call_user_func' && isset($backtrace[2]['args']) && is_array($backtrace[2]['args'])) {
-                if (isset($backtrace[2]['args'][0]) && isset($backtrace[2]['args'][0][0])) {
-                    $called_class = $backtrace[2]['args'][0][0];
-                    // is it an EE function ?
-                    if (strpos($called_class, 'EE') === 0) {
-                        $prefix_chars = strpos($called_class, '_') + 1;
-                        $prefix = substr($called_class, 0, $prefix_chars);
-                        $classname = substr($called_class, $prefix_chars, strlen($called_class));
-                        $classname = $prefix . str_replace(' ', '_', ucwords(strtolower(str_replace('_', ' ', $classname))));
-                        return $classname;
-                    }
-                }
-            } else {
-                $lines = file($backtrace[2]['file']);
-                preg_match_all('/([a-zA-Z0-9\_]+)::' . $backtrace[2]['function'] . '/', $lines[ $backtrace[2]['line'] - 1 ], $matches);
-                if (isset($matches[1]) && isset($matches[1][ self::$i ])) {
-                    return $matches[1][ self::$i ];
-                }
-            }
-        }
-        return false;
-    }
+	/**
+	 *  get_called_class - for PHP versions < 5.3
+	 *
+	 *  @access     public
+	 *  @author origins:  http://stackoverflow.com/a/1542045
+	 *  return string
+	 */
+	public static function get_called_class()
+	{
+		$backtrace = debug_backtrace();
+		if (isset($backtrace[2]) && is_array($backtrace[2]) && isset($backtrace[2]['class']) && ! isset($backtrace[2]['file'])) {
+			return $backtrace[2]['class'];
+		} elseif (isset($backtrace[3]) && is_array($backtrace[3]) && isset($backtrace[3]['class']) && ! isset($backtrace[3]['file'])) {
+			return $backtrace[3]['class'];
+		} elseif (isset($backtrace[2]) && is_array($backtrace[2]) && isset($backtrace[2]['file']) && isset($backtrace[2]['line'])) {
+			if (self::$file_line == $backtrace[2]['file'] . $backtrace[2]['line']) {
+				self::$i++;
+			} else {
+				self::$i = 0;
+				self::$file_line = $backtrace[2]['file'] . $backtrace[2]['line'];
+			}
+			// was  class method called via call_user_func ?
+			if ($backtrace[2]['function'] == 'call_user_func' && isset($backtrace[2]['args']) && is_array($backtrace[2]['args'])) {
+				if (isset($backtrace[2]['args'][0]) && isset($backtrace[2]['args'][0][0])) {
+					$called_class = $backtrace[2]['args'][0][0];
+					// is it an EE function ?
+					if (strpos($called_class, 'EE') === 0) {
+						$prefix_chars = strpos($called_class, '_') + 1;
+						$prefix = substr($called_class, 0, $prefix_chars);
+						$classname = substr($called_class, $prefix_chars, strlen($called_class));
+						$classname = $prefix . str_replace(' ', '_', ucwords(strtolower(str_replace('_', ' ', $classname))));
+						return $classname;
+					}
+				}
+			} else {
+				$lines = file($backtrace[2]['file']);
+				preg_match_all('/([a-zA-Z0-9\_]+)::' . $backtrace[2]['function'] . '/', $lines[ $backtrace[2]['line'] - 1 ], $matches);
+				if (isset($matches[1]) && isset($matches[1][ self::$i ])) {
+					return $matches[1][ self::$i ];
+				}
+			}
+		}
+		return false;
+	}
 
 
 
 
-    /**
-     *  get_class_names_for_all_callbacks_on_hook
-     * returns an array of names for all classes that have methods registered as callbacks for the given action or filter hook
-     *  @access     public
-     *  @param  string  $hook
-     *  @return     array
-     */
-    public static function get_class_names_for_all_callbacks_on_hook($hook = null)
-    {
-        global $wp_filter;
-        $class_names = array();
-        // are any callbacks registered for this hook ?
-        if (isset($wp_filter[ $hook ])) {
-            // loop thru all of the callbacks attached to the deprecated hookpoint
-            foreach ($wp_filter[ $hook ] as $priority) {
-                foreach ($priority as $callback) {
-                    // is the callback a non-static class method ?
-                    if (isset($callback['function']) && is_array($callback['function'])) {
-                        if (isset($callback['function'][0]) && is_object($callback['function'][0])) {
-                            $class_names[] = get_class($callback['function'][0]);
-                        }
-                    // test for static method
-                    } elseif (strpos($callback['function'], '::') !== false) {
-                        $class = explode('::', $callback['function']);
-                        $class_names[] = $class[0];
-                    } else {
-                        // just a function
-                    }
-                }
-            }
-        }
-        return $class_names;
-    }
+	/**
+	 *  get_class_names_for_all_callbacks_on_hook
+	 * returns an array of names for all classes that have methods registered as callbacks for the given action or filter hook
+	 *  @access     public
+	 *  @param  string  $hook
+	 *  @return     array
+	 */
+	public static function get_class_names_for_all_callbacks_on_hook($hook = null)
+	{
+		global $wp_filter;
+		$class_names = array();
+		// are any callbacks registered for this hook ?
+		if (isset($wp_filter[ $hook ])) {
+			// loop thru all of the callbacks attached to the deprecated hookpoint
+			foreach ($wp_filter[ $hook ] as $priority) {
+				foreach ($priority as $callback) {
+					// is the callback a non-static class method ?
+					if (isset($callback['function']) && is_array($callback['function'])) {
+						if (isset($callback['function'][0]) && is_object($callback['function'][0])) {
+							$class_names[] = get_class($callback['function'][0]);
+						}
+					// test for static method
+					} elseif (strpos($callback['function'], '::') !== false) {
+						$class = explode('::', $callback['function']);
+						$class_names[] = $class[0];
+					} else {
+						// just a function
+					}
+				}
+			}
+		}
+		return $class_names;
+	}
 
 
 
 
-    /**
-     *  property_exists() with fallback for PHP versions < 5.3
-     *  @access     public
-     *  @param      mixed object | string   $class
-     *  @param      string  $property
-     *  @return         boolean
-     */
-    public static function has_property($class = null, $property = null)
-    {
-        // if $class or $property don't exist, then get out, cuz that would be like... fatal dude
-        if (empty($class) || empty($property)) {
-            return false;
-        }
-        // if your hosting company doesn't cut the mustard
-        if (version_compare(PHP_VERSION, '5.3.0') < 0) {
-            // just in case $class is an actual instantiated object
-            if (is_object($class)) {
-                return isset($class->{$property}) ? true : false;
-            } else {
-                // use reflection for < PHP 5.3 to get details using just the class name
-                $reflector = new ReflectionClass($class);
-                return $reflector->hasProperty($property);
-            }
-        } else {
-            // or try regular property exists method which works as expected in PHP 5.3+
-            return property_exists($class, $property);
-        }
-    }
+	/**
+	 *  property_exists() with fallback for PHP versions < 5.3
+	 *  @access     public
+	 *  @param      mixed object | string   $class
+	 *  @param      string  $property
+	 *  @return         boolean
+	 */
+	public static function has_property($class = null, $property = null)
+	{
+		// if $class or $property don't exist, then get out, cuz that would be like... fatal dude
+		if (empty($class) || empty($property)) {
+			return false;
+		}
+		// if your hosting company doesn't cut the mustard
+		if (version_compare(PHP_VERSION, '5.3.0') < 0) {
+			// just in case $class is an actual instantiated object
+			if (is_object($class)) {
+				return isset($class->{$property}) ? true : false;
+			} else {
+				// use reflection for < PHP 5.3 to get details using just the class name
+				$reflector = new ReflectionClass($class);
+				return $reflector->hasProperty($property);
+			}
+		} else {
+			// or try regular property exists method which works as expected in PHP 5.3+
+			return property_exists($class, $property);
+		}
+	}
 }
 
 // if PHP version < 5.3
 if (! function_exists('get_called_class')) {
-    /**
-     * @return string
-     */
-    function get_called_class()
-    {
-        return EEH_Class_Tools::get_called_class();
-    }
+	/**
+	 * @return string
+	 */
+	function get_called_class()
+	{
+		return EEH_Class_Tools::get_called_class();
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -30,11 +30,11 @@ 
         } elseif (isset($backtrace[3]) && is_array($backtrace[3]) && isset($backtrace[3]['class']) && ! isset($backtrace[3]['file'])) {
             return $backtrace[3]['class'];
         } elseif (isset($backtrace[2]) && is_array($backtrace[2]) && isset($backtrace[2]['file']) && isset($backtrace[2]['line'])) {
-            if (self::$file_line == $backtrace[2]['file'] . $backtrace[2]['line']) {
+            if (self::$file_line == $backtrace[2]['file'].$backtrace[2]['line']) {
                 self::$i++;
             } else {
                 self::$i = 0;
-                self::$file_line = $backtrace[2]['file'] . $backtrace[2]['line'];
+                self::$file_line = $backtrace[2]['file'].$backtrace[2]['line'];
             }
             // was  class method called via call_user_func ?
             if ($backtrace[2]['function'] == 'call_user_func' && isset($backtrace[2]['args']) && is_array($backtrace[2]['args'])) {
@@ -45,15 +45,15 @@ 
                         $prefix_chars = strpos($called_class, '_') + 1;
                         $prefix = substr($called_class, 0, $prefix_chars);
                         $classname = substr($called_class, $prefix_chars, strlen($called_class));
-                        $classname = $prefix . str_replace(' ', '_', ucwords(strtolower(str_replace('_', ' ', $classname))));
+                        $classname = $prefix.str_replace(' ', '_', ucwords(strtolower(str_replace('_', ' ', $classname))));
                         return $classname;
                     }
                 }
             } else {
                 $lines = file($backtrace[2]['file']);
-                preg_match_all('/([a-zA-Z0-9\_]+)::' . $backtrace[2]['function'] . '/', $lines[ $backtrace[2]['line'] - 1 ], $matches);
-                if (isset($matches[1]) && isset($matches[1][ self::$i ])) {
-                    return $matches[1][ self::$i ];
+                preg_match_all('/([a-zA-Z0-9\_]+)::'.$backtrace[2]['function'].'/', $lines[$backtrace[2]['line'] - 1], $matches);
+                if (isset($matches[1]) && isset($matches[1][self::$i])) {
+                    return $matches[1][self::$i];
                 }
             }
         }
@@ -75,9 +75,9 @@ 
         global $wp_filter;
         $class_names = array();
         // are any callbacks registered for this hook ?
-        if (isset($wp_filter[ $hook ])) {
+        if (isset($wp_filter[$hook])) {
             // loop thru all of the callbacks attached to the deprecated hookpoint
-            foreach ($wp_filter[ $hook ] as $priority) {
+            foreach ($wp_filter[$hook] as $priority) {
                 foreach ($priority as $callback) {
                     // is the callback a non-static class method ?
                     if (isset($callback['function']) && is_array($callback['function'])) {
@@ -131,7 +131,7 @@ 
 }
 
 // if PHP version < 5.3
-if (! function_exists('get_called_class')) {
+if ( ! function_exists('get_called_class')) {
     /**
      * @return string
      */

core/helpers/EEH_Inflector.helper.php

Indentation +380 added lines, -380 removed lines

@@ -33,384 +33,384 @@
  */
 class EEH_Inflector
 {
-    // ------ CLASS METHODS ------ //
-    // ---- Public methods ---- //
-    // {{{ pluralize()
-
-    /**
-     * Just calls self::pluralize and strtolower on $word and returns it
-     * @param string $word
-     * @return string
-     */
-    public static function pluralize_and_lower($word)
-    {
-        return strtolower(self::pluralize($word));
-    }
-
-
-
-    /**
-     * @param string $word
-     * @return mixed
-     */
-    public static function singularize_and_upper($word)
-    {
-        return str_replace(' ', '_', self::humanize(self::singularize($word), 'all'));
-    }
-
-
-
-    /**
-     * Pluralizes English nouns.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    English noun to pluralize
-     * @return string Plural noun
-     */
-    public static function pluralize($word)
-    {
-        $plural = array(
-            '/(quiz)$/i'               => '\1zes',
-            '/^(ox)$/i'                => '\1en',
-            '/([m|l])ouse$/i'          => '\1ice',
-            '/(matr|vert|ind)ix|ex$/i' => '\1ices',
-            '/(x|ch|ss|sh)$/i'         => '\1es',
-            '/([^aeiouy]|qu)ies$/i'    => '\1y',
-            '/([^aeiouy]|qu)y$/i'      => '\1ies',
-            '/(hive)$/i'               => '\1s',
-            '/(?:([^f])fe|([lr])f)$/i' => '\1\2ves',
-            '/sis$/i'                  => 'ses',
-            '/([ti])um$/i'             => '\1a',
-            '/(buffal|tomat)o$/i'      => '\1oes',
-            '/(bu)s$/i'                => '\1ses',
-            '/(alias|status)/i'        => '\1es',
-            '/(octop|vir)us$/i'        => '\1i',
-            '/(ax|test)is$/i'          => '\1es',
-            '/s$/i'                    => 's',
-            '/$/'                      => 's');
-
-        $uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
-
-        $irregular = array(
-            'person' => 'people',
-            'man'    => 'men',
-            'child'  => 'children',
-            'sex'    => 'sexes',
-            'move'   => 'moves');
-
-        $lowercased_word = strtolower($word);
-
-        foreach ($uncountable as $_uncountable) {
-            if (
-                substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable && // even though the word "price" ends in "rice", it can be pluralized, so check the previous character isnt a letter
-                    ! ctype_alpha($lowercased_word[ strlen($lowercased_word) - strlen($_uncountable) ])
-            ) {
-                return $word;
-            }
-        }
-
-        foreach ($irregular as $_plural => $_singular) {
-            if (preg_match('/(' . $_plural . ')$/i', $word, $arr)) {
-                return preg_replace('/(' . $_plural . ')$/i', substr($arr[0], 0, 1) . substr($_singular, 1), $word);
-            }
-        }
-
-        foreach ($plural as $rule => $replacement) {
-            if (preg_match($rule, $word)) {
-                return preg_replace($rule, $replacement, $word);
-            }
-        }
-        return false;
-    }
-
-    // }}}
-    // {{{ singularize()
-
-    /**
-     * Singularizes English nouns.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    English noun to singularize
-     * @return string Singular noun.
-     */
-    public static function singularize($word)
-    {
-        $singular = array(
-            '/(quiz)zes$/i'                                                    => '\1',
-            '/(matr)ices$/i'                                                   => '\1ix',
-            '/(vert|ind)ices$/i'                                               => '\1ex',
-            '/^(ox)en/i'                                                       => '\1',
-            '/(alias|status)es$/i'                                             => '\1',
-            '/([octop|vir])i$/i'                                               => '\1us',
-            '/(cris|ax|test)es$/i'                                             => '\1is',
-            '/(shoe)s$/i'                                                      => '\1',
-            '/(o)es$/i'                                                        => '\1',
-            '/(bus)es$/i'                                                      => '\1',
-            '/([m|l])ice$/i'                                                   => '\1ouse',
-            '/(x|ch|ss|sh)es$/i'                                               => '\1',
-            '/(m)ovies$/i'                                                     => '\1ovie',
-            '/(s)eries$/i'                                                     => '\1eries',
-            '/([^aeiouy]|qu)ies$/i'                                            => '\1y',
-            '/([lr])ves$/i'                                                    => '\1f',
-            '/(tive)s$/i'                                                      => '\1',
-            '/(hive)s$/i'                                                      => '\1',
-            '/([^f])ves$/i'                                                    => '\1fe',
-            '/(^analy)ses$/i'                                                  => '\1sis',
-            '/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$/i' => '\1\2sis',
-            '/([ti])a$/i'                                                      => '\1um',
-            '/(n)ews$/i'                                                       => '\1ews',
-            '/s$/i'                                                            => '',
-        );
-
-        $uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
-
-        $irregular = array(
-            'person' => 'people',
-            'man'    => 'men',
-            'child'  => 'children',
-            'sex'    => 'sexes',
-            'move'   => 'moves');
-
-        $lowercased_word = strtolower($word);
-        foreach ($uncountable as $_uncountable) {
-            if (substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable) {
-                return $word;
-            }
-        }
-
-        foreach ($irregular as $_plural => $_singular) {
-            if (preg_match('/(' . $_singular . ')$/i', $word, $arr)) {
-                return preg_replace('/(' . $_singular . ')$/i', substr($arr[0], 0, 1) . substr($_plural, 1), $word);
-            }
-        }
-
-        foreach ($singular as $rule => $replacement) {
-            if (preg_match($rule, $word)) {
-                return preg_replace($rule, $replacement, $word);
-            }
-        }
-
-        return $word;
-    }
-
-    // }}}
-    // {{{ titleize()
-
-    /**
-     * Converts an underscored or CamelCase word into a English
-     * sentence.
-     *
-     * The titleize static function converts text like "WelcomePage",
-     * "welcome_page" or  "welcome page" to this "Welcome
-     * Page".
-     * If second parameter is set to 'first' it will only
-     * capitalize the first character of the title.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    Word to format as tile
-     * @param    string    $uppercase    If set to 'first' it will only uppercase the
-     * first character. Otherwise it will uppercase all
-     * the words in the title.
-     * @return string Text formatted as title
-     */
-    public static function titleize($word, $uppercase = '')
-    {
-        $uppercase = $uppercase === 'first' ? 'ucfirst' : 'ucwords';
-        return $uppercase(EEH_Inflector::humanize(EEH_Inflector::underscore($word)));
-    }
-
-    // }}}
-    // {{{ camelize()
-
-    /**
-     * Returns given word as CamelCased
-     *
-     * Converts a word like "send_email" to "SendEmail". It
-     * will remove non alphanumeric character from the word, so
-     * "who's online" will be converted to "WhoSOnline"
-     *
-     * @access public
-     * @static
-     * @see variablize
-     * @param    string    $word    Word to convert to camel case
-     * @return string UpperCamelCasedWord
-     */
-    public static function camelize($word)
-    {
-        return str_replace(' ', '', ucwords(preg_replace('/[^A-Z^a-z^0-9]+/', ' ', $word)));
-    }
-
-
-
-    /**
-     * Camelizes all but the first word. This is handy converting a method which followed EE4 legacy naming convention
-     * with the new PSR-based naming conventions
-     * @param $word
-     * @return string
-     */
-    public static function camelize_all_but_first($word)
-    {
-        return lcfirst(EEH_Inflector::camelize($word));
-    }
-    // }}}
-    // {{{ underscore()
-
-    /**
-     * Converts a word "into_it_s_underscored_version"
-     *
-     * Convert any "CamelCased" or "ordinary Word" into an
-     * "underscored_word".
-     *
-     * This can be really useful for creating friendly URLs.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    Word to underscore
-     * @return string Underscored word
-     */
-    public static function underscore($word)
-    {
-        return strtolower(preg_replace('/[^A-Z^a-z^0-9]+/', '_', preg_replace('/([a-zd])([A-Z])/', '1_2', preg_replace('/([A-Z]+)([A-Z][a-z])/', '1_2', $word))));
-    }
-
-    // }}}
-    // {{{ humanize()
-
-    /**
-     * Returns a human-readable string from $word
-     *
-     * Returns a human-readable string from $word, by replacing
-     * underscores with a space, and by upper-casing the initial
-     * character by default.
-     *
-     * If you need to uppercase all the words you just have to
-     * pass 'all' as a second parameter.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    String to "humanize"
-     * @param    string    $uppercase    If set to 'all' it will uppercase all the words
-     * instead of just the first one.
-     * @return string Human-readable word
-     */
-    public static function humanize($word, $uppercase = '')
-    {
-        // make special exceptions for acronyms
-        $word = str_replace('wp_', 'WP_', $word);
-        $uppercase = $uppercase === 'all' ? 'ucwords' : 'ucfirst';
-        return $uppercase(str_replace('_', ' ', preg_replace('/_id$/', '', $word)));
-    }
-
-    // }}}
-    // {{{ variablize()
-
-    /**
-     * Same as camelize but first char is underscored
-     *
-     * Converts a word like "send_email" to "sendEmail". It
-     * will remove non alphanumeric character from the word, so
-     * "who's online" will be converted to "whoSOnline"
-     *
-     * @access public
-     * @static
-     * @see camelize
-     * @param    string    $word    Word to lowerCamelCase
-     * @return string Returns a lowerCamelCasedWord
-     */
-    public static function variablize($word)
-    {
-        $word = EEH_Inflector::camelize($word);
-        return strtolower($word[0]) . substr($word, 1);
-    }
-
-    // }}}
-    // {{{ tableize()
-
-    /**
-     * Converts a class name to its table name according to rails
-     * naming conventions.
-     *
-     * Converts "Person" to "people"
-     *
-     * @access public
-     * @static
-     * @see classify
-     * @param    string    $class_name    Class name for getting related table_name.
-     * @return string plural_table_name
-     */
-    public static function tableize($class_name)
-    {
-        return EEH_Inflector::pluralize(EEH_Inflector::underscore($class_name));
-    }
-
-    // }}}
-    // {{{ classify()
-
-    /**
-     * Converts a table name to its class name according to rails
-     * naming conventions.
-     *
-     * Converts "people" to "Person"
-     *
-     * @access public
-     * @static
-     * @see tableize
-     * @param    string    $table_name    Table name for getting related ClassName.
-     * @return string SingularClassName
-     */
-    public static function classify($table_name)
-    {
-        return EEH_Inflector::camelize(EEH_Inflector::singularize($table_name));
-    }
-
-    // }}}
-    // {{{ ordinalize()
-
-    /**
-     * Converts number to its ordinal English form.
-     *
-     * This method converts 13 to 13th, 2 to 2nd ...
-     *
-     * @access public
-     * @static
-     * @param    integer    $number    Number to get its ordinal value
-     * @return string Ordinal representation of given string.
-     */
-    public static function ordinalize($number)
-    {
-        if (in_array(($number % 100), range(11, 13))) {
-            return $number . 'th';
-        } else {
-            switch (($number % 10)) {
-                case 1:
-                    return $number . 'st';
-                    break;
-                case 2:
-                    return $number . 'nd';
-                    break;
-                case 3:
-                    return $number . 'rd';
-                default:
-                    return $number . 'th';
-                    break;
-            }
-        }
-    }
-
-
-
-    /**
-     * @param $string
-     * @return string
-     */
-    public static function add_indefinite_article($string)
-    {
-        if (strtolower($string) === 'null') {
-            return $string;
-        }
-        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
-    }
+	// ------ CLASS METHODS ------ //
+	// ---- Public methods ---- //
+	// {{{ pluralize()
+
+	/**
+	 * Just calls self::pluralize and strtolower on $word and returns it
+	 * @param string $word
+	 * @return string
+	 */
+	public static function pluralize_and_lower($word)
+	{
+		return strtolower(self::pluralize($word));
+	}
+
+
+
+	/**
+	 * @param string $word
+	 * @return mixed
+	 */
+	public static function singularize_and_upper($word)
+	{
+		return str_replace(' ', '_', self::humanize(self::singularize($word), 'all'));
+	}
+
+
+
+	/**
+	 * Pluralizes English nouns.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    English noun to pluralize
+	 * @return string Plural noun
+	 */
+	public static function pluralize($word)
+	{
+		$plural = array(
+			'/(quiz)$/i'               => '\1zes',
+			'/^(ox)$/i'                => '\1en',
+			'/([m|l])ouse$/i'          => '\1ice',
+			'/(matr|vert|ind)ix|ex$/i' => '\1ices',
+			'/(x|ch|ss|sh)$/i'         => '\1es',
+			'/([^aeiouy]|qu)ies$/i'    => '\1y',
+			'/([^aeiouy]|qu)y$/i'      => '\1ies',
+			'/(hive)$/i'               => '\1s',
+			'/(?:([^f])fe|([lr])f)$/i' => '\1\2ves',
+			'/sis$/i'                  => 'ses',
+			'/([ti])um$/i'             => '\1a',
+			'/(buffal|tomat)o$/i'      => '\1oes',
+			'/(bu)s$/i'                => '\1ses',
+			'/(alias|status)/i'        => '\1es',
+			'/(octop|vir)us$/i'        => '\1i',
+			'/(ax|test)is$/i'          => '\1es',
+			'/s$/i'                    => 's',
+			'/$/'                      => 's');
+
+		$uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
+
+		$irregular = array(
+			'person' => 'people',
+			'man'    => 'men',
+			'child'  => 'children',
+			'sex'    => 'sexes',
+			'move'   => 'moves');
+
+		$lowercased_word = strtolower($word);
+
+		foreach ($uncountable as $_uncountable) {
+			if (
+				substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable && // even though the word "price" ends in "rice", it can be pluralized, so check the previous character isnt a letter
+					! ctype_alpha($lowercased_word[ strlen($lowercased_word) - strlen($_uncountable) ])
+			) {
+				return $word;
+			}
+		}
+
+		foreach ($irregular as $_plural => $_singular) {
+			if (preg_match('/(' . $_plural . ')$/i', $word, $arr)) {
+				return preg_replace('/(' . $_plural . ')$/i', substr($arr[0], 0, 1) . substr($_singular, 1), $word);
+			}
+		}
+
+		foreach ($plural as $rule => $replacement) {
+			if (preg_match($rule, $word)) {
+				return preg_replace($rule, $replacement, $word);
+			}
+		}
+		return false;
+	}
+
+	// }}}
+	// {{{ singularize()
+
+	/**
+	 * Singularizes English nouns.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    English noun to singularize
+	 * @return string Singular noun.
+	 */
+	public static function singularize($word)
+	{
+		$singular = array(
+			'/(quiz)zes$/i'                                                    => '\1',
+			'/(matr)ices$/i'                                                   => '\1ix',
+			'/(vert|ind)ices$/i'                                               => '\1ex',
+			'/^(ox)en/i'                                                       => '\1',
+			'/(alias|status)es$/i'                                             => '\1',
+			'/([octop|vir])i$/i'                                               => '\1us',
+			'/(cris|ax|test)es$/i'                                             => '\1is',
+			'/(shoe)s$/i'                                                      => '\1',
+			'/(o)es$/i'                                                        => '\1',
+			'/(bus)es$/i'                                                      => '\1',
+			'/([m|l])ice$/i'                                                   => '\1ouse',
+			'/(x|ch|ss|sh)es$/i'                                               => '\1',
+			'/(m)ovies$/i'                                                     => '\1ovie',
+			'/(s)eries$/i'                                                     => '\1eries',
+			'/([^aeiouy]|qu)ies$/i'                                            => '\1y',
+			'/([lr])ves$/i'                                                    => '\1f',
+			'/(tive)s$/i'                                                      => '\1',
+			'/(hive)s$/i'                                                      => '\1',
+			'/([^f])ves$/i'                                                    => '\1fe',
+			'/(^analy)ses$/i'                                                  => '\1sis',
+			'/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$/i' => '\1\2sis',
+			'/([ti])a$/i'                                                      => '\1um',
+			'/(n)ews$/i'                                                       => '\1ews',
+			'/s$/i'                                                            => '',
+		);
+
+		$uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
+
+		$irregular = array(
+			'person' => 'people',
+			'man'    => 'men',
+			'child'  => 'children',
+			'sex'    => 'sexes',
+			'move'   => 'moves');
+
+		$lowercased_word = strtolower($word);
+		foreach ($uncountable as $_uncountable) {
+			if (substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable) {
+				return $word;
+			}
+		}
+
+		foreach ($irregular as $_plural => $_singular) {
+			if (preg_match('/(' . $_singular . ')$/i', $word, $arr)) {
+				return preg_replace('/(' . $_singular . ')$/i', substr($arr[0], 0, 1) . substr($_plural, 1), $word);
+			}
+		}
+
+		foreach ($singular as $rule => $replacement) {
+			if (preg_match($rule, $word)) {
+				return preg_replace($rule, $replacement, $word);
+			}
+		}
+
+		return $word;
+	}
+
+	// }}}
+	// {{{ titleize()
+
+	/**
+	 * Converts an underscored or CamelCase word into a English
+	 * sentence.
+	 *
+	 * The titleize static function converts text like "WelcomePage",
+	 * "welcome_page" or  "welcome page" to this "Welcome
+	 * Page".
+	 * If second parameter is set to 'first' it will only
+	 * capitalize the first character of the title.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    Word to format as tile
+	 * @param    string    $uppercase    If set to 'first' it will only uppercase the
+	 * first character. Otherwise it will uppercase all
+	 * the words in the title.
+	 * @return string Text formatted as title
+	 */
+	public static function titleize($word, $uppercase = '')
+	{
+		$uppercase = $uppercase === 'first' ? 'ucfirst' : 'ucwords';
+		return $uppercase(EEH_Inflector::humanize(EEH_Inflector::underscore($word)));
+	}
+
+	// }}}
+	// {{{ camelize()
+
+	/**
+	 * Returns given word as CamelCased
+	 *
+	 * Converts a word like "send_email" to "SendEmail". It
+	 * will remove non alphanumeric character from the word, so
+	 * "who's online" will be converted to "WhoSOnline"
+	 *
+	 * @access public
+	 * @static
+	 * @see variablize
+	 * @param    string    $word    Word to convert to camel case
+	 * @return string UpperCamelCasedWord
+	 */
+	public static function camelize($word)
+	{
+		return str_replace(' ', '', ucwords(preg_replace('/[^A-Z^a-z^0-9]+/', ' ', $word)));
+	}
+
+
+
+	/**
+	 * Camelizes all but the first word. This is handy converting a method which followed EE4 legacy naming convention
+	 * with the new PSR-based naming conventions
+	 * @param $word
+	 * @return string
+	 */
+	public static function camelize_all_but_first($word)
+	{
+		return lcfirst(EEH_Inflector::camelize($word));
+	}
+	// }}}
+	// {{{ underscore()
+
+	/**
+	 * Converts a word "into_it_s_underscored_version"
+	 *
+	 * Convert any "CamelCased" or "ordinary Word" into an
+	 * "underscored_word".
+	 *
+	 * This can be really useful for creating friendly URLs.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    Word to underscore
+	 * @return string Underscored word
+	 */
+	public static function underscore($word)
+	{
+		return strtolower(preg_replace('/[^A-Z^a-z^0-9]+/', '_', preg_replace('/([a-zd])([A-Z])/', '1_2', preg_replace('/([A-Z]+)([A-Z][a-z])/', '1_2', $word))));
+	}
+
+	// }}}
+	// {{{ humanize()
+
+	/**
+	 * Returns a human-readable string from $word
+	 *
+	 * Returns a human-readable string from $word, by replacing
+	 * underscores with a space, and by upper-casing the initial
+	 * character by default.
+	 *
+	 * If you need to uppercase all the words you just have to
+	 * pass 'all' as a second parameter.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    String to "humanize"
+	 * @param    string    $uppercase    If set to 'all' it will uppercase all the words
+	 * instead of just the first one.
+	 * @return string Human-readable word
+	 */
+	public static function humanize($word, $uppercase = '')
+	{
+		// make special exceptions for acronyms
+		$word = str_replace('wp_', 'WP_', $word);
+		$uppercase = $uppercase === 'all' ? 'ucwords' : 'ucfirst';
+		return $uppercase(str_replace('_', ' ', preg_replace('/_id$/', '', $word)));
+	}
+
+	// }}}
+	// {{{ variablize()
+
+	/**
+	 * Same as camelize but first char is underscored
+	 *
+	 * Converts a word like "send_email" to "sendEmail". It
+	 * will remove non alphanumeric character from the word, so
+	 * "who's online" will be converted to "whoSOnline"
+	 *
+	 * @access public
+	 * @static
+	 * @see camelize
+	 * @param    string    $word    Word to lowerCamelCase
+	 * @return string Returns a lowerCamelCasedWord
+	 */
+	public static function variablize($word)
+	{
+		$word = EEH_Inflector::camelize($word);
+		return strtolower($word[0]) . substr($word, 1);
+	}
+
+	// }}}
+	// {{{ tableize()
+
+	/**
+	 * Converts a class name to its table name according to rails
+	 * naming conventions.
+	 *
+	 * Converts "Person" to "people"
+	 *
+	 * @access public
+	 * @static
+	 * @see classify
+	 * @param    string    $class_name    Class name for getting related table_name.
+	 * @return string plural_table_name
+	 */
+	public static function tableize($class_name)
+	{
+		return EEH_Inflector::pluralize(EEH_Inflector::underscore($class_name));
+	}
+
+	// }}}
+	// {{{ classify()
+
+	/**
+	 * Converts a table name to its class name according to rails
+	 * naming conventions.
+	 *
+	 * Converts "people" to "Person"
+	 *
+	 * @access public
+	 * @static
+	 * @see tableize
+	 * @param    string    $table_name    Table name for getting related ClassName.
+	 * @return string SingularClassName
+	 */
+	public static function classify($table_name)
+	{
+		return EEH_Inflector::camelize(EEH_Inflector::singularize($table_name));
+	}
+
+	// }}}
+	// {{{ ordinalize()
+
+	/**
+	 * Converts number to its ordinal English form.
+	 *
+	 * This method converts 13 to 13th, 2 to 2nd ...
+	 *
+	 * @access public
+	 * @static
+	 * @param    integer    $number    Number to get its ordinal value
+	 * @return string Ordinal representation of given string.
+	 */
+	public static function ordinalize($number)
+	{
+		if (in_array(($number % 100), range(11, 13))) {
+			return $number . 'th';
+		} else {
+			switch (($number % 10)) {
+				case 1:
+					return $number . 'st';
+					break;
+				case 2:
+					return $number . 'nd';
+					break;
+				case 3:
+					return $number . 'rd';
+				default:
+					return $number . 'th';
+					break;
+			}
+		}
+	}
+
+
+
+	/**
+	 * @param $string
+	 * @return string
+	 */
+	public static function add_indefinite_article($string)
+	{
+		if (strtolower($string) === 'null') {
+			return $string;
+		}
+		return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -104,15 +104,15 @@ 
         foreach ($uncountable as $_uncountable) {
             if (
                 substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable && // even though the word "price" ends in "rice", it can be pluralized, so check the previous character isnt a letter
-                    ! ctype_alpha($lowercased_word[ strlen($lowercased_word) - strlen($_uncountable) ])
+                    ! ctype_alpha($lowercased_word[strlen($lowercased_word) - strlen($_uncountable)])
             ) {
                 return $word;
             }
         }
 
         foreach ($irregular as $_plural => $_singular) {
-            if (preg_match('/(' . $_plural . ')$/i', $word, $arr)) {
-                return preg_replace('/(' . $_plural . ')$/i', substr($arr[0], 0, 1) . substr($_singular, 1), $word);
+            if (preg_match('/('.$_plural.')$/i', $word, $arr)) {
+                return preg_replace('/('.$_plural.')$/i', substr($arr[0], 0, 1).substr($_singular, 1), $word);
             }
         }
 
@@ -181,8 +181,8 @@ 
         }
 
         foreach ($irregular as $_plural => $_singular) {
-            if (preg_match('/(' . $_singular . ')$/i', $word, $arr)) {
-                return preg_replace('/(' . $_singular . ')$/i', substr($arr[0], 0, 1) . substr($_plural, 1), $word);
+            if (preg_match('/('.$_singular.')$/i', $word, $arr)) {
+                return preg_replace('/('.$_singular.')$/i', substr($arr[0], 0, 1).substr($_plural, 1), $word);
             }
         }
 
@@ -323,7 +323,7 @@ 
     public static function variablize($word)
     {
         $word = EEH_Inflector::camelize($word);
-        return strtolower($word[0]) . substr($word, 1);
+        return strtolower($word[0]).substr($word, 1);
     }
 
     // }}}
@@ -382,19 +382,19 @@ 
     public static function ordinalize($number)
     {
         if (in_array(($number % 100), range(11, 13))) {
-            return $number . 'th';
+            return $number.'th';
         } else {
             switch (($number % 10)) {
                 case 1:
-                    return $number . 'st';
+                    return $number.'st';
                     break;
                 case 2:
-                    return $number . 'nd';
+                    return $number.'nd';
                     break;
                 case 3:
-                    return $number . 'rd';
+                    return $number.'rd';
                 default:
-                    return $number . 'th';
+                    return $number.'th';
                     break;
             }
         }
@@ -411,6 +411,6 @@ 
         if (strtolower($string) === 'null') {
             return $string;
         }
-        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
+        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ').$string;
     }
 }

core/helpers/EEH_Parse_Shortcodes.helper.php

Indentation +264 added lines, -264 removed lines

@@ -13,268 +13,268 @@
 {
 
 
-    /**
-     * holds the template
-     *
-     * @access private
-     * @var mixed (string|array)
-     */
-    private $_template;
-
-
-    /**
-     * holds the incoming data object
-     *
-     * @access private
-     * @var object
-     */
-    private $_data;
-
-
-    /**
-     * will hold an array of EE_Shortcodes library objects.
-     *
-     * @access private
-     * @var EE_Shortcodes[]
-     */
-    private $_shortcode_objs = array();
-
-
-    public function __construct()
-    {
-    }
-
-
-    /**
-     * This kicks off the parsing of shortcodes in message templates
-     *
-     * @param  string                $template         This is the incoming string to be parsed
-     * @param  EE_Messages_Addressee $data             This is the incoming data object
-     * @param  array                 $valid_shortcodes An array of strings that correspond to EE_Shortcode libraries
-     * @param EE_message_type        $message_type     The message type that called the parser
-     * @param EE_messenger           $messenger        The active messenger for this parsing session.
-     * @param EE_Message             $message
-     * @return string                   The parsed template string
-     */
-    public function parse_message_template(
-        $template,
-        EE_Messages_Addressee $data,
-        $valid_shortcodes,
-        EE_message_type $message_type,
-        EE_messenger $messenger,
-        EE_Message $message
-    ) {
-        $extra_data = array(
-            'messenger'    => $messenger,
-            'message_type' => $message_type,
-            'message'      => $message,
-        );
-        $this->_init_data($template, $data, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['main'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_attendee_list_template(
-        $template,
-        EE_Registration $registration,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $registration, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['attendee_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-    public function parse_event_list_template($template, EE_Event $event, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_init_data($template, $event, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['event_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_ticket_list_template($template, EE_Ticket $ticket, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_init_data($template, $ticket, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['ticket_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_line_item_list_template(
-        $template,
-        EE_Line_Item $line_item,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $line_item, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['ticket_line_item_no_pms'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_payment_list_template(
-        $template,
-        EE_Payment $payment_item,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $payment_item, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['payment_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_datetime_list_template(
-        $template,
-        EE_Datetime $datetime,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $datetime, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['datetime_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_question_list_template($template, EE_Answer $answer, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_init_data($template, $answer, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['question_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    private function _init_data($template, $data, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_reset_props();
-        $this->_data['template']   = $template;
-        $this->_data['data']       = $data;
-        $this->_data['extra_data'] = $extra_data;
-        $this->_set_shortcodes($valid_shortcodes);
-    }
-
-
-    private function _reset_props()
-    {
-        $this->_template       = $this->_data = null;
-        $this->_shortcode_objs = array();
-    }
-
-
-    /**
-     * takes the given template and parses it with the $_shortcodes property
-     *
-     * @access private
-     * @return string
-     */
-    private function _parse_message_template()
-    {
-        // now let's get a list of shortcodes that are found in the given template
-        preg_match_all('/(\[.+?\])/', $this->_template, $matches);
-        $shortcodes = (array) $matches[0]; // this should be an array of shortcodes in the template string.
-
-        $matched_code = array();
-        $sc_values    = array();
-
-        $list_type_shortcodes = array(
-            '[ATTENDEE_LIST]',
-            '[EVENT_LIST]',
-            '[TICKET_LIST]',
-            '[DATETIME_LIST]',
-            '[QUESTION_LIST]',
-            '[RECIPIENT_QUESTION_LIST]',
-            '[PRIMARY_REGISTRANT_QUESTION_LIST]',
-            '[RECIPIENT_TICKET_LIST]',
-            '[PRIMARY_REGISTRANT_TICKET_LIST]',
-            '[RECIPIENT_DATETIME_LIST]',
-            '[PRIMARY_REGISTRANT_DATETIME_LIST]',
-            '[TICKET_LINE_ITEM_LIST]',
-            '[TAX_LINE_ITEM_LIST]',
-            '[ADDITIONAL_LINE_ITEM_LIST]',
-            '[PRICE_MODIFIER_LINE_ITEM_LIST]',
-            '[PAYMENT_LIST_*]',
-        );
-
-        $list_type_shortcodes = apply_filters(
-            'FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
-            $list_type_shortcodes
-        );
-
-        // now lets go ahead and loop through our parsers for each shortcode and setup the values
-        foreach ($shortcodes as $shortcode) {
-            foreach ($this->_shortcode_objs as $sc_obj) {
-                if ($sc_obj instanceof EE_Shortcodes) {
-                    // we need to setup any dynamic shortcodes so that they work with the array_key_exists
-                    preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
-                    $sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
-
-                    if (! array_key_exists($sc_to_verify, $sc_obj->get_shortcodes())) {
-                        continue; // the given shortcode isn't in this object
-                    }
-
-                    // if this isn't  a "list" type shortcode then we'll send along the data vanilla instead of in an array.
-                    if (! in_array($sc_to_verify, $list_type_shortcodes)) {
-                        $data_send = ! is_object($this->_data) && isset($this->_data['data']) ? $this->_data['data'] : $this->_data;
-                    } else {
-                        $data_send = $this->_data;
-                    }
-
-                    // is this a conditional type shortcode?  If it is then we actually parse the template here.
-                    if ($this->_is_conditional_shortcode($shortcode)) {
-                        // most shortcode parsers are not going to have a match for this shortcode and will return an
-                        // empty string so we need to make sure that we're only replacing the template when there is a non empty string.
-                        $parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
-                        if ($parsed) {
-                            $this->_template = $parsed;
-                        }
-                    }
-
-                    $parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
-
-                    $matched_code[] = $shortcode;
-                    $sc_values[]    = $parsed;
-                }
-            }
-        }
-
-        // now we've got parsed values for all the shortcodes in the template so we can go ahead and swap the shortcodes out.
-        $parsed = str_replace(array_values($matched_code), array_values($sc_values), $this->_template);
-        return $parsed;
-    }
-
-
-    /**
-     * Simply returns whether the given shortcode matches the structure for a conditional shortcode.
-     *
-     * Does it match this format: `[IF_`
-     *
-     * @param $shortcode
-     */
-    protected function _is_conditional_shortcode($shortcode)
-    {
-        return strpos($shortcode, '[IF_') === 0;
-    }
-
-
-    /**
-     * This sets the shortcodes property from the incoming array of valid shortcodes that corresponds to names of
-     * various EE_Shortcode library objects
-     *
-     * @access private
-     * @param array $valid_shortcodes an array of strings corresponding to EE_Shortcode Library objects
-     * @return void
-     */
-    private function _set_shortcodes($valid_shortcodes)
-    {
-        foreach ($valid_shortcodes as $shortcode_ref) {
-            $ref       = ucwords(str_replace('_', ' ', $shortcode_ref));
-            $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
-            if (class_exists($classname)) {
-                $this->_shortcode_objs[] = new $classname();
-            }
-        }
-    }
+	/**
+	 * holds the template
+	 *
+	 * @access private
+	 * @var mixed (string|array)
+	 */
+	private $_template;
+
+
+	/**
+	 * holds the incoming data object
+	 *
+	 * @access private
+	 * @var object
+	 */
+	private $_data;
+
+
+	/**
+	 * will hold an array of EE_Shortcodes library objects.
+	 *
+	 * @access private
+	 * @var EE_Shortcodes[]
+	 */
+	private $_shortcode_objs = array();
+
+
+	public function __construct()
+	{
+	}
+
+
+	/**
+	 * This kicks off the parsing of shortcodes in message templates
+	 *
+	 * @param  string                $template         This is the incoming string to be parsed
+	 * @param  EE_Messages_Addressee $data             This is the incoming data object
+	 * @param  array                 $valid_shortcodes An array of strings that correspond to EE_Shortcode libraries
+	 * @param EE_message_type        $message_type     The message type that called the parser
+	 * @param EE_messenger           $messenger        The active messenger for this parsing session.
+	 * @param EE_Message             $message
+	 * @return string                   The parsed template string
+	 */
+	public function parse_message_template(
+		$template,
+		EE_Messages_Addressee $data,
+		$valid_shortcodes,
+		EE_message_type $message_type,
+		EE_messenger $messenger,
+		EE_Message $message
+	) {
+		$extra_data = array(
+			'messenger'    => $messenger,
+			'message_type' => $message_type,
+			'message'      => $message,
+		);
+		$this->_init_data($template, $data, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['main'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_attendee_list_template(
+		$template,
+		EE_Registration $registration,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $registration, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['attendee_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+	public function parse_event_list_template($template, EE_Event $event, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_init_data($template, $event, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['event_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_ticket_list_template($template, EE_Ticket $ticket, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_init_data($template, $ticket, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['ticket_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_line_item_list_template(
+		$template,
+		EE_Line_Item $line_item,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $line_item, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['ticket_line_item_no_pms'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_payment_list_template(
+		$template,
+		EE_Payment $payment_item,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $payment_item, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['payment_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_datetime_list_template(
+		$template,
+		EE_Datetime $datetime,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $datetime, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['datetime_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_question_list_template($template, EE_Answer $answer, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_init_data($template, $answer, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['question_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	private function _init_data($template, $data, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_reset_props();
+		$this->_data['template']   = $template;
+		$this->_data['data']       = $data;
+		$this->_data['extra_data'] = $extra_data;
+		$this->_set_shortcodes($valid_shortcodes);
+	}
+
+
+	private function _reset_props()
+	{
+		$this->_template       = $this->_data = null;
+		$this->_shortcode_objs = array();
+	}
+
+
+	/**
+	 * takes the given template and parses it with the $_shortcodes property
+	 *
+	 * @access private
+	 * @return string
+	 */
+	private function _parse_message_template()
+	{
+		// now let's get a list of shortcodes that are found in the given template
+		preg_match_all('/(\[.+?\])/', $this->_template, $matches);
+		$shortcodes = (array) $matches[0]; // this should be an array of shortcodes in the template string.
+
+		$matched_code = array();
+		$sc_values    = array();
+
+		$list_type_shortcodes = array(
+			'[ATTENDEE_LIST]',
+			'[EVENT_LIST]',
+			'[TICKET_LIST]',
+			'[DATETIME_LIST]',
+			'[QUESTION_LIST]',
+			'[RECIPIENT_QUESTION_LIST]',
+			'[PRIMARY_REGISTRANT_QUESTION_LIST]',
+			'[RECIPIENT_TICKET_LIST]',
+			'[PRIMARY_REGISTRANT_TICKET_LIST]',
+			'[RECIPIENT_DATETIME_LIST]',
+			'[PRIMARY_REGISTRANT_DATETIME_LIST]',
+			'[TICKET_LINE_ITEM_LIST]',
+			'[TAX_LINE_ITEM_LIST]',
+			'[ADDITIONAL_LINE_ITEM_LIST]',
+			'[PRICE_MODIFIER_LINE_ITEM_LIST]',
+			'[PAYMENT_LIST_*]',
+		);
+
+		$list_type_shortcodes = apply_filters(
+			'FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
+			$list_type_shortcodes
+		);
+
+		// now lets go ahead and loop through our parsers for each shortcode and setup the values
+		foreach ($shortcodes as $shortcode) {
+			foreach ($this->_shortcode_objs as $sc_obj) {
+				if ($sc_obj instanceof EE_Shortcodes) {
+					// we need to setup any dynamic shortcodes so that they work with the array_key_exists
+					preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
+					$sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
+
+					if (! array_key_exists($sc_to_verify, $sc_obj->get_shortcodes())) {
+						continue; // the given shortcode isn't in this object
+					}
+
+					// if this isn't  a "list" type shortcode then we'll send along the data vanilla instead of in an array.
+					if (! in_array($sc_to_verify, $list_type_shortcodes)) {
+						$data_send = ! is_object($this->_data) && isset($this->_data['data']) ? $this->_data['data'] : $this->_data;
+					} else {
+						$data_send = $this->_data;
+					}
+
+					// is this a conditional type shortcode?  If it is then we actually parse the template here.
+					if ($this->_is_conditional_shortcode($shortcode)) {
+						// most shortcode parsers are not going to have a match for this shortcode and will return an
+						// empty string so we need to make sure that we're only replacing the template when there is a non empty string.
+						$parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
+						if ($parsed) {
+							$this->_template = $parsed;
+						}
+					}
+
+					$parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
+
+					$matched_code[] = $shortcode;
+					$sc_values[]    = $parsed;
+				}
+			}
+		}
+
+		// now we've got parsed values for all the shortcodes in the template so we can go ahead and swap the shortcodes out.
+		$parsed = str_replace(array_values($matched_code), array_values($sc_values), $this->_template);
+		return $parsed;
+	}
+
+
+	/**
+	 * Simply returns whether the given shortcode matches the structure for a conditional shortcode.
+	 *
+	 * Does it match this format: `[IF_`
+	 *
+	 * @param $shortcode
+	 */
+	protected function _is_conditional_shortcode($shortcode)
+	{
+		return strpos($shortcode, '[IF_') === 0;
+	}
+
+
+	/**
+	 * This sets the shortcodes property from the incoming array of valid shortcodes that corresponds to names of
+	 * various EE_Shortcode library objects
+	 *
+	 * @access private
+	 * @param array $valid_shortcodes an array of strings corresponding to EE_Shortcode Library objects
+	 * @return void
+	 */
+	private function _set_shortcodes($valid_shortcodes)
+	{
+		foreach ($valid_shortcodes as $shortcode_ref) {
+			$ref       = ucwords(str_replace('_', ' ', $shortcode_ref));
+			$ref       = str_replace(' ', '_', $ref);
+			$classname = 'EE_' . $ref . '_Shortcodes';
+			if (class_exists($classname)) {
+				$this->_shortcode_objs[] = new $classname();
+			}
+		}
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -208,14 +208,14 @@ 
                 if ($sc_obj instanceof EE_Shortcodes) {
                     // we need to setup any dynamic shortcodes so that they work with the array_key_exists
                     preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
-                    $sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
+                    $sc_to_verify = ! empty($matches[0]) ? $matches[0][0].']' : $shortcode;
 
-                    if (! array_key_exists($sc_to_verify, $sc_obj->get_shortcodes())) {
+                    if ( ! array_key_exists($sc_to_verify, $sc_obj->get_shortcodes())) {
                         continue; // the given shortcode isn't in this object
                     }
 
                     // if this isn't  a "list" type shortcode then we'll send along the data vanilla instead of in an array.
-                    if (! in_array($sc_to_verify, $list_type_shortcodes)) {
+                    if ( ! in_array($sc_to_verify, $list_type_shortcodes)) {
                         $data_send = ! is_object($this->_data) && isset($this->_data['data']) ? $this->_data['data'] : $this->_data;
                     } else {
                         $data_send = $this->_data;
@@ -271,7 +271,7 @@ 
         foreach ($valid_shortcodes as $shortcode_ref) {
             $ref       = ucwords(str_replace('_', ' ', $shortcode_ref));
             $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
+            $classname = 'EE_'.$ref.'_Shortcodes';
             if (class_exists($classname)) {
                 $this->_shortcode_objs[] = new $classname();
             }

core/helpers/EEH_Export.helper.php

Spacing +4 added lines, -4 removed lines

@@ -74,13 +74,13 @@ 
             ) {
                 // its associative, so we want to output its keys as column headers
                 $keys = array_keys($item_in_top_level_array);
-                $new_file_contents .=  EEH_Export::get_csv_row($keys);
+                $new_file_contents .= EEH_Export::get_csv_row($keys);
             }
             // start writing data
             foreach ($data as $data_row) {
                 $new_file_contents .= EEH_Export::get_csv_row($data_row);
             }
-            return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath) . $new_file_contents);
+            return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath).$new_file_contents);
         } else {
             // no data TO write... so we can assume that's a success
             return true;
@@ -118,10 +118,10 @@ 
             }
 
             $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
-                ( $enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure ) : $field_value;
+                ($enclosure.str_replace($enclosure, $enclosure.$enclosure, $field_value).$enclosure) : $field_value;
         }
 
-        return  implode($delimiter, $output) . PHP_EOL;
+        return  implode($delimiter, $output).PHP_EOL;
     }
 
 

Indentation +161 added lines, -161 removed lines

@@ -13,165 +13,165 @@
  */
 class EEH_Export
 {
-    /**
-     * Gets the 'normal' column named for fields
-     * @param EE_Model_Field_Base $field
-     * @return string
-     * @throws EE_Error
-     */
-    public static function get_column_name_for_field(EE_Model_Field_Base $field)
-    {
-        $column_name = wp_specialchars_decode($field->get_nicename(), ENT_QUOTES);
-        if (
-            apply_filters(
-                'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
-                false,
-                $column_name,
-                $field
-            )
-        ) {
-            $column_name .= "["
-                . wp_specialchars_decode($field->get_name(), ENT_QUOTES)
-                . "]";
-        }
-        return $column_name;
-    }
-
-    /**
-     * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
-     *
-     * @param string    $filepath
-     * @param array     $data 2D array,         first numerically-indexed,
-     *                                          and next-level-down preferably indexed by string
-     * @param boolean   $write_column_headers   whether or not we should add the keys in the bottom-most array
-     *                                          as a row for headers in the CSV.
-     *                                            Eg, if $data looked like:
-     *                                            array(
-     *                                                  0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...),
-     *                                                  1=>array(...,...)
-     *                                            )
-     *
-     * @return boolean      if we successfully wrote to the CSV or not. If there's no $data,
-     *                      we consider that a success (because we wrote everything there was...nothing)
-     * @throws EE_Error
-     */
-    public static function write_data_array_to_csv($filepath, $data, $write_column_headers = true)
-    {
-
-        $new_file_contents = '';
-        // determine if $data is actually a 2d array
-        if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) {
-            // make sure top level is numerically indexed,
-
-            if (EEH_Array::is_associative_array($data)) {
-                throw new EE_Error(sprintf(esc_html__("top-level array must be numerically indexed. Does these look like numbers to you? %s", "event_espresso"), implode(",", array_keys($data))));
-            }
-            $item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
-            // now, is the last item in the top-level array of $data an associative or numeric array?
-            if (
-                $write_column_headers &&
-                    EEH_Array::is_associative_array($item_in_top_level_array)
-            ) {
-                // its associative, so we want to output its keys as column headers
-                $keys = array_keys($item_in_top_level_array);
-                $new_file_contents .=  EEH_Export::get_csv_row($keys);
-            }
-            // start writing data
-            foreach ($data as $data_row) {
-                $new_file_contents .= EEH_Export::get_csv_row($data_row);
-            }
-            return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath) . $new_file_contents);
-        } else {
-            // no data TO write... so we can assume that's a success
-            return true;
-        }
-    }
-
-
-
-     /**
-      *
-     *  Writes a row to the csv file
-     *  @param array $row - individual row of csv data
-     *  @param string $delimiter - csv delimiter
-     *  @param string $enclosure - csv enclosure
-     *  @param bool $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
-     *  @return string of text for teh csv file
-     */
-    public static function get_csv_row(array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false)
-    {
-        // Allow user to filter the csv delimiter and enclosure for other countries csv standards
-        $delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
-        $enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
-
-        $delimiter_esc = preg_quote($delimiter, '/');
-        $enclosure_esc = preg_quote($enclosure, '/');
-
-        $output = array();
-        foreach ($row as $field_value) {
-            if (is_object($field_value) || is_array($field_value)) {
-                $field_value = serialize($field_value);
-            }
-            if ($field_value === null && $mysql_null) {
-                $output[] = 'NULL';
-                continue;
-            }
-
-            $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
-                ( $enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure ) : $field_value;
-        }
-
-        return  implode($delimiter, $output) . PHP_EOL;
-    }
-
-
-
-    /**
-     * Shortcut for preparing a database result for display
-     * @param EEM_Base $model
-     * @param string $field_name
-     * @param string $raw_db_value
-     * @param boolean|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to NOT display pretty
-     * @return string
-     */
-    public static function prepare_value_from_db_for_display($model, $field_name, $raw_db_value, $pretty_schema = true)
-    {
-        $field_obj = $model->field_settings_for($field_name);
-        $value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value);
-        if ($field_obj instanceof EE_Datetime_Field) {
-            $field_obj->set_date_format(EEH_Export::get_date_format_for_export($field_obj->get_date_format($pretty_schema)), $pretty_schema);
-            $field_obj->set_time_format(EEH_Export::get_time_format_for_export($field_obj->get_time_format($pretty_schema)), $pretty_schema);
-        }
-        if ($pretty_schema === true) {
-            return $field_obj->prepare_for_pretty_echoing($value_on_model_obj);
-        } elseif (is_string($pretty_schema)) {
-            return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema);
-        } else {
-            return $field_obj->prepare_for_get($value_on_model_obj);
-        }
-    }
-
-
-
-    /**
-     * Gets the date format to use in exports. filterable
-     * @param string $current_format
-     * @return string
-     */
-    public static function get_date_format_for_export($current_format = null)
-    {
-        return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
-    }
-
-
-
-    /**
-     * Gets the time format we want to use in exports. Filterable
-     * @param string $current_format
-     * @return string
-     */
-    public static function get_time_format_for_export($current_format = null)
-    {
-        return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
-    }
+	/**
+	 * Gets the 'normal' column named for fields
+	 * @param EE_Model_Field_Base $field
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function get_column_name_for_field(EE_Model_Field_Base $field)
+	{
+		$column_name = wp_specialchars_decode($field->get_nicename(), ENT_QUOTES);
+		if (
+			apply_filters(
+				'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
+				false,
+				$column_name,
+				$field
+			)
+		) {
+			$column_name .= "["
+				. wp_specialchars_decode($field->get_name(), ENT_QUOTES)
+				. "]";
+		}
+		return $column_name;
+	}
+
+	/**
+	 * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
+	 *
+	 * @param string    $filepath
+	 * @param array     $data 2D array,         first numerically-indexed,
+	 *                                          and next-level-down preferably indexed by string
+	 * @param boolean   $write_column_headers   whether or not we should add the keys in the bottom-most array
+	 *                                          as a row for headers in the CSV.
+	 *                                            Eg, if $data looked like:
+	 *                                            array(
+	 *                                                  0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...),
+	 *                                                  1=>array(...,...)
+	 *                                            )
+	 *
+	 * @return boolean      if we successfully wrote to the CSV or not. If there's no $data,
+	 *                      we consider that a success (because we wrote everything there was...nothing)
+	 * @throws EE_Error
+	 */
+	public static function write_data_array_to_csv($filepath, $data, $write_column_headers = true)
+	{
+
+		$new_file_contents = '';
+		// determine if $data is actually a 2d array
+		if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) {
+			// make sure top level is numerically indexed,
+
+			if (EEH_Array::is_associative_array($data)) {
+				throw new EE_Error(sprintf(esc_html__("top-level array must be numerically indexed. Does these look like numbers to you? %s", "event_espresso"), implode(",", array_keys($data))));
+			}
+			$item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
+			// now, is the last item in the top-level array of $data an associative or numeric array?
+			if (
+				$write_column_headers &&
+					EEH_Array::is_associative_array($item_in_top_level_array)
+			) {
+				// its associative, so we want to output its keys as column headers
+				$keys = array_keys($item_in_top_level_array);
+				$new_file_contents .=  EEH_Export::get_csv_row($keys);
+			}
+			// start writing data
+			foreach ($data as $data_row) {
+				$new_file_contents .= EEH_Export::get_csv_row($data_row);
+			}
+			return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath) . $new_file_contents);
+		} else {
+			// no data TO write... so we can assume that's a success
+			return true;
+		}
+	}
+
+
+
+	 /**
+	  *
+	  *  Writes a row to the csv file
+	  *  @param array $row - individual row of csv data
+	  *  @param string $delimiter - csv delimiter
+	  *  @param string $enclosure - csv enclosure
+	  *  @param bool $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
+	  *  @return string of text for teh csv file
+	  */
+	public static function get_csv_row(array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false)
+	{
+		// Allow user to filter the csv delimiter and enclosure for other countries csv standards
+		$delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
+		$enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
+
+		$delimiter_esc = preg_quote($delimiter, '/');
+		$enclosure_esc = preg_quote($enclosure, '/');
+
+		$output = array();
+		foreach ($row as $field_value) {
+			if (is_object($field_value) || is_array($field_value)) {
+				$field_value = serialize($field_value);
+			}
+			if ($field_value === null && $mysql_null) {
+				$output[] = 'NULL';
+				continue;
+			}
+
+			$output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
+				( $enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure ) : $field_value;
+		}
+
+		return  implode($delimiter, $output) . PHP_EOL;
+	}
+
+
+
+	/**
+	 * Shortcut for preparing a database result for display
+	 * @param EEM_Base $model
+	 * @param string $field_name
+	 * @param string $raw_db_value
+	 * @param boolean|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to NOT display pretty
+	 * @return string
+	 */
+	public static function prepare_value_from_db_for_display($model, $field_name, $raw_db_value, $pretty_schema = true)
+	{
+		$field_obj = $model->field_settings_for($field_name);
+		$value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value);
+		if ($field_obj instanceof EE_Datetime_Field) {
+			$field_obj->set_date_format(EEH_Export::get_date_format_for_export($field_obj->get_date_format($pretty_schema)), $pretty_schema);
+			$field_obj->set_time_format(EEH_Export::get_time_format_for_export($field_obj->get_time_format($pretty_schema)), $pretty_schema);
+		}
+		if ($pretty_schema === true) {
+			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj);
+		} elseif (is_string($pretty_schema)) {
+			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema);
+		} else {
+			return $field_obj->prepare_for_get($value_on_model_obj);
+		}
+	}
+
+
+
+	/**
+	 * Gets the date format to use in exports. filterable
+	 * @param string $current_format
+	 * @return string
+	 */
+	public static function get_date_format_for_export($current_format = null)
+	{
+		return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
+	}
+
+
+
+	/**
+	 * Gets the time format we want to use in exports. Filterable
+	 * @param string $current_format
+	 * @return string
+	 */
+	public static function get_time_format_for_export($current_format = null)
+	{
+		return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
+	}
 }

core/domain/values/model/CustomSelects.php

Indentation +336 added lines, -336 removed lines

@@ -17,340 +17,340 @@
  */
 class CustomSelects
 {
-    const TYPE_SIMPLE = 'simple';
-    const TYPE_COMPLEX = 'complex';
-    const TYPE_STRUCTURED = 'structured';
-
-    private $valid_operators = array('COUNT', 'SUM');
-
-
-    /**
-     * Original incoming select array
-     *
-     * @var array
-     */
-    private $original_selects;
-
-    /**
-     * Select string that can be added to the query
-     *
-     * @var string
-     */
-    private $columns_to_select_expression;
-
-
-    /**
-     * An array of aliases for the columns included in the incoming select array.
-     *
-     * @var array
-     */
-    private $column_aliases_in_select;
-
-
-    /**
-     * Enum representation of the "type" of array coming into this value object.
-     *
-     * @var string
-     */
-    private $type = '';
-
-
-    /**
-     * CustomSelects constructor.
-     * Incoming selects can be in one of the following formats:
-     * ---- self::TYPE_SIMPLE array ----
-     * This is considered the "simple" type. In this case the array is an numerically indexed array with single or
-     * multiple columns to select as the values.
-     * eg. array( 'ATT_ID', 'REG_ID' )
-     * eg. array( '*' )
-     * If you want to use the columns in any WHERE, GROUP BY, or HAVING clauses, you must instead use the "complex" or
-     * "structured" method.
-     * ---- self::TYPE_COMPLEX array ----
-     * This is considered the "complex" type.  In this case the array is indexed by arbitrary strings that serve as
-     * column alias, and the value is an numerically indexed array where there are two values.  The first value (0) is
-     * the selection and the second value (1) is the data type.  Data types must be one of the types defined in
-     * EEM_Base::$_valid_wpdb_data_types.
-     * eg. array( 'count' => array('count(REG_ID)', '%d') )
-     * Complex array configuration allows for using the column alias in any WHERE, GROUP BY, or HAVING clauses.
-     * ---- self::TYPE_STRUCTURED array ---
-     * This is considered the "structured" type. This type is similar to the complex type except that the array attached
-     * to the column alias contains three values.  The first value is the qualified column name (which can include
-     * join syntax for models).  The second value is the operator performed on the column (i.e. 'COUNT', 'SUM' etc).,
-     * the third value is the data type.  Note, if the select does not have an operator, you can use an empty string for
-     * the second value.
-     * Note: for now SUM is only for simple single column expressions (i.e. SUM(Transaction.TXN_total))
-     * eg. array( 'registration_count' => array('Registration.REG_ID', 'count', '%d') );
-     * NOTE: mixing array types in the incoming $select will cause errors.
-     *
-     * @param array $selects
-     * @throws InvalidArgumentException
-     */
-    public function __construct(array $selects)
-    {
-        $this->original_selects = $selects;
-        $this->deriveType($selects);
-        $this->deriveParts($selects);
-    }
-
-
-    /**
-     * Derives what type of custom select has been sent in.
-     *
-     * @param array $selects
-     * @throws InvalidArgumentException
-     */
-    private function deriveType(array $selects)
-    {
-        // first if the first key for this array is an integer then its coming in as a simple format, so we'll also
-        // ensure all elements of the array are simple.
-        if (is_int(key($selects))) {
-            // let's ensure all keys are ints
-            $invalid_keys = array_filter(
-                array_keys($selects),
-                function ($value) {
-                    return ! is_int($value);
-                }
-            );
-            if (! empty($invalid_keys)) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        esc_html__(
-                            'Incoming array looks like its formatted for "%1$s" type selects, however it has elements that are not indexed numerically',
-                            'event_espresso'
-                        ),
-                        self::TYPE_SIMPLE
-                    )
-                );
-            }
-            $this->type = self::TYPE_SIMPLE;
-            return;
-        }
-        // made it here so that means we've got either complex or structured selects.  Let's find out which by popping
-        // the first array element off.
-        $first_element = reset($selects);
-
-        if (! is_array($first_element)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'Incoming array looks like its formatted as a "%1$s" or "%2$s" type.  However, the values in the array must be arrays themselves and they are not.',
-                        'event_espresso'
-                    ),
-                    self::TYPE_COMPLEX,
-                    self::TYPE_STRUCTURED
-                )
-            );
-        }
-        $this->type = count($first_element) === 2
-            ? self::TYPE_COMPLEX
-            : self::TYPE_STRUCTURED;
-    }
-
-
-    /**
-     * Sets up the various properties for the vo depending on type.
-     *
-     * @param array $selects
-     * @throws InvalidArgumentException
-     */
-    private function deriveParts(array $selects)
-    {
-        $column_parts = array();
-        switch ($this->type) {
-            case self::TYPE_SIMPLE:
-                $column_parts = $selects;
-                $this->column_aliases_in_select = $selects;
-                break;
-            case self::TYPE_COMPLEX:
-                foreach ($selects as $alias => $parts) {
-                    $this->validateSelectValueForType($parts, $alias);
-                    $column_parts[] = "{$parts[0]} AS {$alias}";
-                    $this->column_aliases_in_select[] = $alias;
-                }
-                break;
-            case self::TYPE_STRUCTURED:
-                foreach ($selects as $alias => $parts) {
-                    $this->validateSelectValueForType($parts, $alias);
-                    $column_parts[] = $parts[1] !== ''
-                        ? $this->assembleSelectStringWithOperator($parts, $alias)
-                        : "{$parts[0]} AS {$alias}";
-                    $this->column_aliases_in_select[] = $alias;
-                }
-                break;
-        }
-        $this->columns_to_select_expression = implode(', ', $column_parts);
-    }
-
-
-    /**
-     * Validates self::TYPE_COMPLEX and self::TYPE_STRUCTURED select statement parts.
-     *
-     * @param array  $select_parts
-     * @param string $alias
-     * @throws InvalidArgumentException
-     */
-    private function validateSelectValueForType(array $select_parts, $alias)
-    {
-        $valid_data_types = array('%d', '%s', '%f');
-        if (count($select_parts) !== $this->expectedSelectPartCountForType()) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The provided select part array for the %1$s column is expected to have a count of %2$d because the incoming select array is of type %3$s.  However the count was %4$d.',
-                        'event_espresso'
-                    ),
-                    $alias,
-                    $this->expectedSelectPartCountForType(),
-                    $this->type,
-                    count($select_parts)
-                )
-            );
-        }
-        // validate data type.
-        $data_type = $this->type === self::TYPE_COMPLEX ? $select_parts[1] : '';
-        $data_type = $this->type === self::TYPE_STRUCTURED ? $select_parts[2] : $data_type;
-
-        if (! in_array($data_type, $valid_data_types, true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'Datatype %1$s (for selection "%2$s" and alias "%3$s") is not a valid wpdb datatype (eg %%s)',
-                        'event_espresso'
-                    ),
-                    $data_type,
-                    $select_parts[0],
-                    $alias,
-                    implode(', ', $valid_data_types)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Each type will have an expected count of array elements, this returns what that expected count is.
-     *
-     * @param string $type
-     * @return int
-     */
-    private function expectedSelectPartCountForType($type = '')
-    {
-        $type = $type === '' ? $this->type : $type;
-        $types_count_map = array(
-            self::TYPE_COMPLEX    => 2,
-            self::TYPE_STRUCTURED => 3,
-        );
-        return isset($types_count_map[ $type ]) ? $types_count_map[ $type ] : 0;
-    }
-
-
-    /**
-     * Prepares the select statement part for for structured type selects.
-     *
-     * @param array  $select_parts
-     * @param string $alias
-     * @return string
-     * @throws InvalidArgumentException
-     */
-    private function assembleSelectStringWithOperator(array $select_parts, $alias)
-    {
-        $operator = strtoupper($select_parts[1]);
-        // validate operator
-        if (! in_array($operator, $this->valid_operators, true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'An invalid operator has been provided (%1$s) for the column %2$s.  Valid operators must be one of the following: %3$s.',
-                        'event_espresso'
-                    ),
-                    $operator,
-                    $alias,
-                    implode(', ', $this->valid_operators)
-                )
-            );
-        }
-        return $operator . '(' . $select_parts[0] . ') AS ' . $alias;
-    }
-
-
-    /**
-     * Return the datatype from the given select part.
-     * Remember the select_part has already been validated on object instantiation.
-     *
-     * @param array $select_part
-     * @return string
-     */
-    private function getDataTypeForSelectType(array $select_part)
-    {
-        switch ($this->type) {
-            case self::TYPE_COMPLEX:
-                return $select_part[1];
-            case self::TYPE_STRUCTURED:
-                return $select_part[2];
-            default:
-                return '';
-        }
-    }
-
-
-    /**
-     * Returns the original select array sent into the VO.
-     *
-     * @return array
-     */
-    public function originalSelects()
-    {
-        return $this->original_selects;
-    }
-
-
-    /**
-     * Returns the final assembled select expression derived from the incoming select array.
-     *
-     * @return string
-     */
-    public function columnsToSelectExpression()
-    {
-        return $this->columns_to_select_expression;
-    }
-
-
-    /**
-     * Returns all the column aliases derived from the incoming select array.
-     *
-     * @return array
-     */
-    public function columnAliases()
-    {
-        return $this->column_aliases_in_select;
-    }
-
-
-    /**
-     * Returns the enum type for the incoming select array.
-     *
-     * @return string
-     */
-    public function type()
-    {
-        return $this->type;
-    }
-
-
-    /**
-     * Return the datatype for the given column_alias
-     *
-     * @param string $column_alias
-     * @return string  (if there's no data type we return string as the default).
-     */
-    public function getDataTypeForAlias($column_alias)
-    {
-        if (
-            isset($this->original_selects[ $column_alias ])
-            && in_array($column_alias, $this->columnAliases(), true)
-        ) {
-            return $this->getDataTypeForSelectType($this->original_selects[ $column_alias ]);
-        }
-        return '%s';
-    }
+	const TYPE_SIMPLE = 'simple';
+	const TYPE_COMPLEX = 'complex';
+	const TYPE_STRUCTURED = 'structured';
+
+	private $valid_operators = array('COUNT', 'SUM');
+
+
+	/**
+	 * Original incoming select array
+	 *
+	 * @var array
+	 */
+	private $original_selects;
+
+	/**
+	 * Select string that can be added to the query
+	 *
+	 * @var string
+	 */
+	private $columns_to_select_expression;
+
+
+	/**
+	 * An array of aliases for the columns included in the incoming select array.
+	 *
+	 * @var array
+	 */
+	private $column_aliases_in_select;
+
+
+	/**
+	 * Enum representation of the "type" of array coming into this value object.
+	 *
+	 * @var string
+	 */
+	private $type = '';
+
+
+	/**
+	 * CustomSelects constructor.
+	 * Incoming selects can be in one of the following formats:
+	 * ---- self::TYPE_SIMPLE array ----
+	 * This is considered the "simple" type. In this case the array is an numerically indexed array with single or
+	 * multiple columns to select as the values.
+	 * eg. array( 'ATT_ID', 'REG_ID' )
+	 * eg. array( '*' )
+	 * If you want to use the columns in any WHERE, GROUP BY, or HAVING clauses, you must instead use the "complex" or
+	 * "structured" method.
+	 * ---- self::TYPE_COMPLEX array ----
+	 * This is considered the "complex" type.  In this case the array is indexed by arbitrary strings that serve as
+	 * column alias, and the value is an numerically indexed array where there are two values.  The first value (0) is
+	 * the selection and the second value (1) is the data type.  Data types must be one of the types defined in
+	 * EEM_Base::$_valid_wpdb_data_types.
+	 * eg. array( 'count' => array('count(REG_ID)', '%d') )
+	 * Complex array configuration allows for using the column alias in any WHERE, GROUP BY, or HAVING clauses.
+	 * ---- self::TYPE_STRUCTURED array ---
+	 * This is considered the "structured" type. This type is similar to the complex type except that the array attached
+	 * to the column alias contains three values.  The first value is the qualified column name (which can include
+	 * join syntax for models).  The second value is the operator performed on the column (i.e. 'COUNT', 'SUM' etc).,
+	 * the third value is the data type.  Note, if the select does not have an operator, you can use an empty string for
+	 * the second value.
+	 * Note: for now SUM is only for simple single column expressions (i.e. SUM(Transaction.TXN_total))
+	 * eg. array( 'registration_count' => array('Registration.REG_ID', 'count', '%d') );
+	 * NOTE: mixing array types in the incoming $select will cause errors.
+	 *
+	 * @param array $selects
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(array $selects)
+	{
+		$this->original_selects = $selects;
+		$this->deriveType($selects);
+		$this->deriveParts($selects);
+	}
+
+
+	/**
+	 * Derives what type of custom select has been sent in.
+	 *
+	 * @param array $selects
+	 * @throws InvalidArgumentException
+	 */
+	private function deriveType(array $selects)
+	{
+		// first if the first key for this array is an integer then its coming in as a simple format, so we'll also
+		// ensure all elements of the array are simple.
+		if (is_int(key($selects))) {
+			// let's ensure all keys are ints
+			$invalid_keys = array_filter(
+				array_keys($selects),
+				function ($value) {
+					return ! is_int($value);
+				}
+			);
+			if (! empty($invalid_keys)) {
+				throw new InvalidArgumentException(
+					sprintf(
+						esc_html__(
+							'Incoming array looks like its formatted for "%1$s" type selects, however it has elements that are not indexed numerically',
+							'event_espresso'
+						),
+						self::TYPE_SIMPLE
+					)
+				);
+			}
+			$this->type = self::TYPE_SIMPLE;
+			return;
+		}
+		// made it here so that means we've got either complex or structured selects.  Let's find out which by popping
+		// the first array element off.
+		$first_element = reset($selects);
+
+		if (! is_array($first_element)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'Incoming array looks like its formatted as a "%1$s" or "%2$s" type.  However, the values in the array must be arrays themselves and they are not.',
+						'event_espresso'
+					),
+					self::TYPE_COMPLEX,
+					self::TYPE_STRUCTURED
+				)
+			);
+		}
+		$this->type = count($first_element) === 2
+			? self::TYPE_COMPLEX
+			: self::TYPE_STRUCTURED;
+	}
+
+
+	/**
+	 * Sets up the various properties for the vo depending on type.
+	 *
+	 * @param array $selects
+	 * @throws InvalidArgumentException
+	 */
+	private function deriveParts(array $selects)
+	{
+		$column_parts = array();
+		switch ($this->type) {
+			case self::TYPE_SIMPLE:
+				$column_parts = $selects;
+				$this->column_aliases_in_select = $selects;
+				break;
+			case self::TYPE_COMPLEX:
+				foreach ($selects as $alias => $parts) {
+					$this->validateSelectValueForType($parts, $alias);
+					$column_parts[] = "{$parts[0]} AS {$alias}";
+					$this->column_aliases_in_select[] = $alias;
+				}
+				break;
+			case self::TYPE_STRUCTURED:
+				foreach ($selects as $alias => $parts) {
+					$this->validateSelectValueForType($parts, $alias);
+					$column_parts[] = $parts[1] !== ''
+						? $this->assembleSelectStringWithOperator($parts, $alias)
+						: "{$parts[0]} AS {$alias}";
+					$this->column_aliases_in_select[] = $alias;
+				}
+				break;
+		}
+		$this->columns_to_select_expression = implode(', ', $column_parts);
+	}
+
+
+	/**
+	 * Validates self::TYPE_COMPLEX and self::TYPE_STRUCTURED select statement parts.
+	 *
+	 * @param array  $select_parts
+	 * @param string $alias
+	 * @throws InvalidArgumentException
+	 */
+	private function validateSelectValueForType(array $select_parts, $alias)
+	{
+		$valid_data_types = array('%d', '%s', '%f');
+		if (count($select_parts) !== $this->expectedSelectPartCountForType()) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The provided select part array for the %1$s column is expected to have a count of %2$d because the incoming select array is of type %3$s.  However the count was %4$d.',
+						'event_espresso'
+					),
+					$alias,
+					$this->expectedSelectPartCountForType(),
+					$this->type,
+					count($select_parts)
+				)
+			);
+		}
+		// validate data type.
+		$data_type = $this->type === self::TYPE_COMPLEX ? $select_parts[1] : '';
+		$data_type = $this->type === self::TYPE_STRUCTURED ? $select_parts[2] : $data_type;
+
+		if (! in_array($data_type, $valid_data_types, true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'Datatype %1$s (for selection "%2$s" and alias "%3$s") is not a valid wpdb datatype (eg %%s)',
+						'event_espresso'
+					),
+					$data_type,
+					$select_parts[0],
+					$alias,
+					implode(', ', $valid_data_types)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Each type will have an expected count of array elements, this returns what that expected count is.
+	 *
+	 * @param string $type
+	 * @return int
+	 */
+	private function expectedSelectPartCountForType($type = '')
+	{
+		$type = $type === '' ? $this->type : $type;
+		$types_count_map = array(
+			self::TYPE_COMPLEX    => 2,
+			self::TYPE_STRUCTURED => 3,
+		);
+		return isset($types_count_map[ $type ]) ? $types_count_map[ $type ] : 0;
+	}
+
+
+	/**
+	 * Prepares the select statement part for for structured type selects.
+	 *
+	 * @param array  $select_parts
+	 * @param string $alias
+	 * @return string
+	 * @throws InvalidArgumentException
+	 */
+	private function assembleSelectStringWithOperator(array $select_parts, $alias)
+	{
+		$operator = strtoupper($select_parts[1]);
+		// validate operator
+		if (! in_array($operator, $this->valid_operators, true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'An invalid operator has been provided (%1$s) for the column %2$s.  Valid operators must be one of the following: %3$s.',
+						'event_espresso'
+					),
+					$operator,
+					$alias,
+					implode(', ', $this->valid_operators)
+				)
+			);
+		}
+		return $operator . '(' . $select_parts[0] . ') AS ' . $alias;
+	}
+
+
+	/**
+	 * Return the datatype from the given select part.
+	 * Remember the select_part has already been validated on object instantiation.
+	 *
+	 * @param array $select_part
+	 * @return string
+	 */
+	private function getDataTypeForSelectType(array $select_part)
+	{
+		switch ($this->type) {
+			case self::TYPE_COMPLEX:
+				return $select_part[1];
+			case self::TYPE_STRUCTURED:
+				return $select_part[2];
+			default:
+				return '';
+		}
+	}
+
+
+	/**
+	 * Returns the original select array sent into the VO.
+	 *
+	 * @return array
+	 */
+	public function originalSelects()
+	{
+		return $this->original_selects;
+	}
+
+
+	/**
+	 * Returns the final assembled select expression derived from the incoming select array.
+	 *
+	 * @return string
+	 */
+	public function columnsToSelectExpression()
+	{
+		return $this->columns_to_select_expression;
+	}
+
+
+	/**
+	 * Returns all the column aliases derived from the incoming select array.
+	 *
+	 * @return array
+	 */
+	public function columnAliases()
+	{
+		return $this->column_aliases_in_select;
+	}
+
+
+	/**
+	 * Returns the enum type for the incoming select array.
+	 *
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->type;
+	}
+
+
+	/**
+	 * Return the datatype for the given column_alias
+	 *
+	 * @param string $column_alias
+	 * @return string  (if there's no data type we return string as the default).
+	 */
+	public function getDataTypeForAlias($column_alias)
+	{
+		if (
+			isset($this->original_selects[ $column_alias ])
+			&& in_array($column_alias, $this->columnAliases(), true)
+		) {
+			return $this->getDataTypeForSelectType($this->original_selects[ $column_alias ]);
+		}
+		return '%s';
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -107,11 +107,11 @@ 
             // let's ensure all keys are ints
             $invalid_keys = array_filter(
                 array_keys($selects),
-                function ($value) {
+                function($value) {
                     return ! is_int($value);
                 }
             );
-            if (! empty($invalid_keys)) {
+            if ( ! empty($invalid_keys)) {
                 throw new InvalidArgumentException(
                     sprintf(
                         esc_html__(
@@ -129,7 +129,7 @@ 
         // the first array element off.
         $first_element = reset($selects);
 
-        if (! is_array($first_element)) {
+        if ( ! is_array($first_element)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -210,7 +210,7 @@ 
         $data_type = $this->type === self::TYPE_COMPLEX ? $select_parts[1] : '';
         $data_type = $this->type === self::TYPE_STRUCTURED ? $select_parts[2] : $data_type;
 
-        if (! in_array($data_type, $valid_data_types, true)) {
+        if ( ! in_array($data_type, $valid_data_types, true)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -240,7 +240,7 @@ 
             self::TYPE_COMPLEX    => 2,
             self::TYPE_STRUCTURED => 3,
         );
-        return isset($types_count_map[ $type ]) ? $types_count_map[ $type ] : 0;
+        return isset($types_count_map[$type]) ? $types_count_map[$type] : 0;
     }
 
 
@@ -256,7 +256,7 @@ 
     {
         $operator = strtoupper($select_parts[1]);
         // validate operator
-        if (! in_array($operator, $this->valid_operators, true)) {
+        if ( ! in_array($operator, $this->valid_operators, true)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -269,7 +269,7 @@ 
                 )
             );
         }
-        return $operator . '(' . $select_parts[0] . ') AS ' . $alias;
+        return $operator.'('.$select_parts[0].') AS '.$alias;
     }
 
 
@@ -346,10 +346,10 @@ 
     public function getDataTypeForAlias($column_alias)
     {
         if (
-            isset($this->original_selects[ $column_alias ])
+            isset($this->original_selects[$column_alias])
             && in_array($column_alias, $this->columnAliases(), true)
         ) {
-            return $this->getDataTypeForSelectType($this->original_selects[ $column_alias ]);
+            return $this->getDataTypeForSelectType($this->original_selects[$column_alias]);
         }
         return '%s';
     }

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

Indentation +22 added lines, -22 removed lines

@@ -15,27 +15,27 @@
 class International extends Basic
 {
 
-    /**
-     * @param string $email_address
-     * @return bool
-     * @throws \EventEspresso\core\domain\services\validation\email\EmailValidationException
-     */
-    public function validate($email_address)
-    {
-        parent::validate($email_address);
-        if (
+	/**
+	 * @param string $email_address
+	 * @return bool
+	 * @throws \EventEspresso\core\domain\services\validation\email\EmailValidationException
+	 */
+	public function validate($email_address)
+	{
+		parent::validate($email_address);
+		if (
 // plz see http://stackoverflow.com/a/24817336 re: the following regex
-            ! preg_match(
-        // @codingStandardsIgnoreStart
-            '/^(?!\.)((?!.*\.{2})[a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\.!#$%&\'*+-\/=?^_`{|}~\-\d]+)@(?!\.)([a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\-\.\d]+)((\.([a-zA-Z\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}]){2,63})+)$/u',
-            // @codingStandardsIgnoreEnd
-                $email_address
-            )
-        ) {
-            throw new EmailValidationException(
-                esc_html__('Email address is invalid.', 'event_espresso')
-            );
-        }
-        return true;
-    }
+			! preg_match(
+		// @codingStandardsIgnoreStart
+			'/^(?!\.)((?!.*\.{2})[a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\.!#$%&\'*+-\/=?^_`{|}~\-\d]+)@(?!\.)([a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\-\.\d]+)((\.([a-zA-Z\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}]){2,63})+)$/u',
+			// @codingStandardsIgnoreEnd
+				$email_address
+			)
+		) {
+			throw new EmailValidationException(
+				esc_html__('Email address is invalid.', 'event_espresso')
+			);
+		}
+		return true;
+	}
 }