You are here

trait EntityReferenceTestTrait in JSON:API 8.2

Provides common functionality for the EntityReference test classes.

@todo Remove when JSON:API requires Drupal >=8.6

Hierarchy

See also

\Drupal\Tests\field\Traits\EntityReferenceTestTrait

3 files declare their use of EntityReferenceTestTrait
CommonCollectionFilterAccessTestPatternsTrait.php in tests/src/Traits/CommonCollectionFilterAccessTestPatternsTrait.php
InternalEntitiesTest.php in tests/src/Functional/InternalEntitiesTest.php
JsonApiFunctionalTestBase.php in tests/src/Functional/JsonApiFunctionalTestBase.php

File

src/BackwardCompatibility/tests/Traits/EntityReferenceTestTrait.php, line 14

Namespace

Drupal\jsonapi\BackwardCompatibility\tests\Traits
View source
trait EntityReferenceTestTrait {

  /**
   * Creates an entity reference field storage on the specified bundle.
   *
   * @param string $entity_type
   *   The type of entity the field will be attached to.
   * @param string $bundle
   *   The bundle name of the entity the field will be attached to.
   * @param string $field_name
   *   The name of the field; if it already exists, a new instance of the
   *   existing field will be created.
   * @param string $field_label
   *   The label of the field.
   * @param string $target_entity_type
   *   The type of the referenced entity.
   * @param string $selection_handler
   *   The selection handler used by this field.
   * @param array $selection_handler_settings
   *   An array of settings supported by the selection handler specified above.
   *   (e.g. 'target_bundles', 'sort', 'auto_create', etc).
   * @param int $cardinality
   *   The cardinality of the field.
   *
   * @see \Drupal\Core\Entity\Plugin\EntityReferenceSelection\SelectionBase::buildConfigurationForm()
   */
  protected function createEntityReferenceField($entity_type, $bundle, $field_name, $field_label, $target_entity_type, $selection_handler = 'default', array $selection_handler_settings = [], $cardinality = 1) {

    // Look for or add the specified field to the requested entity bundle.
    if (!FieldStorageConfig::loadByName($entity_type, $field_name)) {
      FieldStorageConfig::create([
        'field_name' => $field_name,
        'type' => 'entity_reference',
        'entity_type' => $entity_type,
        'cardinality' => $cardinality,
        'settings' => [
          'target_type' => $target_entity_type,
        ],
      ])
        ->save();
    }
    if (!FieldConfig::loadByName($entity_type, $bundle, $field_name)) {
      FieldConfig::create([
        'field_name' => $field_name,
        'entity_type' => $entity_type,
        'bundle' => $bundle,
        'label' => $field_label,
        'settings' => [
          'handler' => $selection_handler,
          'handler_settings' => $selection_handler_settings,
        ],
      ])
        ->save();
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
EntityReferenceTestTrait::createEntityReferenceField protected function Creates an entity reference field storage on the specified bundle.