You are here

class ContentTranslationFieldSyncRevisionTest in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/content_translation/tests/src/Kernel/ContentTranslationFieldSyncRevisionTest.php \Drupal\Tests\content_translation\Kernel\ContentTranslationFieldSyncRevisionTest

Tests the field synchronization logic when revisions are involved.

@group content_translation

Hierarchy

Expanded class hierarchy of ContentTranslationFieldSyncRevisionTest

File

core/modules/content_translation/tests/src/Kernel/ContentTranslationFieldSyncRevisionTest.php, line 22

Namespace

Drupal\Tests\content_translation\Kernel
View source
class ContentTranslationFieldSyncRevisionTest extends EntityKernelTestBase {
  use TestFileCreationTrait;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'file',
    'image',
    'language',
    'content_translation',
    'content_translation_test',
  ];

  /**
   * The synchronized field name.
   *
   * @var string
   */
  protected $fieldName = 'sync_field';

  /**
   * The content translation manager.
   *
   * @var \Drupal\content_translation\ContentTranslationManagerInterface|\Drupal\content_translation\BundleTranslationSettingsInterface
   */
  protected $contentTranslationManager;

  /**
   * The test entity storage.
   *
   * @var \Drupal\Core\Entity\ContentEntityStorageInterface
   */
  protected $storage;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $entity_type_id = 'entity_test_mulrev';
    $this
      ->installEntitySchema($entity_type_id);
    $this
      ->installEntitySchema('file');
    $this
      ->installSchema('file', [
      'file_usage',
    ]);
    ConfigurableLanguage::createFromLangcode('it')
      ->save();
    ConfigurableLanguage::createFromLangcode('fr')
      ->save();

    /** @var \Drupal\field\Entity\FieldStorageConfig $field_storage */
    $field_storage_config = FieldStorageConfig::create([
      'field_name' => $this->fieldName,
      'type' => 'image',
      'entity_type' => $entity_type_id,
      'cardinality' => 1,
      'translatable' => 1,
    ]);
    $field_storage_config
      ->save();
    $field_config = FieldConfig::create([
      'entity_type' => $entity_type_id,
      'field_name' => $this->fieldName,
      'bundle' => $entity_type_id,
      'label' => 'Synchronized field',
      'translatable' => 1,
    ]);
    $field_config
      ->save();
    $property_settings = [
      'alt' => 'alt',
      'title' => 'title',
      'file' => 0,
    ];
    $field_config
      ->setThirdPartySetting('content_translation', 'translation_sync', $property_settings);
    $field_config
      ->save();
    $this->contentTranslationManager = $this->container
      ->get('content_translation.manager');
    $this->contentTranslationManager
      ->setEnabled($entity_type_id, $entity_type_id, TRUE);
    $this->storage = $this->entityTypeManager
      ->getStorage($entity_type_id);
    foreach ($this
      ->getTestFiles('image') as $file) {
      $entity = File::create((array) $file + [
        'status' => 1,
      ]);
      $entity
        ->save();
    }
    $this->state
      ->set('content_translation.entity_access.file', [
      'view' => TRUE,
    ]);
    $account = User::create([
      'name' => $this
        ->randomMachineName(),
      'status' => 1,
    ]);
    $account
      ->save();
  }

  /**
   * Checks that field synchronization works as expected with revisions.
   *
   * @covers \Drupal\content_translation\Plugin\Validation\Constraint\ContentTranslationSynchronizedFieldsConstraintValidator::create
   * @covers \Drupal\content_translation\Plugin\Validation\Constraint\ContentTranslationSynchronizedFieldsConstraintValidator::validate
   * @covers \Drupal\content_translation\Plugin\Validation\Constraint\ContentTranslationSynchronizedFieldsConstraintValidator::hasSynchronizedPropertyChanges
   * @covers \Drupal\content_translation\FieldTranslationSynchronizer::getFieldSynchronizedProperties
   * @covers \Drupal\content_translation\FieldTranslationSynchronizer::synchronizeFields
   * @covers \Drupal\content_translation\FieldTranslationSynchronizer::synchronizeItems
   */
  public function testFieldSynchronizationAndValidation() {

    // Test that when untranslatable field widgets are displayed, synchronized
    // field properties can be changed only in default revisions.
    $this
      ->setUntranslatableFieldWidgetsDisplay(TRUE);
    $entity = $this
      ->saveNewEntity();
    $entity_id = $entity
      ->id();
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      1,
      1,
      1,
      'Alt 1 EN',
    ]);

    /** @var \Drupal\Core\Entity\ContentEntityInterface $en_revision */
    $en_revision = $this
      ->createRevision($entity, FALSE);
    $en_revision
      ->get($this->fieldName)->target_id = 2;
    $violations = $en_revision
      ->validate();
    $this
      ->assertViolations($violations);
    $it_translation = $entity
      ->addTranslation('it', $entity
      ->toArray());

    /** @var \Drupal\Core\Entity\ContentEntityInterface $it_revision */
    $it_revision = $this
      ->createRevision($it_translation, FALSE);
    $metadata = $this->contentTranslationManager
      ->getTranslationMetadata($it_revision);
    $metadata
      ->setSource('en');
    $it_revision
      ->get($this->fieldName)->target_id = 2;
    $it_revision
      ->get($this->fieldName)->alt = 'Alt 2 IT';
    $violations = $it_revision
      ->validate();
    $this
      ->assertViolations($violations);
    $it_revision
      ->isDefaultRevision(TRUE);
    $violations = $it_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($it_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      2,
      2,
      2,
      'Alt 1 EN',
      'Alt 2 IT',
    ]);
    $en_revision = $this
      ->createRevision($en_revision, FALSE);
    $en_revision
      ->get($this->fieldName)->alt = 'Alt 3 EN';
    $violations = $en_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($en_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      3,
      2,
      2,
      'Alt 3 EN',
      'Alt 2 IT',
    ]);
    $it_revision = $this
      ->createRevision($it_revision, FALSE);
    $it_revision
      ->get($this->fieldName)->alt = 'Alt 4 IT';
    $violations = $it_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($it_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      4,
      2,
      2,
      'Alt 1 EN',
      'Alt 4 IT',
    ]);
    $en_revision = $this
      ->createRevision($en_revision);
    $en_revision
      ->get($this->fieldName)->alt = 'Alt 5 EN';
    $violations = $en_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($en_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      5,
      2,
      2,
      'Alt 5 EN',
      'Alt 2 IT',
    ]);
    $en_revision = $this
      ->createRevision($en_revision);
    $en_revision
      ->get($this->fieldName)->target_id = 6;
    $en_revision
      ->get($this->fieldName)->alt = 'Alt 6 EN';
    $violations = $en_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($en_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      6,
      6,
      6,
      'Alt 6 EN',
      'Alt 2 IT',
    ]);
    $it_revision = $this
      ->createRevision($it_revision);
    $it_revision
      ->get($this->fieldName)->alt = 'Alt 7 IT';
    $violations = $it_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($it_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      7,
      6,
      6,
      'Alt 6 EN',
      'Alt 7 IT',
    ]);

    // Test that when untranslatable field widgets are hidden, synchronized
    // field properties can be changed only when editing the default
    // translation. This may lead to temporarily desynchronized values, when
    // saving a pending revision for the default translation that changes a
    // synchronized property (see revision 11).
    $this
      ->setUntranslatableFieldWidgetsDisplay(FALSE);
    $entity = $this
      ->saveNewEntity();
    $entity_id = $entity
      ->id();
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      8,
      1,
      1,
      'Alt 1 EN',
    ]);

    /** @var \Drupal\Core\Entity\ContentEntityInterface $en_revision */
    $en_revision = $this
      ->createRevision($entity, FALSE);
    $en_revision
      ->get($this->fieldName)->target_id = 2;
    $en_revision
      ->get($this->fieldName)->alt = 'Alt 2 EN';
    $violations = $en_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($en_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      9,
      2,
      2,
      'Alt 2 EN',
    ]);
    $it_translation = $entity
      ->addTranslation('it', $entity
      ->toArray());

    /** @var \Drupal\Core\Entity\ContentEntityInterface $it_revision */
    $it_revision = $this
      ->createRevision($it_translation, FALSE);
    $metadata = $this->contentTranslationManager
      ->getTranslationMetadata($it_revision);
    $metadata
      ->setSource('en');
    $it_revision
      ->get($this->fieldName)->target_id = 3;
    $violations = $it_revision
      ->validate();
    $this
      ->assertViolations($violations);
    $it_revision
      ->isDefaultRevision(TRUE);
    $violations = $it_revision
      ->validate();
    $this
      ->assertViolations($violations);
    $it_revision = $this
      ->createRevision($it_translation);
    $metadata = $this->contentTranslationManager
      ->getTranslationMetadata($it_revision);
    $metadata
      ->setSource('en');
    $it_revision
      ->get($this->fieldName)->alt = 'Alt 3 IT';
    $violations = $it_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($it_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      10,
      1,
      1,
      'Alt 1 EN',
      'Alt 3 IT',
    ]);
    $en_revision = $this
      ->createRevision($en_revision, FALSE);
    $en_revision
      ->get($this->fieldName)->alt = 'Alt 4 EN';
    $violations = $en_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($en_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      11,
      2,
      1,
      'Alt 4 EN',
      'Alt 3 IT',
    ]);
    $it_revision = $this
      ->createRevision($it_revision, FALSE);
    $it_revision
      ->get($this->fieldName)->alt = 'Alt 5 IT';
    $violations = $it_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($it_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      12,
      1,
      1,
      'Alt 1 EN',
      'Alt 5 IT',
    ]);
    $en_revision = $this
      ->createRevision($en_revision);
    $en_revision
      ->get($this->fieldName)->target_id = 6;
    $en_revision
      ->get($this->fieldName)->alt = 'Alt 6 EN';
    $violations = $en_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($en_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      13,
      6,
      6,
      'Alt 6 EN',
      'Alt 3 IT',
    ]);
    $it_revision = $this
      ->createRevision($it_revision);
    $it_revision
      ->get($this->fieldName)->target_id = 7;
    $violations = $it_revision
      ->validate();
    $this
      ->assertViolations($violations);
    $it_revision = $this
      ->createRevision($it_revision);
    $it_revision
      ->get($this->fieldName)->alt = 'Alt 7 IT';
    $violations = $it_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($it_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      14,
      6,
      6,
      'Alt 6 EN',
      'Alt 7 IT',
    ]);

    // Test that creating a default revision starting from a pending revision
    // having changes to synchronized properties, without introducing new
    // changes works properly.
    $this
      ->setUntranslatableFieldWidgetsDisplay(FALSE);
    $entity = $this
      ->saveNewEntity();
    $entity_id = $entity
      ->id();
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      15,
      1,
      1,
      'Alt 1 EN',
    ]);
    $it_translation = $entity
      ->addTranslation('it', $entity
      ->toArray());

    /** @var \Drupal\Core\Entity\ContentEntityInterface $it_revision */
    $it_revision = $this
      ->createRevision($it_translation);
    $metadata = $this->contentTranslationManager
      ->getTranslationMetadata($it_revision);
    $metadata
      ->setSource('en');
    $it_revision
      ->get($this->fieldName)->alt = 'Alt 2 IT';
    $violations = $it_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($it_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      16,
      1,
      1,
      'Alt 1 EN',
      'Alt 2 IT',
    ]);

    /** @var \Drupal\Core\Entity\ContentEntityInterface $en_revision */
    $en_revision = $this
      ->createRevision($entity);
    $en_revision
      ->get($this->fieldName)->target_id = 3;
    $en_revision
      ->get($this->fieldName)->alt = 'Alt 3 EN';
    $violations = $en_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($en_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      17,
      3,
      3,
      'Alt 3 EN',
      'Alt 2 IT',
    ]);
    $en_revision = $this
      ->createRevision($entity, FALSE);
    $en_revision
      ->get($this->fieldName)->target_id = 4;
    $en_revision
      ->get($this->fieldName)->alt = 'Alt 4 EN';
    $violations = $en_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($en_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      18,
      4,
      3,
      'Alt 4 EN',
      'Alt 2 IT',
    ]);
    $en_revision = $this
      ->createRevision($entity);
    $violations = $en_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($en_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      19,
      4,
      4,
      'Alt 4 EN',
      'Alt 2 IT',
    ]);
    $it_revision = $this
      ->createRevision($it_revision);
    $it_revision
      ->get($this->fieldName)->alt = 'Alt 6 IT';
    $violations = $it_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($it_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      20,
      4,
      4,
      'Alt 4 EN',
      'Alt 6 IT',
    ]);

    // Check that we are not allowed to perform changes to multiple translations
    // in pending revisions when synchronized properties are involved.
    $this
      ->setUntranslatableFieldWidgetsDisplay(FALSE);
    $entity = $this
      ->saveNewEntity();
    $entity_id = $entity
      ->id();
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      21,
      1,
      1,
      'Alt 1 EN',
    ]);
    $it_translation = $entity
      ->addTranslation('it', $entity
      ->toArray());

    /** @var \Drupal\Core\Entity\ContentEntityInterface $it_revision */
    $it_revision = $this
      ->createRevision($it_translation);
    $metadata = $this->contentTranslationManager
      ->getTranslationMetadata($it_revision);
    $metadata
      ->setSource('en');
    $it_revision
      ->get($this->fieldName)->alt = 'Alt 2 IT';
    $violations = $it_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($it_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      22,
      1,
      1,
      'Alt 1 EN',
      'Alt 2 IT',
    ]);
    $en_revision = $this
      ->createRevision($entity, FALSE);
    $en_revision
      ->get($this->fieldName)->target_id = 2;
    $en_revision
      ->getTranslation('it')
      ->get($this->fieldName)->alt = 'Alt 3 IT';
    $violations = $en_revision
      ->validate();
    $this
      ->assertViolations($violations);

    // Test that when saving a new default revision starting from a pending
    // revision, outdated synchronized properties do not override more recent
    // ones.
    $this
      ->setUntranslatableFieldWidgetsDisplay(TRUE);
    $entity = $this
      ->saveNewEntity();
    $entity_id = $entity
      ->id();
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      23,
      1,
      1,
      'Alt 1 EN',
    ]);
    $it_translation = $entity
      ->addTranslation('it', $entity
      ->toArray());

    /** @var \Drupal\Core\Entity\ContentEntityInterface $it_revision */
    $it_revision = $this
      ->createRevision($it_translation, FALSE);
    $metadata = $this->contentTranslationManager
      ->getTranslationMetadata($it_revision);
    $metadata
      ->setSource('en');
    $it_revision
      ->get($this->fieldName)->alt = 'Alt 2 IT';
    $violations = $it_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($it_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      24,
      1,
      1,
      'Alt 1 EN',
      'Alt 2 IT',
    ]);

    /** @var \Drupal\Core\Entity\ContentEntityInterface $en_revision */
    $en_revision = $this
      ->createRevision($entity);
    $en_revision
      ->get($this->fieldName)->target_id = 3;
    $en_revision
      ->get($this->fieldName)->alt = 'Alt 3 EN';
    $violations = $en_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($en_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      25,
      3,
      3,
      'Alt 3 EN',
      'Alt 2 IT',
    ]);
    $it_revision = $this
      ->createRevision($it_revision);
    $it_revision
      ->get($this->fieldName)->alt = 'Alt 4 IT';
    $violations = $it_revision
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($it_revision);
    $this
      ->assertLatestRevisionFieldValues($entity_id, [
      26,
      3,
      3,
      'Alt 3 EN',
      'Alt 4 IT',
    ]);
  }

  /**
   * Test changing the default language of an entity.
   */
  public function testChangeDefaultLanguageNonTranslatableFieldsHidden() {
    $this
      ->setUntranslatableFieldWidgetsDisplay(FALSE);
    $entity = $this
      ->saveNewEntity();
    $entity->langcode = 'it';
    $this
      ->assertCount(0, $entity
      ->validate());
  }

  /**
   * Sets untranslatable field widgets' display status.
   *
   * @param bool $display
   *   Whether untranslatable field widgets should be displayed.
   */
  protected function setUntranslatableFieldWidgetsDisplay($display) {
    $entity_type_id = $this->storage
      ->getEntityTypeId();
    $settings = [
      'untranslatable_fields_hide' => !$display,
    ];
    $this->contentTranslationManager
      ->setBundleTranslationSettings($entity_type_id, $entity_type_id, $settings);

    /** @var \Drupal\Core\Entity\EntityTypeBundleInfo $bundle_info */
    $bundle_info = $this->container
      ->get('entity_type.bundle.info');
    $bundle_info
      ->clearCachedBundles();
  }

  /**
   * @return \Drupal\Core\Entity\ContentEntityInterface
   */
  protected function saveNewEntity() {

    /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
    $entity = EntityTestMulRev::create([
      'uid' => 1,
      'langcode' => 'en',
      $this->fieldName => [
        'target_id' => 1,
        'alt' => 'Alt 1 EN',
      ],
    ]);
    $metadata = $this->contentTranslationManager
      ->getTranslationMetadata($entity);
    $metadata
      ->setSource(LanguageInterface::LANGCODE_NOT_SPECIFIED);
    $violations = $entity
      ->validate();
    $this
      ->assertEmpty($violations);
    $this->storage
      ->save($entity);
    return $entity;
  }

  /**
   * Creates a new revision starting from the latest translation-affecting one.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $translation
   *   The translation to be revisioned.
   * @param bool $default
   *   (optional) Whether the new revision should be marked as default. Defaults
   *   to TRUE.
   *
   * @return \Drupal\Core\Entity\ContentEntityInterface
   *   An entity revision object.
   */
  protected function createRevision(ContentEntityInterface $translation, $default = TRUE) {
    if (!$translation
      ->isNewTranslation()) {
      $langcode = $translation
        ->language()
        ->getId();
      $revision_id = $this->storage
        ->getLatestTranslationAffectedRevisionId($translation
        ->id(), $langcode);

      /** @var \Drupal\Core\Entity\ContentEntityInterface $revision */
      $revision = $this->storage
        ->loadRevision($revision_id);
      $translation = $revision
        ->getTranslation($langcode);
    }

    /** @var \Drupal\Core\Entity\ContentEntityInterface $revision */
    $revision = $this->storage
      ->createRevision($translation, $default);
    return $revision;
  }

  /**
   * Asserts that the expected violations were found.
   *
   * @param \Drupal\Core\Entity\EntityConstraintViolationListInterface $violations
   *   A list of violations.
   */
  protected function assertViolations(EntityConstraintViolationListInterface $violations) {
    $entity_type_id = $this->storage
      ->getEntityTypeId();
    $settings = $this->contentTranslationManager
      ->getBundleTranslationSettings($entity_type_id, $entity_type_id);
    $message = !empty($settings['untranslatable_fields_hide']) ? 'Non-translatable field elements can only be changed when updating the original language.' : 'Non-translatable field elements can only be changed when updating the current revision.';
    $list = [];
    foreach ($violations as $violation) {
      if ((string) $violation
        ->getMessage() === $message) {
        $list[] = $violation;
      }
    }
    $this
      ->assertCount(1, $list);
  }

  /**
   * Asserts that the latest revision has the expected field values.
   *
   * @param $entity_id
   *   The entity ID.
   * @param array $expected_values
   *   An array of expected values in the following order:
   *   - revision ID
   *   - target ID (en)
   *   - target ID (it)
   *   - alt (en)
   *   - alt (it)
   */
  protected function assertLatestRevisionFieldValues($entity_id, array $expected_values) {

    /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
    $entity = $this->storage
      ->loadRevision($this->storage
      ->getLatestRevisionId($entity_id));
    @(list($revision_id, $target_id_en, $target_id_it, $alt_en, $alt_it) = $expected_values);
    $this
      ->assertEquals($revision_id, $entity
      ->getRevisionId());
    $this
      ->assertEquals($target_id_en, $entity
      ->get($this->fieldName)->target_id);
    $this
      ->assertEquals($alt_en, $entity
      ->get($this->fieldName)->alt);
    if ($entity
      ->hasTranslation('it')) {
      $it_translation = $entity
        ->getTranslation('it');
      $this
        ->assertEquals($target_id_it, $it_translation
        ->get($this->fieldName)->target_id);
      $this
        ->assertEquals($alt_it, $it_translation
        ->get($this->fieldName)->alt);
    }
  }

}

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.
ContentTranslationFieldSyncRevisionTest::$contentTranslationManager protected property The content translation manager.
ContentTranslationFieldSyncRevisionTest::$fieldName protected property The synchronized field name.
ContentTranslationFieldSyncRevisionTest::$modules public static property Modules to enable. Overrides EntityKernelTestBase::$modules
ContentTranslationFieldSyncRevisionTest::$storage protected property The test entity storage.
ContentTranslationFieldSyncRevisionTest::assertLatestRevisionFieldValues protected function Asserts that the latest revision has the expected field values.
ContentTranslationFieldSyncRevisionTest::assertViolations protected function Asserts that the expected violations were found.
ContentTranslationFieldSyncRevisionTest::createRevision protected function Creates a new revision starting from the latest translation-affecting one.
ContentTranslationFieldSyncRevisionTest::saveNewEntity protected function
ContentTranslationFieldSyncRevisionTest::setUntranslatableFieldWidgetsDisplay protected function Sets untranslatable field widgets' display status.
ContentTranslationFieldSyncRevisionTest::setUp protected function Overrides EntityKernelTestBase::setUp
ContentTranslationFieldSyncRevisionTest::testChangeDefaultLanguageNonTranslatableFieldsHidden public function Test changing the default language of an entity.
ContentTranslationFieldSyncRevisionTest::testFieldSynchronizationAndValidation public function Checks that field synchronization works as expected with revisions.
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.
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.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name.
TestFileCreationTrait::generateFile public static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests.
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