You are here

class EntityAutocompleteElementFormTest in Drupal 8

Same name and namespace in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Entity/Element/EntityAutocompleteElementFormTest.php \Drupal\KernelTests\Core\Entity\Element\EntityAutocompleteElementFormTest

Tests the EntityAutocomplete Form API element.

@group Form

Hierarchy

Expanded class hierarchy of EntityAutocompleteElementFormTest

File

core/tests/Drupal/KernelTests/Core/Entity/Element/EntityAutocompleteElementFormTest.php, line 20

Namespace

Drupal\KernelTests\Core\Entity\Element
View source
class EntityAutocompleteElementFormTest extends EntityKernelTestBase implements FormInterface {

  /**
   * User for testing.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $testUser;

  /**
   * User for autocreate testing.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $testAutocreateUser;

  /**
   * An array of entities to be referenced in this test.
   *
   * @var \Drupal\Core\Entity\EntityInterface[]
   */
  protected $referencedEntities;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installSchema('system', [
      'key_value_expire',
    ]);
    $this
      ->installEntitySchema('entity_test_string_id');
    \Drupal::service('router.builder')
      ->rebuild();
    $this->testUser = User::create([
      'name' => 'foobar1',
      'mail' => 'foobar1@example.com',
    ]);
    $this->testUser
      ->save();
    \Drupal::service('current_user')
      ->setAccount($this->testUser);
    $this->testAutocreateUser = User::create([
      'name' => 'foobar2',
      'mail' => 'foobar2@example.com',
    ]);
    $this->testAutocreateUser
      ->save();
    for ($i = 1; $i < 3; $i++) {
      $entity = EntityTest::create([
        'name' => $this
          ->randomMachineName(),
      ]);
      $entity
        ->save();
      $this->referencedEntities[] = $entity;
    }

    // Use special characters in the ID of some of the test entities so we can
    // test if these are handled correctly.
    for ($i = 0; $i < 2; $i++) {
      $entity = EntityTestStringId::create([
        'name' => $this
          ->randomMachineName(),
        'id' => $this
          ->randomMachineName() . '&</\\:?',
      ]);
      $entity
        ->save();
      $this->referencedEntities[] = $entity;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'test_entity_autocomplete';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['single'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'entity_test',
    ];
    $form['single_autocreate'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'entity_test',
      '#autocreate' => [
        'bundle' => 'entity_test',
      ],
    ];
    $form['single_autocreate_specific_uid'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'entity_test',
      '#autocreate' => [
        'bundle' => 'entity_test',
        'uid' => $this->testAutocreateUser
          ->id(),
      ],
    ];
    $form['tags'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'entity_test',
      '#tags' => TRUE,
    ];
    $form['tags_autocreate'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'entity_test',
      '#tags' => TRUE,
      '#autocreate' => [
        'bundle' => 'entity_test',
      ],
    ];
    $form['tags_autocreate_specific_uid'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'entity_test',
      '#tags' => TRUE,
      '#autocreate' => [
        'bundle' => 'entity_test',
        'uid' => $this->testAutocreateUser
          ->id(),
      ],
    ];
    $form['single_no_validate'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'entity_test',
      '#validate_reference' => FALSE,
    ];
    $form['single_autocreate_no_validate'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'entity_test',
      '#validate_reference' => FALSE,
      '#autocreate' => [
        'bundle' => 'entity_test',
      ],
    ];
    $form['single_access'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'entity_test',
      '#default_value' => $this->referencedEntities[0],
    ];
    $form['tags_access'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'entity_test',
      '#tags' => TRUE,
      '#default_value' => [
        $this->referencedEntities[0],
        $this->referencedEntities[1],
      ],
    ];
    $form['single_string_id'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'entity_test_string_id',
    ];
    $form['tags_string_id'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'entity_test_string_id',
      '#tags' => TRUE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * Tests valid entries in the EntityAutocomplete Form API element.
   */
  public function testValidEntityAutocompleteElement() {
    $form_state = (new FormState())
      ->setValues([
      'single' => $this
        ->getAutocompleteInput($this->referencedEntities[0]),
      'single_autocreate' => 'single - autocreated entity label',
      'single_autocreate_specific_uid' => 'single - autocreated entity label with specific uid',
      'tags' => $this
        ->getAutocompleteInput($this->referencedEntities[0]) . ', ' . $this
        ->getAutocompleteInput($this->referencedEntities[1]),
      'tags_autocreate' => $this
        ->getAutocompleteInput($this->referencedEntities[0]) . ', tags - autocreated entity label, ' . $this
        ->getAutocompleteInput($this->referencedEntities[1]),
      'tags_autocreate_specific_uid' => $this
        ->getAutocompleteInput($this->referencedEntities[0]) . ', tags - autocreated entity label with specific uid, ' . $this
        ->getAutocompleteInput($this->referencedEntities[1]),
      'single_string_id' => $this
        ->getAutocompleteInput($this->referencedEntities[2]),
      'tags_string_id' => $this
        ->getAutocompleteInput($this->referencedEntities[2]) . ', ' . $this
        ->getAutocompleteInput($this->referencedEntities[3]),
    ]);
    $form_builder = $this->container
      ->get('form_builder');
    $form_builder
      ->submitForm($this, $form_state);

    // Valid form state.
    $this
      ->assertCount(0, $form_state
      ->getErrors());

    // Test the 'single' element.
    $this
      ->assertEqual($form_state
      ->getValue('single'), $this->referencedEntities[0]
      ->id());

    // Test the 'single_autocreate' element.
    $value = $form_state
      ->getValue('single_autocreate');
    $this
      ->assertEqual($value['entity']
      ->label(), 'single - autocreated entity label');
    $this
      ->assertEqual($value['entity']
      ->bundle(), 'entity_test');
    $this
      ->assertEqual($value['entity']
      ->getOwnerId(), $this->testUser
      ->id());

    // Test the 'single_autocreate_specific_uid' element.
    $value = $form_state
      ->getValue('single_autocreate_specific_uid');
    $this
      ->assertEqual($value['entity']
      ->label(), 'single - autocreated entity label with specific uid');
    $this
      ->assertEqual($value['entity']
      ->bundle(), 'entity_test');
    $this
      ->assertEqual($value['entity']
      ->getOwnerId(), $this->testAutocreateUser
      ->id());

    // Test the 'tags' element.
    $expected = [
      [
        'target_id' => $this->referencedEntities[0]
          ->id(),
      ],
      [
        'target_id' => $this->referencedEntities[1]
          ->id(),
      ],
    ];
    $this
      ->assertEqual($form_state
      ->getValue('tags'), $expected);

    // Test the 'single_autocreate' element.
    $value = $form_state
      ->getValue('tags_autocreate');

    // First value is an existing entity.
    $this
      ->assertEqual($value[0]['target_id'], $this->referencedEntities[0]
      ->id());

    // Second value is an autocreated entity.
    $this
      ->assertTrue(!isset($value[1]['target_id']));
    $this
      ->assertEqual($value[1]['entity']
      ->label(), 'tags - autocreated entity label');
    $this
      ->assertEqual($value[1]['entity']
      ->getOwnerId(), $this->testUser
      ->id());

    // Third value is an existing entity.
    $this
      ->assertEqual($value[2]['target_id'], $this->referencedEntities[1]
      ->id());

    // Test the 'tags_autocreate_specific_uid' element.
    $value = $form_state
      ->getValue('tags_autocreate_specific_uid');

    // First value is an existing entity.
    $this
      ->assertEqual($value[0]['target_id'], $this->referencedEntities[0]
      ->id());

    // Second value is an autocreated entity.
    $this
      ->assertTrue(!isset($value[1]['target_id']));
    $this
      ->assertEqual($value[1]['entity']
      ->label(), 'tags - autocreated entity label with specific uid');
    $this
      ->assertEqual($value[1]['entity']
      ->getOwnerId(), $this->testAutocreateUser
      ->id());

    // Third value is an existing entity.
    $this
      ->assertEqual($value[2]['target_id'], $this->referencedEntities[1]
      ->id());

    // Test the 'single_string_id' element.
    $this
      ->assertEquals($this->referencedEntities[2]
      ->id(), $form_state
      ->getValue('single_string_id'));

    // Test the 'tags_string_id' element.
    $expected = [
      [
        'target_id' => $this->referencedEntities[2]
          ->id(),
      ],
      [
        'target_id' => $this->referencedEntities[3]
          ->id(),
      ],
    ];
    $this
      ->assertEquals($expected, $form_state
      ->getValue('tags_string_id'));
  }

  /**
   * Tests invalid entries in the EntityAutocomplete Form API element.
   */
  public function testInvalidEntityAutocompleteElement() {
    $form_builder = $this->container
      ->get('form_builder');

    // Test 'single' with a entity label that doesn't exist
    $form_state = (new FormState())
      ->setValues([
      'single' => 'single - non-existent label',
    ]);
    $form_builder
      ->submitForm($this, $form_state);
    $this
      ->assertCount(1, $form_state
      ->getErrors());
    $this
      ->assertEqual($form_state
      ->getErrors()['single'], t('There are no entities matching "%value".', [
      '%value' => 'single - non-existent label',
    ]));

    // Test 'single' with a entity ID that doesn't exist.
    $form_state = (new FormState())
      ->setValues([
      'single' => 'single - non-existent label (42)',
    ]);
    $form_builder
      ->submitForm($this, $form_state);
    $this
      ->assertCount(1, $form_state
      ->getErrors());
    $this
      ->assertEqual($form_state
      ->getErrors()['single'], t('The referenced entity (%type: %id) does not exist.', [
      '%type' => 'entity_test',
      '%id' => 42,
    ]));

    // Do the same tests as above but on an element with '#validate_reference'
    // set to FALSE.
    $form_state = (new FormState())
      ->setValues([
      'single_no_validate' => 'single - non-existent label',
      'single_autocreate_no_validate' => 'single - autocreate non-existent label',
    ]);
    $form_builder
      ->submitForm($this, $form_state);

    // The element without 'autocreate' support still has to emit a warning when
    // the input doesn't end with an entity ID enclosed in parentheses.
    $this
      ->assertCount(1, $form_state
      ->getErrors());
    $this
      ->assertEqual($form_state
      ->getErrors()['single_no_validate'], t('There are no entities matching "%value".', [
      '%value' => 'single - non-existent label',
    ]));
    $form_state = (new FormState())
      ->setValues([
      'single_no_validate' => 'single - non-existent label (42)',
      'single_autocreate_no_validate' => 'single - autocreate non-existent label (43)',
    ]);
    $form_builder
      ->submitForm($this, $form_state);

    // The input is complete (i.e. contains an entity ID at the end), no errors
    // are triggered.
    $this
      ->assertCount(0, $form_state
      ->getErrors());
  }

  /**
   * Tests that access is properly checked by the EntityAutocomplete element.
   */
  public function testEntityAutocompleteAccess() {
    $form_builder = $this->container
      ->get('form_builder');
    $form = $form_builder
      ->getForm($this);

    // Check that the current user has proper access to view entity labels.
    $expected = $this->referencedEntities[0]
      ->label() . ' (' . $this->referencedEntities[0]
      ->id() . ')';
    $this
      ->assertEqual($form['single_access']['#value'], $expected);
    $expected .= ', ' . $this->referencedEntities[1]
      ->label() . ' (' . $this->referencedEntities[1]
      ->id() . ')';
    $this
      ->assertEqual($form['tags_access']['#value'], $expected);

    // Set up a non-admin user that is *not* allowed to view test entities.
    \Drupal::currentUser()
      ->setAccount($this
      ->createUser([], []));

    // Rebuild the form.
    $form = $form_builder
      ->getForm($this);
    $expected = t('- Restricted access -') . ' (' . $this->referencedEntities[0]
      ->id() . ')';
    $this
      ->assertEqual($form['single_access']['#value'], $expected);
    $expected .= ', ' . t('- Restricted access -') . ' (' . $this->referencedEntities[1]
      ->id() . ')';
    $this
      ->assertEqual($form['tags_access']['#value'], $expected);
  }

  /**
   * Tests ID input is handled correctly.
   *
   * E.g. This can happen with GET form parameters.
   */
  public function testEntityAutocompleteIdInput() {

    /** @var \Drupal\Core\Form\FormBuilderInterface $form_builder */
    $form_builder = $this->container
      ->get('form_builder');

    // $form = $form_builder->getForm($this);
    $form_state = (new FormState())
      ->setMethod('GET')
      ->setValues([
      'single' => [
        [
          'target_id' => $this->referencedEntities[0]
            ->id(),
        ],
      ],
      'single_no_validate' => [
        [
          'target_id' => $this->referencedEntities[0]
            ->id(),
        ],
      ],
    ]);
    $form_builder
      ->submitForm($this, $form_state);
    $form = $form_state
      ->getCompleteForm();
    $expected_label = $this
      ->getAutocompleteInput($this->referencedEntities[0]);
    $this
      ->assertSame($expected_label, $form['single']['#value']);
    $this
      ->assertSame($expected_label, $form['single_no_validate']['#value']);
  }

  /**
   * Returns an entity label in the format needed by the EntityAutocomplete
   * element.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   A Drupal entity.
   *
   * @return string
   *   A string that can be used as a value for EntityAutocomplete elements.
   */
  protected function getAutocompleteInput(EntityInterface $entity) {
    return EntityAutocomplete::getEntityLabels([
      $entity,
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
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::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
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::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
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.
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityAutocompleteElementFormTest::$referencedEntities protected property An array of entities to be referenced in this test.
EntityAutocompleteElementFormTest::$testAutocreateUser protected property User for autocreate testing.
EntityAutocompleteElementFormTest::$testUser protected property User for testing.
EntityAutocompleteElementFormTest::buildForm public function Form constructor. Overrides FormInterface::buildForm
EntityAutocompleteElementFormTest::getAutocompleteInput protected function Returns an entity label in the format needed by the EntityAutocomplete element.
EntityAutocompleteElementFormTest::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
EntityAutocompleteElementFormTest::setUp protected function Overrides EntityKernelTestBase::setUp
EntityAutocompleteElementFormTest::submitForm public function Form submission handler. Overrides FormInterface::submitForm
EntityAutocompleteElementFormTest::testEntityAutocompleteAccess public function Tests that access is properly checked by the EntityAutocomplete element.
EntityAutocompleteElementFormTest::testEntityAutocompleteIdInput public function Tests ID input is handled correctly.
EntityAutocompleteElementFormTest::testInvalidEntityAutocompleteElement public function Tests invalid entries in the EntityAutocomplete Form API element.
EntityAutocompleteElementFormTest::testValidEntityAutocompleteElement public function Tests valid entries in the EntityAutocomplete Form API element.
EntityAutocompleteElementFormTest::validateForm public function Form validation handler. Overrides FormInterface::validateForm
EntityKernelTestBase::$deprecatedProperties protected property The list of deprecated services.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$modules public static property Modules to enable. Overrides KernelTestBase::$modules 57
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
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. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser