class CommentTranslationUITest

Same name in other branches
  1. 9 core/modules/comment/tests/src/Functional/CommentTranslationUITest.php \Drupal\Tests\comment\Functional\CommentTranslationUITest
  2. 10 core/modules/comment/tests/src/Functional/CommentTranslationUITest.php \Drupal\Tests\comment\Functional\CommentTranslationUITest
  3. 11.x core/modules/comment/tests/src/Functional/CommentTranslationUITest.php \Drupal\Tests\comment\Functional\CommentTranslationUITest

Tests the Comment Translation UI.

@group comment

Hierarchy

Expanded class hierarchy of CommentTranslationUITest

File

core/modules/comment/tests/src/Functional/CommentTranslationUITest.php, line 15

Namespace

Drupal\Tests\comment\Functional
View source
class CommentTranslationUITest extends ContentTranslationUITestBase {
    use CommentTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * The subject of the test comment.
     *
     * @var string
     */
    protected $subject;
    
    /**
     * An administrative user with permission to administer comments.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $adminUser;
    
    /**
     * {inheritdoc}
     */
    protected $defaultCacheContexts = [
        'languages:language_interface',
        'session',
        'theme',
        'timezone',
        'url.query_args:_wrapper_format',
        'url.query_args.pagers:0',
        'url.site',
        'user.permissions',
        'user.roles',
    ];
    
    /**
     * Modules to install.
     *
     * @var array
     */
    public static $modules = [
        'language',
        'content_translation',
        'node',
        'comment',
    ];
    protected function setUp() {
        $this->entityTypeId = 'comment';
        $this->nodeBundle = 'article';
        $this->bundle = 'comment_article';
        $this->testLanguageSelector = FALSE;
        $this->subject = $this->randomMachineName();
        parent::setUp();
    }
    
    /**
     * {@inheritdoc}
     */
    public function setupBundle() {
        parent::setupBundle();
        $this->drupalCreateContentType([
            'type' => $this->nodeBundle,
            'name' => $this->nodeBundle,
        ]);
        // Add a comment field to the article content type.
        $this->addDefaultCommentField('node', 'article', 'comment_article', CommentItemInterface::OPEN, 'comment_article');
        // Create a page content type.
        $this->drupalCreateContentType([
            'type' => 'page',
            'name' => 'page',
        ]);
        // Add a comment field to the page content type - this one won't be
        // translatable.
        $this->addDefaultCommentField('node', 'page', 'comment');
        // Mark this bundle as translatable.
        $this->container
            ->get('content_translation.manager')
            ->setEnabled('comment', 'comment_article', TRUE);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getTranslatorPermissions() {
        return array_merge(parent::getTranslatorPermissions(), [
            'post comments',
            'administer comments',
            'access comments',
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function createEntity($values, $langcode, $comment_type = 'comment_article') {
        if ($comment_type == 'comment_article') {
            // This is the article node type, with the 'comment_article' field.
            $node_type = 'article';
            $field_name = 'comment_article';
        }
        else {
            // This is the page node type with the non-translatable 'comment' field.
            $node_type = 'page';
            $field_name = 'comment';
        }
        $node = $this->drupalCreateNode([
            'type' => $node_type,
            $field_name => [
                [
                    'status' => CommentItemInterface::OPEN,
                ],
            ],
        ]);
        $values['entity_id'] = $node->id();
        $values['entity_type'] = 'node';
        $values['field_name'] = $field_name;
        $values['uid'] = $node->getOwnerId();
        return parent::createEntity($values, $langcode, $comment_type);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getNewEntityValues($langcode) {
        // Comment subject is not translatable hence we use a fixed value.
        return [
            'subject' => [
                [
                    'value' => $this->subject,
                ],
            ],
            'comment_body' => [
                [
                    'value' => $this->randomMachineName(16),
                ],
            ],
        ] + parent::getNewEntityValues($langcode);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function doTestPublishedStatus() {
        $entity_type_manager = \Drupal::entityTypeManager();
        $storage = $entity_type_manager->getStorage($this->entityTypeId);
        $storage->resetCache();
        $entity = $storage->load($this->entityId);
        // Unpublish translations.
        foreach ($this->langcodes as $index => $langcode) {
            if ($index > 0) {
                $edit = [
                    'status' => 0,
                ];
                $url = $entity->toUrl('edit-form', [
                    'language' => ConfigurableLanguage::load($langcode),
                ]);
                $this->drupalPostForm($url, $edit, $this->getFormSubmitAction($entity, $langcode));
                $storage->resetCache();
                $entity = $storage->load($this->entityId);
                $this->assertFalse($this->manager
                    ->getTranslationMetadata($entity->getTranslation($langcode))
                    ->isPublished(), 'The translation has been correctly unpublished.');
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    protected function doTestAuthoringInfo() {
        $storage = $this->container
            ->get('entity_type.manager')
            ->getStorage($this->entityTypeId);
        $storage->resetCache([
            $this->entityId,
        ]);
        $entity = $storage->load($this->entityId);
        $languages = $this->container
            ->get('language_manager')
            ->getLanguages();
        $values = [];
        // Post different authoring information for each translation.
        foreach ($this->langcodes as $langcode) {
            $url = $entity->toUrl('edit-form', [
                'language' => $languages[$langcode],
            ]);
            $user = $this->drupalCreateUser();
            $values[$langcode] = [
                'uid' => $user->id(),
                'created' => REQUEST_TIME - mt_rand(0, 1000),
            ];
            
            /** @var \Drupal\Core\Datetime\DateFormatterInterface $date_formatter */
            $date_formatter = $this->container
                ->get('date.formatter');
            $edit = [
                'uid' => $user->getAccountName() . ' (' . $user->id() . ')',
                'date[date]' => $date_formatter->format($values[$langcode]['created'], 'custom', 'Y-m-d'),
                'date[time]' => $date_formatter->format($values[$langcode]['created'], 'custom', 'H:i:s'),
            ];
            $this->drupalPostForm($url, $edit, $this->getFormSubmitAction($entity, $langcode));
        }
        $storage->resetCache([
            $this->entityId,
        ]);
        $entity = $storage->load($this->entityId);
        foreach ($this->langcodes as $langcode) {
            $metadata = $this->manager
                ->getTranslationMetadata($entity->getTranslation($langcode));
            $this->assertEqual($metadata->getAuthor()
                ->id(), $values[$langcode]['uid'], 'Translation author correctly stored.');
            $this->assertEqual($metadata->getCreatedTime(), $values[$langcode]['created'], 'Translation date correctly stored.');
        }
    }
    
    /**
     * Tests translate link on comment content admin page.
     */
    public function testTranslateLinkCommentAdminPage() {
        $this->adminUser = $this->drupalCreateUser(array_merge(parent::getTranslatorPermissions(), [
            'access administration pages',
            'administer comments',
            'skip comment approval',
        ]));
        $this->drupalLogin($this->adminUser);
        $cid_translatable = $this->createEntity([], $this->langcodes[0]);
        $cid_untranslatable = $this->createEntity([], $this->langcodes[0], 'comment');
        // Verify translation links.
        $this->drupalGet('admin/content/comment');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertLinkByHref('comment/' . $cid_translatable . '/translations');
        $this->assertNoLinkByHref('comment/' . $cid_untranslatable . '/translations');
    }
    
    /**
     * {@inheritdoc}
     */
    protected function doTestTranslationEdit() {
        $storage = $this->container
            ->get('entity_type.manager')
            ->getStorage($this->entityTypeId);
        $storage->resetCache([
            $this->entityId,
        ]);
        $entity = $storage->load($this->entityId);
        $languages = $this->container
            ->get('language_manager')
            ->getLanguages();
        foreach ($this->langcodes as $langcode) {
            // We only want to test the title for non-english translations.
            if ($langcode != 'en') {
                $options = [
                    'language' => $languages[$langcode],
                ];
                $url = $entity->toUrl('edit-form', $options);
                $this->drupalGet($url);
                $title = t('Edit @type @title [%language translation]', [
                    '@type' => $this->entityTypeId,
                    '@title' => $entity->getTranslation($langcode)
                        ->label(),
                    '%language' => $languages[$langcode]->getName(),
                ]);
                $this->assertRaw($title);
            }
        }
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function
AssertLegacyTrait::assertIdenticalObject protected function
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function
AssertLegacyTrait::verbose protected function
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can
be overridden in a derived class so it is possible to use a different
value for a subset of tests, e.g. the JavaScript tests.
1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommentTestTrait::addDefaultCommentField public function Adds the default comment field to an entity.
CommentTranslationUITest::$adminUser protected property An administrative user with permission to administer comments.
CommentTranslationUITest::$defaultCacheContexts protected property {inheritdoc} Overrides ContentTranslationUITestBase::$defaultCacheContexts
CommentTranslationUITest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
CommentTranslationUITest::$modules public static property Modules to install. Overrides ContentTranslationTestBase::$modules
CommentTranslationUITest::$subject protected property The subject of the test comment.
CommentTranslationUITest::createEntity protected function Creates the entity to be translated. Overrides ContentTranslationTestBase::createEntity
CommentTranslationUITest::doTestAuthoringInfo protected function Tests the translation authoring information. Overrides ContentTranslationUITestBase::doTestAuthoringInfo
CommentTranslationUITest::doTestPublishedStatus protected function Tests the translation publishing status. Overrides ContentTranslationUITestBase::doTestPublishedStatus
CommentTranslationUITest::doTestTranslationEdit protected function Tests edit content translation. Overrides ContentTranslationUITestBase::doTestTranslationEdit
CommentTranslationUITest::getNewEntityValues protected function Returns an array of entity field values to be tested. Overrides ContentTranslationUITestBase::getNewEntityValues
CommentTranslationUITest::getTranslatorPermissions protected function Returns an array of permissions needed for the translator. Overrides ContentTranslationTestBase::getTranslatorPermissions
CommentTranslationUITest::setUp protected function Overrides ContentTranslationTestBase::setUp
CommentTranslationUITest::setupBundle public function Creates or initializes the bundle date if needed. Overrides ContentTranslationTestBase::setupBundle
CommentTranslationUITest::testTranslateLinkCommentAdminPage public function Tests translate link on comment content admin page.
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.
ContentTranslationTestBase::$administrator protected property The account to be used to test access to both workflows.
ContentTranslationTestBase::$bundle protected property The bundle being tested. 1
ContentTranslationTestBase::$controller protected property The translation controller for the current entity type.
ContentTranslationTestBase::$editor protected property The account to be used to test multilingual entity editing.
ContentTranslationTestBase::$entityTypeId protected property The entity type being tested. 1
ContentTranslationTestBase::$fieldName protected property The name of the field used to test translation.
ContentTranslationTestBase::$langcodes protected property The added languages.
ContentTranslationTestBase::$manager protected property
ContentTranslationTestBase::$translator protected property The account to be used to test translation operations.
ContentTranslationTestBase::enableTranslation protected function Enables translation for the current entity type and bundle.
ContentTranslationTestBase::getAdministratorPermissions protected function Returns an array of permissions needed for the administrator. 4
ContentTranslationTestBase::getEditorPermissions protected function Returns an array of permissions needed for the editor. 5
ContentTranslationTestBase::getEditUrl protected function Returns the edit URL for the specified entity. 1
ContentTranslationTestBase::getTranslatePermission protected function Returns the translate permissions for the current entity and bundle.
ContentTranslationTestBase::setupLanguages protected function Adds additional languages.
ContentTranslationTestBase::setupTestFields protected function Creates the test fields. 2
ContentTranslationTestBase::setupUsers protected function Creates and activates translator, editor and admin users.
ContentTranslationUITestBase::$entityId protected property The id of the entity being translated.
ContentTranslationUITestBase::$testHTMLEscapeForAllLanguages protected property Flag to determine if "all languages" rendering is tested. 1
ContentTranslationUITestBase::$testLanguageSelector protected property Whether the behavior of the language selector should be tested.
ContentTranslationUITestBase::doTestBasicTranslation protected function Tests the basic translation workflow. 2
ContentTranslationUITestBase::doTestChangedTimeAfterSaveWithoutChanges public function Test the changed time after API and FORM save without changes.
ContentTranslationUITestBase::doTestOutdatedStatus protected function Tests up-to-date status tracking.
ContentTranslationUITestBase::doTestTranslationChanged protected function Tests the basic translation workflow. 1
ContentTranslationUITestBase::doTestTranslationDeletion protected function Tests translation deletion.
ContentTranslationUITestBase::doTestTranslationOverview protected function Tests that the translation overview shows the correct values.
ContentTranslationUITestBase::getChangedFieldName protected function Returns the name of the field that implements the changed timestamp.
ContentTranslationUITestBase::getEditValues protected function Returns an edit array containing the values to be posted. 2
ContentTranslationUITestBase::getFormSubmitAction protected function Returns the form action value to be used to submit the entity form.
ContentTranslationUITestBase::getFormSubmitActionForNewTranslation protected function Returns the form action value when submitting a new translation.
ContentTranslationUITestBase::getFormSubmitSuffix protected function Returns appropriate submit button suffix based on translatability. 1
ContentTranslationUITestBase::getTranslation protected function Returns the translation object to use to retrieve the translated values.
ContentTranslationUITestBase::getValue protected function Returns the value for the specified property in the given language.
ContentTranslationUITestBase::testTranslationUI public function Tests the basic translation UI. 2
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
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.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

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