You are here

Home » API reference » Mass Contact 8 » MassContactFormTest.php

class MassContactFormTest in Mass Contact 8

Tests for the Mass Contact form.

@group mass_contact

Hierarchy

Expanded class hierarchy of MassContactFormTest

File

tests/src/Functional/Form/MassContactFormTest.php, line 17

Namespace

Drupal\Tests\mass_contact\Functional\Form
View source 
class MassContactFormTest extends MassContactTestBase {
  use AssertMailTrait;

  /**
   * Non admin user.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $massContactUser;

  /**
   * The role for changing mass contact permissions.
   *
   * @var \Drupal\user\RoleInterface
   */
  protected $massContactRole;

  /**
   * The role to send to.
   *
   * @var \Drupal\user\RoleInterface
   */
  protected $recipientRole;

  /**
   * Some test categories.
   *
   * @var \Drupal\mass_contact\Entity\MassContactCategoryInterface[]
   */
  protected $categories;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->massContactUser = $this
      ->createUser([
      'mass contact send messages',
      'mass contact view archived messages',
    ]);
    $role_id = $this->massContactUser
      ->getRoles(TRUE);
    $this->massContactRole = Role::load(reset($role_id));
    foreach (range(1, 6) as $i) {
      $this->categories[$i] = $this
        ->createCategory();
    }

    // Add 410 users.
    $this->recipientRole = Role::load($this
      ->createRole([]));
    foreach (range(1, 410) as $i) {
      $account = $this
        ->createUser();
      if ($i == 5) {

        // Block the 5th one.
        $account
          ->block();
      }
      if ($i == 20 || $i == 50) {

        // Opt out of mass contacts for the 20th and 50th users.
        $account->mass_contact_opt_out->value = 1;
      }
      $account
        ->addRole($this->recipientRole
        ->id());
      $account
        ->save();
    }
  }

  /**
   * Tests basic form operation on an unprivileged user.
   */
  public function testNormalAccess() {
    $this
      ->drupalLogin($this->massContactUser);

    // Ensure page loads successfully.
    $this
      ->drupalGet(Url::fromRoute('entity.mass_contact_message.add_form'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Test with queue system.
    $this
      ->config('mass_contact.settings')
      ->set('send_with_cron', TRUE)
      ->save();

    // Grant permission to one category only.
    $this->massContactRole
      ->grantPermission('mass contact send to users in the ' . $this->categories[2]
      ->id() . ' category')
      ->save();
    $this
      ->drupalGet(Url::fromRoute('entity.mass_contact_message.add_form'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains('A copy of this message will be archived on this website.');
    $this
      ->assertSession()
      ->pageTextContains('Recipients will be hidden from each other.');
    $this
      ->assertSession()
      ->fieldExists('sender_mail');
    $this
      ->assertSession()
      ->fieldValueEquals('sender_mail', $this->massContactUser
      ->getEmail());
    $this
      ->assertSession()
      ->fieldExists('sender_name');
    $this
      ->assertSession()
      ->fieldValueEquals('sender_name', $this->massContactUser
      ->getDisplayName());

    // Update some options.
    $config = $this
      ->config('mass_contact.settings');
    $config
      ->set('use_bcc', FALSE);
    $config
      ->set('create_archive_copy', FALSE);
    $config
      ->set('default_sender_email', 'foo@bar.com');
    $config
      ->set('default_sender_name', 'Foo Bar');

    // Do not respect opt-outs.
    $config
      ->set('optout_enabled', MassContactInterface::OPT_OUT_DISABLED);
    $config
      ->set('message_prefix', [
      'value' => $this
        ->randomString(),
      'format' => filter_default_format(),
    ]);
    $config
      ->set('message_suffix', [
      'value' => $this
        ->randomString(),
      'format' => filter_default_format(),
    ]);
    $config
      ->save();
    $this->massContactRole
      ->grantPermission('mass contact send to users in the ' . $this->categories[3]
      ->id() . ' category')
      ->save();
    $this
      ->drupalGet(Url::fromRoute('entity.mass_contact_message.add_form'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains('Recipients will NOT be hidden from each other.');
    $this
      ->assertSession()
      ->pageTextContains(' A copy of this message will NOT be archived on this website.');
    $this
      ->assertSession()
      ->fieldNotExists('sender_mail');
    $this
      ->assertSession()
      ->fieldNotExists('sender_name');

    // Set category 2 to send to all authenticated users.
    $recipients = [
      'role' => [
        'conjunction' => 'AND',
        'categories' => [
          $this->recipientRole
            ->id(),
        ],
      ],
    ];
    $this->categories[2]
      ->setRecipients($recipients);
    $this->categories[2]
      ->save();

    // Send a message to category 2.
    $edit = [
      'subject' => $this
        ->randomString(),
      'body[value]' => $this
        ->randomString(),
      'categories[]' => [
        $this->categories[2]
          ->id(),
      ],
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Send email'));
    $message_configs['optout'] = FALSE;
    $message_configs['copy'] = FALSE;
    $message_configs['bcc'] = FALSE;
    $message_configs['create_archive_copy'] = FALSE;
    $message_configs['user_count'] = 409;
    $this
      ->verifyConfirmFormAndConfirmSendEmail($message_configs);

    /** @var \Drupal\Core\Queue\QueueWorkerManagerInterface $manager */

    /** @var \Drupal\Core\Queue\QueueWorkerInterface $message_queue_queue_worker */

    /** @var \Drupal\Core\Queue\QueueWorkerInterface $send_message_queue_worker */
    $manager = $this->container
      ->get('plugin.manager.queue_worker');
    $message_queue_queue_worker = $manager
      ->createInstance('mass_contact_queue_messages');
    $send_message_queue_worker = $manager
      ->createInstance('mass_contact_send_message');

    // Should be one item in the  Queue messages queue.
    $this
      ->verifyAndProcessQueueMessagesQueue($message_queue_queue_worker, 1);

    // There should now be 9 items in the sending queue and 409 emails
    // (409 non-blocked users with the recipient role).
    // @see \Drupal\mass_contact\MassContact::MAX__QUEUE_RECIPIENTS
    $this
      ->verifyAndProcessSendMessageQueue($send_message_queue_worker, 9, 409);

    // Switch back to BCC mode and only 3 emails should be sent.
    \Drupal::state()
      ->set('system.test_mail_collector', []);
    $config
      ->set('create_archive_copy', TRUE);
    $config
      ->set('use_bcc', TRUE);
    $config
      ->save();
    $this
      ->drupalGet(Url::fromRoute('entity.mass_contact_message.add_form'));

    // Send a message to category 2.
    $edit = [
      'subject' => $this
        ->randomString(),
      'body[value]' => $this
        ->randomString(),
      'categories[]' => [
        $this->categories[2]
          ->id(),
      ],
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Send email'));
    $message_configs['optout'] = FALSE;
    $message_configs['copy'] = FALSE;
    $message_configs['bcc'] = TRUE;
    $message_configs['create_archive_copy'] = TRUE;
    $message_configs['user_count'] = 409;
    $this
      ->verifyConfirmFormAndConfirmSendEmail($message_configs);
    $this
      ->assertSession()
      ->pageTextContains(t('A copy has been archived'));
    $this
      ->clickLink('here');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->drupalGet(Url::fromRoute('entity.mass_contact_message.add_form'));

    // Should be one item in the  Queue messages queue.
    $this
      ->verifyAndProcessQueueMessagesQueue($message_queue_queue_worker, 1);

    // There should now be 9 items in the sending queue and 9 emails
    // (since BCC is used).
    // @see \Drupal\mass_contact\MassContact::MAX__QUEUE_RECIPIENTS
    $this
      ->verifyAndProcessSendMessageQueue($send_message_queue_worker, 9, 9);

    // Verify message prefix/suffix are properly attached.
    $expected = implode("\n\n", [
      $config
        ->get('message_prefix.value'),
      $edit['body[value]'],
      $config
        ->get('message_suffix.value'),
    ]) . "\n\n";
    $this
      ->assertMail('body', $expected);
    $this
      ->assertMail('to', 'foo@bar.com');

    // Test opt out feature.
    \Drupal::state()
      ->set('system.test_mail_collector', []);
    $config
      ->set('optout_enabled', MassContactInterface::OPT_OUT_GLOBAL);
    $config
      ->set('use_bcc', FALSE);
    $config
      ->save();

    // Get form again.
    $this
      ->drupalGet(Url::fromRoute('entity.mass_contact_message.add_form'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Send a message to category 2 with BCC disabled.
    $edit = [
      'subject' => $this
        ->randomString(),
      'body[value]' => $this
        ->randomString(),
      'categories[]' => [
        $this->categories[2]
          ->id(),
      ],
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Send email'));
    $message_configs['optout'] = TRUE;
    $message_configs['copy'] = FALSE;
    $message_configs['bcc'] = FALSE;
    $message_configs['create_archive_copy'] = TRUE;
    $message_configs['user_count'] = 407;
    $this
      ->verifyConfirmFormAndConfirmSendEmail($message_configs);

    // Should be one item in the  Queue messages queue.
    $this
      ->verifyAndProcessQueueMessagesQueue($message_queue_queue_worker, 1);

    // There should now be 9 items in the sending queue and 407 emails
    // (since BCC is not used and 2 users have opted out).
    // @see \Drupal\mass_contact\MassContact::MAX__QUEUE_RECIPIENTS
    $this
      ->verifyAndProcessSendMessageQueue($send_message_queue_worker, 9, 407);

    // Test send me a copy feature.
    \Drupal::state()
      ->set('system.test_mail_collector', []);

    // Use BCC for this test.
    $config
      ->set('use_bcc', TRUE);
    $config
      ->save();

    // Get form again.
    $this
      ->drupalGet(Url::fromRoute('entity.mass_contact_message.add_form'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Test Send a message without any categories with 'Send me a copy'
    // unchecked. Mail should not be sent since there are no recipients.
    $edit = [
      'subject' => $this
        ->randomString(),
      'body[value]' => $this
        ->randomString(),
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Send email'));
    $this
      ->assertSession()
      ->pageTextContains('There are no recipients chosen for this mass contact message.');

    // Test Sending a message without any categories with
    // 'Send me a copy checked'. Mail should be sent since there is one
    // recipient.
    $edit = [
      'subject' => $this
        ->randomString(),
      'body[value]' => $this
        ->randomString(),
      'copy' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Send email'));
    $message_configs['optout'] = TRUE;
    $message_configs['copy'] = TRUE;
    $message_configs['bcc'] = TRUE;
    $message_configs['create_archive_copy'] = TRUE;
    $message_configs['user_count'] = 1;
    $this
      ->verifyConfirmFormAndConfirmSendEmail($message_configs);

    // Should be one item in the  Queue messages queue.
    $this
      ->verifyAndProcessQueueMessagesQueue($message_queue_queue_worker, 1);

    // There should now be only 1 item in the sending queue for the current
    // user and 1 email sent.
    $this
      ->verifyAndProcessSendMessageQueue($send_message_queue_worker, 1, 1);

    // Test sending a message to category 2 and also a copy to yourself with
    // BCC option as false.
    $config
      ->set('use_bcc', FALSE);

    // Use the checkboxes to display the categories.
    $config
      ->set('category_display', 'checkboxes');
    $config
      ->save();

    // Get form again.
    $this
      ->drupalGet(Url::fromRoute('entity.mass_contact_message.add_form'));
    \Drupal::state()
      ->set('system.test_mail_collector', []);
    $edit = [
      'subject' => $this
        ->randomString(),
      'body[value]' => $this
        ->randomString(),
      'categories[' . $this->categories[2]
        ->id() . ']' => TRUE,
      'categories[' . $this->categories[3]
        ->id() . ']' => FALSE,
      'copy' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Send email'));
    $message_configs['optout'] = TRUE;
    $message_configs['copy'] = TRUE;
    $message_configs['bcc'] = FALSE;
    $message_configs['create_archive_copy'] = TRUE;
    $message_configs['user_count'] = 408;
    $this
      ->verifyConfirmFormAndConfirmSendEmail($message_configs);

    // Should be one item in the  Queue messages queue.
    $this
      ->verifyAndProcessQueueMessagesQueue($message_queue_queue_worker, 1);

    // There should now be 9 items in the sending queue for the current
    // user and should be 408 emails (407 non-blocked users and non opted out
    // users with the recipient role and 1 current user for copy).
    $this
      ->verifyAndProcessSendMessageQueue($send_message_queue_worker, 9, 408);

    // Test cancelling the message confirm form.
    // No messages should be sent if the cancel button is pressed on the
    // confirmation form.
    \Drupal::state()
      ->set('system.test_mail_collector', []);
    $config
      ->set('category_display', 'select');
    $config
      ->save();

    // Get form again.
    $this
      ->drupalGet(Url::fromRoute('entity.mass_contact_message.add_form'));
    $edit = [
      'subject' => $this
        ->randomString(),
      'body[value]' => $this
        ->randomString(),
      'categories[]' => [
        $this->categories[2]
          ->id(),
      ],
      'copy' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Send email'));
    $message_configs['optout'] = TRUE;
    $message_configs['copy'] = TRUE;
    $message_configs['bcc'] = FALSE;
    $message_configs['create_archive_copy'] = TRUE;
    $message_configs['user_count'] = 408;
    $message_configs['cancel'] = TRUE;
    $this
      ->verifyConfirmFormAndConfirmSendEmail($message_configs);
    $this
      ->verifyAndProcessQueueMessagesQueue($message_queue_queue_worker, 0);

    // @todo Test with batch system.
    // @see https://www.drupal.org/node/2855942
    $this
      ->config('mass_contact.settings')
      ->set('send_with_cron', FALSE)
      ->save();
    \Drupal::state()
      ->set('system.test_mail_collector', []);
  }

  /**
   * Verifies the number of items in the mass_contact_queue_messages queue.
   *
   * Also processes the queue.
   *
   * @param \Drupal\Core\Queue\QueueWorkerInterface $queue_worker
   *   The queue worker for the mass_contact_queue_messages queue.
   * @param int $expected_queue_items
   *   Number of items expected in the mass_contact_queue_messages queue.
   */
  protected function verifyAndProcessQueueMessagesQueue(QueueWorkerInterface $queue_worker, $expected_queue_items) {
    $queue = \Drupal::queue('mass_contact_queue_messages');

    // Number of items in the queue_messages queue should be equal to
    // $expected_queue_items.
    $this
      ->assertEquals($expected_queue_items, $queue
      ->numberOfItems());

    // Process the queue.
    while ($item = $queue
      ->claimItem()) {
      $queue_worker
        ->processItem($item->data);
      $queue
        ->deleteItem($item);
    }
  }

  /**
   * Verifies the number of items in the mass_contact_send_message queue.
   *
   * Also processes the queue and verifies the number of emails generated.
   *
   * @param \Drupal\Core\Queue\QueueWorkerInterface $queue_worker
   *   The queue worker for the mass_contact_send_message queue.
   * @param int $expected_queue_items
   *   Number of items expected in the mass_contact_send_message queue.
   * @param int $expected_mails
   *   Number of emails expected to be sent.
   */
  protected function verifyAndProcessSendMessageQueue(QueueWorkerInterface $queue_worker, $expected_queue_items, $expected_mails) {
    $queue = \Drupal::queue('mass_contact_send_message');

    // Number of items in the send_messages queue should be equal to
    // $expected_queue_items.
    $this
      ->assertEquals($expected_queue_items, $queue
      ->numberOfItems());

    // Process the queue.
    while ($item = $queue
      ->claimItem()) {
      $queue_worker
        ->processItem($item->data);
      $queue
        ->deleteItem($item);
    }

    // Number of emails should be equal to $expected_mails.
    $emails = $this
      ->getMails();
    $this
      ->assertEquals($expected_mails, count($emails));
  }

  /**
   * Verifies text in the confirmation form and submits the confirmation form.
   *
   * Form submission is cancelled if configs have an entry for
   * $message_configs['cancel'].
   *
   * @param array $message_configs
   *   An array of chosen message configs which decides the text in the
   *   confirmation form.
   */
  protected function verifyConfirmFormAndConfirmSendEmail(array $message_configs) {
    $this
      ->assertSession()
      ->pageTextContains('Are you sure you want to send this message to ' . $message_configs['user_count'] . ' user(s)?');
    if ($this->massContactUser
      ->hasPermission('mass contact administer')) {
      if ($message_configs['optout']) {
        $this
          ->assertSession()
          ->pageTextContains('You have selected to respect user opt-outs. If a user has opted out of emails they will not receive this mass contact message.');
      }
      else {
        $this
          ->assertSession()
          ->pageTextContains('You have selected to NOT respect user opt-outs. Emails will be sent to all users even if they have elected not to receive a mass contact message.');
      }
    }
    if ($this->massContactUser
      ->hasPermission('mass contact override bcc')) {
      if ($message_configs['bcc']) {
        $this
          ->assertSession()
          ->pageTextContains('Recipients of this message will be HIDDEN on the email');
      }
      else {
        $this
          ->assertSession()
          ->pageTextContains('Recipients of this message will NOT be HIDDEN on the email');
      }
    }
    if ($message_configs['copy']) {
      $this
        ->assertSession()
        ->pageTextContains('A copy of this message will be sent to you.');
    }
    else {
      $this
        ->assertSession()
        ->pageTextContains('A copy of this message will NOT be sent to you.');
    }
    if ($this->massContactUser
      ->hasPermission('mass contact override archiving')) {
      if ($message_configs['create_archive_copy']) {
        $this
          ->assertSession()
          ->pageTextContains('A copy of this message will be archived on this site.');
      }
      else {
        $this
          ->assertSession()
          ->pageTextContains('A copy of this message will NOT be archived on this site.');
      }
    }
    if (empty($message_configs['cancel'])) {
      $this
        ->drupalPostForm(NULL, [], t('Confirm'));
      $this
        ->assertSession()
        ->pageTextContains('Mass Contact message sent successfully.');
    }
    else {
      $this
        ->clickLink('Cancel');
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
AssertMailTrait::assertMail protected function Asserts that the most recently sent email message has the given value.
AssertMailTrait::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString protected function Asserts that the most recently sent email message has the string in it.
AssertMailTrait::getMails protected function Gets an array containing all emails sent during this test case.
AssertMailTrait::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$defaultTheme protected property The theme to install as the default for testing. 1,597
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
CategoryCreationTrait::createCategory public function Creates a category.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
MassContactFormTest::$categories protected property Some test categories.
MassContactFormTest::$massContactRole protected property The role for changing mass contact permissions.
MassContactFormTest::$massContactUser protected property Non admin user.
MassContactFormTest::$recipientRole protected property The role to send to.
MassContactFormTest::setUp protected function Overrides MassContactTestBase::setUp
MassContactFormTest::testNormalAccess public function Tests basic form operation on an unprivileged user.
MassContactFormTest::verifyAndProcessQueueMessagesQueue protected function Verifies the number of items in the mass_contact_queue_messages queue.
MassContactFormTest::verifyAndProcessSendMessageQueue protected function Verifies the number of items in the mass_contact_send_message queue.
MassContactFormTest::verifyConfirmFormAndConfirmSendEmail protected function Verifies text in the confirmation form and submits the confirmation form.
MassContactTestBase::$admin protected property An admin user.
MassContactTestBase::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
MassContactTestBase::$roles protected property Some roles to test with.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.