You are here

Home » API reference » Drupal 8 » EntityReferenceFieldTest.php

class EntityReferenceFieldTest in Drupal 8

Same name and namespace in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Entity/EntityReferenceFieldTest.php \Drupal\KernelTests\Core\Entity\EntityReferenceFieldTest
  2. 10 core/tests/Drupal/KernelTests/Core/Entity/EntityReferenceFieldTest.php \Drupal\KernelTests\Core\Entity\EntityReferenceFieldTest

Tests for the entity reference field.

@group Entity

Hierarchy

Expanded class hierarchy of EntityReferenceFieldTest

File

core/tests/Drupal/KernelTests/Core/Entity/EntityReferenceFieldTest.php, line 24

Namespace

Drupal\KernelTests\Core\Entity
View source 
class EntityReferenceFieldTest extends EntityKernelTestBase {
  use SchemaCheckTestTrait;
  use EntityReferenceTestTrait;

  /**
   * The entity type used in this test.
   *
   * @var string
   */
  protected $entityType = 'entity_test';

  /**
   * The entity type that is being referenced.
   *
   * @var string
   */
  protected $referencedEntityType = 'entity_test_rev';

  /**
   * The bundle used in this test.
   *
   * @var string
   */
  protected $bundle = 'entity_test';

  /**
   * The name of the field used in this test.
   *
   * @var string
   */
  protected $fieldName = 'field_test';

  /**
   * Modules to install.
   *
   * @var array
   */
  public static $modules = [
    'entity_reference_test',
    'entity_test_update',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('entity_test_rev');

    // Create a field.
    $this
      ->createEntityReferenceField($this->entityType, $this->bundle, $this->fieldName, 'Field test', $this->referencedEntityType, 'default', [
      'target_bundles' => [
        $this->bundle,
      ],
    ], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
  }

  /**
   * Tests reference field validation.
   */
  public function testEntityReferenceFieldValidation() {

    // Test a valid reference.
    $referenced_entity = $this->container
      ->get('entity_type.manager')
      ->getStorage($this->referencedEntityType)
      ->create([
      'type' => $this->bundle,
    ]);
    $referenced_entity
      ->save();
    $entity = $this->container
      ->get('entity_type.manager')
      ->getStorage($this->entityType)
      ->create([
      'type' => $this->bundle,
    ]);
    $entity->{$this->fieldName}->target_id = $referenced_entity
      ->id();
    $violations = $entity->{$this->fieldName}
      ->validate();
    $this
      ->assertEqual($violations
      ->count(), 0, 'Validation passes.');

    // Test an invalid reference.
    $entity->{$this->fieldName}->target_id = 9999;
    $violations = $entity->{$this->fieldName}
      ->validate();
    $this
      ->assertEqual($violations
      ->count(), 1, 'Validation throws a violation.');
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('The referenced entity (%type: %id) does not exist.', [
      '%type' => $this->referencedEntityType,
      '%id' => 9999,
    ]));

    // Test a non-referenceable bundle.
    entity_test_create_bundle('non_referenceable', NULL, $this->referencedEntityType);
    $referenced_entity = $this->entityTypeManager
      ->getStorage($this->referencedEntityType)
      ->create([
      'type' => 'non_referenceable',
    ]);
    $referenced_entity
      ->save();
    $entity->{$this->fieldName}->target_id = $referenced_entity
      ->id();
    $violations = $entity->{$this->fieldName}
      ->validate();
    $this
      ->assertEqual($violations
      ->count(), 1, 'Validation throws a violation.');
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('This entity (%type: %id) cannot be referenced.', [
      '%type' => $this->referencedEntityType,
      '%id' => $referenced_entity
        ->id(),
    ]));
  }

  /**
   * Tests the multiple target entities loader.
   */
  public function testReferencedEntitiesMultipleLoad() {

    // Create the parent entity.
    $entity = $this->container
      ->get('entity_type.manager')
      ->getStorage($this->entityType)
      ->create([
      'type' => $this->bundle,
    ]);

    // Create three target entities and attach them to parent field.
    $target_entities = [];
    $reference_field = [];
    for ($i = 0; $i < 3; $i++) {
      $target_entity = $this->container
        ->get('entity_type.manager')
        ->getStorage($this->referencedEntityType)
        ->create([
        'type' => $this->bundle,
      ]);
      $target_entity
        ->save();
      $target_entities[] = $target_entity;
      $reference_field[]['target_id'] = $target_entity
        ->id();
    }

    // Also attach a non-existent entity and a NULL target id.
    $reference_field[3]['target_id'] = 99999;
    $target_entities[3] = NULL;
    $reference_field[4]['target_id'] = NULL;
    $target_entities[4] = NULL;

    // Attach the first created target entity as the sixth item ($delta == 5) of
    // the parent entity field. We want to test the case when the same target
    // entity is referenced twice (or more times) in the same entity reference
    // field.
    $reference_field[5] = $reference_field[0];
    $target_entities[5] = $target_entities[0];

    // Create a new target entity that is not saved, thus testing the
    // "autocreate" feature.
    $target_entity_unsaved = $this->container
      ->get('entity_type.manager')
      ->getStorage($this->referencedEntityType)
      ->create([
      'type' => $this->bundle,
      'name' => $this
        ->randomString(),
    ]);
    $reference_field[6]['entity'] = $target_entity_unsaved;
    $target_entities[6] = $target_entity_unsaved;

    // Set the field value.
    $entity->{$this->fieldName}
      ->setValue($reference_field);

    // Load the target entities using EntityReferenceField::referencedEntities().
    $entities = $entity->{$this->fieldName}
      ->referencedEntities();

    // Test returned entities:
    // - Deltas must be preserved.
    // - Non-existent entities must not be retrieved in target entities result.
    foreach ($target_entities as $delta => $target_entity) {
      if (!empty($target_entity)) {
        if (!$target_entity
          ->isNew()) {

          // There must be an entity in the loaded set having the same id for
          // the same delta.
          $this
            ->assertEqual($target_entity
            ->id(), $entities[$delta]
            ->id());
        }
        else {

          // For entities that were not yet saved, there must an entity in the
          // loaded set having the same label for the same delta.
          $this
            ->assertEqual($target_entity
            ->label(), $entities[$delta]
            ->label());
        }
      }
      else {

        // A non-existent or NULL entity target id must not return any item in
        // the target entities set.
        $this
          ->assertFalse(isset($entities[$delta]));
      }
    }
  }

  /**
   * Tests referencing entities with string IDs.
   */
  public function testReferencedEntitiesStringId() {
    $field_name = 'entity_reference_string_id';
    $this
      ->installEntitySchema('entity_test_string_id');
    $this
      ->createEntityReferenceField($this->entityType, $this->bundle, $field_name, 'Field test', 'entity_test_string_id', 'default', [
      'target_bundles' => [
        $this->bundle,
      ],
    ], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);

    // Create the parent entity.
    $entity = $this->container
      ->get('entity_type.manager')
      ->getStorage($this->entityType)
      ->create([
      'type' => $this->bundle,
    ]);

    // Create the default target entity.
    $target_entity = EntityTestStringId::create([
      'id' => $this
        ->randomString(),
      'type' => $this->bundle,
    ]);
    $target_entity
      ->save();

    // Set the field value.
    $entity->{$field_name}
      ->setValue([
      [
        'target_id' => $target_entity
          ->id(),
      ],
    ]);

    // Load the target entities using EntityReferenceField::referencedEntities().
    $entities = $entity->{$field_name}
      ->referencedEntities();
    $this
      ->assertEqual($entities[0]
      ->id(), $target_entity
      ->id());

    // Test that a string ID works as a default value and the field's config
    // schema is correct.
    $field = FieldConfig::loadByName($this->entityType, $this->bundle, $field_name);
    $field
      ->setDefaultValue($target_entity
      ->id());
    $field
      ->save();
    $this
      ->assertConfigSchema(\Drupal::service('config.typed'), 'field.field.' . $field
      ->id(), $field
      ->toArray());

    // Test that the default value works.
    $entity = $this->container
      ->get('entity_type.manager')
      ->getStorage($this->entityType)
      ->create([
      'type' => $this->bundle,
    ]);
    $entities = $entity->{$field_name}
      ->referencedEntities();
    $this
      ->assertEqual($entities[0]
      ->id(), $target_entity
      ->id());
  }

  /**
   * Tests all the possible ways to autocreate an entity via the API.
   */
  public function testAutocreateApi() {
    $entity = $this->entityTypeManager
      ->getStorage($this->entityType)
      ->create([
      'name' => $this
        ->randomString(),
    ]);

    // Test content entity autocreation.
    $this
      ->assertUserAutocreate($entity, function (EntityInterface $entity, UserInterface $user) {
      $entity
        ->set('user_id', $user);
    });
    $this
      ->assertUserAutocreate($entity, function (EntityInterface $entity, UserInterface $user) {
      $entity
        ->set('user_id', $user, FALSE);
    });
    $this
      ->assertUserAutocreate($entity, function (EntityInterface $entity, UserInterface $user) {
      $entity->user_id
        ->setValue($user);
    });
    $this
      ->assertUserAutocreate($entity, function (EntityInterface $entity, UserInterface $user) {
      $entity->user_id[0]
        ->get('entity')
        ->setValue($user);
    });
    $this
      ->assertUserAutocreate($entity, function (EntityInterface $entity, UserInterface $user) {
      $entity->user_id
        ->setValue([
        'entity' => $user,
        'target_id' => NULL,
      ]);
    });
    try {
      $message = 'Setting both the entity and an invalid target_id property fails.';
      $this
        ->assertUserAutocreate($entity, function (EntityInterface $entity, UserInterface $user) {
        $user
          ->save();
        $entity->user_id
          ->setValue([
          'entity' => $user,
          'target_id' => $this
            ->generateRandomEntityId(),
        ]);
      });
      $this
        ->fail($message);
    } catch (\InvalidArgumentException $e) {

      // Expected exception; just continue testing.
    }
    $this
      ->assertUserAutocreate($entity, function (EntityInterface $entity, UserInterface $user) {
      $entity->user_id = $user;
    });
    $this
      ->assertUserAutocreate($entity, function (EntityInterface $entity, UserInterface $user) {
      $entity->user_id->entity = $user;
    });

    // Test config entity autocreation.
    $this
      ->assertUserRoleAutocreate($entity, function (EntityInterface $entity, RoleInterface $role) {
      $entity
        ->set('user_role', $role);
    });
    $this
      ->assertUserRoleAutocreate($entity, function (EntityInterface $entity, RoleInterface $role) {
      $entity
        ->set('user_role', $role, FALSE);
    });
    $this
      ->assertUserRoleAutocreate($entity, function (EntityInterface $entity, RoleInterface $role) {
      $entity->user_role
        ->setValue($role);
    });
    $this
      ->assertUserRoleAutocreate($entity, function (EntityInterface $entity, RoleInterface $role) {
      $entity->user_role[0]
        ->get('entity')
        ->setValue($role);
    });
    $this
      ->assertUserRoleAutocreate($entity, function (EntityInterface $entity, RoleInterface $role) {
      $entity->user_role
        ->setValue([
        'entity' => $role,
        'target_id' => NULL,
      ]);
    });
    try {
      $message = 'Setting both the entity and an invalid target_id property fails.';
      $this
        ->assertUserRoleAutocreate($entity, function (EntityInterface $entity, RoleInterface $role) {
        $role
          ->save();
        $entity->user_role
          ->setValue([
          'entity' => $role,
          'target_id' => $this
            ->generateRandomEntityId(TRUE),
        ]);
      });
      $this
        ->fail($message);
    } catch (\InvalidArgumentException $e) {

      // Expected exception; just continue testing.
    }
    $this
      ->assertUserRoleAutocreate($entity, function (EntityInterface $entity, RoleInterface $role) {
      $entity->user_role = $role;
    });
    $this
      ->assertUserRoleAutocreate($entity, function (EntityInterface $entity, RoleInterface $role) {
      $entity->user_role->entity = $role;
    });

    // Test target entity saving after setting it as new.
    $storage = $this->entityTypeManager
      ->getStorage('user');
    $user_id = $this
      ->generateRandomEntityId();
    $user = $storage
      ->create([
      'uid' => $user_id,
      'name' => $this
        ->randomString(),
    ]);
    $entity->user_id = $user;
    $user
      ->save();
    $entity
      ->save();
    $this
      ->assertEqual($entity->user_id->target_id, $user
      ->id());
  }

  /**
   * Asserts that the setter callback performs autocreation for users.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The referencing entity.
   * @param $setter_callback
   *   A callback setting the target entity on the referencing entity.
   *
   * @return bool
   *   TRUE if the user was autocreated, FALSE otherwise.
   */
  protected function assertUserAutocreate(EntityInterface $entity, $setter_callback) {
    $storage = $this->entityTypeManager
      ->getStorage('user');
    $user_id = $this
      ->generateRandomEntityId();
    $user = $storage
      ->create([
      'uid' => $user_id,
      'name' => $this
        ->randomString(),
    ]);
    $setter_callback($entity, $user);
    $entity
      ->save();
    $storage
      ->resetCache();
    $user = User::load($user_id);
    return $this
      ->assertEqual($entity->user_id->target_id, $user
      ->id());
  }

  /**
   * Asserts that the setter callback performs autocreation for user roles.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The referencing entity.
   * @param $setter_callback
   *   A callback setting the target entity on the referencing entity.
   *
   * @return bool
   *   TRUE if the user was autocreated, FALSE otherwise.
   */
  protected function assertUserRoleAutocreate(EntityInterface $entity, $setter_callback) {
    $storage = $this->entityTypeManager
      ->getStorage('user_role');
    $role_id = $this
      ->generateRandomEntityId(TRUE);
    $role = $storage
      ->create([
      'id' => $role_id,
      'label' => $this
        ->randomString(),
    ]);
    $setter_callback($entity, $role);
    $entity
      ->save();
    $storage
      ->resetCache();
    $role = Role::load($role_id);
    return $this
      ->assertEqual($entity->user_role->target_id, $role
      ->id());
  }

  /**
   * Tests that the target entity is not unnecessarily loaded.
   */
  public function testTargetEntityNoLoad() {

    // Setup a test entity type with an entity reference field to itself. We use
    // a special storage class throwing exceptions when a load operation is
    // triggered to be able to detect them.
    $entity_type = clone $this->entityTypeManager
      ->getDefinition('entity_test_update');
    $entity_type
      ->setHandlerClass('storage', '\\Drupal\\entity_test\\EntityTestNoLoadStorage');
    $this->state
      ->set('entity_test_update.entity_type', $entity_type);
    $definitions = [
      'target_reference' => BaseFieldDefinition::create('entity_reference')
        ->setSetting('target_type', $entity_type
        ->id())
        ->setSetting('handler', 'default'),
    ];
    $this->state
      ->set('entity_test_update.additional_base_field_definitions', $definitions);
    $this->entityTypeManager
      ->clearCachedDefinitions();
    $this
      ->installEntitySchema($entity_type
      ->id());

    // Create the target entity.
    $storage = $this->entityTypeManager
      ->getStorage($entity_type
      ->id());
    $target_id = $this
      ->generateRandomEntityId();
    $target = $storage
      ->create([
      'id' => $target_id,
      'name' => $this
        ->randomString(),
    ]);
    $target
      ->save();
    $this
      ->assertEqual($target_id, $target
      ->id(), 'The target entity has a random identifier.');

    // Check that populating the reference with an existing target id does not
    // trigger a load operation.
    $message = 'The target entity was not loaded.';
    try {
      $entity = $this->entityTypeManager
        ->getStorage($entity_type
        ->id())
        ->create([
        'name' => $this
          ->randomString(),
      ]);
      $entity->target_reference = $target_id;
    } catch (EntityStorageException $e) {
      $this
        ->fail($message);
    }

    // Check that the storage actually triggers the expected exception when
    // trying to load the target entity.
    $message = 'An exception is thrown when trying to load the target entity';
    try {
      $storage
        ->load($target_id);
      $this
        ->fail($message);
    } catch (EntityStorageException $e) {

      // Expected exception; just continue testing.
    }
  }

  /**
   * Tests the dependencies entity reference fields are created with.
   */
  public function testEntityReferenceFieldDependencies() {
    $field_name = 'user_reference_field';
    $entity_type = 'entity_test';
    $field_storage = FieldStorageConfig::create([
      'field_name' => $field_name,
      'type' => 'entity_reference',
      'entity_type' => $entity_type,
      'settings' => [
        'target_type' => 'user',
      ],
    ]);
    $field_storage
      ->save();
    $this
      ->assertEqual([
      'module' => [
        'entity_test',
        'user',
      ],
    ], $field_storage
      ->getDependencies());
    $field = FieldConfig::create([
      'field_name' => $field_name,
      'entity_type' => $entity_type,
      'bundle' => 'entity_test',
      'label' => $field_name,
      'settings' => [
        'handler' => 'default',
      ],
    ]);
    $field
      ->save();
    $this
      ->assertEqual([
      'config' => [
        'field.storage.entity_test.user_reference_field',
      ],
      'module' => [
        'entity_test',
      ],
    ], $field
      ->getDependencies());
  }

}

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.
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::$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.
EntityReferenceFieldTest::$bundle protected property The bundle used in this test.
EntityReferenceFieldTest::$entityType protected property The entity type used in this test.
EntityReferenceFieldTest::$fieldName protected property The name of the field used in this test.
EntityReferenceFieldTest::$modules public static property Modules to install. Overrides EntityKernelTestBase::$modules
EntityReferenceFieldTest::$referencedEntityType protected property The entity type that is being referenced.
EntityReferenceFieldTest::assertUserAutocreate protected function Asserts that the setter callback performs autocreation for users.
EntityReferenceFieldTest::assertUserRoleAutocreate protected function Asserts that the setter callback performs autocreation for user roles.
EntityReferenceFieldTest::setUp protected function Overrides EntityKernelTestBase::setUp
EntityReferenceFieldTest::testAutocreateApi public function Tests all the possible ways to autocreate an entity via the API.
EntityReferenceFieldTest::testEntityReferenceFieldDependencies public function Tests the dependencies entity reference fields are created with.
EntityReferenceFieldTest::testEntityReferenceFieldValidation public function Tests reference field validation.
EntityReferenceFieldTest::testReferencedEntitiesMultipleLoad public function Tests the multiple target entities loader.
EntityReferenceFieldTest::testReferencedEntitiesStringId public function Tests referencing entities with string IDs.
EntityReferenceFieldTest::testTargetEntityNoLoad public function Tests that the target entity is not unnecessarily loaded.
EntityReferenceTestTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
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.
SchemaCheckTestTrait::assertConfigSchema public function Asserts the TypedConfigManager has a valid schema for the configuration.
SchemaCheckTestTrait::assertConfigSchemaByName public function Asserts configuration, specified by name, has a valid schema.
SchemaCheckTrait::$configName protected property The configuration object name under test.
SchemaCheckTrait::$schema protected property The config schema wrapper object for the configuration object under test.
SchemaCheckTrait::checkConfigSchema public function Checks the TypedConfigManager has a valid schema for the configuration.
SchemaCheckTrait::checkValue protected function Helper method to check data type.
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