function backup_migrate_help in Backup and Migrate 5.2

Same name and namespace in other branches

1. 8.4 backup_migrate.module \backup_migrate_help()
2. 8.2 backup_migrate.module \backup_migrate_help()
3. 8.3 backup_migrate.module \backup_migrate_help()
4. 6.3 backup_migrate.module \backup_migrate_help()
5. 6.2 backup_migrate.module \backup_migrate_help()
6. 7.3 backup_migrate.module \backup_migrate_help()
7. 7.2 backup_migrate.module \backup_migrate_help()
8. 5.0.x backup_migrate.module \backup_migrate_help()

Implementation of hook_menu().

File

./backup_migrate.module, line 15

Create (manually or scheduled) and restore backups of your Drupal MySQL database with an option to exclude table data (e.g. cache_*)

Code

function backup_migrate_help($section) {
  $help = array(
    array(
      'body' => t('Backup and Migrate makes the task of backing up your Drupal database and migrating data from one Drupal install to another easier. It provides a function to backup the entire database to file or download, and to restore from a previous backup. You can also schedule the backup operation. Compression of backup files is also supported.'),
    ),
    'admin/content/backup_migrate' => array(
      'title' => t('Backup Tab'),
      'body' => t('Use this form to run manual backups of your database. You can fill out the fields below, or if you have any <a href="!profileurl">settings profiles</a> saved you can load one. The backup files created can be imported into this or any other Drupal installation with the <a href="!restoreurl">restore feature</a>, or you can use a database tool such as <a href="!phpmyadminurl">phpMyAdmin</a> or the mysql command line command.', array(
        "!profileurl" => url('admin/content/backup_migrate/profile'),
        '!restoreurl' => url('admin/content/backup_migrate/restore'),
        '!phpmyadminurl' => 'http://www.phpmyadmin.net',
      )),
    ),
    'admin/content/backup_migrate/restore' => array(
      'title' => t('Restore Tab'),
      'body' => t('Use this form to upload a previously created backup file. You must make sure that your php settings allow for uploads of the size of your backip file. Compressed backups will be automatically decompressed as long as their file extensions have not been changed. The restore function will not work with databse dumps from other sources such as phpMyAdmin.'),
    ),
    'admin/content/backup_migrate/destination' => array(
      'title' => t('Destinations'),
      'body' => t('Destinations are the places you can save your backup files. Files can be saved to a directory on your web server, downloaded to your desktop or emailed to a specified email account. Other modules may enable other destination types. From the Destinations tab you can create, delete and edit destinations or list the files which have already been backed up to the available destinations.'),
    ),
    'admin/content/backup_migrate/profile' => array(
      'title' => t('Profiles'),
      'body' => t('Profiles are saved backup settings. Profiles store your table exclusion settings as well as your backup file name, compression and timestamp settings. You can use profiles in <a href="!scheduleurl">schedules</a> and for <a href="!manualurl">manual backups</a>.', array(
        "!scheduleurl" => url('admin/content/backup_migrate/schedule'),
        '!manualurl' => url('admin/content/backup_migrate'),
      )),
    ),
    'admin/content/backup_migrate/schedule' => array(
      'title' => t('Scheduling'),
      'body' => t('You can specify schedules on which your database will be automatically backed up. Schedules are run by <a href="!cronurl">cron</a>, and each schedule will run a maximum of once per cron run, so they will not run more frequently than your cron is configured to run. If you specify a number of backups to keep for a schedule, old backups will be deleted as new ones created. <strong>If specifiy a number of files to keep other backup files in that schedule\'s destination will get deleted</strong>.', array(
        '!cronurl' => 'http://drupal.org/cron',
      )),
    ),
  );
  if (isset($help[$section])) {
    return $help[$section]['body'];
  }
  if ($section == 'admin/help#backup_migrate') {
    $out = "";
    foreach ($help as $key => $section) {
      if ($section['title']) {
        if (!is_numeric($key)) {
          $section['title'] = l($section['title'], $key);
        }
        $out .= "<h3>" . $section['title'] . "</h3>";
      }
      $out .= "<p>" . $section['body'] . "</p>";
    }
    return $out;
  }
}