function MigrateDrupalUiHooks::help

Implements hook_help().

File

core/modules/migrate_drupal_ui/src/Hook/MigrateDrupalUiHooks.php, line 17

Class

MigrateDrupalUiHooks

Hook implementations for migrate_drupal_ui.

Namespace

Code

public function help($route_name, RouteMatchInterface $route_match) {
    switch ($route_name) {
        case 'help.page.migrate_drupal_ui':
            $output = '';
            $output .= '<h2>' . t('About') . '</h2>';
            $output .= '<p>' . t('The Migrate Drupal UI module provides a simple user interface to perform an upgrade from an earlier version of Drupal. For more information, see the <a href=":migrate">online documentation for the Migrate Drupal UI module</a>.', [
                ':migrate' => 'https://www.drupal.org/upgrade/migrate',
            ]) . '</p>';
            $output .= '<h2>' . t('Uses') . '</h2>';
            $output .= '<dl>';
            $output .= '<dt>' . t('Preparing the site') . '</dt>';
            $output .= '<dd>' . t('You need to install all modules on this site that are installed on the previous site. For example, if you have used the Book module on the previous site then you must install the Book module on this site for that data to be available on this site.') . '</dd>';
            $output .= '<dt>' . t('Performing the upgrade') . '</dt>';
            $output .= '<dd>' . t('On the <a href=":upgrade">Upgrade</a> page, you are guided through performing the upgrade in several steps.', [
                ':upgrade' => Url::fromRoute('migrate_drupal_ui.upgrade')->toString(),
            ]) . '</dd>';
            $output .= '<dd><ol><li>' . t('If an upgrade has been performed on this site, you will be informed.') . '</li>';
            $output .= '<li>' . t('You need to enter the database credentials of the Drupal site that you want to upgrade. You can also include its files directory in the upgrade. For example local files, /var/www/docroot, or remote files http://www.example.com.') . '</li>';
            $output .= '<li>' . t('If there is existing content on the site that may be overwritten by this upgrade, you will be informed.') . '</li>';
            $output .= '<li>' . t('The next page provides an overview of the modules that will be upgraded and those that will not be upgraded, before you proceed to perform the upgrade.') . '</li>';
            $output .= '<li>' . t('Finally, a message is displayed about the number of upgrade tasks that were successful or failed.') . '</li></ol></dd>';
            $output .= '<dt>' . t('Reviewing the upgrade log') . '</dt>';
            $output .= '<dd>' . t('You can review a <a href=":log">log of upgrade messages</a> by clicking the link in the message provided after the upgrade or by filtering the messages for the type <em>migrate_drupal_ui</em> on the <a href=":messages">Recent log messages</a> page.', [
                ':log' => Url::fromRoute('migrate_drupal_ui.log')->toString(),
                ':messages' => Url::fromRoute('dblog.overview')->toString(),
            ]) . '</dd>';
            $output .= '<dt>' . t('Rolling back an upgrade') . '</dt>';
            $output .= '<dd>' . t('Rolling back an upgrade is not yet supported through the user interface.') . '</dd>';
            $output .= '</dl>';
            return $output;
    }
}