eventespresso / event-espresso-core

acceptance_tests/Helpers/EventsAdmin.php

Indentation +129 added lines, -129 removed lines

@@ -14,133 +14,133 @@
 trait EventsAdmin
 {
 
-    /**
-     * @param string $additional_params
-     */
-    public function amOnDefaultEventsListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params));
-    }
-
-
-    /**
-     * Triggers the publishing of the Event.
-     */
-    public function publishEvent()
-    {
-        $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
-        $this->actor()->wait(3);
-        $this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR);
-        $this->actor()->waitForText('Event published.', 30);
-    }
-
-
-    /**
-     * Triggers saving the Event.
-     */
-    public function saveEvent()
-    {
-        $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
-        $this->actor()->wait(2);
-        $this->actor()->click(EventsPage::EVENT_EDITOR_SAVE_BUTTON_SELECTOR);
-    }
-
-
-    /**
-     * Navigates the actor to the event list table page and will attempt to edit the event for the given title.
-     * First this will search using the given title and then attempt to edit from the results of the search.
-     *
-     * Assumes actor is already logged in.
-     * @param $event_title
-     */
-    public function amEditingTheEventWithTitle($event_title)
-    {
-        $this->amOnDefaultEventsListTablePage();
-        $this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title);
-        $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR);
-        $this->actor()->waitForText($event_title, 15);
-        $this->actor()->click(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
-    }
-
-
-    /**
-     * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View"
-     * link for the event in the event list table.
-     * Assumes the actor is already logged in and on the Event list table page.
-     *
-     * @param string $event_title
-     */
-    public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title)
-    {
-        $this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
-        $this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title));
-    }
-
-
-    /**
-     * Used to retrieve the event id for the event via the list table and for the given event.
-     * @param string $event_title
-     */
-    public function observeEventIdInListTableForEvent($event_title)
-    {
-        return $this->actor()->observeValueFromInputAt(EventsPage::eventListTableEventIdSelectorForTitle($event_title));
-    }
-
-
-    /**
-     * This performs the click action on the gear icon that triggers the advanced settings view state.
-     * Assumes the actor is already logged in and editing an event.
-     *
-     * @param int $row_number  What ticket row to toggle open/close.
-     */
-    public function toggleAdvancedSettingsViewForTicketRow($row_number = 1)
-    {
-        $this->actor()->click(EventsPage::eventEditorTicketAdvancedDetailsSelector($row_number));
-    }
-
-
-    /**
-     * Toggles the TKT_is_taxable checkbox for the ticket in the given row.
-     * Assumes the actor is already logged in and editing an event and that the advanced settings view state for that
-     * ticket is "open".
-     *
-     * @param int $row_number  What ticket row to toggle the checkbox for.
-     */
-    public function toggleTicketIsTaxableForTicketRow($row_number = 1)
-    {
-        $this->actor()->click(EventsPage::eventEditorTicketTaxableCheckboxSelector($row_number));
-    }
-
-
-    /**
-     * Use to change the default registration status for the event.
-     * Assumes the view is already on the event editor.
-     * @param $registration_status
-     */
-    public function changeDefaultRegistrationStatusTo($registration_status)
-    {
-        $this->actor()->selectOption(
-            EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR,
-            $registration_status
-        );
-    }
-
-
-    /**
-     * Use this from the context of the event editor to select the given custom template for a given message type and
-     * messenger.
-     *
-     * @param string $message_type_label  The visible label for the message type (eg Registration Approved)
-     * @param string $messenger_slug      The slug for the messenger (eg 'email')
-     * @param string $custom_template_label The visible label in the select input for the custom template you want
-     *                                      selected.
-     */
-    public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label)
-    {
-        $this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug));
-        $this->actor()->selectOption(
-            EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label),
-            $custom_template_label
-        );
-    }
+	/**
+	 * @param string $additional_params
+	 */
+	public function amOnDefaultEventsListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params));
+	}
+
+
+	/**
+	 * Triggers the publishing of the Event.
+	 */
+	public function publishEvent()
+	{
+		$this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
+		$this->actor()->wait(3);
+		$this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR);
+		$this->actor()->waitForText('Event published.', 30);
+	}
+
+
+	/**
+	 * Triggers saving the Event.
+	 */
+	public function saveEvent()
+	{
+		$this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
+		$this->actor()->wait(2);
+		$this->actor()->click(EventsPage::EVENT_EDITOR_SAVE_BUTTON_SELECTOR);
+	}
+
+
+	/**
+	 * Navigates the actor to the event list table page and will attempt to edit the event for the given title.
+	 * First this will search using the given title and then attempt to edit from the results of the search.
+	 *
+	 * Assumes actor is already logged in.
+	 * @param $event_title
+	 */
+	public function amEditingTheEventWithTitle($event_title)
+	{
+		$this->amOnDefaultEventsListTablePage();
+		$this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title);
+		$this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR);
+		$this->actor()->waitForText($event_title, 15);
+		$this->actor()->click(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
+	}
+
+
+	/**
+	 * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View"
+	 * link for the event in the event list table.
+	 * Assumes the actor is already logged in and on the Event list table page.
+	 *
+	 * @param string $event_title
+	 */
+	public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title)
+	{
+		$this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
+		$this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title));
+	}
+
+
+	/**
+	 * Used to retrieve the event id for the event via the list table and for the given event.
+	 * @param string $event_title
+	 */
+	public function observeEventIdInListTableForEvent($event_title)
+	{
+		return $this->actor()->observeValueFromInputAt(EventsPage::eventListTableEventIdSelectorForTitle($event_title));
+	}
+
+
+	/**
+	 * This performs the click action on the gear icon that triggers the advanced settings view state.
+	 * Assumes the actor is already logged in and editing an event.
+	 *
+	 * @param int $row_number  What ticket row to toggle open/close.
+	 */
+	public function toggleAdvancedSettingsViewForTicketRow($row_number = 1)
+	{
+		$this->actor()->click(EventsPage::eventEditorTicketAdvancedDetailsSelector($row_number));
+	}
+
+
+	/**
+	 * Toggles the TKT_is_taxable checkbox for the ticket in the given row.
+	 * Assumes the actor is already logged in and editing an event and that the advanced settings view state for that
+	 * ticket is "open".
+	 *
+	 * @param int $row_number  What ticket row to toggle the checkbox for.
+	 */
+	public function toggleTicketIsTaxableForTicketRow($row_number = 1)
+	{
+		$this->actor()->click(EventsPage::eventEditorTicketTaxableCheckboxSelector($row_number));
+	}
+
+
+	/**
+	 * Use to change the default registration status for the event.
+	 * Assumes the view is already on the event editor.
+	 * @param $registration_status
+	 */
+	public function changeDefaultRegistrationStatusTo($registration_status)
+	{
+		$this->actor()->selectOption(
+			EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR,
+			$registration_status
+		);
+	}
+
+
+	/**
+	 * Use this from the context of the event editor to select the given custom template for a given message type and
+	 * messenger.
+	 *
+	 * @param string $message_type_label  The visible label for the message type (eg Registration Approved)
+	 * @param string $messenger_slug      The slug for the messenger (eg 'email')
+	 * @param string $custom_template_label The visible label in the select input for the custom template you want
+	 *                                      selected.
+	 */
+	public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label)
+	{
+		$this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug));
+		$this->actor()->selectOption(
+			EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label),
+			$custom_template_label
+		);
+	}
 }
\ No newline at end of file

acceptance_tests/Helpers/MessagesAdmin.php

Indentation +289 added lines, -289 removed lines

@@ -10,293 +10,293 @@
  */
 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 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));
-    }
-
-
-    /**
-     * 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
-        );
-    }
-
-
-    /**
-     * 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,
-            0
-        ));
-        $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
-            )
-        );
-    }
-
-
-    /**
-     * This will create a custom message template for the given messenger and message type from the context of the
-     * default (global) message template list table.
-     * Also takes care of verifying the template was created.
-     * @param string $message_type_label
-     * @param string $messenger_label
-     */
-    public function createCustomMessageTemplateFromDefaultFor($message_type_label, $messenger_label)
-    {
-        $this->amOnDefaultMessageTemplateListTablePage();
-        $this->actor()->click(
-            MessagesPage::createCustomButtonForMessageTypeAndMessenger(
-                $message_type_label,
-                $messenger_label
-            )
-        );
-        $this->actor()->seeInField('#title', 'New Custom Template');
-    }
-
-
-    /**
-     * This switches the context of the current messages template to the given reference.
-     * @param string $context_reference  This should be the visible label for the option.
-     */
-    public function switchContextTo($context_reference)
-    {
-        $this->actor()->selectOption(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR, $context_reference);
-        $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR);
-        $this->actor()->waitForText($context_reference, 10, 'h1');
-    }
-
-
-    /**
-     * Toggles Context so its turned off or on (depending on where it started) and verifies the expected state after
-     * toggling.
-     *
-     * @param string $context_string           What context is being switched (used for the expected state text)
-     * @param bool   $expected_state_is_active Used to indicate whether the expected state is active (true) or inactive
-     *                                         (false)
-     */
-    public function toggleContextState($context_string, $expected_state_is_active = true)
-    {
-        $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE);
-        if ($expected_state_is_active) {
-            $this->actor()->waitForText("The template for $context_string is currently active.");
-        } else {
-            $this->actor()->waitForText("The template for $context_string is currently inactive");
-        }
-    }
-
-
-    /**
-     * Triggers saving the message template.
-     * @param bool $and_close   Use to indicate to click the Save and Close button.
-     */
-    public function saveMessageTemplate($and_close = false)
-    {
-        $this->actor()->scrollTo(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR);
-        if ($and_close) {
-            $this->actor()->click('Save and Close');
-        } else {
-            $this->actor()->click('Save');
-        }
-        $this->actor()->waitForText('successfully updated');
-    }
-
-
-    /**
-     * This takes care of clicking the View Message icon for the given parameters.
-     * Assumes you are already viewing the messages activity list table.
-     * @param        $message_type_label
-     * @param        $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     */
-    public function viewMessageInMessagesListTableFor(
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $this->actor()->click(MessagesPage::messagesActivityListTableViewButtonSelectorFor(
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $number_in_set
-        ));
-    }
-
-
-    /**
-     * Takes care of deleting a message matching the given parameters via the message activity list table.
-     * Assumes you are already viewing the messages activity list table.
-     * @param        $message_type_label
-     * @param        $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     */
-    public function deleteMessageInMessagesListTableFor(
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $delete_action_selector = MessagesPage::messagesActivityListTableDeleteActionSelectorFor(
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $number_in_set
-        );
-        $cell_selector = MessagesPage::messagesActivityListTableCellSelectorFor(
-            'to',
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            '',
-            $number_in_set
-        );
-        $this->actor()->scrollTo($cell_selector, 0, -30);
-        $this->actor()->moveMouseOver(
-            $cell_selector,
-            5,
-            5
-        );
-        $this->actor()->waitForElementVisible(
-            $delete_action_selector
-        );
-        $this->actor()->click(
-            $delete_action_selector
-        );
-        $this->actor()->waitForText('successfully deleted', 20);
-    }
-
-
-    /**
-     * Assuming you have already triggered the view modal for a single message from the context of the message activity
-     * list table, this will take care of validating the given text is in that window.
-     * @param string $text_to_view
-     */
-    public function seeTextInViewMessageModal($text_to_view, $should_not_see = false)
-    {
-        $this->actor()->wait(2);
-        $this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
-        $this->actor()->switchToIframe('message-view-window');
-        $should_not_see ? $this->actor()->dontSee($text_to_view) : $this->actor()->see($text_to_view);
-        $this->actor()->switchToIframe();
-    }
-
-
-    /**
-     * This returns the value for the link at the given selector in the message modal.
-     * @param string $selector (any selector string accepted by WebDriver)
-     */
-    public function observeLinkAtSelectorInMessageModal($selector)
-    {
-        $this->actor()->wait(2);
-        $this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
-        $this->actor()->switchToIframe('message-view-window');
-        $link = $this->actor()->observeLinkUrlAt($selector);
-        $this->actor()->switchToIframe();
-        return $link;
-    }
-
-
-    /**
-     * Assuming you have already triggered the view modal for a single message from the context of the message activity
-     * list table, this will take care of validating the given text is NOT that window.
-     * @param string $text_to_view
-     */
-    public function dontSeeTextInViewMessageModal($text_to_view)
-    {
-        $this->seeTextInViewMessageModal($text_to_view, true);
-    }
-
-
-    public function dismissMessageModal()
-    {
-        $this->actor()->executeJs('window.dialogHelper.closeModal()');
-    }
+	/**
+	 * @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 amOnCustomMessageTemplateListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));
+	}
+
+
+	/**
+	 * 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
+		);
+	}
+
+
+	/**
+	 * 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,
+			0
+		));
+		$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
+			)
+		);
+	}
+
+
+	/**
+	 * This will create a custom message template for the given messenger and message type from the context of the
+	 * default (global) message template list table.
+	 * Also takes care of verifying the template was created.
+	 * @param string $message_type_label
+	 * @param string $messenger_label
+	 */
+	public function createCustomMessageTemplateFromDefaultFor($message_type_label, $messenger_label)
+	{
+		$this->amOnDefaultMessageTemplateListTablePage();
+		$this->actor()->click(
+			MessagesPage::createCustomButtonForMessageTypeAndMessenger(
+				$message_type_label,
+				$messenger_label
+			)
+		);
+		$this->actor()->seeInField('#title', 'New Custom Template');
+	}
+
+
+	/**
+	 * This switches the context of the current messages template to the given reference.
+	 * @param string $context_reference  This should be the visible label for the option.
+	 */
+	public function switchContextTo($context_reference)
+	{
+		$this->actor()->selectOption(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR, $context_reference);
+		$this->actor()->click(MessagesPage::MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR);
+		$this->actor()->waitForText($context_reference, 10, 'h1');
+	}
+
+
+	/**
+	 * Toggles Context so its turned off or on (depending on where it started) and verifies the expected state after
+	 * toggling.
+	 *
+	 * @param string $context_string           What context is being switched (used for the expected state text)
+	 * @param bool   $expected_state_is_active Used to indicate whether the expected state is active (true) or inactive
+	 *                                         (false)
+	 */
+	public function toggleContextState($context_string, $expected_state_is_active = true)
+	{
+		$this->actor()->click(MessagesPage::MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE);
+		if ($expected_state_is_active) {
+			$this->actor()->waitForText("The template for $context_string is currently active.");
+		} else {
+			$this->actor()->waitForText("The template for $context_string is currently inactive");
+		}
+	}
+
+
+	/**
+	 * Triggers saving the message template.
+	 * @param bool $and_close   Use to indicate to click the Save and Close button.
+	 */
+	public function saveMessageTemplate($and_close = false)
+	{
+		$this->actor()->scrollTo(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR);
+		if ($and_close) {
+			$this->actor()->click('Save and Close');
+		} else {
+			$this->actor()->click('Save');
+		}
+		$this->actor()->waitForText('successfully updated');
+	}
+
+
+	/**
+	 * This takes care of clicking the View Message icon for the given parameters.
+	 * Assumes you are already viewing the messages activity list table.
+	 * @param        $message_type_label
+	 * @param        $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 */
+	public function viewMessageInMessagesListTableFor(
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$this->actor()->click(MessagesPage::messagesActivityListTableViewButtonSelectorFor(
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$number_in_set
+		));
+	}
+
+
+	/**
+	 * Takes care of deleting a message matching the given parameters via the message activity list table.
+	 * Assumes you are already viewing the messages activity list table.
+	 * @param        $message_type_label
+	 * @param        $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 */
+	public function deleteMessageInMessagesListTableFor(
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$delete_action_selector = MessagesPage::messagesActivityListTableDeleteActionSelectorFor(
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$number_in_set
+		);
+		$cell_selector = MessagesPage::messagesActivityListTableCellSelectorFor(
+			'to',
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			'',
+			$number_in_set
+		);
+		$this->actor()->scrollTo($cell_selector, 0, -30);
+		$this->actor()->moveMouseOver(
+			$cell_selector,
+			5,
+			5
+		);
+		$this->actor()->waitForElementVisible(
+			$delete_action_selector
+		);
+		$this->actor()->click(
+			$delete_action_selector
+		);
+		$this->actor()->waitForText('successfully deleted', 20);
+	}
+
+
+	/**
+	 * Assuming you have already triggered the view modal for a single message from the context of the message activity
+	 * list table, this will take care of validating the given text is in that window.
+	 * @param string $text_to_view
+	 */
+	public function seeTextInViewMessageModal($text_to_view, $should_not_see = false)
+	{
+		$this->actor()->wait(2);
+		$this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
+		$this->actor()->switchToIframe('message-view-window');
+		$should_not_see ? $this->actor()->dontSee($text_to_view) : $this->actor()->see($text_to_view);
+		$this->actor()->switchToIframe();
+	}
+
+
+	/**
+	 * This returns the value for the link at the given selector in the message modal.
+	 * @param string $selector (any selector string accepted by WebDriver)
+	 */
+	public function observeLinkAtSelectorInMessageModal($selector)
+	{
+		$this->actor()->wait(2);
+		$this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
+		$this->actor()->switchToIframe('message-view-window');
+		$link = $this->actor()->observeLinkUrlAt($selector);
+		$this->actor()->switchToIframe();
+		return $link;
+	}
+
+
+	/**
+	 * Assuming you have already triggered the view modal for a single message from the context of the message activity
+	 * list table, this will take care of validating the given text is NOT that window.
+	 * @param string $text_to_view
+	 */
+	public function dontSeeTextInViewMessageModal($text_to_view)
+	{
+		$this->seeTextInViewMessageModal($text_to_view, true);
+	}
+
+
+	public function dismissMessageModal()
+	{
+		$this->actor()->executeJs('window.dialogHelper.closeModal()');
+	}
 }

espresso.php

Indentation +191 added lines, -191 removed lines

@@ -38,216 +38,216 @@
  * @since       4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.58.rc.001');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.58.rc.001');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
-        /**
-         *    espresso_load_error_handling
-         *    this function loads EE's class for handling exceptions and errors
-         */
-        function espresso_load_error_handling()
-        {
-            static $error_handling_loaded = false;
-            if ($error_handling_loaded) {
-                return;
-            }
-            // load debugging tools
-            if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
-                require_once   EE_HELPERS . 'EEH_Debug_Tools.helper.php';
-                \EEH_Debug_Tools::instance();
-            }
-            // load error handling
-            if (is_readable(EE_CORE . 'EE_Error.core.php')) {
-                require_once EE_CORE . 'EE_Error.core.php';
-            } else {
-                wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
-            }
-            $error_handling_loaded = true;
-        }
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		/**
+		 *    espresso_load_error_handling
+		 *    this function loads EE's class for handling exceptions and errors
+		 */
+		function espresso_load_error_handling()
+		{
+			static $error_handling_loaded = false;
+			if ($error_handling_loaded) {
+				return;
+			}
+			// load debugging tools
+			if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
+				require_once   EE_HELPERS . 'EEH_Debug_Tools.helper.php';
+				\EEH_Debug_Tools::instance();
+			}
+			// load error handling
+			if (is_readable(EE_CORE . 'EE_Error.core.php')) {
+				require_once EE_CORE . 'EE_Error.core.php';
+			} else {
+				wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
+			}
+			$error_handling_loaded = true;
+		}
 
-        /**
-         *    espresso_load_required
-         *    given a class name and path, this function will load that file or throw an exception
-         *
-         * @param    string $classname
-         * @param    string $full_path_to_file
-         * @throws    EE_Error
-         */
-        function espresso_load_required($classname, $full_path_to_file)
-        {
-            if (is_readable($full_path_to_file)) {
-                require_once $full_path_to_file;
-            } else {
-                throw new \EE_Error (
-                    sprintf(
-                        esc_html__(
-                            'The %s class file could not be located or is not readable due to file permissions.',
-                            'event_espresso'
-                        ),
-                        $classname
-                    )
-                );
-            }
-        }
+		/**
+		 *    espresso_load_required
+		 *    given a class name and path, this function will load that file or throw an exception
+		 *
+		 * @param    string $classname
+		 * @param    string $full_path_to_file
+		 * @throws    EE_Error
+		 */
+		function espresso_load_required($classname, $full_path_to_file)
+		{
+			if (is_readable($full_path_to_file)) {
+				require_once $full_path_to_file;
+			} else {
+				throw new \EE_Error (
+					sprintf(
+						esc_html__(
+							'The %s class file could not be located or is not readable due to file permissions.',
+							'event_espresso'
+						),
+						$classname
+					)
+				);
+			}
+		}
 
-        /**
-         * @since 4.9.27
-         * @throws \EE_Error
-         * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-         * @throws \EventEspresso\core\exceptions\InvalidEntityException
-         * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
-         * @throws \EventEspresso\core\exceptions\InvalidClassException
-         * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-         * @throws \EventEspresso\core\services\container\exceptions\ServiceExistsException
-         * @throws \EventEspresso\core\services\container\exceptions\ServiceNotFoundException
-         * @throws \OutOfBoundsException
-         */
-        function bootstrap_espresso()
-        {
-            require_once __DIR__ . '/core/espresso_definitions.php';
-            try {
-                espresso_load_error_handling();
-                espresso_load_required(
-                    'EEH_Base',
-                    EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php'
-                );
-                espresso_load_required(
-                    'EEH_File',
-                    EE_CORE . 'interfaces' . DS . 'EEHI_File.interface.php'
-                );
-                espresso_load_required(
-                    'EEH_File',
-                    EE_CORE . 'helpers' . DS . 'EEH_File.helper.php'
-                );
-                espresso_load_required(
-                    'EEH_Array',
-                    EE_CORE . 'helpers' . DS . 'EEH_Array.helper.php'
-                );
-                // instantiate and configure PSR4 autoloader
-                espresso_load_required(
-                    'Psr4Autoloader',
-                    EE_CORE . 'Psr4Autoloader.php'
-                );
-                espresso_load_required(
-                    'EE_Psr4AutoloaderInit',
-                    EE_CORE . 'EE_Psr4AutoloaderInit.core.php'
-                );
-                $AutoloaderInit = new EE_Psr4AutoloaderInit();
-                $AutoloaderInit->initializeAutoloader();
-                espresso_load_required(
-                    'EE_Request',
-                    EE_CORE . 'request_stack' . DS . 'EE_Request.core.php'
-                );
-                espresso_load_required(
-                    'EE_Response',
-                    EE_CORE . 'request_stack' . DS . 'EE_Response.core.php'
-                );
-                espresso_load_required(
-                    'EE_Bootstrap',
-                    EE_CORE . 'EE_Bootstrap.core.php'
-                );
-                // bootstrap EE and the request stack
-                new EE_Bootstrap(
-                    new EE_Request($_GET, $_POST, $_COOKIE),
-                    new EE_Response()
-                );
-            } catch (Exception $e) {
-                require_once EE_CORE . 'exceptions' . DS . 'ExceptionStackTraceDisplay.php';
-                new EventEspresso\core\exceptions\ExceptionStackTraceDisplay($e);
-            }
-        }
-        bootstrap_espresso();
-    }
+		/**
+		 * @since 4.9.27
+		 * @throws \EE_Error
+		 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+		 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+		 * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
+		 * @throws \EventEspresso\core\exceptions\InvalidClassException
+		 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+		 * @throws \EventEspresso\core\services\container\exceptions\ServiceExistsException
+		 * @throws \EventEspresso\core\services\container\exceptions\ServiceNotFoundException
+		 * @throws \OutOfBoundsException
+		 */
+		function bootstrap_espresso()
+		{
+			require_once __DIR__ . '/core/espresso_definitions.php';
+			try {
+				espresso_load_error_handling();
+				espresso_load_required(
+					'EEH_Base',
+					EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php'
+				);
+				espresso_load_required(
+					'EEH_File',
+					EE_CORE . 'interfaces' . DS . 'EEHI_File.interface.php'
+				);
+				espresso_load_required(
+					'EEH_File',
+					EE_CORE . 'helpers' . DS . 'EEH_File.helper.php'
+				);
+				espresso_load_required(
+					'EEH_Array',
+					EE_CORE . 'helpers' . DS . 'EEH_Array.helper.php'
+				);
+				// instantiate and configure PSR4 autoloader
+				espresso_load_required(
+					'Psr4Autoloader',
+					EE_CORE . 'Psr4Autoloader.php'
+				);
+				espresso_load_required(
+					'EE_Psr4AutoloaderInit',
+					EE_CORE . 'EE_Psr4AutoloaderInit.core.php'
+				);
+				$AutoloaderInit = new EE_Psr4AutoloaderInit();
+				$AutoloaderInit->initializeAutoloader();
+				espresso_load_required(
+					'EE_Request',
+					EE_CORE . 'request_stack' . DS . 'EE_Request.core.php'
+				);
+				espresso_load_required(
+					'EE_Response',
+					EE_CORE . 'request_stack' . DS . 'EE_Response.core.php'
+				);
+				espresso_load_required(
+					'EE_Bootstrap',
+					EE_CORE . 'EE_Bootstrap.core.php'
+				);
+				// bootstrap EE and the request stack
+				new EE_Bootstrap(
+					new EE_Request($_GET, $_POST, $_COOKIE),
+					new EE_Response()
+				);
+			} catch (Exception $e) {
+				require_once EE_CORE . 'exceptions' . DS . 'ExceptionStackTraceDisplay.php';
+				new EventEspresso\core\exceptions\ExceptionStackTraceDisplay($e);
+			}
+		}
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

core/request_stack/EE_Request.core.php

Doc Comments +4 added lines, -4 removed lines

@@ -167,7 +167,7 @@ 
      * returns   the value for a request param if the given key exists
      *
      * @param       $key
-     * @param null|mixed  $default
+     * @param null|string  $default
      * @return mixed
      */
     public function get($key, $default = null)
@@ -214,7 +214,7 @@ 
      * returns true if a match is found or false if not
      *
      * @param string $pattern
-     * @return false|int
+     * @return boolean
      */
     public function matches($pattern)
     {
@@ -372,7 +372,7 @@ 
 
 
     /**
-     * @return mixed
+     * @return boolean
      */
     public function isAjax()
     {
@@ -381,7 +381,7 @@ 
 
 
     /**
-     * @return mixed
+     * @return boolean
      */
     public function isFrontAjax()
     {

Indentation +405 added lines, -405 removed lines

@@ -16,411 +16,411 @@
 class EE_Request implements InterminableInterface
 {
 
-    /**
-     * $_GET parameters
-     *
-     * @var array $_get
-     */
-    private $_get;
-
-    /**
-     * $_POST parameters
-     *
-     * @var    array $_post
-     */
-    private $_post;
-
-    /**
-     * $_COOKIE parameters
-     *
-     * @var array $_cookie
-     */
-    private $_cookie;
-
-    /**
-     * $_REQUEST parameters
-     *
-     * @var array $_params
-     */
-    private $_params;
-
-    /**
-     * whether current request is for the admin but NOT via AJAX
-     *
-     * @var boolean $admin
-     */
-    public $admin = false;
-
-    /**
-     * whether current request is via AJAX
-     *
-     * @var boolean $ajax
-     */
-    public $ajax = false;
-
-    /**
-     * whether current request is via AJAX from the frontend of the site
-     *
-     * @var boolean $front_ajax
-     */
-    public $front_ajax = false;
-
-    /**
-     * IP address for request
-     *
-     * @var string $_ip_address
-     */
-    private $_ip_address;
-
-
-
-    /**
-     * class constructor
-     *
-     * @access    public
-     * @param array $get
-     * @param array $post
-     * @param array $cookie
-     */
-    public function __construct(array $get, array $post, array $cookie)
-    {
-        // grab request vars
-        $this->_get    = $get;
-        $this->_post   = $post;
-        $this->_cookie = $cookie;
-        $this->_params = array_merge($this->_get, $this->_post);
-        // AJAX ???
-        $this->ajax       = defined('DOING_AJAX') && DOING_AJAX;
-        $this->front_ajax = $this->ajax
-                            && $this->is_set('ee_front_ajax')
-                            && filter_var($this->get('ee_front_ajax'), FILTER_VALIDATE_BOOLEAN);
-        $this->admin      = is_admin() && ! $this->ajax;
-        // grab user IP
-        $this->_ip_address = $this->_visitor_ip();
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function get_params()
-    {
-        return $this->_get;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function post_params()
-    {
-        return $this->_post;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function cookie_params()
-    {
-        return $this->_cookie;
-    }
-
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function params()
-    {
-        return $this->_params;
-    }
-
-
-
-    /**
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return    void
-     */
-    public function set($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if (
-            $key !== 'ee'
-            || ($key === 'ee' && empty($this->_params['ee']))
-            || ($key === 'ee' && ! empty($this->_params['ee']) && $override_ee)
-        ) {
-            $this->_params[$key] = $value;
-        }
-    }
-
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param       $key
-     * @param null|mixed  $default
-     * @return mixed
-     */
-    public function get($key, $default = null)
-    {
-        return $this->request_parameter_drill_down($key, $default, 'get');
-    }
-
-
-
-    /**
-     * check if param exists
-     *
-     * @param       $key
-     * @return bool
-     */
-    public function is_set($key)
-    {
-        return $this->request_parameter_drill_down($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string $pattern
-     * @param null|mixed $default
-     * @return false|int
-     */
-    public function getMatch($pattern, $default = null)
-    {
-        return $this->request_parameter_drill_down($pattern, $default, 'match');
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return false|int
-     */
-    public function matches($pattern)
-    {
-        return $this->request_parameter_drill_down($pattern, null, 'match') !== null;
-    }
-
-
-    /**
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
-     * @param string $pattern           A string including wildcards to be converted to a regex pattern
-     *                                  and used to search through the current request's parameter keys
-     * @param array  $request_params    The array of request parameters to search through
-     * @param mixed  $default           [optional] The value to be returned if no match is found.
-     *                                  Default is null
-     * @param string $return            [optional] Controls what kind of value is returned.
-     *                                  Options are:
-     *                                      'bool' will return true or false if match is found or not
-     *                                      'key' will return the first key found that matches the supplied pattern
-     *                                      'value' will return the value for the first request parameter
-     *                                      whose key matches the supplied pattern
-     *                                  Default is 'value'
-     * @return boolean|string
-     */
-    private function match($pattern, array $request_params, $default = null, $return = 'value')
-    {
-        $return = in_array($return, array('bool', 'key', 'value'), true)
-            ? $return
-            : 'is_set';
-        // replace wildcard chars with regex chars
-        $pattern = str_replace(
-            array("\*", "\?"),
-            array('.*', '.'),
-            preg_quote($pattern, '/')
-        );
-        foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
-                // return value for request param
-                if ($return === 'value'){
-                    return $request_params[ $key ];
-                }
-                // or actual key or true just to indicate it was found
-                return $return === 'key' ? $key : true;
-            }
-        }
-        // match not found so return default value or false
-        return $return === 'value' ? $default : false;
-    }
-
-    /**
-     * the supplied key can be a simple string to represent a "top-level" request parameter
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
-     * by using square brackets to surround keys for deeper array elements.
-     * For example :
-     * if the supplied $key was: "first[second][third]"
-     * then this will attempt to drill down into the request parameter array to find a value.
-     * Given the following request parameters:
-     *  array(
-     *      'first' => array(
-     *          'second' => array(
-     *              'third' => 'has a value'
-     *          )
-     *      )
-     *  )
-     * would return true if default parameters were set
-     *
-     * @param string $callback
-     * @param        $key
-     * @param null   $default
-     * @param array  $request_params
-     * @return bool|mixed|null
-     */
-    private function request_parameter_drill_down(
-        $key,
-        $default = null,
-        $callback = 'is_set',
-        array $request_params = array()
-    ) {
-        $callback = in_array($callback, array('is_set', 'get', 'match'), true)
-            ? $callback
-            : 'is_set';
-        $request_params = ! empty($request_params)
-            ? $request_params
-            : $this->_params;
-        // does incoming key represent an array like 'first[second][third]'  ?
-        if (strpos($key, '[') !== false) {
-            // turn it into an actual array
-            $key  = str_replace(']', '', $key);
-            $keys = explode('[', $key);
-            $key  = array_shift($keys);
-            if ($callback === 'match') {
-                $real_key = $this->match($key, $request_params, $default, 'key');
-                $key = $real_key ? $real_key : $key;
-            }
-            // check if top level key exists
-            if (isset($request_params[ $key ])) {
-                // build a new key to pass along like: 'second[third]'
-                // or just 'second' depending on depth of keys
-                $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
-                }
-                return $this->request_parameter_drill_down(
-                    $key_string,
-                    $default,
-                    $callback,
-                    $request_params[ $key ]
-                );
-            }
-        }
-        if ($callback === 'is_set') {
-            return isset($request_params[$key]);
-        }
-        if ($callback === 'match') {
-            return $this->match($key, $request_params, $default);
-        }
-        return isset($request_params[$key])
-            ? $request_params[$key]
-            : $default;
-    }
-
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function un_set($key, $unset_from_global_too = false)
-    {
-        unset($this->_params[$key]);
-        if ($unset_from_global_too) {
-            unset($_REQUEST[$key]);
-        }
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function ip_address()
-    {
-        return $this->_ip_address;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdmin()
-    {
-        return $this->admin;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function isAjax()
-    {
-        return $this->ajax;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function isFrontAjax()
-    {
-        return $this->front_ajax;
-    }
-
-
-
-    /**
-     * _visitor_ip
-     *    attempt to get IP address of current visitor from server
-     * plz see: http://stackoverflow.com/a/2031935/1475279
-     *
-     * @access public
-     * @return string
-     */
-    private function _visitor_ip()
-    {
-        $visitor_ip  = '0.0.0.0';
-        $server_keys = array(
-            'HTTP_CLIENT_IP',
-            'HTTP_X_FORWARDED_FOR',
-            'HTTP_X_FORWARDED',
-            'HTTP_X_CLUSTER_CLIENT_IP',
-            'HTTP_FORWARDED_FOR',
-            'HTTP_FORWARDED',
-            'REMOTE_ADDR',
-        );
-        foreach ($server_keys as $key) {
-            if (isset($_SERVER[$key])) {
-                foreach (array_map('trim', explode(',', $_SERVER[$key])) as $ip) {
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
-                        $visitor_ip = $ip;
-                    }
-                }
-            }
-        }
-        return $visitor_ip;
-    }
+	/**
+	 * $_GET parameters
+	 *
+	 * @var array $_get
+	 */
+	private $_get;
+
+	/**
+	 * $_POST parameters
+	 *
+	 * @var    array $_post
+	 */
+	private $_post;
+
+	/**
+	 * $_COOKIE parameters
+	 *
+	 * @var array $_cookie
+	 */
+	private $_cookie;
+
+	/**
+	 * $_REQUEST parameters
+	 *
+	 * @var array $_params
+	 */
+	private $_params;
+
+	/**
+	 * whether current request is for the admin but NOT via AJAX
+	 *
+	 * @var boolean $admin
+	 */
+	public $admin = false;
+
+	/**
+	 * whether current request is via AJAX
+	 *
+	 * @var boolean $ajax
+	 */
+	public $ajax = false;
+
+	/**
+	 * whether current request is via AJAX from the frontend of the site
+	 *
+	 * @var boolean $front_ajax
+	 */
+	public $front_ajax = false;
+
+	/**
+	 * IP address for request
+	 *
+	 * @var string $_ip_address
+	 */
+	private $_ip_address;
+
+
+
+	/**
+	 * class constructor
+	 *
+	 * @access    public
+	 * @param array $get
+	 * @param array $post
+	 * @param array $cookie
+	 */
+	public function __construct(array $get, array $post, array $cookie)
+	{
+		// grab request vars
+		$this->_get    = $get;
+		$this->_post   = $post;
+		$this->_cookie = $cookie;
+		$this->_params = array_merge($this->_get, $this->_post);
+		// AJAX ???
+		$this->ajax       = defined('DOING_AJAX') && DOING_AJAX;
+		$this->front_ajax = $this->ajax
+							&& $this->is_set('ee_front_ajax')
+							&& filter_var($this->get('ee_front_ajax'), FILTER_VALIDATE_BOOLEAN);
+		$this->admin      = is_admin() && ! $this->ajax;
+		// grab user IP
+		$this->_ip_address = $this->_visitor_ip();
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function get_params()
+	{
+		return $this->_get;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function post_params()
+	{
+		return $this->_post;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function cookie_params()
+	{
+		return $this->_cookie;
+	}
+
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function params()
+	{
+		return $this->_params;
+	}
+
+
+
+	/**
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return    void
+	 */
+	public function set($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if (
+			$key !== 'ee'
+			|| ($key === 'ee' && empty($this->_params['ee']))
+			|| ($key === 'ee' && ! empty($this->_params['ee']) && $override_ee)
+		) {
+			$this->_params[$key] = $value;
+		}
+	}
+
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param       $key
+	 * @param null|mixed  $default
+	 * @return mixed
+	 */
+	public function get($key, $default = null)
+	{
+		return $this->request_parameter_drill_down($key, $default, 'get');
+	}
+
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param       $key
+	 * @return bool
+	 */
+	public function is_set($key)
+	{
+		return $this->request_parameter_drill_down($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string $pattern
+	 * @param null|mixed $default
+	 * @return false|int
+	 */
+	public function getMatch($pattern, $default = null)
+	{
+		return $this->request_parameter_drill_down($pattern, $default, 'match');
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return false|int
+	 */
+	public function matches($pattern)
+	{
+		return $this->request_parameter_drill_down($pattern, null, 'match') !== null;
+	}
+
+
+	/**
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
+	 * @param string $pattern           A string including wildcards to be converted to a regex pattern
+	 *                                  and used to search through the current request's parameter keys
+	 * @param array  $request_params    The array of request parameters to search through
+	 * @param mixed  $default           [optional] The value to be returned if no match is found.
+	 *                                  Default is null
+	 * @param string $return            [optional] Controls what kind of value is returned.
+	 *                                  Options are:
+	 *                                      'bool' will return true or false if match is found or not
+	 *                                      'key' will return the first key found that matches the supplied pattern
+	 *                                      'value' will return the value for the first request parameter
+	 *                                      whose key matches the supplied pattern
+	 *                                  Default is 'value'
+	 * @return boolean|string
+	 */
+	private function match($pattern, array $request_params, $default = null, $return = 'value')
+	{
+		$return = in_array($return, array('bool', 'key', 'value'), true)
+			? $return
+			: 'is_set';
+		// replace wildcard chars with regex chars
+		$pattern = str_replace(
+			array("\*", "\?"),
+			array('.*', '.'),
+			preg_quote($pattern, '/')
+		);
+		foreach ($request_params as $key => $request_param) {
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
+				// return value for request param
+				if ($return === 'value'){
+					return $request_params[ $key ];
+				}
+				// or actual key or true just to indicate it was found
+				return $return === 'key' ? $key : true;
+			}
+		}
+		// match not found so return default value or false
+		return $return === 'value' ? $default : false;
+	}
+
+	/**
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
+	 * by using square brackets to surround keys for deeper array elements.
+	 * For example :
+	 * if the supplied $key was: "first[second][third]"
+	 * then this will attempt to drill down into the request parameter array to find a value.
+	 * Given the following request parameters:
+	 *  array(
+	 *      'first' => array(
+	 *          'second' => array(
+	 *              'third' => 'has a value'
+	 *          )
+	 *      )
+	 *  )
+	 * would return true if default parameters were set
+	 *
+	 * @param string $callback
+	 * @param        $key
+	 * @param null   $default
+	 * @param array  $request_params
+	 * @return bool|mixed|null
+	 */
+	private function request_parameter_drill_down(
+		$key,
+		$default = null,
+		$callback = 'is_set',
+		array $request_params = array()
+	) {
+		$callback = in_array($callback, array('is_set', 'get', 'match'), true)
+			? $callback
+			: 'is_set';
+		$request_params = ! empty($request_params)
+			? $request_params
+			: $this->_params;
+		// does incoming key represent an array like 'first[second][third]'  ?
+		if (strpos($key, '[') !== false) {
+			// turn it into an actual array
+			$key  = str_replace(']', '', $key);
+			$keys = explode('[', $key);
+			$key  = array_shift($keys);
+			if ($callback === 'match') {
+				$real_key = $this->match($key, $request_params, $default, 'key');
+				$key = $real_key ? $real_key : $key;
+			}
+			// check if top level key exists
+			if (isset($request_params[ $key ])) {
+				// build a new key to pass along like: 'second[third]'
+				// or just 'second' depending on depth of keys
+				$key_string = array_shift($keys);
+				if (! empty($keys)) {
+					$key_string .= '[' . implode('][', $keys) . ']';
+				}
+				return $this->request_parameter_drill_down(
+					$key_string,
+					$default,
+					$callback,
+					$request_params[ $key ]
+				);
+			}
+		}
+		if ($callback === 'is_set') {
+			return isset($request_params[$key]);
+		}
+		if ($callback === 'match') {
+			return $this->match($key, $request_params, $default);
+		}
+		return isset($request_params[$key])
+			? $request_params[$key]
+			: $default;
+	}
+
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function un_set($key, $unset_from_global_too = false)
+	{
+		unset($this->_params[$key]);
+		if ($unset_from_global_too) {
+			unset($_REQUEST[$key]);
+		}
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function ip_address()
+	{
+		return $this->_ip_address;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdmin()
+	{
+		return $this->admin;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function isAjax()
+	{
+		return $this->ajax;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function isFrontAjax()
+	{
+		return $this->front_ajax;
+	}
+
+
+
+	/**
+	 * _visitor_ip
+	 *    attempt to get IP address of current visitor from server
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
+	 *
+	 * @access public
+	 * @return string
+	 */
+	private function _visitor_ip()
+	{
+		$visitor_ip  = '0.0.0.0';
+		$server_keys = array(
+			'HTTP_CLIENT_IP',
+			'HTTP_X_FORWARDED_FOR',
+			'HTTP_X_FORWARDED',
+			'HTTP_X_CLUSTER_CLIENT_IP',
+			'HTTP_FORWARDED_FOR',
+			'HTTP_FORWARDED',
+			'REMOTE_ADDR',
+		);
+		foreach ($server_keys as $key) {
+			if (isset($_SERVER[$key])) {
+				foreach (array_map('trim', explode(',', $_SERVER[$key])) as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
+						$visitor_ip = $ip;
+					}
+				}
+			}
+		}
+		return $visitor_ip;
+	}
 
 
 

Spacing +7 added lines, -7 removed lines

@@ -250,10 +250,10 @@ 
             preg_quote($pattern, '/')
         );
         foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
+            if (preg_match('/^'.$pattern.'$/is', $key)) {
                 // return value for request param
-                if ($return === 'value'){
-                    return $request_params[ $key ];
+                if ($return === 'value') {
+                    return $request_params[$key];
                 }
                 // or actual key or true just to indicate it was found
                 return $return === 'key' ? $key : true;
@@ -309,18 +309,18 @@ 
                 $key = $real_key ? $real_key : $key;
             }
             // check if top level key exists
-            if (isset($request_params[ $key ])) {
+            if (isset($request_params[$key])) {
                 // build a new key to pass along like: 'second[third]'
                 // or just 'second' depending on depth of keys
                 $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
+                if ( ! empty($keys)) {
+                    $key_string .= '['.implode('][', $keys).']';
                 }
                 return $this->request_parameter_drill_down(
                     $key_string,
                     $default,
                     $callback,
-                    $request_params[ $key ]
+                    $request_params[$key]
                 );
             }
         }

core/libraries/form_sections/inputs/EE_Invisible_Recaptcha_Input.input.php

Indentation +156 added lines, -156 removed lines

@@ -19,160 +19,160 @@
 class EE_Invisible_Recaptcha_Input extends EE_Form_Input_Base
 {
 
-    const SCRIPT_HANDLE_GOOGLE_INVISIBLE_RECAPTCHA   = 'google_invisible_recaptcha';
-
-    const SCRIPT_HANDLE_ESPRESSO_INVISIBLE_RECAPTCHA = 'espresso_invisible_recaptcha';
-
-    /**
-     * @var EE_Registration_Config $config
-     */
-    private $config;
-
-    /**
-     * @var string $recaptcha_id
-     */
-    private $recaptcha_id;
-
-    /**
-     * @var string $submit_button_id
-     */
-    private $submit_button_id;
-
-
-    /**
-     * @param array                  $input_settings
-     * @param EE_Registration_Config $registration_config
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct(array $input_settings = array(), EE_Registration_Config $registration_config = null)
-    {
-        $this->_set_display_strategy(new EE_Invisible_Recaptcha_Display_Strategy());
-        parent::__construct($input_settings);
-        $registration_config    = $registration_config instanceof EE_Registration_Config
-            ? $registration_config
-            : EE_Registry::instance()->CFG->registration;
-        $this->config           = $registration_config;
-        $this->recaptcha_id     = isset($input_settings['recaptcha_id'])
-            ? $input_settings['recaptcha_id']
-            : substr(spl_object_hash($this), 8, 8);
-        $this->submit_button_id = isset($input_settings['submit_button_id'])
-            ? $input_settings['submit_button_id']
-            : '';
-        $this->registerScripts();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function useCaptcha()
-    {
-        return $this->config->use_captcha && $this->config->recaptcha_theme === 'invisible';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function language()
-    {
-        return $this->config->recaptcha_language;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function siteKey()
-    {
-        return $this->config->recaptcha_publickey;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function secretKey()
-    {
-        return $this->config->recaptcha_privatekey;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function recaptchaId()
-    {
-        return $this->recaptcha_id;
-    }
-
-
-    /**
-     * @return void
-     */
-    public function registerScripts()
-    {
-        if (! $this->useCaptcha()) {
-            return;
-        }
-        add_filter('script_loader_tag', array($this, 'addScriptAttributes'), 10, 2);
-        wp_register_script(
-            EE_Invisible_Recaptcha_Input::SCRIPT_HANDLE_ESPRESSO_INVISIBLE_RECAPTCHA,
-            EED_Recaptcha_Invisible::assetsUrl() . 'espresso_invisible_recaptcha.js',
-            array('espresso_core'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            EE_Invisible_Recaptcha_Input::SCRIPT_HANDLE_GOOGLE_INVISIBLE_RECAPTCHA,
-            add_query_arg(
-                array(
-                    'onload' => 'espressoLoadRecaptcha',
-                    'render' => 'explicit',
-                    'hl'     => $this->language(),
-                ),
-                'https://www.google.com/recaptcha/api.js?'
-            ),
-            array(EE_Invisible_Recaptcha_Input::SCRIPT_HANDLE_ESPRESSO_INVISIBLE_RECAPTCHA),
-            false,
-            true
-        );
-        wp_localize_script(
-            EE_Invisible_Recaptcha_Input::SCRIPT_HANDLE_ESPRESSO_INVISIBLE_RECAPTCHA,
-            'eeRecaptcha',
-            array(
-                'siteKey'          => $this->siteKey(),
-                'submit_button_id' => $this->submit_button_id,
-                'wp_debug'         => WP_DEBUG,
-            )
-        );
-    }
-
-
-    /**
-     * @param string $tag
-     * @param string $handle
-     * @return string
-     */
-    public function addScriptAttributes($tag, $handle)
-    {
-        if ($handle === EE_Invisible_Recaptcha_Input::SCRIPT_HANDLE_GOOGLE_INVISIBLE_RECAPTCHA) {
-            $tag = str_replace('></script>', ' async="async" defer="defer"></script>', $tag);
-        }
-        return $tag;
-    }
-
-
-    /**
-     * Gets the HTML for displaying the label for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     */
-    public function get_html_for_label()
-    {
-        return '';
-    }
+	const SCRIPT_HANDLE_GOOGLE_INVISIBLE_RECAPTCHA   = 'google_invisible_recaptcha';
+
+	const SCRIPT_HANDLE_ESPRESSO_INVISIBLE_RECAPTCHA = 'espresso_invisible_recaptcha';
+
+	/**
+	 * @var EE_Registration_Config $config
+	 */
+	private $config;
+
+	/**
+	 * @var string $recaptcha_id
+	 */
+	private $recaptcha_id;
+
+	/**
+	 * @var string $submit_button_id
+	 */
+	private $submit_button_id;
+
+
+	/**
+	 * @param array                  $input_settings
+	 * @param EE_Registration_Config $registration_config
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct(array $input_settings = array(), EE_Registration_Config $registration_config = null)
+	{
+		$this->_set_display_strategy(new EE_Invisible_Recaptcha_Display_Strategy());
+		parent::__construct($input_settings);
+		$registration_config    = $registration_config instanceof EE_Registration_Config
+			? $registration_config
+			: EE_Registry::instance()->CFG->registration;
+		$this->config           = $registration_config;
+		$this->recaptcha_id     = isset($input_settings['recaptcha_id'])
+			? $input_settings['recaptcha_id']
+			: substr(spl_object_hash($this), 8, 8);
+		$this->submit_button_id = isset($input_settings['submit_button_id'])
+			? $input_settings['submit_button_id']
+			: '';
+		$this->registerScripts();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function useCaptcha()
+	{
+		return $this->config->use_captcha && $this->config->recaptcha_theme === 'invisible';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function language()
+	{
+		return $this->config->recaptcha_language;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function siteKey()
+	{
+		return $this->config->recaptcha_publickey;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function secretKey()
+	{
+		return $this->config->recaptcha_privatekey;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function recaptchaId()
+	{
+		return $this->recaptcha_id;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function registerScripts()
+	{
+		if (! $this->useCaptcha()) {
+			return;
+		}
+		add_filter('script_loader_tag', array($this, 'addScriptAttributes'), 10, 2);
+		wp_register_script(
+			EE_Invisible_Recaptcha_Input::SCRIPT_HANDLE_ESPRESSO_INVISIBLE_RECAPTCHA,
+			EED_Recaptcha_Invisible::assetsUrl() . 'espresso_invisible_recaptcha.js',
+			array('espresso_core'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			EE_Invisible_Recaptcha_Input::SCRIPT_HANDLE_GOOGLE_INVISIBLE_RECAPTCHA,
+			add_query_arg(
+				array(
+					'onload' => 'espressoLoadRecaptcha',
+					'render' => 'explicit',
+					'hl'     => $this->language(),
+				),
+				'https://www.google.com/recaptcha/api.js?'
+			),
+			array(EE_Invisible_Recaptcha_Input::SCRIPT_HANDLE_ESPRESSO_INVISIBLE_RECAPTCHA),
+			false,
+			true
+		);
+		wp_localize_script(
+			EE_Invisible_Recaptcha_Input::SCRIPT_HANDLE_ESPRESSO_INVISIBLE_RECAPTCHA,
+			'eeRecaptcha',
+			array(
+				'siteKey'          => $this->siteKey(),
+				'submit_button_id' => $this->submit_button_id,
+				'wp_debug'         => WP_DEBUG,
+			)
+		);
+	}
+
+
+	/**
+	 * @param string $tag
+	 * @param string $handle
+	 * @return string
+	 */
+	public function addScriptAttributes($tag, $handle)
+	{
+		if ($handle === EE_Invisible_Recaptcha_Input::SCRIPT_HANDLE_GOOGLE_INVISIBLE_RECAPTCHA) {
+			$tag = str_replace('></script>', ' async="async" defer="defer"></script>', $tag);
+		}
+		return $tag;
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the label for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 */
+	public function get_html_for_label()
+	{
+		return '';
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -114,13 +114,13 @@
      */
     public function registerScripts()
     {
-        if (! $this->useCaptcha()) {
+        if ( ! $this->useCaptcha()) {
             return;
         }
         add_filter('script_loader_tag', array($this, 'addScriptAttributes'), 10, 2);
         wp_register_script(
             EE_Invisible_Recaptcha_Input::SCRIPT_HANDLE_ESPRESSO_INVISIBLE_RECAPTCHA,
-            EED_Recaptcha_Invisible::assetsUrl() . 'espresso_invisible_recaptcha.js',
+            EED_Recaptcha_Invisible::assetsUrl().'espresso_invisible_recaptcha.js',
             array('espresso_core'),
             EVENT_ESPRESSO_VERSION,
             true

core/libraries/form_sections/base/EE_Form_Section_Base.form.php

Indentation +474 added lines, -474 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\libraries\form_sections\strategies\filter\FormHtmlFilter;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -21,485 +21,485 @@ 
 abstract class EE_Form_Section_Base
 {
 
-    /**
-     * the URL the form is submitted to
-     *
-     * @var string
-     */
-    protected $_action;
-
-    /**
-     * POST (default) or GET
-     *
-     * @var string
-     */
-    protected $_method;
-
-    /**
-     * html_id and html_name are derived from this by default
-     *
-     * @var string
-     */
-    protected $_name;
-
-    /**
-     * $_html_id
-     * @var string
-     */
-    protected $_html_id;
-
-    /**
-     * $_html_class
-     * @var string
-     */
-    protected $_html_class;
-
-    /**
-     * $_html_style
-     * @var string
-     */
-    protected $_html_style;
-
-    /**
-     * $_other_html_attributes
-     * @var string
-     */
-    protected $_other_html_attributes;
-
-    /**
-     * The form section of which this form section is a part
-     *
-     * @var EE_Form_Section_Proper
-     */
-    protected $_parent_section;
-
-    /**
-     * flag indicating that _construct_finalize has been called.
-     * If it has not been called and we try to use functions which require it, we call it
-     * with no parameters. But normally, _construct_finalize should be called by the instantiating class
-     *
-     * @var boolean
-     */
-    protected $_construction_finalized;
-
-    /**
-     * Strategy for parsing the form HTML upon display
-     *
-     * @var FormHtmlFilter
-     */
-    protected $_form_html_filter;
-
-
-    /**
-     * @param array $options_array {
-     * @type        $name          string the name for this form section, if you want to explicitly define it
-     *                             }
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($options_array = array())
-    {
-        // used by display strategies
-        // assign incoming values to properties
-        foreach ($options_array as $key => $value) {
-            $key = '_' . $key;
-            if (property_exists($this, $key) && empty($this->{$key})) {
-                $this->{$key} = $value;
-                if($key === '_subsections' && ! is_array($value)) {
-                    throw new InvalidDataTypeException($key, $value, 'array');
-                }
-            }
-        }
-        // set parser which allows the form section's rendered HTML to be filtered
-        if (isset($options_array['form_html_filter']) && $options_array['form_html_filter'] instanceof FormHtmlFilter) {
-            $this->_form_html_filter = $options_array['form_html_filter'];
-        }
-    }
-
-
-
-    /**
-     * @param $parent_form_section
-     * @param $name
-     * @throws \EE_Error
-     */
-    protected function _construct_finalize($parent_form_section, $name)
-    {
-        $this->_construction_finalized = true;
-        $this->_parent_section = $parent_form_section;
-        if ($name !== null) {
-            $this->_name = $name;
-        }
-    }
-
-
-
-    /**
-     * make sure construction finalized was called, otherwise children might not be ready
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function ensure_construct_finalized_called()
-    {
-        if (! $this->_construction_finalized) {
-            $this->_construct_finalize($this->_parent_section, $this->_name);
-        }
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function action()
-    {
-        return $this->_action;
-    }
-
-
-
-    /**
-     * @param string $action
-     */
-    public function set_action($action)
-    {
-        $this->_action = $action;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function method()
-    {
-        return ! empty($this->_method) ? $this->_method : 'POST';
-    }
-
-
-
-    /**
-     * @param string $method
-     */
-    public function set_method($method)
-    {
-        switch ($method) {
-            case 'get' :
-            case 'GET' :
-                $this->_method = 'GET';
-                break;
-            default :
-                $this->_method = 'POST';
-        }
-    }
-
-
-
-    /**
-     * Sets the html_id to its default value, if none was specified in the constructor.
-     * Calculation involves using the name and the parent's html id
-     * return void
-     *
-     * @throws \EE_Error
-     */
-    protected function _set_default_html_id_if_empty()
-    {
-        if (! $this->_html_id) {
-            if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
-                $this->_html_id = $this->_parent_section->html_id()
-                                  . '-'
-                                  . $this->_prep_name_for_html_id($this->name());
-            } else {
-                $this->_html_id = $this->_prep_name_for_html_id($this->name());
-            }
-        }
-    }
-
-
-
-    /**
-     * _prep_name_for_html_id
-     *
-     * @param $name
-     * @return string
-     */
-    private function _prep_name_for_html_id($name)
-    {
-        return sanitize_key(str_replace(array(' ', ' ', '_'), '-', $name));
-    }
+	/**
+	 * the URL the form is submitted to
+	 *
+	 * @var string
+	 */
+	protected $_action;
+
+	/**
+	 * POST (default) or GET
+	 *
+	 * @var string
+	 */
+	protected $_method;
+
+	/**
+	 * html_id and html_name are derived from this by default
+	 *
+	 * @var string
+	 */
+	protected $_name;
+
+	/**
+	 * $_html_id
+	 * @var string
+	 */
+	protected $_html_id;
+
+	/**
+	 * $_html_class
+	 * @var string
+	 */
+	protected $_html_class;
+
+	/**
+	 * $_html_style
+	 * @var string
+	 */
+	protected $_html_style;
+
+	/**
+	 * $_other_html_attributes
+	 * @var string
+	 */
+	protected $_other_html_attributes;
+
+	/**
+	 * The form section of which this form section is a part
+	 *
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_parent_section;
+
+	/**
+	 * flag indicating that _construct_finalize has been called.
+	 * If it has not been called and we try to use functions which require it, we call it
+	 * with no parameters. But normally, _construct_finalize should be called by the instantiating class
+	 *
+	 * @var boolean
+	 */
+	protected $_construction_finalized;
+
+	/**
+	 * Strategy for parsing the form HTML upon display
+	 *
+	 * @var FormHtmlFilter
+	 */
+	protected $_form_html_filter;
+
+
+	/**
+	 * @param array $options_array {
+	 * @type        $name          string the name for this form section, if you want to explicitly define it
+	 *                             }
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($options_array = array())
+	{
+		// used by display strategies
+		// assign incoming values to properties
+		foreach ($options_array as $key => $value) {
+			$key = '_' . $key;
+			if (property_exists($this, $key) && empty($this->{$key})) {
+				$this->{$key} = $value;
+				if($key === '_subsections' && ! is_array($value)) {
+					throw new InvalidDataTypeException($key, $value, 'array');
+				}
+			}
+		}
+		// set parser which allows the form section's rendered HTML to be filtered
+		if (isset($options_array['form_html_filter']) && $options_array['form_html_filter'] instanceof FormHtmlFilter) {
+			$this->_form_html_filter = $options_array['form_html_filter'];
+		}
+	}
+
+
+
+	/**
+	 * @param $parent_form_section
+	 * @param $name
+	 * @throws \EE_Error
+	 */
+	protected function _construct_finalize($parent_form_section, $name)
+	{
+		$this->_construction_finalized = true;
+		$this->_parent_section = $parent_form_section;
+		if ($name !== null) {
+			$this->_name = $name;
+		}
+	}
+
+
+
+	/**
+	 * make sure construction finalized was called, otherwise children might not be ready
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function ensure_construct_finalized_called()
+	{
+		if (! $this->_construction_finalized) {
+			$this->_construct_finalize($this->_parent_section, $this->_name);
+		}
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function action()
+	{
+		return $this->_action;
+	}
+
+
+
+	/**
+	 * @param string $action
+	 */
+	public function set_action($action)
+	{
+		$this->_action = $action;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function method()
+	{
+		return ! empty($this->_method) ? $this->_method : 'POST';
+	}
+
+
+
+	/**
+	 * @param string $method
+	 */
+	public function set_method($method)
+	{
+		switch ($method) {
+			case 'get' :
+			case 'GET' :
+				$this->_method = 'GET';
+				break;
+			default :
+				$this->_method = 'POST';
+		}
+	}
+
+
+
+	/**
+	 * Sets the html_id to its default value, if none was specified in the constructor.
+	 * Calculation involves using the name and the parent's html id
+	 * return void
+	 *
+	 * @throws \EE_Error
+	 */
+	protected function _set_default_html_id_if_empty()
+	{
+		if (! $this->_html_id) {
+			if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
+				$this->_html_id = $this->_parent_section->html_id()
+								  . '-'
+								  . $this->_prep_name_for_html_id($this->name());
+			} else {
+				$this->_html_id = $this->_prep_name_for_html_id($this->name());
+			}
+		}
+	}
+
+
+
+	/**
+	 * _prep_name_for_html_id
+	 *
+	 * @param $name
+	 * @return string
+	 */
+	private function _prep_name_for_html_id($name)
+	{
+		return sanitize_key(str_replace(array(' ', ' ', '_'), '-', $name));
+	}
 
 
 
-    /**
-     * Returns the HTML, JS, and CSS necessary to display this form section on a page.
-     * Note however, it's recommended that you instead call enqueue_js on the "wp_enqueue_scripts" action,
-     * and call get_html when you want to output the html. Calling get_html_and_js after
-     * "wp_enqueue_scripts" has already fired seems to work for now, but is contrary
-     * to the instructions on https://developer.wordpress.org/reference/functions/wp_enqueue_script/
-     * and so might stop working anytime.
-     *
-     * @return string
-     */
-    public function get_html_and_js()
-    {
-        return $this->get_html();
-    }
+	/**
+	 * Returns the HTML, JS, and CSS necessary to display this form section on a page.
+	 * Note however, it's recommended that you instead call enqueue_js on the "wp_enqueue_scripts" action,
+	 * and call get_html when you want to output the html. Calling get_html_and_js after
+	 * "wp_enqueue_scripts" has already fired seems to work for now, but is contrary
+	 * to the instructions on https://developer.wordpress.org/reference/functions/wp_enqueue_script/
+	 * and so might stop working anytime.
+	 *
+	 * @return string
+	 */
+	public function get_html_and_js()
+	{
+		return $this->get_html();
+	}
 
 
 
-    /**
-     * Gets the HTML for displaying this form section
-     *
-     * @return string
-     */
-    abstract public function get_html();
-
-
-    /**
-     * @param bool $add_pound_sign
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_id($add_pound_sign = false)
-    {
-        $this->_set_default_html_id_if_empty();
-        return $add_pound_sign ? '#' . $this->_html_id : $this->_html_id;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_class()
-    {
-        return $this->_html_class;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_style()
-    {
-        return $this->_html_style;
-    }
-
-
-
-    /**
-     * @param mixed $html_class
-     */
-    public function set_html_class($html_class)
-    {
-        $this->_html_class = $html_class;
-    }
-
-
-
-    /**
-     * @param mixed $html_id
-     */
-    public function set_html_id($html_id)
-    {
-        $this->_html_id = $html_id;
-    }
-
-
-
-    /**
-     * @param mixed $html_style
-     */
-    public function set_html_style($html_style)
-    {
-        $this->_html_style = $html_style;
-    }
-
-
-
-    /**
-     * @param string $other_html_attributes
-     */
-    public function set_other_html_attributes($other_html_attributes)
-    {
-        $this->_other_html_attributes = $other_html_attributes;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function other_html_attributes()
-    {
-        return $this->_other_html_attributes;
-    }
-
-
-
-    /**
-     * Gets the name of the form section. This is not the same as the HTML name.
-     *
-     * @throws EE_Error
-     * @return string
-     */
-    public function name()
-    {
-        if (! $this->_construction_finalized) {
-            throw new EE_Error(sprintf(__('You cannot use the form section\s name until _construct_finalize has been called on it (when we set the name). It was called on a form section of type \'s\'',
-                'event_espresso'), get_class($this)));
-        }
-        return $this->_name;
-    }
-
-
-
-    /**
-     * Gets the parent section
-     *
-     * @return EE_Form_Section_Proper
-     */
-    public function parent_section()
-    {
-        return $this->_parent_section;
-    }
-
-
-    /**
-     * returns HTML for generating the opening form HTML tag (<form>)
-     *
-     * @param string $action           the URL the form is submitted to
-     * @param string $method           POST (default) or GET
-     * @param string $other_attributes anything else added to the form open tag, MUST BE VALID HTML
-     * @return string
-     * @throws EE_Error
-     */
-    public function form_open($action = '', $method = '', $other_attributes = '')
-    {
-        if (! empty($action)) {
-            $this->set_action($action);
-        }
-        if (! empty($method)) {
-            $this->set_method($method);
-        }
-        $html = EEH_HTML::nl(1, 'form') . '<form';
-        $html .= $this->html_id() !== '' ? ' id="' . $this->get_html_id_for_form($this->html_id()) . '"' : '';
-        $html .= ' action="' . $this->action() . '"';
-        $html .= ' method="' . $this->method() . '"';
-        $html .= ' name="' . $this->name() . '"';
-        $html .= $other_attributes . '>';
-        return $html;
-    }
-
-
-
-    /**
-     * ensures that html id for form either ends in "-form" or "-frm"
-     * so that id doesn't conflict/collide with other elements
-     *
-     * @param string $html_id
-     * @return string
-     */
-    protected function get_html_id_for_form($html_id)
-    {
-        $strlen = strlen($html_id);
-        $html_id = strpos($html_id, '-form') === $strlen-5 || strpos($html_id, '-frm') === $strlen - 4
-            ? $html_id
-            : $html_id . '-frm';
-        return $html_id;
-    }
-
-
-    /**
-     * returns HTML for generating the closing form HTML tag (</form>)
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function form_close()
-    {
-        return EEH_HTML::nl(-1, 'form')
-               . '</form>'
-               . EEH_HTML::nl()
-               . '<!-- end of ee-'
-               . $this->html_id()
-               . '-form -->'
-               . EEH_HTML::nl();
-    }
-
-
-
-    /**
-     * enqueues JS (and CSS) for the form (ie immediately call wp_enqueue_script and
-     * wp_enqueue_style; the scripts could have optionally been registered earlier)
-     * Default does nothing, but child classes can override
-     *
-     * @return void
-     */
-    public function enqueue_js()
-    {
-        //defaults to enqueue NO js or css
-    }
-
-
-
-    /**
-     * Adds any extra data needed by js. Eventually we'll call wp_localize_script
-     * with it, and it will be on each form section's 'other_data' property.
-     * By default nothing is added, but child classes can extend this method to add something.
-     * Eg, if you have an input that will cause a modal dialog to appear,
-     * here you could add an entry like 'modal_dialog_inputs' to this array
-     * to map between the input's html ID and the modal dialogue's ID, so that
-     * your JS code will know where to find the modal dialog when the input is pressed.
-     * Eg $form_other_js_data['modal_dialog_inputs']['some-input-id']='modal-dialog-id';
-     *
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data($form_other_js_data = array())
-    {
-        return $form_other_js_data;
-    }
-
-
-
-    /**
-     * This isn't just the name of an input, it's a path pointing to an input. The
-     * path is similar to a folder path: slash (/) means to descend into a subsection,
-     * dot-dot-slash (../) means to ascend into the parent section.
-     * After a series of slashes and dot-dot-slashes, there should be the name of an input,
-     * which will be returned.
-     * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
-     * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
-     * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
-     * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
-     * Etc
-     *
-     * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
-     * @return EE_Form_Section_Base
-     */
-    public function find_section_from_path($form_section_path)
-    {
-        if (strpos($form_section_path, '/') === 0) {
-            $form_section_path = substr($form_section_path, strlen('/'));
-        }
-        if (empty($form_section_path)) {
-            return $this;
-        }
-        if (strpos($form_section_path, '../') === 0) {
-            $parent = $this->parent_section();
-            $form_section_path = substr($form_section_path, strlen('../'));
-            if ($parent instanceof EE_Form_Section_Base) {
-                return $parent->find_section_from_path($form_section_path);
-            }
-            if (empty($form_section_path)) {
-                return $this;
-            }
-        }
-        //couldn't find it using simple parent following
-        return null;
-    }
+	/**
+	 * Gets the HTML for displaying this form section
+	 *
+	 * @return string
+	 */
+	abstract public function get_html();
+
+
+	/**
+	 * @param bool $add_pound_sign
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_id($add_pound_sign = false)
+	{
+		$this->_set_default_html_id_if_empty();
+		return $add_pound_sign ? '#' . $this->_html_id : $this->_html_id;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_class()
+	{
+		return $this->_html_class;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_style()
+	{
+		return $this->_html_style;
+	}
+
+
+
+	/**
+	 * @param mixed $html_class
+	 */
+	public function set_html_class($html_class)
+	{
+		$this->_html_class = $html_class;
+	}
+
+
+
+	/**
+	 * @param mixed $html_id
+	 */
+	public function set_html_id($html_id)
+	{
+		$this->_html_id = $html_id;
+	}
+
+
+
+	/**
+	 * @param mixed $html_style
+	 */
+	public function set_html_style($html_style)
+	{
+		$this->_html_style = $html_style;
+	}
+
+
+
+	/**
+	 * @param string $other_html_attributes
+	 */
+	public function set_other_html_attributes($other_html_attributes)
+	{
+		$this->_other_html_attributes = $other_html_attributes;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function other_html_attributes()
+	{
+		return $this->_other_html_attributes;
+	}
+
+
+
+	/**
+	 * Gets the name of the form section. This is not the same as the HTML name.
+	 *
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function name()
+	{
+		if (! $this->_construction_finalized) {
+			throw new EE_Error(sprintf(__('You cannot use the form section\s name until _construct_finalize has been called on it (when we set the name). It was called on a form section of type \'s\'',
+				'event_espresso'), get_class($this)));
+		}
+		return $this->_name;
+	}
+
+
+
+	/**
+	 * Gets the parent section
+	 *
+	 * @return EE_Form_Section_Proper
+	 */
+	public function parent_section()
+	{
+		return $this->_parent_section;
+	}
+
+
+	/**
+	 * returns HTML for generating the opening form HTML tag (<form>)
+	 *
+	 * @param string $action           the URL the form is submitted to
+	 * @param string $method           POST (default) or GET
+	 * @param string $other_attributes anything else added to the form open tag, MUST BE VALID HTML
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function form_open($action = '', $method = '', $other_attributes = '')
+	{
+		if (! empty($action)) {
+			$this->set_action($action);
+		}
+		if (! empty($method)) {
+			$this->set_method($method);
+		}
+		$html = EEH_HTML::nl(1, 'form') . '<form';
+		$html .= $this->html_id() !== '' ? ' id="' . $this->get_html_id_for_form($this->html_id()) . '"' : '';
+		$html .= ' action="' . $this->action() . '"';
+		$html .= ' method="' . $this->method() . '"';
+		$html .= ' name="' . $this->name() . '"';
+		$html .= $other_attributes . '>';
+		return $html;
+	}
+
+
+
+	/**
+	 * ensures that html id for form either ends in "-form" or "-frm"
+	 * so that id doesn't conflict/collide with other elements
+	 *
+	 * @param string $html_id
+	 * @return string
+	 */
+	protected function get_html_id_for_form($html_id)
+	{
+		$strlen = strlen($html_id);
+		$html_id = strpos($html_id, '-form') === $strlen-5 || strpos($html_id, '-frm') === $strlen - 4
+			? $html_id
+			: $html_id . '-frm';
+		return $html_id;
+	}
+
+
+	/**
+	 * returns HTML for generating the closing form HTML tag (</form>)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function form_close()
+	{
+		return EEH_HTML::nl(-1, 'form')
+			   . '</form>'
+			   . EEH_HTML::nl()
+			   . '<!-- end of ee-'
+			   . $this->html_id()
+			   . '-form -->'
+			   . EEH_HTML::nl();
+	}
+
+
+
+	/**
+	 * enqueues JS (and CSS) for the form (ie immediately call wp_enqueue_script and
+	 * wp_enqueue_style; the scripts could have optionally been registered earlier)
+	 * Default does nothing, but child classes can override
+	 *
+	 * @return void
+	 */
+	public function enqueue_js()
+	{
+		//defaults to enqueue NO js or css
+	}
+
+
+
+	/**
+	 * Adds any extra data needed by js. Eventually we'll call wp_localize_script
+	 * with it, and it will be on each form section's 'other_data' property.
+	 * By default nothing is added, but child classes can extend this method to add something.
+	 * Eg, if you have an input that will cause a modal dialog to appear,
+	 * here you could add an entry like 'modal_dialog_inputs' to this array
+	 * to map between the input's html ID and the modal dialogue's ID, so that
+	 * your JS code will know where to find the modal dialog when the input is pressed.
+	 * Eg $form_other_js_data['modal_dialog_inputs']['some-input-id']='modal-dialog-id';
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data($form_other_js_data = array())
+	{
+		return $form_other_js_data;
+	}
+
+
+
+	/**
+	 * This isn't just the name of an input, it's a path pointing to an input. The
+	 * path is similar to a folder path: slash (/) means to descend into a subsection,
+	 * dot-dot-slash (../) means to ascend into the parent section.
+	 * After a series of slashes and dot-dot-slashes, there should be the name of an input,
+	 * which will be returned.
+	 * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
+	 * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
+	 * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
+	 * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
+	 * Etc
+	 *
+	 * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
+	 * @return EE_Form_Section_Base
+	 */
+	public function find_section_from_path($form_section_path)
+	{
+		if (strpos($form_section_path, '/') === 0) {
+			$form_section_path = substr($form_section_path, strlen('/'));
+		}
+		if (empty($form_section_path)) {
+			return $this;
+		}
+		if (strpos($form_section_path, '../') === 0) {
+			$parent = $this->parent_section();
+			$form_section_path = substr($form_section_path, strlen('../'));
+			if ($parent instanceof EE_Form_Section_Base) {
+				return $parent->find_section_from_path($form_section_path);
+			}
+			if (empty($form_section_path)) {
+				return $this;
+			}
+		}
+		//couldn't find it using simple parent following
+		return null;
+	}
 
 
 }

Spacing +17 added lines, -17 removed lines

@@ -3,7 +3,7 @@ 
 use EventEspresso\core\exceptions\InvalidDataTypeException;
 use EventEspresso\core\libraries\form_sections\strategies\filter\FormHtmlFilter;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -101,10 +101,10 @@ 
         // used by display strategies
         // assign incoming values to properties
         foreach ($options_array as $key => $value) {
-            $key = '_' . $key;
+            $key = '_'.$key;
             if (property_exists($this, $key) && empty($this->{$key})) {
                 $this->{$key} = $value;
-                if($key === '_subsections' && ! is_array($value)) {
+                if ($key === '_subsections' && ! is_array($value)) {
                     throw new InvalidDataTypeException($key, $value, 'array');
                 }
             }
@@ -141,7 +141,7 @@ 
      */
     public function ensure_construct_finalized_called()
     {
-        if (! $this->_construction_finalized) {
+        if ( ! $this->_construction_finalized) {
             $this->_construct_finalize($this->_parent_section, $this->_name);
         }
     }
@@ -204,7 +204,7 @@ 
      */
     protected function _set_default_html_id_if_empty()
     {
-        if (! $this->_html_id) {
+        if ( ! $this->_html_id) {
             if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
                 $this->_html_id = $this->_parent_section->html_id()
                                   . '-'
@@ -263,7 +263,7 @@ 
     public function html_id($add_pound_sign = false)
     {
         $this->_set_default_html_id_if_empty();
-        return $add_pound_sign ? '#' . $this->_html_id : $this->_html_id;
+        return $add_pound_sign ? '#'.$this->_html_id : $this->_html_id;
     }
 
 
@@ -346,7 +346,7 @@ 
      */
     public function name()
     {
-        if (! $this->_construction_finalized) {
+        if ( ! $this->_construction_finalized) {
             throw new EE_Error(sprintf(__('You cannot use the form section\s name until _construct_finalize has been called on it (when we set the name). It was called on a form section of type \'s\'',
                 'event_espresso'), get_class($this)));
         }
@@ -377,18 +377,18 @@ 
      */
     public function form_open($action = '', $method = '', $other_attributes = '')
     {
-        if (! empty($action)) {
+        if ( ! empty($action)) {
             $this->set_action($action);
         }
-        if (! empty($method)) {
+        if ( ! empty($method)) {
             $this->set_method($method);
         }
-        $html = EEH_HTML::nl(1, 'form') . '<form';
-        $html .= $this->html_id() !== '' ? ' id="' . $this->get_html_id_for_form($this->html_id()) . '"' : '';
-        $html .= ' action="' . $this->action() . '"';
-        $html .= ' method="' . $this->method() . '"';
-        $html .= ' name="' . $this->name() . '"';
-        $html .= $other_attributes . '>';
+        $html = EEH_HTML::nl(1, 'form').'<form';
+        $html .= $this->html_id() !== '' ? ' id="'.$this->get_html_id_for_form($this->html_id()).'"' : '';
+        $html .= ' action="'.$this->action().'"';
+        $html .= ' method="'.$this->method().'"';
+        $html .= ' name="'.$this->name().'"';
+        $html .= $other_attributes.'>';
         return $html;
     }
 
@@ -404,9 +404,9 @@ 
     protected function get_html_id_for_form($html_id)
     {
         $strlen = strlen($html_id);
-        $html_id = strpos($html_id, '-form') === $strlen-5 || strpos($html_id, '-frm') === $strlen - 4
+        $html_id = strpos($html_id, '-form') === $strlen - 5 || strpos($html_id, '-frm') === $strlen - 4
             ? $html_id
-            : $html_id . '-frm';
+            : $html_id.'-frm';
         return $html_id;
     }
 

core/EE_Module_Request_Router.core.php

Indentation +227 added lines, -227 removed lines

@@ -17,256 +17,256 @@
 final class EE_Module_Request_Router implements InterminableInterface
 {
 
-    /**
-     * @var EE_Request $request
-     */
-    private $request;
+	/**
+	 * @var EE_Request $request
+	 */
+	private $request;
 
-    /**
-     * @var array $_previous_routes
-     */
-    private static $_previous_routes = array();
+	/**
+	 * @var array $_previous_routes
+	 */
+	private static $_previous_routes = array();
 
-    /**
-     * @var WP_Query $WP_Query
-     */
-    public $WP_Query;
+	/**
+	 * @var WP_Query $WP_Query
+	 */
+	public $WP_Query;
 
 
 
-    /**
-     * EE_Module_Request_Router constructor.
-     *
-     * @param EE_Request $request
-     */
-    public function __construct(EE_Request $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 * EE_Module_Request_Router constructor.
+	 *
+	 * @param EE_Request $request
+	 */
+	public function __construct(EE_Request $request)
+	{
+		$this->request = $request;
+	}
 
 
 
-    /**
-     * on the first call  to this method, it checks the EE_Request_Handler for a "route"
-     * on subsequent calls to this method,
-     * instead of checking the EE_Request_Handler for a route, it checks the previous routes array,
-     * and checks if the last called route has any forwarding routes registered for it
-     *
-     * @param WP_Query $WP_Query
-     * @return NULL|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_route(WP_Query $WP_Query)
-    {
-        $this->WP_Query = $WP_Query;
-        // assume this if first route being called
-        $previous_route = false;
-        // but is it really ???
-        if (! empty(self::$_previous_routes)) {
-            // get last run route
-            $previous_routes = array_values(self::$_previous_routes);
-            $previous_route = array_pop($previous_routes);
-        }
-        //  has another route already been run ?
-        if ($previous_route) {
-            // check if  forwarding has been set
-            $current_route = $this->get_forward($previous_route);
-            try {
-                //check for recursive forwarding
-                if (isset(self::$_previous_routes[$current_route])) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'An error occurred. The %s route has already been called, and therefore can not be forwarded to, because an infinite loop would be created and break the interweb.',
-                                'event_espresso'
-                            ),
-                            $current_route
-                        )
-                    );
-                }
-            } catch (EE_Error $e) {
-                $e->get_error();
-                return null;
-            }
-        } else {
-            // first route called
-            $current_route = null;
-            // grab all routes
-            $routes = EE_Config::get_routes();
-            foreach ($routes as $key => $route) {
-                // first determine if route key uses w?ldc*rds
-                $uses_wildcards = strpos($key, '?') !== false
-                                  || strpos($key, '*') !== false;
-                // check request for module route
-                $route_found = $uses_wildcards
-                    ? $this->request->matches($key)
-                    : $this->request->is_set($key);
-                if ($route_found) {
-                    $current_route = $uses_wildcards
-                        ? $this->request->getMatch($key)
-                        : $this->request->get($key);
-                    $current_route = sanitize_text_field($current_route);
-                    if ($current_route) {
-                        $current_route = array($key, $current_route);
-                        break;
-                    }
-                }
-            }
-        }
-        // sorry, but I can't read what you route !
-        if (empty($current_route)) {
-            return null;
-        }
-        //add route to previous routes array
-        self::$_previous_routes[] = $current_route;
-        return $current_route;
-    }
+	/**
+	 * on the first call  to this method, it checks the EE_Request_Handler for a "route"
+	 * on subsequent calls to this method,
+	 * instead of checking the EE_Request_Handler for a route, it checks the previous routes array,
+	 * and checks if the last called route has any forwarding routes registered for it
+	 *
+	 * @param WP_Query $WP_Query
+	 * @return NULL|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_route(WP_Query $WP_Query)
+	{
+		$this->WP_Query = $WP_Query;
+		// assume this if first route being called
+		$previous_route = false;
+		// but is it really ???
+		if (! empty(self::$_previous_routes)) {
+			// get last run route
+			$previous_routes = array_values(self::$_previous_routes);
+			$previous_route = array_pop($previous_routes);
+		}
+		//  has another route already been run ?
+		if ($previous_route) {
+			// check if  forwarding has been set
+			$current_route = $this->get_forward($previous_route);
+			try {
+				//check for recursive forwarding
+				if (isset(self::$_previous_routes[$current_route])) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'An error occurred. The %s route has already been called, and therefore can not be forwarded to, because an infinite loop would be created and break the interweb.',
+								'event_espresso'
+							),
+							$current_route
+						)
+					);
+				}
+			} catch (EE_Error $e) {
+				$e->get_error();
+				return null;
+			}
+		} else {
+			// first route called
+			$current_route = null;
+			// grab all routes
+			$routes = EE_Config::get_routes();
+			foreach ($routes as $key => $route) {
+				// first determine if route key uses w?ldc*rds
+				$uses_wildcards = strpos($key, '?') !== false
+								  || strpos($key, '*') !== false;
+				// check request for module route
+				$route_found = $uses_wildcards
+					? $this->request->matches($key)
+					: $this->request->is_set($key);
+				if ($route_found) {
+					$current_route = $uses_wildcards
+						? $this->request->getMatch($key)
+						: $this->request->get($key);
+					$current_route = sanitize_text_field($current_route);
+					if ($current_route) {
+						$current_route = array($key, $current_route);
+						break;
+					}
+				}
+			}
+		}
+		// sorry, but I can't read what you route !
+		if (empty($current_route)) {
+			return null;
+		}
+		//add route to previous routes array
+		self::$_previous_routes[] = $current_route;
+		return $current_route;
+	}
 
 
 
-    /**
-     * this method simply takes a valid route, and resolves what module class method the route points to
-     *
-     * @param string $key
-     * @param string $current_route
-     * @return mixed EED_Module | boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function resolve_route($key, $current_route)
-    {
-        // get module method that route has been mapped to
-        $module_method = EE_Config::get_route($current_route, $key);
-        // verify result was returned
-        if (empty($module_method)) {
-            $msg = sprintf(
-                __('The requested route %s could not be mapped to any registered modules.', 'event_espresso'),
-                $current_route
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // verify that result is an array
-        if (! is_array($module_method)) {
-            $msg = sprintf(__('The %s  route has not been properly registered.', 'event_espresso'), $current_route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // grab module name
-        $module_name = $module_method[0];
-        // verify that a class method was registered properly
-        if (! isset($module_method[1])) {
-            $msg = sprintf(
-                __('A class method for the %s  route has not been properly registered.', 'event_espresso'),
-                $current_route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // grab method
-        $method = $module_method[1];
-        // verify that class exists
-        if (! class_exists($module_name)) {
-            $msg = sprintf(__('The requested %s class could not be found.', 'event_espresso'), $module_name);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // verify that method exists
-        if (! method_exists($module_name, $method)) {
-            $msg = sprintf(
-                __('The class method %s for the %s route is in invalid.', 'event_espresso'), $method, $current_route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // instantiate module and call route method
-        return $this->_module_router($module_name, $method);
-    }
+	/**
+	 * this method simply takes a valid route, and resolves what module class method the route points to
+	 *
+	 * @param string $key
+	 * @param string $current_route
+	 * @return mixed EED_Module | boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function resolve_route($key, $current_route)
+	{
+		// get module method that route has been mapped to
+		$module_method = EE_Config::get_route($current_route, $key);
+		// verify result was returned
+		if (empty($module_method)) {
+			$msg = sprintf(
+				__('The requested route %s could not be mapped to any registered modules.', 'event_espresso'),
+				$current_route
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// verify that result is an array
+		if (! is_array($module_method)) {
+			$msg = sprintf(__('The %s  route has not been properly registered.', 'event_espresso'), $current_route);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// grab module name
+		$module_name = $module_method[0];
+		// verify that a class method was registered properly
+		if (! isset($module_method[1])) {
+			$msg = sprintf(
+				__('A class method for the %s  route has not been properly registered.', 'event_espresso'),
+				$current_route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// grab method
+		$method = $module_method[1];
+		// verify that class exists
+		if (! class_exists($module_name)) {
+			$msg = sprintf(__('The requested %s class could not be found.', 'event_espresso'), $module_name);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// verify that method exists
+		if (! method_exists($module_name, $method)) {
+			$msg = sprintf(
+				__('The class method %s for the %s route is in invalid.', 'event_espresso'), $method, $current_route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// instantiate module and call route method
+		return $this->_module_router($module_name, $method);
+	}
 
 
 
-    /**
-     * this method instantiates modules and calls the method that was defined when the route was registered
-     *
-     * @param string $module_name
-     * @return EED_Module|object|null
-     * @throws ReflectionException
-     */
-    public static function module_factory($module_name)
-    {
-        if ($module_name === 'EED_Module') {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'EED_Module is an abstract parent class an can not be instantiated. Please provide a proper module name.',
-                        'event_espresso'
-                    ), $module_name
-                ), __FILE__, __FUNCTION__, __LINE__
-            );
-            return null;
-        }
-        // instantiate module class
-        $module = new $module_name();
-        // ensure that class is actually a module
-        if (! $module instanceof EED_Module) {
-            EE_Error::add_error(
-                sprintf(__('The requested %s module is not of the class EED_Module.', 'event_espresso'), $module_name),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return null;
-        }
-        return $module;
-    }
+	/**
+	 * this method instantiates modules and calls the method that was defined when the route was registered
+	 *
+	 * @param string $module_name
+	 * @return EED_Module|object|null
+	 * @throws ReflectionException
+	 */
+	public static function module_factory($module_name)
+	{
+		if ($module_name === 'EED_Module') {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'EED_Module is an abstract parent class an can not be instantiated. Please provide a proper module name.',
+						'event_espresso'
+					), $module_name
+				), __FILE__, __FUNCTION__, __LINE__
+			);
+			return null;
+		}
+		// instantiate module class
+		$module = new $module_name();
+		// ensure that class is actually a module
+		if (! $module instanceof EED_Module) {
+			EE_Error::add_error(
+				sprintf(__('The requested %s module is not of the class EED_Module.', 'event_espresso'), $module_name),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return null;
+		}
+		return $module;
+	}
 
 
 
-    /**
-     * this method instantiates modules and calls the method that was defined when the route was registered
-     *
-     * @param string $module_name
-     * @param string $method
-     * @return EED_Module|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _module_router($module_name, $method)
-    {
-        // instantiate module class
-        $module = EE_Module_Request_Router::module_factory($module_name);
-        if ($module instanceof EED_Module) {
-            // and call whatever action the route was for
-            try {
-                call_user_func(array($module, $method), $this->WP_Query);
-            } catch (EE_Error $e) {
-                $e->get_error();
-                return null;
-            }
-        }
-        return $module;
-    }
+	/**
+	 * this method instantiates modules and calls the method that was defined when the route was registered
+	 *
+	 * @param string $module_name
+	 * @param string $method
+	 * @return EED_Module|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _module_router($module_name, $method)
+	{
+		// instantiate module class
+		$module = EE_Module_Request_Router::module_factory($module_name);
+		if ($module instanceof EED_Module) {
+			// and call whatever action the route was for
+			try {
+				call_user_func(array($module, $method), $this->WP_Query);
+			} catch (EE_Error $e) {
+				$e->get_error();
+				return null;
+			}
+		}
+		return $module;
+	}
 
 
 
-    /**
-     * @param $current_route
-     * @return string
-     */
-    public function get_forward($current_route)
-    {
-        return EE_Config::get_forward($current_route);
-    }
+	/**
+	 * @param $current_route
+	 * @return string
+	 */
+	public function get_forward($current_route)
+	{
+		return EE_Config::get_forward($current_route);
+	}
 
 
 
-    /**
-     * @param $current_route
-     * @return string
-     */
-    public function get_view($current_route)
-    {
-        return EE_Config::get_view($current_route);
-    }
+	/**
+	 * @param $current_route
+	 * @return string
+	 */
+	public function get_view($current_route)
+	{
+		return EE_Config::get_view($current_route);
+	}
 
 
 }

caffeinated/modules/recaptcha_invisible/EED_Recaptcha_Invisible.module.php

Indentation +301 added lines, -301 removed lines

@@ -22,305 +22,305 @@
 class EED_Recaptcha_Invisible extends EED_Module
 {
 
-    /**
-     * @var EE_Registration_Config $config
-     */
-    private static $config;
-
-
-    /**
-     * @return EED_Module|EED_Recaptcha
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public static function set_hooks()
-    {
-        EED_Recaptcha_Invisible::setProperties();
-        if (EED_Recaptcha_Invisible::useInvisibleRecaptcha()) {
-            // ticket selection
-            add_filter(
-                'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
-                array('EED_Recaptcha_Invisible', 'ticketSelectorForm'),
-                10, 2
-            );
-            add_action(
-                'EED_Ticket_Selector__process_ticket_selections__before',
-                array('EED_Recaptcha_Invisible', 'processTicketSelectorForm')
-            );
-            // checkout
-            add_action(
-                'AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form',
-                array('EED_Recaptcha_Invisible', 'spcoRegStepForm')
-            );
-            add_filter(
-                'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
-                array('EED_Recaptcha_Invisible', 'receiveSpcoRegStepForm'),
-                10, 2
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public static function set_hooks_admin()
-    {
-        // admin settings
-        add_action(
-            'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
-            array('EED_Recaptcha_Invisible', 'adminSettings')
-        );
-        add_filter(
-            'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
-            array('EED_Recaptcha_Invisible', 'updateAdminSettings')
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public static function setProperties()
-    {
-        EED_Recaptcha_Invisible::$config = EE_Registry::instance()->CFG->registration;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public static function useInvisibleRecaptcha()
-    {
-        return EED_Recaptcha_Invisible::$config->use_captcha
-               && EED_Recaptcha_Invisible::$config->recaptcha_theme === 'invisible';
-    }
-
-
-    /**
-     * @return string
-     */
-    public static function assetsUrl()
-    {
-        return plugin_dir_url(__FILE__) . 'assets' . DS;
-    }
-
-
-    /**
-     * @param \WP $WP
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * @return boolean
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public static function recaptchaPassed()
-    {
-        // logged in means you have already passed a turing test of sorts
-        if (EED_Recaptcha_Invisible::useInvisibleRecaptcha() === false || is_user_logged_in()) {
-            return true;
-        }
-        // was test already passed?
-        return filter_var(
-            EE_Registry::instance()->SSN->get_session_data(
-                InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * @param EE_Request $request
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     */
-    public static function verifyToken(EE_Request $request)
-    {
-        $invisible_recaptcha = RecaptchaFactory::create();
-        if ($invisible_recaptcha->verifyToken($request)) {
-            add_action('shutdown', array('EED_Recaptcha_Invisible', 'setSessionData'));
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper $reg_form
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function spcoRegStepForm(EE_Form_Section_Proper $reg_form)
-    {
-        // do nothing if form isn't for a reg step or test has already been passed
-        if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
-            return;
-        }
-        $default_hidden_inputs = $reg_form->get_subsection('default_hidden_inputs');
-        if ($default_hidden_inputs instanceof EE_Form_Section_Proper) {
-            $invisible_recaptcha = RecaptchaFactory::create();
-            $invisible_recaptcha->addToFormSection($default_hidden_inputs);
-        }
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper $reg_form
-     * @return bool
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public static function processSpcoRegStepForm(EE_Form_Section_Proper $reg_form)
-    {
-        return strpos($reg_form->name(), 'reg-step-form') === false || EED_Recaptcha_Invisible::recaptchaPassed();
-    }
-
-
-    /**
-     * @param array|null             $req_data
-     * @param EE_Form_Section_Proper $reg_form
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     */
-    public static function receiveSpcoRegStepForm($req_data = array(), EE_Form_Section_Proper $reg_form)
-    {
-        // do nothing if form isn't for a reg step or test has already been passed
-        if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
-            return $req_data;
-        }
-        /** @var EE_Request $request */
-        $request = LoaderFactory::getLoader()->getShared('EE_Request');
-        if (! EED_Recaptcha_Invisible::verifyToken($request)) {
-            if ($request->isAjax()) {
-                $json_response = new EE_SPCO_JSON_Response();
-                $json_response->echoAndExit();
-            }
-            EEH_URL::safeRedirectAndExit(
-                EE_Registry::instance()->CFG->core->reg_page_url()
-            );
-        }
-        return $req_data;
-    }
-
-
-    /**
-     * @param string   $html
-     * @param EE_Event $event
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     */
-    public static function ticketSelectorForm($html = '', EE_Event $event)
-    {
-        // do nothing if test has  already  been passed
-        if (EED_Recaptcha_Invisible::recaptchaPassed()) {
-            return $html;
-        }
-        $html .= RecaptchaFactory::create()->getInputHtml(
-            array('recaptcha_id' => $event->ID())
-        );
-        return $html;
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws RuntimeException
-     */
-    public static function processTicketSelectorForm()
-    {
-        // do nothing if test has  already  been passed
-        if (EED_Recaptcha_Invisible::recaptchaPassed()) {
-            return;
-        }
-        /** @var EE_Request $request */
-        $request = LoaderFactory::getLoader()->getShared('EE_Request');
-        if (! EED_Recaptcha_Invisible::verifyToken($request)) {
-            $event_id   = $request->get('tkt-slctr-event-id');
-            $return_url = $request->is_set("tkt-slctr-return-url-{$event_id}")
-                ? $request->get("tkt-slctr-return-url-{$event_id}")
-                : get_permalink($event_id);
-            EEH_URL::safeRedirectAndExit($return_url);
-        }
-    }
-
-
-    /**
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function setSessionData()
-    {
-        EE_Registry::instance()->SSN->set_session_data(
-            array(InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED => true)
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function adminSettings()
-    {
-        RecaptchaFactory::getAdminModule()->adminSettings();
-    }
-
-
-    /**
-     * @param EE_Registration_Config $EE_Registration_Config
-     * @return EE_Registration_Config
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function updateAdminSettings(EE_Registration_Config $EE_Registration_Config)
-    {
-        return RecaptchaFactory::getAdminModule()->updateAdminSettings($EE_Registration_Config);
-    }
+	/**
+	 * @var EE_Registration_Config $config
+	 */
+	private static $config;
+
+
+	/**
+	 * @return EED_Module|EED_Recaptcha
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public static function set_hooks()
+	{
+		EED_Recaptcha_Invisible::setProperties();
+		if (EED_Recaptcha_Invisible::useInvisibleRecaptcha()) {
+			// ticket selection
+			add_filter(
+				'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
+				array('EED_Recaptcha_Invisible', 'ticketSelectorForm'),
+				10, 2
+			);
+			add_action(
+				'EED_Ticket_Selector__process_ticket_selections__before',
+				array('EED_Recaptcha_Invisible', 'processTicketSelectorForm')
+			);
+			// checkout
+			add_action(
+				'AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form',
+				array('EED_Recaptcha_Invisible', 'spcoRegStepForm')
+			);
+			add_filter(
+				'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
+				array('EED_Recaptcha_Invisible', 'receiveSpcoRegStepForm'),
+				10, 2
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public static function set_hooks_admin()
+	{
+		// admin settings
+		add_action(
+			'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
+			array('EED_Recaptcha_Invisible', 'adminSettings')
+		);
+		add_filter(
+			'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
+			array('EED_Recaptcha_Invisible', 'updateAdminSettings')
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public static function setProperties()
+	{
+		EED_Recaptcha_Invisible::$config = EE_Registry::instance()->CFG->registration;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public static function useInvisibleRecaptcha()
+	{
+		return EED_Recaptcha_Invisible::$config->use_captcha
+			   && EED_Recaptcha_Invisible::$config->recaptcha_theme === 'invisible';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function assetsUrl()
+	{
+		return plugin_dir_url(__FILE__) . 'assets' . DS;
+	}
+
+
+	/**
+	 * @param \WP $WP
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public static function recaptchaPassed()
+	{
+		// logged in means you have already passed a turing test of sorts
+		if (EED_Recaptcha_Invisible::useInvisibleRecaptcha() === false || is_user_logged_in()) {
+			return true;
+		}
+		// was test already passed?
+		return filter_var(
+			EE_Registry::instance()->SSN->get_session_data(
+				InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * @param EE_Request $request
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 */
+	public static function verifyToken(EE_Request $request)
+	{
+		$invisible_recaptcha = RecaptchaFactory::create();
+		if ($invisible_recaptcha->verifyToken($request)) {
+			add_action('shutdown', array('EED_Recaptcha_Invisible', 'setSessionData'));
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper $reg_form
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function spcoRegStepForm(EE_Form_Section_Proper $reg_form)
+	{
+		// do nothing if form isn't for a reg step or test has already been passed
+		if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
+			return;
+		}
+		$default_hidden_inputs = $reg_form->get_subsection('default_hidden_inputs');
+		if ($default_hidden_inputs instanceof EE_Form_Section_Proper) {
+			$invisible_recaptcha = RecaptchaFactory::create();
+			$invisible_recaptcha->addToFormSection($default_hidden_inputs);
+		}
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper $reg_form
+	 * @return bool
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public static function processSpcoRegStepForm(EE_Form_Section_Proper $reg_form)
+	{
+		return strpos($reg_form->name(), 'reg-step-form') === false || EED_Recaptcha_Invisible::recaptchaPassed();
+	}
+
+
+	/**
+	 * @param array|null             $req_data
+	 * @param EE_Form_Section_Proper $reg_form
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 */
+	public static function receiveSpcoRegStepForm($req_data = array(), EE_Form_Section_Proper $reg_form)
+	{
+		// do nothing if form isn't for a reg step or test has already been passed
+		if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
+			return $req_data;
+		}
+		/** @var EE_Request $request */
+		$request = LoaderFactory::getLoader()->getShared('EE_Request');
+		if (! EED_Recaptcha_Invisible::verifyToken($request)) {
+			if ($request->isAjax()) {
+				$json_response = new EE_SPCO_JSON_Response();
+				$json_response->echoAndExit();
+			}
+			EEH_URL::safeRedirectAndExit(
+				EE_Registry::instance()->CFG->core->reg_page_url()
+			);
+		}
+		return $req_data;
+	}
+
+
+	/**
+	 * @param string   $html
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 */
+	public static function ticketSelectorForm($html = '', EE_Event $event)
+	{
+		// do nothing if test has  already  been passed
+		if (EED_Recaptcha_Invisible::recaptchaPassed()) {
+			return $html;
+		}
+		$html .= RecaptchaFactory::create()->getInputHtml(
+			array('recaptcha_id' => $event->ID())
+		);
+		return $html;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws RuntimeException
+	 */
+	public static function processTicketSelectorForm()
+	{
+		// do nothing if test has  already  been passed
+		if (EED_Recaptcha_Invisible::recaptchaPassed()) {
+			return;
+		}
+		/** @var EE_Request $request */
+		$request = LoaderFactory::getLoader()->getShared('EE_Request');
+		if (! EED_Recaptcha_Invisible::verifyToken($request)) {
+			$event_id   = $request->get('tkt-slctr-event-id');
+			$return_url = $request->is_set("tkt-slctr-return-url-{$event_id}")
+				? $request->get("tkt-slctr-return-url-{$event_id}")
+				: get_permalink($event_id);
+			EEH_URL::safeRedirectAndExit($return_url);
+		}
+	}
+
+
+	/**
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function setSessionData()
+	{
+		EE_Registry::instance()->SSN->set_session_data(
+			array(InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED => true)
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function adminSettings()
+	{
+		RecaptchaFactory::getAdminModule()->adminSettings();
+	}
+
+
+	/**
+	 * @param EE_Registration_Config $EE_Registration_Config
+	 * @return EE_Registration_Config
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function updateAdminSettings(EE_Registration_Config $EE_Registration_Config)
+	{
+		return RecaptchaFactory::getAdminModule()->updateAdminSettings($EE_Registration_Config);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -118,7 +118,7 @@ 
      */
     public static function assetsUrl()
     {
-        return plugin_dir_url(__FILE__) . 'assets' . DS;
+        return plugin_dir_url(__FILE__).'assets'.DS;
     }
 
 
@@ -182,7 +182,7 @@ 
     public static function spcoRegStepForm(EE_Form_Section_Proper $reg_form)
     {
         // do nothing if form isn't for a reg step or test has already been passed
-        if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
+        if ( ! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
             return;
         }
         $default_hidden_inputs = $reg_form->get_subsection('default_hidden_inputs');
@@ -220,12 +220,12 @@ 
     public static function receiveSpcoRegStepForm($req_data = array(), EE_Form_Section_Proper $reg_form)
     {
         // do nothing if form isn't for a reg step or test has already been passed
-        if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
+        if ( ! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
             return $req_data;
         }
         /** @var EE_Request $request */
         $request = LoaderFactory::getLoader()->getShared('EE_Request');
-        if (! EED_Recaptcha_Invisible::verifyToken($request)) {
+        if ( ! EED_Recaptcha_Invisible::verifyToken($request)) {
             if ($request->isAjax()) {
                 $json_response = new EE_SPCO_JSON_Response();
                 $json_response->echoAndExit();
@@ -275,7 +275,7 @@ 
         }
         /** @var EE_Request $request */
         $request = LoaderFactory::getLoader()->getShared('EE_Request');
-        if (! EED_Recaptcha_Invisible::verifyToken($request)) {
+        if ( ! EED_Recaptcha_Invisible::verifyToken($request)) {
             $event_id   = $request->get('tkt-slctr-event-id');
             $return_url = $request->is_set("tkt-slctr-return-url-{$event_id}")
                 ? $request->get("tkt-slctr-return-url-{$event_id}")

caffeinated/modules/recaptcha_invisible/InvisibleRecaptcha.php

Indentation +150 added lines, -150 removed lines

@@ -29,154 +29,154 @@
 class InvisibleRecaptcha
 {
 
-    const URL_GOOGLE_RECAPTCHA_API          = 'https://www.google.com/recaptcha/api/siteverify';
-
-    const SESSION_DATA_KEY_RECAPTCHA_PASSED = 'recaptcha_passed';
-
-    /**
-     * @var EE_Registration_Config $config
-     */
-    private $config;
-
-
-    /**
-     * InvisibleRecaptcha constructor.
-     *
-     * @param EE_Registration_Config $registration_config
-     */
-    public function __construct(EE_Registration_Config $registration_config)
-    {
-        $this->config = $registration_config;
-    }
-
-
-    /**
-     * @param array $input_settings
-     * @return EE_Invisible_Recaptcha_Input
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function getInput(array $input_settings = array())
-    {
-        return new EE_Invisible_Recaptcha_Input(
-            $input_settings,
-            $this->config
-        );
-    }
-
-
-    /**
-     * @param array $input_settings
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function getInputHtml(array $input_settings = array())
-    {
-        return $this->getInput($input_settings)->get_html_for_input();
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper $form
-     * @param array                  $input_settings
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function addToFormSection(EE_Form_Section_Proper $form, array $input_settings = array())
-    {
-        $form->add_subsections(
-            array(
-                'espresso_recaptcha' => $this->getInput($input_settings),
-            ),
-            null,
-            false
-        );
-    }
-
-
-    /**
-     * @param EE_Request $request
-     * @return boolean
-     * @throws RuntimeException
-     */
-    public function verifyToken(EE_Request $request)
-    {
-        static $previous_recaptcha_response = array();
-        $grecaptcha_response = $request->get('g-recaptcha-response');
-        // if this token has already been verified, then return previous response
-        if (isset($previous_recaptcha_response[ $grecaptcha_response ])) {
-            return $previous_recaptcha_response[ $grecaptcha_response ];
-        }
-        // will update to true if everything passes
-        $previous_recaptcha_response[ $grecaptcha_response ] = false;
-        $response                                            = wp_safe_remote_post(
-            InvisibleRecaptcha::URL_GOOGLE_RECAPTCHA_API,
-            array(
-                'body' => array(
-                    'secret'   => $this->config->recaptcha_privatekey,
-                    'response' => $grecaptcha_response,
-                    'remoteip' => $request->ip_address(),
-                ),
-            )
-        );
-        if ($response instanceof WP_Error) {
-            $this->generateError($response->get_error_messages());
-            return false;
-        }
-        $results = json_decode(wp_remote_retrieve_body($response), true);
-        if (filter_var($results['success'], FILTER_VALIDATE_BOOLEAN) !== true) {
-            $errors   = array_map(
-                array($this, 'getErrorCode'),
-                $results['error-codes']
-            );
-            $errors[] = 'challenge timestamp: ' . $results['challenge_ts'] . '.';
-            $this->generateError(implode(' ', $errors));
-        }
-        $previous_recaptcha_response[ $grecaptcha_response ] = true;
-        return true;
-    }
-
-
-    /**
-     * @param string $error_response
-     * @return void
-     * @throws RuntimeException
-     */
-    public function generateError($error_response = '')
-    {
-        throw new RuntimeException(
-            sprintf(
-                esc_html__(
-                    'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. %1$s %2$s Please try again.',
-                    'event_espresso'
-                ),
-                '<br />',
-                current_user_can('manage_options') ? $error_response : ''
-            )
-        );
-    }
-
-
-    /**
-     * @param string $error_code
-     * @return string
-     */
-    public function getErrorCode(&$error_code)
-    {
-        $error_codes = array(
-            'missing-input-secret'   => 'The secret parameter is missing.',
-            'invalid-input-secret'   => 'The secret parameter is invalid or malformed.',
-            'missing-input-response' => 'The response parameter is missing.',
-            'invalid-input-response' => 'The response parameter is invalid or malformed.',
-            'bad-request'            => 'The request is invalid or malformed.',
-            'timeout-or-duplicate'   => 'The request took too long to be sent or was a duplicate of a previous request.',
-        );
-        return isset($error_codes[ $error_code ]) ? $error_codes[ $error_code ] : '';
-    }
+	const URL_GOOGLE_RECAPTCHA_API          = 'https://www.google.com/recaptcha/api/siteverify';
+
+	const SESSION_DATA_KEY_RECAPTCHA_PASSED = 'recaptcha_passed';
+
+	/**
+	 * @var EE_Registration_Config $config
+	 */
+	private $config;
+
+
+	/**
+	 * InvisibleRecaptcha constructor.
+	 *
+	 * @param EE_Registration_Config $registration_config
+	 */
+	public function __construct(EE_Registration_Config $registration_config)
+	{
+		$this->config = $registration_config;
+	}
+
+
+	/**
+	 * @param array $input_settings
+	 * @return EE_Invisible_Recaptcha_Input
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function getInput(array $input_settings = array())
+	{
+		return new EE_Invisible_Recaptcha_Input(
+			$input_settings,
+			$this->config
+		);
+	}
+
+
+	/**
+	 * @param array $input_settings
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function getInputHtml(array $input_settings = array())
+	{
+		return $this->getInput($input_settings)->get_html_for_input();
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper $form
+	 * @param array                  $input_settings
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function addToFormSection(EE_Form_Section_Proper $form, array $input_settings = array())
+	{
+		$form->add_subsections(
+			array(
+				'espresso_recaptcha' => $this->getInput($input_settings),
+			),
+			null,
+			false
+		);
+	}
+
+
+	/**
+	 * @param EE_Request $request
+	 * @return boolean
+	 * @throws RuntimeException
+	 */
+	public function verifyToken(EE_Request $request)
+	{
+		static $previous_recaptcha_response = array();
+		$grecaptcha_response = $request->get('g-recaptcha-response');
+		// if this token has already been verified, then return previous response
+		if (isset($previous_recaptcha_response[ $grecaptcha_response ])) {
+			return $previous_recaptcha_response[ $grecaptcha_response ];
+		}
+		// will update to true if everything passes
+		$previous_recaptcha_response[ $grecaptcha_response ] = false;
+		$response                                            = wp_safe_remote_post(
+			InvisibleRecaptcha::URL_GOOGLE_RECAPTCHA_API,
+			array(
+				'body' => array(
+					'secret'   => $this->config->recaptcha_privatekey,
+					'response' => $grecaptcha_response,
+					'remoteip' => $request->ip_address(),
+				),
+			)
+		);
+		if ($response instanceof WP_Error) {
+			$this->generateError($response->get_error_messages());
+			return false;
+		}
+		$results = json_decode(wp_remote_retrieve_body($response), true);
+		if (filter_var($results['success'], FILTER_VALIDATE_BOOLEAN) !== true) {
+			$errors   = array_map(
+				array($this, 'getErrorCode'),
+				$results['error-codes']
+			);
+			$errors[] = 'challenge timestamp: ' . $results['challenge_ts'] . '.';
+			$this->generateError(implode(' ', $errors));
+		}
+		$previous_recaptcha_response[ $grecaptcha_response ] = true;
+		return true;
+	}
+
+
+	/**
+	 * @param string $error_response
+	 * @return void
+	 * @throws RuntimeException
+	 */
+	public function generateError($error_response = '')
+	{
+		throw new RuntimeException(
+			sprintf(
+				esc_html__(
+					'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. %1$s %2$s Please try again.',
+					'event_espresso'
+				),
+				'<br />',
+				current_user_can('manage_options') ? $error_response : ''
+			)
+		);
+	}
+
+
+	/**
+	 * @param string $error_code
+	 * @return string
+	 */
+	public function getErrorCode(&$error_code)
+	{
+		$error_codes = array(
+			'missing-input-secret'   => 'The secret parameter is missing.',
+			'invalid-input-secret'   => 'The secret parameter is invalid or malformed.',
+			'missing-input-response' => 'The response parameter is missing.',
+			'invalid-input-response' => 'The response parameter is invalid or malformed.',
+			'bad-request'            => 'The request is invalid or malformed.',
+			'timeout-or-duplicate'   => 'The request took too long to be sent or was a duplicate of a previous request.',
+		);
+		return isset($error_codes[ $error_code ]) ? $error_codes[ $error_code ] : '';
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -110,11 +110,11 @@ 
         static $previous_recaptcha_response = array();
         $grecaptcha_response = $request->get('g-recaptcha-response');
         // if this token has already been verified, then return previous response
-        if (isset($previous_recaptcha_response[ $grecaptcha_response ])) {
-            return $previous_recaptcha_response[ $grecaptcha_response ];
+        if (isset($previous_recaptcha_response[$grecaptcha_response])) {
+            return $previous_recaptcha_response[$grecaptcha_response];
         }
         // will update to true if everything passes
-        $previous_recaptcha_response[ $grecaptcha_response ] = false;
+        $previous_recaptcha_response[$grecaptcha_response] = false;
         $response                                            = wp_safe_remote_post(
             InvisibleRecaptcha::URL_GOOGLE_RECAPTCHA_API,
             array(
@@ -131,14 +131,14 @@ 
         }
         $results = json_decode(wp_remote_retrieve_body($response), true);
         if (filter_var($results['success'], FILTER_VALIDATE_BOOLEAN) !== true) {
-            $errors   = array_map(
+            $errors = array_map(
                 array($this, 'getErrorCode'),
                 $results['error-codes']
             );
-            $errors[] = 'challenge timestamp: ' . $results['challenge_ts'] . '.';
+            $errors[] = 'challenge timestamp: '.$results['challenge_ts'].'.';
             $this->generateError(implode(' ', $errors));
         }
-        $previous_recaptcha_response[ $grecaptcha_response ] = true;
+        $previous_recaptcha_response[$grecaptcha_response] = true;
         return true;
     }
 
@@ -177,6 +177,6 @@ 
             'bad-request'            => 'The request is invalid or malformed.',
             'timeout-or-duplicate'   => 'The request took too long to be sent or was a duplicate of a previous request.',
         );
-        return isset($error_codes[ $error_code ]) ? $error_codes[ $error_code ] : '';
+        return isset($error_codes[$error_code]) ? $error_codes[$error_code] : '';
     }
 }