update_test_postupdate.post_update.php

Same filename in other branches
  1. 9 core/modules/system/tests/modules/update_test_postupdate/update_test_postupdate.post_update.php
  2. 8.9.x core/modules/system/tests/modules/update_test_postupdate/update_test_postupdate.post_update.php
  3. 10 core/modules/system/tests/modules/update_test_postupdate/update_test_postupdate.post_update.php

File

core/modules/system/tests/modules/update_test_postupdate/update_test_postupdate.post_update.php

View source
<?php


/**
 * @file
 * Post update functions for test module.
 */
declare (strict_types=1);
// cspell:ignore postupdate

/**
 * First update.
 */
function update_test_postupdate_post_update_first() : string {
    $execution = \Drupal::state()->get('post_update_test_execution', []);
    $execution[] = __FUNCTION__;
    \Drupal::state()->set('post_update_test_execution', $execution);
    return 'First update';
}

/**
 * Second update.
 */
function update_test_postupdate_post_update_second() : string {
    $execution = \Drupal::state()->get('post_update_test_execution', []);
    $execution[] = __FUNCTION__;
    \Drupal::state()->set('post_update_test_execution', $execution);
    return 'Second update';
}

/**
 * Test1 update.
 */
function update_test_postupdate_post_update_test1() : string {
    $execution = \Drupal::state()->get('post_update_test_execution', []);
    $execution[] = __FUNCTION__;
    \Drupal::state()->set('post_update_test_execution', $execution);
    return 'Test1 update';
}

/**
 * Test0 update.
 */
function update_test_postupdate_post_update_test0() : string {
    $execution = \Drupal::state()->get('post_update_test_execution', []);
    $execution[] = __FUNCTION__;
    \Drupal::state()->set('post_update_test_execution', $execution);
    return 'Test0 update';
}

/**
 * Testing batch processing in post updates update.
 */
function update_test_postupdate_post_update_test_batch(&$sandbox = NULL) : string {
    if (!isset($sandbox['steps'])) {
        $sandbox['current_step'] = 0;
        $sandbox['steps'] = 3;
    }
    $sandbox['current_step']++;
    $execution = \Drupal::state()->get('post_update_test_execution', []);
    $execution[] = __FUNCTION__ . '-' . $sandbox['current_step'];
    \Drupal::state()->set('post_update_test_execution', $execution);
    $sandbox['#finished'] = $sandbox['current_step'] / $sandbox['steps'];
    return 'Test post update batches';
}

/**
 * Implements hook_removed_post_updates().
 */
function update_test_postupdate_removed_post_updates() : array {
    return [
        'update_test_postupdate_post_update_foo' => '8.x-1.0',
        'update_test_postupdate_post_update_bar' => '8.x-2.0',
        'update_test_postupdate_post_update_pub' => '3.0.0',
        'update_test_postupdate_post_update_baz' => '3.0.0',
    ];
}

Functions

Title Deprecated Summary
update_test_postupdate_post_update_first First update.
update_test_postupdate_post_update_second Second update.
update_test_postupdate_post_update_test0 Test0 update.
update_test_postupdate_post_update_test1 Test1 update.
update_test_postupdate_post_update_test_batch Testing batch processing in post updates update.
update_test_postupdate_removed_post_updates Implements hook_removed_post_updates().

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