help.post_update.php

Same filename and directory in other branches
  1. 11.x core/modules/help/help.post_update.php
  2. 10 core/modules/help/help.post_update.php

Post update functions for the Help module.

File

core/modules/help/help.post_update.php

View source
<?php


/**
 * @file
 * Post update functions for the Help module.
 */


/**
 * Implements hook_removed_post_updates().
 */
function help_removed_post_updates() : array {
  return [
    'help_post_update_help_topics_search' => '11.0.0',
    'help_post_update_help_topics_uninstall' => '11.0.0',
    'help_post_update_add_permissions_to_roles' => '11.0.0',
  ];
}

/**
 * Update config entity dependencies to the Search Help module, if necessary.
 *
 * @see system_update_11400()
 */
function help_post_update_search_help_dependencies() : void {
  if (\Drupal::moduleHandler()->moduleExists('search')) {
    // @todo https://www.drupal.org/project/drupal/issues/3587570 Determine why
    //   the search.page.help_search config entity does not have a UUID in the
    //   11.3 test database dump. This means it is not discovered as a config
    //   entity dependency of the help module.
    $search_page_config = \Drupal::configFactory()->getEditable('search.page.help_search');
    if (!$search_page_config->isNew() && $search_page_config->get('uuid') === NULL) {
      $search_page_config->set('uuid', \Drupal::service('uuid')->generate())
        ->save();
    }
    // Update the dependencies of all help config entities if they have
    // changed.
    foreach (\Drupal::service('config.manager')->findConfigEntityDependenciesAsEntities('module', [
      'help',
    ]) as $entity) {
      $dependencies = $entity->getDependencies();
      if ($entity->calculateDependencies()
        ->getDependencies() !== $dependencies) {
        $entity->save();
      }
    }
  }
}

Functions

Title Deprecated Summary
help_post_update_search_help_dependencies Update config entity dependencies to the Search Help module, if necessary.
help_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.