eventespresso / event-espresso-core

admin_pages/messages/help_tours/Messages_Settings_Help_Tour.class.php

Indentation +99 added lines, -99 removed lines

@@ -15,112 +15,112 @@
 class Messages_Settings_Help_Tour extends EE_Help_Tour
 {
 
-    protected function _set_tour_properties()
-    {
-        $this->_label = __('Messages Settings Tour', 'event_espresso');
-        $this->_slug = 'messages-settings-joyride';
-    }
+	protected function _set_tour_properties()
+	{
+		$this->_label = __('Messages Settings Tour', 'event_espresso');
+		$this->_slug = 'messages-settings-joyride';
+	}
 
 
-    protected function _set_tour_stops()
-    {
-        $this->_stops = array(
-            10 => array(
-                'content' => $this->_start(),
-            ),
-            20 => array(
-                'class'   => 'messenger_links',
-                'content' => $this->_messenger_links_stop(),
-                'options' => array(
-                    'tipLocation'    => 'bottom',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -25,
-                ),
-            ),
-            30 => array(
-                'id'      => 'espresso_email_settings',
-                'content' => $this->_email_settings_metabox_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 20,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            40 => array(
-                'id'      => 'on-off-email',
-                'content' => $this->_on_off_toggle_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentY' => -50,
-                    'tipAdjustmentX' => -15,
-                ),
-            ),
-            50 => array(
-                'id'      => 'active-message-types',
-                'content' => $this->_active_mts_container_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            60 => array(
-                'id'      => 'inactive-message-types',
-                'content' => $this->_inactive_mts_container_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentY' => -50,
-                    'tipAdjustmentX' => -15,
-                ),
-            ),
-        );
-    }
+	protected function _set_tour_stops()
+	{
+		$this->_stops = array(
+			10 => array(
+				'content' => $this->_start(),
+			),
+			20 => array(
+				'class'   => 'messenger_links',
+				'content' => $this->_messenger_links_stop(),
+				'options' => array(
+					'tipLocation'    => 'bottom',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -25,
+				),
+			),
+			30 => array(
+				'id'      => 'espresso_email_settings',
+				'content' => $this->_email_settings_metabox_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 20,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			40 => array(
+				'id'      => 'on-off-email',
+				'content' => $this->_on_off_toggle_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentY' => -50,
+					'tipAdjustmentX' => -15,
+				),
+			),
+			50 => array(
+				'id'      => 'active-message-types',
+				'content' => $this->_active_mts_container_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentY' => -30,
+				),
+			),
+			60 => array(
+				'id'      => 'inactive-message-types',
+				'content' => $this->_inactive_mts_container_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentY' => -50,
+					'tipAdjustmentX' => -15,
+				),
+			),
+		);
+	}
 
 
-    protected function _start()
-    {
-        $content = '<h3>' . __('Messages Settings', 'event_espresso') . '</h3>';
-        $content .= '<p>'
-                    . __(
-                        'This tour of the Messages Settings page will go over different areas of the screen to help you understand what they are used for.',
-                        'event_espresso'
-                    ) . '</p>';
-        return $content;
-    }
+	protected function _start()
+	{
+		$content = '<h3>' . __('Messages Settings', 'event_espresso') . '</h3>';
+		$content .= '<p>'
+					. __(
+						'This tour of the Messages Settings page will go over different areas of the screen to help you understand what they are used for.',
+						'event_espresso'
+					) . '</p>';
+		return $content;
+	}
 
-    protected function _messenger_links_stop()
-    {
-        return '<p>' . __('Available messengers are shown above.', 'event_espresso') . '</p>';
-    }
+	protected function _messenger_links_stop()
+	{
+		return '<p>' . __('Available messengers are shown above.', 'event_espresso') . '</p>';
+	}
 
-    protected function _email_settings_metabox_stop()
-    {
-        return '<p>' . __('View the different message types that are currently active.', 'event_espresso') . '</p>';
-    }
+	protected function _email_settings_metabox_stop()
+	{
+		return '<p>' . __('View the different message types that are currently active.', 'event_espresso') . '</p>';
+	}
 
-    protected function _on_off_toggle_stop()
-    {
-        return '<p>'
-               . __(
-                   'This toggle will turn all messages on or off for this message type.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _on_off_toggle_stop()
+	{
+		return '<p>'
+			   . __(
+				   'This toggle will turn all messages on or off for this message type.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _active_mts_container_stop()
-    {
-        return '<p>'
-               . __(
-                   'These are your active message types. Click them to see a description and settings for each one.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _active_mts_container_stop()
+	{
+		return '<p>'
+			   . __(
+				   'These are your active message types. Click them to see a description and settings for each one.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _inactive_mts_container_stop()
-    {
-        return '<p>'
-               . __(
-                   'Drag message types here to deactivate them. Drag them from here to the active box to reactivate them.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _inactive_mts_container_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Drag message types here to deactivate them. Drag them from here to the active box to reactivate them.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -78,23 +78,23 @@ 
 
     protected function _start()
     {
-        $content = '<h3>' . __('Messages Settings', 'event_espresso') . '</h3>';
+        $content = '<h3>'.__('Messages Settings', 'event_espresso').'</h3>';
         $content .= '<p>'
                     . __(
                         'This tour of the Messages Settings page will go over different areas of the screen to help you understand what they are used for.',
                         'event_espresso'
-                    ) . '</p>';
+                    ).'</p>';
         return $content;
     }
 
     protected function _messenger_links_stop()
     {
-        return '<p>' . __('Available messengers are shown above.', 'event_espresso') . '</p>';
+        return '<p>'.__('Available messengers are shown above.', 'event_espresso').'</p>';
     }
 
     protected function _email_settings_metabox_stop()
     {
-        return '<p>' . __('View the different message types that are currently active.', 'event_espresso') . '</p>';
+        return '<p>'.__('View the different message types that are currently active.', 'event_espresso').'</p>';
     }
 
     protected function _on_off_toggle_stop()
@@ -103,7 +103,7 @@ 
                . __(
                    'This toggle will turn all messages on or off for this message type.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _active_mts_container_stop()
@@ -112,7 +112,7 @@ 
                . __(
                    'These are your active message types. Click them to see a description and settings for each one.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _inactive_mts_container_stop()
@@ -121,6 +121,6 @@ 
                . __(
                    'Drag message types here to deactivate them. Drag them from here to the active box to reactivate them.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 }

admin_pages/messages/help_tours/Messages_Overview_Help_Tour.class.php

Indentation +117 added lines, -117 removed lines

@@ -15,131 +15,131 @@
 class Messages_Overview_Help_Tour extends EE_Help_Tour
 {
 
-    protected function _set_tour_properties()
-    {
-        $this->_label = __('Messages Overview Tour', 'event_espresso');
-        $this->_slug = 'messages-overview-joyride';
-    }
+	protected function _set_tour_properties()
+	{
+		$this->_label = __('Messages Overview Tour', 'event_espresso');
+		$this->_slug = 'messages-overview-joyride';
+	}
 
 
-    protected function _set_tour_stops()
-    {
-        $this->_stops = array(
-            10 => array(
-                'content' => $this->_start(),
-            ),
-            20 => array(
-                'id'      => 'event',
-                'content' => $this->event_column_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            30 => array(
-                'id'      => 'message_type',
-                'content' => $this->_message_type_column_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 20,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            40 => array(
-                'id'      => 'messenger',
-                'content' => $this->_messenger_column_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 5,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            50 => array(
-                'id'      => 'description',
-                'content' => $this->_description_column_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 5,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            60 => array(
-                'class'   => 'bulkactions',
-                'content' => $this->_bulk_actions_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 25,
-                    'tipAdjustmentY' => -35,
-                ),
-            ),
-            70 => array(
-                'id'      => 'ee_messenger_filter_by',
-                'content' => $this->_filters_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 25,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-        );
-    }
+	protected function _set_tour_stops()
+	{
+		$this->_stops = array(
+			10 => array(
+				'content' => $this->_start(),
+			),
+			20 => array(
+				'id'      => 'event',
+				'content' => $this->event_column_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			30 => array(
+				'id'      => 'message_type',
+				'content' => $this->_message_type_column_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 20,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			40 => array(
+				'id'      => 'messenger',
+				'content' => $this->_messenger_column_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 5,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			50 => array(
+				'id'      => 'description',
+				'content' => $this->_description_column_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 5,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			60 => array(
+				'class'   => 'bulkactions',
+				'content' => $this->_bulk_actions_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 25,
+					'tipAdjustmentY' => -35,
+				),
+			),
+			70 => array(
+				'id'      => 'ee_messenger_filter_by',
+				'content' => $this->_filters_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 25,
+					'tipAdjustmentY' => -30,
+				),
+			),
+		);
+	}
 
 
-    protected function _start()
-    {
-        $content = '<h3>' . __('Messages Overview', 'event_espresso') . '</h3>';
-        $content .= '<p>'
-                    . __(
-                        'This tour of the Messages Overview page will go over different areas of the screen to help you understand what they are used for.',
-                        'event_espresso'
-                    ) . '</p>';
-        return $content;
-    }
+	protected function _start()
+	{
+		$content = '<h3>' . __('Messages Overview', 'event_espresso') . '</h3>';
+		$content .= '<p>'
+					. __(
+						'This tour of the Messages Overview page will go over different areas of the screen to help you understand what they are used for.',
+						'event_espresso'
+					) . '</p>';
+		return $content;
+	}
 
-    protected function event_column_stop()
-    {
-        return '<p>'
-               . __(
-                   'View if a message is associated with one event or multiple events. Can be sorted in ascending and descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function event_column_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View if a message is associated with one event or multiple events. Can be sorted in ascending and descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _message_type_column_stop()
-    {
-        return '<p>'
-               . __(
-                   'View the type of message. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _message_type_column_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View the type of message. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _messenger_column_stop()
-    {
-        return '<p>'
-               . __(
-                   'View who messages will be sent to. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _messenger_column_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View who messages will be sent to. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _description_column_stop()
-    {
-        return '<p>' . __('View the description for each message type.', 'event_espresso') . '</p>';
-    }
+	protected function _description_column_stop()
+	{
+		return '<p>' . __('View the description for each message type.', 'event_espresso') . '</p>';
+	}
 
-    protected function _bulk_actions_stop()
-    {
-        return '<p>' . __('Perform bulk actions to multiple message types.', 'event_espresso') . '</p>';
-    }
+	protected function _bulk_actions_stop()
+	{
+		return '<p>' . __('Perform bulk actions to multiple message types.', 'event_espresso') . '</p>';
+	}
 
-    protected function _filters_stop()
-    {
-        return '<p>'
-               . __(
-                   'You can filter by different notifications by making a selection below and clicking on the filter button. To reset your selection, just click on the reset filters button.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _filters_stop()
+	{
+		return '<p>'
+			   . __(
+				   'You can filter by different notifications by making a selection below and clicking on the filter button. To reset your selection, just click on the reset filters button.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -88,12 +88,12 @@ 
 
     protected function _start()
     {
-        $content = '<h3>' . __('Messages Overview', 'event_espresso') . '</h3>';
+        $content = '<h3>'.__('Messages Overview', 'event_espresso').'</h3>';
         $content .= '<p>'
                     . __(
                         'This tour of the Messages Overview page will go over different areas of the screen to help you understand what they are used for.',
                         'event_espresso'
-                    ) . '</p>';
+                    ).'</p>';
         return $content;
     }
 
@@ -103,7 +103,7 @@ 
                . __(
                    'View if a message is associated with one event or multiple events. Can be sorted in ascending and descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _message_type_column_stop()
@@ -112,7 +112,7 @@ 
                . __(
                    'View the type of message. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _messenger_column_stop()
@@ -121,17 +121,17 @@ 
                . __(
                    'View who messages will be sent to. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _description_column_stop()
     {
-        return '<p>' . __('View the description for each message type.', 'event_espresso') . '</p>';
+        return '<p>'.__('View the description for each message type.', 'event_espresso').'</p>';
     }
 
     protected function _bulk_actions_stop()
     {
-        return '<p>' . __('Perform bulk actions to multiple message types.', 'event_espresso') . '</p>';
+        return '<p>'.__('Perform bulk actions to multiple message types.', 'event_espresso').'</p>';
     }
 
     protected function _filters_stop()
@@ -140,6 +140,6 @@ 
                . __(
                    'You can filter by different notifications by making a selection below and clicking on the filter button. To reset your selection, just click on the reset filters button.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 }

admin_pages/messages/EE_Message_List_Table.class.php

Indentation +430 added lines, -430 removed lines

@@ -12,434 +12,434 @@
 {
 
 
-    /**
-     * @return Messages_Admin_Page
-     */
-    public function get_admin_page()
-    {
-        return $this->_admin_page;
-    }
-
-
-    protected function _setup_data()
-    {
-        $this->_data = $this->_get_messages($this->_per_page, $this->_view);
-        $this->_all_data_count = $this->_get_messages($this->_per_page, $this->_view, true);
-    }
-
-
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => __('Message', 'event_espresso'),
-            'plural'   => __('Messages', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->get_admin_page()->get_current_screen()->id,
-        );
-
-        $this->_columns = array(
-            'cb'           => '<input type="checkbox" />',
-            'to'           => __('To', 'event_espresso'),
-            'from'         => __('From', 'event_espresso'),
-            'messenger'    => __('Messenger', 'event_espresso'),
-            'message_type' => __('Message Type', 'event_espresso'),
-            'context'      => __('Context', 'event_espresso'),
-            'modified'     => __('Modified', 'event_espresso'),
-            'action'       => __('Actions', 'event_espresso'),
-            'msg_id'       => __('ID', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            'modified'     => array('MSG_modified' => true),
-            'message_type' => array('MSG_message_type' => false),
-            'messenger'    => array('MSG_messenger' => false),
-            'to'           => array('MSG_to' => false),
-            'from'         => array('MSG_from' => false),
-            'context'      => array('MSG_context' => false),
-            'msg_id'       => array('MSG_ID', false),
-        );
-
-        $this->_primary_column = 'to';
-
-        $this->_hidden_columns = array(
-            'msg_id',
-        );
-    }
-
-
-    /**
-     * This simply sets up the row class for the table rows.
-     * Allows for easier overriding of child methods for setting up sorting.
-     *
-     * @param  object $item the current item
-     * @return string
-     */
-    protected function _get_row_class($item)
-    {
-        $class = parent::_get_row_class($item);
-        // add status class
-        $class .= ' ee-status-strip msg-status-' . $item->STS_ID();
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * _get_table_filters
-     * We use this to assemble and return any filters that are associated with this table that help further refine what
-     * get's shown in the table.
-     *
-     * @abstract
-     * @access protected
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_table_filters()
-    {
-        $filters = array();
-
-        // get select_inputs
-        $select_inputs = array(
-            $this->_get_messengers_dropdown_filter(),
-            $this->_get_message_types_dropdown_filter(),
-            $this->_get_contexts_for_message_types_dropdown_filter(),
-        );
-
-        // set filters to select inputs if they aren't empty
-        foreach ($select_inputs as $select_input) {
-            if ($select_input) {
-                $filters[] = $select_input;
-            }
-        }
-        return $filters;
-    }
-
-
-    protected function _add_view_counts()
-    {
-        foreach ($this->_views as $view => $args) {
-            $this->_views[ $view ]['count'] = $this->_get_messages($this->_per_page, $view, true, true);
-        }
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string   checkbox
-     * @throws \EE_Error
-     */
-    public function column_cb($message)
-    {
-        return sprintf('<input type="checkbox" name="MSG_ID[%s]" value="1" />', $message->ID());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_msg_id(EE_Message $message)
-    {
-        return $message->ID();
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string    The recipient of the message
-     * @throws \EE_Error
-     */
-    public function column_to(EE_Message $message)
-    {
-        EE_Registry::instance()->load_helper('URL');
-        $actions = array();
-        $actions['delete'] = '<a href="'
-                             . EEH_URL::add_query_args_and_nonce(
-                                 array(
-                                    'page'   => 'espresso_messages',
-                                    'action' => 'delete_ee_message',
-                                    'MSG_ID' => $message->ID(),
-                                 ),
-                                 admin_url('admin.php')
-                             )
-                             . '">' . __('Delete', 'event_espresso') . '</a>';
-        return esc_html($message->to()) . $this->row_actions($actions);
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string   The sender of the message
-     */
-    public function column_from(EE_Message $message)
-    {
-        return esc_html($message->from());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string  The messenger used to send the message.
-     */
-    public function column_messenger(EE_Message $message)
-    {
-        return ucwords($message->messenger_label());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string  The message type used to generate the message.
-     */
-    public function column_message_type(EE_Message $message)
-    {
-        return ucwords($message->message_type_label());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string  The context the message was generated for.
-     */
-    public function column_context(EE_Message $message)
-    {
-        return $message->context_label();
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string    The timestamp when this message was last modified.
-     */
-    public function column_modified(EE_Message $message)
-    {
-        return $message->modified();
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string   Actions that can be done on the current message.
-     */
-    public function column_action(EE_Message $message)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        $action_links = array(
-            'view'                => EEH_MSG_Template::get_message_action_link('view', $message),
-            'error'               => EEH_MSG_Template::get_message_action_link('error', $message),
-            'generate_now'        => EEH_MSG_Template::get_message_action_link('generate_now', $message),
-            'send_now'            => EEH_MSG_Template::get_message_action_link('send_now', $message),
-            'queue_for_resending' => EEH_MSG_Template::get_message_action_link('queue_for_resending', $message),
-            'view_transaction'    => EEH_MSG_Template::get_message_action_link('view_transaction', $message),
-        );
-        $content = '';
-        switch ($message->STS_ID()) {
-            case EEM_Message::status_sent:
-                $content = $action_links['view'] . $action_links['queue_for_resending'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_resend:
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_retry:
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['error'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_failed:
-            case EEM_Message::status_debug_only:
-                $content = $action_links['error'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_idle:
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_incomplete:
-                $content = $action_links['generate_now'] . $action_links['view_transaction'];
-                break;
-        }
-        return $content;
-    }
-
-
-    /**
-     * Retrieve the EE_Message objects for the list table.
-     *
-     * @param int    $perpage The number of items per page
-     * @param string $view    The view items are being retrieved for
-     * @param bool   $count   Whether to just return a count or not.
-     * @param bool   $all     Disregard any paging info (no limit on data returned).
-     * @return int|EE_Message[]
-     * @throws \EE_Error
-     */
-    protected function _get_messages($perpage = 10, $view = 'all', $count = false, $all = false)
-    {
-
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
-            ? $this->_req_data['paged']
-            : 1;
-
-        $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $perpage;
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit = $all || $count ? null : array($offset, $per_page);
-        $query_params = array(
-            'order_by' => empty($this->_req_data['orderby']) ? 'MSG_modified' : $this->_req_data['orderby'],
-            'order'    => empty($this->_req_data['order']) ? 'DESC' : $this->_req_data['order'],
-            'limit'    => $limit,
-        );
-
-        /**
-         * Any filters coming in from other routes?
-         */
-        if (isset($this->_req_data['filterby'])) {
-            $query_params = array_merge($query_params, EEM_Message::instance()->filter_by_query_params());
-            if (! $count) {
-                $query_params['group_by'] = 'MSG_ID';
-            }
-        }
-
-        // view conditionals
-        if ($view !== 'all' && $count && $all) {
-            $query_params[0]['AND*view_conditional'] = array(
-                'STS_ID' => strtoupper($view),
-            );
-        }
-
-        if (! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
-            $query_params[0]['AND*view_conditional'] = $this->_req_data === EEM_Message::status_failed
-                ? array(
-                    'STS_ID' => array(
-                        'IN',
-                        array(EEM_Message::status_failed, EEM_Message::status_messenger_executing),
-                    ),
-                )
-                : array('STS_ID' => strtoupper($this->_req_data['status']));
-        }
-
-        if (! $all && ! empty($this->_req_data['s'])) {
-            $search_string = '%' . $this->_req_data['s'] . '%';
-            $query_params[0]['OR'] = array(
-                'MSG_to'      => array('LIKE', $search_string),
-                'MSG_from'    => array('LIKE', $search_string),
-                'MSG_subject' => array('LIKE', $search_string),
-                'MSG_content' => array('LIKE', $search_string),
-            );
-        }
-
-        // account for debug only status.  We don't show Messages with the EEM_Message::status_debug_only to clients when
-        // the messages system is in debug mode.
-        // Note: for backward compat with previous iterations, this is necessary because there may be EEM_Message::status_debug_only
-        // messages in the database.
-        if (! EEM_Message::debug()) {
-            $query_params[0]['AND*debug_only_conditional'] = array(
-                'STS_ID' => array('!=', EEM_Message::status_debug_only),
-            );
-        }
-
-        // account for filters
-        if (! $all
-            && isset($this->_req_data['ee_messenger_filter_by'])
-            && $this->_req_data['ee_messenger_filter_by'] !== 'none_selected'
-        ) {
-            $query_params[0]['AND*messenger_filter'] = array(
-                'MSG_messenger' => $this->_req_data['ee_messenger_filter_by'],
-            );
-        }
-        if (! $all
-            && ! empty($this->_req_data['ee_message_type_filter_by'])
-            && $this->_req_data['ee_message_type_filter_by'] !== 'none_selected'
-        ) {
-            $query_params[0]['AND*message_type_filter'] = array(
-                'MSG_message_type' => $this->_req_data['ee_message_type_filter_by'],
-            );
-        }
-
-        if (! $all
-            && ! empty($this->_req_data['ee_context_filter_by'])
-            && $this->_req_data['ee_context_filter_by'] !== 'none_selected'
-        ) {
-            $query_params[0]['AND*context_filter'] = array(
-                'MSG_context' => array('IN', explode(',', $this->_req_data['ee_context_filter_by'])),
-            );
-        }
-
-        return $count
-            /** @type int */
-            ? EEM_Message::instance()->count($query_params, null, true)
-            /** @type EE_Message[] */
-            : EEM_Message::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for messengers.
-     *
-     * @return string
-     */
-    protected function _get_messengers_dropdown_filter()
-    {
-        $messenger_options = array();
-        $active_messages_grouped_by_messenger = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
-
-        // setup array of messenger options
-        foreach ($active_messages_grouped_by_messenger as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $messenger_options[ $active_message->messenger() ] = ucwords($active_message->messenger_label());
-            }
-        }
-        return $this->get_admin_page()->get_messengers_select_input($messenger_options);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for message types
-     *
-     * @return string
-     */
-    protected function _get_message_types_dropdown_filter()
-    {
-        $message_type_options = array();
-        $active_messages_grouped_by_message_type = EEM_Message::instance()->get_all(
-            array('group_by' => 'MSG_message_type')
-        );
-
-        // setup array of message type options
-        foreach ($active_messages_grouped_by_message_type as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $message_type_options[ $active_message->message_type() ] = ucwords(
-                    $active_message->message_type_label()
-                );
-            }
-        }
-        return $this->get_admin_page()->get_message_types_select_input($message_type_options);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for message type contexts
-     *
-     * @return string
-     */
-    protected function _get_contexts_for_message_types_dropdown_filter()
-    {
-        $context_options = array();
-        $active_messages_grouped_by_context = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
-
-        // setup array of context options
-        foreach ($active_messages_grouped_by_context as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $message_type = $active_message->message_type_object();
-                if ($message_type instanceof EE_message_type) {
-                    foreach ($message_type->get_contexts() as $context => $context_details) {
-                        if (isset($context_details['label'])) {
-                            $context_options[ $context ] = $context_details['label'];
-                        }
-                    }
-                }
-            }
-        }
-        return $this->get_admin_page()->get_contexts_for_message_types_select_input($context_options);
-    }
+	/**
+	 * @return Messages_Admin_Page
+	 */
+	public function get_admin_page()
+	{
+		return $this->_admin_page;
+	}
+
+
+	protected function _setup_data()
+	{
+		$this->_data = $this->_get_messages($this->_per_page, $this->_view);
+		$this->_all_data_count = $this->_get_messages($this->_per_page, $this->_view, true);
+	}
+
+
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => __('Message', 'event_espresso'),
+			'plural'   => __('Messages', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->get_admin_page()->get_current_screen()->id,
+		);
+
+		$this->_columns = array(
+			'cb'           => '<input type="checkbox" />',
+			'to'           => __('To', 'event_espresso'),
+			'from'         => __('From', 'event_espresso'),
+			'messenger'    => __('Messenger', 'event_espresso'),
+			'message_type' => __('Message Type', 'event_espresso'),
+			'context'      => __('Context', 'event_espresso'),
+			'modified'     => __('Modified', 'event_espresso'),
+			'action'       => __('Actions', 'event_espresso'),
+			'msg_id'       => __('ID', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			'modified'     => array('MSG_modified' => true),
+			'message_type' => array('MSG_message_type' => false),
+			'messenger'    => array('MSG_messenger' => false),
+			'to'           => array('MSG_to' => false),
+			'from'         => array('MSG_from' => false),
+			'context'      => array('MSG_context' => false),
+			'msg_id'       => array('MSG_ID', false),
+		);
+
+		$this->_primary_column = 'to';
+
+		$this->_hidden_columns = array(
+			'msg_id',
+		);
+	}
+
+
+	/**
+	 * This simply sets up the row class for the table rows.
+	 * Allows for easier overriding of child methods for setting up sorting.
+	 *
+	 * @param  object $item the current item
+	 * @return string
+	 */
+	protected function _get_row_class($item)
+	{
+		$class = parent::_get_row_class($item);
+		// add status class
+		$class .= ' ee-status-strip msg-status-' . $item->STS_ID();
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * _get_table_filters
+	 * We use this to assemble and return any filters that are associated with this table that help further refine what
+	 * get's shown in the table.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_table_filters()
+	{
+		$filters = array();
+
+		// get select_inputs
+		$select_inputs = array(
+			$this->_get_messengers_dropdown_filter(),
+			$this->_get_message_types_dropdown_filter(),
+			$this->_get_contexts_for_message_types_dropdown_filter(),
+		);
+
+		// set filters to select inputs if they aren't empty
+		foreach ($select_inputs as $select_input) {
+			if ($select_input) {
+				$filters[] = $select_input;
+			}
+		}
+		return $filters;
+	}
+
+
+	protected function _add_view_counts()
+	{
+		foreach ($this->_views as $view => $args) {
+			$this->_views[ $view ]['count'] = $this->_get_messages($this->_per_page, $view, true, true);
+		}
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string   checkbox
+	 * @throws \EE_Error
+	 */
+	public function column_cb($message)
+	{
+		return sprintf('<input type="checkbox" name="MSG_ID[%s]" value="1" />', $message->ID());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_msg_id(EE_Message $message)
+	{
+		return $message->ID();
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string    The recipient of the message
+	 * @throws \EE_Error
+	 */
+	public function column_to(EE_Message $message)
+	{
+		EE_Registry::instance()->load_helper('URL');
+		$actions = array();
+		$actions['delete'] = '<a href="'
+							 . EEH_URL::add_query_args_and_nonce(
+								 array(
+									'page'   => 'espresso_messages',
+									'action' => 'delete_ee_message',
+									'MSG_ID' => $message->ID(),
+								 ),
+								 admin_url('admin.php')
+							 )
+							 . '">' . __('Delete', 'event_espresso') . '</a>';
+		return esc_html($message->to()) . $this->row_actions($actions);
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string   The sender of the message
+	 */
+	public function column_from(EE_Message $message)
+	{
+		return esc_html($message->from());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string  The messenger used to send the message.
+	 */
+	public function column_messenger(EE_Message $message)
+	{
+		return ucwords($message->messenger_label());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string  The message type used to generate the message.
+	 */
+	public function column_message_type(EE_Message $message)
+	{
+		return ucwords($message->message_type_label());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string  The context the message was generated for.
+	 */
+	public function column_context(EE_Message $message)
+	{
+		return $message->context_label();
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string    The timestamp when this message was last modified.
+	 */
+	public function column_modified(EE_Message $message)
+	{
+		return $message->modified();
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string   Actions that can be done on the current message.
+	 */
+	public function column_action(EE_Message $message)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$action_links = array(
+			'view'                => EEH_MSG_Template::get_message_action_link('view', $message),
+			'error'               => EEH_MSG_Template::get_message_action_link('error', $message),
+			'generate_now'        => EEH_MSG_Template::get_message_action_link('generate_now', $message),
+			'send_now'            => EEH_MSG_Template::get_message_action_link('send_now', $message),
+			'queue_for_resending' => EEH_MSG_Template::get_message_action_link('queue_for_resending', $message),
+			'view_transaction'    => EEH_MSG_Template::get_message_action_link('view_transaction', $message),
+		);
+		$content = '';
+		switch ($message->STS_ID()) {
+			case EEM_Message::status_sent:
+				$content = $action_links['view'] . $action_links['queue_for_resending'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_resend:
+				$content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_retry:
+				$content = $action_links['view'] . $action_links['send_now'] . $action_links['error'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_failed:
+			case EEM_Message::status_debug_only:
+				$content = $action_links['error'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_idle:
+				$content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_incomplete:
+				$content = $action_links['generate_now'] . $action_links['view_transaction'];
+				break;
+		}
+		return $content;
+	}
+
+
+	/**
+	 * Retrieve the EE_Message objects for the list table.
+	 *
+	 * @param int    $perpage The number of items per page
+	 * @param string $view    The view items are being retrieved for
+	 * @param bool   $count   Whether to just return a count or not.
+	 * @param bool   $all     Disregard any paging info (no limit on data returned).
+	 * @return int|EE_Message[]
+	 * @throws \EE_Error
+	 */
+	protected function _get_messages($perpage = 10, $view = 'all', $count = false, $all = false)
+	{
+
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
+			? $this->_req_data['paged']
+			: 1;
+
+		$per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $perpage;
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit = $all || $count ? null : array($offset, $per_page);
+		$query_params = array(
+			'order_by' => empty($this->_req_data['orderby']) ? 'MSG_modified' : $this->_req_data['orderby'],
+			'order'    => empty($this->_req_data['order']) ? 'DESC' : $this->_req_data['order'],
+			'limit'    => $limit,
+		);
+
+		/**
+		 * Any filters coming in from other routes?
+		 */
+		if (isset($this->_req_data['filterby'])) {
+			$query_params = array_merge($query_params, EEM_Message::instance()->filter_by_query_params());
+			if (! $count) {
+				$query_params['group_by'] = 'MSG_ID';
+			}
+		}
+
+		// view conditionals
+		if ($view !== 'all' && $count && $all) {
+			$query_params[0]['AND*view_conditional'] = array(
+				'STS_ID' => strtoupper($view),
+			);
+		}
+
+		if (! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
+			$query_params[0]['AND*view_conditional'] = $this->_req_data === EEM_Message::status_failed
+				? array(
+					'STS_ID' => array(
+						'IN',
+						array(EEM_Message::status_failed, EEM_Message::status_messenger_executing),
+					),
+				)
+				: array('STS_ID' => strtoupper($this->_req_data['status']));
+		}
+
+		if (! $all && ! empty($this->_req_data['s'])) {
+			$search_string = '%' . $this->_req_data['s'] . '%';
+			$query_params[0]['OR'] = array(
+				'MSG_to'      => array('LIKE', $search_string),
+				'MSG_from'    => array('LIKE', $search_string),
+				'MSG_subject' => array('LIKE', $search_string),
+				'MSG_content' => array('LIKE', $search_string),
+			);
+		}
+
+		// account for debug only status.  We don't show Messages with the EEM_Message::status_debug_only to clients when
+		// the messages system is in debug mode.
+		// Note: for backward compat with previous iterations, this is necessary because there may be EEM_Message::status_debug_only
+		// messages in the database.
+		if (! EEM_Message::debug()) {
+			$query_params[0]['AND*debug_only_conditional'] = array(
+				'STS_ID' => array('!=', EEM_Message::status_debug_only),
+			);
+		}
+
+		// account for filters
+		if (! $all
+			&& isset($this->_req_data['ee_messenger_filter_by'])
+			&& $this->_req_data['ee_messenger_filter_by'] !== 'none_selected'
+		) {
+			$query_params[0]['AND*messenger_filter'] = array(
+				'MSG_messenger' => $this->_req_data['ee_messenger_filter_by'],
+			);
+		}
+		if (! $all
+			&& ! empty($this->_req_data['ee_message_type_filter_by'])
+			&& $this->_req_data['ee_message_type_filter_by'] !== 'none_selected'
+		) {
+			$query_params[0]['AND*message_type_filter'] = array(
+				'MSG_message_type' => $this->_req_data['ee_message_type_filter_by'],
+			);
+		}
+
+		if (! $all
+			&& ! empty($this->_req_data['ee_context_filter_by'])
+			&& $this->_req_data['ee_context_filter_by'] !== 'none_selected'
+		) {
+			$query_params[0]['AND*context_filter'] = array(
+				'MSG_context' => array('IN', explode(',', $this->_req_data['ee_context_filter_by'])),
+			);
+		}
+
+		return $count
+			/** @type int */
+			? EEM_Message::instance()->count($query_params, null, true)
+			/** @type EE_Message[] */
+			: EEM_Message::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for messengers.
+	 *
+	 * @return string
+	 */
+	protected function _get_messengers_dropdown_filter()
+	{
+		$messenger_options = array();
+		$active_messages_grouped_by_messenger = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
+
+		// setup array of messenger options
+		foreach ($active_messages_grouped_by_messenger as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$messenger_options[ $active_message->messenger() ] = ucwords($active_message->messenger_label());
+			}
+		}
+		return $this->get_admin_page()->get_messengers_select_input($messenger_options);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for message types
+	 *
+	 * @return string
+	 */
+	protected function _get_message_types_dropdown_filter()
+	{
+		$message_type_options = array();
+		$active_messages_grouped_by_message_type = EEM_Message::instance()->get_all(
+			array('group_by' => 'MSG_message_type')
+		);
+
+		// setup array of message type options
+		foreach ($active_messages_grouped_by_message_type as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$message_type_options[ $active_message->message_type() ] = ucwords(
+					$active_message->message_type_label()
+				);
+			}
+		}
+		return $this->get_admin_page()->get_message_types_select_input($message_type_options);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for message type contexts
+	 *
+	 * @return string
+	 */
+	protected function _get_contexts_for_message_types_dropdown_filter()
+	{
+		$context_options = array();
+		$active_messages_grouped_by_context = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
+
+		// setup array of context options
+		foreach ($active_messages_grouped_by_context as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$message_type = $active_message->message_type_object();
+				if ($message_type instanceof EE_message_type) {
+					foreach ($message_type->get_contexts() as $context => $context_details) {
+						if (isset($context_details['label'])) {
+							$context_options[ $context ] = $context_details['label'];
+						}
+					}
+				}
+			}
+		}
+		return $this->get_admin_page()->get_contexts_for_message_types_select_input($context_options);
+	}
 }

Spacing +21 added lines, -21 removed lines

@@ -78,7 +78,7 @@ 
     {
         $class = parent::_get_row_class($item);
         // add status class
-        $class .= ' ee-status-strip msg-status-' . $item->STS_ID();
+        $class .= ' ee-status-strip msg-status-'.$item->STS_ID();
         if ($this->_has_checkbox_column) {
             $class .= ' has-checkbox-column';
         }
@@ -120,7 +120,7 @@ 
     protected function _add_view_counts()
     {
         foreach ($this->_views as $view => $args) {
-            $this->_views[ $view ]['count'] = $this->_get_messages($this->_per_page, $view, true, true);
+            $this->_views[$view]['count'] = $this->_get_messages($this->_per_page, $view, true, true);
         }
     }
 
@@ -165,8 +165,8 @@ 
                                  ),
                                  admin_url('admin.php')
                              )
-                             . '">' . __('Delete', 'event_espresso') . '</a>';
-        return esc_html($message->to()) . $this->row_actions($actions);
+                             . '">'.__('Delete', 'event_espresso').'</a>';
+        return esc_html($message->to()).$this->row_actions($actions);
     }
 
 
@@ -238,23 +238,23 @@ 
         $content = '';
         switch ($message->STS_ID()) {
             case EEM_Message::status_sent:
-                $content = $action_links['view'] . $action_links['queue_for_resending'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['queue_for_resending'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_resend:
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['send_now'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_retry:
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['error'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['send_now'].$action_links['error'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_failed:
             case EEM_Message::status_debug_only:
-                $content = $action_links['error'] . $action_links['view_transaction'];
+                $content = $action_links['error'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_idle:
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['send_now'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_incomplete:
-                $content = $action_links['generate_now'] . $action_links['view_transaction'];
+                $content = $action_links['generate_now'].$action_links['view_transaction'];
                 break;
         }
         return $content;
@@ -295,7 +295,7 @@ 
          */
         if (isset($this->_req_data['filterby'])) {
             $query_params = array_merge($query_params, EEM_Message::instance()->filter_by_query_params());
-            if (! $count) {
+            if ( ! $count) {
                 $query_params['group_by'] = 'MSG_ID';
             }
         }
@@ -307,7 +307,7 @@ 
             );
         }
 
-        if (! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
+        if ( ! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
             $query_params[0]['AND*view_conditional'] = $this->_req_data === EEM_Message::status_failed
                 ? array(
                     'STS_ID' => array(
@@ -318,8 +318,8 @@ 
                 : array('STS_ID' => strtoupper($this->_req_data['status']));
         }
 
-        if (! $all && ! empty($this->_req_data['s'])) {
-            $search_string = '%' . $this->_req_data['s'] . '%';
+        if ( ! $all && ! empty($this->_req_data['s'])) {
+            $search_string = '%'.$this->_req_data['s'].'%';
             $query_params[0]['OR'] = array(
                 'MSG_to'      => array('LIKE', $search_string),
                 'MSG_from'    => array('LIKE', $search_string),
@@ -332,14 +332,14 @@ 
         // the messages system is in debug mode.
         // Note: for backward compat with previous iterations, this is necessary because there may be EEM_Message::status_debug_only
         // messages in the database.
-        if (! EEM_Message::debug()) {
+        if ( ! EEM_Message::debug()) {
             $query_params[0]['AND*debug_only_conditional'] = array(
                 'STS_ID' => array('!=', EEM_Message::status_debug_only),
             );
         }
 
         // account for filters
-        if (! $all
+        if ( ! $all
             && isset($this->_req_data['ee_messenger_filter_by'])
             && $this->_req_data['ee_messenger_filter_by'] !== 'none_selected'
         ) {
@@ -347,7 +347,7 @@ 
                 'MSG_messenger' => $this->_req_data['ee_messenger_filter_by'],
             );
         }
-        if (! $all
+        if ( ! $all
             && ! empty($this->_req_data['ee_message_type_filter_by'])
             && $this->_req_data['ee_message_type_filter_by'] !== 'none_selected'
         ) {
@@ -356,7 +356,7 @@ 
             );
         }
 
-        if (! $all
+        if ( ! $all
             && ! empty($this->_req_data['ee_context_filter_by'])
             && $this->_req_data['ee_context_filter_by'] !== 'none_selected'
         ) {
@@ -386,7 +386,7 @@ 
         // setup array of messenger options
         foreach ($active_messages_grouped_by_messenger as $active_message) {
             if ($active_message instanceof EE_Message) {
-                $messenger_options[ $active_message->messenger() ] = ucwords($active_message->messenger_label());
+                $messenger_options[$active_message->messenger()] = ucwords($active_message->messenger_label());
             }
         }
         return $this->get_admin_page()->get_messengers_select_input($messenger_options);
@@ -408,7 +408,7 @@ 
         // setup array of message type options
         foreach ($active_messages_grouped_by_message_type as $active_message) {
             if ($active_message instanceof EE_Message) {
-                $message_type_options[ $active_message->message_type() ] = ucwords(
+                $message_type_options[$active_message->message_type()] = ucwords(
                     $active_message->message_type_label()
                 );
             }
@@ -434,7 +434,7 @@ 
                 if ($message_type instanceof EE_message_type) {
                     foreach ($message_type->get_contexts() as $context => $context_details) {
                         if (isset($context_details['label'])) {
-                            $context_options[ $context ] = $context_details['label'];
+                            $context_options[$context] = $context_details['label'];
                         }
                     }
                 }

admin_pages/venues/Venues_Admin_Page.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -1006,7 +1006,7 @@
      * @access  private
      * @param  int    $VNU_ID
      * @param  string $venue_status
-     * @return void
+     * @return boolean
      */
     private function _change_venue_status($VNU_ID = 0, $venue_status = '')
     {

Indentation +1512 added lines, -1512 removed lines

@@ -17,1518 +17,1518 @@
 {
 
 
-    /**
-     * _venue
-     * This will hold the venue object for venue_details screen.
-     *
-     * @access protected
-     * @var object
-     */
-    protected $_venue;
-
-
-    /**
-     * This will hold the category object for category_details screen.
-     *
-     * @var object
-     */
-    protected $_category;
-
-
-    /**
-     * This property will hold the venue model instance
-     *
-     * @var object
-     */
-    protected $_venue_model;
-
-
-    protected function _init_page_props()
-    {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
-        $this->page_slug = EE_VENUES_PG_SLUG;
-        $this->_admin_base_url = EE_VENUES_ADMIN_URL;
-        $this->_admin_base_path = EE_ADMIN_PAGES . 'venues';
-        $this->page_label = __('Event Venues', 'event_espresso');
-        $this->_cpt_model_names = array(
-            'create_new' => 'EEM_Venue',
-            'edit'       => 'EEM_Venue',
-        );
-        $this->_cpt_edit_routes = array(
-            'espresso_venues' => 'edit',
-        );
-        $this->_venue_model = EEM_Venue::instance();
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        // todo: all hooks for ee_venues ajax goes in here.
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels = array(
-            'buttons'      => array(
-                'add'             => __('Add New Venue', 'event_espresso'),
-                'edit'            => __('Edit Venue', 'event_espresso'),
-                'delete'          => __('Delete Venue', 'event_espresso'),
-                'add_category'    => __('Add New Category', 'event_espresso'),
-                'edit_category'   => __('Edit Category', 'event_espresso'),
-                'delete_category' => __('Delete Category', 'event_espresso'),
-            ),
-            'editor_title' => array(
-                'espresso_venues' => __('Enter Venue name here', 'event_espresso'),
-            ),
-            'publishbox'   => array(
-                'create_new'          => __('Save New Venue', 'event_espresso'),
-                'edit'                => __('Update Venue', 'event_espresso'),
-                'add_category'        => __('Save New Category', 'event_espresso'),
-                'edit_category'       => __('Update Category', 'event_espresso'),
-                'google_map_settings' => __('Update Settings', 'event_espresso'),
-            ),
-        );
-    }
-
-
-    protected function _set_page_routes()
-    {
-
-        // load formatter helper
-        // load field generator helper
-
-        // is there a vnu_id in the request?
-        $vnu_id = ! empty($this->_req_data['VNU_ID']) && ! is_array($this->_req_data['VNU_ID'])
-            ? $this->_req_data['VNU_ID'] : 0;
-        $vnu_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $vnu_id;
-
-        $this->_page_routes = array(
-            'default'                    => array(
-                'func'       => '_overview_list_table',
-                'capability' => 'ee_read_venues',
-            ),
-            'create_new'                 => array(
-                'func'       => '_create_new_cpt_item',
-                'capability' => 'ee_edit_venues',
-            ),
-            'edit'                       => array(
-                'func'       => '_edit_cpt_item',
-                'capability' => 'ee_edit_venue',
-                'obj_id'     => $vnu_id,
-            ),
-            'trash_venue'                => array(
-                'func'       => '_trash_or_restore_venue',
-                'args'       => array('venue_status' => 'trash'),
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue',
-                'obj_id'     => $vnu_id,
-            ),
-            'trash_venues'               => array(
-                'func'       => '_trash_or_restore_venues',
-                'args'       => array('venue_status' => 'trash'),
-                'noheader'   => true,
-                'capability' => 'ee_delete_venues',
-            ),
-            'restore_venue'              => array(
-                'func'       => '_trash_or_restore_venue',
-                'args'       => array('venue_status' => 'draft'),
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue',
-                'obj_id'     => $vnu_id,
-            ),
-            'restore_venues'             => array(
-                'func'       => '_trash_or_restore_venues',
-                'args'       => array('venue_status' => 'draft'),
-                'noheader'   => true,
-                'capability' => 'ee_delete_venues',
-            ),
-            'delete_venues'              => array(
-                'func'       => '_delete_venues',
-                'noheader'   => true,
-                'capability' => 'ee_delete_venues',
-            ),
-            'delete_venue'               => array(
-                'func'       => '_delete_venue',
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue',
-                'obj_id'     => $vnu_id,
-            ),
-            // settings related
-            'google_map_settings'        => array(
-                'func'       => '_google_map_settings',
-                'capability' => 'manage_options',
-            ),
-            'update_google_map_settings' => array(
-                'func'       => '_update_google_map_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            // venue category tab related
-            'add_category'               => array(
-                'func'       => '_category_details',
-                'args'       => array('add'),
-                'capability' => 'ee_edit_venue_category',
-            ),
-            'edit_category'              => array(
-                'func'       => '_category_details',
-                'args'       => array('edit'),
-                'capability' => 'ee_edit_venue_category',
-            ),
-            'delete_categories'          => array(
-                'func'       => '_delete_categories',
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue_category',
-            ),
-
-            'delete_category' => array(
-                'func'       => '_delete_categories',
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue_category',
-            ),
-
-            'insert_category' => array(
-                'func'       => '_insert_or_update_category',
-                'args'       => array('new_category' => true),
-                'noheader'   => true,
-                'capability' => 'ee_edit_venue_category',
-            ),
-
-            'update_category'   => array(
-                'func'       => '_insert_or_update_category',
-                'args'       => array('new_category' => false),
-                'noheader'   => true,
-                'capability' => 'ee_edit_venue_category',
-            ),
-            'export_categories' => array(
-                'func'       => '_categories_export',
-                'noheader'   => true,
-                'capability' => 'export',
-            ),
-            'import_categories' => array(
-                'func'       => '_import_categories',
-                'capability' => 'import',
-            ),
-            'category_list'     => array(
-                'func'       => '_category_list_table',
-                'capability' => 'ee_manage_venue_categories',
-            ),
-        );
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'             => array(
-                'nav'           => array(
-                    'label' => __('Overview', 'event_espresso'),
-                    'order' => 10,
-                ),
-                'list_table'    => 'Venues_Admin_List_Table',
-                'help_tabs'     => array(
-                    'venues_overview_help_tab'                           => array(
-                        'title'    => __('Venues Overview', 'event_espresso'),
-                        'filename' => 'venues_overview',
-                    ),
-                    'venues_overview_table_column_headings_help_tab'     => array(
-                        'title'    => __('Venues Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'venues_overview_table_column_headings',
-                    ),
-                    'venues_overview_views_bulk_actions_search_help_tab' => array(
-                        'title'    => __('Venues Overview Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'venues_overview_views_bulk_actions_search',
-                    ),
-                ),
-                'help_tour'     => array('Venues_Overview_Help_Tour'),
-                'metaboxes'     => array('_espresso_news_post_box', '_espresso_links_post_box'),
-                'require_nonce' => false,
-            ),
-            'create_new'          => array(
-                'nav'           => array(
-                    'label'      => __('Add Venue', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ),
-                'help_tabs'     => array(
-                    'venues_editor_help_tab'                                               => array(
-                        'title'    => __('Venue Editor', 'event_espresso'),
-                        'filename' => 'venues_editor',
-                    ),
-                    'venues_editor_title_richtexteditor_help_tab'                          => array(
-                        'title'    => __('Venue Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'venues_editor_title_richtexteditor',
-                    ),
-                    'venues_editor_tags_categories_help_tab'                               => array(
-                        'title'    => __('Venue Tags & Categories', 'event_espresso'),
-                        'filename' => 'venues_editor_tags_categories',
-                    ),
-                    'venues_editor_physical_location_google_map_virtual_location_help_tab' => array(
-                        'title'    => __(
-                            'Venue Editor Physical Location & Google Map & Virtual Location',
-                            'event_espresso'
-                        ),
-                        'filename' => 'venues_editor_physical_location_google_map_virtual_location',
-                    ),
-                    'venues_editor_save_new_venue_help_tab'                                => array(
-                        'title'    => __('Save New Venue', 'event_espresso'),
-                        'filename' => 'venues_editor_save_new_venue',
-                    ),
-                    'venues_editor_other_help_tab'                                         => array(
-                        'title'    => __('Venue Editor Other', 'event_espresso'),
-                        'filename' => 'venues_editor_other',
-                    ),
-                ),
-                'help_tour'     => array('Venues_Add_Venue_Help_Tour'),
-                'metaboxes'     => array('_venue_editor_metaboxes'),
-                'require_nonce' => false,
-            ),
-            'edit'                => array(
-                'nav'           => array(
-                    'label'      => __('Edit Venue', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['post']) ? add_query_arg(
-                        array('post' => $this->_req_data['post']),
-                        $this->_current_page_view_url
-                    ) : $this->_admin_base_url,
-                ),
-                'help_tabs'     => array(
-                    'venues_editor_help_tab'                                               => array(
-                        'title'    => __('Venue Editor', 'event_espresso'),
-                        'filename' => 'venues_editor',
-                    ),
-                    'venues_editor_title_richtexteditor_help_tab'                          => array(
-                        'title'    => __('Venue Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'venues_editor_title_richtexteditor',
-                    ),
-                    'venues_editor_tags_categories_help_tab'                               => array(
-                        'title'    => __('Venue Tags & Categories', 'event_espresso'),
-                        'filename' => 'venues_editor_tags_categories',
-                    ),
-                    'venues_editor_physical_location_google_map_virtual_location_help_tab' => array(
-                        'title'    => __(
-                            'Venue Editor Physical Location & Google Map & Virtual Location',
-                            'event_espresso'
-                        ),
-                        'filename' => 'venues_editor_physical_location_google_map_virtual_location',
-                    ),
-                    'venues_editor_save_new_venue_help_tab'                                => array(
-                        'title'    => __('Save New Venue', 'event_espresso'),
-                        'filename' => 'venues_editor_save_new_venue',
-                    ),
-                    'venues_editor_other_help_tab'                                         => array(
-                        'title'    => __('Venue Editor Other', 'event_espresso'),
-                        'filename' => 'venues_editor_other',
-                    ),
-                ),
-                /*'help_tour' => array( 'Venues_Edit_Venue_Help_Tour' ),*/
-                'metaboxes'     => array('_venue_editor_metaboxes'),
-                'require_nonce' => false,
-            ),
-            'google_map_settings' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Google Maps', 'event_espresso'),
-                    'order' => 40,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'general_settings_google_maps_help_tab' => array(
-                        'title'    => __('Google Maps', 'event_espresso'),
-                        'filename' => 'general_settings_google_maps',
-                    ),
-                ),
-                'help_tour'     => array('Google_Maps_Help_Tour'),
-                'require_nonce' => false,
-            ),
-            // venue category stuff
-            'add_category'        => array(
-                'nav'           => array(
-                    'label'      => __('Add Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => array('_publish_post_box'),
-                'help_tabs'     => array(
-                    'venues_add_category_help_tab' => array(
-                        'title'    => __('Add New Venue Category', 'event_espresso'),
-                        'filename' => 'venues_add_category',
-                    ),
-                ),
-                'help_tour'     => array('Venues_Add_Category_Help_Tour'),
-                'require_nonce' => false,
-            ),
-            'edit_category'       => array(
-                'nav'           => array(
-                    'label'      => __('Edit Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['EVT_CAT_ID']) ? add_query_arg(
-                        array('EVT_CAT_ID' => $this->_req_data['EVT_CAT_ID']),
-                        $this->_current_page_view_url
-                    ) : $this->_admin_base_url,
-                ),
-                'metaboxes'     => array('_publish_post_box'),
-                'help_tabs'     => array(
-                    'venues_edit_category_help_tab' => array(
-                        'title'    => __('Edit Venue Category', 'event_espresso'),
-                        'filename' => 'venues_edit_category',
-                    ),
-                ),
-                /*'help_tour' => array( 'Venues_Edit_Category_Help_Tour' ),*/
-                'require_nonce' => false,
-            ),
-            'category_list'       => array(
-                'nav'           => array(
-                    'label' => __('Categories', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'list_table'    => 'Venue_Categories_Admin_List_Table',
-                'help_tabs'     => array(
-                    'venues_categories_help_tab'                       => array(
-                        'title'    => __('Venue Categories', 'event_espresso'),
-                        'filename' => 'venues_categories',
-                    ),
-                    'venues_categories_table_column_headings_help_tab' => array(
-                        'title'    => __('Venue Categories Table Column Headings', 'event_espresso'),
-                        'filename' => 'venues_categories_table_column_headings',
-                    ),
-                    'venues_categories_views_help_tab'                 => array(
-                        'title'    => __('Venue Categories Views', 'event_espresso'),
-                        'filename' => 'venues_categories_views',
-                    ),
-                    'venues_categories_other_help_tab'                 => array(
-                        'title'    => __('Venue Categories Other', 'event_espresso'),
-                        'filename' => 'venues_categories_other',
-                    ),
-                ),
-                'help_tour'     => array('Venues_Categories_Help_Tour'),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-    protected function _add_screen_options()
-    {
-        // todo
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    protected function _add_screen_options_category_list()
-    {
-        $page_title = $this->_admin_page_title;
-        $this->_admin_page_title = __('Venue Categories', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    // none of the below group are currently used for Event Venues
-    protected function _add_feature_pointers()
-    {
-    }
-
-    public function admin_init()
-    {
-    }
-
-    public function admin_notices()
-    {
-    }
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles_create_new()
-    {
-        $this->load_scripts_styles_edit();
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('ee-cat-admin');
-    }
-
-
-    public function load_scripts_styles_add_category()
-    {
-        $this->load_scripts_styles_edit_category();
-    }
-
-
-    public function load_scripts_styles_edit_category()
-    {
-    }
-
-
-    public function load_scripts_styles_edit()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'espresso_venues',
-            EE_VENUES_ASSETS_URL . 'ee-venues-admin.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_venues');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => __('View All Venues', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(),
-            ),
-        );
-
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_venues', 'espresso_venues_trash_venues')) {
-            $this->_views['all']['bulk_action'] = array(
-                'trash_venues' => __('Move to Trash', 'event_espresso'),
-            );
-            $this->_views['trash'] = array(
-                'slug'        => 'trash',
-                'label'       => __('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'restore_venues' => __('Restore from Trash', 'event_espresso'),
-                    'delete_venues'  => __('Delete', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-    protected function _set_list_table_views_category_list()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => __('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'delete_categories' => __('Delete Permanently', 'event_espresso'),
-                ),
-            ),
-        );
-    }
-
-
-    protected function _overview_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_template_args['after_list_table'] = EEH_Template::get_button_or_link(
-            get_post_type_archive_link('espresso_venues'),
-            __("View Venue Archive Page", "event_espresso"),
-            'button'
-        );
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button('create_new', 'add', array(), 'add-new-h2');
-        $this->_search_btn_label = __('Venues', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    public function extra_misc_actions_publish_box()
-    {
-        $extra_rows = array(
-            'vnu_capacity' => $this->_cpt_model_obj->get_f('VNU_capacity'),
-            'vnu_url'      => $this->_cpt_model_obj->get_f('VNU_url'),
-            'vnu_phone'    => $this->_cpt_model_obj->get_f('VNU_phone'),
-        );
-        $template = EE_VENUES_TEMPLATE_PATH . 'venue_publish_box_extras.template.php';
-        EEH_Template::display_template($template, $extra_rows);
-    }
-
-
-    /*************        Google Maps        *************/
-
-
-    protected function _google_map_settings()
-    {
-
-
-        $this->_template_args['values'] = $this->_yes_no_values;
-        $default_map_settings = new stdClass();
-        $default_map_settings->use_google_maps = true;
-        $default_map_settings->google_map_api_key = '';
-        // for event details pages (reg page)
-        $default_map_settings->event_details_map_width = 585;            // ee_map_width_single
-        $default_map_settings->event_details_map_height = 362;            // ee_map_height_single
-        $default_map_settings->event_details_map_zoom = 14;            // ee_map_zoom_single
-        $default_map_settings->event_details_display_nav = true;            // ee_map_nav_display_single
-        $default_map_settings->event_details_nav_size = false;            // ee_map_nav_size_single
-        $default_map_settings->event_details_control_type = 'default';        // ee_map_type_control_single
-        $default_map_settings->event_details_map_align = 'center';            // ee_map_align_single
-        // for event list pages
-        $default_map_settings->event_list_map_width = 300;            // ee_map_width
-        $default_map_settings->event_list_map_height = 185;        // ee_map_height
-        $default_map_settings->event_list_map_zoom = 12;            // ee_map_zoom
-        $default_map_settings->event_list_display_nav = false;        // ee_map_nav_display
-        $default_map_settings->event_list_nav_size = true;            // ee_map_nav_size
-        $default_map_settings->event_list_control_type = 'dropdown';        // ee_map_type_control
-        $default_map_settings->event_list_map_align = 'center';            // ee_map_align
-
-        $this->_template_args['map_settings'] =
-            isset(EE_Registry::instance()->CFG->map_settings)
-            && ! empty(EE_Registry::instance()->CFG->map_settings)
-                ? (object) array_merge(
-                    (array) $default_map_settings,
-                    (array) EE_Registry::instance()->CFG->map_settings
-                )
-                : $default_map_settings;
-
-        $this->_set_add_edit_form_tags('update_google_map_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_VENUES_TEMPLATE_PATH . 'google_map.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-    protected function _update_google_map_settings()
-    {
-
-        EE_Registry::instance()->CFG->map_settings->use_google_maps =
-            isset($this->_req_data['use_google_maps'])
-                ? absint($this->_req_data['use_google_maps'])
-                : EE_Registry::instance()->CFG->map_settings->use_google_maps;
-
-        EE_Registry::instance()->CFG->map_settings->google_map_api_key =
-            isset($this->_req_data['google_map_api_key'])
-                ? sanitize_text_field($this->_req_data['google_map_api_key'])
-                : EE_Registry::instance()->CFG->map_settings->google_map_api_key;
-
-        EE_Registry::instance()->CFG->map_settings->event_details_map_width =
-            isset($this->_req_data['event_details_map_width'])
-                ? absint($this->_req_data['event_details_map_width'])
-                : EE_Registry::instance()->CFG->map_settings->event_details_map_width;
-
-        EE_Registry::instance()->CFG->map_settings->event_details_map_height =
-            isset($this->_req_data['event_details_map_height'])
-                ? absint($this->_req_data['event_details_map_height'])
-                : EE_Registry::instance()->CFG->map_settings->event_details_map_height;
-
-        EE_Registry::instance()->CFG->map_settings->event_details_map_zoom =
-            isset($this->_req_data['event_details_map_zoom'])
-                ? absint($this->_req_data['event_details_map_zoom'])
-                : EE_Registry::instance()->CFG->map_settings->event_details_map_zoom;
-
-        EE_Registry::instance()->CFG->map_settings->event_details_display_nav =
-            isset($this->_req_data['event_details_display_nav'])
-                ? absint($this->_req_data['event_details_display_nav'])
-                : EE_Registry::instance()->CFG->map_settings->event_details_display_nav;
-
-        EE_Registry::instance()->CFG->map_settings->event_details_nav_size =
-            isset($this->_req_data['event_details_nav_size'])
-                ? absint($this->_req_data['event_details_nav_size'])
-                : EE_Registry::instance()->CFG->map_settings->event_details_nav_size;
-
-        EE_Registry::instance()->CFG->map_settings->event_details_control_type =
-            isset($this->_req_data['event_details_control_type'])
-                ? sanitize_text_field($this->_req_data['event_details_control_type'])
-                : EE_Registry::instance()->CFG->map_settings->event_details_control_type;
-
-        EE_Registry::instance()->CFG->map_settings->event_details_map_align =
-            isset($this->_req_data['event_details_map_align'])
-                ? sanitize_text_field($this->_req_data['event_details_map_align'])
-                : EE_Registry::instance()->CFG->map_settings->event_details_map_align;
-
-        EE_Registry::instance()->CFG->map_settings->event_list_map_width =
-            isset($this->_req_data['event_list_map_width'])
-                ? absint($this->_req_data['event_list_map_width'])
-                : EE_Registry::instance()->CFG->map_settings->event_list_map_width;
-
-        EE_Registry::instance()->CFG->map_settings->event_list_map_height =
-            isset($this->_req_data['event_list_map_height'])
-                ? absint($this->_req_data['event_list_map_height'])
-                : EE_Registry::instance()->CFG->map_settings->event_list_map_height;
-
-        EE_Registry::instance()->CFG->map_settings->event_list_map_zoom =
-            isset($this->_req_data['event_list_map_zoom'])
-                ? absint($this->_req_data['event_list_map_zoom'])
-                : EE_Registry::instance()->CFG->map_settings->event_list_map_zoom;
-
-        EE_Registry::instance()->CFG->map_settings->event_list_display_nav =
-            isset($this->_req_data['event_list_display_nav'])
-                ? absint($this->_req_data['event_list_display_nav'])
-                : EE_Registry::instance()->CFG->map_settings->event_list_display_nav;
-
-        EE_Registry::instance()->CFG->map_settings->event_list_nav_size =
-            isset($this->_req_data['event_list_nav_size'])
-                ? absint($this->_req_data['event_list_nav_size'])
-                : EE_Registry::instance()->CFG->map_settings->event_list_nav_size;
-
-        EE_Registry::instance()->CFG->map_settings->event_list_control_type =
-            isset($this->_req_data['event_list_control_type'])
-                ? sanitize_text_field($this->_req_data['event_list_control_type'])
-                : EE_Registry::instance()->CFG->map_settings->event_list_control_type;
-
-        EE_Registry::instance()->CFG->map_settings->event_list_map_align =
-            isset($this->_req_data['event_list_map_align'])
-                ? sanitize_text_field($this->_req_data['event_list_map_align'])
-                : EE_Registry::instance()->CFG->map_settings->event_list_map_align;
-
-        EE_Registry::instance()->CFG->map_settings = apply_filters(
-            'FHEE__Extend_General_Settings_Admin_Page___update_google_map_settings__CFG_map_settings',
-            EE_Registry::instance()->CFG->map_settings
-        );
-
-        $what = 'Google Map Settings';
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG->map_settings,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        $this->_redirect_after_action($success, $what, 'updated', array('action' => 'google_map_settings'));
-    }
-
-
-    protected function _venue_editor_metaboxes()
-    {
-        $this->verify_cpt_object();
-
-        add_meta_box(
-            'espresso_venue_address_options',
-            __('Physical Location', 'event_espresso'),
-            array($this, 'venue_address_metabox'),
-            $this->page_slug,
-            'side',
-            'default'
-        );
-        add_meta_box(
-            'espresso_venue_gmap_options',
-            __('Google Map', 'event_espresso'),
-            array($this, 'venue_gmap_metabox'),
-            $this->page_slug,
-            'side',
-            'default'
-        );
-        add_meta_box(
-            'espresso_venue_virtual_loc_options',
-            __('Virtual Location', 'event_espresso'),
-            array($this, 'venue_virtual_loc_metabox'),
-            $this->page_slug,
-            'side',
-            'default'
-        );
-    }
-
-
-    public function venue_gmap_metabox()
-    {
-        $template_args = array(
-            'vnu_enable_for_gmap' => EEH_Form_Fields::select_input(
-                'vnu_enable_for_gmap',
-                $this->get_yes_no_values(),
-                $this->_cpt_model_obj->enable_for_gmap()
-            ),
-            'vnu_google_map_link' => $this->_cpt_model_obj->google_map_link(),
-        );
-        $template = EE_VENUES_TEMPLATE_PATH . 'venue_gmap_metabox_content.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    public function venue_address_metabox()
-    {
-
-        $template_args['_venue'] = $this->_cpt_model_obj;
-
-        $template_args['states_dropdown'] = EEH_Form_Fields::generate_form_input(
-            $QFI = new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    array('QST_display_text' => esc_html__('State', 'event_espresso'), 'QST_system' => 'state')
-                ),
-                EE_Answer::new_instance(array('ANS_value' => $this->_cpt_model_obj->state_ID())),
-                array(
-                    'input_name'     => 'sta_id',
-                    'input_id'       => 'sta_id',
-                    'input_class'    => '',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                )
-            )
-        );
-        $template_args['countries_dropdown'] = EEH_Form_Fields::generate_form_input(
-            $QFI = new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    array('QST_display_text' => esc_html__('Country', 'event_espresso'), 'QST_system' => 'country')
-                ),
-                EE_Answer::new_instance(array('ANS_value' => $this->_cpt_model_obj->country_ID())),
-                array(
-                    'input_name'     => 'cnt_iso',
-                    'input_id'       => 'cnt_iso',
-                    'input_class'    => '',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                )
-            )
-        );
-
-        $template = EE_VENUES_TEMPLATE_PATH . 'venue_address_metabox_content.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    public function venue_virtual_loc_metabox()
-    {
-        $template_args = array(
-            '_venue' => $this->_cpt_model_obj,
-        );
-        $template = EE_VENUES_TEMPLATE_PATH . 'venue_virtual_location_metabox_content.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-        $venue_obj = $this->_venue_model->get_one_by_ID($post_id);
-
-        // meta revision restore
-        $venue_obj->restore_revision($revision_id);
-    }
-
-
-    /**
-     * Handles updates for venue cpts
-     *
-     * @param  int    $post_id ID of Venue CPT
-     * @param  object $post    Post object (with "blessed" WP properties)
-     * @return void
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-
-        if ($post instanceof WP_Post && $post->post_type !== 'espresso_venues') {
-            return;// get out we're not processing the saving of venues.
-        }
-
-        $wheres = array($this->_venue_model->primary_key_name() => $post_id);
-
-        $venue_values = array(
-            'VNU_address'         => ! empty($this->_req_data['vnu_address']) ? $this->_req_data['vnu_address'] : null,
-            'VNU_address2'        => ! empty($this->_req_data['vnu_address2']) ? $this->_req_data['vnu_address2']
-                : null,
-            'VNU_city'            => ! empty($this->_req_data['vnu_city']) ? $this->_req_data['vnu_city'] : null,
-            'STA_ID'              => ! empty($this->_req_data['sta_id']) ? $this->_req_data['sta_id'] : null,
-            'CNT_ISO'             => ! empty($this->_req_data['cnt_iso']) ? $this->_req_data['cnt_iso'] : null,
-            'VNU_zip'             => ! empty($this->_req_data['vnu_zip']) ? $this->_req_data['vnu_zip'] : null,
-            'VNU_phone'           => ! empty($this->_req_data['vnu_phone']) ? $this->_req_data['vnu_phone'] : null,
-            'VNU_capacity'        => ! empty($this->_req_data['vnu_capacity']) ? str_replace(
-                ',',
-                '',
-                $this->_req_data['vnu_capacity']
-            ) : EE_INF,
-            'VNU_url'             => ! empty($this->_req_data['vnu_url']) ? $this->_req_data['vnu_url'] : null,
-            'VNU_virtual_phone'   => ! empty($this->_req_data['vnu_virtual_phone'])
-                ? $this->_req_data['vnu_virtual_phone'] : null,
-            'VNU_virtual_url'     => ! empty($this->_req_data['vnu_virtual_url']) ? $this->_req_data['vnu_virtual_url']
-                : null,
-            'VNU_enable_for_gmap' => ! empty($this->_req_data['vnu_enable_for_gmap']) ? true : false,
-            'VNU_google_map_link' => ! empty($this->_req_data['vnu_google_map_link'])
-                ? $this->_req_data['vnu_google_map_link'] : null,
-        );
-
-        // update venue
-        $success = $this->_venue_model->update($venue_values, array($wheres));
-
-        // get venue_object for other metaboxes that might be added via the filter... though it would seem to make sense to just use $this->_venue_model->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
-        $get_one_where = array($this->_venue_model->primary_key_name() => $post_id, 'status' => $post->post_status);
-        $venue = $this->_venue_model->get_one(array($get_one_where));
-
-        // notice we've applied a filter for venue metabox callbacks but we don't actually have any default venue metaboxes in use.  So this is just here for addons to more easily hook into venue saves.
-        $venue_update_callbacks = apply_filters(
-            'FHEE__Venues_Admin_Page___insert_update_cpt_item__venue_update_callbacks',
-            array()
-        );
-
-        $att_success = true;
-
-        foreach ($venue_update_callbacks as $v_callback) {
-            $_succ = call_user_func_array($v_callback, array($venue, $this->_req_data));
-            $att_success = ! $att_success ? $att_success
-                : $_succ; // if ANY of these updates fail then we want the appropriate global error message
-        }
-
-        // any errors?
-        if ($success && ! $att_success) {
-            EE_Error::add_error(
-                __(
-                    'Venue Details saved successfully but something went wrong with saving attachments.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } elseif ($success === false) {
-            EE_Error::add_error(
-                __('Venue Details did not save successfully.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    public function trash_cpt_item($post_id)
-    {
-        $this->_req_data['VNU_ID'] = $post_id;
-        $this->_trash_or_restore_venue('trash', false);
-    }
-
-
-    public function restore_cpt_item($post_id)
-    {
-        $this->_req_data['VNU_ID'] = $post_id;
-        $this->_trash_or_restore_venue('draft', false);
-    }
-
-
-    public function delete_cpt_item($post_id)
-    {
-        $this->_req_data['VNU_ID'] = $post_id;
-        $this->_delete_venue(false);
-    }
-
-
-    public function get_venue_object()
-    {
-        return $this->_cpt_model_obj;
-    }
-
-
-    protected function _trash_or_restore_venue($venue_status = 'trash', $redirect_after = true)
-    {
-        $VNU_ID = isset($this->_req_data['VNU_ID']) ? absint($this->_req_data['VNU_ID']) : false;
-
-        // loop thru venues
-        if ($VNU_ID) {
-            // clean status
-            $venue_status = sanitize_key($venue_status);
-            // grab status
-            if (! empty($venue_status)) {
-                $success = $this->_change_venue_status($VNU_ID, $venue_status);
-            } else {
-                $success = false;
-                $msg = __(
-                    'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        } else {
-            $success = false;
-            $msg = __(
-                'An error occurred. The venue could not be moved to the trash because a valid venue ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        $action = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Venue', $action, array('action' => 'default'));
-        }
-    }
-
-
-    protected function _trash_or_restore_venues($venue_status = 'trash')
-    {
-        // clean status
-        $venue_status = sanitize_key($venue_status);
-        // grab status
-        if (! empty($venue_status)) {
-            $success = true;
-            // determine the event id and set to array.
-            $VNU_IDs = isset($this->_req_data['venue_id']) ? (array) $this->_req_data['venue_id'] : array();
-            // loop thru events
-            foreach ($VNU_IDs as $VNU_ID) {
-                if ($VNU_ID = absint($VNU_ID)) {
-                    $results = $this->_change_venue_status($VNU_ID, $venue_status);
-                    $success = $results !== false ? $success : false;
-                } else {
-                    $msg = sprintf(
-                        __(
-                            'An error occurred. Venue #%d could not be moved to the trash because a valid venue ID was not not supplied.',
-                            'event_espresso'
-                        ),
-                        $VNU_ID
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                    $success = false;
-                }
-            }
-        } else {
-            $success = false;
-            $msg = __(
-                'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $action = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-        $this->_redirect_after_action($success, 'Venues', $action, array('action' => 'default'));
-    }
-
-
-    /**
-     * _trash_or_restore_venues
-     *
-     * //todo this is pretty much the same as the corresponding change_event_status method in Events_Admin_Page.  We
-     * should probably abstract this up to the EE_Admin_Page_CPT (or even EE_Admin_Page) and make this a common method
-     * accepting a certain number of params.
-     *
-     * @access  private
-     * @param  int    $VNU_ID
-     * @param  string $venue_status
-     * @return void
-     */
-    private function _change_venue_status($VNU_ID = 0, $venue_status = '')
-    {
-        // grab venue id
-        if (! $VNU_ID) {
-            $msg = __('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        $this->_cpt_model_obj = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-
-        // clean status
-        $venue_status = sanitize_key($venue_status);
-        // grab status
-        if (! $venue_status) {
-            $msg = __('An error occurred. No Venue Status or an invalid Venue Status was received.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        // was event trashed or restored ?
-        switch ($venue_status) {
-            case 'draft':
-                $action = 'restored from the trash';
-                $hook = 'AHEE_venue_restored_from_trash';
-                break;
-            case 'trash':
-                $action = 'moved to the trash';
-                $hook = 'AHEE_venue_moved_to_trash';
-                break;
-            default:
-                $action = 'updated';
-                $hook = false;
-        }
-        // use class to change status
-        $this->_cpt_model_obj->set_status($venue_status);
-        $success = $this->_cpt_model_obj->save();
-
-        if ($success === false) {
-            $msg = sprintf(__('An error occurred. The venue could not be %s.', 'event_espresso'), $action);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if ($hook) {
-            do_action($hook);
-        }
-        return true;
-    }
-
-
-    /**
-     * @param  bool $redirect_after
-     * @return void
-     */
-    protected function _delete_venue($redirect_after = true)
-    {
-        // determine the venue id and set to array.
-        $VNU_ID = isset($this->_req_data['VNU_ID']) ? absint($this->_req_data['VNU_ID']) : null;
-        $VNU_ID = isset($this->_req_data['post']) ? absint($this->_req_data['post']) : $VNU_ID;
-
-
-        // loop thru venues
-        if ($VNU_ID) {
-            $success = $this->_delete_or_trash_venue($VNU_ID);
-        } else {
-            $success = false;
-            $msg = __(
-                'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Venue', 'deleted', array('action' => 'default'));
-        }
-    }
-
-
-    protected function _delete_venues()
-    {
-        $success = true;
-        // determine the event id and set to array.
-        $VNU_IDs = isset($this->_req_data['venue_id']) ? (array) $this->_req_data['venue_id'] : array();
-        // loop thru events
-        foreach ($VNU_IDs as $VNU_ID) {
-            if ($VNU_ID = absint($VNU_ID)) {
-                $results = $this->_delete_or_trash_venue($VNU_ID);
-                $success = $results !== false ? $success : false;
-            } else {
-                $success = false;
-                $msg = __(
-                    'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $this->_redirect_after_action(
-            $success,
-            __('Venues', 'event_espresso'),
-            __('deleted', 'event_espresso'),
-            array('action' => 'default')
-        );
-    }
-
-
-    // todo: put in parent
-    private function _delete_or_trash_venue($VNU_ID = false)
-    {
-        // grab event id
-        if (! $VNU_ID = absint($VNU_ID)) {
-            $msg = __('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-
-        $venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-        // first need to remove all term relationships
-        $venue->_remove_relations('Term_Taxonomy');
-        $success = $venue->delete_permanently();
-        // did it all go as planned ?
-        if ($success) {
-            $msg = sprintf(__('Venue ID # %d has been deleted.', 'event_espresso'), $VNU_ID);
-            EE_Error::add_success($msg);
-        } else {
-            $msg = sprintf(__('An error occurred. Venue ID # %d could not be deleted.', 'event_espresso'), $VNU_ID);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        do_action('AHEE__Venues_Admin_Page___delete_or_trash_venue__after_venue_deleted');
-        return true;
-    }
-
-
-
-
-    /***********/
-    /* QUERIES */
-
-
-    public function get_venues($per_page = 10, $count = false)
-    {
-
-        $_orderby = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
-
-        switch ($_orderby) {
-            case 'id':
-                $orderby = 'VNU_ID';
-                break;
-
-            case 'capacity':
-                $orderby = 'VNU_capacity';
-                break;
-
-            case 'city':
-                $orderby = 'VNU_city';
-                break;
-
-            default:
-                $orderby = 'VNU_name';
-        }
-
-
-        $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
-            : 'ASC';
-
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
-            ? $this->_req_data['paged'] : 1;
-        $per_page = isset($per_page) && ! empty($per_page) ? $per_page : 10;
-        $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage'] : $per_page;
-
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit = array($offset, $per_page);
-
-        $category = isset($this->_req_data['category']) && $this->_req_data['category'] > 0
-            ? $this->_req_data['category'] : null;
-        $where = array();
-
-        // only set initial status if it is in the incoming request.  Otherwise the "all" view display's all statuses.
-        if (isset($this->_req_data['status']) && $this->_req_data['status'] != 'all') {
-            $where['status'] = $this->_req_data['status'];
-        }
-
-        if (isset($this->_req_data['venue_status'])) {
-            $where['status'] = $this->_req_data['venue_status'];
-        }
-
-
-        if ($category) {
-            $where['Term_Taxonomy.taxonomy'] = 'espresso_venue_categories';
-            $where['Term_Taxonomy.term_id'] = $category;
-        }
-
-
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_venues', 'get_venues')) {
-            $where['VNU_wp_user'] = get_current_user_id();
-        } else {
-            if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')) {
-                $where['OR'] = array(
-                    'status*restrict_private' => array('!=', 'private'),
-                    'AND'                     => array(
-                        'status*inclusive' => array('=', 'private'),
-                        'VNU_wp_user'      => get_current_user_id(),
-                    ),
-                );
-            }
-        }
-
-
-        if (isset($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
-            $where['OR'] = array(
-                'VNU_name'               => array('LIKE', $sstr),
-                'VNU_desc'               => array('LIKE', $sstr),
-                'VNU_short_desc'         => array('LIKE', $sstr),
-                'VNU_address'            => array('LIKE', $sstr),
-                'VNU_address2'           => array('LIKE', $sstr),
-                'VNU_city'               => array('LIKE', $sstr),
-                'VNU_zip'                => array('LIKE', $sstr),
-                'VNU_phone'              => array('LIKE', $sstr),
-                'VNU_url'                => array('LIKE', $sstr),
-                'VNU_virtual_phone'      => array('LIKE', $sstr),
-                'VNU_virtual_url'        => array('LIKE', $sstr),
-                'VNU_google_map_link'    => array('LIKE', $sstr),
-                'Event.EVT_name'         => array('LIKE', $sstr),
-                'Event.EVT_desc'         => array('LIKE', $sstr),
-                'Event.EVT_phone'        => array('LIKE', $sstr),
-                'Event.EVT_external_URL' => array('LIKE', $sstr),
-            );
-        }
+	/**
+	 * _venue
+	 * This will hold the venue object for venue_details screen.
+	 *
+	 * @access protected
+	 * @var object
+	 */
+	protected $_venue;
+
+
+	/**
+	 * This will hold the category object for category_details screen.
+	 *
+	 * @var object
+	 */
+	protected $_category;
+
+
+	/**
+	 * This property will hold the venue model instance
+	 *
+	 * @var object
+	 */
+	protected $_venue_model;
+
+
+	protected function _init_page_props()
+	{
+		require_once(EE_MODELS . 'EEM_Venue.model.php');
+		$this->page_slug = EE_VENUES_PG_SLUG;
+		$this->_admin_base_url = EE_VENUES_ADMIN_URL;
+		$this->_admin_base_path = EE_ADMIN_PAGES . 'venues';
+		$this->page_label = __('Event Venues', 'event_espresso');
+		$this->_cpt_model_names = array(
+			'create_new' => 'EEM_Venue',
+			'edit'       => 'EEM_Venue',
+		);
+		$this->_cpt_edit_routes = array(
+			'espresso_venues' => 'edit',
+		);
+		$this->_venue_model = EEM_Venue::instance();
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		// todo: all hooks for ee_venues ajax goes in here.
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels = array(
+			'buttons'      => array(
+				'add'             => __('Add New Venue', 'event_espresso'),
+				'edit'            => __('Edit Venue', 'event_espresso'),
+				'delete'          => __('Delete Venue', 'event_espresso'),
+				'add_category'    => __('Add New Category', 'event_espresso'),
+				'edit_category'   => __('Edit Category', 'event_espresso'),
+				'delete_category' => __('Delete Category', 'event_espresso'),
+			),
+			'editor_title' => array(
+				'espresso_venues' => __('Enter Venue name here', 'event_espresso'),
+			),
+			'publishbox'   => array(
+				'create_new'          => __('Save New Venue', 'event_espresso'),
+				'edit'                => __('Update Venue', 'event_espresso'),
+				'add_category'        => __('Save New Category', 'event_espresso'),
+				'edit_category'       => __('Update Category', 'event_espresso'),
+				'google_map_settings' => __('Update Settings', 'event_espresso'),
+			),
+		);
+	}
+
+
+	protected function _set_page_routes()
+	{
+
+		// load formatter helper
+		// load field generator helper
+
+		// is there a vnu_id in the request?
+		$vnu_id = ! empty($this->_req_data['VNU_ID']) && ! is_array($this->_req_data['VNU_ID'])
+			? $this->_req_data['VNU_ID'] : 0;
+		$vnu_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $vnu_id;
+
+		$this->_page_routes = array(
+			'default'                    => array(
+				'func'       => '_overview_list_table',
+				'capability' => 'ee_read_venues',
+			),
+			'create_new'                 => array(
+				'func'       => '_create_new_cpt_item',
+				'capability' => 'ee_edit_venues',
+			),
+			'edit'                       => array(
+				'func'       => '_edit_cpt_item',
+				'capability' => 'ee_edit_venue',
+				'obj_id'     => $vnu_id,
+			),
+			'trash_venue'                => array(
+				'func'       => '_trash_or_restore_venue',
+				'args'       => array('venue_status' => 'trash'),
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue',
+				'obj_id'     => $vnu_id,
+			),
+			'trash_venues'               => array(
+				'func'       => '_trash_or_restore_venues',
+				'args'       => array('venue_status' => 'trash'),
+				'noheader'   => true,
+				'capability' => 'ee_delete_venues',
+			),
+			'restore_venue'              => array(
+				'func'       => '_trash_or_restore_venue',
+				'args'       => array('venue_status' => 'draft'),
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue',
+				'obj_id'     => $vnu_id,
+			),
+			'restore_venues'             => array(
+				'func'       => '_trash_or_restore_venues',
+				'args'       => array('venue_status' => 'draft'),
+				'noheader'   => true,
+				'capability' => 'ee_delete_venues',
+			),
+			'delete_venues'              => array(
+				'func'       => '_delete_venues',
+				'noheader'   => true,
+				'capability' => 'ee_delete_venues',
+			),
+			'delete_venue'               => array(
+				'func'       => '_delete_venue',
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue',
+				'obj_id'     => $vnu_id,
+			),
+			// settings related
+			'google_map_settings'        => array(
+				'func'       => '_google_map_settings',
+				'capability' => 'manage_options',
+			),
+			'update_google_map_settings' => array(
+				'func'       => '_update_google_map_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			// venue category tab related
+			'add_category'               => array(
+				'func'       => '_category_details',
+				'args'       => array('add'),
+				'capability' => 'ee_edit_venue_category',
+			),
+			'edit_category'              => array(
+				'func'       => '_category_details',
+				'args'       => array('edit'),
+				'capability' => 'ee_edit_venue_category',
+			),
+			'delete_categories'          => array(
+				'func'       => '_delete_categories',
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue_category',
+			),
+
+			'delete_category' => array(
+				'func'       => '_delete_categories',
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue_category',
+			),
+
+			'insert_category' => array(
+				'func'       => '_insert_or_update_category',
+				'args'       => array('new_category' => true),
+				'noheader'   => true,
+				'capability' => 'ee_edit_venue_category',
+			),
+
+			'update_category'   => array(
+				'func'       => '_insert_or_update_category',
+				'args'       => array('new_category' => false),
+				'noheader'   => true,
+				'capability' => 'ee_edit_venue_category',
+			),
+			'export_categories' => array(
+				'func'       => '_categories_export',
+				'noheader'   => true,
+				'capability' => 'export',
+			),
+			'import_categories' => array(
+				'func'       => '_import_categories',
+				'capability' => 'import',
+			),
+			'category_list'     => array(
+				'func'       => '_category_list_table',
+				'capability' => 'ee_manage_venue_categories',
+			),
+		);
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'             => array(
+				'nav'           => array(
+					'label' => __('Overview', 'event_espresso'),
+					'order' => 10,
+				),
+				'list_table'    => 'Venues_Admin_List_Table',
+				'help_tabs'     => array(
+					'venues_overview_help_tab'                           => array(
+						'title'    => __('Venues Overview', 'event_espresso'),
+						'filename' => 'venues_overview',
+					),
+					'venues_overview_table_column_headings_help_tab'     => array(
+						'title'    => __('Venues Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'venues_overview_table_column_headings',
+					),
+					'venues_overview_views_bulk_actions_search_help_tab' => array(
+						'title'    => __('Venues Overview Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'venues_overview_views_bulk_actions_search',
+					),
+				),
+				'help_tour'     => array('Venues_Overview_Help_Tour'),
+				'metaboxes'     => array('_espresso_news_post_box', '_espresso_links_post_box'),
+				'require_nonce' => false,
+			),
+			'create_new'          => array(
+				'nav'           => array(
+					'label'      => __('Add Venue', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				),
+				'help_tabs'     => array(
+					'venues_editor_help_tab'                                               => array(
+						'title'    => __('Venue Editor', 'event_espresso'),
+						'filename' => 'venues_editor',
+					),
+					'venues_editor_title_richtexteditor_help_tab'                          => array(
+						'title'    => __('Venue Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'venues_editor_title_richtexteditor',
+					),
+					'venues_editor_tags_categories_help_tab'                               => array(
+						'title'    => __('Venue Tags & Categories', 'event_espresso'),
+						'filename' => 'venues_editor_tags_categories',
+					),
+					'venues_editor_physical_location_google_map_virtual_location_help_tab' => array(
+						'title'    => __(
+							'Venue Editor Physical Location & Google Map & Virtual Location',
+							'event_espresso'
+						),
+						'filename' => 'venues_editor_physical_location_google_map_virtual_location',
+					),
+					'venues_editor_save_new_venue_help_tab'                                => array(
+						'title'    => __('Save New Venue', 'event_espresso'),
+						'filename' => 'venues_editor_save_new_venue',
+					),
+					'venues_editor_other_help_tab'                                         => array(
+						'title'    => __('Venue Editor Other', 'event_espresso'),
+						'filename' => 'venues_editor_other',
+					),
+				),
+				'help_tour'     => array('Venues_Add_Venue_Help_Tour'),
+				'metaboxes'     => array('_venue_editor_metaboxes'),
+				'require_nonce' => false,
+			),
+			'edit'                => array(
+				'nav'           => array(
+					'label'      => __('Edit Venue', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['post']) ? add_query_arg(
+						array('post' => $this->_req_data['post']),
+						$this->_current_page_view_url
+					) : $this->_admin_base_url,
+				),
+				'help_tabs'     => array(
+					'venues_editor_help_tab'                                               => array(
+						'title'    => __('Venue Editor', 'event_espresso'),
+						'filename' => 'venues_editor',
+					),
+					'venues_editor_title_richtexteditor_help_tab'                          => array(
+						'title'    => __('Venue Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'venues_editor_title_richtexteditor',
+					),
+					'venues_editor_tags_categories_help_tab'                               => array(
+						'title'    => __('Venue Tags & Categories', 'event_espresso'),
+						'filename' => 'venues_editor_tags_categories',
+					),
+					'venues_editor_physical_location_google_map_virtual_location_help_tab' => array(
+						'title'    => __(
+							'Venue Editor Physical Location & Google Map & Virtual Location',
+							'event_espresso'
+						),
+						'filename' => 'venues_editor_physical_location_google_map_virtual_location',
+					),
+					'venues_editor_save_new_venue_help_tab'                                => array(
+						'title'    => __('Save New Venue', 'event_espresso'),
+						'filename' => 'venues_editor_save_new_venue',
+					),
+					'venues_editor_other_help_tab'                                         => array(
+						'title'    => __('Venue Editor Other', 'event_espresso'),
+						'filename' => 'venues_editor_other',
+					),
+				),
+				/*'help_tour' => array( 'Venues_Edit_Venue_Help_Tour' ),*/
+				'metaboxes'     => array('_venue_editor_metaboxes'),
+				'require_nonce' => false,
+			),
+			'google_map_settings' => array(
+				'nav'           => array(
+					'label' => esc_html__('Google Maps', 'event_espresso'),
+					'order' => 40,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'general_settings_google_maps_help_tab' => array(
+						'title'    => __('Google Maps', 'event_espresso'),
+						'filename' => 'general_settings_google_maps',
+					),
+				),
+				'help_tour'     => array('Google_Maps_Help_Tour'),
+				'require_nonce' => false,
+			),
+			// venue category stuff
+			'add_category'        => array(
+				'nav'           => array(
+					'label'      => __('Add Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+				),
+				'metaboxes'     => array('_publish_post_box'),
+				'help_tabs'     => array(
+					'venues_add_category_help_tab' => array(
+						'title'    => __('Add New Venue Category', 'event_espresso'),
+						'filename' => 'venues_add_category',
+					),
+				),
+				'help_tour'     => array('Venues_Add_Category_Help_Tour'),
+				'require_nonce' => false,
+			),
+			'edit_category'       => array(
+				'nav'           => array(
+					'label'      => __('Edit Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['EVT_CAT_ID']) ? add_query_arg(
+						array('EVT_CAT_ID' => $this->_req_data['EVT_CAT_ID']),
+						$this->_current_page_view_url
+					) : $this->_admin_base_url,
+				),
+				'metaboxes'     => array('_publish_post_box'),
+				'help_tabs'     => array(
+					'venues_edit_category_help_tab' => array(
+						'title'    => __('Edit Venue Category', 'event_espresso'),
+						'filename' => 'venues_edit_category',
+					),
+				),
+				/*'help_tour' => array( 'Venues_Edit_Category_Help_Tour' ),*/
+				'require_nonce' => false,
+			),
+			'category_list'       => array(
+				'nav'           => array(
+					'label' => __('Categories', 'event_espresso'),
+					'order' => 20,
+				),
+				'list_table'    => 'Venue_Categories_Admin_List_Table',
+				'help_tabs'     => array(
+					'venues_categories_help_tab'                       => array(
+						'title'    => __('Venue Categories', 'event_espresso'),
+						'filename' => 'venues_categories',
+					),
+					'venues_categories_table_column_headings_help_tab' => array(
+						'title'    => __('Venue Categories Table Column Headings', 'event_espresso'),
+						'filename' => 'venues_categories_table_column_headings',
+					),
+					'venues_categories_views_help_tab'                 => array(
+						'title'    => __('Venue Categories Views', 'event_espresso'),
+						'filename' => 'venues_categories_views',
+					),
+					'venues_categories_other_help_tab'                 => array(
+						'title'    => __('Venue Categories Other', 'event_espresso'),
+						'filename' => 'venues_categories_other',
+					),
+				),
+				'help_tour'     => array('Venues_Categories_Help_Tour'),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+	protected function _add_screen_options()
+	{
+		// todo
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	protected function _add_screen_options_category_list()
+	{
+		$page_title = $this->_admin_page_title;
+		$this->_admin_page_title = __('Venue Categories', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	// none of the below group are currently used for Event Venues
+	protected function _add_feature_pointers()
+	{
+	}
+
+	public function admin_init()
+	{
+	}
+
+	public function admin_notices()
+	{
+	}
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles_create_new()
+	{
+		$this->load_scripts_styles_edit();
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('ee-cat-admin');
+	}
+
+
+	public function load_scripts_styles_add_category()
+	{
+		$this->load_scripts_styles_edit_category();
+	}
+
+
+	public function load_scripts_styles_edit_category()
+	{
+	}
+
+
+	public function load_scripts_styles_edit()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'espresso_venues',
+			EE_VENUES_ASSETS_URL . 'ee-venues-admin.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_venues');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => __('View All Venues', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(),
+			),
+		);
+
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_venues', 'espresso_venues_trash_venues')) {
+			$this->_views['all']['bulk_action'] = array(
+				'trash_venues' => __('Move to Trash', 'event_espresso'),
+			);
+			$this->_views['trash'] = array(
+				'slug'        => 'trash',
+				'label'       => __('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'restore_venues' => __('Restore from Trash', 'event_espresso'),
+					'delete_venues'  => __('Delete', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+	protected function _set_list_table_views_category_list()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => __('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'delete_categories' => __('Delete Permanently', 'event_espresso'),
+				),
+			),
+		);
+	}
+
+
+	protected function _overview_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_template_args['after_list_table'] = EEH_Template::get_button_or_link(
+			get_post_type_archive_link('espresso_venues'),
+			__("View Venue Archive Page", "event_espresso"),
+			'button'
+		);
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button('create_new', 'add', array(), 'add-new-h2');
+		$this->_search_btn_label = __('Venues', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	public function extra_misc_actions_publish_box()
+	{
+		$extra_rows = array(
+			'vnu_capacity' => $this->_cpt_model_obj->get_f('VNU_capacity'),
+			'vnu_url'      => $this->_cpt_model_obj->get_f('VNU_url'),
+			'vnu_phone'    => $this->_cpt_model_obj->get_f('VNU_phone'),
+		);
+		$template = EE_VENUES_TEMPLATE_PATH . 'venue_publish_box_extras.template.php';
+		EEH_Template::display_template($template, $extra_rows);
+	}
+
+
+	/*************        Google Maps        *************/
+
+
+	protected function _google_map_settings()
+	{
+
+
+		$this->_template_args['values'] = $this->_yes_no_values;
+		$default_map_settings = new stdClass();
+		$default_map_settings->use_google_maps = true;
+		$default_map_settings->google_map_api_key = '';
+		// for event details pages (reg page)
+		$default_map_settings->event_details_map_width = 585;            // ee_map_width_single
+		$default_map_settings->event_details_map_height = 362;            // ee_map_height_single
+		$default_map_settings->event_details_map_zoom = 14;            // ee_map_zoom_single
+		$default_map_settings->event_details_display_nav = true;            // ee_map_nav_display_single
+		$default_map_settings->event_details_nav_size = false;            // ee_map_nav_size_single
+		$default_map_settings->event_details_control_type = 'default';        // ee_map_type_control_single
+		$default_map_settings->event_details_map_align = 'center';            // ee_map_align_single
+		// for event list pages
+		$default_map_settings->event_list_map_width = 300;            // ee_map_width
+		$default_map_settings->event_list_map_height = 185;        // ee_map_height
+		$default_map_settings->event_list_map_zoom = 12;            // ee_map_zoom
+		$default_map_settings->event_list_display_nav = false;        // ee_map_nav_display
+		$default_map_settings->event_list_nav_size = true;            // ee_map_nav_size
+		$default_map_settings->event_list_control_type = 'dropdown';        // ee_map_type_control
+		$default_map_settings->event_list_map_align = 'center';            // ee_map_align
+
+		$this->_template_args['map_settings'] =
+			isset(EE_Registry::instance()->CFG->map_settings)
+			&& ! empty(EE_Registry::instance()->CFG->map_settings)
+				? (object) array_merge(
+					(array) $default_map_settings,
+					(array) EE_Registry::instance()->CFG->map_settings
+				)
+				: $default_map_settings;
+
+		$this->_set_add_edit_form_tags('update_google_map_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EE_VENUES_TEMPLATE_PATH . 'google_map.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+	protected function _update_google_map_settings()
+	{
+
+		EE_Registry::instance()->CFG->map_settings->use_google_maps =
+			isset($this->_req_data['use_google_maps'])
+				? absint($this->_req_data['use_google_maps'])
+				: EE_Registry::instance()->CFG->map_settings->use_google_maps;
+
+		EE_Registry::instance()->CFG->map_settings->google_map_api_key =
+			isset($this->_req_data['google_map_api_key'])
+				? sanitize_text_field($this->_req_data['google_map_api_key'])
+				: EE_Registry::instance()->CFG->map_settings->google_map_api_key;
+
+		EE_Registry::instance()->CFG->map_settings->event_details_map_width =
+			isset($this->_req_data['event_details_map_width'])
+				? absint($this->_req_data['event_details_map_width'])
+				: EE_Registry::instance()->CFG->map_settings->event_details_map_width;
+
+		EE_Registry::instance()->CFG->map_settings->event_details_map_height =
+			isset($this->_req_data['event_details_map_height'])
+				? absint($this->_req_data['event_details_map_height'])
+				: EE_Registry::instance()->CFG->map_settings->event_details_map_height;
+
+		EE_Registry::instance()->CFG->map_settings->event_details_map_zoom =
+			isset($this->_req_data['event_details_map_zoom'])
+				? absint($this->_req_data['event_details_map_zoom'])
+				: EE_Registry::instance()->CFG->map_settings->event_details_map_zoom;
+
+		EE_Registry::instance()->CFG->map_settings->event_details_display_nav =
+			isset($this->_req_data['event_details_display_nav'])
+				? absint($this->_req_data['event_details_display_nav'])
+				: EE_Registry::instance()->CFG->map_settings->event_details_display_nav;
+
+		EE_Registry::instance()->CFG->map_settings->event_details_nav_size =
+			isset($this->_req_data['event_details_nav_size'])
+				? absint($this->_req_data['event_details_nav_size'])
+				: EE_Registry::instance()->CFG->map_settings->event_details_nav_size;
+
+		EE_Registry::instance()->CFG->map_settings->event_details_control_type =
+			isset($this->_req_data['event_details_control_type'])
+				? sanitize_text_field($this->_req_data['event_details_control_type'])
+				: EE_Registry::instance()->CFG->map_settings->event_details_control_type;
+
+		EE_Registry::instance()->CFG->map_settings->event_details_map_align =
+			isset($this->_req_data['event_details_map_align'])
+				? sanitize_text_field($this->_req_data['event_details_map_align'])
+				: EE_Registry::instance()->CFG->map_settings->event_details_map_align;
+
+		EE_Registry::instance()->CFG->map_settings->event_list_map_width =
+			isset($this->_req_data['event_list_map_width'])
+				? absint($this->_req_data['event_list_map_width'])
+				: EE_Registry::instance()->CFG->map_settings->event_list_map_width;
+
+		EE_Registry::instance()->CFG->map_settings->event_list_map_height =
+			isset($this->_req_data['event_list_map_height'])
+				? absint($this->_req_data['event_list_map_height'])
+				: EE_Registry::instance()->CFG->map_settings->event_list_map_height;
+
+		EE_Registry::instance()->CFG->map_settings->event_list_map_zoom =
+			isset($this->_req_data['event_list_map_zoom'])
+				? absint($this->_req_data['event_list_map_zoom'])
+				: EE_Registry::instance()->CFG->map_settings->event_list_map_zoom;
+
+		EE_Registry::instance()->CFG->map_settings->event_list_display_nav =
+			isset($this->_req_data['event_list_display_nav'])
+				? absint($this->_req_data['event_list_display_nav'])
+				: EE_Registry::instance()->CFG->map_settings->event_list_display_nav;
+
+		EE_Registry::instance()->CFG->map_settings->event_list_nav_size =
+			isset($this->_req_data['event_list_nav_size'])
+				? absint($this->_req_data['event_list_nav_size'])
+				: EE_Registry::instance()->CFG->map_settings->event_list_nav_size;
+
+		EE_Registry::instance()->CFG->map_settings->event_list_control_type =
+			isset($this->_req_data['event_list_control_type'])
+				? sanitize_text_field($this->_req_data['event_list_control_type'])
+				: EE_Registry::instance()->CFG->map_settings->event_list_control_type;
+
+		EE_Registry::instance()->CFG->map_settings->event_list_map_align =
+			isset($this->_req_data['event_list_map_align'])
+				? sanitize_text_field($this->_req_data['event_list_map_align'])
+				: EE_Registry::instance()->CFG->map_settings->event_list_map_align;
+
+		EE_Registry::instance()->CFG->map_settings = apply_filters(
+			'FHEE__Extend_General_Settings_Admin_Page___update_google_map_settings__CFG_map_settings',
+			EE_Registry::instance()->CFG->map_settings
+		);
+
+		$what = 'Google Map Settings';
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG->map_settings,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		$this->_redirect_after_action($success, $what, 'updated', array('action' => 'google_map_settings'));
+	}
+
+
+	protected function _venue_editor_metaboxes()
+	{
+		$this->verify_cpt_object();
+
+		add_meta_box(
+			'espresso_venue_address_options',
+			__('Physical Location', 'event_espresso'),
+			array($this, 'venue_address_metabox'),
+			$this->page_slug,
+			'side',
+			'default'
+		);
+		add_meta_box(
+			'espresso_venue_gmap_options',
+			__('Google Map', 'event_espresso'),
+			array($this, 'venue_gmap_metabox'),
+			$this->page_slug,
+			'side',
+			'default'
+		);
+		add_meta_box(
+			'espresso_venue_virtual_loc_options',
+			__('Virtual Location', 'event_espresso'),
+			array($this, 'venue_virtual_loc_metabox'),
+			$this->page_slug,
+			'side',
+			'default'
+		);
+	}
+
+
+	public function venue_gmap_metabox()
+	{
+		$template_args = array(
+			'vnu_enable_for_gmap' => EEH_Form_Fields::select_input(
+				'vnu_enable_for_gmap',
+				$this->get_yes_no_values(),
+				$this->_cpt_model_obj->enable_for_gmap()
+			),
+			'vnu_google_map_link' => $this->_cpt_model_obj->google_map_link(),
+		);
+		$template = EE_VENUES_TEMPLATE_PATH . 'venue_gmap_metabox_content.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	public function venue_address_metabox()
+	{
+
+		$template_args['_venue'] = $this->_cpt_model_obj;
+
+		$template_args['states_dropdown'] = EEH_Form_Fields::generate_form_input(
+			$QFI = new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					array('QST_display_text' => esc_html__('State', 'event_espresso'), 'QST_system' => 'state')
+				),
+				EE_Answer::new_instance(array('ANS_value' => $this->_cpt_model_obj->state_ID())),
+				array(
+					'input_name'     => 'sta_id',
+					'input_id'       => 'sta_id',
+					'input_class'    => '',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				)
+			)
+		);
+		$template_args['countries_dropdown'] = EEH_Form_Fields::generate_form_input(
+			$QFI = new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					array('QST_display_text' => esc_html__('Country', 'event_espresso'), 'QST_system' => 'country')
+				),
+				EE_Answer::new_instance(array('ANS_value' => $this->_cpt_model_obj->country_ID())),
+				array(
+					'input_name'     => 'cnt_iso',
+					'input_id'       => 'cnt_iso',
+					'input_class'    => '',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				)
+			)
+		);
+
+		$template = EE_VENUES_TEMPLATE_PATH . 'venue_address_metabox_content.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	public function venue_virtual_loc_metabox()
+	{
+		$template_args = array(
+			'_venue' => $this->_cpt_model_obj,
+		);
+		$template = EE_VENUES_TEMPLATE_PATH . 'venue_virtual_location_metabox_content.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+		$venue_obj = $this->_venue_model->get_one_by_ID($post_id);
+
+		// meta revision restore
+		$venue_obj->restore_revision($revision_id);
+	}
+
+
+	/**
+	 * Handles updates for venue cpts
+	 *
+	 * @param  int    $post_id ID of Venue CPT
+	 * @param  object $post    Post object (with "blessed" WP properties)
+	 * @return void
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+
+		if ($post instanceof WP_Post && $post->post_type !== 'espresso_venues') {
+			return;// get out we're not processing the saving of venues.
+		}
+
+		$wheres = array($this->_venue_model->primary_key_name() => $post_id);
+
+		$venue_values = array(
+			'VNU_address'         => ! empty($this->_req_data['vnu_address']) ? $this->_req_data['vnu_address'] : null,
+			'VNU_address2'        => ! empty($this->_req_data['vnu_address2']) ? $this->_req_data['vnu_address2']
+				: null,
+			'VNU_city'            => ! empty($this->_req_data['vnu_city']) ? $this->_req_data['vnu_city'] : null,
+			'STA_ID'              => ! empty($this->_req_data['sta_id']) ? $this->_req_data['sta_id'] : null,
+			'CNT_ISO'             => ! empty($this->_req_data['cnt_iso']) ? $this->_req_data['cnt_iso'] : null,
+			'VNU_zip'             => ! empty($this->_req_data['vnu_zip']) ? $this->_req_data['vnu_zip'] : null,
+			'VNU_phone'           => ! empty($this->_req_data['vnu_phone']) ? $this->_req_data['vnu_phone'] : null,
+			'VNU_capacity'        => ! empty($this->_req_data['vnu_capacity']) ? str_replace(
+				',',
+				'',
+				$this->_req_data['vnu_capacity']
+			) : EE_INF,
+			'VNU_url'             => ! empty($this->_req_data['vnu_url']) ? $this->_req_data['vnu_url'] : null,
+			'VNU_virtual_phone'   => ! empty($this->_req_data['vnu_virtual_phone'])
+				? $this->_req_data['vnu_virtual_phone'] : null,
+			'VNU_virtual_url'     => ! empty($this->_req_data['vnu_virtual_url']) ? $this->_req_data['vnu_virtual_url']
+				: null,
+			'VNU_enable_for_gmap' => ! empty($this->_req_data['vnu_enable_for_gmap']) ? true : false,
+			'VNU_google_map_link' => ! empty($this->_req_data['vnu_google_map_link'])
+				? $this->_req_data['vnu_google_map_link'] : null,
+		);
+
+		// update venue
+		$success = $this->_venue_model->update($venue_values, array($wheres));
+
+		// get venue_object for other metaboxes that might be added via the filter... though it would seem to make sense to just use $this->_venue_model->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
+		$get_one_where = array($this->_venue_model->primary_key_name() => $post_id, 'status' => $post->post_status);
+		$venue = $this->_venue_model->get_one(array($get_one_where));
+
+		// notice we've applied a filter for venue metabox callbacks but we don't actually have any default venue metaboxes in use.  So this is just here for addons to more easily hook into venue saves.
+		$venue_update_callbacks = apply_filters(
+			'FHEE__Venues_Admin_Page___insert_update_cpt_item__venue_update_callbacks',
+			array()
+		);
+
+		$att_success = true;
+
+		foreach ($venue_update_callbacks as $v_callback) {
+			$_succ = call_user_func_array($v_callback, array($venue, $this->_req_data));
+			$att_success = ! $att_success ? $att_success
+				: $_succ; // if ANY of these updates fail then we want the appropriate global error message
+		}
+
+		// any errors?
+		if ($success && ! $att_success) {
+			EE_Error::add_error(
+				__(
+					'Venue Details saved successfully but something went wrong with saving attachments.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} elseif ($success === false) {
+			EE_Error::add_error(
+				__('Venue Details did not save successfully.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	public function trash_cpt_item($post_id)
+	{
+		$this->_req_data['VNU_ID'] = $post_id;
+		$this->_trash_or_restore_venue('trash', false);
+	}
+
+
+	public function restore_cpt_item($post_id)
+	{
+		$this->_req_data['VNU_ID'] = $post_id;
+		$this->_trash_or_restore_venue('draft', false);
+	}
+
+
+	public function delete_cpt_item($post_id)
+	{
+		$this->_req_data['VNU_ID'] = $post_id;
+		$this->_delete_venue(false);
+	}
+
+
+	public function get_venue_object()
+	{
+		return $this->_cpt_model_obj;
+	}
+
+
+	protected function _trash_or_restore_venue($venue_status = 'trash', $redirect_after = true)
+	{
+		$VNU_ID = isset($this->_req_data['VNU_ID']) ? absint($this->_req_data['VNU_ID']) : false;
+
+		// loop thru venues
+		if ($VNU_ID) {
+			// clean status
+			$venue_status = sanitize_key($venue_status);
+			// grab status
+			if (! empty($venue_status)) {
+				$success = $this->_change_venue_status($VNU_ID, $venue_status);
+			} else {
+				$success = false;
+				$msg = __(
+					'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		} else {
+			$success = false;
+			$msg = __(
+				'An error occurred. The venue could not be moved to the trash because a valid venue ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		$action = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Venue', $action, array('action' => 'default'));
+		}
+	}
+
+
+	protected function _trash_or_restore_venues($venue_status = 'trash')
+	{
+		// clean status
+		$venue_status = sanitize_key($venue_status);
+		// grab status
+		if (! empty($venue_status)) {
+			$success = true;
+			// determine the event id and set to array.
+			$VNU_IDs = isset($this->_req_data['venue_id']) ? (array) $this->_req_data['venue_id'] : array();
+			// loop thru events
+			foreach ($VNU_IDs as $VNU_ID) {
+				if ($VNU_ID = absint($VNU_ID)) {
+					$results = $this->_change_venue_status($VNU_ID, $venue_status);
+					$success = $results !== false ? $success : false;
+				} else {
+					$msg = sprintf(
+						__(
+							'An error occurred. Venue #%d could not be moved to the trash because a valid venue ID was not not supplied.',
+							'event_espresso'
+						),
+						$VNU_ID
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+					$success = false;
+				}
+			}
+		} else {
+			$success = false;
+			$msg = __(
+				'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$action = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+		$this->_redirect_after_action($success, 'Venues', $action, array('action' => 'default'));
+	}
+
+
+	/**
+	 * _trash_or_restore_venues
+	 *
+	 * //todo this is pretty much the same as the corresponding change_event_status method in Events_Admin_Page.  We
+	 * should probably abstract this up to the EE_Admin_Page_CPT (or even EE_Admin_Page) and make this a common method
+	 * accepting a certain number of params.
+	 *
+	 * @access  private
+	 * @param  int    $VNU_ID
+	 * @param  string $venue_status
+	 * @return void
+	 */
+	private function _change_venue_status($VNU_ID = 0, $venue_status = '')
+	{
+		// grab venue id
+		if (! $VNU_ID) {
+			$msg = __('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		$this->_cpt_model_obj = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+
+		// clean status
+		$venue_status = sanitize_key($venue_status);
+		// grab status
+		if (! $venue_status) {
+			$msg = __('An error occurred. No Venue Status or an invalid Venue Status was received.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		// was event trashed or restored ?
+		switch ($venue_status) {
+			case 'draft':
+				$action = 'restored from the trash';
+				$hook = 'AHEE_venue_restored_from_trash';
+				break;
+			case 'trash':
+				$action = 'moved to the trash';
+				$hook = 'AHEE_venue_moved_to_trash';
+				break;
+			default:
+				$action = 'updated';
+				$hook = false;
+		}
+		// use class to change status
+		$this->_cpt_model_obj->set_status($venue_status);
+		$success = $this->_cpt_model_obj->save();
+
+		if ($success === false) {
+			$msg = sprintf(__('An error occurred. The venue could not be %s.', 'event_espresso'), $action);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if ($hook) {
+			do_action($hook);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param  bool $redirect_after
+	 * @return void
+	 */
+	protected function _delete_venue($redirect_after = true)
+	{
+		// determine the venue id and set to array.
+		$VNU_ID = isset($this->_req_data['VNU_ID']) ? absint($this->_req_data['VNU_ID']) : null;
+		$VNU_ID = isset($this->_req_data['post']) ? absint($this->_req_data['post']) : $VNU_ID;
+
+
+		// loop thru venues
+		if ($VNU_ID) {
+			$success = $this->_delete_or_trash_venue($VNU_ID);
+		} else {
+			$success = false;
+			$msg = __(
+				'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Venue', 'deleted', array('action' => 'default'));
+		}
+	}
+
+
+	protected function _delete_venues()
+	{
+		$success = true;
+		// determine the event id and set to array.
+		$VNU_IDs = isset($this->_req_data['venue_id']) ? (array) $this->_req_data['venue_id'] : array();
+		// loop thru events
+		foreach ($VNU_IDs as $VNU_ID) {
+			if ($VNU_ID = absint($VNU_ID)) {
+				$results = $this->_delete_or_trash_venue($VNU_ID);
+				$success = $results !== false ? $success : false;
+			} else {
+				$success = false;
+				$msg = __(
+					'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$this->_redirect_after_action(
+			$success,
+			__('Venues', 'event_espresso'),
+			__('deleted', 'event_espresso'),
+			array('action' => 'default')
+		);
+	}
+
+
+	// todo: put in parent
+	private function _delete_or_trash_venue($VNU_ID = false)
+	{
+		// grab event id
+		if (! $VNU_ID = absint($VNU_ID)) {
+			$msg = __('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+
+		$venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+		// first need to remove all term relationships
+		$venue->_remove_relations('Term_Taxonomy');
+		$success = $venue->delete_permanently();
+		// did it all go as planned ?
+		if ($success) {
+			$msg = sprintf(__('Venue ID # %d has been deleted.', 'event_espresso'), $VNU_ID);
+			EE_Error::add_success($msg);
+		} else {
+			$msg = sprintf(__('An error occurred. Venue ID # %d could not be deleted.', 'event_espresso'), $VNU_ID);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		do_action('AHEE__Venues_Admin_Page___delete_or_trash_venue__after_venue_deleted');
+		return true;
+	}
+
+
+
+
+	/***********/
+	/* QUERIES */
+
+
+	public function get_venues($per_page = 10, $count = false)
+	{
+
+		$_orderby = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
+
+		switch ($_orderby) {
+			case 'id':
+				$orderby = 'VNU_ID';
+				break;
+
+			case 'capacity':
+				$orderby = 'VNU_capacity';
+				break;
+
+			case 'city':
+				$orderby = 'VNU_city';
+				break;
+
+			default:
+				$orderby = 'VNU_name';
+		}
+
+
+		$sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
+			: 'ASC';
+
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
+			? $this->_req_data['paged'] : 1;
+		$per_page = isset($per_page) && ! empty($per_page) ? $per_page : 10;
+		$per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage'] : $per_page;
+
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit = array($offset, $per_page);
+
+		$category = isset($this->_req_data['category']) && $this->_req_data['category'] > 0
+			? $this->_req_data['category'] : null;
+		$where = array();
+
+		// only set initial status if it is in the incoming request.  Otherwise the "all" view display's all statuses.
+		if (isset($this->_req_data['status']) && $this->_req_data['status'] != 'all') {
+			$where['status'] = $this->_req_data['status'];
+		}
+
+		if (isset($this->_req_data['venue_status'])) {
+			$where['status'] = $this->_req_data['venue_status'];
+		}
+
+
+		if ($category) {
+			$where['Term_Taxonomy.taxonomy'] = 'espresso_venue_categories';
+			$where['Term_Taxonomy.term_id'] = $category;
+		}
+
+
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_venues', 'get_venues')) {
+			$where['VNU_wp_user'] = get_current_user_id();
+		} else {
+			if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')) {
+				$where['OR'] = array(
+					'status*restrict_private' => array('!=', 'private'),
+					'AND'                     => array(
+						'status*inclusive' => array('=', 'private'),
+						'VNU_wp_user'      => get_current_user_id(),
+					),
+				);
+			}
+		}
+
+
+		if (isset($this->_req_data['s'])) {
+			$sstr = '%' . $this->_req_data['s'] . '%';
+			$where['OR'] = array(
+				'VNU_name'               => array('LIKE', $sstr),
+				'VNU_desc'               => array('LIKE', $sstr),
+				'VNU_short_desc'         => array('LIKE', $sstr),
+				'VNU_address'            => array('LIKE', $sstr),
+				'VNU_address2'           => array('LIKE', $sstr),
+				'VNU_city'               => array('LIKE', $sstr),
+				'VNU_zip'                => array('LIKE', $sstr),
+				'VNU_phone'              => array('LIKE', $sstr),
+				'VNU_url'                => array('LIKE', $sstr),
+				'VNU_virtual_phone'      => array('LIKE', $sstr),
+				'VNU_virtual_url'        => array('LIKE', $sstr),
+				'VNU_google_map_link'    => array('LIKE', $sstr),
+				'Event.EVT_name'         => array('LIKE', $sstr),
+				'Event.EVT_desc'         => array('LIKE', $sstr),
+				'Event.EVT_phone'        => array('LIKE', $sstr),
+				'Event.EVT_external_URL' => array('LIKE', $sstr),
+			);
+		}
 
 
-        $venues = $count
-            ? $this->_venue_model->count(array($where), 'VNU_ID')
-            : $this->_venue_model->get_all(
-                array($where, 'limit' => $limit, 'order_by' => $orderby, 'order' => $sort)
-            );
-
-        return $venues;
-    }
-
-
-
-
-    /** Venue Category Stuff **/
-
-    /**
-     * set the _category property with the category object for the loaded page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_category_object()
-    {
-        if (isset($this->_category->id) && ! empty($this->_category->id)) {
-            return;
-        } // already have the category object so get out.
-
-        // set default category object
-        $this->_set_empty_category_object();
-
-        // only set if we've got an id
-        if (! isset($this->_req_data['VEN_CAT_ID'])) {
-            return;
-        }
-
-        $category_id = absint($this->_req_data['VEN_CAT_ID']);
-        $term = get_term($category_id, 'espresso_venue_categories');
-
-
-        if (! empty($term)) {
-            $this->_category->category_name = $term->name;
-            $this->_category->category_identifier = $term->slug;
-            $this->_category->category_desc = $term->description;
-            $this->_category->id = $term->term_id;
-            $this->_category->parent = $term->parent;
-        }
-    }
-
-
-    private function _set_empty_category_object()
-    {
-        $this->_category = new stdClass();
-        $this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
-        $this->_category->id = $this->_category->parent = 0;
-    }
-
-
-    protected function _category_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'add_category',
-            'add_category',
-            array(),
-            'add-new-h2'
-        );
-        $this->_search_btn_label = __('Venue Categories', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    protected function _category_details($view)
-    {
-
-        // load formatter helper
-        // load field generator helper
-
-        $route = $view == 'edit' ? 'update_category' : 'insert_category';
-        $this->_set_add_edit_form_tags($route);
-
-        $this->_set_category_object();
-        $id = ! empty($this->_category->id) ? $this->_category->id : '';
-
-        $delete_action = 'delete_category';
-
-        $redirect = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'category_list'), $this->_admin_base_url);
-
-        $this->_set_publish_post_box_vars('VEN_CAT_ID', $id, $delete_action, $redirect);
-
-        // take care of contents
-        $this->_template_args['admin_page_content'] = $this->_category_details_content();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    protected function _category_details_content()
-    {
-        $editor_args['category_desc'] = array(
-            'type'          => 'wp_editor',
-            'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
-            'class'         => 'my_editor_custom',
-            'wpeditor_args' => array('media_buttons' => false),
-        );
-        $_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array');
-
-        $all_terms = get_terms(
-            array('espresso_venue_categories'),
-            array('hide_empty' => 0, 'exclude' => array($this->_category->id))
-        );
-
-        // setup category select for term parents.
-        $category_select_values[] = array(
-            'text' => __('No Parent', 'event_espresso'),
-            'id'   => 0,
-        );
-        foreach ($all_terms as $term) {
-            $category_select_values[] = array(
-                'text' => $term->name,
-                'id'   => $term->term_id,
-            );
-        }
-
-        $category_select = EEH_Form_Fields::select_input(
-            'category_parent',
-            $category_select_values,
-            $this->_category->parent
-        );
-        $template_args = array(
-            'category'                 => $this->_category,
-            'category_select'          => $category_select,
-            'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
-            'category_desc_editor'     => $_wp_editor['category_desc']['field'],
-            'disable'                  => '',
-            'disabled_message'         => false,
-        );
-        $template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    protected function _delete_categories()
-    {
-        $cat_ids = isset($this->_req_data['VEN_CAT_ID']) ? (array) $this->_req_data['VEN_CAT_ID']
-            : (array) $this->_req_data['category_id'];
-
-        foreach ($cat_ids as $cat_id) {
-            $this->_delete_category($cat_id);
-        }
-
-        // doesn't matter what page we're coming from... we're going to the same place after delete.
-        $query_args = array(
-            'action' => 'category_list',
-        );
-        $this->_redirect_after_action(0, '', '', $query_args);
-    }
-
-
-    protected function _delete_category($cat_id)
-    {
-        $cat_id = absint($cat_id);
-        wp_delete_term($cat_id, 'espresso_venue_categories');
-    }
-
-
-    protected function _insert_or_update_category($new_category)
-    {
-
-        $cat_id = $new_category ? $this->_insert_category() : $this->_insert_category(true);
-        $success = 0; // we already have a success message so lets not send another.
-        if ($cat_id) {
-            $query_args = array(
-                'action'     => 'edit_category',
-                'VEN_CAT_ID' => $cat_id,
-            );
-        } else {
-            $query_args = array('action' => 'add_category');
-        }
-        $this->_redirect_after_action($success, '', '', $query_args, true);
-    }
-
-
-    private function _insert_category($update = false)
-    {
-        $cat_id = $update ? $this->_req_data['VEN_CAT_ID'] : '';
-        $category_name = isset($this->_req_data['category_name']) ? $this->_req_data['category_name'] : '';
-        $category_desc = isset($this->_req_data['category_desc']) ? $this->_req_data['category_desc'] : '';
-        $category_parent = isset($this->_req_data['category_parent']) ? $this->_req_data['category_parent'] : 0;
-
-        if (empty($category_name)) {
-            $msg = __('You must add a name for the category.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-
-        $term_args = array(
-            'name'        => $category_name,
-            'description' => $category_desc,
-            'parent'      => $category_parent,
-        );
-
-        $insert_ids = $update
-            ? wp_update_term($cat_id, 'espresso_venue_categories', $term_args)
-            : wp_insert_term(
-                $category_name,
-                'espresso_venue_categories',
-                $term_args
-            );
-
-        if (! is_array($insert_ids)) {
-            $msg = __('An error occurred and the category has not been saved to the database.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            $cat_id = $insert_ids['term_id'];
-            $msg = sprintf(__('The category %s was successfully created', 'event_espresso'), $category_name);
-            EE_Error::add_success($msg);
-        }
-
-        return $cat_id;
-    }
-
-
-    /**
-     * TODO handle category exports()
-     *
-     * @return file export
-     */
-    protected function _categories_export()
-    {
-
-        // todo: I don't like doing this but it'll do until we modify EE_Export Class.
-        $new_request_args = array(
-            'export'       => 'report',
-            'action'       => 'categories',
-            'category_ids' => $this->_req_data['VEN_CAT_ID'],
-        );
-
-        $this->_req_data = array_merge($this->_req_data, $new_request_args);
-
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->_req_data);
-            $EE_Export->export();
-        }
-    }
-
-
-    protected function _import_categories()
-    {
-
-        require_once(EE_CLASSES . 'EE_Import.class.php');
-        EE_Import::instance()->import();
-    }
-
-
-    public function get_categories($per_page = 10, $current_page = 1, $count = false)
-    {
-
-        // testing term stuff
-        $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'Term.term_id';
-        $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
-        $limit = ($current_page - 1) * $per_page;
-        $where = array('taxonomy' => 'espresso_venue_categories');
-        if (isset($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
-            $where['OR'] = array(
-                'Term.name'   => array('LIKE', $sstr),
-                'description' => array('LIKE', $sstr),
-            );
-        }
-
-        $query_params = array(
-            $where,
-            'order_by'   => array($orderby => $order),
-            'limit'      => $limit . ',' . $per_page,
-            'force_join' => array('Term'),
-        );
-
-        $categories = $count ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
-            : EEM_Term_Taxonomy::instance()->get_all($query_params);
-
-        return $categories;
-    }
-
-
-    /* end category stuff */
-    /**************/
+		$venues = $count
+			? $this->_venue_model->count(array($where), 'VNU_ID')
+			: $this->_venue_model->get_all(
+				array($where, 'limit' => $limit, 'order_by' => $orderby, 'order' => $sort)
+			);
+
+		return $venues;
+	}
+
+
+
+
+	/** Venue Category Stuff **/
+
+	/**
+	 * set the _category property with the category object for the loaded page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_category_object()
+	{
+		if (isset($this->_category->id) && ! empty($this->_category->id)) {
+			return;
+		} // already have the category object so get out.
+
+		// set default category object
+		$this->_set_empty_category_object();
+
+		// only set if we've got an id
+		if (! isset($this->_req_data['VEN_CAT_ID'])) {
+			return;
+		}
+
+		$category_id = absint($this->_req_data['VEN_CAT_ID']);
+		$term = get_term($category_id, 'espresso_venue_categories');
+
+
+		if (! empty($term)) {
+			$this->_category->category_name = $term->name;
+			$this->_category->category_identifier = $term->slug;
+			$this->_category->category_desc = $term->description;
+			$this->_category->id = $term->term_id;
+			$this->_category->parent = $term->parent;
+		}
+	}
+
+
+	private function _set_empty_category_object()
+	{
+		$this->_category = new stdClass();
+		$this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
+		$this->_category->id = $this->_category->parent = 0;
+	}
+
+
+	protected function _category_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'add_category',
+			'add_category',
+			array(),
+			'add-new-h2'
+		);
+		$this->_search_btn_label = __('Venue Categories', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	protected function _category_details($view)
+	{
+
+		// load formatter helper
+		// load field generator helper
+
+		$route = $view == 'edit' ? 'update_category' : 'insert_category';
+		$this->_set_add_edit_form_tags($route);
+
+		$this->_set_category_object();
+		$id = ! empty($this->_category->id) ? $this->_category->id : '';
+
+		$delete_action = 'delete_category';
+
+		$redirect = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'category_list'), $this->_admin_base_url);
+
+		$this->_set_publish_post_box_vars('VEN_CAT_ID', $id, $delete_action, $redirect);
+
+		// take care of contents
+		$this->_template_args['admin_page_content'] = $this->_category_details_content();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	protected function _category_details_content()
+	{
+		$editor_args['category_desc'] = array(
+			'type'          => 'wp_editor',
+			'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
+			'class'         => 'my_editor_custom',
+			'wpeditor_args' => array('media_buttons' => false),
+		);
+		$_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array');
+
+		$all_terms = get_terms(
+			array('espresso_venue_categories'),
+			array('hide_empty' => 0, 'exclude' => array($this->_category->id))
+		);
+
+		// setup category select for term parents.
+		$category_select_values[] = array(
+			'text' => __('No Parent', 'event_espresso'),
+			'id'   => 0,
+		);
+		foreach ($all_terms as $term) {
+			$category_select_values[] = array(
+				'text' => $term->name,
+				'id'   => $term->term_id,
+			);
+		}
+
+		$category_select = EEH_Form_Fields::select_input(
+			'category_parent',
+			$category_select_values,
+			$this->_category->parent
+		);
+		$template_args = array(
+			'category'                 => $this->_category,
+			'category_select'          => $category_select,
+			'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
+			'category_desc_editor'     => $_wp_editor['category_desc']['field'],
+			'disable'                  => '',
+			'disabled_message'         => false,
+		);
+		$template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	protected function _delete_categories()
+	{
+		$cat_ids = isset($this->_req_data['VEN_CAT_ID']) ? (array) $this->_req_data['VEN_CAT_ID']
+			: (array) $this->_req_data['category_id'];
+
+		foreach ($cat_ids as $cat_id) {
+			$this->_delete_category($cat_id);
+		}
+
+		// doesn't matter what page we're coming from... we're going to the same place after delete.
+		$query_args = array(
+			'action' => 'category_list',
+		);
+		$this->_redirect_after_action(0, '', '', $query_args);
+	}
+
+
+	protected function _delete_category($cat_id)
+	{
+		$cat_id = absint($cat_id);
+		wp_delete_term($cat_id, 'espresso_venue_categories');
+	}
+
+
+	protected function _insert_or_update_category($new_category)
+	{
+
+		$cat_id = $new_category ? $this->_insert_category() : $this->_insert_category(true);
+		$success = 0; // we already have a success message so lets not send another.
+		if ($cat_id) {
+			$query_args = array(
+				'action'     => 'edit_category',
+				'VEN_CAT_ID' => $cat_id,
+			);
+		} else {
+			$query_args = array('action' => 'add_category');
+		}
+		$this->_redirect_after_action($success, '', '', $query_args, true);
+	}
+
+
+	private function _insert_category($update = false)
+	{
+		$cat_id = $update ? $this->_req_data['VEN_CAT_ID'] : '';
+		$category_name = isset($this->_req_data['category_name']) ? $this->_req_data['category_name'] : '';
+		$category_desc = isset($this->_req_data['category_desc']) ? $this->_req_data['category_desc'] : '';
+		$category_parent = isset($this->_req_data['category_parent']) ? $this->_req_data['category_parent'] : 0;
+
+		if (empty($category_name)) {
+			$msg = __('You must add a name for the category.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+
+		$term_args = array(
+			'name'        => $category_name,
+			'description' => $category_desc,
+			'parent'      => $category_parent,
+		);
+
+		$insert_ids = $update
+			? wp_update_term($cat_id, 'espresso_venue_categories', $term_args)
+			: wp_insert_term(
+				$category_name,
+				'espresso_venue_categories',
+				$term_args
+			);
+
+		if (! is_array($insert_ids)) {
+			$msg = __('An error occurred and the category has not been saved to the database.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		} else {
+			$cat_id = $insert_ids['term_id'];
+			$msg = sprintf(__('The category %s was successfully created', 'event_espresso'), $category_name);
+			EE_Error::add_success($msg);
+		}
+
+		return $cat_id;
+	}
+
+
+	/**
+	 * TODO handle category exports()
+	 *
+	 * @return file export
+	 */
+	protected function _categories_export()
+	{
+
+		// todo: I don't like doing this but it'll do until we modify EE_Export Class.
+		$new_request_args = array(
+			'export'       => 'report',
+			'action'       => 'categories',
+			'category_ids' => $this->_req_data['VEN_CAT_ID'],
+		);
+
+		$this->_req_data = array_merge($this->_req_data, $new_request_args);
+
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->_req_data);
+			$EE_Export->export();
+		}
+	}
+
+
+	protected function _import_categories()
+	{
+
+		require_once(EE_CLASSES . 'EE_Import.class.php');
+		EE_Import::instance()->import();
+	}
+
+
+	public function get_categories($per_page = 10, $current_page = 1, $count = false)
+	{
+
+		// testing term stuff
+		$orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'Term.term_id';
+		$order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
+		$limit = ($current_page - 1) * $per_page;
+		$where = array('taxonomy' => 'espresso_venue_categories');
+		if (isset($this->_req_data['s'])) {
+			$sstr = '%' . $this->_req_data['s'] . '%';
+			$where['OR'] = array(
+				'Term.name'   => array('LIKE', $sstr),
+				'description' => array('LIKE', $sstr),
+			);
+		}
+
+		$query_params = array(
+			$where,
+			'order_by'   => array($orderby => $order),
+			'limit'      => $limit . ',' . $per_page,
+			'force_join' => array('Term'),
+		);
+
+		$categories = $count ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
+			: EEM_Term_Taxonomy::instance()->get_all($query_params);
+
+		return $categories;
+	}
+
+
+	/* end category stuff */
+	/**************/
 }

Spacing +43 added lines, -43 removed lines

@@ -45,10 +45,10 @@ 
 
     protected function _init_page_props()
     {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
+        require_once(EE_MODELS.'EEM_Venue.model.php');
         $this->page_slug = EE_VENUES_PG_SLUG;
         $this->_admin_base_url = EE_VENUES_ADMIN_URL;
-        $this->_admin_base_path = EE_ADMIN_PAGES . 'venues';
+        $this->_admin_base_path = EE_ADMIN_PAGES.'venues';
         $this->page_label = __('Event Venues', 'event_espresso');
         $this->_cpt_model_names = array(
             'create_new' => 'EEM_Venue',
@@ -458,7 +458,7 @@ 
 
     public function load_scripts_styles()
     {
-        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
+        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL.'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('ee-cat-admin');
     }
 
@@ -480,7 +480,7 @@ 
         wp_enqueue_style('espresso-ui-theme');
         wp_register_style(
             'espresso_venues',
-            EE_VENUES_ASSETS_URL . 'ee-venues-admin.css',
+            EE_VENUES_ASSETS_URL.'ee-venues-admin.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );
@@ -539,7 +539,7 @@ 
             __("View Venue Archive Page", "event_espresso"),
             'button'
         );
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button('create_new', 'add', array(), 'add-new-h2');
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button('create_new', 'add', array(), 'add-new-h2');
         $this->_search_btn_label = __('Venues', 'event_espresso');
         $this->display_admin_list_table_page_with_sidebar();
     }
@@ -552,7 +552,7 @@ 
             'vnu_url'      => $this->_cpt_model_obj->get_f('VNU_url'),
             'vnu_phone'    => $this->_cpt_model_obj->get_f('VNU_phone'),
         );
-        $template = EE_VENUES_TEMPLATE_PATH . 'venue_publish_box_extras.template.php';
+        $template = EE_VENUES_TEMPLATE_PATH.'venue_publish_box_extras.template.php';
         EEH_Template::display_template($template, $extra_rows);
     }
 
@@ -569,21 +569,21 @@ 
         $default_map_settings->use_google_maps = true;
         $default_map_settings->google_map_api_key = '';
         // for event details pages (reg page)
-        $default_map_settings->event_details_map_width = 585;            // ee_map_width_single
-        $default_map_settings->event_details_map_height = 362;            // ee_map_height_single
-        $default_map_settings->event_details_map_zoom = 14;            // ee_map_zoom_single
-        $default_map_settings->event_details_display_nav = true;            // ee_map_nav_display_single
-        $default_map_settings->event_details_nav_size = false;            // ee_map_nav_size_single
-        $default_map_settings->event_details_control_type = 'default';        // ee_map_type_control_single
-        $default_map_settings->event_details_map_align = 'center';            // ee_map_align_single
+        $default_map_settings->event_details_map_width = 585; // ee_map_width_single
+        $default_map_settings->event_details_map_height = 362; // ee_map_height_single
+        $default_map_settings->event_details_map_zoom = 14; // ee_map_zoom_single
+        $default_map_settings->event_details_display_nav = true; // ee_map_nav_display_single
+        $default_map_settings->event_details_nav_size = false; // ee_map_nav_size_single
+        $default_map_settings->event_details_control_type = 'default'; // ee_map_type_control_single
+        $default_map_settings->event_details_map_align = 'center'; // ee_map_align_single
         // for event list pages
-        $default_map_settings->event_list_map_width = 300;            // ee_map_width
-        $default_map_settings->event_list_map_height = 185;        // ee_map_height
-        $default_map_settings->event_list_map_zoom = 12;            // ee_map_zoom
-        $default_map_settings->event_list_display_nav = false;        // ee_map_nav_display
-        $default_map_settings->event_list_nav_size = true;            // ee_map_nav_size
-        $default_map_settings->event_list_control_type = 'dropdown';        // ee_map_type_control
-        $default_map_settings->event_list_map_align = 'center';            // ee_map_align
+        $default_map_settings->event_list_map_width = 300; // ee_map_width
+        $default_map_settings->event_list_map_height = 185; // ee_map_height
+        $default_map_settings->event_list_map_zoom = 12; // ee_map_zoom
+        $default_map_settings->event_list_display_nav = false; // ee_map_nav_display
+        $default_map_settings->event_list_nav_size = true; // ee_map_nav_size
+        $default_map_settings->event_list_control_type = 'dropdown'; // ee_map_type_control
+        $default_map_settings->event_list_map_align = 'center'; // ee_map_align
 
         $this->_template_args['map_settings'] =
             isset(EE_Registry::instance()->CFG->map_settings)
@@ -597,7 +597,7 @@ 
         $this->_set_add_edit_form_tags('update_google_map_settings');
         $this->_set_publish_post_box_vars(null, false, false, null, false);
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_VENUES_TEMPLATE_PATH . 'google_map.template.php',
+            EE_VENUES_TEMPLATE_PATH.'google_map.template.php',
             $this->_template_args,
             true
         );
@@ -745,7 +745,7 @@ 
             ),
             'vnu_google_map_link' => $this->_cpt_model_obj->google_map_link(),
         );
-        $template = EE_VENUES_TEMPLATE_PATH . 'venue_gmap_metabox_content.template.php';
+        $template = EE_VENUES_TEMPLATE_PATH.'venue_gmap_metabox_content.template.php';
         EEH_Template::display_template($template, $template_args);
     }
 
@@ -786,7 +786,7 @@ 
             )
         );
 
-        $template = EE_VENUES_TEMPLATE_PATH . 'venue_address_metabox_content.template.php';
+        $template = EE_VENUES_TEMPLATE_PATH.'venue_address_metabox_content.template.php';
         EEH_Template::display_template($template, $template_args);
     }
 
@@ -796,7 +796,7 @@ 
         $template_args = array(
             '_venue' => $this->_cpt_model_obj,
         );
-        $template = EE_VENUES_TEMPLATE_PATH . 'venue_virtual_location_metabox_content.template.php';
+        $template = EE_VENUES_TEMPLATE_PATH.'venue_virtual_location_metabox_content.template.php';
         EEH_Template::display_template($template, $template_args);
     }
 
@@ -821,7 +821,7 @@ 
     {
 
         if ($post instanceof WP_Post && $post->post_type !== 'espresso_venues') {
-            return;// get out we're not processing the saving of venues.
+            return; // get out we're not processing the saving of venues.
         }
 
         $wheres = array($this->_venue_model->primary_key_name() => $post_id);
@@ -929,7 +929,7 @@ 
             // clean status
             $venue_status = sanitize_key($venue_status);
             // grab status
-            if (! empty($venue_status)) {
+            if ( ! empty($venue_status)) {
                 $success = $this->_change_venue_status($VNU_ID, $venue_status);
             } else {
                 $success = false;
@@ -960,7 +960,7 @@ 
         // clean status
         $venue_status = sanitize_key($venue_status);
         // grab status
-        if (! empty($venue_status)) {
+        if ( ! empty($venue_status)) {
             $success = true;
             // determine the event id and set to array.
             $VNU_IDs = isset($this->_req_data['venue_id']) ? (array) $this->_req_data['venue_id'] : array();
@@ -1011,7 +1011,7 @@ 
     private function _change_venue_status($VNU_ID = 0, $venue_status = '')
     {
         // grab venue id
-        if (! $VNU_ID) {
+        if ( ! $VNU_ID) {
             $msg = __('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
@@ -1022,7 +1022,7 @@ 
         // clean status
         $venue_status = sanitize_key($venue_status);
         // grab status
-        if (! $venue_status) {
+        if ( ! $venue_status) {
             $msg = __('An error occurred. No Venue Status or an invalid Venue Status was received.', 'event_espresso');
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
@@ -1120,7 +1120,7 @@ 
     private function _delete_or_trash_venue($VNU_ID = false)
     {
         // grab event id
-        if (! $VNU_ID = absint($VNU_ID)) {
+        if ( ! $VNU_ID = absint($VNU_ID)) {
             $msg = __('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
@@ -1207,10 +1207,10 @@ 
         }
 
 
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_venues', 'get_venues')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_venues', 'get_venues')) {
             $where['VNU_wp_user'] = get_current_user_id();
         } else {
-            if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')) {
+            if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')) {
                 $where['OR'] = array(
                     'status*restrict_private' => array('!=', 'private'),
                     'AND'                     => array(
@@ -1223,7 +1223,7 @@ 
 
 
         if (isset($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
+            $sstr = '%'.$this->_req_data['s'].'%';
             $where['OR'] = array(
                 'VNU_name'               => array('LIKE', $sstr),
                 'VNU_desc'               => array('LIKE', $sstr),
@@ -1275,7 +1275,7 @@ 
         $this->_set_empty_category_object();
 
         // only set if we've got an id
-        if (! isset($this->_req_data['VEN_CAT_ID'])) {
+        if ( ! isset($this->_req_data['VEN_CAT_ID'])) {
             return;
         }
 
@@ -1283,7 +1283,7 @@ 
         $term = get_term($category_id, 'espresso_venue_categories');
 
 
-        if (! empty($term)) {
+        if ( ! empty($term)) {
             $this->_category->category_name = $term->name;
             $this->_category->category_identifier = $term->slug;
             $this->_category->category_desc = $term->description;
@@ -1304,7 +1304,7 @@ 
     protected function _category_list_table()
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
             'add_category',
             'add_category',
             array(),
@@ -1379,7 +1379,7 @@ 
             'disable'                  => '',
             'disabled_message'         => false,
         );
-        $template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+        $template = EVENTS_TEMPLATE_PATH.'event_category_details.template.php';
         return EEH_Template::display_template($template, $template_args, true);
     }
 
@@ -1453,7 +1453,7 @@ 
                 $term_args
             );
 
-        if (! is_array($insert_ids)) {
+        if ( ! is_array($insert_ids)) {
             $msg = __('An error occurred and the category has not been saved to the database.', 'event_espresso');
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
         } else {
@@ -1483,8 +1483,8 @@ 
 
         $this->_req_data = array_merge($this->_req_data, $new_request_args);
 
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
+        if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+            require_once(EE_CLASSES.'EE_Export.class.php');
             $EE_Export = EE_Export::instance($this->_req_data);
             $EE_Export->export();
         }
@@ -1494,7 +1494,7 @@ 
     protected function _import_categories()
     {
 
-        require_once(EE_CLASSES . 'EE_Import.class.php');
+        require_once(EE_CLASSES.'EE_Import.class.php');
         EE_Import::instance()->import();
     }
 
@@ -1508,7 +1508,7 @@ 
         $limit = ($current_page - 1) * $per_page;
         $where = array('taxonomy' => 'espresso_venue_categories');
         if (isset($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
+            $sstr = '%'.$this->_req_data['s'].'%';
             $where['OR'] = array(
                 'Term.name'   => array('LIKE', $sstr),
                 'description' => array('LIKE', $sstr),
@@ -1518,7 +1518,7 @@ 
         $query_params = array(
             $where,
             'order_by'   => array($orderby => $order),
-            'limit'      => $limit . ',' . $per_page,
+            'limit'      => $limit.','.$per_page,
             'force_join' => array('Term'),
         );
 

caffeinated/admin/extend/events/Extend_Events_Admin_Page.core.php

Doc Comments +3 added lines, -3 removed lines

@@ -342,7 +342,7 @@ 
      *
      * @param $template
      * @param $template_args
-     * @return mixed
+     * @return string
      * @throws DomainException
      */
     public function add_additional_datetime_button($template, $template_args)
@@ -360,7 +360,7 @@ 
      *
      * @param $template
      * @param $template_args
-     * @return mixed
+     * @return string
      * @throws DomainException
      */
     public function add_datetime_clone_button($template, $template_args)
@@ -378,7 +378,7 @@ 
      *
      * @param $template
      * @param $template_args
-     * @return mixed
+     * @return string
      * @throws DomainException
      */
     public function datetime_timezones_template($template, $template_args)

Indentation +1253 added lines, -1253 removed lines

@@ -16,1257 +16,1257 @@
 {
 
 
-    /**
-     * Extend_Events_Admin_Page constructor.
-     *
-     * @param bool $routing
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        if (! defined('EVENTS_CAF_TEMPLATE_PATH')) {
-            define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'events/templates/');
-            define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'events/assets/');
-            define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'events/assets/');
-        }
-    }
-
-
-    /**
-     * Sets routes.
-     */
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'events';
-        // is there a evt_id in the request?
-        $evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
-            ? $this->_req_data['EVT_ID']
-            : 0;
-        $evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id;
-        // tkt_id?
-        $tkt_id = ! empty($this->_req_data['TKT_ID']) && ! is_array($this->_req_data['TKT_ID'])
-            ? $this->_req_data['TKT_ID']
-            : 0;
-        $new_page_routes = array(
-            'duplicate_event'          => array(
-                'func'       => '_duplicate_event',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ),
-            'ticket_list_table'        => array(
-                'func'       => '_tickets_overview_list_table',
-                'capability' => 'ee_read_default_tickets',
-            ),
-            'trash_ticket'             => array(
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_ticket',
-                'obj_id'     => $tkt_id,
-                'noheader'   => true,
-                'args'       => array('trash' => true),
-            ),
-            'trash_tickets'            => array(
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_tickets',
-                'noheader'   => true,
-                'args'       => array('trash' => true),
-            ),
-            'restore_ticket'           => array(
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_ticket',
-                'obj_id'     => $tkt_id,
-                'noheader'   => true,
-            ),
-            'restore_tickets'          => array(
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_tickets',
-                'noheader'   => true,
-            ),
-            'delete_ticket'            => array(
-                'func'       => '_delete_ticket',
-                'capability' => 'ee_delete_default_ticket',
-                'obj_id'     => $tkt_id,
-                'noheader'   => true,
-            ),
-            'delete_tickets'           => array(
-                'func'       => '_delete_ticket',
-                'capability' => 'ee_delete_default_tickets',
-                'noheader'   => true,
-            ),
-            'import_page'              => array(
-                'func'       => '_import_page',
-                'capability' => 'import',
-            ),
-            'import'                   => array(
-                'func'       => '_import_events',
-                'capability' => 'import',
-                'noheader'   => true,
-            ),
-            'import_events'            => array(
-                'func'       => '_import_events',
-                'capability' => 'import',
-                'noheader'   => true,
-            ),
-            'export_events'            => array(
-                'func'       => '_events_export',
-                'capability' => 'export',
-                'noheader'   => true,
-            ),
-            'export_categories'        => array(
-                'func'       => '_categories_export',
-                'capability' => 'export',
-                'noheader'   => true,
-            ),
-            'sample_export_file'       => array(
-                'func'       => '_sample_export_file',
-                'capability' => 'export',
-                'noheader'   => true,
-            ),
-            'update_template_settings' => array(
-                'func'       => '_update_template_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-        );
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-        // partial route/config override
-        $this->_page_config['import_events']['metaboxes'] = $this->_default_espresso_metaboxes;
-        $this->_page_config['create_new']['metaboxes'][] = '_premium_event_editor_meta_boxes';
-        $this->_page_config['create_new']['qtips'][] = 'EE_Event_Editor_Tips';
-        $this->_page_config['edit']['qtips'][] = 'EE_Event_Editor_Tips';
-        $this->_page_config['edit']['metaboxes'][] = '_premium_event_editor_meta_boxes';
-        $this->_page_config['default']['list_table'] = 'Extend_Events_Admin_List_Table';
-        // add tickets tab but only if there are more than one default ticket!
-        $tkt_count = EEM_Ticket::instance()->count_deleted_and_undeleted(
-            array(array('TKT_is_default' => 1)),
-            'TKT_ID',
-            true
-        );
-        if ($tkt_count > 1) {
-            $new_page_config = array(
-                'ticket_list_table' => array(
-                    'nav'           => array(
-                        'label' => esc_html__('Default Tickets', 'event_espresso'),
-                        'order' => 60,
-                    ),
-                    'list_table'    => 'Tickets_List_Table',
-                    'require_nonce' => false,
-                ),
-            );
-        }
-        // template settings
-        $new_page_config['template_settings'] = array(
-            'nav'           => array(
-                'label' => esc_html__('Templates', 'event_espresso'),
-                'order' => 30,
-            ),
-            'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-            'help_tabs'     => array(
-                'general_settings_templates_help_tab' => array(
-                    'title'    => esc_html__('Templates', 'event_espresso'),
-                    'filename' => 'general_settings_templates',
-                ),
-            ),
-            'help_tour'     => array('Templates_Help_Tour'),
-            'require_nonce' => false,
-        );
-        $this->_page_config = array_merge($this->_page_config, $new_page_config);
-        // add filters and actions
-        // modifying _views
-        add_filter(
-            'FHEE_event_datetime_metabox_add_additional_date_time_template',
-            array($this, 'add_additional_datetime_button'),
-            10,
-            2
-        );
-        add_filter(
-            'FHEE_event_datetime_metabox_clone_button_template',
-            array($this, 'add_datetime_clone_button'),
-            10,
-            2
-        );
-        add_filter(
-            'FHEE_event_datetime_metabox_timezones_template',
-            array($this, 'datetime_timezones_template'),
-            10,
-            2
-        );
-        // filters for event list table
-        add_filter('FHEE__Extend_Events_Admin_List_Table__filters', array($this, 'list_table_filters'), 10, 2);
-        add_filter(
-            'FHEE__Events_Admin_List_Table__column_actions__action_links',
-            array($this, 'extra_list_table_actions'),
-            10,
-            2
-        );
-        // legend item
-        add_filter('FHEE__Events_Admin_Page___event_legend_items__items', array($this, 'additional_legend_items'));
-        add_action('admin_init', array($this, 'admin_init'));
-    }
-
-
-    /**
-     * admin_init
-     */
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings = array_merge(
-            EE_Registry::$i18n_js_strings,
-            array(
-                'image_confirm'          => esc_html__(
-                    'Do you really want to delete this image? Please remember to update your event to complete the removal.',
-                    'event_espresso'
-                ),
-                'event_starts_on'        => esc_html__('Event Starts on', 'event_espresso'),
-                'event_ends_on'          => esc_html__('Event Ends on', 'event_espresso'),
-                'event_datetime_actions' => esc_html__('Actions', 'event_espresso'),
-                'event_clone_dt_msg'     => esc_html__('Clone this Event Date and Time', 'event_espresso'),
-                'remove_event_dt_msg'    => esc_html__('Remove this Event Time', 'event_espresso'),
-            )
-        );
-    }
-
-
-    /**
-     * Add per page screen options to the default ticket list table view.
-     */
-    protected function _add_screen_options_ticket_list_table()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * @param string $return
-     * @param int    $id
-     * @param string $new_title
-     * @param string $new_slug
-     * @return string
-     */
-    public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
-    {
-        $return = parent::extra_permalink_field_buttons($return, $id, $new_title, $new_slug);
-        // make sure this is only when editing
-        if (! empty($id)) {
-            $href = EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'duplicate_event', 'EVT_ID' => $id),
-                $this->_admin_base_url
-            );
-            $title = esc_attr__('Duplicate Event', 'event_espresso');
-            $return .= '<a href="'
-                       . $href
-                       . '" title="'
-                       . $title
-                       . '" id="ee-duplicate-event-button" class="button button-small"  value="duplicate_event">'
-                       . $title
-                       . '</a>';
-        }
-        return $return;
-    }
-
-
-    /**
-     * Set the list table views for the default ticket list table view.
-     */
-    public function _set_list_table_views_ticket_list_table()
-    {
-        $this->_views = array(
-            'all'     => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_tickets' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-            'trashed' => array(
-                'slug'        => 'trashed',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'restore_tickets' => esc_html__('Restore from Trash', 'event_espresso'),
-                    'delete_tickets'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * Enqueue scripts and styles for the event editor.
-     */
-    public function load_scripts_styles_edit()
-    {
-        wp_register_script(
-            'ee-event-editor-heartbeat',
-            EVENTS_CAF_ASSETS_URL . 'event-editor-heartbeat.js',
-            array('ee_admin_js', 'heartbeat'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-accounting');
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_enqueue_script('event_editor_js');
-        wp_enqueue_script('ee-event-editor-heartbeat');
-    }
-
-
-    /**
-     * Returns template for the additional datetime.
-     *
-     * @param $template
-     * @param $template_args
-     * @return mixed
-     * @throws DomainException
-     */
-    public function add_additional_datetime_button($template, $template_args)
-    {
-        return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_add_additional_time.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * Returns the template for cloning a datetime.
-     *
-     * @param $template
-     * @param $template_args
-     * @return mixed
-     * @throws DomainException
-     */
-    public function add_datetime_clone_button($template, $template_args)
-    {
-        return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_metabox_clone_button.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * Returns the template for datetime timezones.
-     *
-     * @param $template
-     * @param $template_args
-     * @return mixed
-     * @throws DomainException
-     */
-    public function datetime_timezones_template($template, $template_args)
-    {
-        return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_timezones.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * Sets the views for the default list table view.
-     */
-    protected function _set_list_table_views_default()
-    {
-        parent::_set_list_table_views_default();
-        $new_views = array(
-            'today' => array(
-                'slug'        => 'today',
-                'label'       => esc_html__('Today', 'event_espresso'),
-                'count'       => $this->total_events_today(),
-                'bulk_action' => array(
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-            'month' => array(
-                'slug'        => 'month',
-                'label'       => esc_html__('This Month', 'event_espresso'),
-                'count'       => $this->total_events_this_month(),
-                'bulk_action' => array(
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-        );
-        $this->_views = array_merge($this->_views, $new_views);
-    }
-
-
-    /**
-     * Returns the extra action links for the default list table view.
-     *
-     * @param array     $action_links
-     * @param \EE_Event $event
-     * @return array
-     * @throws EE_Error
-     */
-    public function extra_list_table_actions(array $action_links, \EE_Event $event)
-    {
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registrations',
-            'espresso_registrations_reports',
-            $event->ID()
-        )
-        ) {
-            $reports_query_args = array(
-                'action' => 'reports',
-                'EVT_ID' => $event->ID(),
-            );
-            $reports_link = EE_Admin_Page::add_query_args_and_nonce($reports_query_args, REG_ADMIN_URL);
-            $action_links[] = '<a href="'
-                              . $reports_link
-                              . '" title="'
-                              . esc_attr__('View Report', 'event_espresso')
-                              . '"><div class="dashicons dashicons-chart-bar"></div></a>'
-                              . "\n\t";
-        }
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
-            EE_Registry::instance()->load_helper('MSG_Template');
-            $action_links[] = EEH_MSG_Template::get_message_action_link(
-                'see_notifications_for',
-                null,
-                array('EVT_ID' => $event->ID())
-            );
-        }
-        return $action_links;
-    }
-
-
-    /**
-     * @param $items
-     * @return mixed
-     */
-    public function additional_legend_items($items)
-    {
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registrations',
-            'espresso_registrations_reports'
-        )
-        ) {
-            $items['reports'] = array(
-                'class' => 'dashicons dashicons-chart-bar',
-                'desc'  => esc_html__('Event Reports', 'event_espresso'),
-            );
-        }
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
-            $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
-            if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
-                $items['view_related_messages'] = array(
-                    'class' => $related_for_icon['css_class'],
-                    'desc'  => $related_for_icon['label'],
-                );
-            }
-        }
-        return $items;
-    }
-
-
-    /**
-     * This is the callback method for the duplicate event route
-     * Method looks for 'EVT_ID' in the request and retrieves that event and its details and duplicates them
-     * into a new event.  We add a hook so that any plugins that add extra event details can hook into this
-     * action.  Note that the dupe will have **DUPLICATE** as its title and slug.
-     * After duplication the redirect is to the new event edit page.
-     *
-     * @return void
-     * @access protected
-     * @throws EE_Error If EE_Event is not available with given ID
-     */
-    protected function _duplicate_event()
-    {
-        // first make sure the ID for the event is in the request.
-        //  If it isn't then we need to bail and redirect back to overview list table (cause how did we get here?)
-        if (! isset($this->_req_data['EVT_ID'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'In order to duplicate an event an Event ID is required.  None was given.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_redirect_after_action(false, '', '', array(), true);
-            return;
-        }
-        // k we've got EVT_ID so let's use that to get the event we'll duplicate
-        $orig_event = EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID']);
-        if (! $orig_event instanceof EE_Event) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('An EE_Event object could not be retrieved for the given ID (%s)', 'event_espresso'),
-                    $this->_req_data['EVT_ID']
-                )
-            );
-        }
-        // k now let's clone the $orig_event before getting relations
-        $new_event = clone $orig_event;
-        // original datetimes
-        $orig_datetimes = $orig_event->get_many_related('Datetime');
-        // other original relations
-        $orig_ven = $orig_event->get_many_related('Venue');
-        // reset the ID and modify other details to make it clear this is a dupe
-        $new_event->set('EVT_ID', 0);
-        $new_name = $new_event->name() . ' ' . esc_html__('**DUPLICATE**', 'event_espresso');
-        $new_event->set('EVT_name', $new_name);
-        $new_event->set(
-            'EVT_slug',
-            wp_unique_post_slug(
-                sanitize_title($orig_event->name()),
-                0,
-                'publish',
-                'espresso_events',
-                0
-            )
-        );
-        $new_event->set('status', 'draft');
-        // duplicate discussion settings
-        $new_event->set('comment_status', $orig_event->get('comment_status'));
-        $new_event->set('ping_status', $orig_event->get('ping_status'));
-        // save the new event
-        $new_event->save();
-        // venues
-        foreach ($orig_ven as $ven) {
-            $new_event->_add_relation_to($ven, 'Venue');
-        }
-        $new_event->save();
-        // now we need to get the question group relations and handle that
-        // first primary question groups
-        $orig_primary_qgs = $orig_event->get_many_related(
-            'Question_Group',
-            array(array('Event_Question_Group.EQG_primary' => 1))
-        );
-        if (! empty($orig_primary_qgs)) {
-            foreach ($orig_primary_qgs as $id => $obj) {
-                if ($obj instanceof EE_Question_Group) {
-                    $new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 1));
-                }
-            }
-        }
-        // next additional attendee question groups
-        $orig_additional_qgs = $orig_event->get_many_related(
-            'Question_Group',
-            array(array('Event_Question_Group.EQG_primary' => 0))
-        );
-        if (! empty($orig_additional_qgs)) {
-            foreach ($orig_additional_qgs as $id => $obj) {
-                if ($obj instanceof EE_Question_Group) {
-                    $new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 0));
-                }
-            }
-        }
-
-        $new_event->save();
-
-        // k now that we have the new event saved we can loop through the datetimes and start adding relations.
-        $cloned_tickets = array();
-        foreach ($orig_datetimes as $orig_dtt) {
-            if (! $orig_dtt instanceof EE_Datetime) {
-                continue;
-            }
-            $new_dtt = clone $orig_dtt;
-            $orig_tkts = $orig_dtt->tickets();
-            // save new dtt then add to event
-            $new_dtt->set('DTT_ID', 0);
-            $new_dtt->set('DTT_sold', 0);
-            $new_dtt->set_reserved(0);
-            $new_dtt->save();
-            $new_event->_add_relation_to($new_dtt, 'Datetime');
-            $new_event->save();
-            // now let's get the ticket relations setup.
-            foreach ((array) $orig_tkts as $orig_tkt) {
-                // it's possible a datetime will have no tickets so let's verify we HAVE a ticket first.
-                if (! $orig_tkt instanceof EE_Ticket) {
-                    continue;
-                }
-                // is this ticket archived?  If it is then let's skip
-                if ($orig_tkt->get('TKT_deleted')) {
-                    continue;
-                }
-                // does this original ticket already exist in the clone_tickets cache?
-                //  If so we'll just use the new ticket from it.
-                if (isset($cloned_tickets[ $orig_tkt->ID() ])) {
-                    $new_tkt = $cloned_tickets[ $orig_tkt->ID() ];
-                } else {
-                    $new_tkt = clone $orig_tkt;
-                    // get relations on the $orig_tkt that we need to setup.
-                    $orig_prices = $orig_tkt->prices();
-                    $new_tkt->set('TKT_ID', 0);
-                    $new_tkt->set('TKT_sold', 0);
-                    $new_tkt->set('TKT_reserved', 0);
-                    $new_tkt->save(); // make sure new ticket has ID.
-                    // price relations on new ticket need to be setup.
-                    foreach ($orig_prices as $orig_price) {
-                        $new_price = clone $orig_price;
-                        $new_price->set('PRC_ID', 0);
-                        $new_price->save();
-                        $new_tkt->_add_relation_to($new_price, 'Price');
-                        $new_tkt->save();
-                    }
-
-                    do_action(
-                        'AHEE__Extend_Events_Admin_Page___duplicate_event__duplicate_ticket__after',
-                        $orig_tkt,
-                        $new_tkt,
-                        $orig_prices,
-                        $orig_event,
-                        $orig_dtt,
-                        $new_dtt
-                    );
-                }
-                // k now we can add the new ticket as a relation to the new datetime
-                // and make sure its added to our cached $cloned_tickets array
-                // for use with later datetimes that have the same ticket.
-                $new_dtt->_add_relation_to($new_tkt, 'Ticket');
-                $new_dtt->save();
-                $cloned_tickets[ $orig_tkt->ID() ] = $new_tkt;
-            }
-        }
-        // clone taxonomy information
-        $taxonomies_to_clone_with = apply_filters(
-            'FHEE__Extend_Events_Admin_Page___duplicate_event__taxonomies_to_clone',
-            array('espresso_event_categories', 'espresso_event_type', 'post_tag')
-        );
-        // get terms for original event (notice)
-        $orig_terms = wp_get_object_terms($orig_event->ID(), $taxonomies_to_clone_with);
-        // loop through terms and add them to new event.
-        foreach ($orig_terms as $term) {
-            wp_set_object_terms($new_event->ID(), $term->term_id, $term->taxonomy, true);
-        }
-
-        // duplicate other core WP_Post items for this event.
-        // post thumbnail (feature image).
-        $feature_image_id = get_post_thumbnail_id($orig_event->ID());
-        if ($feature_image_id) {
-            update_post_meta($new_event->ID(), '_thumbnail_id', $feature_image_id);
-        }
-
-        // duplicate page_template setting
-        $page_template = get_post_meta($orig_event->ID(), '_wp_page_template', true);
-        if ($page_template) {
-            update_post_meta($new_event->ID(), '_wp_page_template', $page_template);
-        }
-
-        do_action('AHEE__Extend_Events_Admin_Page___duplicate_event__after', $new_event, $orig_event);
-        // now let's redirect to the edit page for this duplicated event if we have a new event id.
-        if ($new_event->ID()) {
-            $redirect_args = array(
-                'post'   => $new_event->ID(),
-                'action' => 'edit',
-            );
-            EE_Error::add_success(
-                esc_html__(
-                    'Event successfully duplicated.  Please review the details below and make any necessary edits',
-                    'event_espresso'
-                )
-            );
-        } else {
-            $redirect_args = array(
-                'action' => 'default',
-            );
-            EE_Error::add_error(
-                esc_html__('Not able to duplicate event.  Something went wrong.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $this->_redirect_after_action(false, '', '', $redirect_args, true);
-    }
-
-
-    /**
-     * Generates output for the import page.
-     *
-     * @throws DomainException
-     */
-    protected function _import_page()
-    {
-        $title = esc_html__('Import', 'event_espresso');
-        $intro = esc_html__(
-            'If you have a previously exported Event Espresso 4 information in a Comma Separated Value (CSV) file format, you can upload the file here: ',
-            'event_espresso'
-        );
-        $form_url = EVENTS_ADMIN_URL;
-        $action = 'import_events';
-        $type = 'csv';
-        $this->_template_args['form'] = EE_Import::instance()->upload_form(
-            $title,
-            $intro,
-            $form_url,
-            $action,
-            $type
-        );
-        $this->_template_args['sample_file_link'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'sample_export_file'),
-            $this->_admin_base_url
-        );
-        $content = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'import_page.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->_template_args['admin_page_content'] = $content;
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * _import_events
-     * This handles displaying the screen and running imports for importing events.
-     *
-     * @return void
-     */
-    protected function _import_events()
-    {
-        require_once(EE_CLASSES . 'EE_Import.class.php');
-        $success = EE_Import::instance()->import();
-        $this->_redirect_after_action($success, 'Import File', 'ran', array('action' => 'import_page'), true);
-    }
-
-
-    /**
-     * _events_export
-     * Will export all (or just the given event) to a Excel compatible file.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _events_export()
-    {
-        if (isset($this->_req_data['EVT_ID'])) {
-            $event_ids = $this->_req_data['EVT_ID'];
-        } elseif (isset($this->_req_data['EVT_IDs'])) {
-            $event_ids = $this->_req_data['EVT_IDs'];
-        } else {
-            $event_ids = null;
-        }
-        // todo: I don't like doing this but it'll do until we modify EE_Export Class.
-        $new_request_args = array(
-            'export' => 'report',
-            'action' => 'all_event_data',
-            'EVT_ID' => $event_ids,
-        );
-        $this->_req_data = array_merge($this->_req_data, $new_request_args);
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->_req_data);
-            $EE_Export->export();
-        }
-    }
-
-
-    /**
-     * handle category exports()
-     *
-     * @return void
-     */
-    protected function _categories_export()
-    {
-        // todo: I don't like doing this but it'll do until we modify EE_Export Class.
-        $new_request_args = array(
-            'export'       => 'report',
-            'action'       => 'categories',
-            'category_ids' => $this->_req_data['EVT_CAT_ID'],
-        );
-        $this->_req_data = array_merge($this->_req_data, $new_request_args);
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->_req_data);
-            $EE_Export->export();
-        }
-    }
-
-
-    /**
-     * Creates a sample CSV file for importing
-     */
-    protected function _sample_export_file()
-    {
-        // require_once(EE_CLASSES . 'EE_Export.class.php');
-        EE_Export::instance()->export_sample();
-    }
-
-
-    /*************        Template Settings        *************/
-    /**
-     * Generates template settings page output
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _template_settings()
-    {
-        $this->_template_args['values'] = $this->_yes_no_values;
-        /**
-         * Note leaving this filter in for backward compatibility this was moved in 4.6.x
-         * from General_Settings_Admin_Page to here.
-         */
-        $this->_template_args = apply_filters(
-            'FHEE__General_Settings_Admin_Page__template_settings__template_args',
-            $this->_template_args
-        );
-        $this->_set_add_edit_form_tags('update_template_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'template_settings.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Handler for updating template settings.
-     *
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function _update_template_settings()
-    {
-        /**
-         * Note leaving this filter in for backward compatibility this was moved in 4.6.x
-         * from General_Settings_Admin_Page to here.
-         */
-        EE_Registry::instance()->CFG->template_settings = apply_filters(
-            'FHEE__General_Settings_Admin_Page__update_template_settings__data',
-            EE_Registry::instance()->CFG->template_settings,
-            $this->_req_data
-        );
-        // update custom post type slugs and detect if we need to flush rewrite rules
-        $old_slug = EE_Registry::instance()->CFG->core->event_cpt_slug;
-        EE_Registry::instance()->CFG->core->event_cpt_slug = empty($this->_req_data['event_cpt_slug'])
-            ? EE_Registry::instance()->CFG->core->event_cpt_slug
-            : EEH_URL::slugify($this->_req_data['event_cpt_slug'], 'events');
-        $what = 'Template Settings';
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG->template_settings,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        if (EE_Registry::instance()->CFG->core->event_cpt_slug != $old_slug) {
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flush();
-        }
-        $this->_redirect_after_action($success, $what, 'updated', array('action' => 'template_settings'));
-    }
-
-
-    /**
-     * _premium_event_editor_meta_boxes
-     * add all metaboxes related to the event_editor
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _premium_event_editor_meta_boxes()
-    {
-        $this->verify_cpt_object();
-        add_meta_box(
-            'espresso_event_editor_event_options',
-            esc_html__('Event Registration Options', 'event_espresso'),
-            array($this, 'registration_options_meta_box'),
-            $this->page_slug,
-            'side',
-            'core'
-        );
-    }
-
-
-    /**
-     * override caf metabox
-     *
-     * @return void
-     * @throws DomainException
-     */
-    public function registration_options_meta_box()
-    {
-        $yes_no_values = array(
-            array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')),
-            array('id' => false, 'text' => esc_html__('No', 'event_espresso')),
-        );
-        $default_reg_status_values = EEM_Registration::reg_status_array(
-            array(
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_wait_list,
-            ),
-            true
-        );
-        $template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
-        $template_args['_event'] = $this->_cpt_model_obj;
-        $template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
-        $template_args['default_registration_status'] = EEH_Form_Fields::select_input(
-            'default_reg_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['display_description'] = EEH_Form_Fields::select_input(
-            'display_desc',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_description()
-        );
-        $template_args['display_ticket_selector'] = EEH_Form_Fields::select_input(
-            'display_ticket_selector',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_ticket_selector(),
-            '',
-            '',
-            false
-        );
-        $template_args['EVT_default_registration_status'] = EEH_Form_Fields::select_input(
-            'EVT_default_registration_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['additional_registration_options'] = apply_filters(
-            'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
-            '',
-            $template_args,
-            $yes_no_values,
-            $default_reg_status_values
-        );
-        EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_registration_options.template.php',
-            $template_args
-        );
-    }
-
-
-
-    /**
-     * wp_list_table_mods for caf
-     * ============================
-     */
-    /**
-     * hook into list table filters and provide filters for caffeinated list table
-     *
-     * @param  array $old_filters    any existing filters present
-     * @param  array $list_table_obj the list table object
-     * @return array                  new filters
-     */
-    public function list_table_filters($old_filters, $list_table_obj)
-    {
-        $filters = array();
-        // first month/year filters
-        $filters[] = $this->espresso_event_months_dropdown();
-        $status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
-        // active status dropdown
-        if ($status !== 'draft') {
-            $filters[] = $this->active_status_dropdown(
-                isset($this->_req_data['active_status']) ? $this->_req_data['active_status'] : ''
-            );
-        }
-        // category filter
-        $filters[] = $this->category_dropdown();
-        return array_merge($old_filters, $filters);
-    }
-
-
-    /**
-     * espresso_event_months_dropdown
-     *
-     * @access public
-     * @return string                dropdown listing month/year selections for events.
-     */
-    public function espresso_event_months_dropdown()
-    {
-        // what we need to do is get all PRIMARY datetimes for all events to filter on.
-        // Note we need to include any other filters that are set!
-        $status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
-        // categories?
-        $category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
-            ? $this->_req_data['EVT_CAT']
-            : null;
-        // active status?
-        $active_status = isset($this->_req_data['active_status']) ? $this->_req_data['active_status'] : null;
-        $cur_date = isset($this->_req_data['month_range']) ? $this->_req_data['month_range'] : '';
-        return EEH_Form_Fields::generate_event_months_dropdown($cur_date, $status, $category, $active_status);
-    }
-
-
-    /**
-     * returns a list of "active" statuses on the event
-     *
-     * @param  string $current_value whatever the current active status is
-     * @return string
-     */
-    public function active_status_dropdown($current_value = '')
-    {
-        $select_name = 'active_status';
-        $values = array(
-            'none'     => esc_html__('Show Active/Inactive', 'event_espresso'),
-            'active'   => esc_html__('Active', 'event_espresso'),
-            'upcoming' => esc_html__('Upcoming', 'event_espresso'),
-            'expired'  => esc_html__('Expired', 'event_espresso'),
-            'inactive' => esc_html__('Inactive', 'event_espresso'),
-        );
-        $id = 'id="espresso-active-status-dropdown-filter"';
-        $class = 'wide';
-        return EEH_Form_Fields::select_input($select_name, $values, $current_value, $id, $class);
-    }
-
-
-    /**
-     * output a dropdown of the categories for the category filter on the event admin list table
-     *
-     * @access  public
-     * @return string html
-     */
-    public function category_dropdown()
-    {
-        $cur_cat = isset($this->_req_data['EVT_CAT']) ? $this->_req_data['EVT_CAT'] : -1;
-        return EEH_Form_Fields::generate_event_category_dropdown($cur_cat);
-    }
-
-
-    /**
-     * get total number of events today
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     */
-    public function total_events_today()
-    {
-        $start = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            date('Y-m-d') . ' 00:00:00',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $end = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            date('Y-m-d') . ' 23:59:59',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where = array(
-            'Datetime.DTT_EVT_start' => array('BETWEEN', array($start, $end)),
-        );
-        $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
-        return $count;
-    }
-
-
-    /**
-     * get total number of events this month
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     */
-    public function total_events_this_month()
-    {
-        // Dates
-        $this_year_r = date('Y');
-        $this_month_r = date('m');
-        $days_this_month = date('t');
-        $start = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-01 00:00:00',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $end = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' 23:59:59',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where = array(
-            'Datetime.DTT_EVT_start' => array('BETWEEN', array($start, $end)),
-        );
-        $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
-        return $count;
-    }
-
-
-    /** DEFAULT TICKETS STUFF **/
-
-    /**
-     * Output default tickets list table view.
-     */
-    public function _tickets_overview_list_table()
-    {
-        $this->_search_btn_label = esc_html__('Tickets', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * @param int  $per_page
-     * @param bool $count
-     * @param bool $trashed
-     * @return \EE_Soft_Delete_Base_Class[]|int
-     */
-    public function get_default_tickets($per_page = 10, $count = false, $trashed = false)
-    {
-        $orderby = empty($this->_req_data['orderby']) ? 'TKT_name' : $this->_req_data['orderby'];
-        $order = empty($this->_req_data['order']) ? 'ASC' : $this->_req_data['order'];
-        switch ($orderby) {
-            case 'TKT_name':
-                $orderby = array('TKT_name' => $order);
-                break;
-            case 'TKT_price':
-                $orderby = array('TKT_price' => $order);
-                break;
-            case 'TKT_uses':
-                $orderby = array('TKT_uses' => $order);
-                break;
-            case 'TKT_min':
-                $orderby = array('TKT_min' => $order);
-                break;
-            case 'TKT_max':
-                $orderby = array('TKT_max' => $order);
-                break;
-            case 'TKT_qty':
-                $orderby = array('TKT_qty' => $order);
-                break;
-        }
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
-            ? $this->_req_data['paged']
-            : 1;
-        $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $per_page;
-        $_where = array(
-            'TKT_is_default' => 1,
-            'TKT_deleted'    => $trashed,
-        );
-        $offset = ($current_page - 1) * $per_page;
-        $limit = array($offset, $per_page);
-        if (isset($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
-            $_where['OR'] = array(
-                'TKT_name'        => array('LIKE', $sstr),
-                'TKT_description' => array('LIKE', $sstr),
-            );
-        }
-        $query_params = array(
-            $_where,
-            'order_by' => $orderby,
-            'limit'    => $limit,
-            'group_by' => 'TKT_ID',
-        );
-        if ($count) {
-            return EEM_Ticket::instance()->count_deleted_and_undeleted(array($_where));
-        } else {
-            return EEM_Ticket::instance()->get_all_deleted_and_undeleted($query_params);
-        }
-    }
-
-
-    /**
-     * @param bool $trash
-     * @throws EE_Error
-     */
-    protected function _trash_or_restore_ticket($trash = false)
-    {
-        $success = 1;
-        $TKT = EEM_Ticket::instance();
-        // checkboxes?
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // if array has more than one element then success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-            // cycle thru the boxes
-            while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
-                if ($trash) {
-                    if (! $TKT->delete_by_ID($TKT_ID)) {
-                        $success = 0;
-                    }
-                } else {
-                    if (! $TKT->restore_by_ID($TKT_ID)) {
-                        $success = 0;
-                    }
-                }
-            }
-        } else {
-            // grab single id and trash
-            $TKT_ID = absint($this->_req_data['TKT_ID']);
-            if ($trash) {
-                if (! $TKT->delete_by_ID($TKT_ID)) {
-                    $success = 0;
-                }
-            } else {
-                if (! $TKT->restore_by_ID($TKT_ID)) {
-                    $success = 0;
-                }
-            }
-        }
-        $action_desc = $trash ? 'moved to the trash' : 'restored';
-        $query_args = array(
-            'action' => 'ticket_list_table',
-            'status' => $trash ? '' : 'trashed',
-        );
-        $this->_redirect_after_action($success, 'Tickets', $action_desc, $query_args);
-    }
-
-
-    /**
-     * Handles trashing default ticket.
-     */
-    protected function _delete_ticket()
-    {
-        $success = 1;
-        // checkboxes?
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // if array has more than one element then success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-            // cycle thru the boxes
-            while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
-                // delete
-                if (! $this->_delete_the_ticket($TKT_ID)) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // grab single id and trash
-            $TKT_ID = absint($this->_req_data['TKT_ID']);
-            if (! $this->_delete_the_ticket($TKT_ID)) {
-                $success = 0;
-            }
-        }
-        $action_desc = 'deleted';
-        $query_args = array(
-            'action' => 'ticket_list_table',
-            'status' => 'trashed',
-        );
-        // fail safe.  If the default ticket count === 1 then we need to redirect to event overview.
-        if (EEM_Ticket::instance()->count_deleted_and_undeleted(
-            array(array('TKT_is_default' => 1)),
-            'TKT_ID',
-            true
-        )
-        ) {
-            $query_args = array();
-        }
-        $this->_redirect_after_action($success, 'Tickets', $action_desc, $query_args);
-    }
-
-
-    /**
-     * @param int $TKT_ID
-     * @return bool|int
-     * @throws EE_Error
-     */
-    protected function _delete_the_ticket($TKT_ID)
-    {
-        $tkt = EEM_Ticket::instance()->get_one_by_ID($TKT_ID);
-        $tkt->_remove_relations('Datetime');
-        // delete all related prices first
-        $tkt->delete_related_permanently('Price');
-        return $tkt->delete_permanently();
-    }
+	/**
+	 * Extend_Events_Admin_Page constructor.
+	 *
+	 * @param bool $routing
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		if (! defined('EVENTS_CAF_TEMPLATE_PATH')) {
+			define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'events/templates/');
+			define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'events/assets/');
+			define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'events/assets/');
+		}
+	}
+
+
+	/**
+	 * Sets routes.
+	 */
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'events';
+		// is there a evt_id in the request?
+		$evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
+			? $this->_req_data['EVT_ID']
+			: 0;
+		$evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id;
+		// tkt_id?
+		$tkt_id = ! empty($this->_req_data['TKT_ID']) && ! is_array($this->_req_data['TKT_ID'])
+			? $this->_req_data['TKT_ID']
+			: 0;
+		$new_page_routes = array(
+			'duplicate_event'          => array(
+				'func'       => '_duplicate_event',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			),
+			'ticket_list_table'        => array(
+				'func'       => '_tickets_overview_list_table',
+				'capability' => 'ee_read_default_tickets',
+			),
+			'trash_ticket'             => array(
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_ticket',
+				'obj_id'     => $tkt_id,
+				'noheader'   => true,
+				'args'       => array('trash' => true),
+			),
+			'trash_tickets'            => array(
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_tickets',
+				'noheader'   => true,
+				'args'       => array('trash' => true),
+			),
+			'restore_ticket'           => array(
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_ticket',
+				'obj_id'     => $tkt_id,
+				'noheader'   => true,
+			),
+			'restore_tickets'          => array(
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_tickets',
+				'noheader'   => true,
+			),
+			'delete_ticket'            => array(
+				'func'       => '_delete_ticket',
+				'capability' => 'ee_delete_default_ticket',
+				'obj_id'     => $tkt_id,
+				'noheader'   => true,
+			),
+			'delete_tickets'           => array(
+				'func'       => '_delete_ticket',
+				'capability' => 'ee_delete_default_tickets',
+				'noheader'   => true,
+			),
+			'import_page'              => array(
+				'func'       => '_import_page',
+				'capability' => 'import',
+			),
+			'import'                   => array(
+				'func'       => '_import_events',
+				'capability' => 'import',
+				'noheader'   => true,
+			),
+			'import_events'            => array(
+				'func'       => '_import_events',
+				'capability' => 'import',
+				'noheader'   => true,
+			),
+			'export_events'            => array(
+				'func'       => '_events_export',
+				'capability' => 'export',
+				'noheader'   => true,
+			),
+			'export_categories'        => array(
+				'func'       => '_categories_export',
+				'capability' => 'export',
+				'noheader'   => true,
+			),
+			'sample_export_file'       => array(
+				'func'       => '_sample_export_file',
+				'capability' => 'export',
+				'noheader'   => true,
+			),
+			'update_template_settings' => array(
+				'func'       => '_update_template_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+		);
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+		// partial route/config override
+		$this->_page_config['import_events']['metaboxes'] = $this->_default_espresso_metaboxes;
+		$this->_page_config['create_new']['metaboxes'][] = '_premium_event_editor_meta_boxes';
+		$this->_page_config['create_new']['qtips'][] = 'EE_Event_Editor_Tips';
+		$this->_page_config['edit']['qtips'][] = 'EE_Event_Editor_Tips';
+		$this->_page_config['edit']['metaboxes'][] = '_premium_event_editor_meta_boxes';
+		$this->_page_config['default']['list_table'] = 'Extend_Events_Admin_List_Table';
+		// add tickets tab but only if there are more than one default ticket!
+		$tkt_count = EEM_Ticket::instance()->count_deleted_and_undeleted(
+			array(array('TKT_is_default' => 1)),
+			'TKT_ID',
+			true
+		);
+		if ($tkt_count > 1) {
+			$new_page_config = array(
+				'ticket_list_table' => array(
+					'nav'           => array(
+						'label' => esc_html__('Default Tickets', 'event_espresso'),
+						'order' => 60,
+					),
+					'list_table'    => 'Tickets_List_Table',
+					'require_nonce' => false,
+				),
+			);
+		}
+		// template settings
+		$new_page_config['template_settings'] = array(
+			'nav'           => array(
+				'label' => esc_html__('Templates', 'event_espresso'),
+				'order' => 30,
+			),
+			'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+			'help_tabs'     => array(
+				'general_settings_templates_help_tab' => array(
+					'title'    => esc_html__('Templates', 'event_espresso'),
+					'filename' => 'general_settings_templates',
+				),
+			),
+			'help_tour'     => array('Templates_Help_Tour'),
+			'require_nonce' => false,
+		);
+		$this->_page_config = array_merge($this->_page_config, $new_page_config);
+		// add filters and actions
+		// modifying _views
+		add_filter(
+			'FHEE_event_datetime_metabox_add_additional_date_time_template',
+			array($this, 'add_additional_datetime_button'),
+			10,
+			2
+		);
+		add_filter(
+			'FHEE_event_datetime_metabox_clone_button_template',
+			array($this, 'add_datetime_clone_button'),
+			10,
+			2
+		);
+		add_filter(
+			'FHEE_event_datetime_metabox_timezones_template',
+			array($this, 'datetime_timezones_template'),
+			10,
+			2
+		);
+		// filters for event list table
+		add_filter('FHEE__Extend_Events_Admin_List_Table__filters', array($this, 'list_table_filters'), 10, 2);
+		add_filter(
+			'FHEE__Events_Admin_List_Table__column_actions__action_links',
+			array($this, 'extra_list_table_actions'),
+			10,
+			2
+		);
+		// legend item
+		add_filter('FHEE__Events_Admin_Page___event_legend_items__items', array($this, 'additional_legend_items'));
+		add_action('admin_init', array($this, 'admin_init'));
+	}
+
+
+	/**
+	 * admin_init
+	 */
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings = array_merge(
+			EE_Registry::$i18n_js_strings,
+			array(
+				'image_confirm'          => esc_html__(
+					'Do you really want to delete this image? Please remember to update your event to complete the removal.',
+					'event_espresso'
+				),
+				'event_starts_on'        => esc_html__('Event Starts on', 'event_espresso'),
+				'event_ends_on'          => esc_html__('Event Ends on', 'event_espresso'),
+				'event_datetime_actions' => esc_html__('Actions', 'event_espresso'),
+				'event_clone_dt_msg'     => esc_html__('Clone this Event Date and Time', 'event_espresso'),
+				'remove_event_dt_msg'    => esc_html__('Remove this Event Time', 'event_espresso'),
+			)
+		);
+	}
+
+
+	/**
+	 * Add per page screen options to the default ticket list table view.
+	 */
+	protected function _add_screen_options_ticket_list_table()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * @param string $return
+	 * @param int    $id
+	 * @param string $new_title
+	 * @param string $new_slug
+	 * @return string
+	 */
+	public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
+	{
+		$return = parent::extra_permalink_field_buttons($return, $id, $new_title, $new_slug);
+		// make sure this is only when editing
+		if (! empty($id)) {
+			$href = EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'duplicate_event', 'EVT_ID' => $id),
+				$this->_admin_base_url
+			);
+			$title = esc_attr__('Duplicate Event', 'event_espresso');
+			$return .= '<a href="'
+					   . $href
+					   . '" title="'
+					   . $title
+					   . '" id="ee-duplicate-event-button" class="button button-small"  value="duplicate_event">'
+					   . $title
+					   . '</a>';
+		}
+		return $return;
+	}
+
+
+	/**
+	 * Set the list table views for the default ticket list table view.
+	 */
+	public function _set_list_table_views_ticket_list_table()
+	{
+		$this->_views = array(
+			'all'     => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_tickets' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+			'trashed' => array(
+				'slug'        => 'trashed',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'restore_tickets' => esc_html__('Restore from Trash', 'event_espresso'),
+					'delete_tickets'  => esc_html__('Delete Permanently', 'event_espresso'),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * Enqueue scripts and styles for the event editor.
+	 */
+	public function load_scripts_styles_edit()
+	{
+		wp_register_script(
+			'ee-event-editor-heartbeat',
+			EVENTS_CAF_ASSETS_URL . 'event-editor-heartbeat.js',
+			array('ee_admin_js', 'heartbeat'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-accounting');
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_enqueue_script('event_editor_js');
+		wp_enqueue_script('ee-event-editor-heartbeat');
+	}
+
+
+	/**
+	 * Returns template for the additional datetime.
+	 *
+	 * @param $template
+	 * @param $template_args
+	 * @return mixed
+	 * @throws DomainException
+	 */
+	public function add_additional_datetime_button($template, $template_args)
+	{
+		return EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_add_additional_time.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * Returns the template for cloning a datetime.
+	 *
+	 * @param $template
+	 * @param $template_args
+	 * @return mixed
+	 * @throws DomainException
+	 */
+	public function add_datetime_clone_button($template, $template_args)
+	{
+		return EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_metabox_clone_button.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * Returns the template for datetime timezones.
+	 *
+	 * @param $template
+	 * @param $template_args
+	 * @return mixed
+	 * @throws DomainException
+	 */
+	public function datetime_timezones_template($template, $template_args)
+	{
+		return EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_timezones.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * Sets the views for the default list table view.
+	 */
+	protected function _set_list_table_views_default()
+	{
+		parent::_set_list_table_views_default();
+		$new_views = array(
+			'today' => array(
+				'slug'        => 'today',
+				'label'       => esc_html__('Today', 'event_espresso'),
+				'count'       => $this->total_events_today(),
+				'bulk_action' => array(
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+			'month' => array(
+				'slug'        => 'month',
+				'label'       => esc_html__('This Month', 'event_espresso'),
+				'count'       => $this->total_events_this_month(),
+				'bulk_action' => array(
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+		);
+		$this->_views = array_merge($this->_views, $new_views);
+	}
+
+
+	/**
+	 * Returns the extra action links for the default list table view.
+	 *
+	 * @param array     $action_links
+	 * @param \EE_Event $event
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function extra_list_table_actions(array $action_links, \EE_Event $event)
+	{
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registrations',
+			'espresso_registrations_reports',
+			$event->ID()
+		)
+		) {
+			$reports_query_args = array(
+				'action' => 'reports',
+				'EVT_ID' => $event->ID(),
+			);
+			$reports_link = EE_Admin_Page::add_query_args_and_nonce($reports_query_args, REG_ADMIN_URL);
+			$action_links[] = '<a href="'
+							  . $reports_link
+							  . '" title="'
+							  . esc_attr__('View Report', 'event_espresso')
+							  . '"><div class="dashicons dashicons-chart-bar"></div></a>'
+							  . "\n\t";
+		}
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
+			EE_Registry::instance()->load_helper('MSG_Template');
+			$action_links[] = EEH_MSG_Template::get_message_action_link(
+				'see_notifications_for',
+				null,
+				array('EVT_ID' => $event->ID())
+			);
+		}
+		return $action_links;
+	}
+
+
+	/**
+	 * @param $items
+	 * @return mixed
+	 */
+	public function additional_legend_items($items)
+	{
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registrations',
+			'espresso_registrations_reports'
+		)
+		) {
+			$items['reports'] = array(
+				'class' => 'dashicons dashicons-chart-bar',
+				'desc'  => esc_html__('Event Reports', 'event_espresso'),
+			);
+		}
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
+			$related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
+			if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
+				$items['view_related_messages'] = array(
+					'class' => $related_for_icon['css_class'],
+					'desc'  => $related_for_icon['label'],
+				);
+			}
+		}
+		return $items;
+	}
+
+
+	/**
+	 * This is the callback method for the duplicate event route
+	 * Method looks for 'EVT_ID' in the request and retrieves that event and its details and duplicates them
+	 * into a new event.  We add a hook so that any plugins that add extra event details can hook into this
+	 * action.  Note that the dupe will have **DUPLICATE** as its title and slug.
+	 * After duplication the redirect is to the new event edit page.
+	 *
+	 * @return void
+	 * @access protected
+	 * @throws EE_Error If EE_Event is not available with given ID
+	 */
+	protected function _duplicate_event()
+	{
+		// first make sure the ID for the event is in the request.
+		//  If it isn't then we need to bail and redirect back to overview list table (cause how did we get here?)
+		if (! isset($this->_req_data['EVT_ID'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'In order to duplicate an event an Event ID is required.  None was given.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_redirect_after_action(false, '', '', array(), true);
+			return;
+		}
+		// k we've got EVT_ID so let's use that to get the event we'll duplicate
+		$orig_event = EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID']);
+		if (! $orig_event instanceof EE_Event) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('An EE_Event object could not be retrieved for the given ID (%s)', 'event_espresso'),
+					$this->_req_data['EVT_ID']
+				)
+			);
+		}
+		// k now let's clone the $orig_event before getting relations
+		$new_event = clone $orig_event;
+		// original datetimes
+		$orig_datetimes = $orig_event->get_many_related('Datetime');
+		// other original relations
+		$orig_ven = $orig_event->get_many_related('Venue');
+		// reset the ID and modify other details to make it clear this is a dupe
+		$new_event->set('EVT_ID', 0);
+		$new_name = $new_event->name() . ' ' . esc_html__('**DUPLICATE**', 'event_espresso');
+		$new_event->set('EVT_name', $new_name);
+		$new_event->set(
+			'EVT_slug',
+			wp_unique_post_slug(
+				sanitize_title($orig_event->name()),
+				0,
+				'publish',
+				'espresso_events',
+				0
+			)
+		);
+		$new_event->set('status', 'draft');
+		// duplicate discussion settings
+		$new_event->set('comment_status', $orig_event->get('comment_status'));
+		$new_event->set('ping_status', $orig_event->get('ping_status'));
+		// save the new event
+		$new_event->save();
+		// venues
+		foreach ($orig_ven as $ven) {
+			$new_event->_add_relation_to($ven, 'Venue');
+		}
+		$new_event->save();
+		// now we need to get the question group relations and handle that
+		// first primary question groups
+		$orig_primary_qgs = $orig_event->get_many_related(
+			'Question_Group',
+			array(array('Event_Question_Group.EQG_primary' => 1))
+		);
+		if (! empty($orig_primary_qgs)) {
+			foreach ($orig_primary_qgs as $id => $obj) {
+				if ($obj instanceof EE_Question_Group) {
+					$new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 1));
+				}
+			}
+		}
+		// next additional attendee question groups
+		$orig_additional_qgs = $orig_event->get_many_related(
+			'Question_Group',
+			array(array('Event_Question_Group.EQG_primary' => 0))
+		);
+		if (! empty($orig_additional_qgs)) {
+			foreach ($orig_additional_qgs as $id => $obj) {
+				if ($obj instanceof EE_Question_Group) {
+					$new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 0));
+				}
+			}
+		}
+
+		$new_event->save();
+
+		// k now that we have the new event saved we can loop through the datetimes and start adding relations.
+		$cloned_tickets = array();
+		foreach ($orig_datetimes as $orig_dtt) {
+			if (! $orig_dtt instanceof EE_Datetime) {
+				continue;
+			}
+			$new_dtt = clone $orig_dtt;
+			$orig_tkts = $orig_dtt->tickets();
+			// save new dtt then add to event
+			$new_dtt->set('DTT_ID', 0);
+			$new_dtt->set('DTT_sold', 0);
+			$new_dtt->set_reserved(0);
+			$new_dtt->save();
+			$new_event->_add_relation_to($new_dtt, 'Datetime');
+			$new_event->save();
+			// now let's get the ticket relations setup.
+			foreach ((array) $orig_tkts as $orig_tkt) {
+				// it's possible a datetime will have no tickets so let's verify we HAVE a ticket first.
+				if (! $orig_tkt instanceof EE_Ticket) {
+					continue;
+				}
+				// is this ticket archived?  If it is then let's skip
+				if ($orig_tkt->get('TKT_deleted')) {
+					continue;
+				}
+				// does this original ticket already exist in the clone_tickets cache?
+				//  If so we'll just use the new ticket from it.
+				if (isset($cloned_tickets[ $orig_tkt->ID() ])) {
+					$new_tkt = $cloned_tickets[ $orig_tkt->ID() ];
+				} else {
+					$new_tkt = clone $orig_tkt;
+					// get relations on the $orig_tkt that we need to setup.
+					$orig_prices = $orig_tkt->prices();
+					$new_tkt->set('TKT_ID', 0);
+					$new_tkt->set('TKT_sold', 0);
+					$new_tkt->set('TKT_reserved', 0);
+					$new_tkt->save(); // make sure new ticket has ID.
+					// price relations on new ticket need to be setup.
+					foreach ($orig_prices as $orig_price) {
+						$new_price = clone $orig_price;
+						$new_price->set('PRC_ID', 0);
+						$new_price->save();
+						$new_tkt->_add_relation_to($new_price, 'Price');
+						$new_tkt->save();
+					}
+
+					do_action(
+						'AHEE__Extend_Events_Admin_Page___duplicate_event__duplicate_ticket__after',
+						$orig_tkt,
+						$new_tkt,
+						$orig_prices,
+						$orig_event,
+						$orig_dtt,
+						$new_dtt
+					);
+				}
+				// k now we can add the new ticket as a relation to the new datetime
+				// and make sure its added to our cached $cloned_tickets array
+				// for use with later datetimes that have the same ticket.
+				$new_dtt->_add_relation_to($new_tkt, 'Ticket');
+				$new_dtt->save();
+				$cloned_tickets[ $orig_tkt->ID() ] = $new_tkt;
+			}
+		}
+		// clone taxonomy information
+		$taxonomies_to_clone_with = apply_filters(
+			'FHEE__Extend_Events_Admin_Page___duplicate_event__taxonomies_to_clone',
+			array('espresso_event_categories', 'espresso_event_type', 'post_tag')
+		);
+		// get terms for original event (notice)
+		$orig_terms = wp_get_object_terms($orig_event->ID(), $taxonomies_to_clone_with);
+		// loop through terms and add them to new event.
+		foreach ($orig_terms as $term) {
+			wp_set_object_terms($new_event->ID(), $term->term_id, $term->taxonomy, true);
+		}
+
+		// duplicate other core WP_Post items for this event.
+		// post thumbnail (feature image).
+		$feature_image_id = get_post_thumbnail_id($orig_event->ID());
+		if ($feature_image_id) {
+			update_post_meta($new_event->ID(), '_thumbnail_id', $feature_image_id);
+		}
+
+		// duplicate page_template setting
+		$page_template = get_post_meta($orig_event->ID(), '_wp_page_template', true);
+		if ($page_template) {
+			update_post_meta($new_event->ID(), '_wp_page_template', $page_template);
+		}
+
+		do_action('AHEE__Extend_Events_Admin_Page___duplicate_event__after', $new_event, $orig_event);
+		// now let's redirect to the edit page for this duplicated event if we have a new event id.
+		if ($new_event->ID()) {
+			$redirect_args = array(
+				'post'   => $new_event->ID(),
+				'action' => 'edit',
+			);
+			EE_Error::add_success(
+				esc_html__(
+					'Event successfully duplicated.  Please review the details below and make any necessary edits',
+					'event_espresso'
+				)
+			);
+		} else {
+			$redirect_args = array(
+				'action' => 'default',
+			);
+			EE_Error::add_error(
+				esc_html__('Not able to duplicate event.  Something went wrong.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$this->_redirect_after_action(false, '', '', $redirect_args, true);
+	}
+
+
+	/**
+	 * Generates output for the import page.
+	 *
+	 * @throws DomainException
+	 */
+	protected function _import_page()
+	{
+		$title = esc_html__('Import', 'event_espresso');
+		$intro = esc_html__(
+			'If you have a previously exported Event Espresso 4 information in a Comma Separated Value (CSV) file format, you can upload the file here: ',
+			'event_espresso'
+		);
+		$form_url = EVENTS_ADMIN_URL;
+		$action = 'import_events';
+		$type = 'csv';
+		$this->_template_args['form'] = EE_Import::instance()->upload_form(
+			$title,
+			$intro,
+			$form_url,
+			$action,
+			$type
+		);
+		$this->_template_args['sample_file_link'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'sample_export_file'),
+			$this->_admin_base_url
+		);
+		$content = EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'import_page.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->_template_args['admin_page_content'] = $content;
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * _import_events
+	 * This handles displaying the screen and running imports for importing events.
+	 *
+	 * @return void
+	 */
+	protected function _import_events()
+	{
+		require_once(EE_CLASSES . 'EE_Import.class.php');
+		$success = EE_Import::instance()->import();
+		$this->_redirect_after_action($success, 'Import File', 'ran', array('action' => 'import_page'), true);
+	}
+
+
+	/**
+	 * _events_export
+	 * Will export all (or just the given event) to a Excel compatible file.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _events_export()
+	{
+		if (isset($this->_req_data['EVT_ID'])) {
+			$event_ids = $this->_req_data['EVT_ID'];
+		} elseif (isset($this->_req_data['EVT_IDs'])) {
+			$event_ids = $this->_req_data['EVT_IDs'];
+		} else {
+			$event_ids = null;
+		}
+		// todo: I don't like doing this but it'll do until we modify EE_Export Class.
+		$new_request_args = array(
+			'export' => 'report',
+			'action' => 'all_event_data',
+			'EVT_ID' => $event_ids,
+		);
+		$this->_req_data = array_merge($this->_req_data, $new_request_args);
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->_req_data);
+			$EE_Export->export();
+		}
+	}
+
+
+	/**
+	 * handle category exports()
+	 *
+	 * @return void
+	 */
+	protected function _categories_export()
+	{
+		// todo: I don't like doing this but it'll do until we modify EE_Export Class.
+		$new_request_args = array(
+			'export'       => 'report',
+			'action'       => 'categories',
+			'category_ids' => $this->_req_data['EVT_CAT_ID'],
+		);
+		$this->_req_data = array_merge($this->_req_data, $new_request_args);
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->_req_data);
+			$EE_Export->export();
+		}
+	}
+
+
+	/**
+	 * Creates a sample CSV file for importing
+	 */
+	protected function _sample_export_file()
+	{
+		// require_once(EE_CLASSES . 'EE_Export.class.php');
+		EE_Export::instance()->export_sample();
+	}
+
+
+	/*************        Template Settings        *************/
+	/**
+	 * Generates template settings page output
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _template_settings()
+	{
+		$this->_template_args['values'] = $this->_yes_no_values;
+		/**
+		 * Note leaving this filter in for backward compatibility this was moved in 4.6.x
+		 * from General_Settings_Admin_Page to here.
+		 */
+		$this->_template_args = apply_filters(
+			'FHEE__General_Settings_Admin_Page__template_settings__template_args',
+			$this->_template_args
+		);
+		$this->_set_add_edit_form_tags('update_template_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'template_settings.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Handler for updating template settings.
+	 *
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _update_template_settings()
+	{
+		/**
+		 * Note leaving this filter in for backward compatibility this was moved in 4.6.x
+		 * from General_Settings_Admin_Page to here.
+		 */
+		EE_Registry::instance()->CFG->template_settings = apply_filters(
+			'FHEE__General_Settings_Admin_Page__update_template_settings__data',
+			EE_Registry::instance()->CFG->template_settings,
+			$this->_req_data
+		);
+		// update custom post type slugs and detect if we need to flush rewrite rules
+		$old_slug = EE_Registry::instance()->CFG->core->event_cpt_slug;
+		EE_Registry::instance()->CFG->core->event_cpt_slug = empty($this->_req_data['event_cpt_slug'])
+			? EE_Registry::instance()->CFG->core->event_cpt_slug
+			: EEH_URL::slugify($this->_req_data['event_cpt_slug'], 'events');
+		$what = 'Template Settings';
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG->template_settings,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		if (EE_Registry::instance()->CFG->core->event_cpt_slug != $old_slug) {
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flush();
+		}
+		$this->_redirect_after_action($success, $what, 'updated', array('action' => 'template_settings'));
+	}
+
+
+	/**
+	 * _premium_event_editor_meta_boxes
+	 * add all metaboxes related to the event_editor
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _premium_event_editor_meta_boxes()
+	{
+		$this->verify_cpt_object();
+		add_meta_box(
+			'espresso_event_editor_event_options',
+			esc_html__('Event Registration Options', 'event_espresso'),
+			array($this, 'registration_options_meta_box'),
+			$this->page_slug,
+			'side',
+			'core'
+		);
+	}
+
+
+	/**
+	 * override caf metabox
+	 *
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function registration_options_meta_box()
+	{
+		$yes_no_values = array(
+			array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')),
+			array('id' => false, 'text' => esc_html__('No', 'event_espresso')),
+		);
+		$default_reg_status_values = EEM_Registration::reg_status_array(
+			array(
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_wait_list,
+			),
+			true
+		);
+		$template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
+		$template_args['_event'] = $this->_cpt_model_obj;
+		$template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
+		$template_args['default_registration_status'] = EEH_Form_Fields::select_input(
+			'default_reg_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['display_description'] = EEH_Form_Fields::select_input(
+			'display_desc',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_description()
+		);
+		$template_args['display_ticket_selector'] = EEH_Form_Fields::select_input(
+			'display_ticket_selector',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_ticket_selector(),
+			'',
+			'',
+			false
+		);
+		$template_args['EVT_default_registration_status'] = EEH_Form_Fields::select_input(
+			'EVT_default_registration_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['additional_registration_options'] = apply_filters(
+			'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
+			'',
+			$template_args,
+			$yes_no_values,
+			$default_reg_status_values
+		);
+		EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_registration_options.template.php',
+			$template_args
+		);
+	}
+
+
+
+	/**
+	 * wp_list_table_mods for caf
+	 * ============================
+	 */
+	/**
+	 * hook into list table filters and provide filters for caffeinated list table
+	 *
+	 * @param  array $old_filters    any existing filters present
+	 * @param  array $list_table_obj the list table object
+	 * @return array                  new filters
+	 */
+	public function list_table_filters($old_filters, $list_table_obj)
+	{
+		$filters = array();
+		// first month/year filters
+		$filters[] = $this->espresso_event_months_dropdown();
+		$status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
+		// active status dropdown
+		if ($status !== 'draft') {
+			$filters[] = $this->active_status_dropdown(
+				isset($this->_req_data['active_status']) ? $this->_req_data['active_status'] : ''
+			);
+		}
+		// category filter
+		$filters[] = $this->category_dropdown();
+		return array_merge($old_filters, $filters);
+	}
+
+
+	/**
+	 * espresso_event_months_dropdown
+	 *
+	 * @access public
+	 * @return string                dropdown listing month/year selections for events.
+	 */
+	public function espresso_event_months_dropdown()
+	{
+		// what we need to do is get all PRIMARY datetimes for all events to filter on.
+		// Note we need to include any other filters that are set!
+		$status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
+		// categories?
+		$category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
+			? $this->_req_data['EVT_CAT']
+			: null;
+		// active status?
+		$active_status = isset($this->_req_data['active_status']) ? $this->_req_data['active_status'] : null;
+		$cur_date = isset($this->_req_data['month_range']) ? $this->_req_data['month_range'] : '';
+		return EEH_Form_Fields::generate_event_months_dropdown($cur_date, $status, $category, $active_status);
+	}
+
+
+	/**
+	 * returns a list of "active" statuses on the event
+	 *
+	 * @param  string $current_value whatever the current active status is
+	 * @return string
+	 */
+	public function active_status_dropdown($current_value = '')
+	{
+		$select_name = 'active_status';
+		$values = array(
+			'none'     => esc_html__('Show Active/Inactive', 'event_espresso'),
+			'active'   => esc_html__('Active', 'event_espresso'),
+			'upcoming' => esc_html__('Upcoming', 'event_espresso'),
+			'expired'  => esc_html__('Expired', 'event_espresso'),
+			'inactive' => esc_html__('Inactive', 'event_espresso'),
+		);
+		$id = 'id="espresso-active-status-dropdown-filter"';
+		$class = 'wide';
+		return EEH_Form_Fields::select_input($select_name, $values, $current_value, $id, $class);
+	}
+
+
+	/**
+	 * output a dropdown of the categories for the category filter on the event admin list table
+	 *
+	 * @access  public
+	 * @return string html
+	 */
+	public function category_dropdown()
+	{
+		$cur_cat = isset($this->_req_data['EVT_CAT']) ? $this->_req_data['EVT_CAT'] : -1;
+		return EEH_Form_Fields::generate_event_category_dropdown($cur_cat);
+	}
+
+
+	/**
+	 * get total number of events today
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function total_events_today()
+	{
+		$start = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			date('Y-m-d') . ' 00:00:00',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$end = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			date('Y-m-d') . ' 23:59:59',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where = array(
+			'Datetime.DTT_EVT_start' => array('BETWEEN', array($start, $end)),
+		);
+		$count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
+		return $count;
+	}
+
+
+	/**
+	 * get total number of events this month
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function total_events_this_month()
+	{
+		// Dates
+		$this_year_r = date('Y');
+		$this_month_r = date('m');
+		$days_this_month = date('t');
+		$start = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			$this_year_r . '-' . $this_month_r . '-01 00:00:00',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$end = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			$this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' 23:59:59',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where = array(
+			'Datetime.DTT_EVT_start' => array('BETWEEN', array($start, $end)),
+		);
+		$count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
+		return $count;
+	}
+
+
+	/** DEFAULT TICKETS STUFF **/
+
+	/**
+	 * Output default tickets list table view.
+	 */
+	public function _tickets_overview_list_table()
+	{
+		$this->_search_btn_label = esc_html__('Tickets', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * @param int  $per_page
+	 * @param bool $count
+	 * @param bool $trashed
+	 * @return \EE_Soft_Delete_Base_Class[]|int
+	 */
+	public function get_default_tickets($per_page = 10, $count = false, $trashed = false)
+	{
+		$orderby = empty($this->_req_data['orderby']) ? 'TKT_name' : $this->_req_data['orderby'];
+		$order = empty($this->_req_data['order']) ? 'ASC' : $this->_req_data['order'];
+		switch ($orderby) {
+			case 'TKT_name':
+				$orderby = array('TKT_name' => $order);
+				break;
+			case 'TKT_price':
+				$orderby = array('TKT_price' => $order);
+				break;
+			case 'TKT_uses':
+				$orderby = array('TKT_uses' => $order);
+				break;
+			case 'TKT_min':
+				$orderby = array('TKT_min' => $order);
+				break;
+			case 'TKT_max':
+				$orderby = array('TKT_max' => $order);
+				break;
+			case 'TKT_qty':
+				$orderby = array('TKT_qty' => $order);
+				break;
+		}
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
+			? $this->_req_data['paged']
+			: 1;
+		$per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $per_page;
+		$_where = array(
+			'TKT_is_default' => 1,
+			'TKT_deleted'    => $trashed,
+		);
+		$offset = ($current_page - 1) * $per_page;
+		$limit = array($offset, $per_page);
+		if (isset($this->_req_data['s'])) {
+			$sstr = '%' . $this->_req_data['s'] . '%';
+			$_where['OR'] = array(
+				'TKT_name'        => array('LIKE', $sstr),
+				'TKT_description' => array('LIKE', $sstr),
+			);
+		}
+		$query_params = array(
+			$_where,
+			'order_by' => $orderby,
+			'limit'    => $limit,
+			'group_by' => 'TKT_ID',
+		);
+		if ($count) {
+			return EEM_Ticket::instance()->count_deleted_and_undeleted(array($_where));
+		} else {
+			return EEM_Ticket::instance()->get_all_deleted_and_undeleted($query_params);
+		}
+	}
+
+
+	/**
+	 * @param bool $trash
+	 * @throws EE_Error
+	 */
+	protected function _trash_or_restore_ticket($trash = false)
+	{
+		$success = 1;
+		$TKT = EEM_Ticket::instance();
+		// checkboxes?
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// if array has more than one element then success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			// cycle thru the boxes
+			while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
+				if ($trash) {
+					if (! $TKT->delete_by_ID($TKT_ID)) {
+						$success = 0;
+					}
+				} else {
+					if (! $TKT->restore_by_ID($TKT_ID)) {
+						$success = 0;
+					}
+				}
+			}
+		} else {
+			// grab single id and trash
+			$TKT_ID = absint($this->_req_data['TKT_ID']);
+			if ($trash) {
+				if (! $TKT->delete_by_ID($TKT_ID)) {
+					$success = 0;
+				}
+			} else {
+				if (! $TKT->restore_by_ID($TKT_ID)) {
+					$success = 0;
+				}
+			}
+		}
+		$action_desc = $trash ? 'moved to the trash' : 'restored';
+		$query_args = array(
+			'action' => 'ticket_list_table',
+			'status' => $trash ? '' : 'trashed',
+		);
+		$this->_redirect_after_action($success, 'Tickets', $action_desc, $query_args);
+	}
+
+
+	/**
+	 * Handles trashing default ticket.
+	 */
+	protected function _delete_ticket()
+	{
+		$success = 1;
+		// checkboxes?
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// if array has more than one element then success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			// cycle thru the boxes
+			while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
+				// delete
+				if (! $this->_delete_the_ticket($TKT_ID)) {
+					$success = 0;
+				}
+			}
+		} else {
+			// grab single id and trash
+			$TKT_ID = absint($this->_req_data['TKT_ID']);
+			if (! $this->_delete_the_ticket($TKT_ID)) {
+				$success = 0;
+			}
+		}
+		$action_desc = 'deleted';
+		$query_args = array(
+			'action' => 'ticket_list_table',
+			'status' => 'trashed',
+		);
+		// fail safe.  If the default ticket count === 1 then we need to redirect to event overview.
+		if (EEM_Ticket::instance()->count_deleted_and_undeleted(
+			array(array('TKT_is_default' => 1)),
+			'TKT_ID',
+			true
+		)
+		) {
+			$query_args = array();
+		}
+		$this->_redirect_after_action($success, 'Tickets', $action_desc, $query_args);
+	}
+
+
+	/**
+	 * @param int $TKT_ID
+	 * @return bool|int
+	 * @throws EE_Error
+	 */
+	protected function _delete_the_ticket($TKT_ID)
+	{
+		$tkt = EEM_Ticket::instance()->get_one_by_ID($TKT_ID);
+		$tkt->_remove_relations('Datetime');
+		// delete all related prices first
+		$tkt->delete_related_permanently('Price');
+		return $tkt->delete_permanently();
+	}
 }

Spacing +41 added lines, -41 removed lines

@@ -24,10 +24,10 @@ 
     public function __construct($routing = true)
     {
         parent::__construct($routing);
-        if (! defined('EVENTS_CAF_TEMPLATE_PATH')) {
-            define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'events/templates/');
-            define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'events/assets/');
-            define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'events/assets/');
+        if ( ! defined('EVENTS_CAF_TEMPLATE_PATH')) {
+            define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND.'events/templates/');
+            define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND.'events/assets/');
+            define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'events/assets/');
         }
     }
 
@@ -37,7 +37,7 @@ 
      */
     protected function _extend_page_config()
     {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'events';
+        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND.'events';
         // is there a evt_id in the request?
         $evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
             ? $this->_req_data['EVT_ID']
@@ -247,7 +247,7 @@ 
     {
         $return = parent::extra_permalink_field_buttons($return, $id, $new_title, $new_slug);
         // make sure this is only when editing
-        if (! empty($id)) {
+        if ( ! empty($id)) {
             $href = EE_Admin_Page::add_query_args_and_nonce(
                 array('action' => 'duplicate_event', 'EVT_ID' => $id),
                 $this->_admin_base_url
@@ -299,7 +299,7 @@ 
     {
         wp_register_script(
             'ee-event-editor-heartbeat',
-            EVENTS_CAF_ASSETS_URL . 'event-editor-heartbeat.js',
+            EVENTS_CAF_ASSETS_URL.'event-editor-heartbeat.js',
             array('ee_admin_js', 'heartbeat'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -323,7 +323,7 @@ 
     public function add_additional_datetime_button($template, $template_args)
     {
         return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_add_additional_time.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'event_datetime_add_additional_time.template.php',
             $template_args,
             true
         );
@@ -341,7 +341,7 @@ 
     public function add_datetime_clone_button($template, $template_args)
     {
         return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_metabox_clone_button.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'event_datetime_metabox_clone_button.template.php',
             $template_args,
             true
         );
@@ -359,7 +359,7 @@ 
     public function datetime_timezones_template($template, $template_args)
     {
         return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_timezones.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'event_datetime_timezones.template.php',
             $template_args,
             true
         );
@@ -478,7 +478,7 @@ 
     {
         // first make sure the ID for the event is in the request.
         //  If it isn't then we need to bail and redirect back to overview list table (cause how did we get here?)
-        if (! isset($this->_req_data['EVT_ID'])) {
+        if ( ! isset($this->_req_data['EVT_ID'])) {
             EE_Error::add_error(
                 esc_html__(
                     'In order to duplicate an event an Event ID is required.  None was given.',
@@ -493,7 +493,7 @@ 
         }
         // k we've got EVT_ID so let's use that to get the event we'll duplicate
         $orig_event = EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID']);
-        if (! $orig_event instanceof EE_Event) {
+        if ( ! $orig_event instanceof EE_Event) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('An EE_Event object could not be retrieved for the given ID (%s)', 'event_espresso'),
@@ -509,7 +509,7 @@ 
         $orig_ven = $orig_event->get_many_related('Venue');
         // reset the ID and modify other details to make it clear this is a dupe
         $new_event->set('EVT_ID', 0);
-        $new_name = $new_event->name() . ' ' . esc_html__('**DUPLICATE**', 'event_espresso');
+        $new_name = $new_event->name().' '.esc_html__('**DUPLICATE**', 'event_espresso');
         $new_event->set('EVT_name', $new_name);
         $new_event->set(
             'EVT_slug',
@@ -538,7 +538,7 @@ 
             'Question_Group',
             array(array('Event_Question_Group.EQG_primary' => 1))
         );
-        if (! empty($orig_primary_qgs)) {
+        if ( ! empty($orig_primary_qgs)) {
             foreach ($orig_primary_qgs as $id => $obj) {
                 if ($obj instanceof EE_Question_Group) {
                     $new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 1));
@@ -550,7 +550,7 @@ 
             'Question_Group',
             array(array('Event_Question_Group.EQG_primary' => 0))
         );
-        if (! empty($orig_additional_qgs)) {
+        if ( ! empty($orig_additional_qgs)) {
             foreach ($orig_additional_qgs as $id => $obj) {
                 if ($obj instanceof EE_Question_Group) {
                     $new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 0));
@@ -563,7 +563,7 @@ 
         // k now that we have the new event saved we can loop through the datetimes and start adding relations.
         $cloned_tickets = array();
         foreach ($orig_datetimes as $orig_dtt) {
-            if (! $orig_dtt instanceof EE_Datetime) {
+            if ( ! $orig_dtt instanceof EE_Datetime) {
                 continue;
             }
             $new_dtt = clone $orig_dtt;
@@ -578,7 +578,7 @@ 
             // now let's get the ticket relations setup.
             foreach ((array) $orig_tkts as $orig_tkt) {
                 // it's possible a datetime will have no tickets so let's verify we HAVE a ticket first.
-                if (! $orig_tkt instanceof EE_Ticket) {
+                if ( ! $orig_tkt instanceof EE_Ticket) {
                     continue;
                 }
                 // is this ticket archived?  If it is then let's skip
@@ -587,8 +587,8 @@ 
                 }
                 // does this original ticket already exist in the clone_tickets cache?
                 //  If so we'll just use the new ticket from it.
-                if (isset($cloned_tickets[ $orig_tkt->ID() ])) {
-                    $new_tkt = $cloned_tickets[ $orig_tkt->ID() ];
+                if (isset($cloned_tickets[$orig_tkt->ID()])) {
+                    $new_tkt = $cloned_tickets[$orig_tkt->ID()];
                 } else {
                     $new_tkt = clone $orig_tkt;
                     // get relations on the $orig_tkt that we need to setup.
@@ -621,7 +621,7 @@ 
                 // for use with later datetimes that have the same ticket.
                 $new_dtt->_add_relation_to($new_tkt, 'Ticket');
                 $new_dtt->save();
-                $cloned_tickets[ $orig_tkt->ID() ] = $new_tkt;
+                $cloned_tickets[$orig_tkt->ID()] = $new_tkt;
             }
         }
         // clone taxonomy information
@@ -704,7 +704,7 @@ 
             $this->_admin_base_url
         );
         $content = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'import_page.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'import_page.template.php',
             $this->_template_args,
             true
         );
@@ -721,7 +721,7 @@ 
      */
     protected function _import_events()
     {
-        require_once(EE_CLASSES . 'EE_Import.class.php');
+        require_once(EE_CLASSES.'EE_Import.class.php');
         $success = EE_Import::instance()->import();
         $this->_redirect_after_action($success, 'Import File', 'ran', array('action' => 'import_page'), true);
     }
@@ -750,8 +750,8 @@ 
             'EVT_ID' => $event_ids,
         );
         $this->_req_data = array_merge($this->_req_data, $new_request_args);
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
+        if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+            require_once(EE_CLASSES.'EE_Export.class.php');
             $EE_Export = EE_Export::instance($this->_req_data);
             $EE_Export->export();
         }
@@ -772,8 +772,8 @@ 
             'category_ids' => $this->_req_data['EVT_CAT_ID'],
         );
         $this->_req_data = array_merge($this->_req_data, $new_request_args);
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
+        if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+            require_once(EE_CLASSES.'EE_Export.class.php');
             $EE_Export = EE_Export::instance($this->_req_data);
             $EE_Export->export();
         }
@@ -811,7 +811,7 @@ 
         $this->_set_add_edit_form_tags('update_template_settings');
         $this->_set_publish_post_box_vars(null, false, false, null, false);
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'template_settings.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'template_settings.template.php',
             $this->_template_args,
             true
         );
@@ -938,7 +938,7 @@ 
             $default_reg_status_values
         );
         EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_registration_options.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'event_registration_options.template.php',
             $template_args
         );
     }
@@ -1042,13 +1042,13 @@ 
     {
         $start = EEM_Datetime::instance()->convert_datetime_for_query(
             'DTT_EVT_start',
-            date('Y-m-d') . ' 00:00:00',
+            date('Y-m-d').' 00:00:00',
             'Y-m-d H:i:s',
             'UTC'
         );
         $end = EEM_Datetime::instance()->convert_datetime_for_query(
             'DTT_EVT_start',
-            date('Y-m-d') . ' 23:59:59',
+            date('Y-m-d').' 23:59:59',
             'Y-m-d H:i:s',
             'UTC'
         );
@@ -1075,13 +1075,13 @@ 
         $days_this_month = date('t');
         $start = EEM_Datetime::instance()->convert_datetime_for_query(
             'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-01 00:00:00',
+            $this_year_r.'-'.$this_month_r.'-01 00:00:00',
             'Y-m-d H:i:s',
             'UTC'
         );
         $end = EEM_Datetime::instance()->convert_datetime_for_query(
             'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' 23:59:59',
+            $this_year_r.'-'.$this_month_r.'-'.$days_this_month.' 23:59:59',
             'Y-m-d H:i:s',
             'UTC'
         );
@@ -1148,7 +1148,7 @@ 
         $offset = ($current_page - 1) * $per_page;
         $limit = array($offset, $per_page);
         if (isset($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
+            $sstr = '%'.$this->_req_data['s'].'%';
             $_where['OR'] = array(
                 'TKT_name'        => array('LIKE', $sstr),
                 'TKT_description' => array('LIKE', $sstr),
@@ -1177,17 +1177,17 @@ 
         $success = 1;
         $TKT = EEM_Ticket::instance();
         // checkboxes?
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
             // if array has more than one element then success message should be plural
             $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
             // cycle thru the boxes
             while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
                 if ($trash) {
-                    if (! $TKT->delete_by_ID($TKT_ID)) {
+                    if ( ! $TKT->delete_by_ID($TKT_ID)) {
                         $success = 0;
                     }
                 } else {
-                    if (! $TKT->restore_by_ID($TKT_ID)) {
+                    if ( ! $TKT->restore_by_ID($TKT_ID)) {
                         $success = 0;
                     }
                 }
@@ -1196,11 +1196,11 @@ 
             // grab single id and trash
             $TKT_ID = absint($this->_req_data['TKT_ID']);
             if ($trash) {
-                if (! $TKT->delete_by_ID($TKT_ID)) {
+                if ( ! $TKT->delete_by_ID($TKT_ID)) {
                     $success = 0;
                 }
             } else {
-                if (! $TKT->restore_by_ID($TKT_ID)) {
+                if ( ! $TKT->restore_by_ID($TKT_ID)) {
                     $success = 0;
                 }
             }
@@ -1221,20 +1221,20 @@ 
     {
         $success = 1;
         // checkboxes?
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
             // if array has more than one element then success message should be plural
             $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
             // cycle thru the boxes
             while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
                 // delete
-                if (! $this->_delete_the_ticket($TKT_ID)) {
+                if ( ! $this->_delete_the_ticket($TKT_ID)) {
                     $success = 0;
                 }
             }
         } else {
             // grab single id and trash
             $TKT_ID = absint($this->_req_data['TKT_ID']);
-            if (! $this->_delete_the_ticket($TKT_ID)) {
+            if ( ! $this->_delete_the_ticket($TKT_ID)) {
                 $success = 0;
             }
         }

core/admin/EE_Admin_Page_Loader.core.php

Unused Use Statements -1 removed lines

@@ -1,7 +1,6 @@
 <?php
 
 use EventEspresso\core\domain\entities\notifications\PersistentAdminNotice;
-use EventEspresso\core\exceptions\InvalidDataTypeException;
 
 /**
  * Event Espresso

Indentation +674 added lines, -674 removed lines

@@ -24,678 +24,678 @@
 class EE_Admin_Page_Loader
 {
 
-    /**
-     * _installed_pages
-     * objects for page_init objects detected and loaded
-     *
-     * @access private
-     * @var \EE_Admin_Page_Init[]
-     */
-    private $_installed_pages = array();
-
-
-    /**
-     * this is used to hold the registry of menu slugs for all the installed admin pages
-     *
-     * @var array
-     */
-    private $_menu_slugs = array();
-
-
-    /**
-     * _caffeinated_extends
-     * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
-     * pieces needed to do so).  This property is defined in the _set_caffeinated method.
-     *
-     * @var array
-     */
-    private $_caffeinated_extends = array();
-
-
-    /**
-     * _current_caf_extend_slug
-     * This property is used for holding the page slug that is required for referencing the correct
-     * _caffeinated_extends index when the corresponding core child EE_Admin_Page_init hooks are executed.
-     *
-     * @var array
-     */
-    private $_current_caf_extend_slug;
-
-    /**
-     * _prepped_menu_maps
-     * This is the prepared array of EE_Admin_Page_Menu_Maps for adding to the admin_menu.
-     *
-     * @since  4.4.0
-     * @var EE_Admin_Page_Menu_Map[]
-     */
-    private $_prepped_menu_maps = array();
-
-
-    /**
-     * _admin_menu_groups
-     * array that holds the group headings and details for
-     *
-     * @access private
-     * @var array
-     */
-    private $_admin_menu_groups = array();
-
-
-    /**
-     * This property will hold the hook file for setting up the filter that does all the connections between admin
-     * pages.
-     *
-     * @var string
-     */
-    public $hook_file;
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     * @return \EE_Admin_Page_Loader
-     */
-    public function __construct()
-    {
-        // load menu_map classes
-        EE_Registry::instance()->load_file(EE_ADMIN, 'EE_Admin_Page_Menu_Map', 'core');
-        // define the default "groups" for the admin_pages
-        $this->_set_menu_groups();
-
-        // let's do a scan and see what installed pages we have
-        $this->_get_installed_pages();
-        // set menus (has to be done on every load - we're not actually loading the page just setting the menus and where they point to).
-        add_action('admin_menu', array($this, 'set_menus'));
-        add_action('network_admin_menu', array($this, 'set_network_menus'));
-    }
-
-
-    /**
-     * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
-     * files in the caffeinated folder.
-     *
-     * @access private
-     * @return void
-     */
-    private function _define_caffeinated_constants()
-    {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
-        }
-    }
-
-
-    /**
-     * _set_menu_groups
-     * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_menu_groups()
-    {
-
-        // set array of EE_Admin_Page_Menu_Group objects
-        $groups = array(
-            'main'       => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Main', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::NONE,
-                    'menu_slug'    => 'main',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 0,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'management' => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Management', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'management',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 10,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'settings'   => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Settings', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'settings',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 30,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'templates'  => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Templates', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'templates',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 40,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'extras'     => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'              => __('Extras', 'event_espresso'),
-                    'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
-                    'menu_slug'               => 'extras',
-                    'capability'              => 'ee_read_ee',
-                    'menu_order'              => 50,
-                    'parent_slug'             => 'espresso_events',
-                    'maintenance_mode_parent' => 'espresso_maintenance_settings',
-                )
-            ),
-            'tools'      => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __("Tools", "event_espresso"),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'tools',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 60,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'addons'     => new EE_Admin_Page_Menu_Group(
-                array(
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
-                    'menu_label'   => __('Add-ons', 'event_espresso'),
-                    'menu_slug'    => 'addons',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 20,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-        );
-        $this->_admin_menu_groups = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
-            $groups
-        );
-    }
-
-
-    /**
-     * This takes all the groups in the _admin_menu_groups array and returns the array indexed by group
-     * slug.  The other utility with this function is it validates that all the groups are instances of
-     * EE_Admin_Page_Menu_Group (cause some invalid things might have slipped in via addons).
-     *
-     * @since  4.4.0
-     * @throws \EE_Error
-     * @return EE_Admin_Page_Menu_Group[]
-     */
-    private function _rearrange_menu_groups()
-    {
-        $groups = array();
-        // first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
-        usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
-        foreach ($this->_admin_menu_groups as $group) {
-            if (! $group instanceof EE_Admin_Page_Menu_Group) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Unable to continue sorting the menu groups array because there is an invalid value for the menu groups.  All values in this array are required to be a EE_Admin_Page_Menu_Group object.  Instead there was: %s',
-                            'event_espresso'
-                        ),
-                        print_r($group, true)
-                    )
-                );
-            }
-            $groups[ $group->menu_slug ] = $group;
-        }
-        return $groups;
-    }
-
-
-    /**
-     * _get_installed_pages
-     * This just gets the list of installed EE_Admin_pages.
-     *
-     * @access private
-     * @throws EE_Error
-     * @return void
-     */
-    private function _get_installed_pages()
-    {
-        $installed_refs = array();
-        $exclude = array('assets', 'templates');
-        // grab everything in the  admin core directory
-        $admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
-        if ($admin_screens) {
-            foreach ($admin_screens as $admin_screen) {
-                // files and anything in the exclude array need not apply
-                if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
-                    // these folders represent the different EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
-                }
-            }
-        }
-        if (empty($installed_refs)) {
-            $error_msg[] = __(
-                'There are no EE_Admin pages detected, it looks like EE did not install properly',
-                'event_espresso'
-            );
-            $error_msg[] = $error_msg[0] . "\r\n"
-                           . sprintf(
-                               __(
-                                   'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
-                                   'event_espresso'
-                               ),
-                               EE_ADMIN_PAGES
-                           );
-            throw new EE_Error(implode('||', $error_msg));
-        }
-        // this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
-        $installed_refs = $this->_set_caffeinated($installed_refs);
-        // allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
-        $installed_refs = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
-            $installed_refs
-        );
-        $this->_caffeinated_extends = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
-            $this->_caffeinated_extends
-        );
-        // loop through admin pages and setup the $_installed_pages array.
-        $hooks_ref = array();
-        foreach ($installed_refs as $page => $path) {
-            // set autoloaders for our admin page classes based on included path information
-            EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
-            // build list of installed pages
-            $this->_installed_pages[ $page ] = $this->_load_admin_page($page, $path);
-            // verify returned object
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                if (! $this->_installed_pages[ $page ]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
-                    continue;
-                }
-                // skip if in full maintenance mode and maintenance_mode_parent is set
-                $maintenance_mode_parent = $this->_installed_pages[ $page ]->get_menu_map()->maintenance_mode_parent;
-                if (empty($maintenance_mode_parent)
-                    && EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
-                ) {
-                    unset($installed_refs[ $page ]);
-                    continue;
-                }
-                $menu_slug = $this->_installed_pages[ $page ]->get_menu_map()->menu_slug;
-                $this->_menu_slugs[ $menu_slug ] = $page;
-                // flag for register hooks on extended pages b/c extended pages use the default INIT.
-                $extend = false;
-                // now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
-                if (isset($this->_caffeinated_extends[ $page ])) {
-                    $this->_current_caf_extend_slug = $page;
-                    $admin_page_name = $this->_installed_pages[ $page ]->get_admin_page_name();
-                    $caf_path = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['path'];
-                    $caf_admin_page = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['admin_page'];
-                    add_filter(
-                        "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_{$admin_page_name}",
-                        function ($path_to_file) use ($caf_path) {
-                            return $caf_path;
-                        }
-                    );
-                    add_filter(
-                        "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_{$admin_page_name}",
-                        function ($admin_page) use ($caf_admin_page) {
-                            return $caf_admin_page;
-                        }
-                    );
-                    $extend = true;
-                }
-                // let's do the registered hooks
-                $extended_hooks = $this->_installed_pages[ $page ]->register_hooks($extend);
-                $hooks_ref = array_merge($hooks_ref, $extended_hooks);
-            }
-        }
-        // the hooks_ref is all the pages where we have $extended _Hooks files that will extend a class in a different folder.  So we want to make sure we load the file for the parent.
-        // first make sure we've got unique values
-        $hooks_ref = array_unique($hooks_ref);
-        // now let's loop and require!
-        foreach ($hooks_ref as $path) {
-            require_once($path);
-        }
-        // make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
-        global $ee_menu_slugs;
-        $ee_menu_slugs = $this->_menu_slugs;
-        // we need to loop again to run any early code
-        foreach ($installed_refs as $page => $path) {
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                $this->_installed_pages[ $page ]->do_initial_loads();
-            }
-        }
-        do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
-    }
-
-
-    /**
-     * get_admin_page_object
-     *
-     * @param string $page_slug
-     * @return EE_Admin_Page
-     */
-    public function get_admin_page_object($page_slug = '')
-    {
-        if (isset($this->_installed_pages[ $page_slug ])) {
-            return $this->_installed_pages[ $page_slug ]->loaded_page_object();
-        }
-        return null;
-    }
-
-
-    /**
-     * _get_classname_for_admin_page
-     * generates an "Admin Page" class based on the directory  name
-     *
-     * @param $dir_name
-     * @return string
-     */
-    private function _get_classname_for_admin_page($dir_name = '')
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
-    }
-
-
-    /**
-     * _get_classname_for_admin_init_page
-     * generates an "Admin Page Init" class based on the directory  name
-     *
-     * @param $dir_name
-     * @return string
-     */
-    private function _get_classname_for_admin_init_page($dir_name = '')
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
-    }
-
-
-    /**
-     * _load_admin_page
-     * Loads and instantiates page_init object for a single EE_admin page.
-     *
-     * @param  string $page page_reference
-     * @param string  $path
-     * @throws EE_Error
-     * @return object|bool  return page object if valid, bool false if not.
-     */
-    private function _load_admin_page($page = '', $path = '')
-    {
-        $class_name = $this->_get_classname_for_admin_init_page($page);
-        EE_Registry::instance()->load_file($path, $class_name, 'core');
-        if (! class_exists($class_name)) {
-            $inner_error_msg = '<br />'
-                               . sprintf(
-                                   esc_html__(
-                                       'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
-                                       'event_espresso'
-                                   ),
-                                   '<strong>' . $class_name . '</strong>'
-                               );
-            $error_msg[] = sprintf(
-                __('Something went wrong with loading the %s admin page.', 'event_espresso'),
-                $page
-            );
-            $error_msg[] = $error_msg[0]
-                           . "\r\n"
-                           . sprintf(
-                               esc_html__(
-                                   'There is no Init class in place for the %s admin page.',
-                                   'event_espresso'
-                               ),
-                               $page
-                           )
-                           . $inner_error_msg;
-            throw new EE_Error(implode('||', $error_msg));
-        }
-        $a = new ReflectionClass($class_name);
-        return $a->newInstance();
-    }
-
-
-    /**
-     * set_menus
-     * This method sets up the menus for EE Admin Pages
-     *
-     * @access private
-     * @return void
-     */
-    public function set_menus()
-    {
-        // prep the menu pages (sort, group.)
-        $this->_prep_pages();
-        foreach ($this->_prepped_menu_maps as $menu_map) {
-            if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
-                $menu_map->add_menu_page(false);
-            }
-        }
-    }
-
-
-    /**
-     * set_network_menus
-     * This method sets up the menus for network EE Admin Pages.
-     * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
-     * are only added to the menu map if they are intended for the admin menu
-     *
-     * @return void
-     */
-    public function set_network_menus()
-    {
-        $this->_prep_pages();
-        foreach ($this->_prepped_menu_maps as $menu_map) {
-            if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
-                $menu_map->add_menu_page(true);
-            }
-        }
-    }
-
-
-    /**
-     * _prep_pages
-     * sets the _prepped_menu_maps property
-     *
-     * @access private
-     * @throws EE_Error
-     * @return void
-     */
-    private function _prep_pages()
-    {
-        $pages_array = array();
-        // rearrange _admin_menu_groups to be indexed by group slug.
-        $menu_groups = $this->_rearrange_menu_groups();
-        foreach ($this->_installed_pages as $page) {
-            if ($page instanceof EE_Admin_page_Init) {
-                $page_map = $page->get_menu_map();
-                // if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
-                if (is_array($page_map) || empty($page_map)) {
-                    new PersistentAdminNotice(
-                        'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
-                        sprintf(
-                            __(
-                                'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
-                                'event_espresso'
-                            ),
-                            $page->label
-                        )
-                    );
-                    continue;
-                }
-                // if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
-                if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'The menu map for %s must be an EE_Admin_Page_Menu_Map object.  Instead it is %s.  Please double check that the menu map has been configured correctly.',
-                                'event_espresso'
-                            ),
-                            $page->label,
-                            $page_map
-                        )
-                    );
-                }
-                // use the maintenance_mode_parent property and maintenance mode status to determine if this page even gets added to array.
-                if (empty($page_map->maintenance_mode_parent)
-                    && EE_Maintenance_Mode::instance()->level()
-                       == EE_Maintenance_Mode::level_2_complete_maintenance) {
-                    continue;
-                }
-                // assign to group (remember $page_map has the admin page stored in it).
-                $pages_array[ $page_map->menu_group ][] = $page_map;
-            }
-        }
-        if (empty($pages_array)) {
-            throw new EE_Error(__('Something went wrong when prepping the admin pages', 'event_espresso'));
-        }
-        // let's sort the groups, make sure it's a valid group, add header (if to show).
-        foreach ($pages_array as $group => $menu_maps) {
-            // valid_group?
-            if (! array_key_exists($group, $menu_groups)) {
-                continue;
-            }
-            // sort pages.
-            usort($menu_maps, array($this, '_sort_menu_maps'));
-            // prepend header
-            array_unshift($menu_maps, $menu_groups[ $group ]);
-            // reset $pages_array with prepped data
-            $pages_array[ $group ] = $menu_maps;
-        }
-        // now let's setup the _prepped_menu_maps property
-        foreach ($menu_groups as $group => $group_objs) {
-            if (isset($pages_array[ $group ])) {
-                $this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[ $group ]);
-            }
-        }/**/
-    }
-
-
-    /**
-     * This method is the "workhorse" for detecting and setting up caffeinated functionality.
-     * In this method there are three checks being done:
-     * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $installed_refs
-     * array) etc.  (new page sets are found in caffeinated/new/{page})
-     * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
-     * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
-     * Extend_Events_Admin_Page extends Events_Admin_Page.
-     * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
-     * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
-     * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
-     * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
-     * admin_pages)
-     *
-     * @param array $installed_refs the original installed_refs array that may contain our NEW EE_Admin_Pages to be
-     *                              loaded.
-     * @return array
-     */
-    private function _set_caffeinated($installed_refs)
-    {
-
-        // first let's check if there IS a caffeinated folder. If there is not then lets get out.
-        if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated' . DS . 'admin') || (defined('EE_DECAF') && EE_DECAF)) {
-            return $installed_refs;
-        }
-        $this->_define_caffeinated_constants();
-        $exclude = array('tickets');
-        // okay let's setup an "New" pages first (we'll return installed refs later)
-        $new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
-        if ($new_admin_screens) {
-            foreach ($new_admin_screens as $admin_screen) {
-                // files and anything in the exclude array need not apply
-                if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
-                    // these folders represent the different NEW EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
-                    // set autoloaders for our admin page classes based on included path information
-                    EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
-                }
-            }
-        }
-        // let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
-        if ($extends) {
-            foreach ($extends as $extend) {
-                if (is_dir($extend)) {
-                    $extend_ref = basename($extend);
-                    // now let's make sure there is a file that matches the expected format
-                    $filename = str_replace(
-                        ' ',
-                        '_',
-                        ucwords(
-                            str_replace(
-                                '_',
-                                ' ',
-                                $extend_ref
-                            )
-                        )
-                    );
-                    $filename = 'Extend_' . $filename . '_Admin_Page';
-                    $this->_caffeinated_extends[ $extend_ref ]['path'] = str_replace(
-                        array('\\', '/'),
-                        DS,
-                        EE_CORE_CAF_ADMIN
-                        . 'extend'
-                        . DS
-                        . $extend_ref
-                        . DS
-                        . $filename
-                        . '.core.php'
-                    );
-                    $this->_caffeinated_extends[ $extend_ref ]['admin_page'] = $filename;
-                    // set autoloaders for our admin page classes based on included path information
-                    EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
-                }
-            }
-        }
-        // let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
-        $ee_admin_hooks = array();
-        $hooks = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
-        if ($hooks) {
-            foreach ($hooks as $hook) {
-                if (is_readable($hook)) {
-                    require_once $hook;
-                    $classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
-                    $classname = str_replace('.class.php', '', $classname);
-                    if (class_exists($classname)) {
-                        $a = new ReflectionClass($classname);
-                        $ee_admin_hooks[] = $a->newInstance();
-                    }
-                }
-            }
-        }/**/
-        $ee_admin_hooks = apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
-        return $installed_refs;
-    }
-
-
-    /**
-     * Utility method for sorting the _menu_maps (callback for usort php function)
-     *
-     * @since  4.4.0
-     * @param  EE_Admin_Page_Menu_Map $a menu_map object
-     * @param  EE_Admin_Page_Menu_Map $b being compared to
-     * @return int    sort order
-     */
-    private function _sort_menu_maps(EE_Admin_Page_Menu_Map $a, EE_Admin_Page_Menu_Map $b)
-    {
-        if ($a->menu_order == $b->menu_order) {
-            return 0;
-        }
-        return ($a->menu_order < $b->menu_order) ? -1 : 1;
-    }
-
-
-    /**
-     * _default_header_link
-     * This is just a dummy method to use with header submenu items
-     *
-     * @return bool false
-     */
-    public function _default_header_link()
-    {
-        return false;
-    }
+	/**
+	 * _installed_pages
+	 * objects for page_init objects detected and loaded
+	 *
+	 * @access private
+	 * @var \EE_Admin_Page_Init[]
+	 */
+	private $_installed_pages = array();
+
+
+	/**
+	 * this is used to hold the registry of menu slugs for all the installed admin pages
+	 *
+	 * @var array
+	 */
+	private $_menu_slugs = array();
+
+
+	/**
+	 * _caffeinated_extends
+	 * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
+	 * pieces needed to do so).  This property is defined in the _set_caffeinated method.
+	 *
+	 * @var array
+	 */
+	private $_caffeinated_extends = array();
+
+
+	/**
+	 * _current_caf_extend_slug
+	 * This property is used for holding the page slug that is required for referencing the correct
+	 * _caffeinated_extends index when the corresponding core child EE_Admin_Page_init hooks are executed.
+	 *
+	 * @var array
+	 */
+	private $_current_caf_extend_slug;
+
+	/**
+	 * _prepped_menu_maps
+	 * This is the prepared array of EE_Admin_Page_Menu_Maps for adding to the admin_menu.
+	 *
+	 * @since  4.4.0
+	 * @var EE_Admin_Page_Menu_Map[]
+	 */
+	private $_prepped_menu_maps = array();
+
+
+	/**
+	 * _admin_menu_groups
+	 * array that holds the group headings and details for
+	 *
+	 * @access private
+	 * @var array
+	 */
+	private $_admin_menu_groups = array();
+
+
+	/**
+	 * This property will hold the hook file for setting up the filter that does all the connections between admin
+	 * pages.
+	 *
+	 * @var string
+	 */
+	public $hook_file;
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 * @return \EE_Admin_Page_Loader
+	 */
+	public function __construct()
+	{
+		// load menu_map classes
+		EE_Registry::instance()->load_file(EE_ADMIN, 'EE_Admin_Page_Menu_Map', 'core');
+		// define the default "groups" for the admin_pages
+		$this->_set_menu_groups();
+
+		// let's do a scan and see what installed pages we have
+		$this->_get_installed_pages();
+		// set menus (has to be done on every load - we're not actually loading the page just setting the menus and where they point to).
+		add_action('admin_menu', array($this, 'set_menus'));
+		add_action('network_admin_menu', array($this, 'set_network_menus'));
+	}
+
+
+	/**
+	 * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
+	 * files in the caffeinated folder.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _define_caffeinated_constants()
+	{
+		if (! defined('EE_CORE_CAF_ADMIN')) {
+			define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
+			define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
+			define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
+			define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+		}
+	}
+
+
+	/**
+	 * _set_menu_groups
+	 * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_menu_groups()
+	{
+
+		// set array of EE_Admin_Page_Menu_Group objects
+		$groups = array(
+			'main'       => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Main', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::NONE,
+					'menu_slug'    => 'main',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 0,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'management' => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Management', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'management',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 10,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'settings'   => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Settings', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'settings',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 30,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'templates'  => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Templates', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'templates',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 40,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'extras'     => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'              => __('Extras', 'event_espresso'),
+					'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
+					'menu_slug'               => 'extras',
+					'capability'              => 'ee_read_ee',
+					'menu_order'              => 50,
+					'parent_slug'             => 'espresso_events',
+					'maintenance_mode_parent' => 'espresso_maintenance_settings',
+				)
+			),
+			'tools'      => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __("Tools", "event_espresso"),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'tools',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 60,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'addons'     => new EE_Admin_Page_Menu_Group(
+				array(
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
+					'menu_label'   => __('Add-ons', 'event_espresso'),
+					'menu_slug'    => 'addons',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 20,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+		);
+		$this->_admin_menu_groups = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
+			$groups
+		);
+	}
+
+
+	/**
+	 * This takes all the groups in the _admin_menu_groups array and returns the array indexed by group
+	 * slug.  The other utility with this function is it validates that all the groups are instances of
+	 * EE_Admin_Page_Menu_Group (cause some invalid things might have slipped in via addons).
+	 *
+	 * @since  4.4.0
+	 * @throws \EE_Error
+	 * @return EE_Admin_Page_Menu_Group[]
+	 */
+	private function _rearrange_menu_groups()
+	{
+		$groups = array();
+		// first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
+		usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
+		foreach ($this->_admin_menu_groups as $group) {
+			if (! $group instanceof EE_Admin_Page_Menu_Group) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Unable to continue sorting the menu groups array because there is an invalid value for the menu groups.  All values in this array are required to be a EE_Admin_Page_Menu_Group object.  Instead there was: %s',
+							'event_espresso'
+						),
+						print_r($group, true)
+					)
+				);
+			}
+			$groups[ $group->menu_slug ] = $group;
+		}
+		return $groups;
+	}
+
+
+	/**
+	 * _get_installed_pages
+	 * This just gets the list of installed EE_Admin_pages.
+	 *
+	 * @access private
+	 * @throws EE_Error
+	 * @return void
+	 */
+	private function _get_installed_pages()
+	{
+		$installed_refs = array();
+		$exclude = array('assets', 'templates');
+		// grab everything in the  admin core directory
+		$admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
+		if ($admin_screens) {
+			foreach ($admin_screens as $admin_screen) {
+				// files and anything in the exclude array need not apply
+				if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
+					// these folders represent the different EE admin pages
+					$installed_refs[ basename($admin_screen) ] = $admin_screen;
+				}
+			}
+		}
+		if (empty($installed_refs)) {
+			$error_msg[] = __(
+				'There are no EE_Admin pages detected, it looks like EE did not install properly',
+				'event_espresso'
+			);
+			$error_msg[] = $error_msg[0] . "\r\n"
+						   . sprintf(
+							   __(
+								   'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
+								   'event_espresso'
+							   ),
+							   EE_ADMIN_PAGES
+						   );
+			throw new EE_Error(implode('||', $error_msg));
+		}
+		// this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
+		$installed_refs = $this->_set_caffeinated($installed_refs);
+		// allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
+		$installed_refs = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
+			$installed_refs
+		);
+		$this->_caffeinated_extends = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
+			$this->_caffeinated_extends
+		);
+		// loop through admin pages and setup the $_installed_pages array.
+		$hooks_ref = array();
+		foreach ($installed_refs as $page => $path) {
+			// set autoloaders for our admin page classes based on included path information
+			EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
+			// build list of installed pages
+			$this->_installed_pages[ $page ] = $this->_load_admin_page($page, $path);
+			// verify returned object
+			if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
+				if (! $this->_installed_pages[ $page ]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
+					continue;
+				}
+				// skip if in full maintenance mode and maintenance_mode_parent is set
+				$maintenance_mode_parent = $this->_installed_pages[ $page ]->get_menu_map()->maintenance_mode_parent;
+				if (empty($maintenance_mode_parent)
+					&& EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
+				) {
+					unset($installed_refs[ $page ]);
+					continue;
+				}
+				$menu_slug = $this->_installed_pages[ $page ]->get_menu_map()->menu_slug;
+				$this->_menu_slugs[ $menu_slug ] = $page;
+				// flag for register hooks on extended pages b/c extended pages use the default INIT.
+				$extend = false;
+				// now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
+				if (isset($this->_caffeinated_extends[ $page ])) {
+					$this->_current_caf_extend_slug = $page;
+					$admin_page_name = $this->_installed_pages[ $page ]->get_admin_page_name();
+					$caf_path = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['path'];
+					$caf_admin_page = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['admin_page'];
+					add_filter(
+						"FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_{$admin_page_name}",
+						function ($path_to_file) use ($caf_path) {
+							return $caf_path;
+						}
+					);
+					add_filter(
+						"FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_{$admin_page_name}",
+						function ($admin_page) use ($caf_admin_page) {
+							return $caf_admin_page;
+						}
+					);
+					$extend = true;
+				}
+				// let's do the registered hooks
+				$extended_hooks = $this->_installed_pages[ $page ]->register_hooks($extend);
+				$hooks_ref = array_merge($hooks_ref, $extended_hooks);
+			}
+		}
+		// the hooks_ref is all the pages where we have $extended _Hooks files that will extend a class in a different folder.  So we want to make sure we load the file for the parent.
+		// first make sure we've got unique values
+		$hooks_ref = array_unique($hooks_ref);
+		// now let's loop and require!
+		foreach ($hooks_ref as $path) {
+			require_once($path);
+		}
+		// make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
+		global $ee_menu_slugs;
+		$ee_menu_slugs = $this->_menu_slugs;
+		// we need to loop again to run any early code
+		foreach ($installed_refs as $page => $path) {
+			if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
+				$this->_installed_pages[ $page ]->do_initial_loads();
+			}
+		}
+		do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
+	}
+
+
+	/**
+	 * get_admin_page_object
+	 *
+	 * @param string $page_slug
+	 * @return EE_Admin_Page
+	 */
+	public function get_admin_page_object($page_slug = '')
+	{
+		if (isset($this->_installed_pages[ $page_slug ])) {
+			return $this->_installed_pages[ $page_slug ]->loaded_page_object();
+		}
+		return null;
+	}
+
+
+	/**
+	 * _get_classname_for_admin_page
+	 * generates an "Admin Page" class based on the directory  name
+	 *
+	 * @param $dir_name
+	 * @return string
+	 */
+	private function _get_classname_for_admin_page($dir_name = '')
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+	}
+
+
+	/**
+	 * _get_classname_for_admin_init_page
+	 * generates an "Admin Page Init" class based on the directory  name
+	 *
+	 * @param $dir_name
+	 * @return string
+	 */
+	private function _get_classname_for_admin_init_page($dir_name = '')
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+	}
+
+
+	/**
+	 * _load_admin_page
+	 * Loads and instantiates page_init object for a single EE_admin page.
+	 *
+	 * @param  string $page page_reference
+	 * @param string  $path
+	 * @throws EE_Error
+	 * @return object|bool  return page object if valid, bool false if not.
+	 */
+	private function _load_admin_page($page = '', $path = '')
+	{
+		$class_name = $this->_get_classname_for_admin_init_page($page);
+		EE_Registry::instance()->load_file($path, $class_name, 'core');
+		if (! class_exists($class_name)) {
+			$inner_error_msg = '<br />'
+							   . sprintf(
+								   esc_html__(
+									   'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
+									   'event_espresso'
+								   ),
+								   '<strong>' . $class_name . '</strong>'
+							   );
+			$error_msg[] = sprintf(
+				__('Something went wrong with loading the %s admin page.', 'event_espresso'),
+				$page
+			);
+			$error_msg[] = $error_msg[0]
+						   . "\r\n"
+						   . sprintf(
+							   esc_html__(
+								   'There is no Init class in place for the %s admin page.',
+								   'event_espresso'
+							   ),
+							   $page
+						   )
+						   . $inner_error_msg;
+			throw new EE_Error(implode('||', $error_msg));
+		}
+		$a = new ReflectionClass($class_name);
+		return $a->newInstance();
+	}
+
+
+	/**
+	 * set_menus
+	 * This method sets up the menus for EE Admin Pages
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function set_menus()
+	{
+		// prep the menu pages (sort, group.)
+		$this->_prep_pages();
+		foreach ($this->_prepped_menu_maps as $menu_map) {
+			if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
+				$menu_map->add_menu_page(false);
+			}
+		}
+	}
+
+
+	/**
+	 * set_network_menus
+	 * This method sets up the menus for network EE Admin Pages.
+	 * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
+	 * are only added to the menu map if they are intended for the admin menu
+	 *
+	 * @return void
+	 */
+	public function set_network_menus()
+	{
+		$this->_prep_pages();
+		foreach ($this->_prepped_menu_maps as $menu_map) {
+			if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
+				$menu_map->add_menu_page(true);
+			}
+		}
+	}
+
+
+	/**
+	 * _prep_pages
+	 * sets the _prepped_menu_maps property
+	 *
+	 * @access private
+	 * @throws EE_Error
+	 * @return void
+	 */
+	private function _prep_pages()
+	{
+		$pages_array = array();
+		// rearrange _admin_menu_groups to be indexed by group slug.
+		$menu_groups = $this->_rearrange_menu_groups();
+		foreach ($this->_installed_pages as $page) {
+			if ($page instanceof EE_Admin_page_Init) {
+				$page_map = $page->get_menu_map();
+				// if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
+				if (is_array($page_map) || empty($page_map)) {
+					new PersistentAdminNotice(
+						'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
+						sprintf(
+							__(
+								'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
+								'event_espresso'
+							),
+							$page->label
+						)
+					);
+					continue;
+				}
+				// if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
+				if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'The menu map for %s must be an EE_Admin_Page_Menu_Map object.  Instead it is %s.  Please double check that the menu map has been configured correctly.',
+								'event_espresso'
+							),
+							$page->label,
+							$page_map
+						)
+					);
+				}
+				// use the maintenance_mode_parent property and maintenance mode status to determine if this page even gets added to array.
+				if (empty($page_map->maintenance_mode_parent)
+					&& EE_Maintenance_Mode::instance()->level()
+					   == EE_Maintenance_Mode::level_2_complete_maintenance) {
+					continue;
+				}
+				// assign to group (remember $page_map has the admin page stored in it).
+				$pages_array[ $page_map->menu_group ][] = $page_map;
+			}
+		}
+		if (empty($pages_array)) {
+			throw new EE_Error(__('Something went wrong when prepping the admin pages', 'event_espresso'));
+		}
+		// let's sort the groups, make sure it's a valid group, add header (if to show).
+		foreach ($pages_array as $group => $menu_maps) {
+			// valid_group?
+			if (! array_key_exists($group, $menu_groups)) {
+				continue;
+			}
+			// sort pages.
+			usort($menu_maps, array($this, '_sort_menu_maps'));
+			// prepend header
+			array_unshift($menu_maps, $menu_groups[ $group ]);
+			// reset $pages_array with prepped data
+			$pages_array[ $group ] = $menu_maps;
+		}
+		// now let's setup the _prepped_menu_maps property
+		foreach ($menu_groups as $group => $group_objs) {
+			if (isset($pages_array[ $group ])) {
+				$this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[ $group ]);
+			}
+		}/**/
+	}
+
+
+	/**
+	 * This method is the "workhorse" for detecting and setting up caffeinated functionality.
+	 * In this method there are three checks being done:
+	 * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $installed_refs
+	 * array) etc.  (new page sets are found in caffeinated/new/{page})
+	 * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
+	 * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
+	 * Extend_Events_Admin_Page extends Events_Admin_Page.
+	 * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
+	 * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
+	 * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
+	 * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
+	 * admin_pages)
+	 *
+	 * @param array $installed_refs the original installed_refs array that may contain our NEW EE_Admin_Pages to be
+	 *                              loaded.
+	 * @return array
+	 */
+	private function _set_caffeinated($installed_refs)
+	{
+
+		// first let's check if there IS a caffeinated folder. If there is not then lets get out.
+		if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated' . DS . 'admin') || (defined('EE_DECAF') && EE_DECAF)) {
+			return $installed_refs;
+		}
+		$this->_define_caffeinated_constants();
+		$exclude = array('tickets');
+		// okay let's setup an "New" pages first (we'll return installed refs later)
+		$new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
+		if ($new_admin_screens) {
+			foreach ($new_admin_screens as $admin_screen) {
+				// files and anything in the exclude array need not apply
+				if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
+					// these folders represent the different NEW EE admin pages
+					$installed_refs[ basename($admin_screen) ] = $admin_screen;
+					// set autoloaders for our admin page classes based on included path information
+					EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
+				}
+			}
+		}
+		// let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
+		$extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
+		if ($extends) {
+			foreach ($extends as $extend) {
+				if (is_dir($extend)) {
+					$extend_ref = basename($extend);
+					// now let's make sure there is a file that matches the expected format
+					$filename = str_replace(
+						' ',
+						'_',
+						ucwords(
+							str_replace(
+								'_',
+								' ',
+								$extend_ref
+							)
+						)
+					);
+					$filename = 'Extend_' . $filename . '_Admin_Page';
+					$this->_caffeinated_extends[ $extend_ref ]['path'] = str_replace(
+						array('\\', '/'),
+						DS,
+						EE_CORE_CAF_ADMIN
+						. 'extend'
+						. DS
+						. $extend_ref
+						. DS
+						. $filename
+						. '.core.php'
+					);
+					$this->_caffeinated_extends[ $extend_ref ]['admin_page'] = $filename;
+					// set autoloaders for our admin page classes based on included path information
+					EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
+				}
+			}
+		}
+		// let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
+		$ee_admin_hooks = array();
+		$hooks = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
+		if ($hooks) {
+			foreach ($hooks as $hook) {
+				if (is_readable($hook)) {
+					require_once $hook;
+					$classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
+					$classname = str_replace('.class.php', '', $classname);
+					if (class_exists($classname)) {
+						$a = new ReflectionClass($classname);
+						$ee_admin_hooks[] = $a->newInstance();
+					}
+				}
+			}
+		}/**/
+		$ee_admin_hooks = apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
+		return $installed_refs;
+	}
+
+
+	/**
+	 * Utility method for sorting the _menu_maps (callback for usort php function)
+	 *
+	 * @since  4.4.0
+	 * @param  EE_Admin_Page_Menu_Map $a menu_map object
+	 * @param  EE_Admin_Page_Menu_Map $b being compared to
+	 * @return int    sort order
+	 */
+	private function _sort_menu_maps(EE_Admin_Page_Menu_Map $a, EE_Admin_Page_Menu_Map $b)
+	{
+		if ($a->menu_order == $b->menu_order) {
+			return 0;
+		}
+		return ($a->menu_order < $b->menu_order) ? -1 : 1;
+	}
+
+
+	/**
+	 * _default_header_link
+	 * This is just a dummy method to use with header submenu items
+	 *
+	 * @return bool false
+	 */
+	public function _default_header_link()
+	{
+		return false;
+	}
 }

Spacing +51 added lines, -51 removed lines

@@ -120,13 +120,13 @@ 
      */
     private function _define_caffeinated_constants()
     {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+        if ( ! defined('EE_CORE_CAF_ADMIN')) {
+            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN.'new/');
+            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN.'extend/');
+            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL.'extend/');
+            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN.'hooks/');
         }
     }
 
@@ -237,7 +237,7 @@ 
         // first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
         usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
         foreach ($this->_admin_menu_groups as $group) {
-            if (! $group instanceof EE_Admin_Page_Menu_Group) {
+            if ( ! $group instanceof EE_Admin_Page_Menu_Group) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -248,7 +248,7 @@ 
                     )
                 );
             }
-            $groups[ $group->menu_slug ] = $group;
+            $groups[$group->menu_slug] = $group;
         }
         return $groups;
     }
@@ -267,13 +267,13 @@ 
         $installed_refs = array();
         $exclude = array('assets', 'templates');
         // grab everything in the  admin core directory
-        $admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
+        $admin_screens = glob(EE_ADMIN_PAGES.'*', GLOB_ONLYDIR);
         if ($admin_screens) {
             foreach ($admin_screens as $admin_screen) {
                 // files and anything in the exclude array need not apply
                 if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
                     // these folders represent the different EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
+                    $installed_refs[basename($admin_screen)] = $admin_screen;
                 }
             }
         }
@@ -282,7 +282,7 @@ 
                 'There are no EE_Admin pages detected, it looks like EE did not install properly',
                 'event_espresso'
             );
-            $error_msg[] = $error_msg[0] . "\r\n"
+            $error_msg[] = $error_msg[0]."\r\n"
                            . sprintf(
                                __(
                                    'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
@@ -309,46 +309,46 @@ 
             // set autoloaders for our admin page classes based on included path information
             EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
             // build list of installed pages
-            $this->_installed_pages[ $page ] = $this->_load_admin_page($page, $path);
+            $this->_installed_pages[$page] = $this->_load_admin_page($page, $path);
             // verify returned object
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                if (! $this->_installed_pages[ $page ]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
+            if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
+                if ( ! $this->_installed_pages[$page]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
                     continue;
                 }
                 // skip if in full maintenance mode and maintenance_mode_parent is set
-                $maintenance_mode_parent = $this->_installed_pages[ $page ]->get_menu_map()->maintenance_mode_parent;
+                $maintenance_mode_parent = $this->_installed_pages[$page]->get_menu_map()->maintenance_mode_parent;
                 if (empty($maintenance_mode_parent)
                     && EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
                 ) {
-                    unset($installed_refs[ $page ]);
+                    unset($installed_refs[$page]);
                     continue;
                 }
-                $menu_slug = $this->_installed_pages[ $page ]->get_menu_map()->menu_slug;
-                $this->_menu_slugs[ $menu_slug ] = $page;
+                $menu_slug = $this->_installed_pages[$page]->get_menu_map()->menu_slug;
+                $this->_menu_slugs[$menu_slug] = $page;
                 // flag for register hooks on extended pages b/c extended pages use the default INIT.
                 $extend = false;
                 // now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
-                if (isset($this->_caffeinated_extends[ $page ])) {
+                if (isset($this->_caffeinated_extends[$page])) {
                     $this->_current_caf_extend_slug = $page;
-                    $admin_page_name = $this->_installed_pages[ $page ]->get_admin_page_name();
-                    $caf_path = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['path'];
-                    $caf_admin_page = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['admin_page'];
+                    $admin_page_name = $this->_installed_pages[$page]->get_admin_page_name();
+                    $caf_path = $this->_caffeinated_extends[$this->_current_caf_extend_slug]['path'];
+                    $caf_admin_page = $this->_caffeinated_extends[$this->_current_caf_extend_slug]['admin_page'];
                     add_filter(
                         "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_{$admin_page_name}",
-                        function ($path_to_file) use ($caf_path) {
+                        function($path_to_file) use ($caf_path) {
                             return $caf_path;
                         }
                     );
                     add_filter(
                         "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_{$admin_page_name}",
-                        function ($admin_page) use ($caf_admin_page) {
+                        function($admin_page) use ($caf_admin_page) {
                             return $caf_admin_page;
                         }
                     );
                     $extend = true;
                 }
                 // let's do the registered hooks
-                $extended_hooks = $this->_installed_pages[ $page ]->register_hooks($extend);
+                $extended_hooks = $this->_installed_pages[$page]->register_hooks($extend);
                 $hooks_ref = array_merge($hooks_ref, $extended_hooks);
             }
         }
@@ -364,8 +364,8 @@ 
         $ee_menu_slugs = $this->_menu_slugs;
         // we need to loop again to run any early code
         foreach ($installed_refs as $page => $path) {
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                $this->_installed_pages[ $page ]->do_initial_loads();
+            if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
+                $this->_installed_pages[$page]->do_initial_loads();
             }
         }
         do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
@@ -380,8 +380,8 @@ 
      */
     public function get_admin_page_object($page_slug = '')
     {
-        if (isset($this->_installed_pages[ $page_slug ])) {
-            return $this->_installed_pages[ $page_slug ]->loaded_page_object();
+        if (isset($this->_installed_pages[$page_slug])) {
+            return $this->_installed_pages[$page_slug]->loaded_page_object();
         }
         return null;
     }
@@ -397,7 +397,7 @@ 
     private function _get_classname_for_admin_page($dir_name = '')
     {
         $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+        return str_replace(' ', '_', ucwords($class_name)).'_Admin_Page';
     }
 
 
@@ -411,7 +411,7 @@ 
     private function _get_classname_for_admin_init_page($dir_name = '')
     {
         $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+        return str_replace(' ', '_', ucwords($class_name)).'_Admin_Page_Init';
     }
 
 
@@ -428,14 +428,14 @@ 
     {
         $class_name = $this->_get_classname_for_admin_init_page($page);
         EE_Registry::instance()->load_file($path, $class_name, 'core');
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             $inner_error_msg = '<br />'
                                . sprintf(
                                    esc_html__(
                                        'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
                                        'event_espresso'
                                    ),
-                                   '<strong>' . $class_name . '</strong>'
+                                   '<strong>'.$class_name.'</strong>'
                                );
             $error_msg[] = sprintf(
                 __('Something went wrong with loading the %s admin page.', 'event_espresso'),
@@ -515,7 +515,7 @@ 
                 // if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
                 if (is_array($page_map) || empty($page_map)) {
                     new PersistentAdminNotice(
-                        'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
+                        'menu_map_warning_'.str_replace(' ', '_', $page->label).'_'.EVENT_ESPRESSO_VERSION,
                         sprintf(
                             __(
                                 'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
@@ -527,7 +527,7 @@ 
                     continue;
                 }
                 // if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
-                if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
+                if ( ! $page_map instanceof EE_Admin_Page_Menu_Map) {
                     throw new EE_Error(
                         sprintf(
                             __(
@@ -546,7 +546,7 @@ 
                     continue;
                 }
                 // assign to group (remember $page_map has the admin page stored in it).
-                $pages_array[ $page_map->menu_group ][] = $page_map;
+                $pages_array[$page_map->menu_group][] = $page_map;
             }
         }
         if (empty($pages_array)) {
@@ -555,20 +555,20 @@ 
         // let's sort the groups, make sure it's a valid group, add header (if to show).
         foreach ($pages_array as $group => $menu_maps) {
             // valid_group?
-            if (! array_key_exists($group, $menu_groups)) {
+            if ( ! array_key_exists($group, $menu_groups)) {
                 continue;
             }
             // sort pages.
             usort($menu_maps, array($this, '_sort_menu_maps'));
             // prepend header
-            array_unshift($menu_maps, $menu_groups[ $group ]);
+            array_unshift($menu_maps, $menu_groups[$group]);
             // reset $pages_array with prepped data
-            $pages_array[ $group ] = $menu_maps;
+            $pages_array[$group] = $menu_maps;
         }
         // now let's setup the _prepped_menu_maps property
         foreach ($menu_groups as $group => $group_objs) {
-            if (isset($pages_array[ $group ])) {
-                $this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[ $group ]);
+            if (isset($pages_array[$group])) {
+                $this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[$group]);
             }
         }/**/
     }
@@ -596,26 +596,26 @@ 
     {
 
         // first let's check if there IS a caffeinated folder. If there is not then lets get out.
-        if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated' . DS . 'admin') || (defined('EE_DECAF') && EE_DECAF)) {
+        if ( ! is_dir(EE_PLUGIN_DIR_PATH.'caffeinated'.DS.'admin') || (defined('EE_DECAF') && EE_DECAF)) {
             return $installed_refs;
         }
         $this->_define_caffeinated_constants();
         $exclude = array('tickets');
         // okay let's setup an "New" pages first (we'll return installed refs later)
-        $new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
+        $new_admin_screens = glob(EE_CORE_CAF_ADMIN.'new/*', GLOB_ONLYDIR);
         if ($new_admin_screens) {
             foreach ($new_admin_screens as $admin_screen) {
                 // files and anything in the exclude array need not apply
                 if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
                     // these folders represent the different NEW EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
+                    $installed_refs[basename($admin_screen)] = $admin_screen;
                     // set autoloaders for our admin page classes based on included path information
                     EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
                 }
             }
         }
         // let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
+        $extends = glob(EE_CORE_CAF_ADMIN.'extend/*', GLOB_ONLYDIR);
         if ($extends) {
             foreach ($extends as $extend) {
                 if (is_dir($extend)) {
@@ -632,8 +632,8 @@ 
                             )
                         )
                     );
-                    $filename = 'Extend_' . $filename . '_Admin_Page';
-                    $this->_caffeinated_extends[ $extend_ref ]['path'] = str_replace(
+                    $filename = 'Extend_'.$filename.'_Admin_Page';
+                    $this->_caffeinated_extends[$extend_ref]['path'] = str_replace(
                         array('\\', '/'),
                         DS,
                         EE_CORE_CAF_ADMIN
@@ -644,7 +644,7 @@ 
                         . $filename
                         . '.core.php'
                     );
-                    $this->_caffeinated_extends[ $extend_ref ]['admin_page'] = $filename;
+                    $this->_caffeinated_extends[$extend_ref]['admin_page'] = $filename;
                     // set autoloaders for our admin page classes based on included path information
                     EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
                 }
@@ -652,12 +652,12 @@ 
         }
         // let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
         $ee_admin_hooks = array();
-        $hooks = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
+        $hooks = glob(EE_CORE_CAF_ADMIN.'hooks/*.class.php');
         if ($hooks) {
             foreach ($hooks as $hook) {
                 if (is_readable($hook)) {
                     require_once $hook;
-                    $classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
+                    $classname = str_replace(EE_CORE_CAF_ADMIN.'hooks/', '', $hook);
                     $classname = str_replace('.class.php', '', $classname);
                     if (class_exists($classname)) {
                         $a = new ReflectionClass($classname);

core/admin/EE_Admin_Page_Menu_Map.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
      *
      * @param  array $menu_args           An array of arguments used to setup the menu
      *                                    properties on construct.
-     * @param  array $required            An array of keys that should be in the $menu_args, this
+     * @param  string[] $required            An array of keys that should be in the $menu_args, this
      *                                    is used to validate that the items that should be defined
      *                                    are present.
      * @return void

Indentation +357 added lines, -357 removed lines

@@ -11,257 +11,257 @@ 
 {
 
 
-    /**
-     * The title for the menu page. (the page the menu links to)
-     *
-     * @since  4.4.0
-     * @var string
-     */
-    public $title;
-
-
-    /**
-     * The label for the menu item. (What shows up in the actual menu).
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_label;
-
-
-    /**
-     * What menu item is the parent of this menu item.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $parent_slug;
-
-
-    /**
-     * What capability is required to access this page.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $capability = 'administrator';
-
-
-    /**
-     * What slug should be used to reference this menu item.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_slug;
-
-
-    /**
-     * The callback for displaying the page that the menu references.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_callback;
-
-
-    /**
-     * The EE_Admin_Page_Init attached to this map.
-     *
-     * @var EE_Admin_Page_Init
-     */
-    public $admin_init_page;
-
-
-    /**
-     * The EE specific group this menu item belongs in (group slug).
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_group;
-
-
-    /**
-     * What order this item should be in the menu.
-     *
-     * @since 4.4.0
-     * @var int
-     */
-    public $menu_order;
-
-
-    const NONE = 0;
-    const BLOG_ADMIN_ONLY = 1;
-    const BLOG_AND_NETWORK_ADMIN = 2;
-    const NETWORK_ADMIN_ONLY = 3;
-
-
-    /**
-     * Whether this item is displayed in the menu or not.
-     * Sometimes an EE Admin Page needs to register itself but is not accessible via the WordPress
-     * admin menu.
-     *
-     * @since 4.4.0
-     * @var int
-     */
-    public $show_on_menu = self::BLOG_ADMIN_ONLY;
-
-
-    /**
-     * Menu maps can define a parent slug that gets used instead of the main parent slug for the menu when
-     * EE_Maintenance_Mode::level_2_complete_maintenance is active.
-     *
-     * @var bool
-     */
-    public $maintenance_mode_parent = '';
-
-
-    /**
-     * Constructor.
-     *
-     * @since 4.4.0
-     *
-     * @param  array $menu_args           An array of arguments used to setup the menu
-     *                                    properties on construct.
-     * @param  array $required            An array of keys that should be in the $menu_args, this
-     *                                    is used to validate that the items that should be defined
-     *                                    are present.
-     * @return void
-     */
-    public function __construct($menu_args, $required)
-    {
-        // filter all args before processing so plugins can manipulate various settings for menus.
-        $menu_args = apply_filters(
-            'FHEE__EE_Admin_Page_Menu_Map__construct__menu_args',
-            $menu_args,
-            $required,
-            get_class($this)
-        );
-
-
-        // verify that required keys are present in the incoming array.
-        $missing = array_diff((array) $required, array_keys((array) $menu_args));
-
-        if (! empty($missing)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        '%s is missing some expected keys in the argument array.  The following keys are missing: %s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    implode(', ', $missing)
-                )
-            );
-        }
-
-        // made it here okay, so let's set the properties!
-        foreach ($menu_args as $prop => $value) {
-            switch ($prop) {
-                case 'show_on_menu':
-                    $value = (int) $value;
-                    break;
-                case 'admin_init_page':
-                    if (in_array('admin_init_page', $required) && ! $value instanceof EE_Admin_Page_Init) {
-                        throw new EE_Error(
-                            sprintf(
-                                __(
-                                    'The value for the "admin_init_page" argument must be an instance of an EE_Admin_Page_Init object.  Instead %s was given as the value.',
-                                    'event_espresso'
-                                ),
-                                print_r($value, true)
-                            )
-                        );
-                    }
-                    break;
-                case 'menu_callback':
-                    break;
-
-                default:
-                    $value = (string) $value;
-                    break;
-            }
-            if (! EEH_Class_Tools::has_property($this, $prop)) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'The $menu_args coming into %s has a index key (%s) representing a property that is not defined by the class.  Perhaps there is a typo?',
-                            'event_espresso'
-                        ),
-                        get_class($this),
-                        $prop
-                    )
-                );
-            }
-            $this->{$prop} = $value;
-        }
-
-        // filter capabilities (both static and dynamic)
-        $this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
-        $this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
-
-        // Might need to change parent slug depending on maintenance mode.
-        if (! empty($this->maintenance_mode_parent)
-            && EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
-        ) {
-            $this->parent_slug = $this->maintenance_mode_parent;
-        }
-
-        // if empty menu_callback let's set default (but only if we have admin page init object)
-        if (empty($this->menu_callback) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
-            $this->menu_callback = array($this->admin_init_page, 'initialize_admin_page');
-        }
-    }
-
-
-    /**
-     * This method should define how the menu page gets added for this particular item
-     * and go ahead and define it.  Note that child classes MUST also return the result of
-     * the function used to register the WordPress admin page (the wp_page_slug string)
-     *
-     * @since  4.4.0
-     * @return string wp_page_slug.
-     */
-    abstract protected function _add_menu_page();
-
-
-    /**
-     * Called by client code to use this menu map for registering a WordPress admin page
-     *
-     * @param boolean $network_admin whether this is being added to the network admin page or not
-     * @since  4.4.0
-     */
-    public function add_menu_page($network_admin = false)
-    {
-
-        $show_on_menu_int = (int) $this->show_on_menu;
-        if (($network_admin
-             && in_array(
-                 $show_on_menu_int,
-                 array(self::BLOG_AND_NETWORK_ADMIN, self::NETWORK_ADMIN_ONLY),
-                 true
-             ))
-            ||
-            (! $network_admin
-             && in_array(
-                 $show_on_menu_int,
-                 array(self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY),
-                 true
-             ))) {
-            $wp_page_slug = $this->_add_menu_page();
-        } else {
-            $wp_page_slug = '';
-        }
-
-        if (! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
-            try {
-                $this->admin_init_page->set_page_dependencies($wp_page_slug);
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-    }
+	/**
+	 * The title for the menu page. (the page the menu links to)
+	 *
+	 * @since  4.4.0
+	 * @var string
+	 */
+	public $title;
+
+
+	/**
+	 * The label for the menu item. (What shows up in the actual menu).
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_label;
+
+
+	/**
+	 * What menu item is the parent of this menu item.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $parent_slug;
+
+
+	/**
+	 * What capability is required to access this page.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $capability = 'administrator';
+
+
+	/**
+	 * What slug should be used to reference this menu item.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_slug;
+
+
+	/**
+	 * The callback for displaying the page that the menu references.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_callback;
+
+
+	/**
+	 * The EE_Admin_Page_Init attached to this map.
+	 *
+	 * @var EE_Admin_Page_Init
+	 */
+	public $admin_init_page;
+
+
+	/**
+	 * The EE specific group this menu item belongs in (group slug).
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_group;
+
+
+	/**
+	 * What order this item should be in the menu.
+	 *
+	 * @since 4.4.0
+	 * @var int
+	 */
+	public $menu_order;
+
+
+	const NONE = 0;
+	const BLOG_ADMIN_ONLY = 1;
+	const BLOG_AND_NETWORK_ADMIN = 2;
+	const NETWORK_ADMIN_ONLY = 3;
+
+
+	/**
+	 * Whether this item is displayed in the menu or not.
+	 * Sometimes an EE Admin Page needs to register itself but is not accessible via the WordPress
+	 * admin menu.
+	 *
+	 * @since 4.4.0
+	 * @var int
+	 */
+	public $show_on_menu = self::BLOG_ADMIN_ONLY;
+
+
+	/**
+	 * Menu maps can define a parent slug that gets used instead of the main parent slug for the menu when
+	 * EE_Maintenance_Mode::level_2_complete_maintenance is active.
+	 *
+	 * @var bool
+	 */
+	public $maintenance_mode_parent = '';
+
+
+	/**
+	 * Constructor.
+	 *
+	 * @since 4.4.0
+	 *
+	 * @param  array $menu_args           An array of arguments used to setup the menu
+	 *                                    properties on construct.
+	 * @param  array $required            An array of keys that should be in the $menu_args, this
+	 *                                    is used to validate that the items that should be defined
+	 *                                    are present.
+	 * @return void
+	 */
+	public function __construct($menu_args, $required)
+	{
+		// filter all args before processing so plugins can manipulate various settings for menus.
+		$menu_args = apply_filters(
+			'FHEE__EE_Admin_Page_Menu_Map__construct__menu_args',
+			$menu_args,
+			$required,
+			get_class($this)
+		);
+
+
+		// verify that required keys are present in the incoming array.
+		$missing = array_diff((array) $required, array_keys((array) $menu_args));
+
+		if (! empty($missing)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'%s is missing some expected keys in the argument array.  The following keys are missing: %s',
+						'event_espresso'
+					),
+					get_class($this),
+					implode(', ', $missing)
+				)
+			);
+		}
+
+		// made it here okay, so let's set the properties!
+		foreach ($menu_args as $prop => $value) {
+			switch ($prop) {
+				case 'show_on_menu':
+					$value = (int) $value;
+					break;
+				case 'admin_init_page':
+					if (in_array('admin_init_page', $required) && ! $value instanceof EE_Admin_Page_Init) {
+						throw new EE_Error(
+							sprintf(
+								__(
+									'The value for the "admin_init_page" argument must be an instance of an EE_Admin_Page_Init object.  Instead %s was given as the value.',
+									'event_espresso'
+								),
+								print_r($value, true)
+							)
+						);
+					}
+					break;
+				case 'menu_callback':
+					break;
+
+				default:
+					$value = (string) $value;
+					break;
+			}
+			if (! EEH_Class_Tools::has_property($this, $prop)) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'The $menu_args coming into %s has a index key (%s) representing a property that is not defined by the class.  Perhaps there is a typo?',
+							'event_espresso'
+						),
+						get_class($this),
+						$prop
+					)
+				);
+			}
+			$this->{$prop} = $value;
+		}
+
+		// filter capabilities (both static and dynamic)
+		$this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
+		$this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
+
+		// Might need to change parent slug depending on maintenance mode.
+		if (! empty($this->maintenance_mode_parent)
+			&& EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
+		) {
+			$this->parent_slug = $this->maintenance_mode_parent;
+		}
+
+		// if empty menu_callback let's set default (but only if we have admin page init object)
+		if (empty($this->menu_callback) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
+			$this->menu_callback = array($this->admin_init_page, 'initialize_admin_page');
+		}
+	}
+
+
+	/**
+	 * This method should define how the menu page gets added for this particular item
+	 * and go ahead and define it.  Note that child classes MUST also return the result of
+	 * the function used to register the WordPress admin page (the wp_page_slug string)
+	 *
+	 * @since  4.4.0
+	 * @return string wp_page_slug.
+	 */
+	abstract protected function _add_menu_page();
+
+
+	/**
+	 * Called by client code to use this menu map for registering a WordPress admin page
+	 *
+	 * @param boolean $network_admin whether this is being added to the network admin page or not
+	 * @since  4.4.0
+	 */
+	public function add_menu_page($network_admin = false)
+	{
+
+		$show_on_menu_int = (int) $this->show_on_menu;
+		if (($network_admin
+			 && in_array(
+				 $show_on_menu_int,
+				 array(self::BLOG_AND_NETWORK_ADMIN, self::NETWORK_ADMIN_ONLY),
+				 true
+			 ))
+			||
+			(! $network_admin
+			 && in_array(
+				 $show_on_menu_int,
+				 array(self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY),
+				 true
+			 ))) {
+			$wp_page_slug = $this->_add_menu_page();
+		} else {
+			$wp_page_slug = '';
+		}
+
+		if (! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
+			try {
+				$this->admin_init_page->set_page_dependencies($wp_page_slug);
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+	}
 }
 
 
@@ -275,75 +275,75 @@ 
 class EE_Admin_Page_Main_Menu extends EE_Admin_Page_Menu_Map
 {
 
-    /**
-     * If included int incoming params, then this class will also register a Sub Menue Admin page with a different
-     * subtitle than the main menu item.
-     *
-     * @since 4.4.0
-     *
-     * @var string
-     */
-    public $subtitle;
-
-    /**
-     * The page to a icon used for this menu.
-     *
-     * @since  4.4.0
-     * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
-     *        for what can be set for this property.
-     * @var string
-     */
-    public $icon_url;
-
-
-    /**
-     * What position in the main menu order for the WP admin menu this menu item
-     * should show.
-     *
-     * @since  4.4.0
-     * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
-     *        for what can be set for this property.
-     * @var integer
-     */
-    public $position;
-
-
-    public function __construct($menu_args)
-    {
-        $required = array('menu_label', 'parent_slug', 'menu_slug', 'menu_group', 'menu_order', 'admin_init_page');
-
-        parent::__construct($menu_args, $required);
-
-        $this->position = ! empty($this->position) ? (int) $this->position : $this->position;
-    }
-
-
-    /**
-     * Uses the proper WP utility for registering a menu page for the main WP pages.
-     */
-    protected function _add_menu_page()
-    {
-        $main = add_menu_page(
-            $this->title,
-            $this->menu_label,
-            $this->capability,
-            $this->parent_slug,
-            $this->menu_callback,
-            $this->icon_url,
-            $this->position
-        );
-        if (! empty($this->subtitle)) {
-            add_submenu_page(
-                $this->parent_slug,
-                $this->subtitle,
-                $this->subtitle,
-                $this->capability,
-                $this->menu_slug,
-                $this->menu_callback
-            );
-        }
-        return $main;
-    }
+	/**
+	 * If included int incoming params, then this class will also register a Sub Menue Admin page with a different
+	 * subtitle than the main menu item.
+	 *
+	 * @since 4.4.0
+	 *
+	 * @var string
+	 */
+	public $subtitle;
+
+	/**
+	 * The page to a icon used for this menu.
+	 *
+	 * @since  4.4.0
+	 * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
+	 *        for what can be set for this property.
+	 * @var string
+	 */
+	public $icon_url;
+
+
+	/**
+	 * What position in the main menu order for the WP admin menu this menu item
+	 * should show.
+	 *
+	 * @since  4.4.0
+	 * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
+	 *        for what can be set for this property.
+	 * @var integer
+	 */
+	public $position;
+
+
+	public function __construct($menu_args)
+	{
+		$required = array('menu_label', 'parent_slug', 'menu_slug', 'menu_group', 'menu_order', 'admin_init_page');
+
+		parent::__construct($menu_args, $required);
+
+		$this->position = ! empty($this->position) ? (int) $this->position : $this->position;
+	}
+
+
+	/**
+	 * Uses the proper WP utility for registering a menu page for the main WP pages.
+	 */
+	protected function _add_menu_page()
+	{
+		$main = add_menu_page(
+			$this->title,
+			$this->menu_label,
+			$this->capability,
+			$this->parent_slug,
+			$this->menu_callback,
+			$this->icon_url,
+			$this->position
+		);
+		if (! empty($this->subtitle)) {
+			add_submenu_page(
+				$this->parent_slug,
+				$this->subtitle,
+				$this->subtitle,
+				$this->capability,
+				$this->menu_slug,
+				$this->menu_callback
+			);
+		}
+		return $main;
+	}
 } //end EE_Admin_Page_Main_Menu
 
 
@@ -357,23 +357,23 @@ 
 class EE_Admin_Page_Sub_Menu extends EE_Admin_Page_Main_Menu
 {
 
-    public function __construct($menu_args)
-    {
-        parent::__construct($menu_args);
-    }
-
-
-    protected function _add_menu_page()
-    {
-        return add_submenu_page(
-            $this->parent_slug,
-            $this->title,
-            $this->menu_label,
-            $this->capability,
-            $this->menu_slug,
-            $this->menu_callback
-        );
-    }
+	public function __construct($menu_args)
+	{
+		parent::__construct($menu_args);
+	}
+
+
+	protected function _add_menu_page()
+	{
+		return add_submenu_page(
+			$this->parent_slug,
+			$this->title,
+			$this->menu_label,
+			$this->capability,
+			$this->menu_slug,
+			$this->menu_callback
+		);
+	}
 }
 
 
@@ -392,28 +392,28 @@ 
 {
 
 
-    public function __construct($menu_args = array())
-    {
-        $required = array('menu_label', 'menu_slug', 'menu_order', 'parent_slug');
-        parent::__construct($menu_args, $required);
-    }
+	public function __construct($menu_args = array())
+	{
+		$required = array('menu_label', 'menu_slug', 'menu_order', 'parent_slug');
+		parent::__construct($menu_args, $required);
+	}
 
 
-    protected function _add_menu_page()
-    {
-        return add_submenu_page(
-            $this->parent_slug,
-            $this->menu_label,
-            $this->_group_link(),
-            $this->capability,
-            $this->menu_slug,
-            '__return_false'
-        );
-    }
+	protected function _add_menu_page()
+	{
+		return add_submenu_page(
+			$this->parent_slug,
+			$this->menu_label,
+			$this->_group_link(),
+			$this->capability,
+			$this->menu_slug,
+			'__return_false'
+		);
+	}
 
 
-    private function _group_link()
-    {
-        return '<span class="ee_menu_group"  onclick="return false;">' . $this->menu_label . '</span>';
-    }
+	private function _group_link()
+	{
+		return '<span class="ee_menu_group"  onclick="return false;">' . $this->menu_label . '</span>';
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -143,7 +143,7 @@ 
         // verify that required keys are present in the incoming array.
         $missing = array_diff((array) $required, array_keys((array) $menu_args));
 
-        if (! empty($missing)) {
+        if ( ! empty($missing)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -182,7 +182,7 @@ 
                     $value = (string) $value;
                     break;
             }
-            if (! EEH_Class_Tools::has_property($this, $prop)) {
+            if ( ! EEH_Class_Tools::has_property($this, $prop)) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -199,10 +199,10 @@ 
 
         // filter capabilities (both static and dynamic)
         $this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
-        $this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
+        $this->capability = apply_filters('FHEE_'.$this->menu_slug.'_capability', $this->capability, null);
 
         // Might need to change parent slug depending on maintenance mode.
-        if (! empty($this->maintenance_mode_parent)
+        if ( ! empty($this->maintenance_mode_parent)
             && EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
         ) {
             $this->parent_slug = $this->maintenance_mode_parent;
@@ -243,7 +243,7 @@ 
                  true
              ))
             ||
-            (! $network_admin
+            ( ! $network_admin
              && in_array(
                  $show_on_menu_int,
                  array(self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY),
@@ -254,7 +254,7 @@ 
             $wp_page_slug = '';
         }
 
-        if (! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
+        if ( ! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
             try {
                 $this->admin_init_page->set_page_dependencies($wp_page_slug);
             } catch (EE_Error $e) {
@@ -332,7 +332,7 @@ 
             $this->icon_url,
             $this->position
         );
-        if (! empty($this->subtitle)) {
+        if ( ! empty($this->subtitle)) {
             add_submenu_page(
                 $this->parent_slug,
                 $this->subtitle,
@@ -414,6 +414,6 @@ 
 
     private function _group_link()
     {
-        return '<span class="ee_menu_group"  onclick="return false;">' . $this->menu_label . '</span>';
+        return '<span class="ee_menu_group"  onclick="return false;">'.$this->menu_label.'</span>';
     }
 }

core/admin/EE_Help_Tour.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -96,7 +96,7 @@
      *
      * @access public
      * @param boolean $caf used to indicate if this tour is happening on caf install or not.
-     * @return void
+     * @return EE_Help_Tour
      */
     public function __construct($caf = false)
     {

Indentation +264 added lines, -264 removed lines

@@ -15,268 +15,268 @@
 abstract class EE_Help_Tour extends EE_Base
 {
 
-    /**
-     * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
-     * constructor of the child class.
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_label = '';
-
-
-    /**
-     * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
-     * cookies for the tour. Set this in the constructor of the child class.
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_slug = '';
-
-
-    /**
-     * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
-     * setting up a tour on a given page. format for array is: array(
-     *        0 => array(
-     *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
-     *            precendence even if you also set class.
-     *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
-     *            this param. The first element for that class is the anchor. If the class or the id are empty then the
-     *            stop will be a modal on the page anchored to the main body.
-     *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
-     *            'button_text' => 'custom text for button', //optional
-     *            'content' => 'The content for the stop', //required
-     *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
-     *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
-     *            when this tour has been set to run on timer.
-     *            'options' => array(
-     *                //override any of the global options set via the help_tour "option_callback" for the joyride
-     *                instance on this specific stop.
-     *                )
-     *            )
-     *        );
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_stops = array();
-
-
-    /**
-     * This contains any stop specific options for the tour.
-     * defaults are set but child classes can override.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_options = array();
-
-
-    /**
-     * holds anything found in the $_REQUEST object (however we override any _gets with _post data).
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_req_data = array();
-
-
-    /**
-     * a flag that is set on init for whether this help_tour is happening on a caf install or not.
-     *
-     * @var boolean
-     */
-    protected $_is_caf = false;
-
-
-    /**
-     * _constructor
-     * initialized the tour object and sets up important properties required to setup the tour.
-     *
-     * @access public
-     * @param boolean $caf used to indicate if this tour is happening on caf install or not.
-     * @return void
-     */
-    public function __construct($caf = false)
-    {
-        $this->_is_caf = $caf;
-        $this->_req_data = array_merge($_GET, $_POST);
-        $this->_set_tour_properties();
-        $this->_set_tour_stops();
-        $this->_set_tour_options();
-
-        // make sure the last tour stop has "end tour" for its button
-        $end = array_pop($this->_stops);
-        $end['button_text'] = __('End Tour', 'event_espresso');
-        // add back to stops
-        $this->_stops[] = $end;
-    }
-
-
-    /**
-     * required method that has the sole purpose of setting up the tour $_label and $_slug properties
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tour_properties();
-
-
-    /**
-     * required method that's sole purpose is to setup the $_stops property
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tour_stops();
-
-
-    /**
-     * The method can optionally be overridden by child classes to set the _options array if there are any default
-     * options the child wishes to override for a this tour. See property definition for more info
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_tour_options($options = array())
-    {
-        $defaults = array(
-            'tipLocation'           => 'bottom',
-            // 'top', 'bottom', 'right', 'left' in relation to parent
-            'nubPosition'           => 'auto',
-            // override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
-            'tipAdjustmentY'        => 0,
-            // allow for adjustment of tip
-            'tipAdjustmentX'        => 0,
-            // allow for adjustment of tip
-            'scroll'                => true,
-            // whether to scrollTo the next step or not
-            'scrollSpeed'           => 300,
-            // Page scrolling speed in ms
-            'timer'                 => 0,
-            // 0 = off, all other numbers = time(ms)
-            'autoStart'             => true,
-            // true or false - false tour starts when restart called
-            'startTimerOnClick'     => true,
-            // true/false to start timer on first click
-            'nextButton'            => true,
-            // true/false for next button visibility
-            'button_text'           => __('Next', 'event_espresso'),
-            'tipAnimation'          => 'fade',
-            // 'pop' or 'fade' in each tip
-            'pauseAfter'            => array(),
-            // array of indexes where to pause the tour after
-            'tipAnimationFadeSpeed' => 300,
-            // if 'fade'- speed in ms of transition
-            'cookieMonster'         => true,
-            // true/false for whether cookies are used
-            'cookieName'            => $this->get_slug(),
-            // choose your own cookie name (setup will add the prefix for the specific page joyride)
-            'cookieDomain'          => false,
-            // set to false or yoursite.com
-            // 'tipContainer' => 'body',            // Where the tip be attached if not inline
-            'modal'                 => false,
-            // Whether to cover page with modal during the tour
-            'expose'                => false,
-            // Whether to expose the elements at each step in the tour (requires modal:true),
-            'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
-            // A method to call after an element has been exposed
-            'preRideCallback'       => 'EEHelpTour_preRideCallback',
-            // A method to call before the tour starts (passed index, tip, and cloned exposed element)
-            'postRideCallback'      => 'EEHelpTour_postRideCallback',
-            // a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
-            'preStepCallback'       => 'EEHelpTour_preStepCallback',
-            // A method to call before each step
-            'postStepCallback'      => 'EEHelpTour_postStepCallback',
-            // A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
-        );
-
-        $options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
-        $this->_options = $options;
-    }
-
-
-    /**
-     * getter functions to return all the properties for the tour.
-     */
-
-
-    /**
-     * get_slug
-     *
-     * @return string slug for the tour
-     */
-    public function get_slug()
-    {
-        if (empty($this->_slug)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_slug;
-    }
-
-
-    /**
-     * get_label
-     *
-     * @return string
-     */
-    public function get_label()
-    {
-        if (empty($this->_label)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_label;
-    }
-
-
-    /**
-     * get_stops
-     *
-     * @return array
-     */
-    public function get_stops()
-    {
-        foreach ($this->_stops as $ind => $stop) {
-            if (! isset($stop['button_text'])) {
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
-            }
-        }
-        return $this->_stops;
-    }
-
-
-    /**
-     * get options
-     *
-     * @return array
-     */
-    public function get_options()
-    {
-        // let's make sure there are not pauses set
-        foreach ($this->_stops as $ind => $stop) {
-            if (isset($stop['pause_after']) && $stop['pause_after']) {
-                $this->_options['pauseAfter'][] = $ind;
-            }
-        }
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
-    }
+	/**
+	 * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
+	 * constructor of the child class.
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_label = '';
+
+
+	/**
+	 * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
+	 * cookies for the tour. Set this in the constructor of the child class.
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_slug = '';
+
+
+	/**
+	 * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
+	 * setting up a tour on a given page. format for array is: array(
+	 *        0 => array(
+	 *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
+	 *            precendence even if you also set class.
+	 *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
+	 *            this param. The first element for that class is the anchor. If the class or the id are empty then the
+	 *            stop will be a modal on the page anchored to the main body.
+	 *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
+	 *            'button_text' => 'custom text for button', //optional
+	 *            'content' => 'The content for the stop', //required
+	 *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
+	 *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
+	 *            when this tour has been set to run on timer.
+	 *            'options' => array(
+	 *                //override any of the global options set via the help_tour "option_callback" for the joyride
+	 *                instance on this specific stop.
+	 *                )
+	 *            )
+	 *        );
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_stops = array();
+
+
+	/**
+	 * This contains any stop specific options for the tour.
+	 * defaults are set but child classes can override.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_options = array();
+
+
+	/**
+	 * holds anything found in the $_REQUEST object (however we override any _gets with _post data).
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_req_data = array();
+
+
+	/**
+	 * a flag that is set on init for whether this help_tour is happening on a caf install or not.
+	 *
+	 * @var boolean
+	 */
+	protected $_is_caf = false;
+
+
+	/**
+	 * _constructor
+	 * initialized the tour object and sets up important properties required to setup the tour.
+	 *
+	 * @access public
+	 * @param boolean $caf used to indicate if this tour is happening on caf install or not.
+	 * @return void
+	 */
+	public function __construct($caf = false)
+	{
+		$this->_is_caf = $caf;
+		$this->_req_data = array_merge($_GET, $_POST);
+		$this->_set_tour_properties();
+		$this->_set_tour_stops();
+		$this->_set_tour_options();
+
+		// make sure the last tour stop has "end tour" for its button
+		$end = array_pop($this->_stops);
+		$end['button_text'] = __('End Tour', 'event_espresso');
+		// add back to stops
+		$this->_stops[] = $end;
+	}
+
+
+	/**
+	 * required method that has the sole purpose of setting up the tour $_label and $_slug properties
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tour_properties();
+
+
+	/**
+	 * required method that's sole purpose is to setup the $_stops property
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tour_stops();
+
+
+	/**
+	 * The method can optionally be overridden by child classes to set the _options array if there are any default
+	 * options the child wishes to override for a this tour. See property definition for more info
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_tour_options($options = array())
+	{
+		$defaults = array(
+			'tipLocation'           => 'bottom',
+			// 'top', 'bottom', 'right', 'left' in relation to parent
+			'nubPosition'           => 'auto',
+			// override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
+			'tipAdjustmentY'        => 0,
+			// allow for adjustment of tip
+			'tipAdjustmentX'        => 0,
+			// allow for adjustment of tip
+			'scroll'                => true,
+			// whether to scrollTo the next step or not
+			'scrollSpeed'           => 300,
+			// Page scrolling speed in ms
+			'timer'                 => 0,
+			// 0 = off, all other numbers = time(ms)
+			'autoStart'             => true,
+			// true or false - false tour starts when restart called
+			'startTimerOnClick'     => true,
+			// true/false to start timer on first click
+			'nextButton'            => true,
+			// true/false for next button visibility
+			'button_text'           => __('Next', 'event_espresso'),
+			'tipAnimation'          => 'fade',
+			// 'pop' or 'fade' in each tip
+			'pauseAfter'            => array(),
+			// array of indexes where to pause the tour after
+			'tipAnimationFadeSpeed' => 300,
+			// if 'fade'- speed in ms of transition
+			'cookieMonster'         => true,
+			// true/false for whether cookies are used
+			'cookieName'            => $this->get_slug(),
+			// choose your own cookie name (setup will add the prefix for the specific page joyride)
+			'cookieDomain'          => false,
+			// set to false or yoursite.com
+			// 'tipContainer' => 'body',            // Where the tip be attached if not inline
+			'modal'                 => false,
+			// Whether to cover page with modal during the tour
+			'expose'                => false,
+			// Whether to expose the elements at each step in the tour (requires modal:true),
+			'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
+			// A method to call after an element has been exposed
+			'preRideCallback'       => 'EEHelpTour_preRideCallback',
+			// A method to call before the tour starts (passed index, tip, and cloned exposed element)
+			'postRideCallback'      => 'EEHelpTour_postRideCallback',
+			// a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
+			'preStepCallback'       => 'EEHelpTour_preStepCallback',
+			// A method to call before each step
+			'postStepCallback'      => 'EEHelpTour_postStepCallback',
+			// A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
+		);
+
+		$options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
+		$this->_options = $options;
+	}
+
+
+	/**
+	 * getter functions to return all the properties for the tour.
+	 */
+
+
+	/**
+	 * get_slug
+	 *
+	 * @return string slug for the tour
+	 */
+	public function get_slug()
+	{
+		if (empty($this->_slug)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_slug;
+	}
+
+
+	/**
+	 * get_label
+	 *
+	 * @return string
+	 */
+	public function get_label()
+	{
+		if (empty($this->_label)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_label;
+	}
+
+
+	/**
+	 * get_stops
+	 *
+	 * @return array
+	 */
+	public function get_stops()
+	{
+		foreach ($this->_stops as $ind => $stop) {
+			if (! isset($stop['button_text'])) {
+				$this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
+			}
+		}
+		return $this->_stops;
+	}
+
+
+	/**
+	 * get options
+	 *
+	 * @return array
+	 */
+	public function get_options()
+	{
+		// let's make sure there are not pauses set
+		foreach ($this->_stops as $ind => $stop) {
+			if (isset($stop['pause_after']) && $stop['pause_after']) {
+				$this->_options['pauseAfter'][] = $ind;
+			}
+		}
+		return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -256,8 +256,8 @@ 
     public function get_stops()
     {
         foreach ($this->_stops as $ind => $stop) {
-            if (! isset($stop['button_text'])) {
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
+            if ( ! isset($stop['button_text'])) {
+                $this->_stops[$ind]['button_text'] = $this->_options['button_text'];
             }
         }
         return $this->_stops;
@@ -277,6 +277,6 @@ 
                 $this->_options['pauseAfter'][] = $ind;
             }
         }
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
+        return apply_filters('FHEE__'.get_class($this).'__get_options', $this->_options, $this);
     }
 }

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_answers.dmsstage.php

Doc Comments -1 removed lines

@@ -62,7 +62,6 @@
     /**
      * Creates a 4.1 price base type
      * @global type $wpdb
-     * @param array $old_price
      * @param int $new_reg_id
      * @return int
      */

Spacing +7 added lines, -7 removed lines

@@ -42,8 +42,8 @@ 
         // join to attendee and then join to events table
         $this->select_expression = 'ans.*, e.event_status';
         $this->_extra_where_sql = ' AS ans 
-            INNER JOIN ' . $wpdb->prefix . 'events_attendee AS att ON ans.attendee_id = att.id
-            INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id = e.id 
+            INNER JOIN ' . $wpdb->prefix.'events_attendee AS att ON ans.attendee_id = att.id
+            INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON att.event_id = e.id 
             WHERE e.event_status !="D"';
         $this->_new_answer_table = $wpdb->prefix."esp_answer";
         $this->_new_question_table = $wpdb->prefix."esp_question";
@@ -56,7 +56,7 @@ 
         $old_attendee_table = $wpdb->prefix."events_attendee";
         $new_reg_table = $wpdb->prefix."esp_registration";
         $regs = $this->get_migration_script()->get_mapping_new_pk($old_attendee_table, $old_row['attendee_id'], $new_reg_table);
-        if (! $regs) {
+        if ( ! $regs) {
             $this->add_error(sprintf(__("Could not find new registrations for old attendee %d when creating answer %s", "event_espresso"), $old_row['attendee_id'], $this->_json_encode($old_row)));
             return false;
         }
@@ -90,12 +90,12 @@ 
             'ANS_value'=>$ans_value
         );
         $datatypes = array(
-            '%d',// REG_ID
-            '%d',// QST_ID
-            '%s',// ANS_value
+            '%d', // REG_ID
+            '%d', // QST_ID
+            '%s', // ANS_value
         );
         $success = $wpdb->insert($this->_new_answer_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_answer, $this->_new_answer_table, $cols_n_values, $datatypes));
             return 0;
         }

Indentation +93 added lines, -93 removed lines

@@ -32,102 +32,102 @@
 
 class EE_DMS_4_1_0_answers extends EE_Data_Migration_Script_Stage_Table
 {
-    private $_new_answer_table;
-    private $_new_question_table;
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __("Answers", "event_espresso");
-        $this->_old_table = $wpdb->prefix."events_answer";
-        // join to attendee and then join to events table
-        $this->select_expression = 'ans.*, e.event_status';
-        $this->_extra_where_sql = ' AS ans 
+	private $_new_answer_table;
+	private $_new_question_table;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Answers", "event_espresso");
+		$this->_old_table = $wpdb->prefix."events_answer";
+		// join to attendee and then join to events table
+		$this->select_expression = 'ans.*, e.event_status';
+		$this->_extra_where_sql = ' AS ans 
             INNER JOIN ' . $wpdb->prefix . 'events_attendee AS att ON ans.attendee_id = att.id
             INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id = e.id 
             WHERE e.event_status !="D"';
-        $this->_new_answer_table = $wpdb->prefix."esp_answer";
-        $this->_new_question_table = $wpdb->prefix."esp_question";
-        parent::__construct();
-    }
-    protected function _migrate_old_row($old_row)
-    {
-        // get the new REGs for the old answer
-        global $wpdb;
-        $old_attendee_table = $wpdb->prefix."events_attendee";
-        $new_reg_table = $wpdb->prefix."esp_registration";
-        $regs = $this->get_migration_script()->get_mapping_new_pk($old_attendee_table, $old_row['attendee_id'], $new_reg_table);
-        if (! $regs) {
-            $this->add_error(sprintf(__("Could not find new registrations for old attendee %d when creating answer %s", "event_espresso"), $old_row['attendee_id'], $this->_json_encode($old_row)));
-            return false;
-        }
-        // as inefficient as this sounds, we create an answer per REGISTRATION, (even if the registrations use the same attendee)
-        foreach ($regs as $new_reg_id) {
-            $this->_insert_new_answer($old_row, $new_reg_id);
-        }
-    }
-    /**
-     * Creates a 4.1 price base type
-     * @global type $wpdb
-     * @param array $old_price
-     * @param int $new_reg_id
-     * @return int
-     */
-    private function _insert_new_answer($old_answer, $new_reg_id)
-    {
-        global $wpdb;
-        $old_question_table = $wpdb->prefix."events_question";
-        $new_question_id = $this->get_migration_script()->get_mapping_new_pk($old_question_table, $old_answer['question_id'], $this->_new_question_table);
+		$this->_new_answer_table = $wpdb->prefix."esp_answer";
+		$this->_new_question_table = $wpdb->prefix."esp_question";
+		parent::__construct();
+	}
+	protected function _migrate_old_row($old_row)
+	{
+		// get the new REGs for the old answer
+		global $wpdb;
+		$old_attendee_table = $wpdb->prefix."events_attendee";
+		$new_reg_table = $wpdb->prefix."esp_registration";
+		$regs = $this->get_migration_script()->get_mapping_new_pk($old_attendee_table, $old_row['attendee_id'], $new_reg_table);
+		if (! $regs) {
+			$this->add_error(sprintf(__("Could not find new registrations for old attendee %d when creating answer %s", "event_espresso"), $old_row['attendee_id'], $this->_json_encode($old_row)));
+			return false;
+		}
+		// as inefficient as this sounds, we create an answer per REGISTRATION, (even if the registrations use the same attendee)
+		foreach ($regs as $new_reg_id) {
+			$this->_insert_new_answer($old_row, $new_reg_id);
+		}
+	}
+	/**
+	 * Creates a 4.1 price base type
+	 * @global type $wpdb
+	 * @param array $old_price
+	 * @param int $new_reg_id
+	 * @return int
+	 */
+	private function _insert_new_answer($old_answer, $new_reg_id)
+	{
+		global $wpdb;
+		$old_question_table = $wpdb->prefix."events_question";
+		$new_question_id = $this->get_migration_script()->get_mapping_new_pk($old_question_table, $old_answer['question_id'], $this->_new_question_table);
 
-        $question_row = $this->_get_question_type_and_system($new_question_id);
-        if ($question_row['QST_system']) {
-            // It's an answer to a system question? EE3 used to store that on both the attendee and the answers column,
-            // but not EE4! It's just stored in the attendee meta table. The answers table is ONLY for answers to custom
-            // questions.
-            return 0;
-        }
-        if (in_array($question_row['QST_type'], array('MULTIPLE'))) {
-            $ans_value = serialize(explode(",", stripslashes($old_answer['answer'])));
-        } else {
-            $ans_value = stripslashes($old_answer['answer']);
-        }
-        $cols_n_values = array(
-            'REG_ID'=>$new_reg_id,
-            'QST_ID'=>$new_question_id,
-            'ANS_value'=>$ans_value
-        );
-        $datatypes = array(
-            '%d',// REG_ID
-            '%d',// QST_ID
-            '%s',// ANS_value
-        );
-        $success = $wpdb->insert($this->_new_answer_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_answer, $this->_new_answer_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+		$question_row = $this->_get_question_type_and_system($new_question_id);
+		if ($question_row['QST_system']) {
+			// It's an answer to a system question? EE3 used to store that on both the attendee and the answers column,
+			// but not EE4! It's just stored in the attendee meta table. The answers table is ONLY for answers to custom
+			// questions.
+			return 0;
+		}
+		if (in_array($question_row['QST_type'], array('MULTIPLE'))) {
+			$ans_value = serialize(explode(",", stripslashes($old_answer['answer'])));
+		} else {
+			$ans_value = stripslashes($old_answer['answer']);
+		}
+		$cols_n_values = array(
+			'REG_ID'=>$new_reg_id,
+			'QST_ID'=>$new_question_id,
+			'ANS_value'=>$ans_value
+		);
+		$datatypes = array(
+			'%d',// REG_ID
+			'%d',// QST_ID
+			'%s',// ANS_value
+		);
+		$success = $wpdb->insert($this->_new_answer_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_answer, $this->_new_answer_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    /**
-     * Gets the question's type
-     * @global type $wpdb
-     * @param type $question_id
-     * @return array {
-     *  @type string $QST_type
-     *  @type string $QST_system
-     * }
-     */
-    private function _get_question_type_and_system($question_id)
-    {
-        global $wpdb;
-        $row = $wpdb->get_row(
-            $wpdb->prepare(
-                "SELECT QST_type, QST_system FROM ".$this->_new_question_table." WHERE QST_ID=%d LIMIT 1",
-                $question_id
-            ),
-            ARRAY_A
-        );
-        return $row;
-    }
+	/**
+	 * Gets the question's type
+	 * @global type $wpdb
+	 * @param type $question_id
+	 * @return array {
+	 *  @type string $QST_type
+	 *  @type string $QST_system
+	 * }
+	 */
+	private function _get_question_type_and_system($question_id)
+	{
+		global $wpdb;
+		$row = $wpdb->get_row(
+			$wpdb->prepare(
+				"SELECT QST_type, QST_system FROM ".$this->_new_question_table." WHERE QST_ID=%d LIMIT 1",
+				$question_id
+			),
+			ARRAY_A
+		);
+		return $row;
+	}
 }