You are here

Home » API reference » Inline Entity Form 8 » SimpleWidgetTest.php

class SimpleWidgetTest in Inline Entity Form 8

Tests the IEF simple widget.

@group inline_entity_form

Hierarchy

Expanded class hierarchy of SimpleWidgetTest

File

tests/src/FunctionalJavascript/SimpleWidgetTest.php, line 14

Namespace

Drupal\Tests\inline_entity_form\FunctionalJavascript
View source 
class SimpleWidgetTest extends InlineEntityFormTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'inline_entity_form_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->user = $this
      ->createUser([
      'create ief_simple_single content',
      'create ief_test_custom content',
      'edit any ief_simple_single content',
      'edit own ief_test_custom content',
      'view own unpublished content',
      'create ief_simple_entity_no_bundle content',
      'administer entity_test__without_bundle content',
    ]);
  }

  /**
   * Tests simple IEF widget with different cardinality options.
   */
  public function testSimpleCardinalityOptions() {

    // Get the xpath selectors for the fields in this test.
    $title_field_xpath = $this
      ->getXpathForNthInputByLabelText('Title', 1);
    $first_nested_title_field_xpath = $this
      ->getXpathForNthInputByLabelText('Title', 2);
    $second_nested_title_field_xpath = $this
      ->getXpathForNthInputByLabelText('Title', 3);
    $third_nested_title_field_xpath = $this
      ->getXpathForNthInputByLabelText('Title', 4);
    $fourth_nested_title_field_xpath = $this
      ->getXpathForNthInputByLabelText('Title', 5);
    $first_positive_int_field_xpath = $this
      ->getXpathForNthInputByLabelText('Positive int', 1);
    $second_positive_int_field_xpath = $this
      ->getXpathForNthInputByLabelText('Positive int', 2);
    $third_positive_int_field_xpath = $this
      ->getXpathForNthInputByLabelText('Positive int', 3);
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();
    $this
      ->drupalLogin($this->user);
    $cardinality_options = [
      1 => 1,
      2 => 2,
      FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED => 3,
    ];

    /** @var \Drupal\field\FieldStorageConfigInterface $field_storage */
    $field_storage = $this->fieldStorageConfigStorage
      ->load('node.single');
    foreach ($cardinality_options as $cardinality => $number_of_items) {
      $field_storage
        ->setCardinality($cardinality);
      $field_storage
        ->save();
      $this
        ->drupalGet('node/add/ief_simple_single');
      $assert_session
        ->elementTextContains('css', 'span.fieldset-legend', 'Single node');
      $assert_session
        ->elementTextContains('css', 'div.description', 'Reference a single node.');
      if ($cardinality === 1) {

        // With cardinality 1, one item should already be on the page.
        $assert_session
          ->buttonNotExists('Add another item');
        $assert_session
          ->elementExists('xpath', $title_field_xpath)
          ->setValue('Host node');
        $assert_session
          ->elementExists('xpath', $first_nested_title_field_xpath)
          ->setValue('Nested single node');
        $assert_session
          ->elementExists('xpath', $first_positive_int_field_xpath)
          ->setValue(42);
        $page
          ->pressButton('Save');
        $assert_session
          ->pageTextContains('IEF simple single Host node has been created.');
        $host_node = $this
          ->getNodeByTitle('Host node');
      }
      elseif ($cardinality === 2) {

        // With cardinality 2, two items should already be on the page.
        $assert_session
          ->buttonNotExists('Add another item');
        $assert_session
          ->elementExists('xpath', $title_field_xpath)
          ->setValue('Host node 2');
        $assert_session
          ->elementExists('xpath', $first_nested_title_field_xpath)
          ->setValue('Nested single node 2');
        $assert_session
          ->elementExists('xpath', $first_positive_int_field_xpath)
          ->setValue(42);
        $assert_session
          ->elementExists('xpath', $second_nested_title_field_xpath)
          ->setValue('Nested single node 3');
        $assert_session
          ->elementExists('xpath', $second_positive_int_field_xpath)
          ->setValue(42);
        $page
          ->pressButton('Save');
        $assert_session
          ->pageTextContains('IEF simple single Host node 2 has been created.');
        $host_node = $this
          ->getNodeByTitle('Host node 2');
      }
      elseif ($cardinality === FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) {

        // With unlimited cardinality, one item should already be on the page,
        // and an 'Add another item' button should appear.
        $assert_session
          ->elementExists('xpath', $title_field_xpath)
          ->setValue('Host node 3');
        $assert_session
          ->elementExists('xpath', $first_nested_title_field_xpath)
          ->setValue('Nested single node 4');
        $assert_session
          ->elementExists('xpath', $first_positive_int_field_xpath)
          ->setValue(42);
        $assert_session
          ->elementNotExists('xpath', $second_positive_int_field_xpath);

        // Press the 'add another item' button and add a second item.
        $assert_session
          ->buttonExists('Add another item')
          ->press();
        $this
          ->assertNotEmpty($assert_session
          ->waitForElement('xpath', $second_nested_title_field_xpath));

        // Assert an extra item isn't added at the same time.
        $assert_session
          ->elementNotExists('xpath', $third_nested_title_field_xpath);
        $assert_session
          ->elementExists('xpath', $second_nested_title_field_xpath)
          ->setValue('Nested single node 5');
        $assert_session
          ->elementExists('xpath', $second_positive_int_field_xpath)
          ->setValue(42);

        // Press the 'add another item' button and add a third item.
        $assert_session
          ->buttonExists('Add another item')
          ->press();
        $this
          ->assertNotEmpty($assert_session
          ->waitForElement('xpath', $third_nested_title_field_xpath));

        // Assert an extra item isn't added at the same time.
        $assert_session
          ->elementNotExists('xpath', $fourth_nested_title_field_xpath);
        $assert_session
          ->elementExists('xpath', $third_nested_title_field_xpath)
          ->setValue('Nested single node 6');
        $assert_session
          ->elementExists('xpath', $third_positive_int_field_xpath)
          ->setValue(42);
        $page
          ->pressButton('Save');
        $assert_session
          ->pageTextContains('IEF simple single Host node 3 has been created.');
        $host_node = $this
          ->getNodeByTitle('Host node 3');
      }
      $this
        ->checkEditAccess($host_node, $number_of_items, $cardinality);
    }
  }

  /**
   * Test Validation on Simple Widget.
   */
  public function testSimpleValidation() {

    // Get the xpath selectors for the fields in this test.
    $title_field_xpath = $this
      ->getXpathForNthInputByLabelText('Title', 1);
    $nested_title_field_xpath = $this
      ->getXpathForNthInputByLabelText('Title', 2);
    $positive_int_field_xpath = $this
      ->getXpathForNthInputByLabelText('Positive int', 1);
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();
    $this
      ->drupalLogin($this->user);
    $host_node_title = 'Host Validation Node';
    $this
      ->drupalGet('node/add/ief_simple_single');

    // Assert inline entity field widget title found.
    $assert_session
      ->pageTextContains('Single node');

    // Assert inline entity field description found.
    $assert_session
      ->pageTextContains('Reference a single node.');

    // Assert positive int field found.
    $assert_session
      ->pageTextContains('Positive int');
    $assert_session
      ->elementExists('xpath', $title_field_xpath)
      ->setValue($host_node_title);
    $page
      ->pressButton('Save');

    // Assert title validation fires on Inline Entity Form widget.
    $assert_session
      ->pageTextNotContains('IEF simple single Host Validation Node has been created.');

    // Assert that we're still on form due to to validation error.
    $this
      ->assertSession()
      ->addressEquals('node/add/ief_simple_single');
    $child_title = 'Child node ' . $this
      ->randomString();
    $assert_session
      ->elementExists('xpath', $nested_title_field_xpath)
      ->setValue($child_title);
    $assert_session
      ->elementExists('xpath', $positive_int_field_xpath)
      ->setValue(-1);
    $page
      ->pressButton('Save');

    // Assert field validation fires on Inline Entity Form widget.
    $assert_session
      ->pageTextNotContains('IEF simple single Host Validation Node has been created.');

    // Assert that we're still on form due to to validation error.
    $this
      ->assertSession()
      ->addressEquals('node/add/ief_simple_single');
    $assert_session
      ->elementExists('xpath', $positive_int_field_xpath)
      ->setValue(1);
    $page
      ->pressButton('Save');

    // Assert title validation passes on Inline Entity Form widget.
    $assert_session
      ->pageTextNotContains('Title field is required.');

    // Assert field validation fires on Inline Entity Form widget.
    $assert_session
      ->pageTextNotContains('Positive int must be higher than or equal to 1');
    $assert_session
      ->pageTextContains('IEF simple single Host Validation Node has been created.');

    // Check that nodes were created correctly.
    $host_node = $this
      ->getNodeByTitle($host_node_title);
    $this
      ->assertNotNull($host_node, 'Host node created.');
    if (isset($host_node)) {

      // Assert that address is the canonical page after node add.
      $this
        ->assertSession()
        ->addressEquals($host_node
        ->toUrl('canonical', [
        'absolute' => TRUE,
      ])
        ->toString());
      $child_node = $this
        ->getNodeByTitle($child_title);
      $this
        ->assertNotNull($child_node);
      if (isset($child_node)) {
        $this
          ->assertSame($host_node->single[0]->target_id, $child_node
          ->id(), 'Child node is referenced');
        $this
          ->assertSame($child_node->positive_int[0]->value, '1', 'Child node int field correct.');
        $this
          ->assertSame($child_node
          ->bundle(), 'ief_test_custom', 'Child node is correct bundle.');
      }
    }
  }

  /**
   * Tests if the entity create access works in the simple widget.
   */
  public function testSimpleCreateAccess() {

    // Get the xpath selectors for the fields in this test.
    $nested_title_field_xpath = $this
      ->getXpathForNthInputByLabelText('Title', 2);
    $assert_session = $this
      ->assertSession();

    // Create a user who does not have access to create ief_test_custom nodes.
    $this
      ->drupalLogin($this
      ->createUser([
      'create ief_simple_single content',
    ]));
    $this
      ->drupalGet('node/add/ief_simple_single');
    $assert_session
      ->elementNotExists('xpath', $nested_title_field_xpath);

    // Now test with a user has access to create ief_test_custom nodes.
    $this
      ->drupalLogin($this->user);
    $this
      ->drupalGet('node/add/ief_simple_single');
    $assert_session
      ->elementExists('xpath', $nested_title_field_xpath);
  }

  /**
   * Ensures that an entity without bundles can be used with the simple widget.
   */
  public function testEntityWithoutBundle() {

    // Get the xpath selectors for the fields in this test.
    $title_field_xpath = $this
      ->getXpathForNthInputByLabelText('Title', 1);
    $name_field_xpath = $this
      ->getXpathForNthInputByLabelText('Name', 1);
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();
    $this
      ->drupalLogin($this->user);
    $this
      ->drupalGet('node/add/ief_simple_entity_no_bundle');
    $assert_session
      ->elementExists('xpath', $title_field_xpath)
      ->setValue('Node title');
    $assert_session
      ->elementExists('xpath', $name_field_xpath)
      ->setValue('Entity title');
    $page
      ->pressButton('Save');
    $assert_session
      ->pageTextContains('IEF simple entity no bundle Node title has been created.');
    $this
      ->assertNodeByTitle('Node title', 'ief_simple_entity_no_bundle');
    $this
      ->assertEntityByLabel('Entity title', 'entity_test__without_bundle');
  }

  /**
   * Tests that user only has access to the their own nodes.
   *
   * @param \Drupal\node\NodeInterface $host_node
   *   The node of the type of ief_simple_single.
   * @param int $number_of_items
   *   The number of entity reference values in the "single" field.
   * @param int $cardinality
   *   The field cardinality with which to check.
   */
  protected function checkEditAccess(NodeInterface $host_node, int $number_of_items, int $cardinality) {
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();
    $other_user = $this
      ->createUser([
      'edit own ief_test_custom content',
      'edit any ief_simple_single content',
    ]);
    $first_child_node = $host_node->single[0]->entity;
    $first_child_node
      ->setOwner($other_user)
      ->save();
    $this
      ->drupalGet("node/{$host_node->id()}/edit");
    $assert_session
      ->pageTextContains($first_child_node
      ->label());

    // Assert the form of child node without edit access is not found.
    $assert_session
      ->fieldNotExists('single[0][inline_entity_form][title][0][value]');

    // Check that the forms for other child nodes (if any) appear on the form.
    // If $number_of_items is greater than one, iterate through the other
    // fields that should appear on the page.
    $delta = 1;
    while ($delta < $number_of_items) {
      $child_node = $host_node->single[$delta]->entity;

      // Assert the form of child node with edit access is found.
      $delta_field = $assert_session
        ->fieldExists("single[{$delta}][inline_entity_form][title][0][value]");
      $this
        ->assertStringContainsString($child_node
        ->label(), $delta_field
        ->getValue());
      $delta++;
    }

    // Check that there is NOT an extra "add" form when editing.
    $unexpected_item_number = $number_of_items;

    // Assert no empty "add" entity form is found on edit.
    $assert_session
      ->fieldNotExists("single[{$unexpected_item_number}][inline_entity_form][title][0][value]");
    if ($cardinality == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) {
      $next_item_number = $number_of_items;
      $page
        ->pressButton('Add another item');

      // Assert item $next_item_number does appear after 'Add More'
      // clicked.
      $this
        ->assertNotEmpty($assert_session
        ->waitForField("single[{$next_item_number}][inline_entity_form][title][0][value]"));

      // Make sure only 1 item is added.
      $unexpected_item_number = $next_item_number + 1;

      // Assert extra item $unexpected_item_number is not added after
      // 'Add More' clicked.
      $assert_session
        ->fieldNotExists("single[{$unexpected_item_number}][inline_entity_form][title][0][value]");
    }

    // Now that we have confirmed the correct fields appear, let's update the
    // values and save them. We do not have access to the form for delta 0
    // because it is owned by another user.
    $delta = 1;
    $new_titles = [];
    $edit = [];

    // Loop through an update all child node titles.
    while ($delta < $number_of_items) {

      /** @var \Drupal\node\Entity\Node $child_node */
      $child_node = $host_node->single[$delta]->entity;
      $new_titles[$delta] = $child_node
        ->label() . ' - updated';
      $edit["single[{$delta}][inline_entity_form][title][0][value]"] = $new_titles[$delta];
      $delta++;
    }

    // If cardinality equals CARDINALITY_UNLIMITED then we should have 1 extra
    // form open.
    if ($cardinality === FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) {
      $new_titles[$delta] = 'Title for new child';
      $edit["single[{$delta}][inline_entity_form][title][0][value]"] = $new_titles[$delta];
    }
    $this
      ->submitForm($edit, 'Save');
    $assert_session
      ->pageTextContains("IEF simple single {$host_node->label()} has been updated.");

    // Reset cache for nodes.
    $node_ids = [
      $host_node
        ->id(),
    ];
    foreach ($host_node->single as $item) {
      $node_ids[] = $item->entity
        ->id();
    }
    $this->container
      ->get('entity_type.manager')
      ->getStorage('node')
      ->resetCache($node_ids);
    $host_node = Node::load($host_node
      ->id());

    // Check that titles were updated.
    foreach ($new_titles as $delta => $new_title) {
      $child_node = $host_node->single[$delta]->entity;
      $this
        ->assertSame($new_title, $child_node
        ->label(), "Child {$delta} node title has been updated.");
    }
  }

}

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
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::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::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
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::getHttpClient protected function Obtain the HTTP client for the system under test.
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::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
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.
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::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::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.
InlineEntityFormTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
InlineEntityFormTestBase::$fieldConfigStorage protected property Field config storage.
InlineEntityFormTestBase::$fieldStorageConfigStorage protected property Field config storage.
InlineEntityFormTestBase::$user protected property User with permissions to create content.
InlineEntityFormTestBase::assertEntityByLabel protected function Ensures that an entity with a specific label exists.
InlineEntityFormTestBase::assertNodeByTitle protected function Passes if a node is found for the title.
InlineEntityFormTestBase::assertNoNodeByTitle protected function Passes if no node is found for the title.
InlineEntityFormTestBase::assertNoRowByTitle protected function Asserts that an IEF table row does not exist.
InlineEntityFormTestBase::assertRowByTitle protected function Asserts that an IEF table row exists.
InlineEntityFormTestBase::checkFormDisplayFields protected function Checks for check correct fields on form displays.
InlineEntityFormTestBase::getButtonName protected function Gets IEF button name.
InlineEntityFormTestBase::getXpathForAutoCompleteInput protected function Returns xpath selector to the first input with an auto-complete.
InlineEntityFormTestBase::getXpathForButtonWithValue protected function Returns xpath selector to the index-th button with button text value.
InlineEntityFormTestBase::getXpathForFieldsetLabel protected function Returns xpath selector for fieldset label.
InlineEntityFormTestBase::getXpathForNthInputByLabelText protected function Returns xpath selector to the index-th input with label.
InlineEntityFormTestBase::prepareSettings protected function Prepares site settings and services before installation. Overrides FunctionalTestSetupTrait::prepareSettings
InlineEntityFormTestBase::waitForRowByTitle protected function Wait for an IEF table row to appear.
InlineEntityFormTestBase::waitForRowRemovedByTitle protected function Wait for an IEF table row to disappear.
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.
SimpleWidgetTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
SimpleWidgetTest::checkEditAccess protected function Tests that user only has access to the their own nodes.
SimpleWidgetTest::setUp protected function Overrides InlineEntityFormTestBase::setUp
SimpleWidgetTest::testEntityWithoutBundle public function Ensures that an entity without bundles can be used with the simple widget.
SimpleWidgetTest::testSimpleCardinalityOptions public function Tests simple IEF widget with different cardinality options.
SimpleWidgetTest::testSimpleCreateAccess public function Tests if the entity create access works in the simple widget.
SimpleWidgetTest::testSimpleValidation public function Test Validation on Simple Widget.
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::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.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$minkDefaultDriverClass protected property To use a legacy phantomjs based approach, please use PhantomJSDriver::class. Overrides BrowserTestBase::$minkDefaultDriverClass 2
WebDriverTestBase::assertElementNotVisible Deprecated protected function Asserts that the element with the given CSS selector is not visible.
WebDriverTestBase::assertElementVisible Deprecated protected function Asserts that the element with the given CSS selector is visible.
WebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession 1
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::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. Overrides BrowserTestBase::getMinkDriverArgs
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink 1
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.