function auditfiles_help in Audit Files 5

Same name and namespace in other branches

1. 8.3 auditfiles.module \auditfiles_help()
2. 8.2 auditfiles.module \auditfiles_help()
3. 6.3 auditfiles.module \auditfiles_help()
4. 6.2 auditfiles.module \auditfiles_help()
5. 7.4 auditfiles.module \auditfiles_help()
6. 7.3 auditfiles.module \auditfiles_help()
7. 4.x auditfiles.module \auditfiles_help()

Implementation of hook_help().

File

./auditfiles.module, line 12

Code

function auditfiles_help($section) {
  switch ($section) {
    case 'admin/settings/auditfiles':
      return t('You can choose to exclude specific files, paths and extensions from the \'files not in database\' audit report by adding them to the relevant lists below.');
    case 'admin/help#auditfiles':
      return '<p>' . t('The audit files module performs an audit of the file table and the files directory to check for inconsistencies.') . '</p>';
    case 'admin/logs/auditfiles':
      return '<p>' . t('These reports allow you to audit the consistency of the {files} table and your physical files. Choose from the two reports offered below.') . '</p>';
    case 'admin/logs/auditfiles/notonserver':
      $output .= '<p>' . t('The files listed below are in the {files} table but the physical files do not exist on the server. This might mean the file has been deleted using a program such as FTP, or it may mean there is an error in the database. You can click on the node numbers to view the item to which the missing file relates to try and determine what action needs to be taken. For example, you may need to edit the node to re-attach the file.') . '</p>';
      $output .= '<p>' . t('Files in this list are relative to the files directory %directorypath.', array(
        '%directorypath' => file_directory_path(),
      )) . '</p>';
      return $output;
    case 'admin/logs/auditfiles/notindb':
      $output .= '<p>' . t('The files listed below are in the files directory on the server but appear to have no corresponding entry in the {files} table. Files in "temporary" folders such as those created by the image module are included in order to check that they are not filling up. You can choose to delete files from this report but remember that if you do this the action cannot be undone.') . '</p>';
      $output .= '<p>' . t('Files in this list are relative to the files directory %directorypath.', array(
        '%directorypath' => file_directory_path(),
      )) . '</p>';

      // If on the delete confirmation form then suppress the help message
      if ($_POST['operation'] == 'delete' && $_POST['files']) {
        $output = '';
      }
      return $output;
  }
}