You are here

function flexiaccess_help in Flexi Access 7

Implements hook_help().

File

./flexiaccess.module, line 11
Main hooks for per user access control.

Code

function flexiaccess_help($path, $arg) {
  switch ($path) {
    case 'admin/help#flexiaccess':
      $output = '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Flexi access module provides a simple interfrace to the !acl', array(
        '!acl' => l(t('ACL'), 'http://drupal.org/project/acl/'),
      ));
      $output .= ' (Access Control List) ' . t('module') . '. ';
      $output .= t('It lets you set up and mange ACLs naming individual users that are allowed access to a particular node.') . '</p>';
      $output .= '<h3>' . t('Usage') . '</h3><dl>';
      $output .= '<dt>' . t('Administrative interface:') . '</dt>';
      $output .= '<dd>' . t('The !aif has the following tabs:', array(
        '!aif' => l(t('administrative interface'), 'admin/config/people/flexiaccess'),
      )) . '<br/><ul>';
      $output .= '<li>' . t('Main settings: Enable/disable the content types you want Flexi access to manage. Set up automatic ACL creation. Set default priority for ACL entries.') . '</li>';
      $output .= '<li>' . t('Anonymous user: Set a name for the anonymous user (required to attach an ACL to the anonymous user).') . '</li>';
      $output .= '<li>' . t('Bulk operations: Bulk operations to reset ACL priorities and delete all ACLs.') . '</li></dd></ul>';

      // $output .= '<li>' . t('User Lists: Administer (create/edit/delete)
      // predefined user lists. [forthcoming]') . '</li>';
      $output .= '<dt>' . t('Node interface:') . '</dt>';
      $output .= '<dd>' . t('Administrators viewing a node of a Flexi access enabled content type will see a tab called “Flexi access”. Inside this tab, there is three subfields (<em>view, update, delete</em>). Each subfield can be used to manage an ACL granting individual users view, update, and delete rights for the node.') . '</dd>';
      $output .= '<dt>' . t('User profile interface:') . '</dt>';
      $output .= '<dd>' . t('Administrators viewing a user profile will see a tab named “Flexi access” as part of that profile.  This tab is to manage ACLs for that particular user.');
      $output .= '</dl>';
      if (function_exists('advanced_help_hint_docs')) {
        $output .= '<p>' . advanced_help_hint_docs('flexiaccess', 'https://www.drupal.org/docs/7/modules/flexi-access', TRUE) . '</p>';
      }
      else {
        $output .= t('If you install and enable the module <strong>!url</strong>, you will get more help for <strong>Flexi access</strong>.', array(
          '!url' => l('Advanced help hint', 'https://www.drupal.org/project/advanced_help_hint'),
        ));
      }
      return $output;
  }
}