function entityform_help in Entityform 7

Same name and namespace in other branches

1. 7.2 entityform.module \entityform_help()

Implements hook_help().

File

./entityform.module, line 1438

Module for the Entityform Entity - a starting point to create your own Entity and associated administration interface

Code

function entityform_help($path, $arg) {
  $output = '';
  $view_mode_text = 'This View Mode is used to controls how fields will displayed ';
  switch ($path) {
    case 'admin/structure/entityform_types/manage/%/display/download':
      $output = t("{$view_mode_text} in the CSV and XML downloads and their order.");
      break;
    case 'admin/structure/entityform_types/manage/%/display/table':
      $output = t("{$view_mode_text} in submissions table.");
      break;
    case 'admin/structure/entityform_types/manage/%/display/confirmation':
      $output = t("{$view_mode_text} on the submission conformation page.");
      break;
    case 'admin/config/content/entityform':
      $output = t('Set the default settings for new Entityform Types. This will be used for new Entityform Types.');
      break;
    case 'admin/structure/entityform_types/manage/%/submissions':
      $display_id = $arg[6];

    // Intentionally no "break" here. It should fall through.
    case 'admin/reports/entityforms/submissions/%':
      if ($path == 'admin/reports/entityforms/submissions/%') {
        $display_id = $arg[5];
      }
      if (user_access('administer entityform types')) {
        if ($display_id == 'autofields_table') {
          $output = t('The fields on this table can be controlled via the "Table" view mode under Manage Display for this Entityform Type.');
        }
      }
    case 'admin/structure/entityform_types/access_rules/manage/%':

      // Give an explanation of how the access Rule works.
      $rule_object = menu_get_object('rules_config', 5);
      if (is_subclass_of($rule_object, 'RulesActionContainer')) {
        $output = t('This Rule must set the provided variable %var to TRUE for the Entityform to show.', array(
          '%var' => 'show_form',
        ));
      }
      elseif (is_subclass_of($rule_object, 'RulesConditionContainer')) {
        $output = t('This Rule must evaluate to TRUE for the Entityform to show.', array(
          '%var' => 'show_form',
        ));
      }
      break;
    case 'admin/structure/entityform_types/validation_rules/manage/%':
      $output = t('If this Rule sets the provided variable %var to FALSE then the Entityform submission will not validae.', array(
        '%var' => 'validate_form',
      ));
      $output .= ' ' . t('The Rule should also display a message to the user about the validation error.');
  }
  return $output;
}