Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\system\Tests\Update;
Chris@0: 
Chris@0: @trigger_error(__NAMESPACE__ . '\DbUpdatesTrait is deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Use \Drupal\FunctionalTests\Update\DbUpdatesTrait instead. See https://www.drupal.org/node/2896640.', E_USER_DEPRECATED);
Chris@0: 
Chris@0: use Drupal\Core\StringTranslation\StringTranslationTrait;
Chris@0: use Drupal\Core\Url;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides methods to conditionally enable db update functions and apply
Chris@0:  * pending db updates through the Update UI.
Chris@0:  *
Chris@0:  * This should be used only by classes extending \Drupal\simpletest\WebTestBase.
Chris@0:  *
Chris@0:  * @deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0.
Chris@0:  *   Use \Drupal\FunctionalTests\Update\DbUpdatesTrait.
Chris@0:  * @see https://www.drupal.org/node/2896640
Chris@0:  */
Chris@0: trait DbUpdatesTrait {
Chris@0: 
Chris@0:   use StringTranslationTrait;
Chris@0: 
Chris@0:   /**
Chris@0:    * Enables db updates until the specified index.
Chris@0:    *
Chris@0:    * @param string $module
Chris@0:    *   The name of the module defining the update functions.
Chris@0:    * @param string $group
Chris@0:    *   A name identifying the group of update functions to enable.
Chris@0:    * @param $index
Chris@0:    *   The index of the last update function to run.
Chris@0:    */
Chris@0:   protected function enableUpdates($module, $group, $index) {
Chris@0:     $this->container->get('state')->set($module . '.db_updates.' . $group, $index);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Applies any pending DB updates through the Update UI.
Chris@0:    */
Chris@0:   protected function applyUpdates() {
Chris@0:     $this->drupalGet(Url::fromRoute('system.db_update'));
Chris@0:     $this->clickLink($this->t('Continue'));
Chris@0:     $this->clickLink($this->t('Apply pending updates'));
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Conditionally load Update API functions for the specified group.
Chris@0:    *
Chris@0:    * @param string $module
Chris@0:    *   The name of the module defining the update functions.
Chris@0:    * @param string $group
Chris@0:    *   A name identifying the group of update functions to enable.
Chris@0:    */
Chris@0:   public static function includeUpdates($module, $group) {
Chris@0:     if ($index = \Drupal::state()->get($module . '.db_updates.' . $group)) {
Chris@0:       module_load_include('inc', $module, 'update/' . $group . '_' . $index);
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0: }