trait DbUpdatesTrait

Same name in this branch
  1. 8.9.x core/modules/system/src/Tests/Update/DbUpdatesTrait.php \Drupal\system\Tests\Update\DbUpdatesTrait

Provides methods to conditionally enable db update functions and apply pending db updates through the Update UI.

This should be used only by classes extending \Drupal\Tests\BrowserTestBase.

Hierarchy

1 file declares its use of DbUpdatesTrait
UpdateApiEntityDefinitionUpdateTest.php in core/modules/system/tests/src/Functional/Entity/Update/UpdateApiEntityDefinitionUpdateTest.php

File

core/modules/system/tests/src/Functional/Update/DbUpdatesTrait.php, line 15

Namespace

Drupal\Tests\system\Functional\Update
View source
trait DbUpdatesTrait {
    use StringTranslationTrait;
    use RequirementsPageTrait;
    
    /**
     * Enables db updates until the specified index.
     *
     * @param string $module
     *   The name of the module defining the update functions.
     * @param string $group
     *   A name identifying the group of update functions to enable.
     * @param $index
     *   The index of the last update function to run.
     */
    protected function enableUpdates($module, $group, $index) {
        $this->container
            ->get('state')
            ->set($module . '.db_updates.' . $group, $index);
    }
    
    /**
     * Applies any pending DB updates through the Update UI.
     */
    protected function applyUpdates() {
        $this->drupalGet(Url::fromRoute('system.db_update'));
        $this->updateRequirementsProblem();
        $this->clickLink($this->t('Continue'));
        $this->clickLink($this->t('Apply pending updates'));
        $this->checkForMetaRefresh();
    }

}

Members

Title Sort descending Modifiers Object type Summary Overrides
DbUpdatesTrait::applyUpdates protected function Applies any pending DB updates through the Update UI.
DbUpdatesTrait::enableUpdates protected function Enables db updates until the specified index.
RequirementsPageTrait::assertWarningSummaries protected function Assert the given warning summaries are present on the page.
RequirementsPageTrait::continueOnExpectedWarnings protected function Continues installation when the expected warnings are found.
RequirementsPageTrait::updateRequirementsProblem protected function Handles the update requirements page.
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

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