trait 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\simpletest\WebTestBase.
Hierarchy
- trait \Drupal\system\Tests\Update\DbUpdatesTrait uses \Drupal\Core\StringTranslation\StringTranslationTrait
Deprecated
in drupal:8.4.0 and is removed from drupal:9.0.0. Use \Drupal\FunctionalTests\Update\DbUpdatesTrait.
See also
https://www.drupal.org/node/2896640
File
-
core/
modules/ system/ src/ Tests/ Update/ DbUpdatesTrait.php, line 20
Namespace
Drupal\system\Tests\UpdateView source
trait DbUpdatesTrait {
use StringTranslationTrait;
/**
* 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->clickLink($this->t('Continue'));
$this->clickLink($this->t('Apply pending updates'));
}
/**
* Conditionally load Update API functions for the specified group.
*
* @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.
*/
public static function includeUpdates($module, $group) {
if ($index = \Drupal::state()->get($module . '.db_updates.' . $group)) {
module_load_include('inc', $module, 'update/' . $group . '_' . $index);
}
}
}
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. | |
| DbUpdatesTrait::includeUpdates | public static | function | Conditionally load Update API functions for the specified group. | |
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 1 |
| 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.