eventespresso / event-espresso-core

core/services/context/ContextChecker.php

Spacing +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
     {
         $this->evaluation_callback = $evaluation_callback instanceof Closure
             ? $evaluation_callback
-            : function (ContextInterface $context, $acceptable_values) {
+            : function(ContextInterface $context, $acceptable_values) {
                 return in_array($context->slug(), $acceptable_values, true);
             };
     }

Indentation +141 added lines, -141 removed lines

@@ -17,145 +17,145 @@
 class ContextChecker
 {
 
-    /**
-     * A unique string used to identify where this ContextChecker is being employed
-     * Is currently only used within the hook name for the filterable return value of isAllowed().
-     *
-     * @var string $identifier
-     */
-    private $identifier;
-
-    /**
-     * A list of values to be compared against the slug of the Context class passed to isAllowed()
-     *
-     * @var array $acceptable_values
-     */
-    private $acceptable_values;
-
-    /**
-     * Closure that will be called to perform the evaluation within isAllowed().
-     * If none is provided, then a simple type sensitive in_array() check will be used
-     * and return true if the incoming Context::slug() is found within the array of $acceptable_values.
-     *
-     * @var Closure $evaluation_callback
-     */
-    private $evaluation_callback;
-
-
-    /**
-     * ContextChecker constructor.
-     *
-     * @param string       $identifier
-     * @param array        $acceptable_values
-     * @param Closure|null $evaluation_callback [optional]
-     */
-    public function __construct($identifier, array $acceptable_values, Closure $evaluation_callback = null)
-    {
-        $this->setIdentifier($identifier);
-        $this->setAcceptableValues($acceptable_values);
-        $this->setEvaluationCallback($evaluation_callback);
-    }
-
-
-    /**
-     * @param string $identifier
-     */
-    private function setIdentifier($identifier)
-    {
-        $this->identifier = sanitize_key($identifier);
-    }
-
-
-    /**
-     * @param array $acceptable_values
-     */
-    private function setAcceptableValues(array $acceptable_values)
-    {
-        $this->acceptable_values = $acceptable_values;
-    }
-
-
-    /**
-     * @param Closure $evaluation_callback
-     */
-    private function setEvaluationCallback(Closure $evaluation_callback = null)
-    {
-        $this->evaluation_callback = $evaluation_callback instanceof Closure
-            ? $evaluation_callback
-            : function (ContextInterface $context, $acceptable_values) {
-                return in_array($context->slug(), $acceptable_values, true);
-            };
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function identifier()
-    {
-        return $this->identifier;
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function acceptableValues()
-    {
-        return apply_filters(
-            "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__acceptableValues",
-            $this->acceptable_values
-        );
-    }
-
-
-    /**
-     * @return Closure
-     */
-    protected function evaluationCallback()
-    {
-        return $this->evaluation_callback;
-    }
-
-
-    /**
-     * Returns true if the incoming Context class slug matches one of the preset acceptable values.
-     * The result is filterable using the identifier for this ContextChecker.
-     * example:
-     * If this ContextChecker's $identifier was set to "registration-checkout-type",
-     * then the filter here would be named:
-     *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed".
-     * Other code could hook into the filter in isAllowed() using the above name
-     * and test for additional acceptable values.
-     * So if the set of $acceptable_values was: [ "initial-visit",  "revisit" ]
-     * then adding a filter to
-     *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed",
-     * would allow you to perform your own conditional and allow "wait-list-checkout" as an acceptable value.
-     *  example:
-     *      add_filter(
-     *          'FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed',
-     *          function ($is_allowed, ContextInterface $context) { return $context->slug() === 'wait-list-checkout'
-     *                  ? true
-     *                  : $is_allowed;
-     *          },
-     *          10,
-     *          2
-     *      );
-     *
-     * @param ContextInterface $context
-     * @return boolean
-     */
-    public function isAllowed(ContextInterface $context)
-    {
-        $evaluation_callback = $this->evaluationCallback();
-        return filter_var(
-            apply_filters(
-                "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__isAllowed",
-                $evaluation_callback($context, $this->acceptableValues()),
-                $context,
-                $this
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
+	/**
+	 * A unique string used to identify where this ContextChecker is being employed
+	 * Is currently only used within the hook name for the filterable return value of isAllowed().
+	 *
+	 * @var string $identifier
+	 */
+	private $identifier;
+
+	/**
+	 * A list of values to be compared against the slug of the Context class passed to isAllowed()
+	 *
+	 * @var array $acceptable_values
+	 */
+	private $acceptable_values;
+
+	/**
+	 * Closure that will be called to perform the evaluation within isAllowed().
+	 * If none is provided, then a simple type sensitive in_array() check will be used
+	 * and return true if the incoming Context::slug() is found within the array of $acceptable_values.
+	 *
+	 * @var Closure $evaluation_callback
+	 */
+	private $evaluation_callback;
+
+
+	/**
+	 * ContextChecker constructor.
+	 *
+	 * @param string       $identifier
+	 * @param array        $acceptable_values
+	 * @param Closure|null $evaluation_callback [optional]
+	 */
+	public function __construct($identifier, array $acceptable_values, Closure $evaluation_callback = null)
+	{
+		$this->setIdentifier($identifier);
+		$this->setAcceptableValues($acceptable_values);
+		$this->setEvaluationCallback($evaluation_callback);
+	}
+
+
+	/**
+	 * @param string $identifier
+	 */
+	private function setIdentifier($identifier)
+	{
+		$this->identifier = sanitize_key($identifier);
+	}
+
+
+	/**
+	 * @param array $acceptable_values
+	 */
+	private function setAcceptableValues(array $acceptable_values)
+	{
+		$this->acceptable_values = $acceptable_values;
+	}
+
+
+	/**
+	 * @param Closure $evaluation_callback
+	 */
+	private function setEvaluationCallback(Closure $evaluation_callback = null)
+	{
+		$this->evaluation_callback = $evaluation_callback instanceof Closure
+			? $evaluation_callback
+			: function (ContextInterface $context, $acceptable_values) {
+				return in_array($context->slug(), $acceptable_values, true);
+			};
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function identifier()
+	{
+		return $this->identifier;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function acceptableValues()
+	{
+		return apply_filters(
+			"FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__acceptableValues",
+			$this->acceptable_values
+		);
+	}
+
+
+	/**
+	 * @return Closure
+	 */
+	protected function evaluationCallback()
+	{
+		return $this->evaluation_callback;
+	}
+
+
+	/**
+	 * Returns true if the incoming Context class slug matches one of the preset acceptable values.
+	 * The result is filterable using the identifier for this ContextChecker.
+	 * example:
+	 * If this ContextChecker's $identifier was set to "registration-checkout-type",
+	 * then the filter here would be named:
+	 *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed".
+	 * Other code could hook into the filter in isAllowed() using the above name
+	 * and test for additional acceptable values.
+	 * So if the set of $acceptable_values was: [ "initial-visit",  "revisit" ]
+	 * then adding a filter to
+	 *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed",
+	 * would allow you to perform your own conditional and allow "wait-list-checkout" as an acceptable value.
+	 *  example:
+	 *      add_filter(
+	 *          'FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed',
+	 *          function ($is_allowed, ContextInterface $context) { return $context->slug() === 'wait-list-checkout'
+	 *                  ? true
+	 *                  : $is_allowed;
+	 *          },
+	 *          10,
+	 *          2
+	 *      );
+	 *
+	 * @param ContextInterface $context
+	 * @return boolean
+	 */
+	public function isAllowed(ContextInterface $context)
+	{
+		$evaluation_callback = $this->evaluationCallback();
+		return filter_var(
+			apply_filters(
+				"FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__isAllowed",
+				$evaluation_callback($context, $this->acceptableValues()),
+				$context,
+				$this
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
 }

core/domain/entities/contexts/ContextInterface.php

Indentation +8 added lines, -8 removed lines

@@ -18,14 +18,14 @@
 interface ContextInterface
 {
 
-    /**
-     * @return string
-     */
-    public function slug();
+	/**
+	 * @return string
+	 */
+	public function slug();
 
 
-    /**
-     * @return string
-     */
-    public function description();
+	/**
+	 * @return string
+	 */
+	public function description();
 }

core/db_models/EEM_Question.model.php

Doc Comments +2 added lines, -2 removed lines

@@ -364,7 +364,7 @@ 
      * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
      * which system question QST_ID corresponds to the QST_system 'city', use EEM_Question::instance()->get_Question_ID_from_system_string('city');
      * @param $QST_system
-     * @return int of QST_ID for the question that corresponds to that QST_system
+     * @return string of QST_ID for the question that corresponds to that QST_system
      */
     public function get_Question_ID_from_system_string($QST_system)
     {
@@ -425,7 +425,7 @@ 
 
 
     /**
-     * @return array
+     * @return EEM_Question
      */
     public function question_descriptions()
     {

acceptance_tests/tests/b-TestRegistrationSummaryCept.php

Indentation +41 added lines, -41 removed lines

@@ -14,8 +14,8 @@ 
 
 //need the MER plugin active for this test (we'll deactivate it after).
 $I->ensurePluginActive(
-    'event-espresso-mer-multi-event-registration',
-    'activated'
+	'event-espresso-mer-multi-event-registration',
+	'activated'
 );
 
 //k now we need to make sure the registration multi-status message type is active because it isn't by default
@@ -73,38 +73,38 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->see(
-    'rsm_tester@example.org',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Multi-status Summary',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Primary Registrant'
-    )
+	'rsm_tester@example.org',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Multi-status Summary',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Primary Registrant'
+	)
 );
 $I->see(
-    'admin@example.com',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Multi-status Summary',
-        MessagesAdmin::MESSAGE_STATUS_SENT
-    )
+	'admin@example.com',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Multi-status Summary',
+		MessagesAdmin::MESSAGE_STATUS_SENT
+	)
 );
 //verify count
 $I->verifyMatchingCountofTextInMessageActivityListTableFor(
-    1,
-    'rsm_tester@example.org',
-    'to',
-    'Registration Multi-status Summary',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Primary Registrant'
+	1,
+	'rsm_tester@example.org',
+	'to',
+	'Registration Multi-status Summary',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Primary Registrant'
 );
 $I->verifyMatchingCountofTextInMessageActivityListTableFor(
-    1,
-    'admin@example.com',
-    'to',
-    'Registration Multi-status Summary'
+	1,
+	'admin@example.com',
+	'to',
+	'Registration Multi-status Summary'
 );
 
 //okay now let's do some registrations for just the first event and verify that registration multi-status summary is NOT
@@ -134,25 +134,25 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->dontSee(
-    'rsm_testerb@example.org',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Multi-status Summary',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Primary Registrant'
-    )
+	'rsm_testerb@example.org',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Multi-status Summary',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Primary Registrant'
+	)
 );
 //there should still only be one admin multi-status summary thing.
 $I->verifyMatchingCountofTextInMessageActivityListTableFor(
-    1,
-    'admin@example.com',
-    'to',
-    'Registration Multi-status Summary'
+	1,
+	'admin@example.com',
+	'to',
+	'Registration Multi-status Summary'
 );
 
 //deactivate MER plugin so its not active for future tests
 $I->ensurePluginDeactivated(
-    'event-espresso-mer-multi-event-registration',
-    'plugins deactivated'
+	'event-espresso-mer-multi-event-registration',
+	'plugins deactivated'
 );
\ No newline at end of file

acceptance_tests/tests/c-TestCustomMessageTemplateCept.php

Indentation +27 added lines, -27 removed lines

@@ -18,14 +18,14 @@ 
 $event_one_link = $event_two_link = $event_three_link = '';
 
 $I->wantTo(
-    'Test that when registrations for multiple events are completed, and those events share the same custom'
-    . 'template, that that custom template will be used.'
+	'Test that when registrations for multiple events are completed, and those events share the same custom'
+	. 'template, that that custom template will be used.'
 );
 
 //need the MER plugin active for this test (we'll deactivate it after).
 $I->ensurePluginActive(
-    'event-espresso-mer-multi-event-registration',
-    'activated'
+	'event-espresso-mer-multi-event-registration',
+	'activated'
 );
 
 $I->loginAsAdmin();
@@ -80,9 +80,9 @@ 
 
 
 $test_registration_details = array(
-    'fname' => 'CTGuy',
-    'lname' => 'Dude',
-    'email' => 'ctguy_dude@example.org'
+	'fname' => 'CTGuy',
+	'lname' => 'Dude',
+	'email' => 'ctguy_dude@example.org'
 );
 
 $I->amGoingTo('Register for Event One and Event Two and verify Custom Template A was used.');
@@ -108,23 +108,23 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 $I->seeTextInViewMessageModal($custom_template_a_label);
 $I->dismissMessageModal();
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 
 //verify admin context
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 $I->seeTextInViewMessageModal($custom_template_a_label);
 $I->dismissMessageModal();
@@ -153,25 +153,25 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 $I->waitForElementVisible(MessagesAdmin::MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR);
 $I->dontSeeTextInViewMessageModal($custom_template_a_label);
 $I->dontSeeTextInViewMessageModal($custom_template_b_label);
 $I->dismissMessageModal();
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 
 //verify admin context
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 $I->waitForElementVisible(MessagesAdmin::MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR);
 $I->dontSee($custom_template_a_label);
@@ -183,6 +183,6 @@ 
 
 //deactivate MER plugin so its not active for future tests
 $I->ensurePluginDeactivated(
-    'event-espresso-mer-multi-event-registration',
-    'plugins deactivated'
+	'event-espresso-mer-multi-event-registration',
+	'plugins deactivated'
 );
\ No newline at end of file

acceptance_tests/Helpers/RegistrationsAdmin.php

Indentation +134 added lines, -134 removed lines

@@ -15,139 +15,139 @@
 trait RegistrationsAdmin
 {
 
-    /**
-     * This will select all checkboxes on a registration list table for the given array of
-     * registration ids.
-     * Assumes the actor is on a list table page for registrations.
-     * @param $registration_ids
-     */
-    public function selectBulkActionCheckboxesForRegistrationIds(array $registration_ids)
-    {
-        foreach ($registration_ids as $registration_id) {
-            $this->actor()->checkOption(
-                RegistrationsAdminPage::listTableCheckBoxSelectorForRegistrationId($registration_id)
-            );
-        }
-    }
-
-
-    /**
-     * Navigates the actor to the default registration list table page.
-     * @param string $additional_params
-     */
-    public function amOnDefaultRegistrationsListTableAdminPage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(
-            RegistrationsAdminPage::registrationsDefaultAdminListTableUrl($additional_params)
-        );
-        //wait for page to fully load
-        $this->actor()->wait(5);
-    }
-
-
-    /**
-     * Will enter the provided value in the registration list table search field and execute a search for that value.
-     * @param string $search_text
-     */
-    public function searchForRegistrationOnRegistrationListTableWithText($search_text)
-    {
-        $this->amOnDefaultRegistrationsListTableAdminPage();
-        $this->actor()->fillField(RegistrationsAdminPage::SEARCH_INPUT_SELECTOR_LIST_TABLE_REGISTRATION, $search_text);
-        $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR);
-        $this->actor()->waitForText('Displaying search results for');
-    }
-
-
-
-    /**
-     * This will filter the registration list table to view registrations for the given event id.
-     * Assumption is made that you are logged into the admin but you do not need to be on the registration list table
-     * page.
-     *
-     * @param int $event_id  The id of the event viewing registrations for.
-     */
-    public function amViewingRegistrationsForEvent($event_id)
-    {
-        $this->actor()->amOnDefaultEventsListTablePage();
-        $this->actor()->click(EventsAdmin::listTableActionLinkRegistrationsForEvent($event_id));
-        $this->actor()->waitForText('Viewing registrations for the event');
-    }
-
-
-    /**
-     * This helper will initiate registering for the given event via the backend.
-     * @param int $event_id  The event to initiate registration for.
-     */
-    public function amOnAdminRegistrationPageForEvent($event_id)
-    {
-        $this->actor()->amViewingRegistrationsForEvent($event_id);
-        $this->actor()->click(RegistrationsAdminPage::BUTTON_ADD_NEW_REGISTRATION);
-        $this->actor()->waitForText('Adding Registration For');
-    }
-
-
-
-    /**
-     * This clicks the View Details Link for Registration with the given Id
-     * @param $registration_id
-     */
-    public function clickViewDetailsLinkForRegistrationWithId($registration_id)
-    {
-        $this->actor()->click(RegistrationsAdminPage::viewDetailsLinkSelectorForRegistrationId($registration_id));
-    }
-
-
-    /**
-     * /**
-     * This assumes you are on the admin details page for a registration in EE.  It selects the given status in the
-     * dropdown for changing registration status.
-     *
-     * @param string $status_label_or_value  Either the label for the dropdown option or the value for the option.
-     * @param $status_label_or_value
-     */
-    public function selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value)
-    {
-        $this->actor()->selectOption(
-            RegistrationsAdminPage::DROPDOWN_REGISTRATION_STATUS,
-            $status_label_or_value
-        );
-    }
-
-
-    /**
-     * This selects (or deselects) the "Send Related Messages" checkbox on the Registration Details page.
-     * @param bool $send_related_messages
-     */
-    public function selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages = true)
-    {
-        $send_related_messages
-            ? $this->actor()->selectOption(
-                RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES,
-                'Yes'
-            )
-            : $this->actor()->selecOption(
-                RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES,
-                'No'
-            );
-    }
-
-
-
-    /**
-     * This assumes you are on the admin details page for a registration in EE.  It selects the given status in the
-     * dropdown for changing registration status and submits the change.
-     *
-     * @param string $status_label_or_value  Either the label for the dropdown option or the value for the option.
-     * @param bool   $send_related_messages  Whether or not to send related messages after changing the bulk action.
-     */
-    public function changeRegistrationStatusOnRegistrationDetailsPageTo(
-        $status_label_or_value,
-        $send_related_messages = true
-    ) {
-        $this->actor()->selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value);
-        $this->actor()->selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages);
-        $this->actor()->click(RegistrationsAdminPage::BUTTON_UPDATE_REGISTRATION_STATUS);
-        $this->actor()->waitForText('Registration status has been set to');
-    }
+	/**
+	 * This will select all checkboxes on a registration list table for the given array of
+	 * registration ids.
+	 * Assumes the actor is on a list table page for registrations.
+	 * @param $registration_ids
+	 */
+	public function selectBulkActionCheckboxesForRegistrationIds(array $registration_ids)
+	{
+		foreach ($registration_ids as $registration_id) {
+			$this->actor()->checkOption(
+				RegistrationsAdminPage::listTableCheckBoxSelectorForRegistrationId($registration_id)
+			);
+		}
+	}
+
+
+	/**
+	 * Navigates the actor to the default registration list table page.
+	 * @param string $additional_params
+	 */
+	public function amOnDefaultRegistrationsListTableAdminPage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(
+			RegistrationsAdminPage::registrationsDefaultAdminListTableUrl($additional_params)
+		);
+		//wait for page to fully load
+		$this->actor()->wait(5);
+	}
+
+
+	/**
+	 * Will enter the provided value in the registration list table search field and execute a search for that value.
+	 * @param string $search_text
+	 */
+	public function searchForRegistrationOnRegistrationListTableWithText($search_text)
+	{
+		$this->amOnDefaultRegistrationsListTableAdminPage();
+		$this->actor()->fillField(RegistrationsAdminPage::SEARCH_INPUT_SELECTOR_LIST_TABLE_REGISTRATION, $search_text);
+		$this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR);
+		$this->actor()->waitForText('Displaying search results for');
+	}
+
+
+
+	/**
+	 * This will filter the registration list table to view registrations for the given event id.
+	 * Assumption is made that you are logged into the admin but you do not need to be on the registration list table
+	 * page.
+	 *
+	 * @param int $event_id  The id of the event viewing registrations for.
+	 */
+	public function amViewingRegistrationsForEvent($event_id)
+	{
+		$this->actor()->amOnDefaultEventsListTablePage();
+		$this->actor()->click(EventsAdmin::listTableActionLinkRegistrationsForEvent($event_id));
+		$this->actor()->waitForText('Viewing registrations for the event');
+	}
+
+
+	/**
+	 * This helper will initiate registering for the given event via the backend.
+	 * @param int $event_id  The event to initiate registration for.
+	 */
+	public function amOnAdminRegistrationPageForEvent($event_id)
+	{
+		$this->actor()->amViewingRegistrationsForEvent($event_id);
+		$this->actor()->click(RegistrationsAdminPage::BUTTON_ADD_NEW_REGISTRATION);
+		$this->actor()->waitForText('Adding Registration For');
+	}
+
+
+
+	/**
+	 * This clicks the View Details Link for Registration with the given Id
+	 * @param $registration_id
+	 */
+	public function clickViewDetailsLinkForRegistrationWithId($registration_id)
+	{
+		$this->actor()->click(RegistrationsAdminPage::viewDetailsLinkSelectorForRegistrationId($registration_id));
+	}
+
+
+	/**
+	 * /**
+	 * This assumes you are on the admin details page for a registration in EE.  It selects the given status in the
+	 * dropdown for changing registration status.
+	 *
+	 * @param string $status_label_or_value  Either the label for the dropdown option or the value for the option.
+	 * @param $status_label_or_value
+	 */
+	public function selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value)
+	{
+		$this->actor()->selectOption(
+			RegistrationsAdminPage::DROPDOWN_REGISTRATION_STATUS,
+			$status_label_or_value
+		);
+	}
+
+
+	/**
+	 * This selects (or deselects) the "Send Related Messages" checkbox on the Registration Details page.
+	 * @param bool $send_related_messages
+	 */
+	public function selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages = true)
+	{
+		$send_related_messages
+			? $this->actor()->selectOption(
+				RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES,
+				'Yes'
+			)
+			: $this->actor()->selecOption(
+				RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES,
+				'No'
+			);
+	}
+
+
+
+	/**
+	 * This assumes you are on the admin details page for a registration in EE.  It selects the given status in the
+	 * dropdown for changing registration status and submits the change.
+	 *
+	 * @param string $status_label_or_value  Either the label for the dropdown option or the value for the option.
+	 * @param bool   $send_related_messages  Whether or not to send related messages after changing the bulk action.
+	 */
+	public function changeRegistrationStatusOnRegistrationDetailsPageTo(
+		$status_label_or_value,
+		$send_related_messages = true
+	) {
+		$this->actor()->selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value);
+		$this->actor()->selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages);
+		$this->actor()->click(RegistrationsAdminPage::BUTTON_UPDATE_REGISTRATION_STATUS);
+		$this->actor()->waitForText('Registration status has been set to');
+	}
 
 }
\ No newline at end of file

acceptance_tests/Helpers/Checkout.php

Indentation +62 added lines, -62 removed lines

@@ -13,75 +13,75 @@
  */
 trait Checkout
 {
-    /**
-     * @param     $value
-     * @param int $attendee_number
-     * @param bool  $admin  Used to indicate whether we're filling out the field from the context of the admin or not.
-     */
-    public function fillOutFirstNameFieldForAttendee($value, $attendee_number = 1, $admin = false)
-    {
-        $this->actor()->fillField(CheckoutPage::firstNameFieldSelectorForAttendeeNumber($attendee_number, $admin), $value);
-    }
+	/**
+	 * @param     $value
+	 * @param int $attendee_number
+	 * @param bool  $admin  Used to indicate whether we're filling out the field from the context of the admin or not.
+	 */
+	public function fillOutFirstNameFieldForAttendee($value, $attendee_number = 1, $admin = false)
+	{
+		$this->actor()->fillField(CheckoutPage::firstNameFieldSelectorForAttendeeNumber($attendee_number, $admin), $value);
+	}
 
-    /**
-     * @param     $value
-     * @param int $attendee_number
-     * @param bool  $admin  Used to indicate whether we're filling out the field from the context of the admin or not.
-     */
-    public function fillOutLastNameFieldForAttendee($value, $attendee_number = 1, $admin = false)
-    {
-        $this->actor()->fillField(CheckoutPage::lastNameFieldSelectorForAttendeeNumber($attendee_number, $admin), $value);
-    }
+	/**
+	 * @param     $value
+	 * @param int $attendee_number
+	 * @param bool  $admin  Used to indicate whether we're filling out the field from the context of the admin or not.
+	 */
+	public function fillOutLastNameFieldForAttendee($value, $attendee_number = 1, $admin = false)
+	{
+		$this->actor()->fillField(CheckoutPage::lastNameFieldSelectorForAttendeeNumber($attendee_number, $admin), $value);
+	}
 
-    /**
-     * @param     $value
-     * @param int $attendee_number
-     * @param bool  $admin  Used to indicate whether we're filling out the field from the context of the admin or not.
-     */
-    public function fillOutEmailFieldForAttendee($value, $attendee_number = 1, $admin = false)
-    {
-        $this->actor()->fillField(CheckoutPage::emailFieldSelectorForAttendeeNumber($attendee_number, $admin), $value);
-    }
+	/**
+	 * @param     $value
+	 * @param int $attendee_number
+	 * @param bool  $admin  Used to indicate whether we're filling out the field from the context of the admin or not.
+	 */
+	public function fillOutEmailFieldForAttendee($value, $attendee_number = 1, $admin = false)
+	{
+		$this->actor()->fillField(CheckoutPage::emailFieldSelectorForAttendeeNumber($attendee_number, $admin), $value);
+	}
 
 
-    /**
-     * Clicks the next registration step button.
-     */
-    public function goToNextRegistrationStep()
-    {
-        $this->actor()->click(CheckoutPage::NEXT_STEP_BUTTON_SELECTOR);
-    }
+	/**
+	 * Clicks the next registration step button.
+	 */
+	public function goToNextRegistrationStep()
+	{
+		$this->actor()->click(CheckoutPage::NEXT_STEP_BUTTON_SELECTOR);
+	}
 
 
-    /**
-     * Selects the payment option for the given payment method slug.
-     *
-     * @param string $payment_method_slug
-     * @param bool   $verify_selected      If true, this will wait for the "Important Information" info box after the
-     *                                     payment option select box is complete.  Otherwise its up to calling code to
-     *                                     wait for whatever is needed after selecting the payment method.
-     */
-    public function selectPaymentOptionFor($payment_method_slug = 'invoice', $verify_selected = true)
-    {
-        $this->waitForElementVisible(CheckoutPage::SELECTOR_PAYMENT_OPTIONS_CONTAINER);
-        $this->wait(5);
-        $this->actor()->selectOption(
-            CheckoutPage::PAYMENT_METHOD_STEP_FORM,
-            $payment_method_slug
-        );
-        if ($verify_selected) {
-            $this->actor()->waitForText('Important information regarding your payment');
-        }
-    }
+	/**
+	 * Selects the payment option for the given payment method slug.
+	 *
+	 * @param string $payment_method_slug
+	 * @param bool   $verify_selected      If true, this will wait for the "Important Information" info box after the
+	 *                                     payment option select box is complete.  Otherwise its up to calling code to
+	 *                                     wait for whatever is needed after selecting the payment method.
+	 */
+	public function selectPaymentOptionFor($payment_method_slug = 'invoice', $verify_selected = true)
+	{
+		$this->waitForElementVisible(CheckoutPage::SELECTOR_PAYMENT_OPTIONS_CONTAINER);
+		$this->wait(5);
+		$this->actor()->selectOption(
+			CheckoutPage::PAYMENT_METHOD_STEP_FORM,
+			$payment_method_slug
+		);
+		if ($verify_selected) {
+			$this->actor()->waitForText('Important information regarding your payment');
+		}
+	}
 
 
-    /**
-     * Submits the payment options step form.
-     * Assumes the actor is in the context of the payment options SPCO step.
-     */
-    public function submitPaymentOptionsRegistrationStepForm()
-    {
-        $this->actor()->submitForm(CheckoutPage::PAYMENT_METHOD_STEP_FORM, array());
-    }
+	/**
+	 * Submits the payment options step form.
+	 * Assumes the actor is in the context of the payment options SPCO step.
+	 */
+	public function submitPaymentOptionsRegistrationStepForm()
+	{
+		$this->actor()->submitForm(CheckoutPage::PAYMENT_METHOD_STEP_FORM, array());
+	}
 
 }
\ No newline at end of file

acceptance_tests/Page/TicketSelector.php

Indentation +21 added lines, -21 removed lines

@@ -12,27 +12,27 @@
 class TicketSelector
 {
 
-    /**
-     * Return the selector for the ticket option select input for the given event id.
-     * @param int|string $event_id
-     * @return string
-     */
-    public static function ticketOptionByEventIdSelector($event_id)
-    {
-        return "//select[@id='ticket-selector-tbl-qty-slct-$event_id-1']";
-    }
+	/**
+	 * Return the selector for the ticket option select input for the given event id.
+	 * @param int|string $event_id
+	 * @return string
+	 */
+	public static function ticketOptionByEventIdSelector($event_id)
+	{
+		return "//select[@id='ticket-selector-tbl-qty-slct-$event_id-1']";
+	}
 
 
-    /**
-     * Return the selector for the submit button for the ticket selector for the given event id.
-     * @param int|string $event_id
-     * @param bool       $admin     Used to return the selector from the context of the admin (true) or frontend (false)
-     * @return string
-     */
-    public static function ticketSelectionSubmitSelectorByEventId($event_id, $admin = false)
-    {
-        return $admin
-            ? "#ee-new-registration-step-button"
-            : "#ticket-selector-submit-$event_id-btn";
-    }
+	/**
+	 * Return the selector for the submit button for the ticket selector for the given event id.
+	 * @param int|string $event_id
+	 * @param bool       $admin     Used to return the selector from the context of the admin (true) or frontend (false)
+	 * @return string
+	 */
+	public static function ticketSelectionSubmitSelectorByEventId($event_id, $admin = false)
+	{
+		return $admin
+			? "#ee-new-registration-step-button"
+			: "#ticket-selector-submit-$event_id-btn";
+	}
 }
\ No newline at end of file

acceptance_tests/Page/RegistrationsAdmin.php

Indentation +43 added lines, -43 removed lines

@@ -12,47 +12,47 @@
 class RegistrationsAdmin extends CoreAdmin
 {
 
-    const REGISTRATION_STATUS_NOT_APPROVED = 'RNA';
-    const REGISTRATION_STATUS_APPROVED = 'RAP';
-    const REGISTRATION_STATUS_PENDING_PAYMENT = 'RPP';
-    const SEARCH_INPUT_SELECTOR_LIST_TABLE_REGISTRATION = '#event-espresso_page_espresso_registrations-search-input';
-    const BUTTON_ADD_NEW_REGISTRATION = '#add-new-registration';
-    const DROPDOWN_REGISTRATION_STATUS = '#reg-status-change-form-reg-status';
-    const BUTTON_UPDATE_REGISTRATION_STATUS = '#reg-status-change-form-submit-submit';
-    const DROPDOWN_SEND_RELATED_MESSAGES = '#reg-status-change-form-send-notifications';
-
-
-    /**
-     * @param string $additional_params
-     * @return string
-     */
-    public static function registrationsDefaultAdminListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_registrations', 'default', $additional_params);
-    }
-
-
-    /**
-     * Given a registration id, this will return the selector for all the checkbox for that id.
-     * Assumes the view is the default registrations list table.
-     * @param int $registration_id
-     * @return string
-     */
-    public static function listTableCheckBoxSelectorForRegistrationId($registration_id)
-    {
-        return "//input[@name='_REG_ID[]' and @value='{$registration_id}']";
-    }
-
-
-    /**
-     * Given a registration id, this will return the selector for the link to the registration details.
-     * Assumes the view is the default registrations list table.
-     * @param int $registration_id
-     * @return string
-     */
-    public static function viewDetailsLinkSelectorForRegistrationId($registration_id)
-    {
-        return "//tbody[@id='the-list']/tr/td[contains(@class, 'column-_REG_ID') and contains(., $registration_id)]"
-            . "//ancestor::tr/td[contains(@class, 'column-ATT_fname')]/a[1]";
-    }
+	const REGISTRATION_STATUS_NOT_APPROVED = 'RNA';
+	const REGISTRATION_STATUS_APPROVED = 'RAP';
+	const REGISTRATION_STATUS_PENDING_PAYMENT = 'RPP';
+	const SEARCH_INPUT_SELECTOR_LIST_TABLE_REGISTRATION = '#event-espresso_page_espresso_registrations-search-input';
+	const BUTTON_ADD_NEW_REGISTRATION = '#add-new-registration';
+	const DROPDOWN_REGISTRATION_STATUS = '#reg-status-change-form-reg-status';
+	const BUTTON_UPDATE_REGISTRATION_STATUS = '#reg-status-change-form-submit-submit';
+	const DROPDOWN_SEND_RELATED_MESSAGES = '#reg-status-change-form-send-notifications';
+
+
+	/**
+	 * @param string $additional_params
+	 * @return string
+	 */
+	public static function registrationsDefaultAdminListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_registrations', 'default', $additional_params);
+	}
+
+
+	/**
+	 * Given a registration id, this will return the selector for all the checkbox for that id.
+	 * Assumes the view is the default registrations list table.
+	 * @param int $registration_id
+	 * @return string
+	 */
+	public static function listTableCheckBoxSelectorForRegistrationId($registration_id)
+	{
+		return "//input[@name='_REG_ID[]' and @value='{$registration_id}']";
+	}
+
+
+	/**
+	 * Given a registration id, this will return the selector for the link to the registration details.
+	 * Assumes the view is the default registrations list table.
+	 * @param int $registration_id
+	 * @return string
+	 */
+	public static function viewDetailsLinkSelectorForRegistrationId($registration_id)
+	{
+		return "//tbody[@id='the-list']/tr/td[contains(@class, 'column-_REG_ID') and contains(., $registration_id)]"
+			. "//ancestor::tr/td[contains(@class, 'column-ATT_fname')]/a[1]";
+	}
 }
\ No newline at end of file