class EntityDecoupledTranslationRevisionsTest

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Entity/EntityDecoupledTranslationRevisionsTest.php \Drupal\KernelTests\Core\Entity\EntityDecoupledTranslationRevisionsTest
  2. 8.9.x core/tests/Drupal/KernelTests/Core/Entity/EntityDecoupledTranslationRevisionsTest.php \Drupal\KernelTests\Core\Entity\EntityDecoupledTranslationRevisionsTest
  3. 10 core/tests/Drupal/KernelTests/Core/Entity/EntityDecoupledTranslationRevisionsTest.php \Drupal\KernelTests\Core\Entity\EntityDecoupledTranslationRevisionsTest

Test decoupled translation revisions.

@group entity

@coversDefaultClass \Drupal\Core\Entity\ContentEntityStorageBase

Hierarchy

Expanded class hierarchy of EntityDecoupledTranslationRevisionsTest

File

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

Namespace

Drupal\KernelTests\Core\Entity
View source
class EntityDecoupledTranslationRevisionsTest extends EntityKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system',
        'entity_test',
        'language',
    ];
    
    /**
     * The entity type bundle info service.
     *
     * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
     */
    protected $bundleInfo;
    
    /**
     * The entity storage.
     *
     * @var \Drupal\Core\Entity\ContentEntityStorageInterface
     */
    protected $storage;
    
    /**
     * The translations of the test entity.
     *
     * @var \Drupal\Core\Entity\ContentEntityInterface[]
     */
    protected $translations;
    
    /**
     * The previous revision identifiers for the various revision translations.
     *
     * @var int[]
     */
    protected $previousRevisionId = [];
    
    /**
     * The previous untranslatable field value.
     *
     * @var string[]
     */
    protected $previousUntranslatableFieldValue;
    
    /**
     * The current edit sequence step index.
     *
     * @var int
     */
    protected $stepIndex;
    
    /**
     * The current edit sequence step info.
     *
     * @var array
     */
    protected $stepInfo;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $entity_type_id = 'entity_test_mulrev';
        $this->installEntitySchema($entity_type_id);
        $this->storage = $this->container
            ->get('entity_type.manager')
            ->getStorage($entity_type_id);
        $this->installConfig([
            'language',
        ]);
        $langcodes = [
            'it',
            'fr',
        ];
        foreach ($langcodes as $langcode) {
            ConfigurableLanguage::createFromLangcode($langcode)->save();
        }
        $values = [
            'name' => $this->randomString(),
            'status' => 1,
        ];
        User::create($values)->save();
        // Make sure entity bundles are translatable.
        $this->state
            ->set('entity_test.translation', TRUE);
        $this->bundleInfo = \Drupal::service('entity_type.bundle.info');
        $this->bundleInfo
            ->clearCachedBundles();
    }
    
    /**
     * Data provider for ::testDecoupledDefaultRevisions.
     */
    public static function dataTestDecoupledPendingRevisions() {
        $sets = [];
        $sets['Intermixed languages - No initial default translation'][] = [
            [
                'en',
                TRUE,
            ],
            [
                'en',
                FALSE,
            ],
            [
                'it',
                FALSE,
            ],
            [
                'en',
                FALSE,
            ],
            [
                'it',
                FALSE,
            ],
            [
                'en',
                TRUE,
            ],
            [
                'it',
                TRUE,
            ],
        ];
        $sets['Intermixed languages - With initial default translation'][] = [
            [
                'en',
                TRUE,
            ],
            [
                'it',
                TRUE,
            ],
            [
                'en',
                FALSE,
            ],
            [
                'it',
                FALSE,
            ],
            [
                'en',
                TRUE,
            ],
            [
                'it',
                TRUE,
            ],
        ];
        $sets['Alternate languages - No initial default translation'][] = [
            [
                'en',
                TRUE,
            ],
            [
                'en',
                FALSE,
            ],
            [
                'en',
                FALSE,
            ],
            [
                'en',
                TRUE,
            ],
            [
                'it',
                FALSE,
            ],
            [
                'en',
                TRUE,
            ],
            [
                'it',
                FALSE,
            ],
            [
                'it',
                FALSE,
            ],
            [
                'it',
                TRUE,
            ],
        ];
        $sets['Alternate languages - With initial default translation'][] = [
            [
                'en',
                TRUE,
            ],
            [
                'it',
                TRUE,
            ],
            [
                'en',
                TRUE,
            ],
            [
                'en',
                FALSE,
            ],
            [
                'en',
                FALSE,
            ],
            [
                'en',
                TRUE,
            ],
            [
                'it',
                TRUE,
            ],
            [
                'it',
                FALSE,
            ],
            [
                'it',
                FALSE,
            ],
            [
                'it',
                TRUE,
            ],
        ];
        $sets['Multiple languages - No initial default translation'][] = [
            [
                'en',
                TRUE,
            ],
            [
                'it',
                FALSE,
            ],
            [
                'fr',
                FALSE,
            ],
            [
                'en',
                FALSE,
            ],
            [
                'en',
                TRUE,
            ],
            [
                'it',
                TRUE,
            ],
            [
                'fr',
                FALSE,
            ],
            [
                'en',
                FALSE,
            ],
            [
                'it',
                FALSE,
            ],
            [
                'en',
                TRUE,
            ],
            [
                'fr',
                TRUE,
            ],
            [
                'it',
                TRUE,
            ],
            [
                'fr',
                TRUE,
            ],
        ];
        $sets['Multiple languages - With initial default translation'][] = [
            [
                'en',
                TRUE,
            ],
            [
                'it',
                TRUE,
            ],
            [
                'fr',
                TRUE,
            ],
            [
                'en',
                FALSE,
            ],
            [
                'it',
                FALSE,
            ],
            [
                'en',
                TRUE,
            ],
            [
                'it',
                TRUE,
            ],
            [
                'fr',
                FALSE,
            ],
            [
                'en',
                FALSE,
            ],
            [
                'it',
                FALSE,
            ],
            [
                'en',
                TRUE,
            ],
            [
                'fr',
                TRUE,
            ],
            [
                'it',
                TRUE,
            ],
            [
                'fr',
                TRUE,
            ],
        ];
        return $sets;
    }
    
    /**
     * Tests decoupled default revisions.
     *
     * @param array[] $sequence
     *   An array with arrays of arguments for the ::doSaveNewRevision() method as
     *   values. Every child array corresponds to a method invocation.
     *
     * @covers ::createRevision
     *
     * @dataProvider dataTestDecoupledPendingRevisions
     */
    public function testDecoupledPendingRevisions($sequence) : void {
        $revision_id = $this->doTestEditSequence($sequence);
        $this->assertCount($revision_id, $sequence);
    }
    
    /**
     * Data provider for ::testUntranslatableFields.
     */
    public static function dataTestUntranslatableFields() {
        $sets = [];
        $sets['Default behavior - Untranslatable fields affect all revisions'] = [
            [
                [
                    'en',
                    TRUE,
                    TRUE,
                ],
                [
                    'it',
                    FALSE,
                    TRUE,
                    FALSE,
                ],
                [
                    'en',
                    FALSE,
                    TRUE,
                    FALSE,
                ],
                [
                    'en',
                    TRUE,
                    TRUE,
                ],
                [
                    'it',
                    TRUE,
                    TRUE,
                ],
                [
                    'en',
                    FALSE,
                ],
                [
                    'it',
                    FALSE,
                ],
                [
                    'en',
                    TRUE,
                ],
                [
                    'it',
                    TRUE,
                ],
            ],
            FALSE,
        ];
        $sets['Alternative behavior - Untranslatable fields affect only default translation'] = [
            [
                [
                    'en',
                    TRUE,
                    TRUE,
                ],
                [
                    'it',
                    FALSE,
                    TRUE,
                    FALSE,
                ],
                [
                    'en',
                    FALSE,
                    TRUE,
                ],
                [
                    'it',
                    TRUE,
                    TRUE,
                    FALSE,
                ],
                [
                    'it',
                    FALSE,
                ],
                [
                    'it',
                    TRUE,
                ],
                [
                    'en',
                    TRUE,
                    TRUE,
                ],
                [
                    'it',
                    FALSE,
                ],
                [
                    'en',
                    FALSE,
                ],
                [
                    'it',
                    TRUE,
                ],
                [
                    'en',
                    TRUE,
                    TRUE,
                ],
            ],
            TRUE,
        ];
        return $sets;
    }
    
    /**
     * Tests that untranslatable fields are handled correctly.
     *
     * @param array[] $sequence
     *   An array with arrays of arguments for the ::doSaveNewRevision() method as
     *   values. Every child array corresponds to a method invocation.
     * @param bool $default_translation_affected
     *   Whether untranslatable field changes affect all revisions or only the
     *   default revision.
     *
     * @covers ::createRevision
     * @covers \Drupal\Core\Entity\Plugin\Validation\Constraint\EntityUntranslatableFieldsConstraintValidator::validate
     *
     * @dataProvider dataTestUntranslatableFields
     */
    public function testUntranslatableFields($sequence, $default_translation_affected) : void {
        // Configure the untranslatable fields edit mode.
        $this->state
            ->set('entity_test.untranslatable_fields.default_translation_affected', $default_translation_affected);
        $this->bundleInfo
            ->clearCachedBundles();
        // Test that a new entity is always valid.
        $entity = EntityTestMulRev::create();
        $entity->set('non_mul_field', 0);
        $violations = $entity->validate();
        $this->assertEmpty($violations);
        // Test the specified sequence.
        $this->doTestEditSequence($sequence);
    }
    
    /**
     * Actually tests an edit step sequence.
     *
     * @param array[] $sequence
     *   An array of sequence steps.
     *
     * @return int
     *   The latest saved revision id.
     */
    protected function doTestEditSequence($sequence) {
        $revision_id = NULL;
        foreach ($sequence as $index => $step) {
            $this->stepIndex = $index;
            $revision_id = call_user_func_array([
                $this,
                'doEditStep',
            ], $step);
        }
        return (int) $revision_id;
    }
    
    /**
     * Saves a new revision of the test entity.
     *
     * @param string $active_langcode
     *   The language of the translation for which a new revision will be saved.
     * @param bool $default_revision
     *   Whether the revision should be flagged as the default revision.
     * @param bool $untranslatable_update
     *   (optional) Whether an untranslatable field update should be performed.
     *   Defaults to FALSE.
     * @param bool $valid
     *   (optional) Whether entity validation is expected to succeed. Defaults to
     *   TRUE.
     *
     * @return int
     *   The new revision identifier.
     *
     * @throws \Drupal\Core\Entity\EntityStorageException
     */
    protected function doEditStep($active_langcode, $default_revision, $untranslatable_update = FALSE, $valid = TRUE) {
        $this->stepInfo = [
            $active_langcode,
            $default_revision,
            $untranslatable_update,
            $valid,
        ];
        // If changes to untranslatable fields affect only the default translation,
        // we can different values for untranslatable fields in the various
        // revision translations, so we need to track their previous value per
        // language.
        $all_translations_affected = !$this->state
            ->get('entity_test.untranslatable_fields.default_translation_affected');
        $previous_untranslatable_field_langcode = $all_translations_affected ? LanguageInterface::LANGCODE_DEFAULT : $active_langcode;
        // Initialize previous data tracking.
        if (!isset($this->translations)) {
            $this->translations[$active_langcode] = EntityTestMulRev::create();
            $this->previousRevisionId[$active_langcode] = 0;
            $this->previousUntranslatableFieldValue[$previous_untranslatable_field_langcode] = NULL;
        }
        if (!isset($this->translations[$active_langcode])) {
            $this->translations[$active_langcode] = reset($this->translations)
                ->addTranslation($active_langcode);
            $this->previousRevisionId[$active_langcode] = 0;
            $this->previousUntranslatableFieldValue[$active_langcode] = NULL;
        }
        // We want to update previous data only if we expect a valid result,
        // otherwise we would be just polluting it with invalid values.
        if ($valid) {
            $entity =& $this->translations[$active_langcode];
            $previous_revision_id =& $this->previousRevisionId[$active_langcode];
            $previous_untranslatable_field_value =& $this->previousUntranslatableFieldValue[$previous_untranslatable_field_langcode];
        }
        else {
            $entity = clone $this->translations[$active_langcode];
            $previous_revision_id = $this->previousRevisionId[$active_langcode];
            $previous_untranslatable_field_value = $this->previousUntranslatableFieldValue[$previous_untranslatable_field_langcode];
        }
        // Check that after instantiating a new revision for the specified
        // translation, we are resuming work from where we left the last time. If
        // that is the case, the label generated for the previous revision should
        // match the stored one.
        if (!$entity->isNew()) {
            $previous_label = NULL;
            if (!$entity->isNewTranslation()) {
                $previous_label = $this->generateNewEntityLabel($entity, $previous_revision_id);
                $latest_affected_revision_id = $this->storage
                    ->getLatestTranslationAffectedRevisionId($entity->id(), $entity->language()
                    ->getId());
            }
            else {
                // Normally it would make sense to load the default revision in this
                // case, however that would mean simulating here the logic that we need
                // to test, thus "masking" possible flaws. To avoid that, we simply
                // pretend we are starting from an earlier non translated revision.
                // This ensures that the we can check that the merging logic is applied
                // also when adding a new translation.
                $latest_affected_revision_id = 1;
            }
            $previous_revision_id = (int) $entity->getLoadedRevisionId();
            
            /** @var \Drupal\Core\Entity\ContentEntityInterface $latest_affected_revision */
            $latest_affected_revision = $this->storage
                ->loadRevision($latest_affected_revision_id);
            $translation = $latest_affected_revision->hasTranslation($active_langcode) ? $latest_affected_revision->getTranslation($active_langcode) : $latest_affected_revision->addTranslation($active_langcode);
            $entity = $this->storage
                ->createRevision($translation, $default_revision);
            $this->assertEquals($default_revision, $entity->isDefaultRevision());
            $this->assertEquals($translation->getLoadedRevisionId(), $entity->getLoadedRevisionId());
            $this->assertEquals($previous_label, $entity->label(), $this->formatMessage('Loaded translatable field value does not match the previous one.'));
        }
        // Check that the previous untranslatable field value is loaded in the new
        // revision as expected. When we are dealing with a non default translation
        // the expected value is always the one stored in the default revision, as
        // untranslatable fields can only be changed in the default translation or
        // in the default revision, depending on the configured mode.
        $value = $entity->get('non_mul_field')->value;
        if (isset($previous_untranslatable_field_value)) {
            $this->assertEquals($previous_untranslatable_field_value, $value, $this->formatMessage('Loaded untranslatable field value does not match the previous one.'));
        }
        elseif (!$entity->isDefaultTranslation()) {
            
            /** @var \Drupal\Core\Entity\ContentEntityInterface $default_revision */
            $default_revision = $this->storage
                ->loadUnchanged($entity->id());
            $expected_value = $default_revision->get('non_mul_field')->value;
            $this->assertEquals($expected_value, $value, $this->formatMessage('Loaded untranslatable field value does not match the previous one.'));
        }
        // Perform a change and store it.
        $label = $this->generateNewEntityLabel($entity, $previous_revision_id, TRUE);
        $entity->set('name', $label);
        if ($untranslatable_update) {
            // Store the revision ID of the previous untranslatable fields update in
            // the new value, besides the upcoming revision ID. Useful to analyze test
            // failures.
            $prev = 0;
            if (isset($previous_untranslatable_field_value)) {
                preg_match('/^\\d+ -> (\\d+)$/', $previous_untranslatable_field_value, $matches);
                $prev = $matches[1];
            }
            $value = $prev . ' -> ' . ($entity->getLoadedRevisionId() + 1);
            $entity->set('non_mul_field', $value);
            $previous_untranslatable_field_value = $value;
        }
        $violations = $entity->validate();
        $messages = [];
        foreach ($violations as $violation) {
            
            /** \Symfony\Component\Validator\ConstraintViolationInterface */
            $messages[] = $violation->getMessage();
        }
        $this->assertEquals($valid, !$violations->count(), $this->formatMessage('Validation does not match the expected result: %s', implode(', ', $messages)));
        if ($valid) {
            $entity->save();
            // Reload the current revision translation and the default revision to
            // make sure data was stored correctly.
            
            /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
            $entity = $this->storage
                ->loadRevision($entity->getRevisionId());
            $entity = $entity->getTranslation($active_langcode);
            
            /** @var \Drupal\Core\Entity\ContentEntityInterface $default_entity */
            $default_entity = $this->storage
                ->loadUnchanged($entity->id());
            // Verify that the values for the current revision translation match the
            // expected ones, while for the other translations they match the default
            // revision. We also need to verify that only the current revision
            // translation was marked as affected.
            foreach ($entity->getTranslationLanguages() as $langcode => $language) {
                $translation = $entity->getTranslation($langcode);
                $rta_expected = $langcode == $active_langcode || $untranslatable_update && $all_translations_affected;
                $this->assertEquals($rta_expected, $translation->isRevisionTranslationAffected(), $this->formatMessage("'{$langcode}' translation incorrectly affected"));
                $label_expected = $label;
                if ($langcode !== $active_langcode) {
                    $default_translation = $default_entity->hasTranslation($langcode) ? $default_entity->getTranslation($langcode) : $default_entity;
                    $label_expected = $default_translation->label();
                }
                $this->assertEquals($label_expected, $translation->label(), $this->formatMessage("Incorrect '{$langcode}' translation label"));
            }
        }
        return $entity->getRevisionId();
    }
    
    /**
     * Generates a new label for the specified revision.
     *
     * @param \Drupal\Core\Entity\ContentEntityInterface $revision
     *   An entity object.
     * @param int $previous_revision_id
     *   The previous revision identifier for this revision translation.
     * @param bool $next
     *   (optional) Whether the label describes the current revision or the one
     *   to be created. Defaults to FALSE.
     *
     * @return string
     *   A revision label.
     */
    protected function generateNewEntityLabel(ContentEntityInterface $revision, $previous_revision_id, $next = FALSE) : string {
        $language_label = $revision->language()
            ->getName();
        $revision_type = $revision->isDefaultRevision() ? 'Default' : 'Pending';
        $revision_id = $next ? $this->storage
            ->getLatestRevisionId($revision->id()) + 1 : $revision->getLoadedRevisionId();
        return sprintf('%s (%s %d -> %d)', $language_label, $revision_type, $previous_revision_id, $revision_id);
    }
    
    /**
     * Formats an assertion message.
     *
     * @param string $message
     *   The human-readable message.
     *
     * @return string
     *   The formatted message.
     */
    protected function formatMessage($message) {
        $args = func_get_args();
        array_shift($args);
        $params = array_merge($args, $this->stepInfo);
        array_unshift($params, $this->stepIndex + 1);
        array_unshift($params, '[Step %d] ' . $message . ' (langcode: %s, default_revision: %d, untranslatable_update: %d, valid: %d)');
        return call_user_func_array('sprintf', $params);
    }
    
    /**
     * Checks that changes to multiple translations are handled correctly.
     *
     * @covers ::createRevision
     * @covers \Drupal\Core\Entity\Plugin\Validation\Constraint\EntityUntranslatableFieldsConstraintValidator::validate
     */
    public function testMultipleTranslationChanges() : void {
        // Configure the untranslatable fields edit mode.
        $this->state
            ->set('entity_test.untranslatable_fields.default_translation_affected', TRUE);
        $this->bundleInfo
            ->clearCachedBundles();
        $entity = EntityTestMulRev::create();
        $entity->get('name')->value = 'Test 1.1 EN';
        $entity->get('non_mul_field')->value = 'Test 1.1';
        $this->storage
            ->save($entity);
        
        /** @var \Drupal\Core\Entity\ContentEntityInterface $revision */
        $revision = $this->storage
            ->createRevision($entity->addTranslation('it'));
        $revision->get('name')->value = 'Test 1.2 IT';
        $this->storage
            ->save($revision);
        $revision = $this->storage
            ->createRevision($revision->getTranslation('en'), FALSE);
        $revision->get('non_mul_field')->value = 'Test 1.3';
        $revision->getTranslation('it')
            ->get('name')->value = 'Test 1.3 IT';
        $violations = $revision->validate();
        $this->assertCount(1, $violations);
        $this->assertEquals('Non-translatable fields can only be changed when updating the original language.', $violations[0]->getMessage());
    }
    
    /**
     * Tests that internal properties are preserved while creating a new revision.
     */
    public function testInternalProperties() : void {
        $entity = EntityTestMulRev::create();
        $this->doTestInternalProperties($entity);
        $entity = EntityTestMulRev::create();
        $entity->save();
        $this->doTestInternalProperties($entity);
        
        /** @var \Drupal\entity_test\Entity\EntityTestMulRev $translation */
        $translation = EntityTestMulRev::create()->addTranslation('it');
        $translation->save();
        $this->doTestInternalProperties($translation);
    }
    
    /**
     * Checks that internal properties are preserved for the specified entity.
     *
     * @param \Drupal\Core\Entity\ContentEntityInterface $entity
     *   An entity object.
     */
    protected function doTestInternalProperties(ContentEntityInterface $entity) {
        $this->assertFalse($entity->isValidationRequired());
        $entity->setValidationRequired(TRUE);
        $this->assertTrue($entity->isValidationRequired());
        $new_revision = $this->storage
            ->createRevision($entity);
        $this->assertTrue($new_revision->isValidationRequired());
    }
    
    /**
     * Tests that deleted translations are not accidentally restored.
     *
     * @covers ::createRevision
     */
    public function testRemovedTranslations() : void {
        
        /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
        $entity = EntityTestMulRev::create([
            'name' => 'Test 1.1 EN',
        ]);
        $this->storage
            ->save($entity);
        
        /** @var \Drupal\Core\Entity\ContentEntityInterface $it_revision */
        $it_revision = $this->storage
            ->createRevision($entity->addTranslation('it'));
        $it_revision->set('name', 'Test 1.2 IT');
        $this->storage
            ->save($it_revision);
        
        /** @var \Drupal\Core\Entity\ContentEntityInterface $en_revision */
        $en_revision = $this->storage
            ->createRevision($it_revision->getUntranslated(), FALSE);
        $en_revision->set('name', 'Test 1.3 EN');
        $this->storage
            ->save($en_revision);
        
        /** @var \Drupal\Core\Entity\ContentEntityInterface $en_revision */
        $it_revision = $this->storage
            ->createRevision($it_revision);
        $en_revision = $it_revision->getUntranslated();
        $en_revision->removeTranslation('it');
        $this->storage
            ->save($en_revision);
        $revision_id = $this->storage
            ->getLatestTranslationAffectedRevisionId($entity->id(), 'en');
        $en_revision = $this->storage
            ->loadRevision($revision_id);
        $en_revision = $this->storage
            ->createRevision($en_revision);
        $en_revision->set('name', 'Test 1.5 EN');
        $this->storage
            ->save($en_revision);
        $en_revision = $this->storage
            ->loadRevision($en_revision->getRevisionId());
        $this->assertFalse($en_revision->hasTranslation('it'));
    }
    
    /**
     * Checks that the revision create hook works as expected.
     *
     * @covers ::createRevision
     */
    public function testCreateRevisionHook() : void {
        $entity = EntityTestMulRev::create();
        $entity->get('name')->value = 'revision_create_test_en';
        $this->storage
            ->save($entity);
        
        /** @var \Drupal\Core\Entity\ContentEntityInterface $translation */
        $translation = $entity->addTranslation('it');
        $translation->set('name', 'revision_create_test_it');
        
        /** @var \Drupal\Core\Entity\ContentEntityInterface $revision */
        $revision = $this->storage
            ->createRevision($translation, FALSE, TRUE);
        // Assert that the alter hook can alter the new revision.
        $this->assertEquals('revision_create_test_it_altered', $revision->get('name')->value);
        // Assert the data passed to the hook.
        $data = $this->state
            ->get('entity_test.hooks');
        $this->assertEquals('revision_create_test_it', $data['entity_test_mulrev_revision_create']['entity']->get('name')->value);
        $this->assertEquals('revision_create_test_it_altered', $data['entity_test_mulrev_revision_create']['new_revision']->get('name')->value);
        $this->assertFalse($data['entity_test_mulrev_revision_create']['entity']->isNewRevision());
        $this->assertTrue($data['entity_test_mulrev_revision_create']['new_revision']->isNewRevision());
        $this->assertTrue($data['entity_test_mulrev_revision_create']['entity']->isDefaultRevision());
        $this->assertFalse($data['entity_test_mulrev_revision_create']['new_revision']->isDefaultRevision());
        $this->assertTrue($data['entity_test_mulrev_revision_create']['keep_untranslatable_fields']);
        $this->assertEquals('revision_create_test_it', $data['entity_revision_create']['entity']->get('name')->value);
        $this->assertEquals('revision_create_test_it_altered', $data['entity_revision_create']['new_revision']->get('name')->value);
        $this->assertFalse($data['entity_revision_create']['entity']->isNewRevision());
        $this->assertTrue($data['entity_revision_create']['new_revision']->isNewRevision());
        $this->assertTrue($data['entity_revision_create']['entity']->isDefaultRevision());
        $this->assertFalse($data['entity_revision_create']['new_revision']->isDefaultRevision());
        $this->assertTrue($data['entity_revision_create']['keep_untranslatable_fields']);
        // Test again with different arguments.
        $translation->isDefaultRevision(FALSE);
        $this->storage
            ->createRevision($translation);
        $data = $this->state
            ->get('entity_test.hooks');
        $this->assertFalse($data['entity_revision_create']['entity']->isNewRevision());
        $this->assertTrue($data['entity_revision_create']['new_revision']->isNewRevision());
        $this->assertFalse($data['entity_revision_create']['entity']->isDefaultRevision());
        $this->assertTrue($data['entity_revision_create']['new_revision']->isDefaultRevision());
        $this->assertNull($data['entity_revision_create']['keep_untranslatable_fields']);
        $this->assertFalse($data['entity_test_mulrev_revision_create']['entity']->isNewRevision());
        $this->assertTrue($data['entity_test_mulrev_revision_create']['new_revision']->isNewRevision());
        $this->assertFalse($data['entity_test_mulrev_revision_create']['entity']->isDefaultRevision());
        $this->assertTrue($data['entity_test_mulrev_revision_create']['new_revision']->isDefaultRevision());
        $this->assertNull($data['entity_test_mulrev_revision_create']['keep_untranslatable_fields']);
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title 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 raw text IS NOT found escaped on 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::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.
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.
EntityDecoupledTranslationRevisionsTest::$bundleInfo protected property The entity type bundle info service.
EntityDecoupledTranslationRevisionsTest::$modules protected static property Modules to install. Overrides EntityKernelTestBase::$modules
EntityDecoupledTranslationRevisionsTest::$previousRevisionId protected property The previous revision identifiers for the various revision translations.
EntityDecoupledTranslationRevisionsTest::$previousUntranslatableFieldValue protected property The previous untranslatable field value.
EntityDecoupledTranslationRevisionsTest::$stepIndex protected property The current edit sequence step index.
EntityDecoupledTranslationRevisionsTest::$stepInfo protected property The current edit sequence step info.
EntityDecoupledTranslationRevisionsTest::$storage protected property The entity storage.
EntityDecoupledTranslationRevisionsTest::$translations protected property The translations of the test entity.
EntityDecoupledTranslationRevisionsTest::dataTestDecoupledPendingRevisions public static function Data provider for ::testDecoupledDefaultRevisions.
EntityDecoupledTranslationRevisionsTest::dataTestUntranslatableFields public static function Data provider for ::testUntranslatableFields.
EntityDecoupledTranslationRevisionsTest::doEditStep protected function Saves a new revision of the test entity.
EntityDecoupledTranslationRevisionsTest::doTestEditSequence protected function Actually tests an edit step sequence.
EntityDecoupledTranslationRevisionsTest::doTestInternalProperties protected function Checks that internal properties are preserved for the specified entity.
EntityDecoupledTranslationRevisionsTest::formatMessage protected function Formats an assertion message.
EntityDecoupledTranslationRevisionsTest::generateNewEntityLabel protected function Generates a new label for the specified revision.
EntityDecoupledTranslationRevisionsTest::setUp protected function Overrides EntityKernelTestBase::setUp
EntityDecoupledTranslationRevisionsTest::testCreateRevisionHook public function Checks that the revision create hook works as expected.
EntityDecoupledTranslationRevisionsTest::testDecoupledPendingRevisions public function Tests decoupled default revisions.
EntityDecoupledTranslationRevisionsTest::testInternalProperties public function Tests that internal properties are preserved while creating a new revision.
EntityDecoupledTranslationRevisionsTest::testMultipleTranslationChanges public function Checks that changes to multiple translations are handled correctly.
EntityDecoupledTranslationRevisionsTest::testRemovedTranslations public function Tests that deleted translations are not accidentally restored.
EntityDecoupledTranslationRevisionsTest::testUntranslatableFields public function Tests that untranslatable fields are handled correctly.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
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::uninstallModule protected function Uninstalls a module and refreshes services.
EntityTrait::$generatedIds protected property A list of entity IDs generated by self::generateRandomEntityId().
EntityTrait::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityTrait::reloadEntity protected function Reloads the given entity from the storage and returns it.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 3
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 protected function Bootstraps a kernel for a test. 1
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. 1
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. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install 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::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
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::tearDown protected function 7
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.