eventespresso / event-espresso-core

acceptance_tests/Helpers/MessagesAdmin.php

Indentation +89 added lines, -89 removed lines

@@ -10,105 +10,105 @@
  */
 trait MessagesAdmin
 {
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnMessagesActivityListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params));
-    }
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnMessagesActivityListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params));
+	}
 
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnDefaultMessageTemplateListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params));
-    }
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnDefaultMessageTemplateListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params));
+	}
 
 
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnCustomMessageTemplateListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));
-    }
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnCustomMessageTemplateListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));
+	}
 
 
-    /**
-     * Directs to message settings page
-     */
-    public function amOnMessageSettingsPage()
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl());
-    }
+	/**
+	 * Directs to message settings page
+	 */
+	public function amOnMessageSettingsPage()
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl());
+	}
 
 
-    public function activateMessageTypeForMessenger($message_type_slug, $messenger_slug = 'email')
-    {
-        $this->actor()->dragAndDrop(
-            MessagesPage::draggableSettingsBoxSelectorForMessageTypeAndMessenger($message_type_slug, $messenger_slug),
-            MessagesPage::MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR
-        );
-    }
+	public function activateMessageTypeForMessenger($message_type_slug, $messenger_slug = 'email')
+	{
+		$this->actor()->dragAndDrop(
+			MessagesPage::draggableSettingsBoxSelectorForMessageTypeAndMessenger($message_type_slug, $messenger_slug),
+			MessagesPage::MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR
+		);
+	}
 
 
-    /**
-     * Assumes you are already on the list table page that has the ui for editing the template.
-     * @param string $message_type_slug
-     * @param string $context [optional] if you want to click directly to the given context in the editor
-     */
-    public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '')
-    {
-        $this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context));
-    }
+	/**
+	 * Assumes you are already on the list table page that has the ui for editing the template.
+	 * @param string $message_type_slug
+	 * @param string $context [optional] if you want to click directly to the given context in the editor
+	 */
+	public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '')
+	{
+		$this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context));
+	}
 
 
-    /**
-     * Use this action to verify that the count for the given text in the specified field is as expected.  For example
-     * filling the condition of, "There should only be 1 instance of `someaddress@email.com` in all the 'to' column.
-     *
-     * @param int    $expected_occurence_count
-     * @param string $text_to_check_for
-     * @param string $field
-     * @param string $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     */
-    public function verifyMatchingCountofTextInMessageActivityListTableFor(
-        $expected_occurence_count,
-        $text_to_check_for,
-        $field,
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin'
-    ) {
-        $elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor(
-            $field,
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $text_to_check_for
-        ));
-        $actual_count = count($elements);
-        $this->actor()->assertEquals(
-            $expected_occurence_count,
-            $actual_count,
-            sprintf(
-                'Expected %s of the %s text for the %s field but there were actually %s counted.',
-                $expected_occurence_count,
-                $text_to_check_for,
-                $field,
-                $actual_count
-            )
-        );
-    }
+	/**
+	 * Use this action to verify that the count for the given text in the specified field is as expected.  For example
+	 * filling the condition of, "There should only be 1 instance of `someaddress@email.com` in all the 'to' column.
+	 *
+	 * @param int    $expected_occurence_count
+	 * @param string $text_to_check_for
+	 * @param string $field
+	 * @param string $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 */
+	public function verifyMatchingCountofTextInMessageActivityListTableFor(
+		$expected_occurence_count,
+		$text_to_check_for,
+		$field,
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin'
+	) {
+		$elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor(
+			$field,
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$text_to_check_for
+		));
+		$actual_count = count($elements);
+		$this->actor()->assertEquals(
+			$expected_occurence_count,
+			$actual_count,
+			sprintf(
+				'Expected %s of the %s text for the %s field but there were actually %s counted.',
+				$expected_occurence_count,
+				$text_to_check_for,
+				$field,
+				$actual_count
+			)
+		);
+	}
 
 }
\ No newline at end of file

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

Indentation +476 added lines, -476 removed lines

@@ -12,481 +12,481 @@
 class Custom_Messages_Template_List_Table extends EE_Admin_List_Table
 {
 
-    /**
-     * Custom_Messages_Template_List_Table constructor.
-     *
-     * @param EE_Admin_Page $admin_page
-     */
-    public function __construct($admin_page)
-    {
-        //Set parent defaults
-        parent::__construct($admin_page);
-    }
-
-
-    /**
-     * @return Messages_Admin_Page
-     */
-    public function get_admin_page()
-    {
-        return $this->_admin_page;
-    }
-
-    /**
-     * Setup initial data.
-     */
-    protected function _setup_data()
-    {
-        $this->_data           = $this->get_admin_page()->get_message_templates(
-            $this->_per_page,
-            $this->_view,
-            false,
-            false,
-            false
-        );
-        $this->_all_data_count = $this->get_admin_page()->get_message_templates(
-            $this->_per_page,
-            $this->_view,
-            true,
-            true,
-            false
-        );
-    }
-
-
-    /**
-     * Set initial properties
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('Message Template Group', 'event_espresso'),
-            'plural'   => esc_html__('Message Template', 'event_espresso'),
-            'ajax'     => true, //for now,
-            'screen'   => $this->get_admin_page()->get_current_screen()->id,
-        );
-
-        $this->_columns = array(
-            'cb'           => '<input type="checkbox" />',
-            'name'         => esc_html__('Template Name', 'event_espresso'),
-            'message_type' => esc_html__('Message Type', 'event_espresso'),
-            'messenger'    => esc_html__('Messenger', 'event_espresso'),
-            'description'  => esc_html__('Description', 'event_espresso'),
-            'events'       => esc_html__('Events', 'event_espresso'),
-            //count of events using this template.
-            'actions'      => ''
-        );
-
-        $this->_sortable_columns = array(
-            'messenger' => array('MTP_messenger' => true),
-        );
-
-        $this->_hidden_columns = array();
-    }
-
-
-    /**
-     * Overriding the single_row method from parent to verify whether the $item has an accessible
-     * message_type or messenger object before generating the row.
-     *
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function single_row($item)
-    {
-        $message_type = $item->message_type_obj();
-        $messenger    = $item->messenger_obj();
-
-        if (! $message_type instanceof EE_message_type || ! $messenger instanceof EE_messenger) {
-            echo '';
-            return;
-        }
-
-        parent::single_row($item);
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function _get_table_filters()
-    {
-        $filters = array();
-
-        //get select inputs
-        $select_inputs = array(
-            $this->_get_messengers_dropdown_filter(),
-            $this->_get_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;
-    }
-
-    /**
-     * we're just removing the search box for message templates, not needed.
-     *
-     * @return string (empty);
-     */
-    function search_box($text, $input_id)
-    {
-        return '';
-    }
-
-
-    /**
-     * Set the view counts on the _views property
-     */
-    protected function _add_view_counts()
-    {
-        foreach ($this->_views as $view => $args) {
-            $this->_views[$view]['count'] = $this->get_admin_page()->get_message_templates(
-                $this->_per_page,
-                $view,
-                true,
-                true,
-                false
-            );
-        }
-    }
-
-
-    /**
-     * Custom message for when there are no items found.
-     *
-     * @since 4.3.0
-     * @return string
-     */
-    public function no_items()
-    {
-        if ($this->_view !== 'trashed') {
-            printf(
-                esc_html__(
-                    '%sNo Custom Templates found.%s To create your first custom message template, go to the "Default Message Templates" tab and click the "Create Custom" button next to the template you want to use as a base for the new one.',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>'
-            );
-        } else {
-            parent::no_items();
-        }
-    }
-
-
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function column_cb($item)
-    {
-        return sprintf('<input type="checkbox" name="checkbox[%s] value="1" />', $item->GRP_ID());
-    }
-
-
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    function column_name($item)
-    {
-        return '<p>' . $item->name() . '</p>';
-    }
-
-
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    function column_description($item)
-    {
-        return '<p>' . $item->description() . '</p>';
-    }
-
-
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    function column_actions($item)
-    {
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_messages',
-            'espresso_messages_add_new_message_template'
-        )) {
-            $create_args = array(
-                'GRP_ID'       => $item->ID(),
-                'messenger'    => $item->messenger(),
-                'message_type' => $item->message_type(),
-                'action'       => 'add_new_message_template',
-            );
-            $create_link = EE_Admin_Page::add_query_args_and_nonce($create_args, EE_MSG_ADMIN_URL);
-            return sprintf(
-                '<p><a href="%s" class="button button-small">%s</a></p>',
-                $create_link,
-                esc_html__('Create Custom', 'event_espresso')
-            );
-        }
-        return '';
-    }
-
-
-    /**
-     * Return the content for the messenger column
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    function column_messenger($item)
-    {
-
-        //Build row actions
-        $actions = array();
-        $edit_lnk_url = '';
-
-        // edit link but only if item isn't trashed.
-        if (! $item->get('MTP_deleted')
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_message',
-                'espresso_messages_edit_message_template',
-                $item->ID()
-            )
-        ) {
-            $edit_lnk_url    = EE_Admin_Page::add_query_args_and_nonce(array(
-                'action' => 'edit_message_template',
-                'id'     => $item->GRP_ID(),
-            ), EE_MSG_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_lnk_url . '"'
-                               . ' class="' . $item->message_type() . '-edit-link"'
-                               . ' title="'
-                               . esc_attr__('Edit Template', 'event_espresso')
-                               . '">'
-                               . esc_html__('Edit', 'event_espresso')
-                               . '</a>';
-        }
-
-        $name_link     = ! $item->get('MTP_deleted')
-                         && EE_Registry::instance()->CAP->current_user_can(
-                             'ee_edit_message',
-                             'espresso_messages_edit_message_template',
-                             $item->ID()
-                         )
-                        && $edit_lnk_url
-            ? '<a href="'
-              . $edit_lnk_url
-              . '" title="'
-              . esc_attr__('Edit Template', 'event_espresso')
-              . '">'
-              . ucwords($item->messenger_obj()->label['singular'])
-              . '</a>'
-            : ucwords($item->messenger_obj()->label['singular']);
-        $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'   => 'trash_message_template',
-                                                                       'id'       => $item->GRP_ID(),
-                                                                       'noheader' => true,
-        ), EE_MSG_ADMIN_URL);
-        // restore link
-        $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'   => 'restore_message_template',
-                                                                         'id'       => $item->GRP_ID(),
-                                                                         'noheader' => true,
-        ), EE_MSG_ADMIN_URL);
-        // delete price link
-        $delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'   => 'delete_message_template',
-                                                                        'id'       => $item->GRP_ID(),
-                                                                        'noheader' => true,
-        ), EE_MSG_ADMIN_URL);
-
-        if (! $item->get('MTP_deleted')
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_message',
-                'espresso_messages_trash_message_template',
-                $item->ID()
-            )
-        ) {
-            $actions['trash'] = '<a href="'
-                                . $trash_lnk_url
-                                . '" title="'
-                                . esc_attr__('Move Template Group to Trash', 'event_espresso')
-                                . '">'
-                                . esc_html__('Move to Trash', 'event_espresso')
-                                . '</a>';
-        } else {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_message',
-                'espresso_messages_restore_message_template',
-                $item->ID()
-            )) {
-                $actions['restore'] = '<a href="'
-                                      . $restore_lnk_url
-                                      . '" title="'
-                                      . esc_attr__('Restore Message Template', 'event_espresso')
-                                      . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
-            }
-
-            if ($this->_view == 'trashed'
-                && EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_message',
-                    'espresso_messages_delete_message_template',
-                    $item->ID()
-                )) {
-                $actions['delete'] = '<a href="'
-                                     . $delete_lnk_url
-                                     . '" title="'
-                                     . esc_attr__('Delete Template Group Permanently', 'event_espresso')
-                                     . '">'
-                                     . esc_html__('Delete Permanently', 'event_espresso')
-                                     . '</a>';
-            }
-        }
-
-        //we want to display the contexts in here so we need to set them up
-        $c_label           = $item->context_label();
-        $c_configs         = $item->contexts_config();
-        $ctxt              = array();
-        $context_templates = $item->context_templates();
-        foreach ($context_templates as $context => $template_fields) {
-            $mtp_to        = ! empty($context_templates[$context]['to'])
-                             && $context_templates[$context]['to'] instanceof EE_Message_Template
-                ? $context_templates[$context]['to']->get('MTP_content')
-                : null;
-            $inactive      = empty($mtp_to) && ! empty($context_templates[$context]['to'])
-                ? ' class="mtp-inactive"'
-                : '';
-            $context_title = ucwords($c_configs[$context]['label']);
-            $edit_link     = EE_Admin_Page::add_query_args_and_nonce(array('action'  => 'edit_message_template',
-                                                                           'id'      => $item->GRP_ID(),
-                                                                           'context' => $context,
-            ), EE_MSG_ADMIN_URL);
-            $ctxt[]        = EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_message',
-                'espresso_messages_edit_message_template',
-                $item->ID()
-            )
-                ? '<a'
-                  . $inactive
-                  . ' class="' . $item->message_type() . '-' . $context . '-edit-link"'
-                  . ' href="' . $edit_link . '"'
-                  . ' title="' . esc_attr__('Edit Context', 'event_espresso') . '">'
-                  . $context_title
-                  . '</a>'
-                : $context_title;
-        }
-
-        $ctx_content = ! $item->get('MTP_deleted')
-                       && EE_Registry::instance()->CAP->current_user_can(
-                           'ee_edit_message',
-                           'espresso_messages_edit_message_template',
-                           $item->ID()
-                       )
-            ? sprintf(
-                '<strong>%s:</strong> ',
-                ucwords($c_label['plural'])
-            )
-              . implode(' | ', $ctxt)
-            : '';
-
-
-        //Return the name contents
-        return sprintf(
-            '%1$s <span style="color:silver">(id:%2$s)</span><br />%3$s%4$s',
-            /* $1%s */
-            $name_link,
-            /* $2%s */
-            $item->GRP_ID(),
-            /* %4$s */
-            $ctx_content,
-            /* $3%s */
-            $this->row_actions($actions)
-        );
-    }
-
-    /**
-     * column_events
-     * This provides a count of events using this custom template
-     *
-     * @param  EE_Message_Template_Group $item message_template group data
-     * @return string column output
-     */
-    function column_events($item)
-    {
-        return $item->count_events();
-    }
-
-    /**
-     * column_message_type
-     *
-     * @param  EE_Message_Template_Group $item message info for the row
-     * @return string       message_type name
-     */
-    function column_message_type($item)
-    {
-        return ucwords($item->message_type_obj()->label['singular']);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for messengers
-     *
-     * @return string
-     */
-    protected function _get_messengers_dropdown_filter()
-    {
-        $messenger_options                                   = array();
-        $active_message_template_groups_grouped_by_messenger = EEM_Message_Template_Group::instance()->get_all(
-            array(
-                array(
-                    'MTP_is_active' => true,
-                    'MTP_is_global' => false,
-                ),
-                'group_by' => 'MTP_messenger',
-            )
-        );
-
-        foreach ($active_message_template_groups_grouped_by_messenger as $active_message_template_group) {
-            if ($active_message_template_group instanceof EE_Message_Template_Group) {
-                $messenger                                                      = $active_message_template_group->messenger_obj();
-                $messenger_label                                                = $messenger instanceof EE_messenger
-                    ? $messenger->label['singular']
-                    : $active_message_template_group->messenger();
-                $messenger_options[$active_message_template_group->messenger()] = ucwords($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_message_template_groups_grouped_by_message_type = EEM_Message_Template_Group::instance()->get_all(
-            array(
-                array(
-                    'MTP_is_active' => true,
-                    'MTP_is_global' => false,
-                ),
-                'group_by' => 'MTP_message_type',
-            )
-        );
-
-        foreach ($active_message_template_groups_grouped_by_message_type as $active_message_template_group) {
-            if ($active_message_template_group instanceof EE_Message_Template_Group) {
-                $message_type                                                         = $active_message_template_group->message_type_obj();
-                $message_type_label                                                   = $message_type instanceof EE_message_type
-                    ? $message_type->label['singular']
-                    : $active_message_template_group->message_type();
-                $message_type_options[$active_message_template_group->message_type()] = ucwords($message_type_label);
-            }
-        }
-        return $this->get_admin_page()->get_message_types_select_input($message_type_options);
-    }
+	/**
+	 * Custom_Messages_Template_List_Table constructor.
+	 *
+	 * @param EE_Admin_Page $admin_page
+	 */
+	public function __construct($admin_page)
+	{
+		//Set parent defaults
+		parent::__construct($admin_page);
+	}
+
+
+	/**
+	 * @return Messages_Admin_Page
+	 */
+	public function get_admin_page()
+	{
+		return $this->_admin_page;
+	}
+
+	/**
+	 * Setup initial data.
+	 */
+	protected function _setup_data()
+	{
+		$this->_data           = $this->get_admin_page()->get_message_templates(
+			$this->_per_page,
+			$this->_view,
+			false,
+			false,
+			false
+		);
+		$this->_all_data_count = $this->get_admin_page()->get_message_templates(
+			$this->_per_page,
+			$this->_view,
+			true,
+			true,
+			false
+		);
+	}
+
+
+	/**
+	 * Set initial properties
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('Message Template Group', 'event_espresso'),
+			'plural'   => esc_html__('Message Template', 'event_espresso'),
+			'ajax'     => true, //for now,
+			'screen'   => $this->get_admin_page()->get_current_screen()->id,
+		);
+
+		$this->_columns = array(
+			'cb'           => '<input type="checkbox" />',
+			'name'         => esc_html__('Template Name', 'event_espresso'),
+			'message_type' => esc_html__('Message Type', 'event_espresso'),
+			'messenger'    => esc_html__('Messenger', 'event_espresso'),
+			'description'  => esc_html__('Description', 'event_espresso'),
+			'events'       => esc_html__('Events', 'event_espresso'),
+			//count of events using this template.
+			'actions'      => ''
+		);
+
+		$this->_sortable_columns = array(
+			'messenger' => array('MTP_messenger' => true),
+		);
+
+		$this->_hidden_columns = array();
+	}
+
+
+	/**
+	 * Overriding the single_row method from parent to verify whether the $item has an accessible
+	 * message_type or messenger object before generating the row.
+	 *
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function single_row($item)
+	{
+		$message_type = $item->message_type_obj();
+		$messenger    = $item->messenger_obj();
+
+		if (! $message_type instanceof EE_message_type || ! $messenger instanceof EE_messenger) {
+			echo '';
+			return;
+		}
+
+		parent::single_row($item);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function _get_table_filters()
+	{
+		$filters = array();
+
+		//get select inputs
+		$select_inputs = array(
+			$this->_get_messengers_dropdown_filter(),
+			$this->_get_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;
+	}
+
+	/**
+	 * we're just removing the search box for message templates, not needed.
+	 *
+	 * @return string (empty);
+	 */
+	function search_box($text, $input_id)
+	{
+		return '';
+	}
+
+
+	/**
+	 * Set the view counts on the _views property
+	 */
+	protected function _add_view_counts()
+	{
+		foreach ($this->_views as $view => $args) {
+			$this->_views[$view]['count'] = $this->get_admin_page()->get_message_templates(
+				$this->_per_page,
+				$view,
+				true,
+				true,
+				false
+			);
+		}
+	}
+
+
+	/**
+	 * Custom message for when there are no items found.
+	 *
+	 * @since 4.3.0
+	 * @return string
+	 */
+	public function no_items()
+	{
+		if ($this->_view !== 'trashed') {
+			printf(
+				esc_html__(
+					'%sNo Custom Templates found.%s To create your first custom message template, go to the "Default Message Templates" tab and click the "Create Custom" button next to the template you want to use as a base for the new one.',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>'
+			);
+		} else {
+			parent::no_items();
+		}
+	}
+
+
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function column_cb($item)
+	{
+		return sprintf('<input type="checkbox" name="checkbox[%s] value="1" />', $item->GRP_ID());
+	}
+
+
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	function column_name($item)
+	{
+		return '<p>' . $item->name() . '</p>';
+	}
+
+
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	function column_description($item)
+	{
+		return '<p>' . $item->description() . '</p>';
+	}
+
+
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	function column_actions($item)
+	{
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_messages',
+			'espresso_messages_add_new_message_template'
+		)) {
+			$create_args = array(
+				'GRP_ID'       => $item->ID(),
+				'messenger'    => $item->messenger(),
+				'message_type' => $item->message_type(),
+				'action'       => 'add_new_message_template',
+			);
+			$create_link = EE_Admin_Page::add_query_args_and_nonce($create_args, EE_MSG_ADMIN_URL);
+			return sprintf(
+				'<p><a href="%s" class="button button-small">%s</a></p>',
+				$create_link,
+				esc_html__('Create Custom', 'event_espresso')
+			);
+		}
+		return '';
+	}
+
+
+	/**
+	 * Return the content for the messenger column
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	function column_messenger($item)
+	{
+
+		//Build row actions
+		$actions = array();
+		$edit_lnk_url = '';
+
+		// edit link but only if item isn't trashed.
+		if (! $item->get('MTP_deleted')
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_message',
+				'espresso_messages_edit_message_template',
+				$item->ID()
+			)
+		) {
+			$edit_lnk_url    = EE_Admin_Page::add_query_args_and_nonce(array(
+				'action' => 'edit_message_template',
+				'id'     => $item->GRP_ID(),
+			), EE_MSG_ADMIN_URL);
+			$actions['edit'] = '<a href="' . $edit_lnk_url . '"'
+							   . ' class="' . $item->message_type() . '-edit-link"'
+							   . ' title="'
+							   . esc_attr__('Edit Template', 'event_espresso')
+							   . '">'
+							   . esc_html__('Edit', 'event_espresso')
+							   . '</a>';
+		}
+
+		$name_link     = ! $item->get('MTP_deleted')
+						 && EE_Registry::instance()->CAP->current_user_can(
+							 'ee_edit_message',
+							 'espresso_messages_edit_message_template',
+							 $item->ID()
+						 )
+						&& $edit_lnk_url
+			? '<a href="'
+			  . $edit_lnk_url
+			  . '" title="'
+			  . esc_attr__('Edit Template', 'event_espresso')
+			  . '">'
+			  . ucwords($item->messenger_obj()->label['singular'])
+			  . '</a>'
+			: ucwords($item->messenger_obj()->label['singular']);
+		$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'   => 'trash_message_template',
+																	   'id'       => $item->GRP_ID(),
+																	   'noheader' => true,
+		), EE_MSG_ADMIN_URL);
+		// restore link
+		$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'   => 'restore_message_template',
+																		 'id'       => $item->GRP_ID(),
+																		 'noheader' => true,
+		), EE_MSG_ADMIN_URL);
+		// delete price link
+		$delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'   => 'delete_message_template',
+																		'id'       => $item->GRP_ID(),
+																		'noheader' => true,
+		), EE_MSG_ADMIN_URL);
+
+		if (! $item->get('MTP_deleted')
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_message',
+				'espresso_messages_trash_message_template',
+				$item->ID()
+			)
+		) {
+			$actions['trash'] = '<a href="'
+								. $trash_lnk_url
+								. '" title="'
+								. esc_attr__('Move Template Group to Trash', 'event_espresso')
+								. '">'
+								. esc_html__('Move to Trash', 'event_espresso')
+								. '</a>';
+		} else {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_message',
+				'espresso_messages_restore_message_template',
+				$item->ID()
+			)) {
+				$actions['restore'] = '<a href="'
+									  . $restore_lnk_url
+									  . '" title="'
+									  . esc_attr__('Restore Message Template', 'event_espresso')
+									  . '">'
+									  . esc_html__('Restore', 'event_espresso') . '</a>';
+			}
+
+			if ($this->_view == 'trashed'
+				&& EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_message',
+					'espresso_messages_delete_message_template',
+					$item->ID()
+				)) {
+				$actions['delete'] = '<a href="'
+									 . $delete_lnk_url
+									 . '" title="'
+									 . esc_attr__('Delete Template Group Permanently', 'event_espresso')
+									 . '">'
+									 . esc_html__('Delete Permanently', 'event_espresso')
+									 . '</a>';
+			}
+		}
+
+		//we want to display the contexts in here so we need to set them up
+		$c_label           = $item->context_label();
+		$c_configs         = $item->contexts_config();
+		$ctxt              = array();
+		$context_templates = $item->context_templates();
+		foreach ($context_templates as $context => $template_fields) {
+			$mtp_to        = ! empty($context_templates[$context]['to'])
+							 && $context_templates[$context]['to'] instanceof EE_Message_Template
+				? $context_templates[$context]['to']->get('MTP_content')
+				: null;
+			$inactive      = empty($mtp_to) && ! empty($context_templates[$context]['to'])
+				? ' class="mtp-inactive"'
+				: '';
+			$context_title = ucwords($c_configs[$context]['label']);
+			$edit_link     = EE_Admin_Page::add_query_args_and_nonce(array('action'  => 'edit_message_template',
+																		   'id'      => $item->GRP_ID(),
+																		   'context' => $context,
+			), EE_MSG_ADMIN_URL);
+			$ctxt[]        = EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_message',
+				'espresso_messages_edit_message_template',
+				$item->ID()
+			)
+				? '<a'
+				  . $inactive
+				  . ' class="' . $item->message_type() . '-' . $context . '-edit-link"'
+				  . ' href="' . $edit_link . '"'
+				  . ' title="' . esc_attr__('Edit Context', 'event_espresso') . '">'
+				  . $context_title
+				  . '</a>'
+				: $context_title;
+		}
+
+		$ctx_content = ! $item->get('MTP_deleted')
+					   && EE_Registry::instance()->CAP->current_user_can(
+						   'ee_edit_message',
+						   'espresso_messages_edit_message_template',
+						   $item->ID()
+					   )
+			? sprintf(
+				'<strong>%s:</strong> ',
+				ucwords($c_label['plural'])
+			)
+			  . implode(' | ', $ctxt)
+			: '';
+
+
+		//Return the name contents
+		return sprintf(
+			'%1$s <span style="color:silver">(id:%2$s)</span><br />%3$s%4$s',
+			/* $1%s */
+			$name_link,
+			/* $2%s */
+			$item->GRP_ID(),
+			/* %4$s */
+			$ctx_content,
+			/* $3%s */
+			$this->row_actions($actions)
+		);
+	}
+
+	/**
+	 * column_events
+	 * This provides a count of events using this custom template
+	 *
+	 * @param  EE_Message_Template_Group $item message_template group data
+	 * @return string column output
+	 */
+	function column_events($item)
+	{
+		return $item->count_events();
+	}
+
+	/**
+	 * column_message_type
+	 *
+	 * @param  EE_Message_Template_Group $item message info for the row
+	 * @return string       message_type name
+	 */
+	function column_message_type($item)
+	{
+		return ucwords($item->message_type_obj()->label['singular']);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for messengers
+	 *
+	 * @return string
+	 */
+	protected function _get_messengers_dropdown_filter()
+	{
+		$messenger_options                                   = array();
+		$active_message_template_groups_grouped_by_messenger = EEM_Message_Template_Group::instance()->get_all(
+			array(
+				array(
+					'MTP_is_active' => true,
+					'MTP_is_global' => false,
+				),
+				'group_by' => 'MTP_messenger',
+			)
+		);
+
+		foreach ($active_message_template_groups_grouped_by_messenger as $active_message_template_group) {
+			if ($active_message_template_group instanceof EE_Message_Template_Group) {
+				$messenger                                                      = $active_message_template_group->messenger_obj();
+				$messenger_label                                                = $messenger instanceof EE_messenger
+					? $messenger->label['singular']
+					: $active_message_template_group->messenger();
+				$messenger_options[$active_message_template_group->messenger()] = ucwords($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_message_template_groups_grouped_by_message_type = EEM_Message_Template_Group::instance()->get_all(
+			array(
+				array(
+					'MTP_is_active' => true,
+					'MTP_is_global' => false,
+				),
+				'group_by' => 'MTP_message_type',
+			)
+		);
+
+		foreach ($active_message_template_groups_grouped_by_message_type as $active_message_template_group) {
+			if ($active_message_template_group instanceof EE_Message_Template_Group) {
+				$message_type                                                         = $active_message_template_group->message_type_obj();
+				$message_type_label                                                   = $message_type instanceof EE_message_type
+					? $message_type->label['singular']
+					: $active_message_template_group->message_type();
+				$message_type_options[$active_message_template_group->message_type()] = ucwords($message_type_label);
+			}
+		}
+		return $this->get_admin_page()->get_message_types_select_input($message_type_options);
+	}
 
 }

Spacing +15 added lines, -15 removed lines

@@ -37,7 +37,7 @@ 
      */
     protected function _setup_data()
     {
-        $this->_data           = $this->get_admin_page()->get_message_templates(
+        $this->_data = $this->get_admin_page()->get_message_templates(
             $this->_per_page,
             $this->_view,
             false,
@@ -97,7 +97,7 @@ 
         $message_type = $item->message_type_obj();
         $messenger    = $item->messenger_obj();
 
-        if (! $message_type instanceof EE_message_type || ! $messenger instanceof EE_messenger) {
+        if ( ! $message_type instanceof EE_message_type || ! $messenger instanceof EE_messenger) {
             echo '';
             return;
         }
@@ -195,7 +195,7 @@ 
      */
     function column_name($item)
     {
-        return '<p>' . $item->name() . '</p>';
+        return '<p>'.$item->name().'</p>';
     }
 
 
@@ -205,7 +205,7 @@ 
      */
     function column_description($item)
     {
-        return '<p>' . $item->description() . '</p>';
+        return '<p>'.$item->description().'</p>';
     }
 
 
@@ -249,19 +249,19 @@ 
         $edit_lnk_url = '';
 
         // edit link but only if item isn't trashed.
-        if (! $item->get('MTP_deleted')
+        if ( ! $item->get('MTP_deleted')
             && EE_Registry::instance()->CAP->current_user_can(
                 'ee_edit_message',
                 'espresso_messages_edit_message_template',
                 $item->ID()
             )
         ) {
-            $edit_lnk_url    = EE_Admin_Page::add_query_args_and_nonce(array(
+            $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
                 'action' => 'edit_message_template',
                 'id'     => $item->GRP_ID(),
             ), EE_MSG_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_lnk_url . '"'
-                               . ' class="' . $item->message_type() . '-edit-link"'
+            $actions['edit'] = '<a href="'.$edit_lnk_url.'"'
+                               . ' class="'.$item->message_type().'-edit-link"'
                                . ' title="'
                                . esc_attr__('Edit Template', 'event_espresso')
                                . '">'
@@ -269,7 +269,7 @@ 
                                . '</a>';
         }
 
-        $name_link     = ! $item->get('MTP_deleted')
+        $name_link = ! $item->get('MTP_deleted')
                          && EE_Registry::instance()->CAP->current_user_can(
                              'ee_edit_message',
                              'espresso_messages_edit_message_template',
@@ -299,7 +299,7 @@ 
                                                                         'noheader' => true,
         ), EE_MSG_ADMIN_URL);
 
-        if (! $item->get('MTP_deleted')
+        if ( ! $item->get('MTP_deleted')
             && EE_Registry::instance()->CAP->current_user_can(
                 'ee_delete_message',
                 'espresso_messages_trash_message_template',
@@ -324,7 +324,7 @@ 
                                       . '" title="'
                                       . esc_attr__('Restore Message Template', 'event_espresso')
                                       . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
+                                      . esc_html__('Restore', 'event_espresso').'</a>';
             }
 
             if ($this->_view == 'trashed'
@@ -361,16 +361,16 @@ 
                                                                            'id'      => $item->GRP_ID(),
                                                                            'context' => $context,
             ), EE_MSG_ADMIN_URL);
-            $ctxt[]        = EE_Registry::instance()->CAP->current_user_can(
+            $ctxt[] = EE_Registry::instance()->CAP->current_user_can(
                 'ee_edit_message',
                 'espresso_messages_edit_message_template',
                 $item->ID()
             )
                 ? '<a'
                   . $inactive
-                  . ' class="' . $item->message_type() . '-' . $context . '-edit-link"'
-                  . ' href="' . $edit_link . '"'
-                  . ' title="' . esc_attr__('Edit Context', 'event_espresso') . '">'
+                  . ' class="'.$item->message_type().'-'.$context.'-edit-link"'
+                  . ' href="'.$edit_link.'"'
+                  . ' title="'.esc_attr__('Edit Context', 'event_espresso').'">'
                   . $context_title
                   . '</a>'
                 : $context_title;

caffeinated/admin/extend/transactions/Extend_Transactions_Admin_Page.core.php

Indentation +220 added lines, -220 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -32,224 +32,224 @@ 
 {
 
 
-    /**
-     * This is used to hold the reports template data which is setup early in the request.
-     * @type array
-     */
-    protected $_reports_template_data = array();
-
-    /**
-     * @Constructor
-     * @access public
-     *
-     * @param bool $routing
-     *
-     * @return \Extend_Transactions_Admin_Page
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/');
-        define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/');
-        define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/');
-    }
-
-
-    /**
-     *    _extend_page_config
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions';
-
-        $new_page_routes = array(
-            'reports' => array(
-                'func'       => '_transaction_reports',
-                'capability' => 'ee_read_transactions'
-            )
-        );
-
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-
-        $new_page_config    = array(
-            'reports' => array(
-                'nav'           => array(
-                    'label' => __('Reports', 'event_espresso'),
-                    'order' => 20
-                ),
-                'help_tabs'     => array(
-                    'transactions_reports_help_tab' => array(
-                        'title'    => __('Transaction Reports', 'event_espresso'),
-                        'filename' => 'transactions_reports'
-                    )
-                ),
-                /*'help_tour' => array( 'Transaction_Reports_Help_Tour' ),*/
-                'require_nonce' => false
-            )
-        );
-        $this->_page_config = array_merge($this->_page_config, $new_page_config);
-    }
-
-
-    /**
-     *    load_scripts_styles_reports
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles_reports()
-    {
-        wp_register_script(
-            'ee-txn-reports-js',
-            TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js',
-            array('google-charts'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-txn-reports-js');
-        $this->_transaction_reports_js_setup();
-        EE_Registry::$i18n_js_strings['currency_format'] = EEH_Money::get_format_for_google_charts();
-    }
-
-
-    /**
-     * This is called when javascript is being enqueued to setup the various data needed for the reports js.
-     * Also $this->{$_reports_template_data} property is set for later usage by the _transaction_reports method.
-     */
-    protected function _transaction_reports_js_setup()
-    {
-        $this->_reports_template_data['admin_reports'][] = $this->_revenue_per_day_report();
-        $this->_reports_template_data['admin_reports'][] = $this->_revenue_per_event_report();
-    }
-
-
-    /**
-     * _transaction_reports
-     *    generates Business Reports regarding Transactions
-     *
-     * @return void
-     */
-    protected function _transaction_reports()
-    {
-        $template_path                              = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
-        $this->_admin_page_title                    = __('Transactions', 'event_espresso');
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
-            $this->_reports_template_data, true);
-
-        // the final template wrapper
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * _revenue_per_day_report
-     * generates Business Report showing Total Revenue per Day.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     *
-     * @return string
-     */
-    private function _revenue_per_day_report($period = '-1 month')
-    {
-
-        $report_ID = 'txn-admin-revenue-per-day-report-dv';
-
-        $TXN = EEM_Transaction::instance();
-
-        $results  = $TXN->get_revenue_per_day_report($period);
-        $results  = (array)$results;
-        $revenue  = array();
-        $subtitle = '';
-
-        if ($results) {
-            $revenue[] = array(
-                __('Date (only shows dates that have a revenue greater than 1)', 'event_espresso'),
-                __('Total Revenue', 'event_espresso')
-            );
-            foreach ($results as $result) {
-                $revenue[] = array($result->txnDate, (float)$result->revenue);
-            }
-
-            //setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
-        }
-
-        $report_title = esc_html__('Total Revenue per Day', 'event_espresso');
-
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'revenue'   => $revenue,
-            'noResults' => empty($revenue) || count($revenue) === 1,
-            'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>', '</p>')
-        );
-        wp_localize_script('ee-txn-reports-js', 'txnRevPerDay', $report_params);
-
-        return $report_ID;
-    }
-
-
-    /**
-     * _revenue_per_event_report
-     * generates Business Report showing total revenue per event.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     *
-     * @return int
-     */
-    private function _revenue_per_event_report($period = '-1 month')
-    {
-
-        $report_ID = 'txn-admin-revenue-per-event-report-dv';
-
-        $TXN      = EEM_Transaction::instance();
-        $results  = $TXN->get_revenue_per_event_report($period);
-        $results  = (array)$results;
-        $revenue  = array();
-        $subtitle = '';
-
-        if ($results) {
-            $revenue[] = array(
-                __('Event (only events that have a revenue greater than 1 are shown)', 'event_espresso'),
-                __('Total Revenue', 'event_espresso')
-            );
-            foreach ($results as $result) {
-                if ($result->revenue > 1) {
-                    $event_name = stripslashes(html_entity_decode($result->event_name, ENT_QUOTES, 'UTF-8'));
-                    $event_name = wp_trim_words($event_name, 5, '...');
-                    $revenue[]  = array($event_name, (float)$result->revenue);
-                }
-            }
-
-            //setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
-        }
-
-        $report_title = esc_html__('Total Revenue per Event', 'event_espresso');
-
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'revenue'   => $revenue,
-            'noResults' => empty($revenue),
-            'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>', '</p>')
-        );
-        wp_localize_script('ee-txn-reports-js', 'txnRevPerEvent', $report_params);
-
-        return $report_ID;
-    }
+	/**
+	 * This is used to hold the reports template data which is setup early in the request.
+	 * @type array
+	 */
+	protected $_reports_template_data = array();
+
+	/**
+	 * @Constructor
+	 * @access public
+	 *
+	 * @param bool $routing
+	 *
+	 * @return \Extend_Transactions_Admin_Page
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/');
+		define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/');
+		define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/');
+	}
+
+
+	/**
+	 *    _extend_page_config
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions';
+
+		$new_page_routes = array(
+			'reports' => array(
+				'func'       => '_transaction_reports',
+				'capability' => 'ee_read_transactions'
+			)
+		);
+
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+
+		$new_page_config    = array(
+			'reports' => array(
+				'nav'           => array(
+					'label' => __('Reports', 'event_espresso'),
+					'order' => 20
+				),
+				'help_tabs'     => array(
+					'transactions_reports_help_tab' => array(
+						'title'    => __('Transaction Reports', 'event_espresso'),
+						'filename' => 'transactions_reports'
+					)
+				),
+				/*'help_tour' => array( 'Transaction_Reports_Help_Tour' ),*/
+				'require_nonce' => false
+			)
+		);
+		$this->_page_config = array_merge($this->_page_config, $new_page_config);
+	}
+
+
+	/**
+	 *    load_scripts_styles_reports
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles_reports()
+	{
+		wp_register_script(
+			'ee-txn-reports-js',
+			TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js',
+			array('google-charts'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-txn-reports-js');
+		$this->_transaction_reports_js_setup();
+		EE_Registry::$i18n_js_strings['currency_format'] = EEH_Money::get_format_for_google_charts();
+	}
+
+
+	/**
+	 * This is called when javascript is being enqueued to setup the various data needed for the reports js.
+	 * Also $this->{$_reports_template_data} property is set for later usage by the _transaction_reports method.
+	 */
+	protected function _transaction_reports_js_setup()
+	{
+		$this->_reports_template_data['admin_reports'][] = $this->_revenue_per_day_report();
+		$this->_reports_template_data['admin_reports'][] = $this->_revenue_per_event_report();
+	}
+
+
+	/**
+	 * _transaction_reports
+	 *    generates Business Reports regarding Transactions
+	 *
+	 * @return void
+	 */
+	protected function _transaction_reports()
+	{
+		$template_path                              = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+		$this->_admin_page_title                    = __('Transactions', 'event_espresso');
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
+			$this->_reports_template_data, true);
+
+		// the final template wrapper
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * _revenue_per_day_report
+	 * generates Business Report showing Total Revenue per Day.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 *
+	 * @return string
+	 */
+	private function _revenue_per_day_report($period = '-1 month')
+	{
+
+		$report_ID = 'txn-admin-revenue-per-day-report-dv';
+
+		$TXN = EEM_Transaction::instance();
+
+		$results  = $TXN->get_revenue_per_day_report($period);
+		$results  = (array)$results;
+		$revenue  = array();
+		$subtitle = '';
+
+		if ($results) {
+			$revenue[] = array(
+				__('Date (only shows dates that have a revenue greater than 1)', 'event_espresso'),
+				__('Total Revenue', 'event_espresso')
+			);
+			foreach ($results as $result) {
+				$revenue[] = array($result->txnDate, (float)$result->revenue);
+			}
+
+			//setup the date range.
+			$beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
+		}
+
+		$report_title = esc_html__('Total Revenue per Day', 'event_espresso');
+
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'revenue'   => $revenue,
+			'noResults' => empty($revenue) || count($revenue) === 1,
+			'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
+				'<h2>' . $report_title . '</h2><p>', '</p>')
+		);
+		wp_localize_script('ee-txn-reports-js', 'txnRevPerDay', $report_params);
+
+		return $report_ID;
+	}
+
+
+	/**
+	 * _revenue_per_event_report
+	 * generates Business Report showing total revenue per event.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 *
+	 * @return int
+	 */
+	private function _revenue_per_event_report($period = '-1 month')
+	{
+
+		$report_ID = 'txn-admin-revenue-per-event-report-dv';
+
+		$TXN      = EEM_Transaction::instance();
+		$results  = $TXN->get_revenue_per_event_report($period);
+		$results  = (array)$results;
+		$revenue  = array();
+		$subtitle = '';
+
+		if ($results) {
+			$revenue[] = array(
+				__('Event (only events that have a revenue greater than 1 are shown)', 'event_espresso'),
+				__('Total Revenue', 'event_espresso')
+			);
+			foreach ($results as $result) {
+				if ($result->revenue > 1) {
+					$event_name = stripslashes(html_entity_decode($result->event_name, ENT_QUOTES, 'UTF-8'));
+					$event_name = wp_trim_words($event_name, 5, '...');
+					$revenue[]  = array($event_name, (float)$result->revenue);
+				}
+			}
+
+			//setup the date range.
+			$beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
+		}
+
+		$report_title = esc_html__('Total Revenue per Event', 'event_espresso');
+
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'revenue'   => $revenue,
+			'noResults' => empty($revenue),
+			'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
+				'<h2>' . $report_title . '</h2><p>', '</p>')
+		);
+		wp_localize_script('ee-txn-reports-js', 'txnRevPerEvent', $report_params);
+
+		return $report_ID;
+	}
 
 }

Spacing +14 added lines, -14 removed lines

@@ -49,9 +49,9 @@ 
     public function __construct($routing = true)
     {
         parent::__construct($routing);
-        define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/');
-        define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/');
-        define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/');
+        define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND.'transactions/templates/');
+        define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND.'transactions/assets/');
+        define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'transactions/assets/');
     }
 
 
@@ -63,7 +63,7 @@ 
      */
     protected function _extend_page_config()
     {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions';
+        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND.'transactions';
 
         $new_page_routes = array(
             'reports' => array(
@@ -104,7 +104,7 @@ 
     {
         wp_register_script(
             'ee-txn-reports-js',
-            TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js',
+            TXN_CAF_ASSETS_URL.'ee-transaction-admin-reports.js',
             array('google-charts'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -134,7 +134,7 @@ 
      */
     protected function _transaction_reports()
     {
-        $template_path                              = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+        $template_path                              = EE_ADMIN_TEMPLATE.'admin_reports.template.php';
         $this->_admin_page_title                    = __('Transactions', 'event_espresso');
         $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
             $this->_reports_template_data, true);
@@ -160,7 +160,7 @@ 
         $TXN = EEM_Transaction::instance();
 
         $results  = $TXN->get_revenue_per_day_report($period);
-        $results  = (array)$results;
+        $results  = (array) $results;
         $revenue  = array();
         $subtitle = '';
 
@@ -170,11 +170,11 @@ 
                 __('Total Revenue', 'event_espresso')
             );
             foreach ($results as $result) {
-                $revenue[] = array($result->txnDate, (float)$result->revenue);
+                $revenue[] = array($result->txnDate, (float) $result->revenue);
             }
 
             //setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+            $beginning_date = new DateTime('now'.$period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
                 $beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
@@ -189,7 +189,7 @@ 
             'revenue'   => $revenue,
             'noResults' => empty($revenue) || count($revenue) === 1,
             'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>', '</p>')
+                '<h2>'.$report_title.'</h2><p>', '</p>')
         );
         wp_localize_script('ee-txn-reports-js', 'txnRevPerDay', $report_params);
 
@@ -212,7 +212,7 @@ 
 
         $TXN      = EEM_Transaction::instance();
         $results  = $TXN->get_revenue_per_event_report($period);
-        $results  = (array)$results;
+        $results  = (array) $results;
         $revenue  = array();
         $subtitle = '';
 
@@ -225,12 +225,12 @@ 
                 if ($result->revenue > 1) {
                     $event_name = stripslashes(html_entity_decode($result->event_name, ENT_QUOTES, 'UTF-8'));
                     $event_name = wp_trim_words($event_name, 5, '...');
-                    $revenue[]  = array($event_name, (float)$result->revenue);
+                    $revenue[]  = array($event_name, (float) $result->revenue);
                 }
             }
 
             //setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+            $beginning_date = new DateTime('now'.$period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
                 $beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
@@ -245,7 +245,7 @@ 
             'revenue'   => $revenue,
             'noResults' => empty($revenue),
             'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>', '</p>')
+                '<h2>'.$report_title.'</h2><p>', '</p>')
         );
         wp_localize_script('ee-txn-reports-js', 'txnRevPerEvent', $report_params);
 

core/libraries/shortcodes/EE_Venue_Shortcodes.lib.php

Spacing +4 added lines, -4 removed lines

@@ -164,7 +164,7 @@ 
 
 
         //If there is no event objecdt by now then get out.
-        if (! $this->_event instanceof EE_Event) {
+        if ( ! $this->_event instanceof EE_Event) {
             return '';
         }
 
@@ -190,11 +190,11 @@ 
                 break;
 
             case 'image':
-                return '<img src="' . $venue->feature_image_url(array(200, 200,))
-                       . '" alt="' . sprintf(
+                return '<img src="'.$venue->feature_image_url(array(200, 200,))
+                       . '" alt="'.sprintf(
                            esc_attr__('%s Feature Image', 'event_espresso'),
                            $venue->get('VNU_name')
-                       ) . '" />';
+                       ).'" />';
                 break;
 
             case 'phone':

Indentation +253 added lines, -253 removed lines

@@ -16,257 +16,257 @@
 {
 
 
-    /**
-     * Will hold the EE_Event if available
-     *
-     * @var EE_Event
-     */
-    protected $_event;
-
-
-    /**
-     * Initialize properties
-     */
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Venue Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to venue related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[VENUE_TITLE]'             => esc_html__('The title for the event venue', 'event_espresso'),
-            '[VENUE_DESCRIPTION]'       => esc_html__('The description for the event venue', 'event_espresso'),
-            '[VENUE_URL]'               => esc_html__('A url to a webpage for the venue', 'event_espresso'),
-            '[VENUE_IMAGE]'             => esc_html__('An image representing the event venue', 'event_espresso'),
-            '[VENUE_PHONE]'             => esc_html__('The phone number for the venue', 'event_espresso'),
-            '[VENUE_ADDRESS]'           => esc_html__('The address for the venue', 'event_espresso'),
-            '[VENUE_ADDRESS2]'          => esc_html__('Address 2 for the venue', 'event_espresso'),
-            '[VENUE_CITY]'              => esc_html__('The city the venue is in', 'event_espresso'),
-            '[VENUE_STATE]'             => esc_html__('The state the venue is located in', 'event_espresso'),
-            '[VENUE_COUNTRY]'           => esc_html__('The country the venue is located in', 'event_espresso'),
-            '[VENUE_FORMATTED_ADDRESS]' => esc_html__(
-                'This just outputs the venue address in a semantic address format.',
-                'event_espresso'
-            ),
-            '[VENUE_ZIP]'               => esc_html__('The zip code for the venue address', 'event_espresso'),
-            '[GOOGLE_MAP_URL]'          => esc_html__(
-                'URL for the google map associated with the venue.',
-                'event_espresso'
-            ),
-            '[GOOGLE_MAP_LINK]'         => esc_html__('Link to a google map for the venue', 'event_espresso'),
-            '[GOOGLE_MAP_IMAGE]'        => esc_html__('Google map for venue wrapped in image tags', 'event_espresso'),
-        );
-    }
-
-
-    /**
-     * Parse incoming shortcode
-     * @param string $shortcode
-     * @return string
-     */
-    protected function _parser($shortcode)
-    {
-
-        switch ($shortcode) {
-            case '[VENUE_TITLE]':
-                return $this->_venue('title');
-                break;
-
-            case '[VENUE_DESCRIPTION]':
-                return $this->_venue('description');
-                break;
-
-            case '[VENUE_URL]':
-                return $this->_venue('url');
-                break;
-
-            case '[VENUE_IMAGE]':
-                return $this->_venue('image');
-                break;
-
-            case '[VENUE_PHONE]':
-                return $this->_venue('phone');
-                break;
-
-            case '[VENUE_ADDRESS]':
-                return $this->_venue('address');
-                break;
-
-            case '[VENUE_ADDRESS2]':
-                return $this->_venue('address2');
-                break;
-
-            case '[VENUE_CITY]':
-                return $this->_venue('city');
-                break;
-
-            case '[VENUE_COUNTRY]':
-                return $this->_venue('country');
-                break;
-
-            case '[VENUE_STATE]':
-                return $this->_venue('state');
-                break;
-
-            case '[VENUE_ZIP]':
-                return $this->_venue('zip');
-                break;
-
-            case '[VENUE_FORMATTED_ADDRESS]':
-                return $this->_venue('formatted_address');
-                break;
-
-            case '[GOOGLE_MAP_URL]':
-                return $this->_venue('gmap_url');
-                break;
-
-            case '[GOOGLE_MAP_LINK]':
-                return $this->_venue('gmap_link');
-                break;
-
-            case '[GOOGLE_MAP_IMAGE]':
-                return $this->_venue('gmap_link_img');
-                break;
-
-        }
-    }
-
-
-    /**
-     * This retrieves the specified venue information
-     *
-     * @param string $field  What Venue field to retrieve
-     * @return string What was retrieved!
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    private function _venue($field)
-    {
-        //we need the EE_Event object to get the venue.
-        $this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
-
-        //if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the reg_obj instead.
-        if (empty($this->_event)) {
-            $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-            $aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
-
-            $this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration ? $aee->reg_obj->event() : null;
-
-            //if still empty do we have a ticket data item?
-            $this->_event = empty($this->_event)
-                            && $this->_data instanceof EE_Ticket
-                            && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->tickets[$this->_data->ID()]['EE_Event']
-                : $this->_event;
-
-            //if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee and use that.
-            $event        = $aee instanceof EE_Messages_Addressee ? reset($aee->events) : array();
-            $this->_event = empty($this->_event) && ! empty($events) ? $event : $this->_event;
-        }
-
-
-        //If there is no event objecdt by now then get out.
-        if (! $this->_event instanceof EE_Event) {
-            return '';
-        }
-
-        /** @var EE_Venue $venue */
-        $venue = $this->_event->get_first_related('Venue');
-
-        if (empty($venue)) {
-            return '';
-        } //no venue so get out.
-
-        switch ($field) {
-            case 'title':
-                return $venue->get('VNU_name');
-                break;
-
-            case 'description':
-                return $venue->get('VNU_desc');
-                break;
-
-            case 'url':
-                $url = $venue->get('VNU_url');
-                return empty($url) ? $venue->get_permalink() : $url;
-                break;
-
-            case 'image':
-                return '<img src="' . $venue->feature_image_url(array(200, 200,))
-                       . '" alt="' . sprintf(
-                           esc_attr__('%s Feature Image', 'event_espresso'),
-                           $venue->get('VNU_name')
-                       ) . '" />';
-                break;
-
-            case 'phone':
-                return $venue->get('VNU_phone');
-                break;
-
-            case 'address':
-                return $venue->get('VNU_address');
-                break;
-
-            case 'address2':
-                return $venue->get('VNU_address2');
-                break;
-
-            case 'city':
-                return $venue->get('VNU_city');
-                break;
-
-            case 'state':
-                $state = $venue->state_obj();
-                return is_object($state) ? $state->get('STA_name') : '';
-                break;
-
-            case 'country':
-                $country = $venue->country_obj();
-                return is_object($country) ? $country->get('CNT_name') : '';
-                break;
-
-            case 'zip':
-                return $venue->get('VNU_zip');
-                break;
-
-            case 'formatted_address':
-                return EEH_Address::format($venue);
-                break;
-
-            case 'gmap_link':
-            case 'gmap_url':
-            case 'gmap_link_img':
-                $atts = $this->get_map_attributes($venue, $field);
-                return EEH_Maps::google_map_link($atts);
-                break;
-        }
-        return '';
-    }
-
-
-    /**
-     * Generates the attributes for retrieving a google_map artifact.
-     * @param EE_Venue $venue
-     * @param string   $field
-     * @return array
-     * @throws EE_Error
-     */
-    protected function get_map_attributes(EE_Venue $venue, $field = 'gmap_link')
-    {
-        $state   = $venue->state_obj();
-        $country = $venue->country_obj();
-        $atts    = array(
-            'id'      => $venue->ID(),
-            'address' => $venue->get('VNU_address'),
-            'city'    => $venue->get('VNU_city'),
-            'state'   => is_object($state) ? $state->get('STA_name') : '',
-            'zip'     => $venue->get('VNU_zip'),
-            'country' => is_object($country) ? $country->get('CNT_name') : '',
-            'type'    => $field === 'gmap_link' ? 'url' : 'map',
-            'map_w'   => 200,
-            'map_h'   => 200,
-        );
-        if ($field === 'gmap_url') {
-            $atts['type'] = 'url_only';
-        }
-        return $atts;
-    }
+	/**
+	 * Will hold the EE_Event if available
+	 *
+	 * @var EE_Event
+	 */
+	protected $_event;
+
+
+	/**
+	 * Initialize properties
+	 */
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Venue Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to venue related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[VENUE_TITLE]'             => esc_html__('The title for the event venue', 'event_espresso'),
+			'[VENUE_DESCRIPTION]'       => esc_html__('The description for the event venue', 'event_espresso'),
+			'[VENUE_URL]'               => esc_html__('A url to a webpage for the venue', 'event_espresso'),
+			'[VENUE_IMAGE]'             => esc_html__('An image representing the event venue', 'event_espresso'),
+			'[VENUE_PHONE]'             => esc_html__('The phone number for the venue', 'event_espresso'),
+			'[VENUE_ADDRESS]'           => esc_html__('The address for the venue', 'event_espresso'),
+			'[VENUE_ADDRESS2]'          => esc_html__('Address 2 for the venue', 'event_espresso'),
+			'[VENUE_CITY]'              => esc_html__('The city the venue is in', 'event_espresso'),
+			'[VENUE_STATE]'             => esc_html__('The state the venue is located in', 'event_espresso'),
+			'[VENUE_COUNTRY]'           => esc_html__('The country the venue is located in', 'event_espresso'),
+			'[VENUE_FORMATTED_ADDRESS]' => esc_html__(
+				'This just outputs the venue address in a semantic address format.',
+				'event_espresso'
+			),
+			'[VENUE_ZIP]'               => esc_html__('The zip code for the venue address', 'event_espresso'),
+			'[GOOGLE_MAP_URL]'          => esc_html__(
+				'URL for the google map associated with the venue.',
+				'event_espresso'
+			),
+			'[GOOGLE_MAP_LINK]'         => esc_html__('Link to a google map for the venue', 'event_espresso'),
+			'[GOOGLE_MAP_IMAGE]'        => esc_html__('Google map for venue wrapped in image tags', 'event_espresso'),
+		);
+	}
+
+
+	/**
+	 * Parse incoming shortcode
+	 * @param string $shortcode
+	 * @return string
+	 */
+	protected function _parser($shortcode)
+	{
+
+		switch ($shortcode) {
+			case '[VENUE_TITLE]':
+				return $this->_venue('title');
+				break;
+
+			case '[VENUE_DESCRIPTION]':
+				return $this->_venue('description');
+				break;
+
+			case '[VENUE_URL]':
+				return $this->_venue('url');
+				break;
+
+			case '[VENUE_IMAGE]':
+				return $this->_venue('image');
+				break;
+
+			case '[VENUE_PHONE]':
+				return $this->_venue('phone');
+				break;
+
+			case '[VENUE_ADDRESS]':
+				return $this->_venue('address');
+				break;
+
+			case '[VENUE_ADDRESS2]':
+				return $this->_venue('address2');
+				break;
+
+			case '[VENUE_CITY]':
+				return $this->_venue('city');
+				break;
+
+			case '[VENUE_COUNTRY]':
+				return $this->_venue('country');
+				break;
+
+			case '[VENUE_STATE]':
+				return $this->_venue('state');
+				break;
+
+			case '[VENUE_ZIP]':
+				return $this->_venue('zip');
+				break;
+
+			case '[VENUE_FORMATTED_ADDRESS]':
+				return $this->_venue('formatted_address');
+				break;
+
+			case '[GOOGLE_MAP_URL]':
+				return $this->_venue('gmap_url');
+				break;
+
+			case '[GOOGLE_MAP_LINK]':
+				return $this->_venue('gmap_link');
+				break;
+
+			case '[GOOGLE_MAP_IMAGE]':
+				return $this->_venue('gmap_link_img');
+				break;
+
+		}
+	}
+
+
+	/**
+	 * This retrieves the specified venue information
+	 *
+	 * @param string $field  What Venue field to retrieve
+	 * @return string What was retrieved!
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	private function _venue($field)
+	{
+		//we need the EE_Event object to get the venue.
+		$this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
+
+		//if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the reg_obj instead.
+		if (empty($this->_event)) {
+			$aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+			$aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
+
+			$this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration ? $aee->reg_obj->event() : null;
+
+			//if still empty do we have a ticket data item?
+			$this->_event = empty($this->_event)
+							&& $this->_data instanceof EE_Ticket
+							&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+				? $this->_extra_data['data']->tickets[$this->_data->ID()]['EE_Event']
+				: $this->_event;
+
+			//if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee and use that.
+			$event        = $aee instanceof EE_Messages_Addressee ? reset($aee->events) : array();
+			$this->_event = empty($this->_event) && ! empty($events) ? $event : $this->_event;
+		}
+
+
+		//If there is no event objecdt by now then get out.
+		if (! $this->_event instanceof EE_Event) {
+			return '';
+		}
+
+		/** @var EE_Venue $venue */
+		$venue = $this->_event->get_first_related('Venue');
+
+		if (empty($venue)) {
+			return '';
+		} //no venue so get out.
+
+		switch ($field) {
+			case 'title':
+				return $venue->get('VNU_name');
+				break;
+
+			case 'description':
+				return $venue->get('VNU_desc');
+				break;
+
+			case 'url':
+				$url = $venue->get('VNU_url');
+				return empty($url) ? $venue->get_permalink() : $url;
+				break;
+
+			case 'image':
+				return '<img src="' . $venue->feature_image_url(array(200, 200,))
+					   . '" alt="' . sprintf(
+						   esc_attr__('%s Feature Image', 'event_espresso'),
+						   $venue->get('VNU_name')
+					   ) . '" />';
+				break;
+
+			case 'phone':
+				return $venue->get('VNU_phone');
+				break;
+
+			case 'address':
+				return $venue->get('VNU_address');
+				break;
+
+			case 'address2':
+				return $venue->get('VNU_address2');
+				break;
+
+			case 'city':
+				return $venue->get('VNU_city');
+				break;
+
+			case 'state':
+				$state = $venue->state_obj();
+				return is_object($state) ? $state->get('STA_name') : '';
+				break;
+
+			case 'country':
+				$country = $venue->country_obj();
+				return is_object($country) ? $country->get('CNT_name') : '';
+				break;
+
+			case 'zip':
+				return $venue->get('VNU_zip');
+				break;
+
+			case 'formatted_address':
+				return EEH_Address::format($venue);
+				break;
+
+			case 'gmap_link':
+			case 'gmap_url':
+			case 'gmap_link_img':
+				$atts = $this->get_map_attributes($venue, $field);
+				return EEH_Maps::google_map_link($atts);
+				break;
+		}
+		return '';
+	}
+
+
+	/**
+	 * Generates the attributes for retrieving a google_map artifact.
+	 * @param EE_Venue $venue
+	 * @param string   $field
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function get_map_attributes(EE_Venue $venue, $field = 'gmap_link')
+	{
+		$state   = $venue->state_obj();
+		$country = $venue->country_obj();
+		$atts    = array(
+			'id'      => $venue->ID(),
+			'address' => $venue->get('VNU_address'),
+			'city'    => $venue->get('VNU_city'),
+			'state'   => is_object($state) ? $state->get('STA_name') : '',
+			'zip'     => $venue->get('VNU_zip'),
+			'country' => is_object($country) ? $country->get('CNT_name') : '',
+			'type'    => $field === 'gmap_link' ? 'url' : 'map',
+			'map_w'   => 200,
+			'map_h'   => 200,
+		);
+		if ($field === 'gmap_url') {
+			$atts['type'] = 'url_only';
+		}
+		return $atts;
+	}
 }

core/helpers/EEH_Maps.helper.php

Indentation +170 added lines, -170 removed lines

@@ -14,176 +14,176 @@
 class EEH_Maps
 {
 
-    // array of map settings
-    public static $gmap_vars = array();
-
-
-    /**
-     * google_map - creates a Google Map Link
-     *
-     * @param  array $ee_gmaps_opts array of attributes required for the map link generation
-     * @return string (link to map!)
-     */
-    public static function google_map($ee_gmaps_opts)
-    {
-
-        $ee_map_width        = ! empty($ee_gmaps_opts['ee_map_width']) ? $ee_gmaps_opts['ee_map_width'] : '300';
-        $ee_map_height       = ! empty($ee_gmaps_opts['ee_map_height']) ? $ee_gmaps_opts['ee_map_height'] : '185';
-        $ee_map_zoom         = ! empty($ee_gmaps_opts['ee_map_zoom']) ? $ee_gmaps_opts['ee_map_zoom'] : '12';
-        $ee_map_nav_display  = ! empty($ee_gmaps_opts['ee_map_nav_display']) ? 'true' : 'false';
-        $ee_map_nav_size     = ! empty($ee_gmaps_opts['ee_map_nav_size'])
-            ? $ee_gmaps_opts['ee_map_nav_size']
-            : 'default';
-        $ee_map_type_control = ! empty($ee_gmaps_opts['ee_map_type_control'])
-            ? $ee_gmaps_opts['ee_map_type_control']
-            : 'default';
-        $static_url          = ! empty($ee_gmaps_opts['ee_static_url']) ? $ee_gmaps_opts['ee_static_url'] : false;
-
-        if (! empty($ee_gmaps_opts['ee_map_align'])) {
-            switch ($ee_gmaps_opts['ee_map_align']) {
-                case "left":
-                    $map_align = 'ee-gmap-align-left left';
-                    break;
-                case "right":
-                    $map_align = 'ee-gmap-align-right right';
-                    break;
-                case "center":
-                    $map_align = 'ee-gmap-align-center center';
-                    break;
-                case "none":
-                default:
-                    $map_align = 'ee-gmap-align-none';
-            }
-        } else {
-            $map_align = 'ee-gmap-align-none';
-        }
-
-
-        // Determine whether user has set a hardoded url to use and
-        // if so display a Google static iframe map else run V3 api
-        if ($static_url) {
-            $html = '<div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align . '">';
-            $html .= '<iframe src="' . $static_url . '&output=embed"'
-                . ' style="width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;"'
-                . ' frameborder="0" scrolling="no">';
-            $html .= '</iframe>';
-            $html .= '<a href="' . $static_url . '">View Large map</a>';
-            $html .= '</div>';
-            return $html;
-
-        } else {
-            EEH_Maps::$gmap_vars[$ee_gmaps_opts['map_ID']] = array(
-                'map_ID'              => $ee_gmaps_opts['map_ID'],
-                'ee_map_zoom'         => $ee_map_zoom,
-                'ee_map_nav_display'  => $ee_map_nav_display,
-                'ee_map_nav_size'     => $ee_map_nav_size,
-                'ee_map_type_control' => $ee_map_type_control,
-                'location'            => $ee_gmaps_opts['location'],
-            );
-
-            $style = 'width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;';
-            $html = '<div class="ee-gmap-wrapper ' . $map_align . '">'
-                    . '<div class="ee-gmap" id="map_canvas_' . $ee_gmaps_opts['map_ID'] . '"'
-                    . ' style="' . $style . '"></div>'
-                    . '</div>';
-
-            wp_enqueue_script('gmap_api');
-            wp_enqueue_script('ee_gmap');
-            add_action('wp_footer', array('EEH_Maps', 'footer_enqueue_script'));
-
-            return $html;
-        } // end auto map or static url map check
-    }
-
-
-    /**
-     * enqueue_script
-     *
-     * @return void
-     */
-    public static function footer_enqueue_script()
-    {
-        wp_localize_script('ee_gmap', 'ee_gmap_vars', EEH_Maps::$gmap_vars);
-    }
-
-
-    /**
-     * registers scripts for maps
-     */
-    public static function espresso_google_map_js()
-    {
-        $api_url = sprintf(
-            "https://maps.googleapis.com/maps/api/js?key=%s",
-            apply_filters(
-                'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
-                EE_Registry::instance()->CFG->map_settings->google_map_api_key
-            )
-        );
-        wp_register_script('gmap_api', $api_url, array('jquery'), null, true);
-        wp_register_script('ee_gmap', plugin_dir_url(__FILE__) . 'assets/ee_gmap.js', array('gmap_api'), '1.0', true);
-    }
-
-    /**
-     * creates a Google Map Link
-     *
-     * @param  array $atts array of attributes required for the map link generation
-     * @return string (link to map!)
-     */
-    public static function google_map_link($atts)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        extract($atts);
-        /** @var string $address */
-        /** @var string $city */
-        /** @var string $state */
-        /** @var string $zip */
-        /** @var string $country */
-        $address         = "{$address}";
-        $city            = "{$city}";
-        $state           = "{$state}";
-        $zip             = "{$zip}";
-        $country         = "{$country}";
-        $text            = isset($text) ? "{$text}" : "";
-        $type            = isset($type) ? "{$type}" : "";
-        $map_w           = isset($map_w) ? "{$map_w}" : 400;
-        $map_h           = isset($map_h) ? "{$map_h}" : 400;
-        $id              = isset($id) ? $id : 'not_set';
-        $map_image_class = isset($map_image_class) ? $map_image_class : 'ee_google_map_view';
-
-        $address_string = ($address != '' ? $address : '')
-                          . ($city != '' ? ',' . $city : '')
-                          . ($state != '' ? ',' . $state : '')
-                          . ($zip != '' ? ',' . $zip : '')
-                          . ($country != '' ? ',' . $country : '');
-
-        $google_map = htmlentities2('http://maps.google.com/maps?q=' . urlencode($address_string));
-
-        switch ($type) {
-            case 'text':
-            default:
-                $text = $text == '' ? __('Map and Directions', 'event_espresso') : $text;
-                break;
-
-            case 'url_only':
-            case 'url':
-                $text = $google_map;
-                break;
-
-            case 'map':
-                $scheme = is_ssl() ? 'https://' : 'http://';
-
-                $api_key = apply_filters(
-                    'FHEE__EEH_Maps__espresso_google_maps_link__api_key',
-                    EE_Registry::instance()->CFG->map_settings->google_map_api_key
-                );
-
-                return '<a class="a_map_image_link" href="' . $google_map . '" target="_blank">' . '<img class="map_image_link" id="venue_map_' . $id . '" ' . $map_image_class . ' src="' . htmlentities2($scheme . 'maps.googleapis.com/maps/api/staticmap?center=' . urlencode($address_string) . '&amp;zoom=14&amp;size=' . $map_w . 'x' . $map_h . '&amp;markers=color:green|label:|' . urlencode($address_string) . '&amp;sensor=false&amp;key=' . $api_key) . '" /></a>';
-        }
-
-        return $type === 'url_only'
-            ? $text
-            : '<a href="' . $google_map . '" target="_blank">' . $text . '</a>';
-    }
+	// array of map settings
+	public static $gmap_vars = array();
+
+
+	/**
+	 * google_map - creates a Google Map Link
+	 *
+	 * @param  array $ee_gmaps_opts array of attributes required for the map link generation
+	 * @return string (link to map!)
+	 */
+	public static function google_map($ee_gmaps_opts)
+	{
+
+		$ee_map_width        = ! empty($ee_gmaps_opts['ee_map_width']) ? $ee_gmaps_opts['ee_map_width'] : '300';
+		$ee_map_height       = ! empty($ee_gmaps_opts['ee_map_height']) ? $ee_gmaps_opts['ee_map_height'] : '185';
+		$ee_map_zoom         = ! empty($ee_gmaps_opts['ee_map_zoom']) ? $ee_gmaps_opts['ee_map_zoom'] : '12';
+		$ee_map_nav_display  = ! empty($ee_gmaps_opts['ee_map_nav_display']) ? 'true' : 'false';
+		$ee_map_nav_size     = ! empty($ee_gmaps_opts['ee_map_nav_size'])
+			? $ee_gmaps_opts['ee_map_nav_size']
+			: 'default';
+		$ee_map_type_control = ! empty($ee_gmaps_opts['ee_map_type_control'])
+			? $ee_gmaps_opts['ee_map_type_control']
+			: 'default';
+		$static_url          = ! empty($ee_gmaps_opts['ee_static_url']) ? $ee_gmaps_opts['ee_static_url'] : false;
+
+		if (! empty($ee_gmaps_opts['ee_map_align'])) {
+			switch ($ee_gmaps_opts['ee_map_align']) {
+				case "left":
+					$map_align = 'ee-gmap-align-left left';
+					break;
+				case "right":
+					$map_align = 'ee-gmap-align-right right';
+					break;
+				case "center":
+					$map_align = 'ee-gmap-align-center center';
+					break;
+				case "none":
+				default:
+					$map_align = 'ee-gmap-align-none';
+			}
+		} else {
+			$map_align = 'ee-gmap-align-none';
+		}
+
+
+		// Determine whether user has set a hardoded url to use and
+		// if so display a Google static iframe map else run V3 api
+		if ($static_url) {
+			$html = '<div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align . '">';
+			$html .= '<iframe src="' . $static_url . '&output=embed"'
+				. ' style="width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;"'
+				. ' frameborder="0" scrolling="no">';
+			$html .= '</iframe>';
+			$html .= '<a href="' . $static_url . '">View Large map</a>';
+			$html .= '</div>';
+			return $html;
+
+		} else {
+			EEH_Maps::$gmap_vars[$ee_gmaps_opts['map_ID']] = array(
+				'map_ID'              => $ee_gmaps_opts['map_ID'],
+				'ee_map_zoom'         => $ee_map_zoom,
+				'ee_map_nav_display'  => $ee_map_nav_display,
+				'ee_map_nav_size'     => $ee_map_nav_size,
+				'ee_map_type_control' => $ee_map_type_control,
+				'location'            => $ee_gmaps_opts['location'],
+			);
+
+			$style = 'width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;';
+			$html = '<div class="ee-gmap-wrapper ' . $map_align . '">'
+					. '<div class="ee-gmap" id="map_canvas_' . $ee_gmaps_opts['map_ID'] . '"'
+					. ' style="' . $style . '"></div>'
+					. '</div>';
+
+			wp_enqueue_script('gmap_api');
+			wp_enqueue_script('ee_gmap');
+			add_action('wp_footer', array('EEH_Maps', 'footer_enqueue_script'));
+
+			return $html;
+		} // end auto map or static url map check
+	}
+
+
+	/**
+	 * enqueue_script
+	 *
+	 * @return void
+	 */
+	public static function footer_enqueue_script()
+	{
+		wp_localize_script('ee_gmap', 'ee_gmap_vars', EEH_Maps::$gmap_vars);
+	}
+
+
+	/**
+	 * registers scripts for maps
+	 */
+	public static function espresso_google_map_js()
+	{
+		$api_url = sprintf(
+			"https://maps.googleapis.com/maps/api/js?key=%s",
+			apply_filters(
+				'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
+				EE_Registry::instance()->CFG->map_settings->google_map_api_key
+			)
+		);
+		wp_register_script('gmap_api', $api_url, array('jquery'), null, true);
+		wp_register_script('ee_gmap', plugin_dir_url(__FILE__) . 'assets/ee_gmap.js', array('gmap_api'), '1.0', true);
+	}
+
+	/**
+	 * creates a Google Map Link
+	 *
+	 * @param  array $atts array of attributes required for the map link generation
+	 * @return string (link to map!)
+	 */
+	public static function google_map_link($atts)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		extract($atts);
+		/** @var string $address */
+		/** @var string $city */
+		/** @var string $state */
+		/** @var string $zip */
+		/** @var string $country */
+		$address         = "{$address}";
+		$city            = "{$city}";
+		$state           = "{$state}";
+		$zip             = "{$zip}";
+		$country         = "{$country}";
+		$text            = isset($text) ? "{$text}" : "";
+		$type            = isset($type) ? "{$type}" : "";
+		$map_w           = isset($map_w) ? "{$map_w}" : 400;
+		$map_h           = isset($map_h) ? "{$map_h}" : 400;
+		$id              = isset($id) ? $id : 'not_set';
+		$map_image_class = isset($map_image_class) ? $map_image_class : 'ee_google_map_view';
+
+		$address_string = ($address != '' ? $address : '')
+						  . ($city != '' ? ',' . $city : '')
+						  . ($state != '' ? ',' . $state : '')
+						  . ($zip != '' ? ',' . $zip : '')
+						  . ($country != '' ? ',' . $country : '');
+
+		$google_map = htmlentities2('http://maps.google.com/maps?q=' . urlencode($address_string));
+
+		switch ($type) {
+			case 'text':
+			default:
+				$text = $text == '' ? __('Map and Directions', 'event_espresso') : $text;
+				break;
+
+			case 'url_only':
+			case 'url':
+				$text = $google_map;
+				break;
+
+			case 'map':
+				$scheme = is_ssl() ? 'https://' : 'http://';
+
+				$api_key = apply_filters(
+					'FHEE__EEH_Maps__espresso_google_maps_link__api_key',
+					EE_Registry::instance()->CFG->map_settings->google_map_api_key
+				);
+
+				return '<a class="a_map_image_link" href="' . $google_map . '" target="_blank">' . '<img class="map_image_link" id="venue_map_' . $id . '" ' . $map_image_class . ' src="' . htmlentities2($scheme . 'maps.googleapis.com/maps/api/staticmap?center=' . urlencode($address_string) . '&amp;zoom=14&amp;size=' . $map_w . 'x' . $map_h . '&amp;markers=color:green|label:|' . urlencode($address_string) . '&amp;sensor=false&amp;key=' . $api_key) . '" /></a>';
+		}
+
+		return $type === 'url_only'
+			? $text
+			: '<a href="' . $google_map . '" target="_blank">' . $text . '</a>';
+	}
 }
 // End of file EEH_Maps.helper.php
 // Location: /helpers/EEH_Maps.helper.php
\ No newline at end of file

Spacing +17 added lines, -17 removed lines

@@ -39,7 +39,7 @@ 
             : 'default';
         $static_url          = ! empty($ee_gmaps_opts['ee_static_url']) ? $ee_gmaps_opts['ee_static_url'] : false;
 
-        if (! empty($ee_gmaps_opts['ee_map_align'])) {
+        if ( ! empty($ee_gmaps_opts['ee_map_align'])) {
             switch ($ee_gmaps_opts['ee_map_align']) {
                 case "left":
                     $map_align = 'ee-gmap-align-left left';
@@ -62,12 +62,12 @@ 
         // Determine whether user has set a hardoded url to use and
         // if so display a Google static iframe map else run V3 api
         if ($static_url) {
-            $html = '<div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align . '">';
-            $html .= '<iframe src="' . $static_url . '&output=embed"'
-                . ' style="width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;"'
+            $html = '<div class="ee-gmap-iframewrap ee-gmap-wrapper '.$map_align.'">';
+            $html .= '<iframe src="'.$static_url.'&output=embed"'
+                . ' style="width: '.$ee_map_width.'px; height: '.$ee_map_height.'px;"'
                 . ' frameborder="0" scrolling="no">';
             $html .= '</iframe>';
-            $html .= '<a href="' . $static_url . '">View Large map</a>';
+            $html .= '<a href="'.$static_url.'">View Large map</a>';
             $html .= '</div>';
             return $html;
 
@@ -81,10 +81,10 @@ 
                 'location'            => $ee_gmaps_opts['location'],
             );
 
-            $style = 'width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;';
-            $html = '<div class="ee-gmap-wrapper ' . $map_align . '">'
-                    . '<div class="ee-gmap" id="map_canvas_' . $ee_gmaps_opts['map_ID'] . '"'
-                    . ' style="' . $style . '"></div>'
+            $style = 'width: '.$ee_map_width.'px; height: '.$ee_map_height.'px;';
+            $html = '<div class="ee-gmap-wrapper '.$map_align.'">'
+                    . '<div class="ee-gmap" id="map_canvas_'.$ee_gmaps_opts['map_ID'].'"'
+                    . ' style="'.$style.'"></div>'
                     . '</div>';
 
             wp_enqueue_script('gmap_api');
@@ -120,7 +120,7 @@ 
             )
         );
         wp_register_script('gmap_api', $api_url, array('jquery'), null, true);
-        wp_register_script('ee_gmap', plugin_dir_url(__FILE__) . 'assets/ee_gmap.js', array('gmap_api'), '1.0', true);
+        wp_register_script('ee_gmap', plugin_dir_url(__FILE__).'assets/ee_gmap.js', array('gmap_api'), '1.0', true);
     }
 
     /**
@@ -151,12 +151,12 @@ 
         $map_image_class = isset($map_image_class) ? $map_image_class : 'ee_google_map_view';
 
         $address_string = ($address != '' ? $address : '')
-                          . ($city != '' ? ',' . $city : '')
-                          . ($state != '' ? ',' . $state : '')
-                          . ($zip != '' ? ',' . $zip : '')
-                          . ($country != '' ? ',' . $country : '');
+                          . ($city != '' ? ','.$city : '')
+                          . ($state != '' ? ','.$state : '')
+                          . ($zip != '' ? ','.$zip : '')
+                          . ($country != '' ? ','.$country : '');
 
-        $google_map = htmlentities2('http://maps.google.com/maps?q=' . urlencode($address_string));
+        $google_map = htmlentities2('http://maps.google.com/maps?q='.urlencode($address_string));
 
         switch ($type) {
             case 'text':
@@ -177,12 +177,12 @@ 
                     EE_Registry::instance()->CFG->map_settings->google_map_api_key
                 );
 
-                return '<a class="a_map_image_link" href="' . $google_map . '" target="_blank">' . '<img class="map_image_link" id="venue_map_' . $id . '" ' . $map_image_class . ' src="' . htmlentities2($scheme . 'maps.googleapis.com/maps/api/staticmap?center=' . urlencode($address_string) . '&amp;zoom=14&amp;size=' . $map_w . 'x' . $map_h . '&amp;markers=color:green|label:|' . urlencode($address_string) . '&amp;sensor=false&amp;key=' . $api_key) . '" /></a>';
+                return '<a class="a_map_image_link" href="'.$google_map.'" target="_blank">'.'<img class="map_image_link" id="venue_map_'.$id.'" '.$map_image_class.' src="'.htmlentities2($scheme.'maps.googleapis.com/maps/api/staticmap?center='.urlencode($address_string).'&amp;zoom=14&amp;size='.$map_w.'x'.$map_h.'&amp;markers=color:green|label:|'.urlencode($address_string).'&amp;sensor=false&amp;key='.$api_key).'" /></a>';
         }
 
         return $type === 'url_only'
             ? $text
-            : '<a href="' . $google_map . '" target="_blank">' . $text . '</a>';
+            : '<a href="'.$google_map.'" target="_blank">'.$text.'</a>';
     }
 }
 // End of file EEH_Maps.helper.php

modules/add_new_state/EED_Add_New_State.module.php

Indentation +693 added lines, -693 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -16,698 +16,698 @@ 
 
 
 
-    /**
-     * @return EED_Module|EED_Add_New_State
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks()
-    {
-        add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
-        add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'translate_js_strings'), 0);
-        add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'wp_enqueue_scripts'), 10);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
-        add_filter('FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-            array('EED_Add_New_State', 'unset_new_state_request_params'), 10, 1);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            array('EED_Add_New_State', 'inject_new_reg_state_into_options'), 10, 5);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            array('EED_Add_New_State', 'inject_new_reg_country_into_options'), 10, 5);
-        add_filter('FHEE__EE_State_Select_Input____construct__state_options',
-            array('EED_Add_New_State', 'state_options'), 10, 1);
-        add_filter('FHEE__EE_Country_Select_Input____construct__country_options',
-            array('EED_Add_New_State', 'country_options'), 10, 1);
-    }
-
-
-
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
-        add_action('wp_ajax_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
-        add_action('wp_ajax_nopriv_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
-        add_filter('FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-            array('EED_Add_New_State', 'unset_new_state_request_params'), 10, 1);
-        add_action('AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
-            array('EED_Add_New_State', 'update_country_settings'), 10, 3);
-        add_action('AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
-            array('EED_Add_New_State', 'update_country_settings'), 10, 3);
-        add_filter('FHEE__EE_State_Select_Input____construct__state_options',
-            array('EED_Add_New_State', 'state_options'), 10, 1);
-        add_filter('FHEE__EE_Country_Select_Input____construct__country_options',
-            array('EED_Add_New_State', 'country_options'), 10, 1);
-        add_filter('FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
-            array('EED_Add_New_State', 'filter_checkout_request_params'), 10, 1);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            array('EED_Add_New_State', 'inject_new_reg_state_into_options'), 10, 5);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            array('EED_Add_New_State', 'inject_new_reg_country_into_options'), 10, 5);
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public static function set_definitions()
-    {
-        define('ANS_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
-        define('ANS_TEMPLATES_PATH', str_replace(
-            '\\',
-            DS, plugin_dir_path(__FILE__)) . 'templates' . DS
-        );
-    }
-
-
-
-    /**
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public static function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['ans_no_country'] = esc_html__(
-            'In order to proceed, you need to select the Country that your State/Province belongs to.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_no_name'] = esc_html__(
-            'In order to proceed, you need to enter the name of your State/Province.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_no_abbreviation'] = esc_html__(
-            'In order to proceed, you need to enter an abbreviation for the name of your State/Province.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_save_success'] = esc_html__(
-            'The new state was successfully saved to the database.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_server_save_error'] = esc_html__(
-            'An unknown error has occurred on the server while saving the new state to the database.',
-            'event_espresso'
-        );
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public static function wp_enqueue_scripts()
-    {
-        if (apply_filters('EED_Single_Page_Checkout__SPCO_active', false)) {
-            wp_register_script('add_new_state', ANS_ASSETS_URL . 'add_new_state.js',
-                array('espresso_core', 'single_page_checkout'), EVENT_ESPRESSO_VERSION, true);
-            wp_enqueue_script('add_new_state');
-        }
-    }
-
-
-
-    /**
-     * display_add_new_state_micro_form
-     *
-     * @param EE_Form_Section_Proper $question_group_reg_form
-     * @return string
-     * @throws EE_Error
-     */
-    //	public static function display_add_new_state_micro_form( $html, EE_Form_Input_With_Options_Base $input ){
-    public static function display_add_new_state_micro_form(EE_Form_Section_Proper $question_group_reg_form)
-    {
-        // only add the 'new_state_micro_form' when displaying reg forms,
-        // not during processing since we process the 'new_state_micro_form' in it's own AJAX request
-        $action = EE_Registry::instance()->REQ->get('action', '');
-        // is the "state" question in this form section?
-        $input = $question_group_reg_form->get_subsection('state');
-        if ($action === 'process_reg_step' || $action === 'update_reg_step') {
-            //ok then all we need to do is make sure the input's HTML name is consistent
-            //by forcing it to set it now, like it did while getting the form for display
-            if ($input instanceof EE_State_Select_Input) {
-                $input->html_name();
-            }
-            return $question_group_reg_form;
-        }
-        // we're only doing this for state select inputs
-        if ($input instanceof EE_State_Select_Input) {
-            // grab any set values from the request
-            $country_name = str_replace('state', 'nsmf_new_state_country', $input->html_name());
-            $state_name = str_replace('state', 'nsmf_new_state_name', $input->html_name());
-            $abbrv_name = str_replace('state', 'nsmf_new_state_abbrv', $input->html_name());
-            $new_state_submit_id = str_replace('state', 'new_state', $input->html_id());
-            $country_options = array();
-            $countries = EEM_Country::instance()->get_all_countries();
-            if (! empty($countries)) {
-                foreach ($countries as $country) {
-                    if ($country instanceof EE_Country) {
-                        $country_options[$country->ID()] = $country->name();
-                    }
-                }
-            }
-            $new_state_micro_form = new EE_Form_Section_Proper(
-                array(
-                    'name'            => 'new_state_micro_form',
-                    'html_id'         => 'new_state_micro_form',
-                    'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'subsections'     => array(
-                        // add hidden input to indicate that a new state is being added
-                        'add_new_state'               => new EE_Hidden_Input(
-                            array(
-                                'html_name' => str_replace(
-                                    'state',
-                                    'nsmf_add_new_state', $input->html_name()
-                                ),
-                                'html_id'   => str_replace(
-                                    'state',
-                                    'nsmf_add_new_state', $input->html_id()
-                                ),
-                                'default'   => 0,
-                            )
-                        ),
-                        // add link for displaying hidden container
-                        'click_here_link'             => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__click_here_link',
-                                EEH_HTML::link(
-                                    '',
-                                    esc_html__('click here to add a new state/province', 'event_espresso'),
-                                    '',
-                                    'display-' . $input->html_id(),
-                                    'ee-form-add-new-state-lnk display-the-hidden smaller-text hide-if-no-js',
-                                    '',
-                                    'data-target="' . $input->html_id() . '"'
-                                )
-                            )
-                        ),
-                        // add initial html for hidden container
-                        'add_new_state_micro_form'    => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_micro_form',
-                                EEH_HTML::div('', $input->html_id() . '-dv', 'ee-form-add-new-state-dv',
-                                    'display: none;') .
-                                EEH_HTML::h6(
-                                    esc_html__(
-                                        'Is your state/province missing from the dropdown menu above? You can add it by completing the following steps:',
-                                        'event_espresso'
-                                    )
-                                ) .
-                                EEH_HTML::ul() .
-                                EEH_HTML::li(
-                                    esc_html__(
-                                        'first select the Country that your State/Province belongs to',
-                                        'event_espresso'
-                                    )
-                                ) .
-                                EEH_HTML::li(
-                                    esc_html__('enter the name of your State/Province', 'event_espresso')
-                                ) .
-                                EEH_HTML::li(
-                                    esc_html__(
-                                        'enter a two to six letter abbreviation for the name of your State/Province',
-                                        'event_espresso'
-                                    )
-                                ) .
-                                EEH_HTML::li(esc_html__('click the ADD button', 'event_espresso')) .
-                                EEH_HTML::ulx()
-                            )
-                        ),
-                        // NEW STATE COUNTRY
-                        'new_state_country'           => new EE_Country_Select_Input(
-                            $country_options,
-                            array(
-                                'html_name'       => $country_name,
-                                'html_id'         => str_replace(
-                                    'state',
-                                    'nsmf_new_state_country', $input->html_id()
-                                ),
-                                'html_class'      => $input->html_class() . ' new-state-country',
-                                'html_label_text' => esc_html__('New State/Province Country', 'event_espresso'),
-                                'default'         => EE_Registry::instance()->REQ->get($country_name, ''),
-                                'required'        => false,
-                            )
-                        ),
-                        // NEW STATE NAME
-                        'new_state_name'              => new EE_Text_Input(
-                            array(
-                                'html_name'       => $state_name,
-                                'html_id'         => str_replace(
-                                    'state',
-                                    'nsmf_new_state_name', $input->html_id()
-                                ),
-                                'html_class'      => $input->html_class() . ' new-state-state',
-                                'html_label_text' => esc_html__('New State/Province Name',
-                                    'event_espresso'),
-                                'default'         => EE_Registry::instance()->REQ->get($state_name, ''),
-                                'required'        => false,
-                            )
-                        ),
-                        'spacer'                      => new EE_Form_Section_HTML(EEH_HTML::br()),
-                        // NEW STATE NAME
-                        'new_state_abbrv'             => new EE_Text_Input(
-                            array(
-                                'html_name'             => $abbrv_name,
-                                'html_id'               => str_replace('state', 'nsmf_new_state_abbrv',
-                                    $input->html_id()),
-                                'html_class'            => $input->html_class() . ' new-state-abbrv',
-                                'html_label_text'       => esc_html__(
-                                    'New State/Province Abbreviation',
-                                    'event_espresso'
-                                ) . ' *',
-                                'html_other_attributes' => 'size="24"',
-                                'default'               => EE_Registry::instance()->REQ->get($abbrv_name, ''),
-                                'required'              => false,
-                            )
-                        ),
-                        // "submit" button
-                        'add_new_state_submit_button' => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_submit_button',
-                                EEH_HTML::nbsp(3) .
-                                EEH_HTML::link(
-                                    '',
-                                    esc_html__('ADD', 'event_espresso'),
-                                    '',
-                                    'submit-' . $new_state_submit_id,
-                                    'ee-form-add-new-state-submit button button-secondary',
-                                    '',
-                                    'data-target="' . $new_state_submit_id . '"'
-                                )
-                            )
-                        ),
-                        // extra info
-                        'add_new_state_extra'         => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_extra',
-                                EEH_HTML::br(2)
-                                .
-                                EEH_HTML::div('', '', 'small-text')
-                                .
-                                EEH_HTML::strong(
-                                    '* ' .
-                                    esc_html__(
-                                        'Don\'t know your State/Province Abbreviation?',
-                                        'event_espresso'
-                                    )
-                                )
-                                .
-                                EEH_HTML::br()
-                                .
-                                sprintf(
-                                    esc_html__(
-                                        'You can look here: %s, for a list of Countries and links to their State/Province Abbreviations ("Subdivisions assigned codes" column).',
-                                        'event_espresso'
-                                    ),
-                                    EEH_HTML::link(
-                                        'http://en.wikipedia.org/wiki/ISO_3166-2',
-                                        'http://en.wikipedia.org/wiki/ISO_3166-2',
-                                        '',
-                                        '',
-                                        'ee-form-add-new-state-wiki-lnk',
-                                        '',
-                                        'target="_blank"'
-                                    )
-                                )
-                                .
-                                EEH_HTML::divx()
-                                .
-                                EEH_HTML::br()
-                                .
-                                EEH_HTML::link(
-                                    '',
-                                    esc_html__('cancel new State/Province', 'event_espresso'),
-                                    '',
-                                    'hide-' . $input->html_id(),
-                                    'ee-form-cancel-new-state-lnk smaller-text',
-                                    '',
-                                    'data-target="' . $input->html_id() . '"'
-                                )
-                                .
-                                EEH_HTML::divx()
-                                .
-                                EEH_HTML::br()
-                            )
-                        ),
-                    ),
-                )
-            );
-            $question_group_reg_form->add_subsections(
-                array('new_state_micro_form' => $new_state_micro_form),
-                'state',
-                false
-            );
-        }
-        return $question_group_reg_form;
-    }
-
-
-
-    /**
-     * set_new_state_input_width
-     *
-     * @return int|string
-     * @throws EE_Error
-     */
-    public static function add_new_state()
-    {
-        $REQ = EE_Registry::instance()->load_core('Request_Handler');
-        if (absint($REQ->get('nsmf_add_new_state')) === 1) {
-            EE_Registry::instance()->load_model('State');
-            // grab country ISO code, new state name, and new state abbreviation
-            $state_country = $REQ->is_set('nsmf_new_state_country')
-                ? sanitize_text_field($REQ->get('nsmf_new_state_country'))
-                : false;
-            $state_name = $REQ->is_set('nsmf_new_state_name')
-                ? sanitize_text_field($REQ->get('nsmf_new_state_name'))
-                : false;
-            $state_abbr = $REQ->is_set('nsmf_new_state_abbrv')
-                ? sanitize_text_field($REQ->get('nsmf_new_state_abbrv'))
-                : false;
-            if ($state_country && $state_name && $state_abbr) {
-                $new_state = EED_Add_New_State::save_new_state_to_db(array(
-                    'CNT_ISO'    => strtoupper($state_country),
-                    'STA_abbrev' => strtoupper($state_abbr),
-                    'STA_name'   => ucwords($state_name),
-                    'STA_active' => false,
-                ));
-                if ($new_state instanceof EE_State) {
-                    // clean house
-                    EE_Registry::instance()->REQ->un_set('nsmf_add_new_state');
-                    EE_Registry::instance()->REQ->un_set('nsmf_new_state_country');
-                    EE_Registry::instance()->REQ->un_set('nsmf_new_state_name');
-                    EE_Registry::instance()->REQ->un_set('nsmf_new_state_abbrv');
-                    // get any existing new states
-                    $new_states = EE_Registry::instance()->SSN->get_session_data(
-                        'nsmf_new_states'
-                    );
-                    $new_states[$new_state->ID()] = $new_state;
-                    EE_Registry::instance()->SSN->set_session_data(
-                        array('nsmf_new_states' => $new_states)
-                    );
-                    if (EE_Registry::instance()->REQ->ajax) {
-                        echo wp_json_encode(array(
-                            'success'      => true,
-                            'id'           => $new_state->ID(),
-                            'name'         => $new_state->name(),
-                            'abbrev'       => $new_state->abbrev(),
-                            'country_iso'  => $new_state->country_iso(),
-                            'country_name' => $new_state->country()->name(),
-                        ));
-                        exit();
-                    }
-                    return $new_state->ID();
-                }
-            } else {
-                $error = esc_html__(
-                    'A new State/Province could not be added because invalid or missing data was received.',
-                    'event_espresso'
-                );
-                if (EE_Registry::instance()->REQ->ajax) {
-                    echo wp_json_encode(array('error' => $error));
-                    exit();
-                }
-                EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * recursively drills down through request params to remove any that were added by this module
-     *
-     * @param array $request_params
-     * @return array
-     */
-    public static function filter_checkout_request_params($request_params)
-    {
-        foreach ($request_params as $form_section) {
-            if (is_array($form_section)) {
-                EED_Add_New_State::unset_new_state_request_params($form_section);
-                EED_Add_New_State::filter_checkout_request_params($form_section);
-            }
-        }
-        return $request_params;
-    }
-
-
-
-    /**
-     * @param array $request_params
-     * @return array
-     */
-    public static function unset_new_state_request_params($request_params)
-    {
-        unset(
-            $request_params['new_state_micro_form'],
-            $request_params['new_state_micro_add_new_state'],
-            $request_params['new_state_micro_new_state_country'],
-            $request_params['new_state_micro_new_state_name'],
-            $request_params['new_state_micro_new_state_abbrv']
-        );
-        return $request_params;
-    }
-
-
-
-    /**
-     * @param array $props_n_values
-     * @return bool
-     * @throws EE_Error
-     */
-    public static function save_new_state_to_db($props_n_values = array())
-    {
-        $existing_state = EEM_State::instance()->get_all(array($props_n_values, 'limit' => 1));
-        if (! empty($existing_state)) {
-            return array_pop($existing_state);
-        }
-        $new_state = EE_State::new_instance($props_n_values);
-        if ($new_state instanceof EE_State) {
-            // if not non-ajax admin
-            $new_state_key = 'new-state-added-' . $new_state->country_iso() . '-' . $new_state->abbrev();
-            $new_state_notice = sprintf(
-                esc_html__(
-                    'A new State named "%1$s (%2$s)" was dynamically added from an Event Espresso form for the Country of "%3$s".%5$sTo verify, edit, and/or delete this new State, please go to the %4$s and update the States / Provinces section.%5$sCheck "Yes" to have this new State added to dropdown select lists in forms.',
-                    'event_espresso'
-                ),
-                '<b>' . $new_state->name() . '</b>',
-                '<b>' . $new_state->abbrev() . '</b>',
-                '<b>' . $new_state->country()->name() . '</b>',
-                '<a href="' . add_query_arg(array(
-                    'page'    => 'espresso_general_settings',
-                    'action'  => 'country_settings',
-                    'country' => $new_state->country_iso(),
-                ), admin_url('admin.php')) . '">' . esc_html__('Event Espresso - General Settings > Countries Tab',
-                    'event_espresso') . '</a>',
-                '<br />'
-            );
-            EE_Error::add_persistent_admin_notice($new_state_key, $new_state_notice);
-            $new_state->save();
-            EEM_State::instance()->reset_cached_states();
-            return $new_state;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @param string $CNT_ISO
-     * @param string $STA_ID
-     * @param array  $cols_n_values
-     * @return void
-     */
-    public static function update_country_settings($CNT_ISO = '', $STA_ID = '', $cols_n_values = array())
-    {
-        $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : false;
-        if (! $CNT_ISO) {
-            EE_Error::add_error(
-                esc_html__('An invalid or missing Country ISO Code was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $STA_abbrev = is_array($cols_n_values) && isset($cols_n_values['STA_abbrev']) ? $cols_n_values['STA_abbrev']
-            : false;
-        if (! $STA_abbrev && ! empty($STA_ID)) {
-            $state = EEM_State::instance()->get_one_by_ID($STA_ID);
-            if ($state instanceof EE_State) {
-                $STA_abbrev = $state->abbrev();
-            }
-        }
-        if (! $STA_abbrev) {
-            EE_Error::add_error(
-                esc_html__('An invalid or missing State Abbreviation was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        EE_Error::dismiss_persistent_admin_notice($CNT_ISO . '-' . $STA_abbrev, true, true);
-    }
-
-
-
-    /**
-     * @param EE_State[]                             $state_options
-     * @param EE_SPCO_Reg_Step_Attendee_Information  $reg_step
-     * @param EE_Registration                        $registration
-     * @param EE_Question                            $question
-     * @param                                        $answer
-     * @return array
-     */
-    public static function inject_new_reg_state_into_options(
-        $state_options = array(),
-        EE_SPCO_Reg_Step_Attendee_Information $reg_step,
-        EE_Registration $registration,
-        EE_Question $question,
-        $answer
-    ) {
-        if ($answer instanceof EE_Answer && $question instanceof EE_Question
-            && $question->type()
-               === EEM_Question::QST_type_state
-        ) {
-            $STA_ID = $answer->value();
-            if (! empty($STA_ID)) {
-                $state = EEM_State::instance()->get_one_by_ID($STA_ID);
-                if ($state instanceof EE_State) {
-                    $country = $state->country();
-                    if ($country instanceof EE_Country) {
-                        if (! isset($state_options[$country->name()])) {
-                            $state_options[$country->name()] = array();
-                        }
-                        if (! isset($state_options[$country->name()][$STA_ID])) {
-                            $state_options[$country->name()][$STA_ID] = $state->name();
-                        }
-                    }
-                }
-            }
-        }
-        return $state_options;
-    }
-
-
-
-    /**
-     * @param EE_Country[]                           $country_options
-     * @param EE_SPCO_Reg_Step_Attendee_Information  $reg_step
-     * @param EE_Registration                        $registration
-     * @param EE_Question                            $question
-     * @param                                        $answer
-     * @return array
-     */
-    public static function inject_new_reg_country_into_options(
-        $country_options = array(),
-        EE_SPCO_Reg_Step_Attendee_Information $reg_step,
-        EE_Registration $registration,
-        EE_Question $question,
-        $answer
-    ) {
-        if ($answer instanceof EE_Answer && $question instanceof EE_Question
-            && $question->type()
-               === EEM_Question::QST_type_country
-        ) {
-            $CNT_ISO = $answer->value();
-            if (! empty($CNT_ISO)) {
-                $country = EEM_Country::instance()->get_one_by_ID($CNT_ISO);
-                if ($country instanceof EE_Country) {
-                    if (! isset($country_options[$CNT_ISO])) {
-                        $country_options[$CNT_ISO] = $country->name();
-                    }
-                }
-            }
-        }
-        return $country_options;
-    }
-
-
-
-    /**
-     * @param EE_State[] $state_options
-     * @return array
-     * @throws EE_Error
-     */
-    public static function state_options($state_options = array())
-    {
-        $new_states = EED_Add_New_State::_get_new_states();
-        foreach ($new_states as $new_state) {
-            if (
-                $new_state instanceof EE_State
-                && $new_state->country() instanceof EE_Country
-            ) {
-                $state_options[$new_state->country()->name()][$new_state->ID()] = $new_state->name();
-            }
-        }
-        return $state_options;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    protected static function _get_new_states()
-    {
-        $new_states = array();
-        if (EE_Registry::instance()->SSN instanceof EE_Session) {
-            $new_states = EE_Registry::instance()->SSN->get_session_data(
-                'nsmf_new_states'
-            );
-        }
-        return is_array($new_states) ? $new_states : array();
-    }
-
-
-
-    /**
-     * @param EE_Country[] $country_options
-     * @return array
-     * @throws EE_Error
-     */
-    public static function country_options($country_options = array())
-    {
-        $new_states = EED_Add_New_State::_get_new_states();
-        foreach ($new_states as $new_state) {
-            if (
-                $new_state instanceof EE_State
-                && $new_state->country() instanceof EE_Country
-            ) {
-                $country_options[$new_state->country()->ID()] = $new_state->country()->name();
-            }
-        }
-        return $country_options;
-    }
+	/**
+	 * @return EED_Module|EED_Add_New_State
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks()
+	{
+		add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
+		add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'translate_js_strings'), 0);
+		add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'wp_enqueue_scripts'), 10);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
+		add_filter('FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+			array('EED_Add_New_State', 'unset_new_state_request_params'), 10, 1);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			array('EED_Add_New_State', 'inject_new_reg_state_into_options'), 10, 5);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			array('EED_Add_New_State', 'inject_new_reg_country_into_options'), 10, 5);
+		add_filter('FHEE__EE_State_Select_Input____construct__state_options',
+			array('EED_Add_New_State', 'state_options'), 10, 1);
+		add_filter('FHEE__EE_Country_Select_Input____construct__country_options',
+			array('EED_Add_New_State', 'country_options'), 10, 1);
+	}
+
+
+
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
+		add_action('wp_ajax_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
+		add_action('wp_ajax_nopriv_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
+		add_filter('FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+			array('EED_Add_New_State', 'unset_new_state_request_params'), 10, 1);
+		add_action('AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
+			array('EED_Add_New_State', 'update_country_settings'), 10, 3);
+		add_action('AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
+			array('EED_Add_New_State', 'update_country_settings'), 10, 3);
+		add_filter('FHEE__EE_State_Select_Input____construct__state_options',
+			array('EED_Add_New_State', 'state_options'), 10, 1);
+		add_filter('FHEE__EE_Country_Select_Input____construct__country_options',
+			array('EED_Add_New_State', 'country_options'), 10, 1);
+		add_filter('FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
+			array('EED_Add_New_State', 'filter_checkout_request_params'), 10, 1);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			array('EED_Add_New_State', 'inject_new_reg_state_into_options'), 10, 5);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			array('EED_Add_New_State', 'inject_new_reg_country_into_options'), 10, 5);
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function set_definitions()
+	{
+		define('ANS_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
+		define('ANS_TEMPLATES_PATH', str_replace(
+			'\\',
+			DS, plugin_dir_path(__FILE__)) . 'templates' . DS
+		);
+	}
+
+
+
+	/**
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['ans_no_country'] = esc_html__(
+			'In order to proceed, you need to select the Country that your State/Province belongs to.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_no_name'] = esc_html__(
+			'In order to proceed, you need to enter the name of your State/Province.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_no_abbreviation'] = esc_html__(
+			'In order to proceed, you need to enter an abbreviation for the name of your State/Province.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_save_success'] = esc_html__(
+			'The new state was successfully saved to the database.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_server_save_error'] = esc_html__(
+			'An unknown error has occurred on the server while saving the new state to the database.',
+			'event_espresso'
+		);
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function wp_enqueue_scripts()
+	{
+		if (apply_filters('EED_Single_Page_Checkout__SPCO_active', false)) {
+			wp_register_script('add_new_state', ANS_ASSETS_URL . 'add_new_state.js',
+				array('espresso_core', 'single_page_checkout'), EVENT_ESPRESSO_VERSION, true);
+			wp_enqueue_script('add_new_state');
+		}
+	}
+
+
+
+	/**
+	 * display_add_new_state_micro_form
+	 *
+	 * @param EE_Form_Section_Proper $question_group_reg_form
+	 * @return string
+	 * @throws EE_Error
+	 */
+	//	public static function display_add_new_state_micro_form( $html, EE_Form_Input_With_Options_Base $input ){
+	public static function display_add_new_state_micro_form(EE_Form_Section_Proper $question_group_reg_form)
+	{
+		// only add the 'new_state_micro_form' when displaying reg forms,
+		// not during processing since we process the 'new_state_micro_form' in it's own AJAX request
+		$action = EE_Registry::instance()->REQ->get('action', '');
+		// is the "state" question in this form section?
+		$input = $question_group_reg_form->get_subsection('state');
+		if ($action === 'process_reg_step' || $action === 'update_reg_step') {
+			//ok then all we need to do is make sure the input's HTML name is consistent
+			//by forcing it to set it now, like it did while getting the form for display
+			if ($input instanceof EE_State_Select_Input) {
+				$input->html_name();
+			}
+			return $question_group_reg_form;
+		}
+		// we're only doing this for state select inputs
+		if ($input instanceof EE_State_Select_Input) {
+			// grab any set values from the request
+			$country_name = str_replace('state', 'nsmf_new_state_country', $input->html_name());
+			$state_name = str_replace('state', 'nsmf_new_state_name', $input->html_name());
+			$abbrv_name = str_replace('state', 'nsmf_new_state_abbrv', $input->html_name());
+			$new_state_submit_id = str_replace('state', 'new_state', $input->html_id());
+			$country_options = array();
+			$countries = EEM_Country::instance()->get_all_countries();
+			if (! empty($countries)) {
+				foreach ($countries as $country) {
+					if ($country instanceof EE_Country) {
+						$country_options[$country->ID()] = $country->name();
+					}
+				}
+			}
+			$new_state_micro_form = new EE_Form_Section_Proper(
+				array(
+					'name'            => 'new_state_micro_form',
+					'html_id'         => 'new_state_micro_form',
+					'layout_strategy' => new EE_Div_Per_Section_Layout(),
+					'subsections'     => array(
+						// add hidden input to indicate that a new state is being added
+						'add_new_state'               => new EE_Hidden_Input(
+							array(
+								'html_name' => str_replace(
+									'state',
+									'nsmf_add_new_state', $input->html_name()
+								),
+								'html_id'   => str_replace(
+									'state',
+									'nsmf_add_new_state', $input->html_id()
+								),
+								'default'   => 0,
+							)
+						),
+						// add link for displaying hidden container
+						'click_here_link'             => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__click_here_link',
+								EEH_HTML::link(
+									'',
+									esc_html__('click here to add a new state/province', 'event_espresso'),
+									'',
+									'display-' . $input->html_id(),
+									'ee-form-add-new-state-lnk display-the-hidden smaller-text hide-if-no-js',
+									'',
+									'data-target="' . $input->html_id() . '"'
+								)
+							)
+						),
+						// add initial html for hidden container
+						'add_new_state_micro_form'    => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_micro_form',
+								EEH_HTML::div('', $input->html_id() . '-dv', 'ee-form-add-new-state-dv',
+									'display: none;') .
+								EEH_HTML::h6(
+									esc_html__(
+										'Is your state/province missing from the dropdown menu above? You can add it by completing the following steps:',
+										'event_espresso'
+									)
+								) .
+								EEH_HTML::ul() .
+								EEH_HTML::li(
+									esc_html__(
+										'first select the Country that your State/Province belongs to',
+										'event_espresso'
+									)
+								) .
+								EEH_HTML::li(
+									esc_html__('enter the name of your State/Province', 'event_espresso')
+								) .
+								EEH_HTML::li(
+									esc_html__(
+										'enter a two to six letter abbreviation for the name of your State/Province',
+										'event_espresso'
+									)
+								) .
+								EEH_HTML::li(esc_html__('click the ADD button', 'event_espresso')) .
+								EEH_HTML::ulx()
+							)
+						),
+						// NEW STATE COUNTRY
+						'new_state_country'           => new EE_Country_Select_Input(
+							$country_options,
+							array(
+								'html_name'       => $country_name,
+								'html_id'         => str_replace(
+									'state',
+									'nsmf_new_state_country', $input->html_id()
+								),
+								'html_class'      => $input->html_class() . ' new-state-country',
+								'html_label_text' => esc_html__('New State/Province Country', 'event_espresso'),
+								'default'         => EE_Registry::instance()->REQ->get($country_name, ''),
+								'required'        => false,
+							)
+						),
+						// NEW STATE NAME
+						'new_state_name'              => new EE_Text_Input(
+							array(
+								'html_name'       => $state_name,
+								'html_id'         => str_replace(
+									'state',
+									'nsmf_new_state_name', $input->html_id()
+								),
+								'html_class'      => $input->html_class() . ' new-state-state',
+								'html_label_text' => esc_html__('New State/Province Name',
+									'event_espresso'),
+								'default'         => EE_Registry::instance()->REQ->get($state_name, ''),
+								'required'        => false,
+							)
+						),
+						'spacer'                      => new EE_Form_Section_HTML(EEH_HTML::br()),
+						// NEW STATE NAME
+						'new_state_abbrv'             => new EE_Text_Input(
+							array(
+								'html_name'             => $abbrv_name,
+								'html_id'               => str_replace('state', 'nsmf_new_state_abbrv',
+									$input->html_id()),
+								'html_class'            => $input->html_class() . ' new-state-abbrv',
+								'html_label_text'       => esc_html__(
+									'New State/Province Abbreviation',
+									'event_espresso'
+								) . ' *',
+								'html_other_attributes' => 'size="24"',
+								'default'               => EE_Registry::instance()->REQ->get($abbrv_name, ''),
+								'required'              => false,
+							)
+						),
+						// "submit" button
+						'add_new_state_submit_button' => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_submit_button',
+								EEH_HTML::nbsp(3) .
+								EEH_HTML::link(
+									'',
+									esc_html__('ADD', 'event_espresso'),
+									'',
+									'submit-' . $new_state_submit_id,
+									'ee-form-add-new-state-submit button button-secondary',
+									'',
+									'data-target="' . $new_state_submit_id . '"'
+								)
+							)
+						),
+						// extra info
+						'add_new_state_extra'         => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_extra',
+								EEH_HTML::br(2)
+								.
+								EEH_HTML::div('', '', 'small-text')
+								.
+								EEH_HTML::strong(
+									'* ' .
+									esc_html__(
+										'Don\'t know your State/Province Abbreviation?',
+										'event_espresso'
+									)
+								)
+								.
+								EEH_HTML::br()
+								.
+								sprintf(
+									esc_html__(
+										'You can look here: %s, for a list of Countries and links to their State/Province Abbreviations ("Subdivisions assigned codes" column).',
+										'event_espresso'
+									),
+									EEH_HTML::link(
+										'http://en.wikipedia.org/wiki/ISO_3166-2',
+										'http://en.wikipedia.org/wiki/ISO_3166-2',
+										'',
+										'',
+										'ee-form-add-new-state-wiki-lnk',
+										'',
+										'target="_blank"'
+									)
+								)
+								.
+								EEH_HTML::divx()
+								.
+								EEH_HTML::br()
+								.
+								EEH_HTML::link(
+									'',
+									esc_html__('cancel new State/Province', 'event_espresso'),
+									'',
+									'hide-' . $input->html_id(),
+									'ee-form-cancel-new-state-lnk smaller-text',
+									'',
+									'data-target="' . $input->html_id() . '"'
+								)
+								.
+								EEH_HTML::divx()
+								.
+								EEH_HTML::br()
+							)
+						),
+					),
+				)
+			);
+			$question_group_reg_form->add_subsections(
+				array('new_state_micro_form' => $new_state_micro_form),
+				'state',
+				false
+			);
+		}
+		return $question_group_reg_form;
+	}
+
+
+
+	/**
+	 * set_new_state_input_width
+	 *
+	 * @return int|string
+	 * @throws EE_Error
+	 */
+	public static function add_new_state()
+	{
+		$REQ = EE_Registry::instance()->load_core('Request_Handler');
+		if (absint($REQ->get('nsmf_add_new_state')) === 1) {
+			EE_Registry::instance()->load_model('State');
+			// grab country ISO code, new state name, and new state abbreviation
+			$state_country = $REQ->is_set('nsmf_new_state_country')
+				? sanitize_text_field($REQ->get('nsmf_new_state_country'))
+				: false;
+			$state_name = $REQ->is_set('nsmf_new_state_name')
+				? sanitize_text_field($REQ->get('nsmf_new_state_name'))
+				: false;
+			$state_abbr = $REQ->is_set('nsmf_new_state_abbrv')
+				? sanitize_text_field($REQ->get('nsmf_new_state_abbrv'))
+				: false;
+			if ($state_country && $state_name && $state_abbr) {
+				$new_state = EED_Add_New_State::save_new_state_to_db(array(
+					'CNT_ISO'    => strtoupper($state_country),
+					'STA_abbrev' => strtoupper($state_abbr),
+					'STA_name'   => ucwords($state_name),
+					'STA_active' => false,
+				));
+				if ($new_state instanceof EE_State) {
+					// clean house
+					EE_Registry::instance()->REQ->un_set('nsmf_add_new_state');
+					EE_Registry::instance()->REQ->un_set('nsmf_new_state_country');
+					EE_Registry::instance()->REQ->un_set('nsmf_new_state_name');
+					EE_Registry::instance()->REQ->un_set('nsmf_new_state_abbrv');
+					// get any existing new states
+					$new_states = EE_Registry::instance()->SSN->get_session_data(
+						'nsmf_new_states'
+					);
+					$new_states[$new_state->ID()] = $new_state;
+					EE_Registry::instance()->SSN->set_session_data(
+						array('nsmf_new_states' => $new_states)
+					);
+					if (EE_Registry::instance()->REQ->ajax) {
+						echo wp_json_encode(array(
+							'success'      => true,
+							'id'           => $new_state->ID(),
+							'name'         => $new_state->name(),
+							'abbrev'       => $new_state->abbrev(),
+							'country_iso'  => $new_state->country_iso(),
+							'country_name' => $new_state->country()->name(),
+						));
+						exit();
+					}
+					return $new_state->ID();
+				}
+			} else {
+				$error = esc_html__(
+					'A new State/Province could not be added because invalid or missing data was received.',
+					'event_espresso'
+				);
+				if (EE_Registry::instance()->REQ->ajax) {
+					echo wp_json_encode(array('error' => $error));
+					exit();
+				}
+				EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * recursively drills down through request params to remove any that were added by this module
+	 *
+	 * @param array $request_params
+	 * @return array
+	 */
+	public static function filter_checkout_request_params($request_params)
+	{
+		foreach ($request_params as $form_section) {
+			if (is_array($form_section)) {
+				EED_Add_New_State::unset_new_state_request_params($form_section);
+				EED_Add_New_State::filter_checkout_request_params($form_section);
+			}
+		}
+		return $request_params;
+	}
+
+
+
+	/**
+	 * @param array $request_params
+	 * @return array
+	 */
+	public static function unset_new_state_request_params($request_params)
+	{
+		unset(
+			$request_params['new_state_micro_form'],
+			$request_params['new_state_micro_add_new_state'],
+			$request_params['new_state_micro_new_state_country'],
+			$request_params['new_state_micro_new_state_name'],
+			$request_params['new_state_micro_new_state_abbrv']
+		);
+		return $request_params;
+	}
+
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public static function save_new_state_to_db($props_n_values = array())
+	{
+		$existing_state = EEM_State::instance()->get_all(array($props_n_values, 'limit' => 1));
+		if (! empty($existing_state)) {
+			return array_pop($existing_state);
+		}
+		$new_state = EE_State::new_instance($props_n_values);
+		if ($new_state instanceof EE_State) {
+			// if not non-ajax admin
+			$new_state_key = 'new-state-added-' . $new_state->country_iso() . '-' . $new_state->abbrev();
+			$new_state_notice = sprintf(
+				esc_html__(
+					'A new State named "%1$s (%2$s)" was dynamically added from an Event Espresso form for the Country of "%3$s".%5$sTo verify, edit, and/or delete this new State, please go to the %4$s and update the States / Provinces section.%5$sCheck "Yes" to have this new State added to dropdown select lists in forms.',
+					'event_espresso'
+				),
+				'<b>' . $new_state->name() . '</b>',
+				'<b>' . $new_state->abbrev() . '</b>',
+				'<b>' . $new_state->country()->name() . '</b>',
+				'<a href="' . add_query_arg(array(
+					'page'    => 'espresso_general_settings',
+					'action'  => 'country_settings',
+					'country' => $new_state->country_iso(),
+				), admin_url('admin.php')) . '">' . esc_html__('Event Espresso - General Settings > Countries Tab',
+					'event_espresso') . '</a>',
+				'<br />'
+			);
+			EE_Error::add_persistent_admin_notice($new_state_key, $new_state_notice);
+			$new_state->save();
+			EEM_State::instance()->reset_cached_states();
+			return $new_state;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @param string $CNT_ISO
+	 * @param string $STA_ID
+	 * @param array  $cols_n_values
+	 * @return void
+	 */
+	public static function update_country_settings($CNT_ISO = '', $STA_ID = '', $cols_n_values = array())
+	{
+		$CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : false;
+		if (! $CNT_ISO) {
+			EE_Error::add_error(
+				esc_html__('An invalid or missing Country ISO Code was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$STA_abbrev = is_array($cols_n_values) && isset($cols_n_values['STA_abbrev']) ? $cols_n_values['STA_abbrev']
+			: false;
+		if (! $STA_abbrev && ! empty($STA_ID)) {
+			$state = EEM_State::instance()->get_one_by_ID($STA_ID);
+			if ($state instanceof EE_State) {
+				$STA_abbrev = $state->abbrev();
+			}
+		}
+		if (! $STA_abbrev) {
+			EE_Error::add_error(
+				esc_html__('An invalid or missing State Abbreviation was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		EE_Error::dismiss_persistent_admin_notice($CNT_ISO . '-' . $STA_abbrev, true, true);
+	}
+
+
+
+	/**
+	 * @param EE_State[]                             $state_options
+	 * @param EE_SPCO_Reg_Step_Attendee_Information  $reg_step
+	 * @param EE_Registration                        $registration
+	 * @param EE_Question                            $question
+	 * @param                                        $answer
+	 * @return array
+	 */
+	public static function inject_new_reg_state_into_options(
+		$state_options = array(),
+		EE_SPCO_Reg_Step_Attendee_Information $reg_step,
+		EE_Registration $registration,
+		EE_Question $question,
+		$answer
+	) {
+		if ($answer instanceof EE_Answer && $question instanceof EE_Question
+			&& $question->type()
+			   === EEM_Question::QST_type_state
+		) {
+			$STA_ID = $answer->value();
+			if (! empty($STA_ID)) {
+				$state = EEM_State::instance()->get_one_by_ID($STA_ID);
+				if ($state instanceof EE_State) {
+					$country = $state->country();
+					if ($country instanceof EE_Country) {
+						if (! isset($state_options[$country->name()])) {
+							$state_options[$country->name()] = array();
+						}
+						if (! isset($state_options[$country->name()][$STA_ID])) {
+							$state_options[$country->name()][$STA_ID] = $state->name();
+						}
+					}
+				}
+			}
+		}
+		return $state_options;
+	}
+
+
+
+	/**
+	 * @param EE_Country[]                           $country_options
+	 * @param EE_SPCO_Reg_Step_Attendee_Information  $reg_step
+	 * @param EE_Registration                        $registration
+	 * @param EE_Question                            $question
+	 * @param                                        $answer
+	 * @return array
+	 */
+	public static function inject_new_reg_country_into_options(
+		$country_options = array(),
+		EE_SPCO_Reg_Step_Attendee_Information $reg_step,
+		EE_Registration $registration,
+		EE_Question $question,
+		$answer
+	) {
+		if ($answer instanceof EE_Answer && $question instanceof EE_Question
+			&& $question->type()
+			   === EEM_Question::QST_type_country
+		) {
+			$CNT_ISO = $answer->value();
+			if (! empty($CNT_ISO)) {
+				$country = EEM_Country::instance()->get_one_by_ID($CNT_ISO);
+				if ($country instanceof EE_Country) {
+					if (! isset($country_options[$CNT_ISO])) {
+						$country_options[$CNT_ISO] = $country->name();
+					}
+				}
+			}
+		}
+		return $country_options;
+	}
+
+
+
+	/**
+	 * @param EE_State[] $state_options
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function state_options($state_options = array())
+	{
+		$new_states = EED_Add_New_State::_get_new_states();
+		foreach ($new_states as $new_state) {
+			if (
+				$new_state instanceof EE_State
+				&& $new_state->country() instanceof EE_Country
+			) {
+				$state_options[$new_state->country()->name()][$new_state->ID()] = $new_state->name();
+			}
+		}
+		return $state_options;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	protected static function _get_new_states()
+	{
+		$new_states = array();
+		if (EE_Registry::instance()->SSN instanceof EE_Session) {
+			$new_states = EE_Registry::instance()->SSN->get_session_data(
+				'nsmf_new_states'
+			);
+		}
+		return is_array($new_states) ? $new_states : array();
+	}
+
+
+
+	/**
+	 * @param EE_Country[] $country_options
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function country_options($country_options = array())
+	{
+		$new_states = EED_Add_New_State::_get_new_states();
+		foreach ($new_states as $new_state) {
+			if (
+				$new_state instanceof EE_State
+				&& $new_state->country() instanceof EE_Country
+			) {
+				$country_options[$new_state->country()->ID()] = $new_state->country()->name();
+			}
+		}
+		return $country_options;
+	}
 
 
 

Spacing +42 added lines, -42 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -93,10 +93,10 @@ 
      */
     public static function set_definitions()
     {
-        define('ANS_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
+        define('ANS_ASSETS_URL', plugin_dir_url(__FILE__).'assets'.DS);
         define('ANS_TEMPLATES_PATH', str_replace(
             '\\',
-            DS, plugin_dir_path(__FILE__)) . 'templates' . DS
+            DS, plugin_dir_path(__FILE__)).'templates'.DS
         );
     }
 
@@ -147,7 +147,7 @@ 
     public static function wp_enqueue_scripts()
     {
         if (apply_filters('EED_Single_Page_Checkout__SPCO_active', false)) {
-            wp_register_script('add_new_state', ANS_ASSETS_URL . 'add_new_state.js',
+            wp_register_script('add_new_state', ANS_ASSETS_URL.'add_new_state.js',
                 array('espresso_core', 'single_page_checkout'), EVENT_ESPRESSO_VERSION, true);
             wp_enqueue_script('add_new_state');
         }
@@ -187,7 +187,7 @@ 
             $new_state_submit_id = str_replace('state', 'new_state', $input->html_id());
             $country_options = array();
             $countries = EEM_Country::instance()->get_all_countries();
-            if (! empty($countries)) {
+            if ( ! empty($countries)) {
                 foreach ($countries as $country) {
                     if ($country instanceof EE_Country) {
                         $country_options[$country->ID()] = $country->name();
@@ -222,10 +222,10 @@ 
                                     '',
                                     esc_html__('click here to add a new state/province', 'event_espresso'),
                                     '',
-                                    'display-' . $input->html_id(),
+                                    'display-'.$input->html_id(),
                                     'ee-form-add-new-state-lnk display-the-hidden smaller-text hide-if-no-js',
                                     '',
-                                    'data-target="' . $input->html_id() . '"'
+                                    'data-target="'.$input->html_id().'"'
                                 )
                             )
                         ),
@@ -233,31 +233,31 @@ 
                         'add_new_state_micro_form'    => new EE_Form_Section_HTML(
                             apply_filters(
                                 'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_micro_form',
-                                EEH_HTML::div('', $input->html_id() . '-dv', 'ee-form-add-new-state-dv',
-                                    'display: none;') .
+                                EEH_HTML::div('', $input->html_id().'-dv', 'ee-form-add-new-state-dv',
+                                    'display: none;').
                                 EEH_HTML::h6(
                                     esc_html__(
                                         'Is your state/province missing from the dropdown menu above? You can add it by completing the following steps:',
                                         'event_espresso'
                                     )
-                                ) .
-                                EEH_HTML::ul() .
+                                ).
+                                EEH_HTML::ul().
                                 EEH_HTML::li(
                                     esc_html__(
                                         'first select the Country that your State/Province belongs to',
                                         'event_espresso'
                                     )
-                                ) .
+                                ).
                                 EEH_HTML::li(
                                     esc_html__('enter the name of your State/Province', 'event_espresso')
-                                ) .
+                                ).
                                 EEH_HTML::li(
                                     esc_html__(
                                         'enter a two to six letter abbreviation for the name of your State/Province',
                                         'event_espresso'
                                     )
-                                ) .
-                                EEH_HTML::li(esc_html__('click the ADD button', 'event_espresso')) .
+                                ).
+                                EEH_HTML::li(esc_html__('click the ADD button', 'event_espresso')).
                                 EEH_HTML::ulx()
                             )
                         ),
@@ -270,7 +270,7 @@ 
                                     'state',
                                     'nsmf_new_state_country', $input->html_id()
                                 ),
-                                'html_class'      => $input->html_class() . ' new-state-country',
+                                'html_class'      => $input->html_class().' new-state-country',
                                 'html_label_text' => esc_html__('New State/Province Country', 'event_espresso'),
                                 'default'         => EE_Registry::instance()->REQ->get($country_name, ''),
                                 'required'        => false,
@@ -284,7 +284,7 @@ 
                                     'state',
                                     'nsmf_new_state_name', $input->html_id()
                                 ),
-                                'html_class'      => $input->html_class() . ' new-state-state',
+                                'html_class'      => $input->html_class().' new-state-state',
                                 'html_label_text' => esc_html__('New State/Province Name',
                                     'event_espresso'),
                                 'default'         => EE_Registry::instance()->REQ->get($state_name, ''),
@@ -298,11 +298,11 @@ 
                                 'html_name'             => $abbrv_name,
                                 'html_id'               => str_replace('state', 'nsmf_new_state_abbrv',
                                     $input->html_id()),
-                                'html_class'            => $input->html_class() . ' new-state-abbrv',
+                                'html_class'            => $input->html_class().' new-state-abbrv',
                                 'html_label_text'       => esc_html__(
                                     'New State/Province Abbreviation',
                                     'event_espresso'
-                                ) . ' *',
+                                ).' *',
                                 'html_other_attributes' => 'size="24"',
                                 'default'               => EE_Registry::instance()->REQ->get($abbrv_name, ''),
                                 'required'              => false,
@@ -312,15 +312,15 @@ 
                         'add_new_state_submit_button' => new EE_Form_Section_HTML(
                             apply_filters(
                                 'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_submit_button',
-                                EEH_HTML::nbsp(3) .
+                                EEH_HTML::nbsp(3).
                                 EEH_HTML::link(
                                     '',
                                     esc_html__('ADD', 'event_espresso'),
                                     '',
-                                    'submit-' . $new_state_submit_id,
+                                    'submit-'.$new_state_submit_id,
                                     'ee-form-add-new-state-submit button button-secondary',
                                     '',
-                                    'data-target="' . $new_state_submit_id . '"'
+                                    'data-target="'.$new_state_submit_id.'"'
                                 )
                             )
                         ),
@@ -333,7 +333,7 @@ 
                                 EEH_HTML::div('', '', 'small-text')
                                 .
                                 EEH_HTML::strong(
-                                    '* ' .
+                                    '* '.
                                     esc_html__(
                                         'Don\'t know your State/Province Abbreviation?',
                                         'event_espresso'
@@ -366,10 +366,10 @@ 
                                     '',
                                     esc_html__('cancel new State/Province', 'event_espresso'),
                                     '',
-                                    'hide-' . $input->html_id(),
+                                    'hide-'.$input->html_id(),
                                     'ee-form-cancel-new-state-lnk smaller-text',
                                     '',
-                                    'data-target="' . $input->html_id() . '"'
+                                    'data-target="'.$input->html_id().'"'
                                 )
                                 .
                                 EEH_HTML::divx()
@@ -508,27 +508,27 @@ 
     public static function save_new_state_to_db($props_n_values = array())
     {
         $existing_state = EEM_State::instance()->get_all(array($props_n_values, 'limit' => 1));
-        if (! empty($existing_state)) {
+        if ( ! empty($existing_state)) {
             return array_pop($existing_state);
         }
         $new_state = EE_State::new_instance($props_n_values);
         if ($new_state instanceof EE_State) {
             // if not non-ajax admin
-            $new_state_key = 'new-state-added-' . $new_state->country_iso() . '-' . $new_state->abbrev();
+            $new_state_key = 'new-state-added-'.$new_state->country_iso().'-'.$new_state->abbrev();
             $new_state_notice = sprintf(
                 esc_html__(
                     'A new State named "%1$s (%2$s)" was dynamically added from an Event Espresso form for the Country of "%3$s".%5$sTo verify, edit, and/or delete this new State, please go to the %4$s and update the States / Provinces section.%5$sCheck "Yes" to have this new State added to dropdown select lists in forms.',
                     'event_espresso'
                 ),
-                '<b>' . $new_state->name() . '</b>',
-                '<b>' . $new_state->abbrev() . '</b>',
-                '<b>' . $new_state->country()->name() . '</b>',
-                '<a href="' . add_query_arg(array(
+                '<b>'.$new_state->name().'</b>',
+                '<b>'.$new_state->abbrev().'</b>',
+                '<b>'.$new_state->country()->name().'</b>',
+                '<a href="'.add_query_arg(array(
                     'page'    => 'espresso_general_settings',
                     'action'  => 'country_settings',
                     'country' => $new_state->country_iso(),
-                ), admin_url('admin.php')) . '">' . esc_html__('Event Espresso - General Settings > Countries Tab',
-                    'event_espresso') . '</a>',
+                ), admin_url('admin.php')).'">'.esc_html__('Event Espresso - General Settings > Countries Tab',
+                    'event_espresso').'</a>',
                 '<br />'
             );
             EE_Error::add_persistent_admin_notice($new_state_key, $new_state_notice);
@@ -550,7 +550,7 @@ 
     public static function update_country_settings($CNT_ISO = '', $STA_ID = '', $cols_n_values = array())
     {
         $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : false;
-        if (! $CNT_ISO) {
+        if ( ! $CNT_ISO) {
             EE_Error::add_error(
                 esc_html__('An invalid or missing Country ISO Code was received.', 'event_espresso'),
                 __FILE__,
@@ -560,13 +560,13 @@ 
         }
         $STA_abbrev = is_array($cols_n_values) && isset($cols_n_values['STA_abbrev']) ? $cols_n_values['STA_abbrev']
             : false;
-        if (! $STA_abbrev && ! empty($STA_ID)) {
+        if ( ! $STA_abbrev && ! empty($STA_ID)) {
             $state = EEM_State::instance()->get_one_by_ID($STA_ID);
             if ($state instanceof EE_State) {
                 $STA_abbrev = $state->abbrev();
             }
         }
-        if (! $STA_abbrev) {
+        if ( ! $STA_abbrev) {
             EE_Error::add_error(
                 esc_html__('An invalid or missing State Abbreviation was received.', 'event_espresso'),
                 __FILE__,
@@ -574,7 +574,7 @@ 
                 __LINE__
             );
         }
-        EE_Error::dismiss_persistent_admin_notice($CNT_ISO . '-' . $STA_abbrev, true, true);
+        EE_Error::dismiss_persistent_admin_notice($CNT_ISO.'-'.$STA_abbrev, true, true);
     }
 
 
@@ -599,15 +599,15 @@ 
                === EEM_Question::QST_type_state
         ) {
             $STA_ID = $answer->value();
-            if (! empty($STA_ID)) {
+            if ( ! empty($STA_ID)) {
                 $state = EEM_State::instance()->get_one_by_ID($STA_ID);
                 if ($state instanceof EE_State) {
                     $country = $state->country();
                     if ($country instanceof EE_Country) {
-                        if (! isset($state_options[$country->name()])) {
+                        if ( ! isset($state_options[$country->name()])) {
                             $state_options[$country->name()] = array();
                         }
-                        if (! isset($state_options[$country->name()][$STA_ID])) {
+                        if ( ! isset($state_options[$country->name()][$STA_ID])) {
                             $state_options[$country->name()][$STA_ID] = $state->name();
                         }
                     }
@@ -639,10 +639,10 @@ 
                === EEM_Question::QST_type_country
         ) {
             $CNT_ISO = $answer->value();
-            if (! empty($CNT_ISO)) {
+            if ( ! empty($CNT_ISO)) {
                 $country = EEM_Country::instance()->get_one_by_ID($CNT_ISO);
                 if ($country instanceof EE_Country) {
-                    if (! isset($country_options[$CNT_ISO])) {
+                    if ( ! isset($country_options[$CNT_ISO])) {
                         $country_options[$CNT_ISO] = $country->name();
                     }
                 }

core/helpers/EEH_Event_View.helper.php

Indentation +94 added lines, -94 removed lines

@@ -32,49 +32,49 @@ 
 
 
 
-    /**
-     * get_event
-     * attempts to retrieve an EE_Event object any way it can
-     *
-     * @param int|WP_Post $EVT_ID
-     * @return EE_Event|null
-     * @throws \EE_Error
-     */
+	/**
+	 * get_event
+	 * attempts to retrieve an EE_Event object any way it can
+	 *
+	 * @param int|WP_Post $EVT_ID
+	 * @return EE_Event|null
+	 * @throws \EE_Error
+	 */
 	public static function get_event( $EVT_ID = 0 ) {
-        // international newspaper?
-        global $post;
-        $EVT_ID = $EVT_ID instanceof WP_Post && $EVT_ID->post_type === 'espresso_events'
-            ? $EVT_ID->ID
-            : absint($EVT_ID);
-        // do we already have the Event  you are looking for?
-        if (EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID) {
-            return EEH_Event_View::$_event;
-        }
-        //reset property so that the new event is cached.
-        EEH_Event_View::$_event = null;
-
-        if ($EVT_ID || $post instanceof WP_Post) {
-            //if the post type is for an event and it has a cached event and we don't have a different incoming $EVT_ID
-            //then let's just use that cached event on the $post object.
-            if (($post instanceof WP_Post 
-                    && $post->post_type === 'espresso_events'
-                    )
-                && isset($post->EE_Event)
-                && ($EVT_ID === 0
-                    || $EVT_ID === $post->ID
-                    )
-            ) {
-                EEH_Event_View::$_event = $post->EE_Event;
-            }
-
-            //If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
-            if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
-                EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-            }
-        }
-
-        return EEH_Event_View::$_event;
-    }
+		// international newspaper?
+		global $post;
+		$EVT_ID = $EVT_ID instanceof WP_Post && $EVT_ID->post_type === 'espresso_events'
+			? $EVT_ID->ID
+			: absint($EVT_ID);
+		// do we already have the Event  you are looking for?
+		if (EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID) {
+			return EEH_Event_View::$_event;
+		}
+		//reset property so that the new event is cached.
+		EEH_Event_View::$_event = null;
+
+		if ($EVT_ID || $post instanceof WP_Post) {
+			//if the post type is for an event and it has a cached event and we don't have a different incoming $EVT_ID
+			//then let's just use that cached event on the $post object.
+			if (($post instanceof WP_Post 
+					&& $post->post_type === 'espresso_events'
+					)
+				&& isset($post->EE_Event)
+				&& ($EVT_ID === 0
+					|| $EVT_ID === $post->ID
+					)
+			) {
+				EEH_Event_View::$_event = $post->EE_Event;
+			}
+
+			//If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
+			if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
+				EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+			}
+		}
+
+		return EEH_Event_View::$_event;
+	}
 
 
 
@@ -150,58 +150,58 @@ 
 	 * @return    string
 	 */
 	public static function event_content_or_excerpt( $num_words = NULL, $more = NULL ) {
-        global $post;
+		global $post;
 		ob_start();
 		if (( is_single() ) || ( is_archive() && espresso_display_full_description_in_event_list() )) {
 			// admin has chosen "full description"
-            // for the "Event Espresso - Events > Templates > Display Description" option
+			// for the "Event Espresso - Events > Templates > Display Description" option
 			the_content();
 		} else if (( is_archive() && espresso_display_excerpt_in_event_list() ) ) {
-            if ( has_excerpt( $post->ID )) {
-                // admin has chosen "excerpt (short desc)"
-                // for the "Event Espresso - Events > Templates > Display Description" option
-                // AND an excerpt actually exists
-                the_excerpt();
-            } else {
-                // admin has chosen "excerpt (short desc)"
-                // for the "Event Espresso - Events > Templates > Display Description" option
-                // but NO excerpt actually exists, so we need to create one
-                if ( ! empty( $num_words )) {
-                    if ( empty( $more )) {
-                        $more_link_text = __( '(more…)' );
-                        $more = ' <a href="' . get_permalink() . '"';
-                        $more .= ' class="more-link"';
-                        $more .= \EED_Events_Archive::link_target();
-                        $more .= '>' . $more_link_text . '</a>';
-                        $more = apply_filters( 'the_content_more_link', $more, $more_link_text );
-                    }
-                    $content = str_replace( 'NOMORELINK', '', get_the_content( 'NOMORELINK' ));
-
-                    $content =  wp_trim_words( $content, $num_words, ' ' ) . $more;
-                } else {
-                    $content =  get_the_content();
-                }
-                global $allowedtags;
-                // make sure links are allowed
-                $allowedtags['a'] = isset($allowedtags['a'])
-                    ? $allowedtags['a']
-                    : array();
-                // as well as target attribute
-                $allowedtags['a']['target'] = isset($allowedtags['a']['target'])
-                    ? $allowedtags['a']['target']
-                    : false;
-                // but get previous value so we can reset it
-                $prev_value = $allowedtags['a']['target'];
-                $allowedtags['a']['target'] = true;
-                $content = wp_kses( $content, $allowedtags );
-                $content = strip_shortcodes( $content );
-                echo apply_filters( 'the_content', $content );
-                $allowedtags['a']['target'] = $prev_value;
-            }
-        } else {
-            // admin has chosen "none"
-            // for the "Event Espresso - Events > Templates > Display Description" option
-            echo apply_filters( 'the_content', '' );
+			if ( has_excerpt( $post->ID )) {
+				// admin has chosen "excerpt (short desc)"
+				// for the "Event Espresso - Events > Templates > Display Description" option
+				// AND an excerpt actually exists
+				the_excerpt();
+			} else {
+				// admin has chosen "excerpt (short desc)"
+				// for the "Event Espresso - Events > Templates > Display Description" option
+				// but NO excerpt actually exists, so we need to create one
+				if ( ! empty( $num_words )) {
+					if ( empty( $more )) {
+						$more_link_text = __( '(more&hellip;)' );
+						$more = ' <a href="' . get_permalink() . '"';
+						$more .= ' class="more-link"';
+						$more .= \EED_Events_Archive::link_target();
+						$more .= '>' . $more_link_text . '</a>';
+						$more = apply_filters( 'the_content_more_link', $more, $more_link_text );
+					}
+					$content = str_replace( 'NOMORELINK', '', get_the_content( 'NOMORELINK' ));
+
+					$content =  wp_trim_words( $content, $num_words, ' ' ) . $more;
+				} else {
+					$content =  get_the_content();
+				}
+				global $allowedtags;
+				// make sure links are allowed
+				$allowedtags['a'] = isset($allowedtags['a'])
+					? $allowedtags['a']
+					: array();
+				// as well as target attribute
+				$allowedtags['a']['target'] = isset($allowedtags['a']['target'])
+					? $allowedtags['a']['target']
+					: false;
+				// but get previous value so we can reset it
+				$prev_value = $allowedtags['a']['target'];
+				$allowedtags['a']['target'] = true;
+				$content = wp_kses( $content, $allowedtags );
+				$content = strip_shortcodes( $content );
+				echo apply_filters( 'the_content', $content );
+				$allowedtags['a']['target'] = $prev_value;
+			}
+		} else {
+			// admin has chosen "none"
+			// for the "Event Espresso - Events > Templates > Display Description" option
+			echo apply_filters( 'the_content', '' );
 		}
 		return ob_get_clean();
 	}
@@ -248,11 +248,11 @@ 
 					$url = get_term_link( $term, 'espresso_venue_categories' );
 					if ( ! is_wp_error( $url ) && (( $hide_uncategorized && strtolower( $term->name ) != __( 'uncategorized', 'event_espresso' )) || ! $hide_uncategorized )) {
 						$category_links[] = '<a href="' . esc_url( $url )
-                                            . '" rel="tag"'
-                                            . \EED_Events_Archive::link_target()
-                                            .'>'
-                                            . $term->name
-                                            . '</a>';
+											. '" rel="tag"'
+											. \EED_Events_Archive::link_target()
+											.'>'
+											. $term->name
+											. '</a>';
 					}
 				}
 			}

admin_pages/about/templates/credits.template.php

Spacing +13 added lines, -13 removed lines

@@ -3,7 +3,7 @@ 
 <ul class="wp-people-group" id="ee-people-group-owners">
 	<li class="wp-person" id="ee-person-sshoultes">
 		<a href="<?php esp_gravatar_profile('seth@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'seth@eventespresso.com', 'Seth Shoultes' ); ?>
+			<?php echo esp_gravatar_image('seth@eventespresso.com', 'Seth Shoultes'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('seth@eventespresso.com'); ?>">
 			Seth Shoultes
@@ -12,7 +12,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-gkoyle">
 		<a href="<?php esp_gravatar_profile('garth@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'garth@eventespresso.com', 'Garth Koyle' ); ?>
+			<?php echo esp_gravatar_image('garth@eventespresso.com', 'Garth Koyle'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('garth@eventespresso.com'); ?>">
 			Garth Koyle
@@ -24,7 +24,7 @@ 
 <ul class="wp-people-group" id="ee-people-group-core-developers">
 	<li class="wp-person" id="ee-person-bchristensen">
 		<a href="<?php esp_gravatar_profile('brent@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'brent@eventespresso.com', 'Brent Christensen' ); ?>
+			<?php echo esp_gravatar_image('brent@eventespresso.com', 'Brent Christensen'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('brent@eventespresso.com'); ?>">
 			Brent Christensen
@@ -33,7 +33,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-dethier">
 		<a href="<?php esp_gravatar_profile('darren@roughsmootheng.in'); ?>">
-			<?php echo esp_gravatar_image( 'darren@roughsmootheng.in', 'Darren Ethier' ); ?>
+			<?php echo esp_gravatar_image('darren@roughsmootheng.in', 'Darren Ethier'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('darren@roughsmootheng.in'); ?>">
 			Darren Ethier
@@ -42,7 +42,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-mnelson">
 		<a href="<?php esp_gravatar_profile('michael@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'michael@eventespresso.com', 'Michael Nelson' ); ?>
+			<?php echo esp_gravatar_image('michael@eventespresso.com', 'Michael Nelson'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('michael@eventespresso.com'); ?>">
 			Michael Nelson
@@ -51,7 +51,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-nkolivoshka">
 		<a href="<?php esp_gravatar_profile('nazar@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'nazar@eventespresso.com', 'Nazar Kolivoshka' ); ?>
+			<?php echo esp_gravatar_image('nazar@eventespresso.com', 'Nazar Kolivoshka'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('nazar@eventespresso.com'); ?>">
 			Nazar Kolivoshka
@@ -63,7 +63,7 @@ 
 <ul class="wp-people-group" id="ee-people-group-support-staff">
 	<li class="wp-person" id="ee-person-jfeck">
 		<a href="<?php esp_gravatar_profile('josh@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'josh@eventespresso.com', 'Josh Feck' ); ?>
+			<?php echo esp_gravatar_image('josh@eventespresso.com', 'Josh Feck'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('josh@eventespresso.com'); ?>">
 			Josh Feck
@@ -71,7 +71,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-twarwick">
 		<a href="<?php esp_gravatar_profile('tony@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'tony@eventespresso.com', 'Tony Warwick' ); ?>
+			<?php echo esp_gravatar_image('tony@eventespresso.com', 'Tony Warwick'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('tony@eventespresso.com'); ?>">
 			Tony Warwick
@@ -79,7 +79,7 @@ 
 	</li>
 	<li class="wp-person" id="ee-person-lcaum">
 		<a href="<?php esp_gravatar_profile('lorenzo@eventespresso.com'); ?>">
-			<?php echo esp_gravatar_image( 'lorenzo@eventespresso.com', 'Lorenzo Caum' ); ?>
+			<?php echo esp_gravatar_image('lorenzo@eventespresso.com', 'Lorenzo Caum'); ?>
 		</a>
 		<a class="web" href="<?php esp_gravatar_profile('lorenzo@eventespresso.com'); ?>">
 			Lorenzo Caum
@@ -89,7 +89,7 @@ 
 </ul>
 <h3 class="wp-people-group"><?php _e('Contributor Recognition', 'event_espresso'); ?></h3>
 <p class="description">
-	<?php printf( __('For every major release we want to recognize the people who contributed to the release via a GitHub pull request. Want to see your name listed here? %sWhen you submit a pull request that gets included in a major release%s, we\'ll add your name here linked to your GitHub profile.', 'event_espresso'), '<a href="https://github.com/eventespresso/event-espresso-core" title="Contribute to Event Espresso by making a pull request via GitHub">', '</a>' ); ?>
+	<?php printf(__('For every major release we want to recognize the people who contributed to the release via a GitHub pull request. Want to see your name listed here? %sWhen you submit a pull request that gets included in a major release%s, we\'ll add your name here linked to your GitHub profile.', 'event_espresso'), '<a href="https://github.com/eventespresso/event-espresso-core" title="Contribute to Event Espresso by making a pull request via GitHub">', '</a>'); ?>
 </p>
 <p class="wp-credits-list">
 	<ul>
@@ -103,7 +103,7 @@ 
 </p>
 <h3 class="wp-people-group"><?php _e('External Libraries', 'event_espresso'); ?></h3>
 <p class="description">
-	<?php printf( __('Along with the libraries %sincluded with WordPress%s, Event Espresso utilizes the following third party libraries:', 'event_espresso'), '<a href="credits.php">', '</a>' ); ?>
+	<?php printf(__('Along with the libraries %sincluded with WordPress%s, Event Espresso utilizes the following third party libraries:', 'event_espresso'), '<a href="credits.php">', '</a>'); ?>
 </p>
 <p class="wp-credits-list">
 	<a href="http://josscrowcroft.github.io/accounting.js/"><?php _e('accounting.js', 'event_espresso'); ?></a>,
@@ -119,10 +119,10 @@ 
 
 <?php
 	function esp_gravatar_profile($email) {
-		echo 'http://www.gravatar.com/' . md5($email);
+		echo 'http://www.gravatar.com/'.md5($email);
 	}
 
 	function esp_gravatar_image($email, $name) {
-		echo '<img src="http://0.gravatar.com/avatar/' . md5($email) . '?s=60" class="gravatar" alt="' . $name . '"/>';
+		echo '<img src="http://0.gravatar.com/avatar/'.md5($email).'?s=60" class="gravatar" alt="'.$name.'"/>';
 	}
 ?>

core/EE_Error.core.php

Indentation +1085 added lines, -1085 removed lines

@@ -5,8 +5,8 @@ 
 // if you're a dev and want to receive all errors via email
 // add this to your wp-config.php: define( 'EE_ERROR_EMAILS', TRUE );
 if (defined('WP_DEBUG') && WP_DEBUG === true && defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS === true) {
-    set_error_handler(array('EE_Error', 'error_handler'));
-    register_shutdown_function(array('EE_Error', 'fatal_error_handler'));
+	set_error_handler(array('EE_Error', 'error_handler'));
+	register_shutdown_function(array('EE_Error', 'fatal_error_handler'));
 }
 
 
@@ -23,259 +23,259 @@ 
 {
 
 
-    /**
-     *    name of the file to log exceptions to
-     *
-     * @var string
-     */
-    private static $_exception_log_file = 'espresso_error_log.txt';
-
-    /**
-     *    stores details for all exception
-     *
-     * @var array
-     */
-    private static $_all_exceptions = array();
-
-    /**
-     *    tracks number of errors
-     *
-     * @var int
-     */
-    private static $_error_count = 0;
-
-    /**
-     *    has shutdown action been added ?
-     *
-     * @var array $_espresso_notices
-     */
-    private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false);
-
-
-
-    /**
-     * @override default exception handling
-     * @param string         $message
-     * @param int            $code
-     * @param Exception|null $previous
-     */
-    public function __construct($message, $code = 0, Exception $previous = null)
-    {
-        if (version_compare(PHP_VERSION, '5.3.0', '<')) {
-            parent::__construct($message, $code);
-        } else {
-            parent::__construct($message, $code, $previous);
-        }
-    }
-
-
-
-    /**
-     *    error_handler
-     *
-     * @param $code
-     * @param $message
-     * @param $file
-     * @param $line
-     * @return void
-     */
-    public static function error_handler($code, $message, $file, $line)
-    {
-        $type = EE_Error::error_type($code);
-        $site = site_url();
-        switch ($site) {
-            case 'http://ee4.eventespresso.com/' :
-            case 'http://ee4decaf.eventespresso.com/' :
-            case 'http://ee4hf.eventespresso.com/' :
-            case 'http://ee4a.eventespresso.com/' :
-            case 'http://ee4ad.eventespresso.com/' :
-            case 'http://ee4b.eventespresso.com/' :
-            case 'http://ee4bd.eventespresso.com/' :
-            case 'http://ee4d.eventespresso.com/' :
-            case 'http://ee4dd.eventespresso.com/' :
-                $to = 'developers@eventespresso.com';
-                break;
-            default :
-                $to = get_option('admin_email');
-        }
-        $subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
-        $msg = EE_Error::_format_error($type, $message, $file, $line);
-        if (function_exists('wp_mail')) {
-            add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
-            wp_mail($to, $subject, $msg);
-        }
-        echo '<div id="message" class="espresso-notices error"><p>';
-        echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
-        echo '<br /></p></div>';
-    }
-
-
-
-    /**
-     * error_type
-     * http://www.php.net/manual/en/errorfunc.constants.php#109430
-     *
-     * @param $code
-     * @return string
-     */
-    public static function error_type($code)
-    {
-        switch ($code) {
-            case E_ERROR: // 1 //
-                return 'E_ERROR';
-            case E_WARNING: // 2 //
-                return 'E_WARNING';
-            case E_PARSE: // 4 //
-                return 'E_PARSE';
-            case E_NOTICE: // 8 //
-                return 'E_NOTICE';
-            case E_CORE_ERROR: // 16 //
-                return 'E_CORE_ERROR';
-            case E_CORE_WARNING: // 32 //
-                return 'E_CORE_WARNING';
-            case E_COMPILE_ERROR: // 64 //
-                return 'E_COMPILE_ERROR';
-            case E_COMPILE_WARNING: // 128 //
-                return 'E_COMPILE_WARNING';
-            case E_USER_ERROR: // 256 //
-                return 'E_USER_ERROR';
-            case E_USER_WARNING: // 512 //
-                return 'E_USER_WARNING';
-            case E_USER_NOTICE: // 1024 //
-                return 'E_USER_NOTICE';
-            case E_STRICT: // 2048 //
-                return 'E_STRICT';
-            case E_RECOVERABLE_ERROR: // 4096 //
-                return 'E_RECOVERABLE_ERROR';
-            case E_DEPRECATED: // 8192 //
-                return 'E_DEPRECATED';
-            case E_USER_DEPRECATED: // 16384 //
-                return 'E_USER_DEPRECATED';
-            case E_ALL: // 16384 //
-                return 'E_ALL';
-        }
-        return '';
-    }
-
-
-
-    /**
-     *    fatal_error_handler
-     *
-     * @return void
-     */
-    public static function fatal_error_handler()
-    {
-        $last_error = error_get_last();
-        if ($last_error['type'] === E_ERROR) {
-            EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
-        }
-    }
-
-
-
-    /**
-     * _format_error
-     *
-     * @param $code
-     * @param $message
-     * @param $file
-     * @param $line
-     * @return string
-     */
-    private static function _format_error($code, $message, $file, $line)
-    {
-        $html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>";
-        $html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>";
-        $html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>";
-        $html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>";
-        $html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>";
-        $html .= '</tbody></table>';
-        return $html;
-    }
-
-
-
-    /**
-     * set_content_type
-     *
-     * @param $content_type
-     * @return string
-     */
-    public static function set_content_type($content_type)
-    {
-        return 'text/html';
-    }
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_error()
-    {
-        if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
-            throw $this;
-        }
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $this->getMessage());
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // add details to _all_exceptions array
-        $x_time = time();
-        self::$_all_exceptions[$x_time]['name'] = get_class($this);
-        self::$_all_exceptions[$x_time]['file'] = $this->getFile();
-        self::$_all_exceptions[$x_time]['line'] = $this->getLine();
-        self::$_all_exceptions[$x_time]['msg'] = $msg;
-        self::$_all_exceptions[$x_time]['code'] = $this->getCode();
-        self::$_all_exceptions[$x_time]['trace'] = $this->getTrace();
-        self::$_all_exceptions[$x_time]['string'] = $this->getTraceAsString();
-        self::$_error_count++;
-        //add_action( 'shutdown', array( $this, 'display_errors' ));
-        $this->display_errors();
-    }
-
-
-
-    /**
-     *    has_error
-     *
-     * @param bool   $check_stored
-     * @param string $type_to_check
-     * @return bool
-     */
-    public static function has_error($check_stored = false, $type_to_check = 'errors')
-    {
-        $has_error = isset(self::$_espresso_notices[$type_to_check])
-                     && ! empty(self::$_espresso_notices[$type_to_check])
-            ? true
-            : false;
-        if ($check_stored && ! $has_error) {
-            $notices = (array)get_option('ee_notices', array());
-            foreach ($notices as $type => $notice) {
-                if ($type === $type_to_check && $notice) {
-                    return true;
-                }
-            }
-        }
-        return $has_error;
-    }
-
-
-
-    /**
-     *    display_errors
-     *
-     * @echo   string
-     * @throws \ReflectionException
-     */
-    public function display_errors()
-    {
-        $trace_details = '';
-        $output = '
+	/**
+	 *    name of the file to log exceptions to
+	 *
+	 * @var string
+	 */
+	private static $_exception_log_file = 'espresso_error_log.txt';
+
+	/**
+	 *    stores details for all exception
+	 *
+	 * @var array
+	 */
+	private static $_all_exceptions = array();
+
+	/**
+	 *    tracks number of errors
+	 *
+	 * @var int
+	 */
+	private static $_error_count = 0;
+
+	/**
+	 *    has shutdown action been added ?
+	 *
+	 * @var array $_espresso_notices
+	 */
+	private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false);
+
+
+
+	/**
+	 * @override default exception handling
+	 * @param string         $message
+	 * @param int            $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($message, $code = 0, Exception $previous = null)
+	{
+		if (version_compare(PHP_VERSION, '5.3.0', '<')) {
+			parent::__construct($message, $code);
+		} else {
+			parent::__construct($message, $code, $previous);
+		}
+	}
+
+
+
+	/**
+	 *    error_handler
+	 *
+	 * @param $code
+	 * @param $message
+	 * @param $file
+	 * @param $line
+	 * @return void
+	 */
+	public static function error_handler($code, $message, $file, $line)
+	{
+		$type = EE_Error::error_type($code);
+		$site = site_url();
+		switch ($site) {
+			case 'http://ee4.eventespresso.com/' :
+			case 'http://ee4decaf.eventespresso.com/' :
+			case 'http://ee4hf.eventespresso.com/' :
+			case 'http://ee4a.eventespresso.com/' :
+			case 'http://ee4ad.eventespresso.com/' :
+			case 'http://ee4b.eventespresso.com/' :
+			case 'http://ee4bd.eventespresso.com/' :
+			case 'http://ee4d.eventespresso.com/' :
+			case 'http://ee4dd.eventespresso.com/' :
+				$to = 'developers@eventespresso.com';
+				break;
+			default :
+				$to = get_option('admin_email');
+		}
+		$subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
+		$msg = EE_Error::_format_error($type, $message, $file, $line);
+		if (function_exists('wp_mail')) {
+			add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
+			wp_mail($to, $subject, $msg);
+		}
+		echo '<div id="message" class="espresso-notices error"><p>';
+		echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
+		echo '<br /></p></div>';
+	}
+
+
+
+	/**
+	 * error_type
+	 * http://www.php.net/manual/en/errorfunc.constants.php#109430
+	 *
+	 * @param $code
+	 * @return string
+	 */
+	public static function error_type($code)
+	{
+		switch ($code) {
+			case E_ERROR: // 1 //
+				return 'E_ERROR';
+			case E_WARNING: // 2 //
+				return 'E_WARNING';
+			case E_PARSE: // 4 //
+				return 'E_PARSE';
+			case E_NOTICE: // 8 //
+				return 'E_NOTICE';
+			case E_CORE_ERROR: // 16 //
+				return 'E_CORE_ERROR';
+			case E_CORE_WARNING: // 32 //
+				return 'E_CORE_WARNING';
+			case E_COMPILE_ERROR: // 64 //
+				return 'E_COMPILE_ERROR';
+			case E_COMPILE_WARNING: // 128 //
+				return 'E_COMPILE_WARNING';
+			case E_USER_ERROR: // 256 //
+				return 'E_USER_ERROR';
+			case E_USER_WARNING: // 512 //
+				return 'E_USER_WARNING';
+			case E_USER_NOTICE: // 1024 //
+				return 'E_USER_NOTICE';
+			case E_STRICT: // 2048 //
+				return 'E_STRICT';
+			case E_RECOVERABLE_ERROR: // 4096 //
+				return 'E_RECOVERABLE_ERROR';
+			case E_DEPRECATED: // 8192 //
+				return 'E_DEPRECATED';
+			case E_USER_DEPRECATED: // 16384 //
+				return 'E_USER_DEPRECATED';
+			case E_ALL: // 16384 //
+				return 'E_ALL';
+		}
+		return '';
+	}
+
+
+
+	/**
+	 *    fatal_error_handler
+	 *
+	 * @return void
+	 */
+	public static function fatal_error_handler()
+	{
+		$last_error = error_get_last();
+		if ($last_error['type'] === E_ERROR) {
+			EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
+		}
+	}
+
+
+
+	/**
+	 * _format_error
+	 *
+	 * @param $code
+	 * @param $message
+	 * @param $file
+	 * @param $line
+	 * @return string
+	 */
+	private static function _format_error($code, $message, $file, $line)
+	{
+		$html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>";
+		$html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>";
+		$html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>";
+		$html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>";
+		$html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>";
+		$html .= '</tbody></table>';
+		return $html;
+	}
+
+
+
+	/**
+	 * set_content_type
+	 *
+	 * @param $content_type
+	 * @return string
+	 */
+	public static function set_content_type($content_type)
+	{
+		return 'text/html';
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_error()
+	{
+		if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
+			throw $this;
+		}
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $this->getMessage());
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// add details to _all_exceptions array
+		$x_time = time();
+		self::$_all_exceptions[$x_time]['name'] = get_class($this);
+		self::$_all_exceptions[$x_time]['file'] = $this->getFile();
+		self::$_all_exceptions[$x_time]['line'] = $this->getLine();
+		self::$_all_exceptions[$x_time]['msg'] = $msg;
+		self::$_all_exceptions[$x_time]['code'] = $this->getCode();
+		self::$_all_exceptions[$x_time]['trace'] = $this->getTrace();
+		self::$_all_exceptions[$x_time]['string'] = $this->getTraceAsString();
+		self::$_error_count++;
+		//add_action( 'shutdown', array( $this, 'display_errors' ));
+		$this->display_errors();
+	}
+
+
+
+	/**
+	 *    has_error
+	 *
+	 * @param bool   $check_stored
+	 * @param string $type_to_check
+	 * @return bool
+	 */
+	public static function has_error($check_stored = false, $type_to_check = 'errors')
+	{
+		$has_error = isset(self::$_espresso_notices[$type_to_check])
+					 && ! empty(self::$_espresso_notices[$type_to_check])
+			? true
+			: false;
+		if ($check_stored && ! $has_error) {
+			$notices = (array)get_option('ee_notices', array());
+			foreach ($notices as $type => $notice) {
+				if ($type === $type_to_check && $notice) {
+					return true;
+				}
+			}
+		}
+		return $has_error;
+	}
+
+
+
+	/**
+	 *    display_errors
+	 *
+	 * @echo   string
+	 * @throws \ReflectionException
+	 */
+	public function display_errors()
+	{
+		$trace_details = '';
+		$output = '
 <style type="text/css">
 	#ee-error-message {
 		max-width:90% !important;
@@ -331,19 +331,19 @@ 
 	}
 </style>
 <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
-            $output .= '
+		if (! WP_DEBUG) {
+			$output .= '
 	<p>';
-        }
-        // cycle thru errors
-        foreach (self::$_all_exceptions as $time => $ex) {
-            $error_code = '';
-            // process trace info
-            if (empty($ex['trace'])) {
-                $trace_details .= __('Sorry, but no trace information was available for this exception.',
-                    'event_espresso');
-            } else {
-                $trace_details .= '
+		}
+		// cycle thru errors
+		foreach (self::$_all_exceptions as $time => $ex) {
+			$error_code = '';
+			// process trace info
+			if (empty($ex['trace'])) {
+				$trace_details .= __('Sorry, but no trace information was available for this exception.',
+					'event_espresso');
+			} else {
+				$trace_details .= '
 			<div id="ee-trace-details">
 			<table width="100%" border="0" cellpadding="5" cellspacing="0">
 				<tr>
@@ -353,38 +353,38 @@ 
 					<th scope="col" align="left">Class</th>
 					<th scope="col" align="left">Method( arguments )</th>
 				</tr>';
-                $last_on_stack = count($ex['trace']) - 1;
-                // reverse array so that stack is in proper chronological order
-                $sorted_trace = array_reverse($ex['trace']);
-                foreach ($sorted_trace as $nmbr => $trace) {
-                    $file = isset($trace['file']) ? $trace['file'] : '';
-                    $class = isset($trace['class']) ? $trace['class'] : '';
-                    $type = isset($trace['type']) ? $trace['type'] : '';
-                    $function = isset($trace['function']) ? $trace['function'] : '';
-                    $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-                    $line = isset($trace['line']) ? $trace['line'] : '';
-                    $zebra = ($nmbr % 2) ? ' odd' : '';
-                    if (empty($file) && ! empty($class)) {
-                        $a = new ReflectionClass($class);
-                        $file = $a->getFileName();
-                        if (empty($line) && ! empty($function)) {
-                            $b = new ReflectionMethod($class, $function);
-                            $line = $b->getStartLine();
-                        }
-                    }
-                    if ($nmbr === $last_on_stack) {
-                        $file = $ex['file'] !== '' ? $ex['file'] : $file;
-                        $line = $ex['line'] !== '' ? $ex['line'] : $line;
-                        $error_code = self::generate_error_code($file, $trace['function'], $line);
-                    }
-                    $nmbr_dsply = ! empty($nmbr) ? $nmbr : '&nbsp;';
-                    $line_dsply = ! empty($line) ? $line : '&nbsp;';
-                    $file_dsply = ! empty($file) ? $file : '&nbsp;';
-                    $class_dsply = ! empty($class) ? $class : '&nbsp;';
-                    $type_dsply = ! empty($type) ? $type : '&nbsp;';
-                    $function_dsply = ! empty($function) ? $function : '&nbsp;';
-                    $args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
-                    $trace_details .= '
+				$last_on_stack = count($ex['trace']) - 1;
+				// reverse array so that stack is in proper chronological order
+				$sorted_trace = array_reverse($ex['trace']);
+				foreach ($sorted_trace as $nmbr => $trace) {
+					$file = isset($trace['file']) ? $trace['file'] : '';
+					$class = isset($trace['class']) ? $trace['class'] : '';
+					$type = isset($trace['type']) ? $trace['type'] : '';
+					$function = isset($trace['function']) ? $trace['function'] : '';
+					$args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
+					$line = isset($trace['line']) ? $trace['line'] : '';
+					$zebra = ($nmbr % 2) ? ' odd' : '';
+					if (empty($file) && ! empty($class)) {
+						$a = new ReflectionClass($class);
+						$file = $a->getFileName();
+						if (empty($line) && ! empty($function)) {
+							$b = new ReflectionMethod($class, $function);
+							$line = $b->getStartLine();
+						}
+					}
+					if ($nmbr === $last_on_stack) {
+						$file = $ex['file'] !== '' ? $ex['file'] : $file;
+						$line = $ex['line'] !== '' ? $ex['line'] : $line;
+						$error_code = self::generate_error_code($file, $trace['function'], $line);
+					}
+					$nmbr_dsply = ! empty($nmbr) ? $nmbr : '&nbsp;';
+					$line_dsply = ! empty($line) ? $line : '&nbsp;';
+					$file_dsply = ! empty($file) ? $file : '&nbsp;';
+					$class_dsply = ! empty($class) ? $class : '&nbsp;';
+					$type_dsply = ! empty($type) ? $type : '&nbsp;';
+					$function_dsply = ! empty($function) ? $function : '&nbsp;';
+					$args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
+					$trace_details .= '
 					<tr>
 						<td align="right" class="' . $zebra . '">' . $nmbr_dsply . '</td>
 						<td align="right" class="' . $zebra . '">' . $line_dsply . '</td>
@@ -392,669 +392,669 @@ 
 						<td align="left" class="' . $zebra . '">' . $class_dsply . '</td>
 						<td align="left" class="' . $zebra . '">' . $type_dsply . $function_dsply . $args_dsply . '</td>
 					</tr>';
-                }
-                $trace_details .= '
+				}
+				$trace_details .= '
 			 </table>
 			</div>';
-            }
-            $ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
-            // add generic non-identifying messages for non-privileged users
-            if (! WP_DEBUG) {
-                $output .= '<span class="ee-error-user-msg-spn">'
-                           . trim($ex['msg'])
-                           . '</span> &nbsp; <sup>'
-                           . $ex['code']
-                           . '</sup><br />';
-            } else {
-                // or helpful developer messages if debugging is on
-                $output .= '
+			}
+			$ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
+			// add generic non-identifying messages for non-privileged users
+			if (! WP_DEBUG) {
+				$output .= '<span class="ee-error-user-msg-spn">'
+						   . trim($ex['msg'])
+						   . '</span> &nbsp; <sup>'
+						   . $ex['code']
+						   . '</sup><br />';
+			} else {
+				// or helpful developer messages if debugging is on
+				$output .= '
 		<div class="ee-error-dev-msg-dv">
 			<p class="ee-error-dev-msg-pg">
 				<strong class="ee-error-dev-msg-str">An '
-                           . $ex['name']
-                           . ' exception was thrown!</strong>  &nbsp; <span>code: '
-                           . $ex['code']
-                           . '</span><br />
+						   . $ex['name']
+						   . ' exception was thrown!</strong>  &nbsp; <span>code: '
+						   . $ex['code']
+						   . '</span><br />
 				<span class="big-text">"'
-                           . trim($ex['msg'])
-                           . '"</span><br/>
+						   . trim($ex['msg'])
+						   . '"</span><br/>
 				<a id="display-ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '">
+						   . self::$_error_count
+						   . $time
+						   . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
+						   . self::$_error_count
+						   . $time
+						   . '">
 					'
-                           . __('click to view backtrace and class/method details', 'event_espresso')
-                           . '
+						   . __('click to view backtrace and class/method details', 'event_espresso')
+						   . '
 				</a><br />
 				<span class="small-text lt-grey-text">'
-                           . $ex['file']
-                           . ' &nbsp; ( line no: '
-                           . $ex['line']
-                           . ' )</span>
+						   . $ex['file']
+						   . ' &nbsp; ( line no: '
+						   . $ex['line']
+						   . ' )</span>
 			</p>
 			<div id="ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '-dv" class="ee-error-trace-dv" style="display: none;">
+						   . self::$_error_count
+						   . $time
+						   . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
-                           . $trace_details;
-                if (! empty($class)) {
-                    $output .= '
+						   . $trace_details;
+				if (! empty($class)) {
+					$output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #666; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #666; background:#f9f9f9;">
 						<h3>Class Details</h3>';
-                    $a = new ReflectionClass($class);
-                    $output .= '
+					$a = new ReflectionClass($class);
+					$output .= '
 						<pre>' . $a . '</pre>
 					</div>
 				</div>';
-                }
-                $output .= '
+				}
+				$output .= '
 			</div>
 		</div>
 		<br />';
-            }
-            $this->write_to_error_log($time, $ex);
-        }
-        // remove last linebreak
-        $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
-            $output .= '
+			}
+			$this->write_to_error_log($time, $ex);
+		}
+		// remove last linebreak
+		$output = substr($output, 0, -6);
+		if (! WP_DEBUG) {
+			$output .= '
 	</p>';
-        }
-        $output .= '
+		}
+		$output .= '
 </div>';
-        $output .= self::_print_scripts(true);
-        if (defined('DOING_AJAX')) {
-            echo wp_json_encode(array('error' => $output));
-            exit();
-        }
-        echo $output;
-        die();
-    }
-
-
-
-    /**
-     *    generate string from exception trace args
-     *
-     * @param array $arguments
-     * @param bool  $array
-     * @return string
-     */
-    private function _convert_args_to_string($arguments = array(), $array = false)
-    {
-        $arg_string = '';
-        if (! empty($arguments)) {
-            $args = array();
-            foreach ($arguments as $arg) {
-                if (! empty($arg)) {
-                    if (is_string($arg)) {
-                        $args[] = " '" . $arg . "'";
-                    } elseif (is_array($arg)) {
-                        $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
-                    } elseif ($arg === null) {
-                        $args[] = ' NULL';
-                    } elseif (is_bool($arg)) {
-                        $args[] = ($arg) ? ' TRUE' : ' FALSE';
-                    } elseif (is_object($arg)) {
-                        $args[] = ' OBJECT ' . get_class($arg);
-                    } elseif (is_resource($arg)) {
-                        $args[] = get_resource_type($arg);
-                    } else {
-                        $args[] = $arg;
-                    }
-                }
-            }
-            $arg_string = implode(', ', $args);
-        }
-        if ($array) {
-            $arg_string .= ' )';
-        }
-        return $arg_string;
-    }
-
-
-
-    /**
-     *    add error message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_error($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('errors', $msg, $file, $func, $line);
-        self::$_error_count++;
-    }
-
-
-
-    /**
-     * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
-     * adds an error
-     *
-     * @param string $msg
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @throws EE_Error
-     */
-    public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null)
-    {
-        if (WP_DEBUG) {
-            throw new EE_Error($msg);
-        }
-        EE_Error::add_error($msg, $file, $func, $line);
-    }
-
-
-
-    /**
-     *    add success message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_success($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('success', $msg, $file, $func, $line);
-    }
-
-
-
-    /**
-     *    add attention message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_attention($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('attention', $msg, $file, $func, $line);
-    }
-
-
-
-    /**
-     *    add success message
-     *
-     * @param        string $type whether the message is for a success or error notification
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    private static function _add_notice($type = 'success', $msg = null, $file = null, $func = null, $line = null)
-    {
-        if (empty($msg)) {
-            EE_Error::doing_it_wrong(
-                'EE_Error::add_' . $type . '()',
-                sprintf(
-                    __('Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
-                        'event_espresso'),
-                    $type,
-                    $file,
-                    $line
-                ),
-                EVENT_ESPRESSO_VERSION
-            );
-        }
-        if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
-            EE_Error::doing_it_wrong(
-                'EE_Error::add_error()',
-                __('You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
-                    'event_espresso'),
-                EVENT_ESPRESSO_VERSION
-            );
-        }
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $msg);
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        /**
-         * Do an action so other code can be triggered when a notice is created
-         *
-         * @param string $type     can be 'errors', 'attention', or 'success'
-         * @param string $user_msg message displayed to user when WP_DEBUG is off
-         * @param string $user_msg message displayed to user when WP_DEBUG is on
-         * @param string $file     file where error was generated
-         * @param string $func     function where error was generated
-         * @param string $line     line where error was generated
-         */
-        do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // add notice if message exists
-        if (! empty($msg)) {
-            // get error code
-            $notice_code = EE_Error::generate_error_code($file, $func, $line);
-            if (WP_DEBUG && $type === 'errors') {
-                $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
-            }
-            // add notice. Index by code if it's not blank
-            if ($notice_code) {
-                self::$_espresso_notices[$type][$notice_code] = $msg;
-            } else {
-                self::$_espresso_notices[$type][] = $msg;
-            }
-            add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
-        }
-    }
-
-
-
-    /**
-     *    in some case it may be necessary to overwrite the existing success messages
-     *
-     * @return        void
-     */
-    public static function overwrite_success()
-    {
-        self::$_espresso_notices['success'] = false;
-    }
-
-
-
-    /**
-     *    in some case it may be necessary to overwrite the existing attention messages
-     *
-     * @return        void
-     */
-    public static function overwrite_attention()
-    {
-        self::$_espresso_notices['attention'] = false;
-    }
-
-
-
-    /**
-     *    in some case it may be necessary to overwrite the existing error messages
-     *
-     * @return        void
-     */
-    public static function overwrite_errors()
-    {
-        self::$_espresso_notices['errors'] = false;
-    }
-
-
-
-    /**
-     *    reset_notices
-     *
-     * @return void
-     */
-    public static function reset_notices()
-    {
-        self::$_espresso_notices['success'] = false;
-        self::$_espresso_notices['attention'] = false;
-        self::$_espresso_notices['errors'] = false;
-    }
-
-
-
-    /**
-     *    has_errors
-     *
-     * @return int
-     */
-    public static function has_notices()
-    {
-        $has_notices = 0;
-        // check for success messages
-        $has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success']) ? 3
-            : $has_notices;
-        // check for attention messages
-        $has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention']) ? 2
-            : $has_notices;
-        // check for error messages
-        $has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors']) ? 1
-            : $has_notices;
-        return $has_notices;
-    }
-
-
-
-    /**
-     * This simply returns non formatted error notices as they were sent into the EE_Error object.
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    public static function get_vanilla_notices()
-    {
-        return array(
-            'success'   => isset(self::$_espresso_notices['success']) ? self::$_espresso_notices['success'] : array(),
-            'attention' => isset(self::$_espresso_notices['attention']) ? self::$_espresso_notices['attention']
-                : array(),
-            'errors'    => isset(self::$_espresso_notices['errors']) ? self::$_espresso_notices['errors'] : array(),
-        );
-    }
-
-
-
-    /**
-     *    compile all error or success messages into one string
-     *
-     * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
-     * @param        boolean $format_output     whether or not to format the messages for display in the WP admin
-     * @param        boolean $save_to_transient whether or not to save notices to the db for retrieval on next request
-     *                                          - ONLY do this just before redirecting
-     * @param        boolean $remove_empty      whether or not to unset empty messages
-     * @return        array
-     */
-    public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $success_messages = '';
-        $attention_messages = '';
-        $error_messages = '';
-        $print_scripts = false;
-        // either save notices to the db
-        if ($save_to_transient) {
-            update_option('ee_notices', self::$_espresso_notices);
-            return array();
-        }
-        // grab any notices that have been previously saved
-        if ($notices = get_option('ee_notices', false)) {
-            foreach ($notices as $type => $notice) {
-                if (is_array($notice) && ! empty($notice)) {
-                    // make sure that existing notice type is an array
-                    self::$_espresso_notices[$type] = is_array(self::$_espresso_notices[$type])
-                                                      && ! empty(self::$_espresso_notices[$type])
-                        ? self::$_espresso_notices[$type] : array();
-                    // merge stored notices with any newly created ones
-                    self::$_espresso_notices[$type] = array_merge(self::$_espresso_notices[$type], $notice);
-                    $print_scripts = true;
-                }
-            }
-            // now clear any stored notices
-            update_option('ee_notices', false);
-        }
-        // check for success messages
-        if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
-            // combine messages
-            $success_messages .= implode(self::$_espresso_notices['success'], '<br /><br />');
-            $print_scripts = true;
-        }
-        // check for attention messages
-        if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
-            // combine messages
-            $attention_messages .= implode(self::$_espresso_notices['attention'], '<br /><br />');
-            $print_scripts = true;
-        }
-        // check for error messages
-        if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
-            $error_messages .= count(self::$_espresso_notices['errors']) > 1
-                ? __('The following errors have occurred:<br />', 'event_espresso')
-                : __('An error has occurred:<br />', 'event_espresso');
-            // combine messages
-            $error_messages .= implode(self::$_espresso_notices['errors'], '<br /><br />');
-            $print_scripts = true;
-        }
-        if ($format_output) {
-            $notices = '<div id="espresso-notices">';
-            $close = is_admin() ? ''
-                : '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"></span></a>';
-            if ($success_messages !== '') {
-                $css_id = is_admin() ? 'message' : 'espresso-notices-success';
-                $css_class = is_admin() ? 'updated fade' : 'success fade-away';
-                //showMessage( $success_messages );
-                $notices .= '<div id="'
-                            . $css_id
-                            . '" class="espresso-notices '
-                            . $css_class
-                            . '" style="display:none;"><p>'
-                            . $success_messages
-                            . '</p>'
-                            . $close
-                            . '</div>';
-            }
-            if ($attention_messages !== '') {
-                $css_id = is_admin() ? 'message' : 'espresso-notices-attention';
-                $css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
-                //showMessage( $error_messages, TRUE );
-                $notices .= '<div id="'
-                            . $css_id
-                            . '" class="espresso-notices '
-                            . $css_class
-                            . '" style="display:none;"><p>'
-                            . $attention_messages
-                            . '</p>'
-                            . $close
-                            . '</div>';
-            }
-            if ($error_messages !== '') {
-                $css_id = is_admin() ? 'message' : 'espresso-notices-error';
-                $css_class = is_admin() ? 'error' : 'error fade-away';
-                //showMessage( $error_messages, TRUE );
-                $notices .= '<div id="'
-                            . $css_id
-                            . '" class="espresso-notices '
-                            . $css_class
-                            . '" style="display:none;"><p>'
-                            . $error_messages
-                            . '</p>'
-                            . $close
-                            . '</div>';
-            }
-            $notices .= '</div>';
-        } else {
-            $notices = array(
-                'success'   => $success_messages,
-                'attention' => $attention_messages,
-                'errors'    => $error_messages,
-            );
-            if ($remove_empty) {
-                // remove empty notices
-                foreach ($notices as $type => $notice) {
-                    if (empty($notice)) {
-                        unset($notices[$type]);
-                    }
-                }
-            }
-        }
-        if ($print_scripts) {
-            self::_print_scripts();
-        }
-        return $notices;
-    }
-
-
-
-    /**
-     *    add_persistent_admin_notice
-     *
-     * @param        string $pan_name     the name, or key of the Persistent Admin Notice to be stored
-     * @param        string $pan_message  the message to be stored persistently until dismissed
-     * @param bool          $force_update allows one to enforce the reappearance of a persistent message.
-     * @return        void
-     */
-    public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false)
-    {
-        if (! empty($pan_name) && ! empty($pan_message)) {
-            $persistent_admin_notices = get_option('ee_pers_admin_notices', array());
-            //maybe initialize persistent_admin_notices
-            if (empty($persistent_admin_notices)) {
-                add_option('ee_pers_admin_notices', array(), '', 'no');
-            }
-            $pan_name = sanitize_key($pan_name);
-            if (! array_key_exists($pan_name, $persistent_admin_notices) || $force_update) {
-                $persistent_admin_notices[$pan_name] = $pan_message;
-                update_option('ee_pers_admin_notices', $persistent_admin_notices);
-            }
-        }
-    }
-
-
-
-    /**
-     *    dismiss_persistent_admin_notice
-     *
-     * @param        string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
-     * @param bool          $purge
-     * @param bool          $return_immediately
-     * @return        void
-     */
-    public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return_immediately = false)
-    {
-        $pan_name = EE_Registry::instance()->REQ->is_set('ee_nag_notice')
-            ? EE_Registry::instance()->REQ->get('ee_nag_notice') : $pan_name;
-        if (! empty($pan_name)) {
-            $persistent_admin_notices = get_option('ee_pers_admin_notices', array());
-            // check if notice we wish to dismiss is actually in the $persistent_admin_notices array
-            if (is_array($persistent_admin_notices) && isset($persistent_admin_notices[$pan_name])) {
-                // completely delete nag notice, or just NULL message so that it can NOT be added again ?
-                if ($purge) {
-                    unset($persistent_admin_notices[$pan_name]);
-                } else {
-                    $persistent_admin_notices[$pan_name] = null;
-                }
-                if (update_option('ee_pers_admin_notices', $persistent_admin_notices) === false) {
-                    EE_Error::add_error(sprintf(__('The persistent admin notice for "%s" could not be deleted.',
-                        'event_espresso'), $pan_name), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-        }
-        if ($return_immediately) {
-            return;
-        }
-        if (EE_Registry::instance()->REQ->ajax) {
-            // grab any notices and concatenate into string
-            echo wp_json_encode(array('errors' => implode('<br />', EE_Error::get_notices(false))));
-            exit();
-        }
-        // save errors to a transient to be displayed on next request (after redirect)
-        EE_Error::get_notices(false, true);
-        $return_url = EE_Registry::instance()->REQ->is_set('return_url')
-            ? EE_Registry::instance()->REQ->get('return_url') : '';
-        wp_safe_redirect(urldecode($return_url));
-    }
-
-
-
-    /**
-     * display_persistent_admin_notices
-     *
-     * @param  string $pan_name    the name, or key of the Persistent Admin Notice to be stored
-     * @param  string $pan_message the message to be stored persistently until dismissed
-     * @param  string $return_url  URL to go back to after nag notice is dismissed
-     * @return string
-     */
-    public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '')
-    {
-        if (! empty($pan_name) && ! empty($pan_message)) {
-            $args = array(
-                'nag_notice'    => $pan_name,
-                'return_url'    => urlencode($return_url),
-                'ajax_url'      => WP_AJAX_URL,
-                'unknown_error' => __('An unknown error has occurred on the server while attempting to dismiss this notice.',
-                    'event_espresso'),
-            );
-            wp_localize_script('espresso_core', 'ee_dismiss', $args);
-            return '
+		$output .= self::_print_scripts(true);
+		if (defined('DOING_AJAX')) {
+			echo wp_json_encode(array('error' => $output));
+			exit();
+		}
+		echo $output;
+		die();
+	}
+
+
+
+	/**
+	 *    generate string from exception trace args
+	 *
+	 * @param array $arguments
+	 * @param bool  $array
+	 * @return string
+	 */
+	private function _convert_args_to_string($arguments = array(), $array = false)
+	{
+		$arg_string = '';
+		if (! empty($arguments)) {
+			$args = array();
+			foreach ($arguments as $arg) {
+				if (! empty($arg)) {
+					if (is_string($arg)) {
+						$args[] = " '" . $arg . "'";
+					} elseif (is_array($arg)) {
+						$args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
+					} elseif ($arg === null) {
+						$args[] = ' NULL';
+					} elseif (is_bool($arg)) {
+						$args[] = ($arg) ? ' TRUE' : ' FALSE';
+					} elseif (is_object($arg)) {
+						$args[] = ' OBJECT ' . get_class($arg);
+					} elseif (is_resource($arg)) {
+						$args[] = get_resource_type($arg);
+					} else {
+						$args[] = $arg;
+					}
+				}
+			}
+			$arg_string = implode(', ', $args);
+		}
+		if ($array) {
+			$arg_string .= ' )';
+		}
+		return $arg_string;
+	}
+
+
+
+	/**
+	 *    add error message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_error($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('errors', $msg, $file, $func, $line);
+		self::$_error_count++;
+	}
+
+
+
+	/**
+	 * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
+	 * adds an error
+	 *
+	 * @param string $msg
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @throws EE_Error
+	 */
+	public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null)
+	{
+		if (WP_DEBUG) {
+			throw new EE_Error($msg);
+		}
+		EE_Error::add_error($msg, $file, $func, $line);
+	}
+
+
+
+	/**
+	 *    add success message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_success($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('success', $msg, $file, $func, $line);
+	}
+
+
+
+	/**
+	 *    add attention message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_attention($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('attention', $msg, $file, $func, $line);
+	}
+
+
+
+	/**
+	 *    add success message
+	 *
+	 * @param        string $type whether the message is for a success or error notification
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	private static function _add_notice($type = 'success', $msg = null, $file = null, $func = null, $line = null)
+	{
+		if (empty($msg)) {
+			EE_Error::doing_it_wrong(
+				'EE_Error::add_' . $type . '()',
+				sprintf(
+					__('Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
+						'event_espresso'),
+					$type,
+					$file,
+					$line
+				),
+				EVENT_ESPRESSO_VERSION
+			);
+		}
+		if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
+			EE_Error::doing_it_wrong(
+				'EE_Error::add_error()',
+				__('You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
+					'event_espresso'),
+				EVENT_ESPRESSO_VERSION
+			);
+		}
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $msg);
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		/**
+		 * Do an action so other code can be triggered when a notice is created
+		 *
+		 * @param string $type     can be 'errors', 'attention', or 'success'
+		 * @param string $user_msg message displayed to user when WP_DEBUG is off
+		 * @param string $user_msg message displayed to user when WP_DEBUG is on
+		 * @param string $file     file where error was generated
+		 * @param string $func     function where error was generated
+		 * @param string $line     line where error was generated
+		 */
+		do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// add notice if message exists
+		if (! empty($msg)) {
+			// get error code
+			$notice_code = EE_Error::generate_error_code($file, $func, $line);
+			if (WP_DEBUG && $type === 'errors') {
+				$msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
+			}
+			// add notice. Index by code if it's not blank
+			if ($notice_code) {
+				self::$_espresso_notices[$type][$notice_code] = $msg;
+			} else {
+				self::$_espresso_notices[$type][] = $msg;
+			}
+			add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
+		}
+	}
+
+
+
+	/**
+	 *    in some case it may be necessary to overwrite the existing success messages
+	 *
+	 * @return        void
+	 */
+	public static function overwrite_success()
+	{
+		self::$_espresso_notices['success'] = false;
+	}
+
+
+
+	/**
+	 *    in some case it may be necessary to overwrite the existing attention messages
+	 *
+	 * @return        void
+	 */
+	public static function overwrite_attention()
+	{
+		self::$_espresso_notices['attention'] = false;
+	}
+
+
+
+	/**
+	 *    in some case it may be necessary to overwrite the existing error messages
+	 *
+	 * @return        void
+	 */
+	public static function overwrite_errors()
+	{
+		self::$_espresso_notices['errors'] = false;
+	}
+
+
+
+	/**
+	 *    reset_notices
+	 *
+	 * @return void
+	 */
+	public static function reset_notices()
+	{
+		self::$_espresso_notices['success'] = false;
+		self::$_espresso_notices['attention'] = false;
+		self::$_espresso_notices['errors'] = false;
+	}
+
+
+
+	/**
+	 *    has_errors
+	 *
+	 * @return int
+	 */
+	public static function has_notices()
+	{
+		$has_notices = 0;
+		// check for success messages
+		$has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success']) ? 3
+			: $has_notices;
+		// check for attention messages
+		$has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention']) ? 2
+			: $has_notices;
+		// check for error messages
+		$has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors']) ? 1
+			: $has_notices;
+		return $has_notices;
+	}
+
+
+
+	/**
+	 * This simply returns non formatted error notices as they were sent into the EE_Error object.
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	public static function get_vanilla_notices()
+	{
+		return array(
+			'success'   => isset(self::$_espresso_notices['success']) ? self::$_espresso_notices['success'] : array(),
+			'attention' => isset(self::$_espresso_notices['attention']) ? self::$_espresso_notices['attention']
+				: array(),
+			'errors'    => isset(self::$_espresso_notices['errors']) ? self::$_espresso_notices['errors'] : array(),
+		);
+	}
+
+
+
+	/**
+	 *    compile all error or success messages into one string
+	 *
+	 * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
+	 * @param        boolean $format_output     whether or not to format the messages for display in the WP admin
+	 * @param        boolean $save_to_transient whether or not to save notices to the db for retrieval on next request
+	 *                                          - ONLY do this just before redirecting
+	 * @param        boolean $remove_empty      whether or not to unset empty messages
+	 * @return        array
+	 */
+	public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$success_messages = '';
+		$attention_messages = '';
+		$error_messages = '';
+		$print_scripts = false;
+		// either save notices to the db
+		if ($save_to_transient) {
+			update_option('ee_notices', self::$_espresso_notices);
+			return array();
+		}
+		// grab any notices that have been previously saved
+		if ($notices = get_option('ee_notices', false)) {
+			foreach ($notices as $type => $notice) {
+				if (is_array($notice) && ! empty($notice)) {
+					// make sure that existing notice type is an array
+					self::$_espresso_notices[$type] = is_array(self::$_espresso_notices[$type])
+													  && ! empty(self::$_espresso_notices[$type])
+						? self::$_espresso_notices[$type] : array();
+					// merge stored notices with any newly created ones
+					self::$_espresso_notices[$type] = array_merge(self::$_espresso_notices[$type], $notice);
+					$print_scripts = true;
+				}
+			}
+			// now clear any stored notices
+			update_option('ee_notices', false);
+		}
+		// check for success messages
+		if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
+			// combine messages
+			$success_messages .= implode(self::$_espresso_notices['success'], '<br /><br />');
+			$print_scripts = true;
+		}
+		// check for attention messages
+		if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
+			// combine messages
+			$attention_messages .= implode(self::$_espresso_notices['attention'], '<br /><br />');
+			$print_scripts = true;
+		}
+		// check for error messages
+		if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
+			$error_messages .= count(self::$_espresso_notices['errors']) > 1
+				? __('The following errors have occurred:<br />', 'event_espresso')
+				: __('An error has occurred:<br />', 'event_espresso');
+			// combine messages
+			$error_messages .= implode(self::$_espresso_notices['errors'], '<br /><br />');
+			$print_scripts = true;
+		}
+		if ($format_output) {
+			$notices = '<div id="espresso-notices">';
+			$close = is_admin() ? ''
+				: '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"></span></a>';
+			if ($success_messages !== '') {
+				$css_id = is_admin() ? 'message' : 'espresso-notices-success';
+				$css_class = is_admin() ? 'updated fade' : 'success fade-away';
+				//showMessage( $success_messages );
+				$notices .= '<div id="'
+							. $css_id
+							. '" class="espresso-notices '
+							. $css_class
+							. '" style="display:none;"><p>'
+							. $success_messages
+							. '</p>'
+							. $close
+							. '</div>';
+			}
+			if ($attention_messages !== '') {
+				$css_id = is_admin() ? 'message' : 'espresso-notices-attention';
+				$css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
+				//showMessage( $error_messages, TRUE );
+				$notices .= '<div id="'
+							. $css_id
+							. '" class="espresso-notices '
+							. $css_class
+							. '" style="display:none;"><p>'
+							. $attention_messages
+							. '</p>'
+							. $close
+							. '</div>';
+			}
+			if ($error_messages !== '') {
+				$css_id = is_admin() ? 'message' : 'espresso-notices-error';
+				$css_class = is_admin() ? 'error' : 'error fade-away';
+				//showMessage( $error_messages, TRUE );
+				$notices .= '<div id="'
+							. $css_id
+							. '" class="espresso-notices '
+							. $css_class
+							. '" style="display:none;"><p>'
+							. $error_messages
+							. '</p>'
+							. $close
+							. '</div>';
+			}
+			$notices .= '</div>';
+		} else {
+			$notices = array(
+				'success'   => $success_messages,
+				'attention' => $attention_messages,
+				'errors'    => $error_messages,
+			);
+			if ($remove_empty) {
+				// remove empty notices
+				foreach ($notices as $type => $notice) {
+					if (empty($notice)) {
+						unset($notices[$type]);
+					}
+				}
+			}
+		}
+		if ($print_scripts) {
+			self::_print_scripts();
+		}
+		return $notices;
+	}
+
+
+
+	/**
+	 *    add_persistent_admin_notice
+	 *
+	 * @param        string $pan_name     the name, or key of the Persistent Admin Notice to be stored
+	 * @param        string $pan_message  the message to be stored persistently until dismissed
+	 * @param bool          $force_update allows one to enforce the reappearance of a persistent message.
+	 * @return        void
+	 */
+	public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false)
+	{
+		if (! empty($pan_name) && ! empty($pan_message)) {
+			$persistent_admin_notices = get_option('ee_pers_admin_notices', array());
+			//maybe initialize persistent_admin_notices
+			if (empty($persistent_admin_notices)) {
+				add_option('ee_pers_admin_notices', array(), '', 'no');
+			}
+			$pan_name = sanitize_key($pan_name);
+			if (! array_key_exists($pan_name, $persistent_admin_notices) || $force_update) {
+				$persistent_admin_notices[$pan_name] = $pan_message;
+				update_option('ee_pers_admin_notices', $persistent_admin_notices);
+			}
+		}
+	}
+
+
+
+	/**
+	 *    dismiss_persistent_admin_notice
+	 *
+	 * @param        string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
+	 * @param bool          $purge
+	 * @param bool          $return_immediately
+	 * @return        void
+	 */
+	public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return_immediately = false)
+	{
+		$pan_name = EE_Registry::instance()->REQ->is_set('ee_nag_notice')
+			? EE_Registry::instance()->REQ->get('ee_nag_notice') : $pan_name;
+		if (! empty($pan_name)) {
+			$persistent_admin_notices = get_option('ee_pers_admin_notices', array());
+			// check if notice we wish to dismiss is actually in the $persistent_admin_notices array
+			if (is_array($persistent_admin_notices) && isset($persistent_admin_notices[$pan_name])) {
+				// completely delete nag notice, or just NULL message so that it can NOT be added again ?
+				if ($purge) {
+					unset($persistent_admin_notices[$pan_name]);
+				} else {
+					$persistent_admin_notices[$pan_name] = null;
+				}
+				if (update_option('ee_pers_admin_notices', $persistent_admin_notices) === false) {
+					EE_Error::add_error(sprintf(__('The persistent admin notice for "%s" could not be deleted.',
+						'event_espresso'), $pan_name), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+		}
+		if ($return_immediately) {
+			return;
+		}
+		if (EE_Registry::instance()->REQ->ajax) {
+			// grab any notices and concatenate into string
+			echo wp_json_encode(array('errors' => implode('<br />', EE_Error::get_notices(false))));
+			exit();
+		}
+		// save errors to a transient to be displayed on next request (after redirect)
+		EE_Error::get_notices(false, true);
+		$return_url = EE_Registry::instance()->REQ->is_set('return_url')
+			? EE_Registry::instance()->REQ->get('return_url') : '';
+		wp_safe_redirect(urldecode($return_url));
+	}
+
+
+
+	/**
+	 * display_persistent_admin_notices
+	 *
+	 * @param  string $pan_name    the name, or key of the Persistent Admin Notice to be stored
+	 * @param  string $pan_message the message to be stored persistently until dismissed
+	 * @param  string $return_url  URL to go back to after nag notice is dismissed
+	 * @return string
+	 */
+	public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '')
+	{
+		if (! empty($pan_name) && ! empty($pan_message)) {
+			$args = array(
+				'nag_notice'    => $pan_name,
+				'return_url'    => urlencode($return_url),
+				'ajax_url'      => WP_AJAX_URL,
+				'unknown_error' => __('An unknown error has occurred on the server while attempting to dismiss this notice.',
+					'event_espresso'),
+			);
+			wp_localize_script('espresso_core', 'ee_dismiss', $args);
+			return '
 			<div id="'
-                   . $pan_name
-                   . '" class="espresso-notices updated ee-nag-notice clearfix" style="border-left: 4px solid #fcb93c;">
+				   . $pan_name
+				   . '" class="espresso-notices updated ee-nag-notice clearfix" style="border-left: 4px solid #fcb93c;">
 				<p>'
-                   . $pan_message
-                   . '</p>
+				   . $pan_message
+				   . '</p>
 				<a class="dismiss-ee-nag-notice hide-if-no-js" style="float: right; cursor: pointer; text-decoration:none;" rel="'
-                   . $pan_name
-                   . '">
+				   . $pan_name
+				   . '">
 					<span class="dashicons dashicons-dismiss" style="position:relative; top:-1px; margin-right:.25em;"></span>'
-                   . __('Dismiss', 'event_espresso')
-                   . '
+				   . __('Dismiss', 'event_espresso')
+				   . '
 				</a>
 				<div style="clear:both;"></div>
 			</div>';
-        }
-        return '';
-    }
-
-
-
-    /**
-     *    get_persistent_admin_notices
-     *
-     * @param string $return_url
-     * @return string
-     */
-    public static function get_persistent_admin_notices($return_url = '')
-    {
-        $notices = '';
-        // check for persistent admin notices
-        //filter the list though so plugins can notify the admin in a different way if they want
-        $persistent_admin_notices = apply_filters(
-            'FHEE__EE_Error__get_persistent_admin_notices',
-            get_option('ee_pers_admin_notices', false),
-            'ee_pers_admin_notices',
-            $return_url
-        );
-        if ($persistent_admin_notices) {
-            // load scripts
-            wp_register_script(
-                'espresso_core',
-                EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-                array('jquery'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_register_script(
-                'ee_error_js',
-                EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
-                array('espresso_core'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_script('ee_error_js');
-            // and display notices
-            foreach ($persistent_admin_notices as $pan_name => $pan_message) {
-                $notices .= self::display_persistent_admin_notices($pan_name, $pan_message, $return_url);
-            }
-        }
-        return $notices;
-    }
-
-
-
-    /**
-     * _print_scripts
-     *
-     * @param    bool $force_print
-     * @return    string
-     */
-    private static function _print_scripts($force_print = false)
-    {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
-            if (wp_script_is('ee_error_js', 'enqueued')) {
-                return '';
-            }
-            if (wp_script_is('ee_error_js', 'registered')) {
-                wp_enqueue_style('espresso_default');
-                wp_enqueue_style('espresso_custom_css');
-                wp_enqueue_script('ee_error_js');
-                wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
-            }
-        } else {
-            return '
+		}
+		return '';
+	}
+
+
+
+	/**
+	 *    get_persistent_admin_notices
+	 *
+	 * @param string $return_url
+	 * @return string
+	 */
+	public static function get_persistent_admin_notices($return_url = '')
+	{
+		$notices = '';
+		// check for persistent admin notices
+		//filter the list though so plugins can notify the admin in a different way if they want
+		$persistent_admin_notices = apply_filters(
+			'FHEE__EE_Error__get_persistent_admin_notices',
+			get_option('ee_pers_admin_notices', false),
+			'ee_pers_admin_notices',
+			$return_url
+		);
+		if ($persistent_admin_notices) {
+			// load scripts
+			wp_register_script(
+				'espresso_core',
+				EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+				array('jquery'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_register_script(
+				'ee_error_js',
+				EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+				array('espresso_core'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_script('ee_error_js');
+			// and display notices
+			foreach ($persistent_admin_notices as $pan_name => $pan_message) {
+				$notices .= self::display_persistent_admin_notices($pan_name, $pan_message, $return_url);
+			}
+		}
+		return $notices;
+	}
+
+
+
+	/**
+	 * _print_scripts
+	 *
+	 * @param    bool $force_print
+	 * @return    string
+	 */
+	private static function _print_scripts($force_print = false)
+	{
+		if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+			if (wp_script_is('ee_error_js', 'enqueued')) {
+				return '';
+			}
+			if (wp_script_is('ee_error_js', 'registered')) {
+				wp_enqueue_style('espresso_default');
+				wp_enqueue_style('espresso_custom_css');
+				wp_enqueue_script('ee_error_js');
+				wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
+			}
+		} else {
+			return '
 <script>
 /* <![CDATA[ */
 var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
@@ -1064,143 +1064,143 @@ 
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 ';
-        }
-        return '';
-    }
-
-
-
-    /**
-     *    enqueue_error_scripts
-     *
-     * @return        void
-     */
-    public static function enqueue_error_scripts()
-    {
-        self::_print_scripts();
-    }
-
-
-
-    /**
-     *    create error code from filepath, function name,
-     *    and line number where exception or error was thrown
-     *
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @return string
-     */
-    public static function generate_error_code($file = '', $func = '', $line = '')
-    {
-        $file = explode('.', basename($file));
-        $error_code = ! empty($file[0]) ? $file[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
-        return $error_code;
-    }
-
-
-
-    /**
-     *    write exception details to log file
-     *
-     * @param int   $time
-     * @param array $ex
-     * @param bool  $clear
-     * @return void
-     */
-    public function write_to_error_log($time = 0, $ex = array(), $clear = false)
-    {
-        if (empty($ex)) {
-            return;
-        }
-        if (! $time) {
-            $time = time();
-        }
-        $exception_log = '----------------------------------------------------------------------------------------'
-                         . PHP_EOL;
-        $exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
-        $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
-        $exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
-        $exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
-        $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
-        $exception_log .= 'Stack trace: ' . PHP_EOL;
-        $exception_log .= $ex['string'] . PHP_EOL;
-        $exception_log .= '----------------------------------------------------------------------------------------'
-                          . PHP_EOL;
-        try {
-            EEH_File::ensure_file_exists_and_is_writable(
-                EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file
-            );
-            EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs');
-            if (! $clear) {
-                //get existing log file and append new log info
-                $exception_log = EEH_File::get_file_contents(
-                    EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file
-                ) . $exception_log;
-            }
-            EEH_File::write_to_file(
-                EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file,
-                $exception_log
-            );
-        } catch (EE_Error $e) {
-            EE_Error::add_error(sprintf(__('Event Espresso error logging could not be setup because: %s',
-                'event_espresso'), $e->getMessage()));
-            return;
-        }
-    }
-
-
-
-    /**
-     * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
-     * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
-     * but the code execution is done in a manner that could lead to unexpected results
-     * (i.e. running to early, or too late in WP or EE loading process).
-     * A good test for knowing whether to use this method is:
-     * 1. Is there going to be a PHP error if something isn't setup/used correctly?
-     * Yes -> use EE_Error::add_error() or throw new EE_Error()
-     * 2. If this is loaded before something else, it won't break anything,
-     * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
-     *
-     * @uses   constant WP_DEBUG test if wp_debug is on or not
-     * @param string $function      The function that was called
-     * @param string $message       A message explaining what has been done incorrectly
-     * @param string $version       The version of Event Espresso where the error was added
-     * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
-     *                              for a deprecated function. This allows deprecation to occur during one version,
-     *                              but not have any notices appear until a later version. This allows developers
-     *                              extra time to update their code before notices appear.
-     * @param int    $error_type
-     */
-    public static function doing_it_wrong(
-        $function,
-        $message,
-        $version,
-        $applies_when = '',
-        $error_type = null
-    ) {
-        if (defined('WP_DEBUG') && WP_DEBUG) {
-            EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
-        }
-    }
-
-
-
-    /**
-     * Like get_notices, but returns an array of all the notices of the given type.
-     *
-     * @return array {
-     * @type array $success   all the success messages
-     * @type array $errors    all the error messages
-     * @type array $attention all the attention messages
-     * }
-     */
-    public static function get_raw_notices()
-    {
-        return self::$_espresso_notices;
-    }
+		}
+		return '';
+	}
+
+
+
+	/**
+	 *    enqueue_error_scripts
+	 *
+	 * @return        void
+	 */
+	public static function enqueue_error_scripts()
+	{
+		self::_print_scripts();
+	}
+
+
+
+	/**
+	 *    create error code from filepath, function name,
+	 *    and line number where exception or error was thrown
+	 *
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @return string
+	 */
+	public static function generate_error_code($file = '', $func = '', $line = '')
+	{
+		$file = explode('.', basename($file));
+		$error_code = ! empty($file[0]) ? $file[0] : '';
+		$error_code .= ! empty($func) ? ' - ' . $func : '';
+		$error_code .= ! empty($line) ? ' - ' . $line : '';
+		return $error_code;
+	}
+
+
+
+	/**
+	 *    write exception details to log file
+	 *
+	 * @param int   $time
+	 * @param array $ex
+	 * @param bool  $clear
+	 * @return void
+	 */
+	public function write_to_error_log($time = 0, $ex = array(), $clear = false)
+	{
+		if (empty($ex)) {
+			return;
+		}
+		if (! $time) {
+			$time = time();
+		}
+		$exception_log = '----------------------------------------------------------------------------------------'
+						 . PHP_EOL;
+		$exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
+		$exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
+		$exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
+		$exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
+		$exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
+		$exception_log .= 'Stack trace: ' . PHP_EOL;
+		$exception_log .= $ex['string'] . PHP_EOL;
+		$exception_log .= '----------------------------------------------------------------------------------------'
+						  . PHP_EOL;
+		try {
+			EEH_File::ensure_file_exists_and_is_writable(
+				EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file
+			);
+			EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs');
+			if (! $clear) {
+				//get existing log file and append new log info
+				$exception_log = EEH_File::get_file_contents(
+					EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file
+				) . $exception_log;
+			}
+			EEH_File::write_to_file(
+				EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file,
+				$exception_log
+			);
+		} catch (EE_Error $e) {
+			EE_Error::add_error(sprintf(__('Event Espresso error logging could not be setup because: %s',
+				'event_espresso'), $e->getMessage()));
+			return;
+		}
+	}
+
+
+
+	/**
+	 * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
+	 * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
+	 * but the code execution is done in a manner that could lead to unexpected results
+	 * (i.e. running to early, or too late in WP or EE loading process).
+	 * A good test for knowing whether to use this method is:
+	 * 1. Is there going to be a PHP error if something isn't setup/used correctly?
+	 * Yes -> use EE_Error::add_error() or throw new EE_Error()
+	 * 2. If this is loaded before something else, it won't break anything,
+	 * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
+	 *
+	 * @uses   constant WP_DEBUG test if wp_debug is on or not
+	 * @param string $function      The function that was called
+	 * @param string $message       A message explaining what has been done incorrectly
+	 * @param string $version       The version of Event Espresso where the error was added
+	 * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
+	 *                              for a deprecated function. This allows deprecation to occur during one version,
+	 *                              but not have any notices appear until a later version. This allows developers
+	 *                              extra time to update their code before notices appear.
+	 * @param int    $error_type
+	 */
+	public static function doing_it_wrong(
+		$function,
+		$message,
+		$version,
+		$applies_when = '',
+		$error_type = null
+	) {
+		if (defined('WP_DEBUG') && WP_DEBUG) {
+			EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
+		}
+	}
+
+
+
+	/**
+	 * Like get_notices, but returns an array of all the notices of the given type.
+	 *
+	 * @return array {
+	 * @type array $success   all the success messages
+	 * @type array $errors    all the error messages
+	 * @type array $attention all the attention messages
+	 * }
+	 */
+	public static function get_raw_notices()
+	{
+		return self::$_espresso_notices;
+	}
 
 
 
@@ -1216,27 +1216,27 @@ 
  */
 function espresso_error_enqueue_scripts()
 {
-    // js for error handling
-    wp_register_script(
-        'espresso_core',
-        EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-        array('jquery'),
-        EVENT_ESPRESSO_VERSION,
-        false
-    );
-    wp_register_script(
-        'ee_error_js',
-        EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
-        array('espresso_core'),
-        EVENT_ESPRESSO_VERSION,
-        false
-    );
+	// js for error handling
+	wp_register_script(
+		'espresso_core',
+		EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+		array('jquery'),
+		EVENT_ESPRESSO_VERSION,
+		false
+	);
+	wp_register_script(
+		'ee_error_js',
+		EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+		array('espresso_core'),
+		EVENT_ESPRESSO_VERSION,
+		false
+	);
 }
 
 if (is_admin()) {
-    add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
+	add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
 } else {
-    add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
+	add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
 }