function webform_purge_help in Webform Purge 7

Implements hook_help().

File

./webform_purge.module, line 68

Custom functionality for purging webform submissions.

Code

function webform_purge_help($path, $arg) {
  switch ($path) {
    case 'admin/help#webform_purge':
      $ret_val = '<h3>' . t('About') . '</h3>';
      $ret_val .= '<p>' . t('The Webform Purge module allows you to set up automated purging of Webform submissions on a daily rolling schedule. You select the number of days to retain and the module uses hook_cron to purge them during cron runs.') . '</p>';
      $ret_val .= '<h3>' . t('Configuration') . '</h3>';
      $ret_val .= '<p>' . t('Configure the settings in Administration » Configuration » Webform Purge:') . '</p>';
      $ret_val .= '<ul>';
      $ret_val .= '<li>' . t('Enable automated purging - This option enables the functionality of the module. If not checked, the purge function will not run.') . '</li>';
      $ret_val .= '<li>' . t('Run only once per day - This option is used to limit the purge to just one cron run per day. Conversely if unchecked, it will execute with every cron run.') . '</li>';
      $ret_val .= '<li>' . t('Days to retain - The number of days to retain submissions before they are purged.') . '</li>';
      $ret_val .= '</ul>';
      $ret_val .= '<h3>' . t('FAQ') . '</h3>';
      $ret_val .= '<p>' . t('If expected entries are not purged, check the following:') . '</p>';
      $ret_val .= '<ul>';
      $ret_val .= '<li>' . t('Is the Enable automated purging checkbox checked?') . '</li>';
      $ret_val .= '<li>' . t('Is the submission younger than the Days to retain?') . '</li>';
      $ret_val .= '</ul>';
      $ret_val .= '<h3>' . t('Troubleshooting') . '</h3>';
      $ret_val .= '<p>' . t('Q - If I want to incrementally purge starting with a very old date and progress to my target date, do I have to run this across multiple days?') . '</p>';
      $ret_val .= '<ul>';
      $ret_val .= '<li>' . t('No, you can uncheck the "Run only once per day" option and then set a "Days to retain" at an initial high value and run the cron job. Repeat this with lower values until you achieve your target number of days to retain.') . '</li>';
      $ret_val .= '</ul>';
      $ret_val .= '<p>' . t('Q - How can I tell how many entries were purged?') . '</p>';
      $ret_val .= '<ul>';
      $ret_val .= '<li>' . t('Check the "Recent log messages" under the Reports tab for an informational entry from the webform_purge module.') . '</li>';
      $ret_val .= '</ul>';
      $ret_val .= '<h3>' . t('Module Resources') . '</h3>';
      $ret_val .= '<p>' . t('For a full description of the module, visit the <a href="https://www.drupal.org/project/webform_purge" target="_blank">project page.</a>') . '</p>';
      $ret_val .= '<p>' . t('To submit  <a href="https://www.drupal.org/project/issues/webform_purge" target="_blank">bug reports and feature suggestions, or to track changes.</a>') . '</p>';
      break;
    default:
      $ret_val = '';
      break;
  }
  return $ret_val;
}