eventespresso / event-espresso-core

core/db_models/EEM_Registration.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -467,7 +467,7 @@
      * @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
+     * @return        null|EE_Base_Class        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)

Unused Use Statements -1 removed lines

@@ -1,5 +1,4 @@
 <?php
-use EventEspresso\core\exceptions\InvalidIdentifierException;
 use EventEspresso\core\exceptions\InvalidStatusException;
 use EventEspresso\core\services\database\TableAnalysis;
 

Spacing +25 added lines, -25 removed lines

@@ -369,14 +369,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;
                 }
             }
         }
@@ -433,7 +433,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)));
@@ -450,7 +450,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)));
@@ -501,7 +501,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');
@@ -513,7 +513,7 @@ 
             ),
             OBJECT,
             array(
-                'regDate' => array('DATE(' . $query_interval . ')', '%s'),
+                'regDate' => array('DATE('.$query_interval.')', '%s'),
                 'total' => array('count(REG_ID)', '%d'),
             )
         );
@@ -533,7 +533,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
@@ -542,9 +542,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;
@@ -567,7 +567,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);
     }
@@ -593,7 +593,7 @@ 
             'REG_date' => array('>=', $date_sql),
             'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
         );
-        if (!EE_Registry::instance()->CAP->current_user_can(
+        if ( ! EE_Registry::instance()->CAP->current_user_can(
             'ee_read_others_registrations',
             'reg_per_event_report'
         )
@@ -629,16 +629,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;
@@ -661,7 +661,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);
     }
@@ -676,7 +676,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(
@@ -745,11 +745,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 '
@@ -779,12 +779,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'
@@ -813,7 +813,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)
@@ -868,7 +868,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')
             );
@@ -877,7 +877,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'));
             }
         }

Indentation +866 added lines, -866 removed lines

@@ -13,815 +13,815 @@ 
 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
-     *
-     * @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
+	 *
+	 * @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
@@ -835,61 +835,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
+		);
+	}
 }

core/exceptions/InvalidStatusException.php

Indentation +22 added lines, -22 removed lines

@@ -8,26 +8,26 @@
 
 class InvalidStatusException extends InvalidArgumentException
 {
-    /**
-     * InvalidStatusException constructor.
-     * @param string $status the invalid status id that was supplied
-     * @param string $domain the name of the domain, model, or class that the status belongs to
-     * @param string $message custom message
-     * @param int $code
-     * @param Exception|null $previous
-     */
-    public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    '"%1$s" is not a valid %2$s status',
-                    'event_espresso'
-                ),
-                $status,
-                $domain
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidStatusException constructor.
+	 * @param string $status the invalid status id that was supplied
+	 * @param string $domain the name of the domain, model, or class that the status belongs to
+	 * @param string $message custom message
+	 * @param int $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'"%1$s" is not a valid %2$s status',
+					'event_espresso'
+				),
+				$status,
+				$domain
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/domain/services/admin/AdminToolBar.php

Spacing +10 added lines, -10 removed lines

@@ -120,7 +120,7 @@ 
     {
         wp_register_style(
             'espresso-admin-toolbar',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
+            EE_GLOBAL_ASSETS_URL.'css/espresso-admin-toolbar.css',
             array('dashicons'),
             EVENT_ESPRESSO_VERSION
         );
@@ -143,7 +143,7 @@ 
                 'href'  => $this->events_admin_url,
                 'meta'  => array(
                     'title' => esc_html__('Event Espresso', 'event_espresso'),
-                    'class' => $this->menu_class . 'first',
+                    'class' => $this->menu_class.'first',
                 ),
             )
         );
@@ -491,7 +491,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Approved', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-approved',
                     ),
                 )
             );
@@ -528,7 +528,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Pending Payment', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-pending',
                     ),
                 )
             );
@@ -565,7 +565,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Not Approved', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-not-approved',
                     ),
                 )
             );
@@ -602,7 +602,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Cancelled', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-cancelled',
                     ),
                 )
             );
@@ -674,7 +674,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Approved', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-approved',
                     ),
                 )
             );
@@ -711,7 +711,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Pending', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-pending',
                     ),
                 )
             );
@@ -748,7 +748,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Not Approved', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-not-approved',
                     ),
                 )
             );
@@ -785,7 +785,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Cancelled', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-cancelled',
                     ),
                 )
             );

Indentation +737 added lines, -737 removed lines

@@ -19,741 +19,741 @@
 class AdminToolBar
 {
 
-    /**
-     * @var WP_Admin_Bar $admin_bar
-     */
-    private $admin_bar;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var string $events_admin_url
-     */
-    private $events_admin_url;
-
-    /**
-     * @var string $menu_class
-     */
-    private $menu_class = 'espresso_menu_item_class';
-
-    /**
-     * @var string $reg_admin_url
-     */
-    private $reg_admin_url;
-
-
-    /**
-     * AdminToolBar constructor.
-     *
-     * @param EE_Capabilities $capabilities
-     */
-    public function __construct(EE_Capabilities $capabilities)
-    {
-        $this->capabilities = $capabilities;
-        add_action('admin_bar_menu', array($this, 'espressoToolbarItems'), 100);
-        $this->enqueueAssets();
-    }
-
-
-    /**
-     *    espresso_toolbar_items
-     *
-     * @access public
-     * @param  WP_Admin_Bar $admin_bar
-     * @return void
-     */
-    public function espressoToolbarItems(WP_Admin_Bar $admin_bar)
-    {
-        // if its an AJAX request, or user is NOT an admin, or in full M-Mode
-        if (defined('DOING_AJAX')
-            || ! $this->capabilities->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
-            || EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
-        ) {
-            return;
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->admin_bar = $admin_bar;
-        // we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
-        // because they're only defined in each of their respective constructors
-        // and this might be a frontend request, in which case they aren't available
-        $this->events_admin_url = admin_url('admin.php?page=espresso_events');
-        $this->reg_admin_url = admin_url('admin.php?page=espresso_registrations');
-        // now let's add all of the menu items
-        $this->addTopLevelMenu();
-        $this->addEventsSubMenu();
-        $this->addEventsAddEditHeader();
-        $this->addEventsAddNew();
-        $this->addEventsEditCurrentEvent();
-        $this->addEventsViewHeader();
-        $this->addEventsViewAll();
-        $this->addEventsViewToday();
-        $this->addEventsViewThisMonth();
-        $this->addRegistrationSubMenu();
-        $this->addRegistrationOverviewToday();
-        $this->addRegistrationOverviewTodayApproved();
-        $this->addRegistrationOverviewTodayPendingPayment();
-        $this->addRegistrationOverviewTodayNotApproved();
-        $this->addRegistrationOverviewTodayCancelled();
-        $this->addRegistrationOverviewThisMonth();
-        $this->addRegistrationOverviewThisMonthApproved();
-        $this->addRegistrationOverviewThisMonthPending();
-        $this->addRegistrationOverviewThisMonthNotApproved();
-        $this->addRegistrationOverviewThisMonthCancelled();
-        $this->addExtensionsAndServices();
-    }
-
-
-    /**
-     * @return void
-     */
-    private function enqueueAssets()
-    {
-        wp_register_style(
-            'espresso-admin-toolbar',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
-            array('dashicons'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso-admin-toolbar');
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addTopLevelMenu()
-    {
-        $this->admin_bar->add_menu(
-            array(
-                'id'    => 'espresso-toolbar',
-                'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
-                           . esc_html_x('Event Espresso', 'admin bar menu group label', 'event_espresso')
-                           . '</span>',
-                'href'  => $this->events_admin_url,
-                'meta'  => array(
-                    'title' => esc_html__('Event Espresso', 'event_espresso'),
-                    'class' => $this->menu_class . 'first',
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsSubMenu()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events'
-        )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Events', 'event_espresso'),
-                    'href'   => $this->events_admin_url,
-                    'meta'   => array(
-                        'title'  => esc_html__('Events', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsAddEditHeader()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-view'
-        )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-add-edit',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => esc_html__('Add / Edit', 'event_espresso'),
-                    'href'   => '',
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsAddNew()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_edit_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-new'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-new',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Add New', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array('action' => 'create_new'),
-                        $this->events_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Add New', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsEditCurrentEvent()
-    {
-        if (is_single() && (get_post_type() === 'espresso_events')) {
-            // Current post
-            global $post;
-            if ($this->capabilities->current_user_can(
-                'ee_edit_event',
-                'ee_admin_bar_menu_espresso-toolbar-events-edit',
-                $post->ID
-            )) {
-                $this->admin_bar->add_menu(
-                    array(
-                        'id'     => 'espresso-toolbar-events-edit',
-                        'parent' => 'espresso-toolbar-events',
-                        'title'  => '<span class="ee-toolbar-icon"></span>'
-                                    . esc_html__('Edit Event', 'event_espresso'),
-                        'href'   => EEH_URL::add_query_args_and_nonce(
-                            array(
-                                'action' => 'edit',
-                                'post'   => $post->ID,
-                            ),
-                            $this->events_admin_url
-                        ),
-                        'meta'   => array(
-                            'title'  => esc_html__('Edit Event', 'event_espresso'),
-                            'target' => '',
-                            'class'  => $this->menu_class,
-                        ),
-                    )
-                );
-            }
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewHeader()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-view'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-view',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => esc_html__('View', 'event_espresso'),
-                    'href'   => '',
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewAll()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-all'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-all',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('All', 'event_espresso'),
-                    'href'   => $this->events_admin_url,
-                    'meta'   => array(
-                        'title'  => esc_html__('All', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewToday()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-today'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-today',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Today', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action' => 'default',
-                            'status' => 'today',
-                        ),
-                        $this->events_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Today', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewThisMonth()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-month'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-month',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('This Month', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action' => 'default',
-                            'status' => 'month',
-                        ),
-                        $this->events_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('This Month', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationSubMenu()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Registrations', 'event_espresso'),
-                    'href'   => $this->reg_admin_url,
-                    'meta'   => array(
-                        'title'  => esc_html__('Registrations', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewToday()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => esc_html__('Today', 'event_espresso'),
-                    'href'   => '',
-                    'meta'   => array(
-                        'title'  => esc_html__('Today', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayApproved()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayPendingPayment()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-pending',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Pending', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_pending_payment,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Pending Payment', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayNotApproved()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-not-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Not Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_not_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Not Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayCancelled()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-cancelled',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Cancelled', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_cancelled,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Cancelled', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonth()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => esc_html__('This Month', 'event_espresso'),
-                    'href'   => '', // EEH_URL::add_query_args_and_nonce(
-                    //     array(
-                    //         'action' => 'default',
-                    //         'status' => 'month'
-                    //     ),
-                    //     $this->reg_admin_url
-                    // ),
-                    'meta'   => array(
-                        'title'  => esc_html__('This Month', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthApproved()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthPending()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-pending',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Pending', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_pending_payment,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Pending', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthNotApproved()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-not-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Not Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_not_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Not Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthCancelled()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-cancelled',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Cancelled', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_cancelled,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Cancelled', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addExtensionsAndServices()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_ee',
-            'ee_admin_bar_menu_espresso-toolbar-extensions-and-services'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-extensions-and-services',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Extensions & Services', 'event_espresso'),
-                    'href'   => admin_url('admin.php?page=espresso_packages'),
-                    'meta'   => array(
-                        'title'  => esc_html__('Extensions & Services', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
+	/**
+	 * @var WP_Admin_Bar $admin_bar
+	 */
+	private $admin_bar;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var string $events_admin_url
+	 */
+	private $events_admin_url;
+
+	/**
+	 * @var string $menu_class
+	 */
+	private $menu_class = 'espresso_menu_item_class';
+
+	/**
+	 * @var string $reg_admin_url
+	 */
+	private $reg_admin_url;
+
+
+	/**
+	 * AdminToolBar constructor.
+	 *
+	 * @param EE_Capabilities $capabilities
+	 */
+	public function __construct(EE_Capabilities $capabilities)
+	{
+		$this->capabilities = $capabilities;
+		add_action('admin_bar_menu', array($this, 'espressoToolbarItems'), 100);
+		$this->enqueueAssets();
+	}
+
+
+	/**
+	 *    espresso_toolbar_items
+	 *
+	 * @access public
+	 * @param  WP_Admin_Bar $admin_bar
+	 * @return void
+	 */
+	public function espressoToolbarItems(WP_Admin_Bar $admin_bar)
+	{
+		// if its an AJAX request, or user is NOT an admin, or in full M-Mode
+		if (defined('DOING_AJAX')
+			|| ! $this->capabilities->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
+			|| EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
+		) {
+			return;
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->admin_bar = $admin_bar;
+		// we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
+		// because they're only defined in each of their respective constructors
+		// and this might be a frontend request, in which case they aren't available
+		$this->events_admin_url = admin_url('admin.php?page=espresso_events');
+		$this->reg_admin_url = admin_url('admin.php?page=espresso_registrations');
+		// now let's add all of the menu items
+		$this->addTopLevelMenu();
+		$this->addEventsSubMenu();
+		$this->addEventsAddEditHeader();
+		$this->addEventsAddNew();
+		$this->addEventsEditCurrentEvent();
+		$this->addEventsViewHeader();
+		$this->addEventsViewAll();
+		$this->addEventsViewToday();
+		$this->addEventsViewThisMonth();
+		$this->addRegistrationSubMenu();
+		$this->addRegistrationOverviewToday();
+		$this->addRegistrationOverviewTodayApproved();
+		$this->addRegistrationOverviewTodayPendingPayment();
+		$this->addRegistrationOverviewTodayNotApproved();
+		$this->addRegistrationOverviewTodayCancelled();
+		$this->addRegistrationOverviewThisMonth();
+		$this->addRegistrationOverviewThisMonthApproved();
+		$this->addRegistrationOverviewThisMonthPending();
+		$this->addRegistrationOverviewThisMonthNotApproved();
+		$this->addRegistrationOverviewThisMonthCancelled();
+		$this->addExtensionsAndServices();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function enqueueAssets()
+	{
+		wp_register_style(
+			'espresso-admin-toolbar',
+			EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
+			array('dashicons'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso-admin-toolbar');
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addTopLevelMenu()
+	{
+		$this->admin_bar->add_menu(
+			array(
+				'id'    => 'espresso-toolbar',
+				'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
+						   . esc_html_x('Event Espresso', 'admin bar menu group label', 'event_espresso')
+						   . '</span>',
+				'href'  => $this->events_admin_url,
+				'meta'  => array(
+					'title' => esc_html__('Event Espresso', 'event_espresso'),
+					'class' => $this->menu_class . 'first',
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsSubMenu()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events'
+		)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Events', 'event_espresso'),
+					'href'   => $this->events_admin_url,
+					'meta'   => array(
+						'title'  => esc_html__('Events', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsAddEditHeader()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-view'
+		)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-add-edit',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => esc_html__('Add / Edit', 'event_espresso'),
+					'href'   => '',
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsAddNew()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_edit_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-new'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-new',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Add New', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array('action' => 'create_new'),
+						$this->events_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Add New', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsEditCurrentEvent()
+	{
+		if (is_single() && (get_post_type() === 'espresso_events')) {
+			// Current post
+			global $post;
+			if ($this->capabilities->current_user_can(
+				'ee_edit_event',
+				'ee_admin_bar_menu_espresso-toolbar-events-edit',
+				$post->ID
+			)) {
+				$this->admin_bar->add_menu(
+					array(
+						'id'     => 'espresso-toolbar-events-edit',
+						'parent' => 'espresso-toolbar-events',
+						'title'  => '<span class="ee-toolbar-icon"></span>'
+									. esc_html__('Edit Event', 'event_espresso'),
+						'href'   => EEH_URL::add_query_args_and_nonce(
+							array(
+								'action' => 'edit',
+								'post'   => $post->ID,
+							),
+							$this->events_admin_url
+						),
+						'meta'   => array(
+							'title'  => esc_html__('Edit Event', 'event_espresso'),
+							'target' => '',
+							'class'  => $this->menu_class,
+						),
+					)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewHeader()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-view'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-view',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => esc_html__('View', 'event_espresso'),
+					'href'   => '',
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewAll()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-all'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-all',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('All', 'event_espresso'),
+					'href'   => $this->events_admin_url,
+					'meta'   => array(
+						'title'  => esc_html__('All', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewToday()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-today'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-today',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Today', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action' => 'default',
+							'status' => 'today',
+						),
+						$this->events_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Today', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewThisMonth()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-month'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-month',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('This Month', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action' => 'default',
+							'status' => 'month',
+						),
+						$this->events_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('This Month', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationSubMenu()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Registrations', 'event_espresso'),
+					'href'   => $this->reg_admin_url,
+					'meta'   => array(
+						'title'  => esc_html__('Registrations', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewToday()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => esc_html__('Today', 'event_espresso'),
+					'href'   => '',
+					'meta'   => array(
+						'title'  => esc_html__('Today', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayApproved()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayPendingPayment()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-pending',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Pending', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_pending_payment,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Pending Payment', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayNotApproved()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-not-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Not Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_not_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Not Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayCancelled()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-cancelled',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Cancelled', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_cancelled,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Cancelled', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonth()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => esc_html__('This Month', 'event_espresso'),
+					'href'   => '', // EEH_URL::add_query_args_and_nonce(
+					//     array(
+					//         'action' => 'default',
+					//         'status' => 'month'
+					//     ),
+					//     $this->reg_admin_url
+					// ),
+					'meta'   => array(
+						'title'  => esc_html__('This Month', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthApproved()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthPending()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-pending',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Pending', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_pending_payment,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Pending', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthNotApproved()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-not-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Not Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_not_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Not Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthCancelled()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-cancelled',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Cancelled', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_cancelled,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Cancelled', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addExtensionsAndServices()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_ee',
+			'ee_admin_bar_menu_espresso-toolbar-extensions-and-services'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-extensions-and-services',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Extensions & Services', 'event_espresso'),
+					'href'   => admin_url('admin.php?page=espresso_packages'),
+					'meta'   => array(
+						'title'  => esc_html__('Extensions & Services', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
 }

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

Doc Comments +1 added lines, -1 removed lines

@@ -151,7 +151,7 @@
      * This provides a count of events using this custom template
      *
      * @param  EE_Message_Template_Group $item message_template group data
-     * @return string column output
+     * @return integer column output
      */
     public function column_events($item)
     {

Indentation +225 added lines, -225 removed lines

@@ -12,252 +12,252 @@
 class Custom_Messages_Template_List_Table extends Messages_Template_List_Table
 {
 
-    /**
-     * Setup initial data.
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->get_admin_page()->get_message_templates(
-            $this->_per_page,
-            $this->_view,
-            false,
-            false,
-            false
-        );
-        $this->_all_data_count = $this->get_admin_page()->get_message_templates(
-            $this->_per_page,
-            $this->_view,
-            true,
-            true,
-            false
-        );
-    }
+	/**
+	 * Setup initial data.
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->get_admin_page()->get_message_templates(
+			$this->_per_page,
+			$this->_view,
+			false,
+			false,
+			false
+		);
+		$this->_all_data_count = $this->get_admin_page()->get_message_templates(
+			$this->_per_page,
+			$this->_view,
+			true,
+			true,
+			false
+		);
+	}
 
 
-    /**
-     * Set initial properties
-     */
-    protected function _set_properties()
-    {
-        parent::_set_properties();
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('Message Template Group', 'event_espresso'),
-            'plural'   => esc_html__('Message Template', 'event_espresso'),
-            'ajax'     => true, // for now,
-            'screen'   => $this->get_admin_page()->get_current_screen()->id,
-        );
+	/**
+	 * Set initial properties
+	 */
+	protected function _set_properties()
+	{
+		parent::_set_properties();
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('Message Template Group', 'event_espresso'),
+			'plural'   => esc_html__('Message Template', 'event_espresso'),
+			'ajax'     => true, // for now,
+			'screen'   => $this->get_admin_page()->get_current_screen()->id,
+		);
 
-        $this->_columns = array_merge(
-            array(
-                'cb'   => '<input type="checkbox" />',
-                'name' => esc_html__('Template Name', 'event_espresso'),
-            ),
-            $this->_columns,
-            array(
-                'events'  => esc_html__('Events', 'event_espresso'),
-                'actions' => '',
-            )
-        );
-    }
+		$this->_columns = array_merge(
+			array(
+				'cb'   => '<input type="checkbox" />',
+				'name' => esc_html__('Template Name', 'event_espresso'),
+			),
+			$this->_columns,
+			array(
+				'events'  => esc_html__('Events', 'event_espresso'),
+				'actions' => '',
+			)
+		);
+	}
 
 
-    /**
-     * Custom message for when there are no items found.
-     *
-     * @since 4.3.0
-     */
-    public function no_items()
-    {
-        if ($this->_view !== 'trashed') {
-            printf(
-                esc_html__(
-                    '%sNo Custom Templates found.%s To create your first custom message template, go to the "Default Message Templates" tab and click the "Create Custom" button next to the template you want to use as a base for the new one.',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>'
-            );
-        } else {
-            parent::no_items();
-        }
-    }
+	/**
+	 * Custom message for when there are no items found.
+	 *
+	 * @since 4.3.0
+	 */
+	public function no_items()
+	{
+		if ($this->_view !== 'trashed') {
+			printf(
+				esc_html__(
+					'%sNo Custom Templates found.%s To create your first custom message template, go to the "Default Message Templates" tab and click the "Create Custom" button next to the template you want to use as a base for the new one.',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>'
+			);
+		} else {
+			parent::no_items();
+		}
+	}
 
 
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function column_cb($item)
-    {
-        return sprintf('<input type="checkbox" name="checkbox[%s]" value="1" />', $item->GRP_ID());
-    }
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function column_cb($item)
+	{
+		return sprintf('<input type="checkbox" name="checkbox[%s]" value="1" />', $item->GRP_ID());
+	}
 
 
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function column_name($item)
-    {
-        return '<p>' . $item->name() . '</p>';
-    }
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function column_name($item)
+	{
+		return '<p>' . $item->name() . '</p>';
+	}
 
 
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function column_actions($item)
-    {
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_messages',
-            'espresso_messages_add_new_message_template'
-        )) {
-            $create_args = array(
-                'GRP_ID'       => $item->ID(),
-                'messenger'    => $item->messenger(),
-                'message_type' => $item->message_type(),
-                'action'       => 'add_new_message_template',
-            );
-            $create_link = EE_Admin_Page::add_query_args_and_nonce($create_args, EE_MSG_ADMIN_URL);
-            return sprintf(
-                '<p><a href="%s" class="button button-small">%s</a></p>',
-                $create_link,
-                esc_html__('Create Custom', 'event_espresso')
-            );
-        }
-        return '';
-    }
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function column_actions($item)
+	{
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_messages',
+			'espresso_messages_add_new_message_template'
+		)) {
+			$create_args = array(
+				'GRP_ID'       => $item->ID(),
+				'messenger'    => $item->messenger(),
+				'message_type' => $item->message_type(),
+				'action'       => 'add_new_message_template',
+			);
+			$create_link = EE_Admin_Page::add_query_args_and_nonce($create_args, EE_MSG_ADMIN_URL);
+			return sprintf(
+				'<p><a href="%s" class="button button-small">%s</a></p>',
+				$create_link,
+				esc_html__('Create Custom', 'event_espresso')
+			);
+		}
+		return '';
+	}
 
-    /**
-     * Set the view counts on the _views property
-     */
-    protected function _add_view_counts()
-    {
-        foreach ($this->_views as $view => $args) {
-            $this->_views[ $view ]['count'] = $this->get_admin_page()->get_message_templates(
-                $this->_per_page,
-                $view,
-                true,
-                true,
-                false
-            );
-        }
-    }
+	/**
+	 * Set the view counts on the _views property
+	 */
+	protected function _add_view_counts()
+	{
+		foreach ($this->_views as $view => $args) {
+			$this->_views[ $view ]['count'] = $this->get_admin_page()->get_message_templates(
+				$this->_per_page,
+				$view,
+				true,
+				true,
+				false
+			);
+		}
+	}
 
 
-    /**
-     * column_events
-     * This provides a count of events using this custom template
-     *
-     * @param  EE_Message_Template_Group $item message_template group data
-     * @return string column output
-     */
-    public function column_events($item)
-    {
-        return $item->count_events();
-    }
+	/**
+	 * column_events
+	 * This provides a count of events using this custom template
+	 *
+	 * @param  EE_Message_Template_Group $item message_template group data
+	 * @return string column output
+	 */
+	public function column_events($item)
+	{
+		return $item->count_events();
+	}
 
 
-    /**
-     * Add additional actions for custom message template list view.
-     *
-     * @param EE_Message_Template_Group $item
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_actions_for_messenger_column(EE_Message_Template_Group $item)
-    {
-        $actions = parent::_get_actions_for_messenger_column($item);
+	/**
+	 * Add additional actions for custom message template list view.
+	 *
+	 * @param EE_Message_Template_Group $item
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_actions_for_messenger_column(EE_Message_Template_Group $item)
+	{
+		$actions = parent::_get_actions_for_messenger_column($item);
 
-        // add additional actions for trash/restore etc.
-        $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action'   => 'trash_message_template',
-            'id'       => $item->GRP_ID(),
-            'noheader' => true,
-        ), EE_MSG_ADMIN_URL);
-        // restore link
-        $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action'   => 'restore_message_template',
-            'id'       => $item->GRP_ID(),
-            'noheader' => true,
-        ), EE_MSG_ADMIN_URL);
-        // delete price link
-        $delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action'   => 'delete_message_template',
-            'id'       => $item->GRP_ID(),
-            'noheader' => true,
-        ), EE_MSG_ADMIN_URL);
+		// add additional actions for trash/restore etc.
+		$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action'   => 'trash_message_template',
+			'id'       => $item->GRP_ID(),
+			'noheader' => true,
+		), EE_MSG_ADMIN_URL);
+		// restore link
+		$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action'   => 'restore_message_template',
+			'id'       => $item->GRP_ID(),
+			'noheader' => true,
+		), EE_MSG_ADMIN_URL);
+		// delete price link
+		$delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action'   => 'delete_message_template',
+			'id'       => $item->GRP_ID(),
+			'noheader' => true,
+		), EE_MSG_ADMIN_URL);
 
-        if (! $item->get('MTP_deleted')
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_message',
-                'espresso_messages_trash_message_template',
-                $item->ID()
-            )
-        ) {
-            $actions['trash'] = '<a href="'
-                                . $trash_lnk_url
-                                . '" title="'
-                                . esc_attr__('Move Template Group to Trash', 'event_espresso')
-                                . '">'
-                                . esc_html__('Move to Trash', 'event_espresso')
-                                . '</a>';
-        } else {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_message',
-                'espresso_messages_restore_message_template',
-                $item->ID()
-            )) {
-                $actions['restore'] = '<a href="'
-                                      . $restore_lnk_url
-                                      . '" title="'
-                                      . esc_attr__('Restore Message Template', 'event_espresso')
-                                      . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
-            }
+		if (! $item->get('MTP_deleted')
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_message',
+				'espresso_messages_trash_message_template',
+				$item->ID()
+			)
+		) {
+			$actions['trash'] = '<a href="'
+								. $trash_lnk_url
+								. '" title="'
+								. esc_attr__('Move Template Group to Trash', 'event_espresso')
+								. '">'
+								. esc_html__('Move to Trash', 'event_espresso')
+								. '</a>';
+		} else {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_message',
+				'espresso_messages_restore_message_template',
+				$item->ID()
+			)) {
+				$actions['restore'] = '<a href="'
+									  . $restore_lnk_url
+									  . '" title="'
+									  . esc_attr__('Restore Message Template', 'event_espresso')
+									  . '">'
+									  . esc_html__('Restore', 'event_espresso') . '</a>';
+			}
 
-            if ($this->_view === 'trashed'
-                && EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_message',
-                    'espresso_messages_delete_message_template',
-                    $item->ID()
-                )) {
-                $actions['delete'] = '<a href="'
-                                     . $delete_lnk_url
-                                     . '" title="'
-                                     . esc_attr__('Delete Template Group Permanently', 'event_espresso')
-                                     . '">'
-                                     . esc_html__('Delete Permanently', 'event_espresso')
-                                     . '</a>';
-            }
-        }
-        return $actions;
-    }
+			if ($this->_view === 'trashed'
+				&& EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_message',
+					'espresso_messages_delete_message_template',
+					$item->ID()
+				)) {
+				$actions['delete'] = '<a href="'
+									 . $delete_lnk_url
+									 . '" title="'
+									 . esc_attr__('Delete Template Group Permanently', 'event_espresso')
+									 . '">'
+									 . esc_html__('Delete Permanently', 'event_espresso')
+									 . '</a>';
+			}
+		}
+		return $actions;
+	}
 
 
-    /**
-     * Generate dropdown filter select input for messengers
-     *
-     * @param bool $global
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_messengers_dropdown_filter($global = true)
-    {
-        return parent::_get_messengers_dropdown_filter(false);
-    }
+	/**
+	 * Generate dropdown filter select input for messengers
+	 *
+	 * @param bool $global
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_messengers_dropdown_filter($global = true)
+	{
+		return parent::_get_messengers_dropdown_filter(false);
+	}
 
 
-    /**
-     * Generate dropdown filter select input for message types
-     *
-     * @param bool $global
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_message_types_dropdown_filter($global = true)
-    {
-        return parent::_get_message_types_dropdown_filter(false);
-    }
+	/**
+	 * Generate dropdown filter select input for message types
+	 *
+	 * @param bool $global
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_message_types_dropdown_filter($global = true)
+	{
+		return parent::_get_message_types_dropdown_filter(false);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -99,7 +99,7 @@ 
      */
     public function column_name($item)
     {
-        return '<p>' . $item->name() . '</p>';
+        return '<p>'.$item->name().'</p>';
     }
 
 
@@ -135,7 +135,7 @@ 
     protected function _add_view_counts()
     {
         foreach ($this->_views as $view => $args) {
-            $this->_views[ $view ]['count'] = $this->get_admin_page()->get_message_templates(
+            $this->_views[$view]['count'] = $this->get_admin_page()->get_message_templates(
                 $this->_per_page,
                 $view,
                 true,
@@ -189,7 +189,7 @@ 
             'noheader' => true,
         ), EE_MSG_ADMIN_URL);
 
-        if (! $item->get('MTP_deleted')
+        if ( ! $item->get('MTP_deleted')
             && EE_Registry::instance()->CAP->current_user_can(
                 'ee_delete_message',
                 'espresso_messages_trash_message_template',
@@ -214,7 +214,7 @@ 
                                       . '" title="'
                                       . esc_attr__('Restore Message Template', 'event_espresso')
                                       . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
+                                      . esc_html__('Restore', 'event_espresso').'</a>';
             }
 
             if ($this->_view === 'trashed'

core/libraries/messages/EE_Message_Template_Group_Collection.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
     /**
      * This retrieves any EE_Message_Template_Group in the repo by its ID.
      *
-     * @param $GRP_ID
+     * @param integer $GRP_ID
      * @return EE_Message_Template_Group | null
      */
     public function get_by_ID($GRP_ID)

Indentation +100 added lines, -100 removed lines

@@ -14,115 +14,115 @@
 {
 
 
-    /**
-     * EE_Message_Template_Group_Collection constructor.
-     */
-    public function __construct()
-    {
-        $this->interface = 'EE_Message_Template_Group';
-    }
+	/**
+	 * EE_Message_Template_Group_Collection constructor.
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EE_Message_Template_Group';
+	}
 
 
-    /**
-     * Adds the Message Template Group object to the repository.
-     *
-     * @param           $message_template_group
-     * @param array|int $EVT_ID    Some templates are specific to EVT, so this is provided as a way of
-     *                         indexing the template by key.  If this template is shared among multiple events then
-     *                         include the events as an array.
-     * @return bool
-     */
-    public function add($message_template_group, $EVT_ID = array())
-    {
-        $EVT_ID = is_array($EVT_ID) ? $EVT_ID : (array) $EVT_ID;
-        if ($message_template_group instanceof $this->interface) {
-            $data['key'] = $this->getKey(
-                $message_template_group->messenger(),
-                $message_template_group->message_type(),
-                $EVT_ID
-            );
-            return parent::add($message_template_group, $data);
-        }
-        return false;
-    }
+	/**
+	 * Adds the Message Template Group object to the repository.
+	 *
+	 * @param           $message_template_group
+	 * @param array|int $EVT_ID    Some templates are specific to EVT, so this is provided as a way of
+	 *                         indexing the template by key.  If this template is shared among multiple events then
+	 *                         include the events as an array.
+	 * @return bool
+	 */
+	public function add($message_template_group, $EVT_ID = array())
+	{
+		$EVT_ID = is_array($EVT_ID) ? $EVT_ID : (array) $EVT_ID;
+		if ($message_template_group instanceof $this->interface) {
+			$data['key'] = $this->getKey(
+				$message_template_group->messenger(),
+				$message_template_group->message_type(),
+				$EVT_ID
+			);
+			return parent::add($message_template_group, $data);
+		}
+		return false;
+	}
 
 
-    /**
-     * This retrieves any EE_Message_Template_Group in the repo by its ID.
-     *
-     * @param $GRP_ID
-     * @return EE_Message_Template_Group | null
-     */
-    public function get_by_ID($GRP_ID)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current()->ID() === $GRP_ID) {
-                /** @var EE_Message_Template_Group $message_template_group */
-                $message_template_group = $this->current();
-                $this->rewind();
-                return $message_template_group;
-            }
-            $this->next();
-        }
-        return null;
-    }
+	/**
+	 * This retrieves any EE_Message_Template_Group in the repo by its ID.
+	 *
+	 * @param $GRP_ID
+	 * @return EE_Message_Template_Group | null
+	 */
+	public function get_by_ID($GRP_ID)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current()->ID() === $GRP_ID) {
+				/** @var EE_Message_Template_Group $message_template_group */
+				$message_template_group = $this->current();
+				$this->rewind();
+				return $message_template_group;
+			}
+			$this->next();
+		}
+		return null;
+	}
 
 
-    /**
-     * Generates a hash used to identify a given Message Template Group.
-     *
-     * @param string $messenger    The EE_messenger->name
-     * @param string $message_type The EE_message_type->name
-     * @param int    $EVT_ID       Optional.  If the template is for a specific EVT then that should be included.
-     * @deprecated 4.9.40.rc.017  Use getKey instead.
-     * @return string
-     */
-    public function get_key($messenger, $message_type, $EVT_ID = 0)
-    {
-        $EVT_ID = (array) $EVT_ID;
-        return $this->getKey($messenger, $message_type, $EVT_ID);
-    }
+	/**
+	 * Generates a hash used to identify a given Message Template Group.
+	 *
+	 * @param string $messenger    The EE_messenger->name
+	 * @param string $message_type The EE_message_type->name
+	 * @param int    $EVT_ID       Optional.  If the template is for a specific EVT then that should be included.
+	 * @deprecated 4.9.40.rc.017  Use getKey instead.
+	 * @return string
+	 */
+	public function get_key($messenger, $message_type, $EVT_ID = 0)
+	{
+		$EVT_ID = (array) $EVT_ID;
+		return $this->getKey($messenger, $message_type, $EVT_ID);
+	}
 
 
-    /**
-     * Generates a hash used to identify a given Message Template Group
-     * @param string    $messenger      The EE_messenger->name
-     * @param string    $message_type   The EE_message_type->name
-     * @param array     $EVT_ID         Optional.  If the template is for a specific EVT_ID (or events) then that should
-     *                                  be included.
-     * @since 4.9.40.rc.017
-     * @return string
-     */
-    public function getKey($messenger, $message_type, array $EVT_ID = array())
-    {
-        sort($EVT_ID);
-        $EVT_ID = implode(',', array_unique($EVT_ID));
-        return md5($messenger . $message_type . $EVT_ID);
-    }
+	/**
+	 * Generates a hash used to identify a given Message Template Group
+	 * @param string    $messenger      The EE_messenger->name
+	 * @param string    $message_type   The EE_message_type->name
+	 * @param array     $EVT_ID         Optional.  If the template is for a specific EVT_ID (or events) then that should
+	 *                                  be included.
+	 * @since 4.9.40.rc.017
+	 * @return string
+	 */
+	public function getKey($messenger, $message_type, array $EVT_ID = array())
+	{
+		sort($EVT_ID);
+		$EVT_ID = implode(',', array_unique($EVT_ID));
+		return md5($messenger . $message_type . $EVT_ID);
+	}
 
 
-    /**
-     * This returns a saved EE_Message_Template_Group object if there is one in the repository indexed by a key matching
-     * the given string.
-     *
-     * @param string $key @see EE_Message_Template_Group::get_key() to setup a key formatted for searching.
-     * @return null|EE_Message_Template_Group
-     */
-    public function get_by_key($key)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $data = $this->getInfo();
-            if (isset($data['key']) && $data['key'] === $key) {
-                /** @var EE_Message_Template_Group $message_template_group */
-                $message_template_group = $this->current();
-                $this->rewind();
-                return $message_template_group;
-            }
-            $this->next();
-        }
-        return null;
-    }
+	/**
+	 * This returns a saved EE_Message_Template_Group object if there is one in the repository indexed by a key matching
+	 * the given string.
+	 *
+	 * @param string $key @see EE_Message_Template_Group::get_key() to setup a key formatted for searching.
+	 * @return null|EE_Message_Template_Group
+	 */
+	public function get_by_key($key)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$data = $this->getInfo();
+			if (isset($data['key']) && $data['key'] === $key) {
+				/** @var EE_Message_Template_Group $message_template_group */
+				$message_template_group = $this->current();
+				$this->rewind();
+				return $message_template_group;
+			}
+			$this->next();
+		}
+		return null;
+	}
 
 }

Spacing +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
     {
         sort($EVT_ID);
         $EVT_ID = implode(',', array_unique($EVT_ID));
-        return md5($messenger . $message_type . $EVT_ID);
+        return md5($messenger.$message_type.$EVT_ID);
     }
 
 

public/template_tags.php

Doc Comments +5 added lines, -5 removed lines

@@ -130,7 +130,7 @@ 
  * can_use_espresso_conditionals
  * tests whether the Espresso Conditional tags like is_espresso_event_single() can be called
  *
- * @param $conditional_tag
+ * @param string $conditional_tag
  * @return bool
  */
 function can_use_espresso_conditionals( $conditional_tag ) {
@@ -201,7 +201,7 @@ 
 if ( ! function_exists( 'espresso_ticket_selector' )) {
 	/**
 	 * espresso_ticket_selector
-	 * @param null $event
+	 * @param EE_Event $event
 	 */
 	function espresso_ticket_selector( $event = NULL ) {
 		if (  ! apply_filters( 'FHEE_disable_espresso_ticket_selector', FALSE ) ) {
@@ -842,7 +842,7 @@ 
 	/**
 	 * espresso_event_venues
 	 *
-	 * @return array  all venues related to an event
+	 * @return EE_Venue[]  all venues related to an event
 	 */
 	function espresso_event_venues() {
 		return EEH_Venue_View::get_event_venues();
@@ -875,7 +875,7 @@ 
 	 *
 	 * @param int     $VNU_ID optional, the venue id to check.
 	 *
-	 * @return bool | null
+	 * @return null|boolean | null
 	 */
 	function espresso_is_venue_private( $VNU_ID = 0 ) {
 		return EEH_Venue_View::is_venue_private( $VNU_ID );
@@ -889,7 +889,7 @@ 
 	 * returns true or false if a venue is password protected or not
 	 *
 	 * @param int     $VNU_ID optional, the venue id to check.
-	 * @return string
+	 * @return boolean
 	 */
 	function espresso_venue_is_password_protected( $VNU_ID = 0 ) {
 		EE_Registry::instance()->load_helper( 'Venue_View' );

Indentation +1 added lines, -1 removed lines

@@ -206,7 +206,7 @@
 	function espresso_ticket_selector( $event = NULL ) {
 		if (  ! apply_filters( 'FHEE_disable_espresso_ticket_selector', FALSE ) ) {
 			espresso_load_ticket_selector();
-            \EED_Ticket_Selector::set_definitions();
+			\EED_Ticket_Selector::set_definitions();
 			echo EED_Ticket_Selector::display_ticket_selector( $event );
 		}
 	}

Spacing +289 added lines, -289 removed lines

@@ -14,12 +14,12 @@ 
  * @param int | \EE_Event $event
  * @return bool
  */
-function is_espresso_event( $event = NULL ) {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+function is_espresso_event($event = NULL) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		// extract EE_Event object from passed param regardless of what it is (within reason of course)
-		$event = EEH_Event_View::get_event( $event );
+		$event = EEH_Event_View::get_event($event);
 		// do we have a valid event ?
-		return $event instanceof EE_Event  ? TRUE : FALSE;
+		return $event instanceof EE_Event ? TRUE : FALSE;
 	}
 	return FALSE;
 }
@@ -31,7 +31,7 @@ 
  * @return bool
  */
 function is_espresso_event_single() {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		global $wp_query;
 		// return conditionals set by CPTs
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_event_single : FALSE;
@@ -46,7 +46,7 @@ 
  * @return bool
  */
 function is_espresso_event_archive() {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		global $wp_query;
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_event_archive : FALSE;
 	}
@@ -60,7 +60,7 @@ 
  * @return bool
  */
 function is_espresso_event_taxonomy() {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		global $wp_query;
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_event_taxonomy : FALSE;
 	}
@@ -74,10 +74,10 @@ 
  * @param int | \EE_Venue $venue
  * @return bool
  */
-function is_espresso_venue( $venue = NULL ) {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+function is_espresso_venue($venue = NULL) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		// extract EE_Venue object from passed param regardless of what it is (within reason of course)
-		$venue = EEH_Venue_View::get_venue( $venue, FALSE );
+		$venue = EEH_Venue_View::get_venue($venue, FALSE);
 		// do we have a valid event ?
 		return $venue instanceof EE_Venue ? TRUE : FALSE;
 	}
@@ -91,7 +91,7 @@ 
  * @return bool
  */
 function is_espresso_venue_single() {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		global $wp_query;
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_venue_single : FALSE;
 	}
@@ -105,7 +105,7 @@ 
  * @return bool
  */
 function is_espresso_venue_archive() {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		global $wp_query;
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_venue_archive : FALSE;
 	}
@@ -119,7 +119,7 @@ 
  * @return bool
  */
 function is_espresso_venue_taxonomy() {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		global $wp_query;
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_venue_taxonomy : FALSE;
 	}
@@ -133,12 +133,12 @@ 
  * @param $conditional_tag
  * @return bool
  */
-function can_use_espresso_conditionals( $conditional_tag ) {
-	if ( ! did_action( 'AHEE__EE_System__initialize' )) {
+function can_use_espresso_conditionals($conditional_tag) {
+	if ( ! did_action('AHEE__EE_System__initialize')) {
 		EE_Error::doing_it_wrong(
 			__FUNCTION__,
 			sprintf(
-				__( 'The "%s" conditional tag can not be used until after the "init" hook has run, but works best when used within a theme\'s template files.','event_espresso'),
+				__('The "%s" conditional tag can not be used until after the "init" hook has run, but works best when used within a theme\'s template files.', 'event_espresso'),
 				$conditional_tag
 			),
 			'4.4.0'
@@ -153,13 +153,13 @@ 
 
 /*************************** Event Queries ***************************/
 
-if ( ! function_exists( 'espresso_get_events' )) {
+if ( ! function_exists('espresso_get_events')) {
 	/**
 	 * 	espresso_get_events
 	 * @param array $params
 	 * @return array
 	 */
-	function espresso_get_events( $params = array() ) {
+	function espresso_get_events($params = array()) {
 		//set default params
 		$default_espresso_events_params = array(
 			'limit' => 10,
@@ -170,18 +170,18 @@ 
 			'sort' => 'ASC'
 		);
 		// allow the defaults to be filtered
-		$default_espresso_events_params = apply_filters( 'espresso_get_events__default_espresso_events_params', $default_espresso_events_params );
+		$default_espresso_events_params = apply_filters('espresso_get_events__default_espresso_events_params', $default_espresso_events_params);
 		// grab params and merge with defaults, then extract
-		$params = array_merge( $default_espresso_events_params, $params );
+		$params = array_merge($default_espresso_events_params, $params);
 		// run the query
-		$events_query = new EventEspresso\core\domain\services\wp_queries\EventListQuery( $params );
+		$events_query = new EventEspresso\core\domain\services\wp_queries\EventListQuery($params);
 		// assign results to a variable so we can return it
 		$events = $events_query->have_posts() ? $events_query->posts : array();
 		// but first reset the query and postdata
 		wp_reset_query();
 		wp_reset_postdata();
 		EED_Events_Archive::remove_all_events_archive_filters();
-		unset( $events_query );
+		unset($events_query);
 		return $events;
 	}
 }
@@ -195,33 +195,33 @@ 
  * espresso_load_ticket_selector
  */
 function espresso_load_ticket_selector() {
-	EE_Registry::instance()->load_file( EE_MODULES . 'ticket_selector', 'EED_Ticket_Selector', 'module' );
+	EE_Registry::instance()->load_file(EE_MODULES.'ticket_selector', 'EED_Ticket_Selector', 'module');
 }
 
-if ( ! function_exists( 'espresso_ticket_selector' )) {
+if ( ! function_exists('espresso_ticket_selector')) {
 	/**
 	 * espresso_ticket_selector
 	 * @param null $event
 	 */
-	function espresso_ticket_selector( $event = NULL ) {
-		if (  ! apply_filters( 'FHEE_disable_espresso_ticket_selector', FALSE ) ) {
+	function espresso_ticket_selector($event = NULL) {
+		if ( ! apply_filters('FHEE_disable_espresso_ticket_selector', FALSE)) {
 			espresso_load_ticket_selector();
             \EED_Ticket_Selector::set_definitions();
-			echo EED_Ticket_Selector::display_ticket_selector( $event );
+			echo EED_Ticket_Selector::display_ticket_selector($event);
 		}
 	}
 }
 
 
-	if ( ! function_exists( 'espresso_view_details_btn' )) {
+	if ( ! function_exists('espresso_view_details_btn')) {
 	/**
 	 * espresso_view_details_btn
 	 * @param null $event
 	 */
-	function espresso_view_details_btn( $event = NULL ) {
-		if (  ! apply_filters( 'FHEE_disable_espresso_view_details_btn', FALSE ) ) {
+	function espresso_view_details_btn($event = NULL) {
+		if ( ! apply_filters('FHEE_disable_espresso_view_details_btn', FALSE)) {
 			espresso_load_ticket_selector();
-			echo EED_Ticket_Selector::display_ticket_selector( $event, TRUE );
+			echo EED_Ticket_Selector::display_ticket_selector($event, TRUE);
 		}
 	}
 }
@@ -231,7 +231,7 @@ 
 
 /*************************** EEH_Event_View ***************************/
 
-if ( ! function_exists( 'espresso_load_event_list_assets' )) {
+if ( ! function_exists('espresso_load_event_list_assets')) {
 	/**
 	 * espresso_load_event_list_assets
 	 * ensures that event list styles and scripts are loaded
@@ -240,13 +240,13 @@ 
 	 */
 	function espresso_load_event_list_assets() {
 		$event_list = EED_Events_Archive::instance();
-		add_action( 'AHEE__EE_System__initialize_last', array( $event_list, 'load_event_list_assets' ), 10 );
-		add_filter( 'FHEE_enable_default_espresso_css', '__return_true' );
+		add_action('AHEE__EE_System__initialize_last', array($event_list, 'load_event_list_assets'), 10);
+		add_filter('FHEE_enable_default_espresso_css', '__return_true');
 	}
 }
 
 
-if ( ! function_exists( 'espresso_event_reg_button' )) {
+if ( ! function_exists('espresso_event_reg_button')) {
 	/**
 	 * espresso_event_reg_button
 	 * returns the "Register Now" button if event is active,
@@ -258,9 +258,9 @@ 
 	 * @param bool $EVT_ID
 	 * @return string
 	 */
-	function espresso_event_reg_button( $btn_text_if_active = NULL, $btn_text_if_inactive = FALSE, $EVT_ID = FALSE ) {
-		$event_status = EEH_Event_View::event_active_status( $EVT_ID );
-		switch ( $event_status ) {
+	function espresso_event_reg_button($btn_text_if_active = NULL, $btn_text_if_inactive = FALSE, $EVT_ID = FALSE) {
+		$event_status = EEH_Event_View::event_active_status($EVT_ID);
+		switch ($event_status) {
 			case EE_Datetime::sold_out :
 				$btn_text = __('Sold Out', 'event_espresso');
 				$class = 'ee-pink';
@@ -276,10 +276,10 @@ 
 			case EE_Datetime::upcoming :
 			case EE_Datetime::active :
 			default :
-				$btn_text =! empty( $btn_text_if_active ) ? $btn_text_if_active : __( 'Register Now', 'event_espresso' );
+				$btn_text = ! empty($btn_text_if_active) ? $btn_text_if_active : __('Register Now', 'event_espresso');
 				$class = 'ee-green';
 		}
-		if ( $event_status < 1 && ! empty( $btn_text_if_inactive )) {
+		if ($event_status < 1 && ! empty($btn_text_if_inactive)) {
 			$btn_text = $btn_text_if_inactive;
 			$class = 'ee-grey';
 		}
@@ -293,7 +293,7 @@ 
 
 
 
-if ( ! function_exists( 'espresso_display_ticket_selector' )) {
+if ( ! function_exists('espresso_display_ticket_selector')) {
 	/**
 	 * espresso_display_ticket_selector
 	 * whether or not to display the Ticket Selector for an event
@@ -301,14 +301,14 @@ 
 	 * @param bool $EVT_ID
 	 * @return boolean
 	 */
-	function espresso_display_ticket_selector( $EVT_ID = FALSE ) {
-		return EEH_Event_View::display_ticket_selector( $EVT_ID );
+	function espresso_display_ticket_selector($EVT_ID = FALSE) {
+		return EEH_Event_View::display_ticket_selector($EVT_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_event_status_banner' )) {
+if ( ! function_exists('espresso_event_status_banner')) {
 	/**
 	 * espresso_event_status
 	 * returns a banner showing the event status if it is sold out, expired, or inactive
@@ -316,13 +316,13 @@ 
 	 * @param bool $EVT_ID
 	 * @return string
 	 */
-	function espresso_event_status_banner( $EVT_ID = FALSE ) {
-		return EEH_Event_View::event_status( $EVT_ID );
+	function espresso_event_status_banner($EVT_ID = FALSE) {
+		return EEH_Event_View::event_status($EVT_ID);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_event_status' )) {
+if ( ! function_exists('espresso_event_status')) {
 	/**
 	 * espresso_event_status
 	 * returns the event status if it is sold out, expired, or inactive
@@ -331,13 +331,13 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_event_status( $EVT_ID = 0, $echo = TRUE ) {
-		return EEH_Event_View::event_active_status( $EVT_ID, $echo );
+	function espresso_event_status($EVT_ID = 0, $echo = TRUE) {
+		return EEH_Event_View::event_active_status($EVT_ID, $echo);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_event_categories' )) {
+if ( ! function_exists('espresso_event_categories')) {
 	/**
 	 * espresso_event_categories
 	 * returns the terms associated with an event
@@ -347,17 +347,17 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_event_categories( $EVT_ID = 0, $hide_uncategorized = TRUE, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Event_View::event_categories( $EVT_ID, $hide_uncategorized );
+	function espresso_event_categories($EVT_ID = 0, $hide_uncategorized = TRUE, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Event_View::event_categories($EVT_ID, $hide_uncategorized);
 			return '';
 		}
-		return EEH_Event_View::event_categories( $EVT_ID, $hide_uncategorized );
+		return EEH_Event_View::event_categories($EVT_ID, $hide_uncategorized);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_event_tickets_available' )) {
+if ( ! function_exists('espresso_event_tickets_available')) {
 	/**
 	 * espresso_event_tickets_available
 	 * returns the ticket types available for purchase for an event
@@ -367,26 +367,26 @@ 
 	 * @param bool $format
 	 * @return string
 	 */
-	function espresso_event_tickets_available( $EVT_ID = 0, $echo = TRUE, $format = TRUE ) {
-		$tickets = EEH_Event_View::event_tickets_available( $EVT_ID );
-		if ( is_array( $tickets ) && ! empty( $tickets )) {
+	function espresso_event_tickets_available($EVT_ID = 0, $echo = TRUE, $format = TRUE) {
+		$tickets = EEH_Event_View::event_tickets_available($EVT_ID);
+		if (is_array($tickets) && ! empty($tickets)) {
 			// if formatting then $html will be a string, else it will be an array of ticket objects
-			$html = $format ? '<ul id="ee-event-tickets-ul-' . $EVT_ID . '" class="ee-event-tickets-ul">' : array();
-			foreach ( $tickets as $ticket ) {
-				if ( $ticket instanceof EE_Ticket ) {
-					if ( $format ) {
-						$html .= '<li id="ee-event-tickets-li-' . $ticket->ID() . '" class="ee-event-tickets-li">';
-						$html .= $ticket->name() . ' ' . EEH_Template::format_currency( $ticket->get_ticket_total_with_taxes() );
+			$html = $format ? '<ul id="ee-event-tickets-ul-'.$EVT_ID.'" class="ee-event-tickets-ul">' : array();
+			foreach ($tickets as $ticket) {
+				if ($ticket instanceof EE_Ticket) {
+					if ($format) {
+						$html .= '<li id="ee-event-tickets-li-'.$ticket->ID().'" class="ee-event-tickets-li">';
+						$html .= $ticket->name().' '.EEH_Template::format_currency($ticket->get_ticket_total_with_taxes());
 						$html .= '</li>';
 					} else {
 						$html[] = $ticket;
 					}
 				}
 			}
-			if ( $format ) {
+			if ($format) {
 				$html .= '</ul>';
 			}
-			if ( $echo && $format ) {
+			if ($echo && $format) {
 				echo $html;
 				return '';
 			}
@@ -396,7 +396,7 @@ 
 	}
 }
 
-if ( ! function_exists( 'espresso_event_date_obj' )) {
+if ( ! function_exists('espresso_event_date_obj')) {
 	/**
 	 * espresso_event_date_obj
 	 * returns the primary date object for an event
@@ -404,13 +404,13 @@ 
 	 * @param bool $EVT_ID
 	 * @return object
 	 */
-	function espresso_event_date_obj( $EVT_ID = FALSE ) {
-		return EEH_Event_View::get_primary_date_obj( $EVT_ID );
+	function espresso_event_date_obj($EVT_ID = FALSE) {
+		return EEH_Event_View::get_primary_date_obj($EVT_ID);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_event_date' )) {
+if ( ! function_exists('espresso_event_date')) {
 	/**
 	 * espresso_event_date
 	 * returns the primary date for an event
@@ -421,22 +421,22 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_event_date( $date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE ) {
-		$date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' );
-		$time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' );
-		$date_format = apply_filters( 'FHEE__espresso_event_date__date_format', $date_format );
-		$time_format = apply_filters( 'FHEE__espresso_event_date__time_format', $time_format );
-		if($echo){
-			echo EEH_Event_View::the_event_date( $date_format, $time_format, $EVT_ID );
+	function espresso_event_date($date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE) {
+		$date_format = ! empty($date_format) ? $date_format : get_option('date_format');
+		$time_format = ! empty($time_format) ? $time_format : get_option('time_format');
+		$date_format = apply_filters('FHEE__espresso_event_date__date_format', $date_format);
+		$time_format = apply_filters('FHEE__espresso_event_date__time_format', $time_format);
+		if ($echo) {
+			echo EEH_Event_View::the_event_date($date_format, $time_format, $EVT_ID);
 			return '';
 		}
-		return EEH_Event_View::the_event_date( $date_format, $time_format, $EVT_ID );
+		return EEH_Event_View::the_event_date($date_format, $time_format, $EVT_ID);
 
 	}
 }
 
 
-if ( ! function_exists( 'espresso_list_of_event_dates' )) {
+if ( ! function_exists('espresso_list_of_event_dates')) {
 	/**
 	 * espresso_list_of_event_dates
 	 * returns a unordered list of dates for an event
@@ -451,40 +451,40 @@ 
 	 * @param null   $limit
 	 * @return string
 	 */
-	function espresso_list_of_event_dates( $EVT_ID = 0, $date_format = '', $time_format = '', $echo = TRUE, $show_expired = NULL, $format = TRUE, $add_breaks = TRUE, $limit = NULL ) {
-		$date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' );
-		$time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' );
-		$date_format = apply_filters( 'FHEE__espresso_list_of_event_dates__date_format', $date_format );
-		$time_format = apply_filters( 'FHEE__espresso_list_of_event_dates__time_format', $time_format );
-		$datetimes = EEH_Event_View::get_all_date_obj( $EVT_ID, $show_expired, FALSE, $limit );
-		if ( ! $format ) {
-			return apply_filters( 'FHEE__espresso_list_of_event_dates__datetimes', $datetimes );
+	function espresso_list_of_event_dates($EVT_ID = 0, $date_format = '', $time_format = '', $echo = TRUE, $show_expired = NULL, $format = TRUE, $add_breaks = TRUE, $limit = NULL) {
+		$date_format = ! empty($date_format) ? $date_format : get_option('date_format');
+		$time_format = ! empty($time_format) ? $time_format : get_option('time_format');
+		$date_format = apply_filters('FHEE__espresso_list_of_event_dates__date_format', $date_format);
+		$time_format = apply_filters('FHEE__espresso_list_of_event_dates__time_format', $time_format);
+		$datetimes = EEH_Event_View::get_all_date_obj($EVT_ID, $show_expired, FALSE, $limit);
+		if ( ! $format) {
+			return apply_filters('FHEE__espresso_list_of_event_dates__datetimes', $datetimes);
 		}
 		//d( $datetimes );
-		if ( is_array( $datetimes ) && ! empty( $datetimes )) {
+		if (is_array($datetimes) && ! empty($datetimes)) {
 			global $post;
-			$html = $format ? '<ul id="ee-event-datetimes-ul-' . $post->ID . '" class="ee-event-datetimes-ul ee-clearfix">' : '';
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
-					$html .= '<li id="ee-event-datetimes-li-' . $datetime->ID();
-					$html .= '" class="ee-event-datetimes-li ee-event-datetimes-li-' . $datetime->get_active_status() . '">';
+			$html = $format ? '<ul id="ee-event-datetimes-ul-'.$post->ID.'" class="ee-event-datetimes-ul ee-clearfix">' : '';
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$html .= '<li id="ee-event-datetimes-li-'.$datetime->ID();
+					$html .= '" class="ee-event-datetimes-li ee-event-datetimes-li-'.$datetime->get_active_status().'">';
 					$datetime_name = $datetime->name();
-					$html .= ! empty( $datetime_name ) ? '<strong>' . $datetime_name . '</strong>' : '';
-					$html .= ! empty( $datetime_name )  && $add_breaks ? '<br />' : '';
-					$html .= '<span class="dashicons dashicons-calendar"></span><span class="ee-event-datetimes-li-daterange">' . $datetime->date_range( $date_format ) . '</span><br/>';
-					$html .= '<span class="dashicons dashicons-clock"></span><span class="ee-event-datetimes-li-timerange">' . $datetime->time_range( $time_format ) . '</span>';
+					$html .= ! empty($datetime_name) ? '<strong>'.$datetime_name.'</strong>' : '';
+					$html .= ! empty($datetime_name) && $add_breaks ? '<br />' : '';
+					$html .= '<span class="dashicons dashicons-calendar"></span><span class="ee-event-datetimes-li-daterange">'.$datetime->date_range($date_format).'</span><br/>';
+					$html .= '<span class="dashicons dashicons-clock"></span><span class="ee-event-datetimes-li-timerange">'.$datetime->time_range($time_format).'</span>';
 					$datetime_description = $datetime->description();
-					$html .= ! empty( $datetime_description )  && $add_breaks ? '<br />' : '';
-					$html .= ! empty( $datetime_description ) ? ' - ' . $datetime_description : '';
-					$html = apply_filters( 'FHEE__espresso_list_of_event_dates__datetime_html', $html, $datetime );
+					$html .= ! empty($datetime_description) && $add_breaks ? '<br />' : '';
+					$html .= ! empty($datetime_description) ? ' - '.$datetime_description : '';
+					$html = apply_filters('FHEE__espresso_list_of_event_dates__datetime_html', $html, $datetime);
 					$html .= '</li>';
 				}
 			}
 			$html .= $format ? '</ul>' : '';
 		} else {
-			$html = $format ?  '<p><span class="dashicons dashicons-marker pink-text"></span>' . __( 'There are no upcoming dates for this event.', 'event_espresso' ) . '</p><br/>' : '';
+			$html = $format ? '<p><span class="dashicons dashicons-marker pink-text"></span>'.__('There are no upcoming dates for this event.', 'event_espresso').'</p><br/>' : '';
 		}
-		if ( $echo ) {
+		if ($echo) {
 			echo $html;
 			return '';
 		}
@@ -493,7 +493,7 @@ 
 }
 
 
-if ( ! function_exists( 'espresso_event_end_date' )) {
+if ( ! function_exists('espresso_event_end_date')) {
 	/**
 	 * espresso_event_end_date
 	 * returns the last date for an event
@@ -504,20 +504,20 @@ 
 	 * @param bool   $echo
 	 * @return string
 	 */
-	function espresso_event_end_date( $date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE ) {
-		$date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' );
-		$time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' );
-		$date_format = apply_filters( 'FHEE__espresso_event_end_date__date_format', $date_format );
-		$time_format = apply_filters( 'FHEE__espresso_event_end_date__time_format', $time_format );
-		if($echo){
-			echo EEH_Event_View::the_event_end_date( $date_format, $time_format, $EVT_ID );
+	function espresso_event_end_date($date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE) {
+		$date_format = ! empty($date_format) ? $date_format : get_option('date_format');
+		$time_format = ! empty($time_format) ? $time_format : get_option('time_format');
+		$date_format = apply_filters('FHEE__espresso_event_end_date__date_format', $date_format);
+		$time_format = apply_filters('FHEE__espresso_event_end_date__time_format', $time_format);
+		if ($echo) {
+			echo EEH_Event_View::the_event_end_date($date_format, $time_format, $EVT_ID);
 			return '';
 		}
-		return EEH_Event_View::the_event_end_date( $date_format, $time_format, $EVT_ID );
+		return EEH_Event_View::the_event_end_date($date_format, $time_format, $EVT_ID);
 	}
 }
 
-if ( ! function_exists( 'espresso_event_date_range' )) {
+if ( ! function_exists('espresso_event_date_range')) {
 	/**
 	 * espresso_event_date_range
 	 * returns the first and last chronologically ordered dates for an event (if different)
@@ -530,31 +530,31 @@ 
 	 * @param bool   $echo
 	 * @return string
 	 */
-	function espresso_event_date_range( $date_format = '', $time_format = '', $single_date_format = '', $single_time_format = '', $EVT_ID = FALSE, $echo = TRUE ) {
+	function espresso_event_date_range($date_format = '', $time_format = '', $single_date_format = '', $single_time_format = '', $EVT_ID = FALSE, $echo = TRUE) {
 		// set and filter date and time formats when a range is returned
-		$date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' );
-		$date_format = apply_filters( 'FHEE__espresso_event_date_range__date_format', $date_format );
+		$date_format = ! empty($date_format) ? $date_format : get_option('date_format');
+		$date_format = apply_filters('FHEE__espresso_event_date_range__date_format', $date_format);
 		// get the start and end date with NO time portion
-		$the_event_date = EEH_Event_View::the_earliest_event_date( $date_format, '', $EVT_ID );
-		$the_event_end_date = EEH_Event_View::the_latest_event_date( $date_format, '', $EVT_ID );
+		$the_event_date = EEH_Event_View::the_earliest_event_date($date_format, '', $EVT_ID);
+		$the_event_end_date = EEH_Event_View::the_latest_event_date($date_format, '', $EVT_ID);
 		// now we can determine if date range spans more than one day
-		if ( $the_event_date != $the_event_end_date ) {
-			$time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' );
-			$time_format = apply_filters( 'FHEE__espresso_event_date_range__time_format', $time_format );
+		if ($the_event_date != $the_event_end_date) {
+			$time_format = ! empty($time_format) ? $time_format : get_option('time_format');
+			$time_format = apply_filters('FHEE__espresso_event_date_range__time_format', $time_format);
 			$html = sprintf(
-				__( '%1$s - %2$s', 'event_espresso' ),
-				EEH_Event_View::the_earliest_event_date( $date_format, $time_format, $EVT_ID ),
-				EEH_Event_View::the_latest_event_date( $date_format, $time_format, $EVT_ID )
+				__('%1$s - %2$s', 'event_espresso'),
+				EEH_Event_View::the_earliest_event_date($date_format, $time_format, $EVT_ID),
+				EEH_Event_View::the_latest_event_date($date_format, $time_format, $EVT_ID)
 			);
 		} else {
 			// set and filter date and time formats when only a single datetime is returned
-			$single_date_format = ! empty( $single_date_format ) ? $single_date_format : get_option( 'date_format' );
-			$single_time_format = ! empty( $single_time_format ) ? $single_time_format : get_option( 'time_format' );
-			$single_date_format = apply_filters( 'FHEE__espresso_event_date_range__single_date_format', $single_date_format );
-			$single_time_format = apply_filters( 'FHEE__espresso_event_date_range__single_time_format', $single_time_format );
-			$html = EEH_Event_View::the_earliest_event_date( $single_date_format, $single_time_format, $EVT_ID );
+			$single_date_format = ! empty($single_date_format) ? $single_date_format : get_option('date_format');
+			$single_time_format = ! empty($single_time_format) ? $single_time_format : get_option('time_format');
+			$single_date_format = apply_filters('FHEE__espresso_event_date_range__single_date_format', $single_date_format);
+			$single_time_format = apply_filters('FHEE__espresso_event_date_range__single_time_format', $single_time_format);
+			$html = EEH_Event_View::the_earliest_event_date($single_date_format, $single_time_format, $EVT_ID);
 		}
-		if ( $echo ) {
+		if ($echo) {
 			echo $html;
 			return '';
 		}
@@ -562,7 +562,7 @@ 
 	}
 }
 
-if ( ! function_exists( 'espresso_next_upcoming_datetime_obj' )) {
+if ( ! function_exists('espresso_next_upcoming_datetime_obj')) {
 	/**
 	 * espresso_next_upcoming_datetime_obj
 	 * returns the next upcoming datetime object for an event
@@ -570,12 +570,12 @@ 
 	 * @param int $EVT_ID
 	 * @return EE_Datetime|null
 	 */
-	function espresso_next_upcoming_datetime_obj( $EVT_ID = 0 ) {
-		return EEH_Event_View::get_next_upcoming_date_obj( $EVT_ID );
+	function espresso_next_upcoming_datetime_obj($EVT_ID = 0) {
+		return EEH_Event_View::get_next_upcoming_date_obj($EVT_ID);
 	}
 }
 
-if ( ! function_exists( 'espresso_next_upcoming_datetime' ) ) {
+if ( ! function_exists('espresso_next_upcoming_datetime')) {
 	/**
 	 * espresso_next_upcoming_datetime
 	 * returns the start date and time for the next upcoming event.
@@ -586,30 +586,30 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_next_upcoming_datetime( $date_format = '', $time_format = '', $EVT_ID = 0, $echo = true ) {
+	function espresso_next_upcoming_datetime($date_format = '', $time_format = '', $EVT_ID = 0, $echo = true) {
 
-		$date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' );
-		$date_format = apply_filters( 'FHEE__espresso_next_upcoming_datetime__date_format', $date_format );
+		$date_format = ! empty($date_format) ? $date_format : get_option('date_format');
+		$date_format = apply_filters('FHEE__espresso_next_upcoming_datetime__date_format', $date_format);
 
-		$time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' );
-		$time_format = apply_filters( 'FHEE__espresso_next_upcoming_datetime__time_format', $time_format );
+		$time_format = ! empty($time_format) ? $time_format : get_option('time_format');
+		$time_format = apply_filters('FHEE__espresso_next_upcoming_datetime__time_format', $time_format);
 
-		$datetime_format = trim( $date_format . ' ' . $time_format);
+		$datetime_format = trim($date_format.' '.$time_format);
 
-		$datetime = espresso_next_upcoming_datetime_obj( $EVT_ID );
+		$datetime = espresso_next_upcoming_datetime_obj($EVT_ID);
 
-		if( ! $datetime instanceof EE_Datetime ) {
+		if ( ! $datetime instanceof EE_Datetime) {
 			return '';
 		}
-		if ( $echo ){
-			echo $datetime->get_i18n_datetime( 'DTT_EVT_start', $datetime_format );
+		if ($echo) {
+			echo $datetime->get_i18n_datetime('DTT_EVT_start', $datetime_format);
 			return '';
 		}
-		return $datetime->get_i18n_datetime( 'DTT_EVT_start', $datetime_format );
+		return $datetime->get_i18n_datetime('DTT_EVT_start', $datetime_format);
 	}
 }
 
-if ( ! function_exists( 'espresso_event_date_as_calendar_page' )) {
+if ( ! function_exists('espresso_event_date_as_calendar_page')) {
 	/**
 	 * espresso_event_date_as_calendar_page
 	 * returns the primary date for an event, stylized to appear as the page of a calendar
@@ -617,15 +617,15 @@ 
 	 * @param bool $EVT_ID
 	 * @return string
 	 */
-	function espresso_event_date_as_calendar_page( $EVT_ID = FALSE ) {
-		EEH_Event_View::event_date_as_calendar_page( $EVT_ID );
+	function espresso_event_date_as_calendar_page($EVT_ID = FALSE) {
+		EEH_Event_View::event_date_as_calendar_page($EVT_ID);
 	}
 }
 
 
 
 
-if ( ! function_exists( 'espresso_event_link_url' )) {
+if ( ! function_exists('espresso_event_link_url')) {
 	/**
 	 * espresso_event_link_url
 	 *
@@ -633,18 +633,18 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_event_link_url( $EVT_ID = 0, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Event_View::event_link_url( $EVT_ID );
+	function espresso_event_link_url($EVT_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Event_View::event_link_url($EVT_ID);
 			return '';
 		}
-		return EEH_Event_View::event_link_url( $EVT_ID );
+		return EEH_Event_View::event_link_url($EVT_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_event_has_content_or_excerpt' )) {
+if ( ! function_exists('espresso_event_has_content_or_excerpt')) {
 	/**
 	 *    espresso_event_has_content_or_excerpt
 	 *
@@ -652,15 +652,15 @@ 
 	 * @param bool $EVT_ID
 	 * @return    boolean
 	 */
-	function espresso_event_has_content_or_excerpt( $EVT_ID = FALSE ) {
-		return EEH_Event_View::event_has_content_or_excerpt( $EVT_ID );
+	function espresso_event_has_content_or_excerpt($EVT_ID = FALSE) {
+		return EEH_Event_View::event_has_content_or_excerpt($EVT_ID);
 	}
 }
 
 
 
 
-if ( ! function_exists( 'espresso_event_content_or_excerpt' )) {
+if ( ! function_exists('espresso_event_content_or_excerpt')) {
 	/**
 	 * espresso_event_content_or_excerpt
 	 *
@@ -669,18 +669,18 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_event_content_or_excerpt( $num_words = 55, $more = NULL, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Event_View::event_content_or_excerpt( $num_words, $more );
+	function espresso_event_content_or_excerpt($num_words = 55, $more = NULL, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Event_View::event_content_or_excerpt($num_words, $more);
 			return '';
 		}
-		return EEH_Event_View::event_content_or_excerpt( $num_words, $more );
+		return EEH_Event_View::event_content_or_excerpt($num_words, $more);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_event_phone' )) {
+if ( ! function_exists('espresso_event_phone')) {
 	/**
 	 * espresso_event_phone
 	 *
@@ -688,18 +688,18 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_event_phone( $EVT_ID = 0, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Event_View::event_phone( $EVT_ID );
+	function espresso_event_phone($EVT_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Event_View::event_phone($EVT_ID);
 			return '';
 		}
-		return EEH_Event_View::event_phone( $EVT_ID );
+		return EEH_Event_View::event_phone($EVT_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_edit_event_link' )) {
+if ( ! function_exists('espresso_edit_event_link')) {
 	/**
 	 * espresso_edit_event_link
 	 * returns a link to edit an event
@@ -708,39 +708,39 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_edit_event_link( $EVT_ID = 0, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Event_View::edit_event_link( $EVT_ID );
+	function espresso_edit_event_link($EVT_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Event_View::edit_event_link($EVT_ID);
 			return '';
 		}
-		return EEH_Event_View::edit_event_link( $EVT_ID );
+		return EEH_Event_View::edit_event_link($EVT_ID);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_organization_name' )) {
+if ( ! function_exists('espresso_organization_name')) {
 	/**
 	 * espresso_organization_name
 	 * @param bool $echo
 	 * @return string
 	 */
 	function espresso_organization_name($echo = TRUE) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'name' );
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('name');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'name' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('name');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_address' )) {
+if ( ! function_exists('espresso_organization_address')) {
 	/**
 	 * espresso_organization_address
 	 * @param string $type
 	 * @return string
 	 */
-	function espresso_organization_address( $type = 'inline' ) {
-		if ( EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config ) {
+	function espresso_organization_address($type = 'inline') {
+		if (EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config) {
 			$address = new EventEspresso\core\domain\entities\GenericAddress(
 				EE_Registry::instance()->CFG->organization->address_1,
 				EE_Registry::instance()->CFG->organization->address_2,
@@ -749,129 +749,129 @@ 
 				EE_Registry::instance()->CFG->organization->zip,
 				EE_Registry::instance()->CFG->organization->CNT_ISO
 			);
-			return EEH_Address::format( $address, $type );
+			return EEH_Address::format($address, $type);
 		}
 		return '';
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_email' )) {
+if ( ! function_exists('espresso_organization_email')) {
 	/**
 	 * espresso_organization_email
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_email( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'email' );
+	function espresso_organization_email($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('email');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'email' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('email');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_logo_url' )) {
+if ( ! function_exists('espresso_organization_logo_url')) {
 	/**
 	 * espresso_organization_logo_url
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_logo_url( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'logo_url' );
+	function espresso_organization_logo_url($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('logo_url');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'logo_url' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('logo_url');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_facebook' )) {
+if ( ! function_exists('espresso_organization_facebook')) {
 	/**
 	 * espresso_organization_facebook
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_facebook( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'facebook' );
+	function espresso_organization_facebook($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('facebook');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'facebook' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('facebook');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_twitter' )) {
+if ( ! function_exists('espresso_organization_twitter')) {
 	/**
 	 * espresso_organization_twitter
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_twitter( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'twitter' );
+	function espresso_organization_twitter($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('twitter');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'twitter' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('twitter');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_linkedin' )) {
+if ( ! function_exists('espresso_organization_linkedin')) {
 	/**
 	 * espresso_organization_linkedin
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_linkedin( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'linkedin' );
+	function espresso_organization_linkedin($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('linkedin');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'linkedin' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('linkedin');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_pinterest' )) {
+if ( ! function_exists('espresso_organization_pinterest')) {
 	/**
 	 * espresso_organization_pinterest
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_pinterest( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'pinterest' );
+	function espresso_organization_pinterest($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('pinterest');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'pinterest' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('pinterest');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_google' )) {
+if ( ! function_exists('espresso_organization_google')) {
 	/**
 	 * espresso_organization_google
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_google( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'google' );
+	function espresso_organization_google($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('google');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'google' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('google');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_instagram' )) {
+if ( ! function_exists('espresso_organization_instagram')) {
 	/**
 	 * espresso_organization_instagram
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_instagram( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'instagram' );
+	function espresso_organization_instagram($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('instagram');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'instagram' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('instagram');
 	}
 }
 
@@ -881,7 +881,7 @@ 
 
 
 
-if ( ! function_exists( 'espresso_event_venues' )) {
+if ( ! function_exists('espresso_event_venues')) {
 	/**
 	 * espresso_event_venues
 	 *
@@ -895,7 +895,7 @@ 
 
 
 
-if ( ! function_exists( 'espresso_venue_id' )) {
+if ( ! function_exists('espresso_venue_id')) {
 	/**
 	 *    espresso_venue_name
 	 *
@@ -903,15 +903,15 @@ 
 	 * @param     int $EVT_ID
 	 * @return    string
 	 */
-	function espresso_venue_id( $EVT_ID = 0 ) {
-		$venue = EEH_Venue_View::get_venue( $EVT_ID );
+	function espresso_venue_id($EVT_ID = 0) {
+		$venue = EEH_Venue_View::get_venue($EVT_ID);
 		return $venue instanceof EE_Venue ? $venue->ID() : 0;
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_is_venue_private' ) ) {
+if ( ! function_exists('espresso_is_venue_private')) {
 	/**
 	 * Return whether a venue is private or not.
 	 * @see EEH_Venue_View::get_venue() for more info on expected return results.
@@ -920,45 +920,45 @@ 
 	 *
 	 * @return bool | null
 	 */
-	function espresso_is_venue_private( $VNU_ID = 0 ) {
-		return EEH_Venue_View::is_venue_private( $VNU_ID );
+	function espresso_is_venue_private($VNU_ID = 0) {
+		return EEH_Venue_View::is_venue_private($VNU_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_venue_is_password_protected' ) ) {
+if ( ! function_exists('espresso_venue_is_password_protected')) {
 	/**
 	 * returns true or false if a venue is password protected or not
 	 *
 	 * @param int     $VNU_ID optional, the venue id to check.
 	 * @return string
 	 */
-	function espresso_venue_is_password_protected( $VNU_ID = 0 ) {
-		EE_Registry::instance()->load_helper( 'Venue_View' );
-		return EEH_Venue_View::is_venue_password_protected( $VNU_ID );
+	function espresso_venue_is_password_protected($VNU_ID = 0) {
+		EE_Registry::instance()->load_helper('Venue_View');
+		return EEH_Venue_View::is_venue_password_protected($VNU_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_password_protected_venue_form' ) ) {
+if ( ! function_exists('espresso_password_protected_venue_form')) {
 	/**
 	 * Returns a password form if venue is password protected.
 	 *
 	 * @param int     $VNU_ID optional, the venue id to check.
 	 * @return string
 	 */
-	function espresso_password_protected_venue_form( $VNU_ID = 0 ) {
-		EE_Registry::instance()->load_helper( 'Venue_View' );
-		return EEH_Venue_View::password_protected_venue_form( $VNU_ID );
+	function espresso_password_protected_venue_form($VNU_ID = 0) {
+		EE_Registry::instance()->load_helper('Venue_View');
+		return EEH_Venue_View::password_protected_venue_form($VNU_ID);
 	}
 }
 
 
 
 
-if ( ! function_exists( 'espresso_venue_name' )) {
+if ( ! function_exists('espresso_venue_name')) {
 	/**
 	 *    espresso_venue_name
 	 *
@@ -968,19 +968,19 @@ 
 	 * @param bool   $echo
 	 * @return    string
 	 */
-	function espresso_venue_name( $VNU_ID = 0, $link_to = 'details', $echo = TRUE ) {
-		if($echo){
-			echo EEH_Venue_View::venue_name( $link_to, $VNU_ID );
+	function espresso_venue_name($VNU_ID = 0, $link_to = 'details', $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_name($link_to, $VNU_ID);
 			return '';
 		}
-		return EEH_Venue_View::venue_name( $link_to, $VNU_ID );
+		return EEH_Venue_View::venue_name($link_to, $VNU_ID);
 	}
 }
 
 
 
 
-if ( ! function_exists( 'espresso_venue_link' )) {
+if ( ! function_exists('espresso_venue_link')) {
 	/**
 	 * 	espresso_venue_link
 	 *
@@ -989,14 +989,14 @@ 
 	 *  @param 	string 	$text
 	 *  @return 	string
 	 */
-	function espresso_venue_link( $VNU_ID = 0, $text = '' ) {
-		return EEH_Venue_View::venue_details_link( $VNU_ID, $text );
+	function espresso_venue_link($VNU_ID = 0, $text = '') {
+		return EEH_Venue_View::venue_details_link($VNU_ID, $text);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_venue_description' )) {
+if ( ! function_exists('espresso_venue_description')) {
 	/**
 	 *    espresso_venue_description
 	 *
@@ -1005,17 +1005,17 @@ 
 	 * @param bool $echo
 	 * @return    string
 	 */
-	function espresso_venue_description( $VNU_ID = FALSE, $echo = TRUE ) {
-		if($echo){
-			echo EEH_Venue_View::venue_description( $VNU_ID );
+	function espresso_venue_description($VNU_ID = FALSE, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_description($VNU_ID);
 			return '';
 		}
-		return EEH_Venue_View::venue_description( $VNU_ID );
+		return EEH_Venue_View::venue_description($VNU_ID);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_venue_excerpt' )) {
+if ( ! function_exists('espresso_venue_excerpt')) {
 	/**
 	 *    espresso_venue_excerpt
 	 *
@@ -1024,18 +1024,18 @@ 
 	 * @param bool $echo
 	 * @return    string
 	 */
-	function espresso_venue_excerpt( $VNU_ID = 0,  $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Venue_View::venue_excerpt( $VNU_ID );
+	function espresso_venue_excerpt($VNU_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_excerpt($VNU_ID);
 			return '';
 		}
-		return EEH_Venue_View::venue_excerpt( $VNU_ID );
+		return EEH_Venue_View::venue_excerpt($VNU_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_venue_categories' )) {
+if ( ! function_exists('espresso_venue_categories')) {
 	/**
 	 * espresso_venue_categories
 	 * returns the terms associated with a venue
@@ -1045,17 +1045,17 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_venue_categories( $VNU_ID = 0, $hide_uncategorized = TRUE,  $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Venue_View::venue_categories( $VNU_ID, $hide_uncategorized );
+	function espresso_venue_categories($VNU_ID = 0, $hide_uncategorized = TRUE, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_categories($VNU_ID, $hide_uncategorized);
 			return '';
 		}
-		return EEH_Venue_View::venue_categories( $VNU_ID, $hide_uncategorized );
+		return EEH_Venue_View::venue_categories($VNU_ID, $hide_uncategorized);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_venue_address' )) {
+if ( ! function_exists('espresso_venue_address')) {
 	/**
 	 * espresso_venue_address
 	 * returns a formatted block of html  for displaying a venue's address
@@ -1065,17 +1065,17 @@ 
 	 * @param bool   $echo
 	 * @return string
 	 */
-	function espresso_venue_address( $type = 'multiline', $VNU_ID = 0, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Venue_View::venue_address( $type, $VNU_ID );
+	function espresso_venue_address($type = 'multiline', $VNU_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_address($type, $VNU_ID);
 			return '';
 		}
-		return EEH_Venue_View::venue_address( $type, $VNU_ID );
+		return EEH_Venue_View::venue_address($type, $VNU_ID);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_venue_raw_address' )) {
+if ( ! function_exists('espresso_venue_raw_address')) {
 	/**
 	 * espresso_venue_address
 	 * returns an UN-formatted string containing a venue's address
@@ -1085,17 +1085,17 @@ 
 	 * @param bool     $echo
 	 * @return string
 	 */
-	function espresso_venue_raw_address( $type = 'multiline', $VNU_ID = 0, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Venue_View::venue_address( $type, $VNU_ID, FALSE, FALSE );
+	function espresso_venue_raw_address($type = 'multiline', $VNU_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_address($type, $VNU_ID, FALSE, FALSE);
 			return '';
 		}
-		return EEH_Venue_View::venue_address( $type, $VNU_ID, FALSE, FALSE );
+		return EEH_Venue_View::venue_address($type, $VNU_ID, FALSE, FALSE);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_venue_has_address' )) {
+if ( ! function_exists('espresso_venue_has_address')) {
 	/**
 	 * espresso_venue_has_address
 	 * returns TRUE or FALSE if a Venue has address information
@@ -1103,13 +1103,13 @@ 
 	 * @param int $VNU_ID
 	 * @return bool
 	 */
-	function espresso_venue_has_address( $VNU_ID = 0 ) {
-		return EEH_Venue_View::venue_has_address( $VNU_ID );
+	function espresso_venue_has_address($VNU_ID = 0) {
+		return EEH_Venue_View::venue_has_address($VNU_ID);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_venue_gmap' )) {
+if ( ! function_exists('espresso_venue_gmap')) {
 	/**
 	 * espresso_venue_gmap
 	 * returns a google map for the venue address
@@ -1120,17 +1120,17 @@ 
 	 * @param bool     $echo
 	 * @return string
 	 */
-	function espresso_venue_gmap( $VNU_ID = 0, $map_ID = FALSE, $gmap = array(), $echo = TRUE  ) {
-		if ( $echo ) {
-			echo EEH_Venue_View::venue_gmap( $VNU_ID, $map_ID, $gmap );
+	function espresso_venue_gmap($VNU_ID = 0, $map_ID = FALSE, $gmap = array(), $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_gmap($VNU_ID, $map_ID, $gmap);
 			return '';
 		}
-		return EEH_Venue_View::venue_gmap( $VNU_ID, $map_ID, $gmap );
+		return EEH_Venue_View::venue_gmap($VNU_ID, $map_ID, $gmap);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_venue_phone' )) {
+if ( ! function_exists('espresso_venue_phone')) {
 	/**
 	 * espresso_venue_phone
 	 *
@@ -1138,18 +1138,18 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_venue_phone( $VNU_ID = 0, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Venue_View::venue_phone( $VNU_ID );
+	function espresso_venue_phone($VNU_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_phone($VNU_ID);
 			return '';
 		}
-		return EEH_Venue_View::venue_phone( $VNU_ID );
+		return EEH_Venue_View::venue_phone($VNU_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_venue_website' )) {
+if ( ! function_exists('espresso_venue_website')) {
 	/**
 	 * espresso_venue_website
 	 *
@@ -1157,18 +1157,18 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_venue_website( $VNU_ID = 0, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Venue_View::venue_website_link( $VNU_ID );
+	function espresso_venue_website($VNU_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_website_link($VNU_ID);
 			return '';
 		}
-		return EEH_Venue_View::venue_website_link( $VNU_ID );
+		return EEH_Venue_View::venue_website_link($VNU_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_edit_venue_link' )) {
+if ( ! function_exists('espresso_edit_venue_link')) {
 	/**
 	 * espresso_edit_venue_link
 	 *
@@ -1176,12 +1176,12 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_edit_venue_link( $VNU_ID = 0, $echo = TRUE ) {
-		if($echo){
-			echo EEH_Venue_View::edit_venue_link( $VNU_ID );
+	function espresso_edit_venue_link($VNU_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::edit_venue_link($VNU_ID);
 			return '';
 		}
-		return EEH_Venue_View::edit_venue_link( $VNU_ID );
+		return EEH_Venue_View::edit_venue_link($VNU_ID);
 	}
 }
 

core/services/cache/BasicCacheManager.php

Spacing +4 added lines, -4 removed lines

@@ -140,7 +140,7 @@ 
         // with these parameters
         $cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL);
         // then md5 the above to control it's length, add all of our prefixes, and truncate
-        return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
+        return substr($this->cachePrefix().$id_prefix.'-'.md5($cache_id), 0, 182);
     }
 
 
@@ -170,9 +170,9 @@ 
         return '
 <div class="ee-cached-content-notice" style="position:fixed; bottom:0; left: 0;">
     <p style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;margin:0 0 3px 5px">
-        <b>' . $type . '</b><span style="color:#999"> : </span>
-        <span>' . $cache_id . '</span>
-        <span style="margin-left:2em;">' . __FILE__ . '</span>
+        <b>' . $type.'</b><span style="color:#999"> : </span>
+        <span>' . $cache_id.'</span>
+        <span style="margin-left:2em;">' . __FILE__.'</span>
     </p>
 </div>';
     }

Indentation +130 added lines, -130 removed lines

@@ -16,135 +16,135 @@ 
 class BasicCacheManager implements CacheManagerInterface
 {
 
-    /**
-     * @type string
-     */
-    const CACHE_PREFIX = 'ee_cache_';
-
-
-    /**
-     * @var CacheStorageInterface $cache_storage
-     */
-    private $cache_storage;
-
-
-    /**
-     * BasicCacheManager constructor.
-     *
-     * @param CacheStorageInterface $cache_storage [required]
-     */
-    public function __construct(CacheStorageInterface $cache_storage)
-    {
-        $this->cache_storage = $cache_storage;
-    }
-
-
-    /**
-     * returns a string that will be prepended to all cache identifiers
-     *
-     * @return string
-     */
-    public function cachePrefix()
-    {
-        return BasicCacheManager::CACHE_PREFIX;
-    }
-
-
-    /**
-     * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
-     *                           May also be helpful to include an additional specific identifier,
-     *                           such as a post ID as part of the $id_prefix so that individual caches
-     *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
-     *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
-     * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
-     *                           It is advisable to use some of the actual data
-     *                           that is used to generate the content being cached,
-     *                           in order to guarantee that the cache id is unique for that content.
-     *                           The cache id will be md5'd before usage to make it more db friendly,
-     *                           and the entire cache id string will be truncated to 190 characters.
-     * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
-     *                           necessary,
-     *                           we wrap our content creation in a Closure so that it is not executed until needed.
-     * @param int     $expiration
-     * @return Closure|mixed
-     */
-    public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS)
-    {
-        $content = '';
-        $expiration = absint(
-            apply_filters(
-                'FHEE__CacheManager__get__cache_expiration',
-                $expiration,
-                $id_prefix,
-                $cache_id
-            )
-        );
-        $cache_id = $this->generateCacheIdentifier($id_prefix, $cache_id);
-        // is caching enabled for this content ?
-        if ($expiration) {
-            $content = $this->cache_storage->get($cache_id);
-        }
-        // any existing content ?
-        if (empty($content)) {
-            // nope! let's generate some new stuff
-            $content = $callback();
-            // save the new content if caching is enabled
-            if ($expiration) {
-                $this->cache_storage->add($cache_id, $content, $expiration);
-                if (EE_DEBUG) {
-                    $content .= $this->displayCacheNotice($cache_id, 'REFRESH CACHE');
-                }
-            }
-        } else {
-            if (EE_DEBUG) {
-                $content .= $this->displayCacheNotice($cache_id, 'CACHED CONTENT');
-            }
-        }
-        return $content;
-    }
-
-
-    /**
-     * Generates a unique identifier string for the cache
-     *
-     * @param string $id_prefix [required] see BasicCacheManager::get()
-     * @param string $cache_id  [required] see BasicCacheManager::get()
-     * @return string
-     */
-    private function generateCacheIdentifier($id_prefix, $cache_id)
-    {
-        // let's make the cached content unique for this "page"
-        $cache_id .= filter_input(INPUT_SERVER, 'REQUEST_URI', FILTER_SANITIZE_URL);
-        // with these parameters
-        $cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL);
-        // then md5 the above to control it's length, add all of our prefixes, and truncate
-        return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
-    }
-
-
-    /**
-     * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
-     *                               or a specific ID targeting a single cache item
-     * @return void
-     */
-    public function clear($cache_id)
-    {
-        // ensure incoming arg is in an array
-        $cache_id = is_array($cache_id) ? $cache_id : array($cache_id);
-        // delete corresponding transients for the supplied id prefix
-        $this->cache_storage->deleteMany($cache_id);
-    }
-
-
-    /**
-     * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
-     *                               or a specific ID targeting a single cache item
-     * @param string       $type
-     * @return string
-     */
-    private function displayCacheNotice($cache_id, $type)
-    {
-        return '
+	/**
+	 * @type string
+	 */
+	const CACHE_PREFIX = 'ee_cache_';
+
+
+	/**
+	 * @var CacheStorageInterface $cache_storage
+	 */
+	private $cache_storage;
+
+
+	/**
+	 * BasicCacheManager constructor.
+	 *
+	 * @param CacheStorageInterface $cache_storage [required]
+	 */
+	public function __construct(CacheStorageInterface $cache_storage)
+	{
+		$this->cache_storage = $cache_storage;
+	}
+
+
+	/**
+	 * returns a string that will be prepended to all cache identifiers
+	 *
+	 * @return string
+	 */
+	public function cachePrefix()
+	{
+		return BasicCacheManager::CACHE_PREFIX;
+	}
+
+
+	/**
+	 * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
+	 *                           May also be helpful to include an additional specific identifier,
+	 *                           such as a post ID as part of the $id_prefix so that individual caches
+	 *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
+	 *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
+	 * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
+	 *                           It is advisable to use some of the actual data
+	 *                           that is used to generate the content being cached,
+	 *                           in order to guarantee that the cache id is unique for that content.
+	 *                           The cache id will be md5'd before usage to make it more db friendly,
+	 *                           and the entire cache id string will be truncated to 190 characters.
+	 * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
+	 *                           necessary,
+	 *                           we wrap our content creation in a Closure so that it is not executed until needed.
+	 * @param int     $expiration
+	 * @return Closure|mixed
+	 */
+	public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS)
+	{
+		$content = '';
+		$expiration = absint(
+			apply_filters(
+				'FHEE__CacheManager__get__cache_expiration',
+				$expiration,
+				$id_prefix,
+				$cache_id
+			)
+		);
+		$cache_id = $this->generateCacheIdentifier($id_prefix, $cache_id);
+		// is caching enabled for this content ?
+		if ($expiration) {
+			$content = $this->cache_storage->get($cache_id);
+		}
+		// any existing content ?
+		if (empty($content)) {
+			// nope! let's generate some new stuff
+			$content = $callback();
+			// save the new content if caching is enabled
+			if ($expiration) {
+				$this->cache_storage->add($cache_id, $content, $expiration);
+				if (EE_DEBUG) {
+					$content .= $this->displayCacheNotice($cache_id, 'REFRESH CACHE');
+				}
+			}
+		} else {
+			if (EE_DEBUG) {
+				$content .= $this->displayCacheNotice($cache_id, 'CACHED CONTENT');
+			}
+		}
+		return $content;
+	}
+
+
+	/**
+	 * Generates a unique identifier string for the cache
+	 *
+	 * @param string $id_prefix [required] see BasicCacheManager::get()
+	 * @param string $cache_id  [required] see BasicCacheManager::get()
+	 * @return string
+	 */
+	private function generateCacheIdentifier($id_prefix, $cache_id)
+	{
+		// let's make the cached content unique for this "page"
+		$cache_id .= filter_input(INPUT_SERVER, 'REQUEST_URI', FILTER_SANITIZE_URL);
+		// with these parameters
+		$cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL);
+		// then md5 the above to control it's length, add all of our prefixes, and truncate
+		return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
+	}
+
+
+	/**
+	 * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
+	 *                               or a specific ID targeting a single cache item
+	 * @return void
+	 */
+	public function clear($cache_id)
+	{
+		// ensure incoming arg is in an array
+		$cache_id = is_array($cache_id) ? $cache_id : array($cache_id);
+		// delete corresponding transients for the supplied id prefix
+		$this->cache_storage->deleteMany($cache_id);
+	}
+
+
+	/**
+	 * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
+	 *                               or a specific ID targeting a single cache item
+	 * @param string       $type
+	 * @return string
+	 */
+	private function displayCacheNotice($cache_id, $type)
+	{
+		return '
 <div class="ee-cached-content-notice" style="position:fixed; bottom:0; left: 0;">
     <p style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;margin:0 0 3px 5px">
         <b>' . $type . '</b><span style="color:#999"> : </span>
@@ -152,5 +152,5 @@ 
         <span style="margin-left:2em;">' . __FILE__ . '</span>
     </p>
 </div>';
-    }
+	}
 }

acceptance_tests/Page/EventsAdmin.php

Doc Comments +1 added lines, -1 removed lines

@@ -120,7 +120,7 @@
 
     /**
      * Wrapper for getting the selector for a given field and given display row of a ticket in the event editor.
-     * @param     $field_name
+     * @param     string $field_name
      * @param int $row_number
      * @return string
      */

Indentation +276 added lines, -276 removed lines

@@ -14,280 +14,280 @@
 class EventsAdmin extends CoreAdmin
 {
 
-    /**
-     * Selector for the Add new Event button in the admin.
-     * @var string
-     */
-    const ADD_NEW_EVENT_BUTTON_SELECTOR = '#add-new-event';
-
-
-    /**
-     * Selector for the Event Title field in the event editor
-     * @var string
-     */
-    const EVENT_EDITOR_TITLE_FIELD_SELECTOR = ['xpath' => "//input[@id='title']"];
-
-    /**
-     * Selector for the publish submit button in the event editor.
-     * @var string
-     */
-    const EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR = ['xpath'=>"//div[@id='major-publishing-actions']//input[@id='publish']"];
-
-
-    /**
-     * Selector for the save button in the event editor
-     */
-    const EVENT_EDITOR_SAVE_BUTTON_SELECTOR = ['xpath' => "//div[@id='minor-publishing-actions']//input[@id='save-post']"];
-
-
-    /**
-     * @var string
-     */
-    const EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR = '#EVT_default_registration_status';
-
-    /**
-     * Selector for the view link after publishing an event.
-     * @var string
-     */
-    const EVENT_EDITOR_VIEW_LINK_AFTER_PUBLISH_SELECTOR = "//span[@id='sample-permalink']/a";
-
-
-    /**
-     * Selector for the ID of the event in the event editor
-     * @var string
-     */
-    const EVENT_EDITOR_EVT_ID_SELECTOR = "//input[@id='post_ID']";
-
-
-    /**
-     * Selector for the search input on the event list table page.
-     * @var string
-     */
-    const EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR = '#toplevel_page_espresso_events-search-input';
-
-
-
-
-    /**
-     * @param string $additional_params
-     * @return string
-     */
-    public static function defaultEventsListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_events', 'default', $additional_params);
-    }
-
-
-    /**
-     * The selector for the DTTname field for the given row in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorDatetimeNameFieldSelector($row_number = 1)
-    {
-        return self::eventEditorDatetimeFieldSelectorForField('DTT_name', $row_number);
-    }
-
-
-    /**
-     * The selector for the DTT_EVT_start field for the given row in the event editor.d
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorDatetimeStartDateFieldSelector($row_number = 1)
-    {
-        return self::eventEditorDatetimeFieldSelectorForField('DTT_EVT_start', $row_number);
-    }
-
-
-    /**
-     * Wrapper for getting the selector for a given field and given row of a datetime in the event editor.
-     *
-     * @param string $field_name
-     * @param int    $row_number
-     * @return string
-     */
-    public static function eventEditorDatetimeFieldSelectorForField($field_name, $row_number = 1)
-    {
-        return "//input[@id='event-datetime-$field_name-$row_number']";
-    }
-
-
-    /**
-     * The selector for the TKT_name field for the given display row in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketNameFieldSelector($row_number = 1)
-    {
-        return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_name', $row_number);
-    }
-
-
-    /**
-     * Selector for the TKT_base_price field for the given display row in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketPriceFieldSelector($row_number = 1)
-    {
-        return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_base_price', $row_number);
-    }
-
-
-    /**
-     * Selector for the TKT_qty field for the given display row in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketQuantityFieldSelector($row_number = 1)
-    {
-        return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_qty', $row_number);
-    }
-
-
-    /**
-     * Selector for the advanced details toggle for the ticket for the given display row in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketAdvancedDetailsSelector($row_number = 1)
-    {
-        return "//tr[@id='display-ticketrow-$row_number']//span[contains(@class, 'gear-icon')]";
-    }
-
-
-    /**
-     * Selector for the subtotal amount for the given display row of the ticket in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketAdvancedDetailsSubtotalSelector($row_number = 1)
-    {
-        return "//span[@id='price-total-amount-$row_number']";
-    }
-
-
-    /**
-     * Selector for the Total element for the given display row of the ticket in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketAdvancedDetailsTotalSelector($row_number = 1)
-    {
-        return "//span[@id='price-total-amount-$row_number']";
-    }
-
-
-    /**
-     * Selector for the taxable selector for the ticket for the given display row in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketTaxableCheckboxSelector($row_number = 1)
-    {
-        return "//input[@id='edit-ticket-TKT_taxable-$row_number']";
-    }
-
-
-    /**
-     * This returns the xpath locater for the Tax amount display container within the advanced settings view for the
-     * given ticket (row) and the given tax id (PRC_ID).
-     *
-     * @param int $tax_id     The PRC_ID for the tax you want the locater for.  Note, this defaults to the default tax
-     *                        setup on a fresh install.
-     * @param int $row_number What row representing the ticket you want the locator for.
-     * @return string
-     */
-    public static function eventEditorTicketTaxAmountDisplayForTaxIdAndTicketRowSelector($tax_id = 2, $row_number = 1)
-    {
-        return "//span[@id='TKT-tax-amount-display-$tax_id-$row_number']";
-    }
-
-
-    /**
-     * Wrapper for getting the selector for a given field and given display row of a ticket in the event editor.
-     * @param     $field_name
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketFieldSelectorForFieldInDisplayRow($field_name, $row_number = 1)
-    {
-        return "//tr[@id='display-ticketrow-$row_number']//input[contains(@class, 'edit-ticket-$field_name')]";
-    }
-
-
-    /**
-     * Returns the selector for the event title edit link in the events list table for the given Event Title.
-     * @param string $event_title
-     * @return string
-     */
-    public static function eventListTableEventTitleEditLinkSelectorForTitle($event_title)
-    {
-        return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']";
-    }
-
-
-    /**
-     * Locator for for the ID column in the event list table for a given event title.
-     * @param string $event_title
-     * @return string
-     */
-    public static function eventListTableEventIdSelectorForTitle($event_title)
-    {
-        return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"
-               . "//ancestor::tr/th[contains(@class, 'check-column')]/input";
-    }
-
-
-    /**
-     * Locator for the view link in the row of an event list table for the given event title.
-     * @param string $event_title
-     * @return string
-     */
-    public static function eventListTableEventTitleViewLinkSelectorForTitle($event_title)
-    {
-        return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"
-               . "//ancestor::td//span[@class='view']/a";
-    }
-
-
-    /**
-     * Locator for the messenger tab in the Notifications metabox in the event editor.
-     * @param string $messenger_slug  The slug for the messenger (it's reference slug).
-     * @return string
-     */
-    public static function eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug)
-    {
-        return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']"
-               . "//a[@rel='ee-tab-$messenger_slug']";
-    }
-
-
-    /**
-     * Locator for the select input within the notifications metabox.
-     * Note, this assumes the tab content for the related messenger is already visible.
-     * @param string $message_type_label The message type label (visible string in the table) you want the selector for.
-     * @return string
-     */
-    public static function eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label)
-    {
-        return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']"
-               . "//table[@class='messages-custom-template-switcher']"
-               . "//tr/td[contains(.,'Registration Approved')]"
-               . "//ancestor::tr//select[contains(@class,'message-template-selector')]";
-    }
-
-
-    /**
-     * Returns the selector for the action link to the registrations list table view filtered by the given event_id.
-     * Assumes one is in the context of the Events List Table
-     * @param int $event_id
-     * @return string
-     */
-    public static function listTableActionLinkRegistrationsForEvent($event_id)
-    {
-        return "//tbody[@id='the-list']/tr/td[contains(@class, 'column-id') and contains(.,$event_id)]"
-                . "//ancestor::tr/td//a[div[contains(@class, 'dashicons-groups')]]";
-    }
+	/**
+	 * Selector for the Add new Event button in the admin.
+	 * @var string
+	 */
+	const ADD_NEW_EVENT_BUTTON_SELECTOR = '#add-new-event';
+
+
+	/**
+	 * Selector for the Event Title field in the event editor
+	 * @var string
+	 */
+	const EVENT_EDITOR_TITLE_FIELD_SELECTOR = ['xpath' => "//input[@id='title']"];
+
+	/**
+	 * Selector for the publish submit button in the event editor.
+	 * @var string
+	 */
+	const EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR = ['xpath'=>"//div[@id='major-publishing-actions']//input[@id='publish']"];
+
+
+	/**
+	 * Selector for the save button in the event editor
+	 */
+	const EVENT_EDITOR_SAVE_BUTTON_SELECTOR = ['xpath' => "//div[@id='minor-publishing-actions']//input[@id='save-post']"];
+
+
+	/**
+	 * @var string
+	 */
+	const EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR = '#EVT_default_registration_status';
+
+	/**
+	 * Selector for the view link after publishing an event.
+	 * @var string
+	 */
+	const EVENT_EDITOR_VIEW_LINK_AFTER_PUBLISH_SELECTOR = "//span[@id='sample-permalink']/a";
+
+
+	/**
+	 * Selector for the ID of the event in the event editor
+	 * @var string
+	 */
+	const EVENT_EDITOR_EVT_ID_SELECTOR = "//input[@id='post_ID']";
+
+
+	/**
+	 * Selector for the search input on the event list table page.
+	 * @var string
+	 */
+	const EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR = '#toplevel_page_espresso_events-search-input';
+
+
+
+
+	/**
+	 * @param string $additional_params
+	 * @return string
+	 */
+	public static function defaultEventsListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_events', 'default', $additional_params);
+	}
+
+
+	/**
+	 * The selector for the DTTname field for the given row in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorDatetimeNameFieldSelector($row_number = 1)
+	{
+		return self::eventEditorDatetimeFieldSelectorForField('DTT_name', $row_number);
+	}
+
+
+	/**
+	 * The selector for the DTT_EVT_start field for the given row in the event editor.d
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorDatetimeStartDateFieldSelector($row_number = 1)
+	{
+		return self::eventEditorDatetimeFieldSelectorForField('DTT_EVT_start', $row_number);
+	}
+
+
+	/**
+	 * Wrapper for getting the selector for a given field and given row of a datetime in the event editor.
+	 *
+	 * @param string $field_name
+	 * @param int    $row_number
+	 * @return string
+	 */
+	public static function eventEditorDatetimeFieldSelectorForField($field_name, $row_number = 1)
+	{
+		return "//input[@id='event-datetime-$field_name-$row_number']";
+	}
+
+
+	/**
+	 * The selector for the TKT_name field for the given display row in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketNameFieldSelector($row_number = 1)
+	{
+		return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_name', $row_number);
+	}
+
+
+	/**
+	 * Selector for the TKT_base_price field for the given display row in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketPriceFieldSelector($row_number = 1)
+	{
+		return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_base_price', $row_number);
+	}
+
+
+	/**
+	 * Selector for the TKT_qty field for the given display row in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketQuantityFieldSelector($row_number = 1)
+	{
+		return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_qty', $row_number);
+	}
+
+
+	/**
+	 * Selector for the advanced details toggle for the ticket for the given display row in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketAdvancedDetailsSelector($row_number = 1)
+	{
+		return "//tr[@id='display-ticketrow-$row_number']//span[contains(@class, 'gear-icon')]";
+	}
+
+
+	/**
+	 * Selector for the subtotal amount for the given display row of the ticket in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketAdvancedDetailsSubtotalSelector($row_number = 1)
+	{
+		return "//span[@id='price-total-amount-$row_number']";
+	}
+
+
+	/**
+	 * Selector for the Total element for the given display row of the ticket in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketAdvancedDetailsTotalSelector($row_number = 1)
+	{
+		return "//span[@id='price-total-amount-$row_number']";
+	}
+
+
+	/**
+	 * Selector for the taxable selector for the ticket for the given display row in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketTaxableCheckboxSelector($row_number = 1)
+	{
+		return "//input[@id='edit-ticket-TKT_taxable-$row_number']";
+	}
+
+
+	/**
+	 * This returns the xpath locater for the Tax amount display container within the advanced settings view for the
+	 * given ticket (row) and the given tax id (PRC_ID).
+	 *
+	 * @param int $tax_id     The PRC_ID for the tax you want the locater for.  Note, this defaults to the default tax
+	 *                        setup on a fresh install.
+	 * @param int $row_number What row representing the ticket you want the locator for.
+	 * @return string
+	 */
+	public static function eventEditorTicketTaxAmountDisplayForTaxIdAndTicketRowSelector($tax_id = 2, $row_number = 1)
+	{
+		return "//span[@id='TKT-tax-amount-display-$tax_id-$row_number']";
+	}
+
+
+	/**
+	 * Wrapper for getting the selector for a given field and given display row of a ticket in the event editor.
+	 * @param     $field_name
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketFieldSelectorForFieldInDisplayRow($field_name, $row_number = 1)
+	{
+		return "//tr[@id='display-ticketrow-$row_number']//input[contains(@class, 'edit-ticket-$field_name')]";
+	}
+
+
+	/**
+	 * Returns the selector for the event title edit link in the events list table for the given Event Title.
+	 * @param string $event_title
+	 * @return string
+	 */
+	public static function eventListTableEventTitleEditLinkSelectorForTitle($event_title)
+	{
+		return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']";
+	}
+
+
+	/**
+	 * Locator for for the ID column in the event list table for a given event title.
+	 * @param string $event_title
+	 * @return string
+	 */
+	public static function eventListTableEventIdSelectorForTitle($event_title)
+	{
+		return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"
+			   . "//ancestor::tr/th[contains(@class, 'check-column')]/input";
+	}
+
+
+	/**
+	 * Locator for the view link in the row of an event list table for the given event title.
+	 * @param string $event_title
+	 * @return string
+	 */
+	public static function eventListTableEventTitleViewLinkSelectorForTitle($event_title)
+	{
+		return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"
+			   . "//ancestor::td//span[@class='view']/a";
+	}
+
+
+	/**
+	 * Locator for the messenger tab in the Notifications metabox in the event editor.
+	 * @param string $messenger_slug  The slug for the messenger (it's reference slug).
+	 * @return string
+	 */
+	public static function eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug)
+	{
+		return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']"
+			   . "//a[@rel='ee-tab-$messenger_slug']";
+	}
+
+
+	/**
+	 * Locator for the select input within the notifications metabox.
+	 * Note, this assumes the tab content for the related messenger is already visible.
+	 * @param string $message_type_label The message type label (visible string in the table) you want the selector for.
+	 * @return string
+	 */
+	public static function eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label)
+	{
+		return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']"
+			   . "//table[@class='messages-custom-template-switcher']"
+			   . "//tr/td[contains(.,'Registration Approved')]"
+			   . "//ancestor::tr//select[contains(@class,'message-template-selector')]";
+	}
+
+
+	/**
+	 * Returns the selector for the action link to the registrations list table view filtered by the given event_id.
+	 * Assumes one is in the context of the Events List Table
+	 * @param int $event_id
+	 * @return string
+	 */
+	public static function listTableActionLinkRegistrationsForEvent($event_id)
+	{
+		return "//tbody[@id='the-list']/tr/td[contains(@class, 'column-id') and contains(.,$event_id)]"
+				. "//ancestor::tr/td//a[div[contains(@class, 'dashicons-groups')]]";
+	}
 }

acceptance_tests/Page/CoreAdmin.php

Spacing +5 added lines, -5 removed lines

@@ -66,9 +66,9 @@ 
      */
     public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '')
     {
-        $url = self::URL_PREFIX . $page;
-        $url .= $action ? '&action=' . $action : '';
-        $url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : '';
+        $url = self::URL_PREFIX.$page;
+        $url .= $action ? '&action='.$action : '';
+        $url .= $additional_params ? '&'.ltrim('&', ltrim('?', $additional_params)) : '';
         return $url;
     }
 
@@ -80,7 +80,7 @@ 
      */
     public static function wpEditorTextTabSelector($field_reference)
     {
-        return '#content-' . $field_reference . '-content-html';
+        return '#content-'.$field_reference.'-content-html';
     }
 
 
@@ -91,6 +91,6 @@ 
      */
     public static function wpEditorTextAreaSelector($field_reference)
     {
-        return '#content-' . $field_reference . '-content';
+        return '#content-'.$field_reference.'-content';
     }
 }

Indentation +92 added lines, -92 removed lines

@@ -13,96 +13,96 @@
 class CoreAdmin
 {
 
-    /**
-     * @var string
-     */
-    const URL_PREFIX = 'admin.php?page=';
-
-
-    /**
-     * This is the selector for the next page button on list tables.
-     * @var string
-     */
-    const ADMIN_LIST_TABLE_NEXT_PAGE_CLASS = '.next-page';
-
-
-    /**
-     * The selector for the search input submit button on list table pages
-     * @var string
-     */
-    const LIST_TABLE_SEARCH_SUBMIT_SELECTOR = '#search-submit';
-
-
-    /**
-     * Selector for the screen options dropdown.
-     * @var string
-     */
-    const WP_SCREEN_SETTINGS_LINK_SELECTOR = '#show-settings-link';
-
-
-    /**
-     * Selector for the per page field setting selector (found within screen options dropdown)
-     * @var string
-     */
-    const WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR = '.screen-per-page';
-
-
-    /**
-     * Selector for apply screen options settings.
-     * @var string
-     */
-    const WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR = '#screen-options-apply';
-
-
-    /**
-     * Selector for bulk action select field on list tables.
-     */
-    const SELECTOR_LIST_TABLE_BULK_ACTION_FIELD = '#bulk-action-selector-';
-
-
-    /**
-     * Selector for applying a bulk action.
-     */
-    const SELECTOR_LIST_TABLE_BULK_ACTTION_APPLY = '#doaction';
-
-
-    /**
-     * Get the EE admin url for the given properties.
-     * Note, this is JUST the endpoint for the admin route.  It is expected that the actor/test would be calling this
-     * with `amOnAdminPage` action.
-     *
-     * @param string $page
-     * @param string $action
-     * @param string $additional_params
-     * @return string
-     */
-    public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '')
-    {
-        $url = self::URL_PREFIX . $page;
-        $url .= $action ? '&action=' . $action : '';
-        $url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : '';
-        return $url;
-    }
-
-
-    /**
-     * Returns the selector for the text tab switcher for a wp-editor instance.
-     * @param $field_reference
-     * @return string
-     */
-    public static function wpEditorTextTabSelector($field_reference)
-    {
-        return '#content-' . $field_reference . '-content-html';
-    }
-
-
-    /**
-     * Returns the selector for the textarea exposed when clicing the text tab switcher for a wp-editor instance.
-     * @param $field_reference
-     * @return string
-     */
-    public static function wpEditorTextAreaSelector($field_reference)
-    {
-        return '#content-' . $field_reference . '-content';
-    }
+	/**
+	 * @var string
+	 */
+	const URL_PREFIX = 'admin.php?page=';
+
+
+	/**
+	 * This is the selector for the next page button on list tables.
+	 * @var string
+	 */
+	const ADMIN_LIST_TABLE_NEXT_PAGE_CLASS = '.next-page';
+
+
+	/**
+	 * The selector for the search input submit button on list table pages
+	 * @var string
+	 */
+	const LIST_TABLE_SEARCH_SUBMIT_SELECTOR = '#search-submit';
+
+
+	/**
+	 * Selector for the screen options dropdown.
+	 * @var string
+	 */
+	const WP_SCREEN_SETTINGS_LINK_SELECTOR = '#show-settings-link';
+
+
+	/**
+	 * Selector for the per page field setting selector (found within screen options dropdown)
+	 * @var string
+	 */
+	const WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR = '.screen-per-page';
+
+
+	/**
+	 * Selector for apply screen options settings.
+	 * @var string
+	 */
+	const WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR = '#screen-options-apply';
+
+
+	/**
+	 * Selector for bulk action select field on list tables.
+	 */
+	const SELECTOR_LIST_TABLE_BULK_ACTION_FIELD = '#bulk-action-selector-';
+
+
+	/**
+	 * Selector for applying a bulk action.
+	 */
+	const SELECTOR_LIST_TABLE_BULK_ACTTION_APPLY = '#doaction';
+
+
+	/**
+	 * Get the EE admin url for the given properties.
+	 * Note, this is JUST the endpoint for the admin route.  It is expected that the actor/test would be calling this
+	 * with `amOnAdminPage` action.
+	 *
+	 * @param string $page
+	 * @param string $action
+	 * @param string $additional_params
+	 * @return string
+	 */
+	public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '')
+	{
+		$url = self::URL_PREFIX . $page;
+		$url .= $action ? '&action=' . $action : '';
+		$url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : '';
+		return $url;
+	}
+
+
+	/**
+	 * Returns the selector for the text tab switcher for a wp-editor instance.
+	 * @param $field_reference
+	 * @return string
+	 */
+	public static function wpEditorTextTabSelector($field_reference)
+	{
+		return '#content-' . $field_reference . '-content-html';
+	}
+
+
+	/**
+	 * Returns the selector for the textarea exposed when clicing the text tab switcher for a wp-editor instance.
+	 * @param $field_reference
+	 * @return string
+	 */
+	public static function wpEditorTextAreaSelector($field_reference)
+	{
+		return '#content-' . $field_reference . '-content';
+	}
 }