class ContentTranslationHandlerTest

Same name and namespace in other branches
  1. 9 core/modules/content_translation/tests/src/Kernel/ContentTranslationHandlerTest.php \Drupal\Tests\content_translation\Kernel\ContentTranslationHandlerTest
  2. 8.9.x core/modules/content_translation/tests/src/Kernel/ContentTranslationHandlerTest.php \Drupal\Tests\content_translation\Kernel\ContentTranslationHandlerTest
  3. 10 core/modules/content_translation/tests/src/Kernel/ContentTranslationHandlerTest.php \Drupal\Tests\content_translation\Kernel\ContentTranslationHandlerTest

Tests the content translation handler.

@group content_translation

@coversDefaultClass \Drupal\content_translation\ContentTranslationHandler

Hierarchy

Expanded class hierarchy of ContentTranslationHandlerTest

File

core/modules/content_translation/tests/src/Kernel/ContentTranslationHandlerTest.php, line 18

Namespace

Drupal\Tests\content_translation\Kernel
View source
class ContentTranslationHandlerTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'content_translation',
        'entity_test',
        'language',
        'user',
    ];
    
    /**
     * The state service.
     *
     * @var \Drupal\Core\State\StateInterface
     */
    protected $state;
    
    /**
     * The entity type bundle information.
     *
     * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
     */
    protected $entityTypeBundleInfo;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * The messenger.
     *
     * @var \Drupal\Core\Messenger\MessengerInterface
     */
    protected $messenger;
    
    /**
     * The ID of the entity type used in this test.
     *
     * @var string
     */
    protected $entityTypeId = 'entity_test_mul';
    
    /**
     * The ID of the translation language used in this test.
     *
     * @var string
     */
    protected $translationLangcode = 'af';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->state = $this->container
            ->get('state');
        $this->entityTypeBundleInfo = $this->container
            ->get('entity_type.bundle.info');
        $this->entityTypeManager = $this->container
            ->get('entity_type.manager');
        $this->messenger = $this->container
            ->get('messenger');
        $this->installEntitySchema($this->entityTypeId);
        ConfigurableLanguage::createFromLangcode($this->translationLangcode)
            ->save();
    }
    
    /**
     * Tests ContentTranslationHandler::entityFormSharedElements()
     *
     * @param array $element
     *   The element that will be altered.
     * @param bool $default_translation_affected
     *   Whether or not only the default translation of the entity is affected.
     * @param bool $default_translation
     *   Whether or not the entity is the default translation.
     * @param bool $translation_form
     *   Whether or not the form is a translation form.
     * @param array $expected
     *   The expected altered element.
     *
     * @dataProvider providerTestEntityFormSharedElements
     *
     * @covers ::entityFormSharedElements
     * @covers ::addTranslatabilityClue
     */
    public function testEntityFormSharedElements(array $element, $default_translation_affected, $default_translation, $translation_form, array $expected) : void {
        $this->state
            ->set('entity_test.translation', TRUE);
        $this->state
            ->set('entity_test.untranslatable_fields.default_translation_affected', $default_translation_affected);
        $this->entityTypeBundleInfo
            ->clearCachedBundles();
        
        /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
        $entity = $this->entityTypeManager
            ->getStorage($this->entityTypeId)
            ->create();
        if (!$default_translation) {
            $entity = $entity->addTranslation($this->translationLangcode);
        }
        $entity->save();
        $form_object = $this->entityTypeManager
            ->getFormObject($this->entityTypeId, 'default');
        $form_object->setEntity($entity);
        $form_state = new FormState();
        $form_state->addBuildInfo('callback_object', $form_object)
            ->set([
            'content_translation',
            'translation_form',
        ], $translation_form);
        $handler = $this->entityTypeManager
            ->getHandler($this->entityTypeId, 'translation');
        $actual = $handler->entityFormSharedElements($element, $form_state, $element);
        $this->assertEquals($expected, $actual);
    }
    
    /**
     * Returns test cases for ::testEntityFormSharedElements().
     *
     * @return array[]
     *   An array of test cases, each one containing the element to alter, the
     *   form state, and the expected altered element.
     */
    public static function providerTestEntityFormSharedElements() {
        $tests = [];
        $element = [];
        $tests['empty'] = [
            'element' => $element,
            'default_translation_affected' => TRUE,
            'default_translation' => TRUE,
            'translation_form' => FALSE,
            'expected' => $element,
        ];
        $element = [
            '#type' => 'textfield',
        ];
        $tests['no-children'] = $tests['empty'];
        $tests['no-children']['element'] = $element;
        $tests['no-children']['expected'] = $element;
        $element = [
            'test' => [
                '#type' => 'textfield',
                '#multilingual' => TRUE,
            ],
        ];
        $tests['multilingual'] = $tests['empty'];
        $tests['multilingual']['element'] = $element;
        $tests['multilingual']['expected'] = $element;
        unset($element['test']['#multilingual']);
        $tests['no-title'] = $tests['empty'];
        $tests['no-title']['element'] = $element;
        $tests['no-title']['expected'] = $element;
        $element['test']['#title'] = 'Test';
        $tests['no-translatability-clue'] = $tests['empty'];
        $tests['no-translatability-clue']['element'] = $element;
        $tests['no-translatability-clue']['expected'] = $element;
        $expected = $element;
        $expected['test']['#title'] .= ' <span class="translation-entity-all-languages">(all languages)</span>';
        $tests['translatability-clue'] = $tests['no-translatability-clue'];
        $tests['translatability-clue']['default_translation_affected'] = FALSE;
        $tests['translatability-clue']['expected'] = $expected;
        $ignored_types = [
            'actions',
            'details',
            'hidden',
            'link',
            'token',
            'value',
            'vertical_tabs',
        ];
        foreach ($ignored_types as $ignored_type) {
            $element = [
                'test' => [
                    '#type' => $ignored_type,
                    '#title' => 'Test',
                ],
            ];
            $tests["ignore-{$ignored_type}"] = $tests['translatability-clue'];
            $tests["ignore-{$ignored_type}"]['element'] = $element;
            $tests["ignore-{$ignored_type}"]['expected'] = $element;
        }
        $tests['unknown-field'] = $tests['no-translatability-clue'];
        $tests['unknown-field']['default_translation'] = FALSE;
        $element = [
            'name' => [
                '#type' => 'textfield',
            ],
            'hidden_fields_warning_message' => [
                '#theme' => 'status_messages',
                '#message_list' => [
                    'warning' => [
                        t('Fields that apply to all languages are hidden to avoid conflicting changes. <a href=":url">Edit them on the original language form</a>.'),
                    ],
                ],
                '#weight' => -100,
                '#status_headings' => [
                    'warning' => t('Warning message'),
                ],
            ],
        ];
        $expected = $element;
        $expected['name']['#access'] = FALSE;
        $tests['hide-untranslatable'] = $tests['unknown-field'];
        $tests['hide-untranslatable']['element'] = $element;
        $tests['hide-untranslatable']['expected'] = $expected;
        $tests['no-translation-form'] = $tests['no-translatability-clue'];
        $tests['no-translation-form']['translation_form'] = FALSE;
        return $tests;
    }

}

Members

Title Sort descending Modifiers Object type Summary 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.
ContentTranslationHandlerTest::$entityTypeBundleInfo protected property The entity type bundle information.
ContentTranslationHandlerTest::$entityTypeId protected property The ID of the entity type used in this test.
ContentTranslationHandlerTest::$entityTypeManager protected property The entity type manager.
ContentTranslationHandlerTest::$messenger protected property The messenger.
ContentTranslationHandlerTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
ContentTranslationHandlerTest::$state protected property The state service.
ContentTranslationHandlerTest::$translationLangcode protected property The ID of the translation language used in this test.
ContentTranslationHandlerTest::providerTestEntityFormSharedElements public static function Returns test cases for ::testEntityFormSharedElements().
ContentTranslationHandlerTest::setUp protected function Overrides KernelTestBase::setUp
ContentTranslationHandlerTest::testEntityFormSharedElements public function Tests ContentTranslationHandler::entityFormSharedElements()
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. 3
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. 8
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 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::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.

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