function group_permission_form in Group 7

Builds the role permission page.

Shows the permissions overview for either all group roles that affect a single group type (local and global roles) or a single group role entity. Roles that should be edited elsewhere (global) or are otherwise locked (local on a fixed group type) will have their checkboxes disabled.

_state

@todo Consolidate third and fourth argument and use instanceof?

Parameters

array $form:

GroupType $group_type: (optional) The group type to show the permissions page for. If left blank, a GroupRole entity needs to be passed as the fourth argument.

GroupRole $group_role: (optional) A single group role to show the page for. When $group_role is provided, $group_type is ignored.

Return value

array

2 string references to 'group_permission_form'

GroupRoleUIController::hook_menu in classes/group_role.ui_controller.inc

Provides definitions for implementing hook_menu().

GroupTypeUIController::hook_menu in classes/group_type.ui_controller.inc

Provides definitions for implementing hook_menu().

File

admin/group.permission.inc, line 28

Group role permissions admin UI.

Code

function group_permission_form($form, &$form_state, GroupType $group_type = NULL, GroupRole $group_role = NULL) {

  // Define whether we're on a group type overview page or not.
  $type_page = !empty($group_type) && empty($group_role);

  // Store if the permission descriptions should be hidden.
  $hide = system_admin_compact_mode();

  // Retrieve role names for columns.
  $group_roles = !$type_page ? array(
    $group_role->name => $group_role,
  ) : $group_type
    ->getRoles();

  // Store $group_roles for use in the theme function and submit handler.
  $form['roles'] = array(
    '#type' => 'value',
    '#value' => $group_roles,
  );

  // Shortcut to the theme function if no roles are available.
  if (empty($group_roles)) {
    return $form;
  }

  // Fetch permissions for all roles or the one selected role.
  $role_permissions = array();
  foreach ($group_roles as $group_role) {
    $role_permissions[$group_role->name] = $group_role->permissions;
  }

  // Get a list of all the modules implementing a hook_group_permission()
  // and sort by display name.
  $modules = array();
  $module_info = system_get_info('module');
  foreach (module_implements('group_permission') as $module) {
    $modules[$module] = $module_info[$module]['name'];
  }
  asort($modules);

  // We keep track of checkbox options for all three membership types. This
  // allows us to have certain checkboxes missing in case they are prohibited
  // for a membership type.
  $options = array(
    'anonymous' => array(),
    'outsider' => array(),
    'member' => array(),
  );

  // Populate the checkbox options and rows for every possible permission.
  foreach ($modules as $module => $module_name) {
    if ($permissions = module_invoke($module, 'group_permission')) {

      // Add the module name first so we can show a separating row.
      $form['permissions'][] = array(
        '#markup' => $module_name,
        '#id' => $module,
      );

      // Then add a row for every permission defined by the module.
      foreach ($permissions as $pname => $permission) {

        // Set the default warning message, if any.
        $warning = !empty($permission['restrict access']) ? t('Warning: Give to trusted roles only; this permission has security implications.') : '';

        // Fill in default values for the permission.
        $permission += array(
          'description' => '',
          'restrict access' => FALSE,
          'warning' => $warning,
          'limit to' => GROUP_LIMIT_ALL,
        );

        // Add the permission to the checkbox options. The label of each option
        // will be properly set in theme_group_permission_form().
        if ($permission['limit to'] & GROUP_LIMIT_ANONYMOUS) {
          $options['anonymous'][$pname] = '';
        }
        if ($permission['limit to'] & GROUP_LIMIT_OUTSIDER) {
          $options['outsider'][$pname] = '';
        }
        if ($permission['limit to'] & GROUP_LIMIT_MEMBER) {
          $options['member'][$pname] = '';
        }

        // Theme the permission name and description.
        $form['permissions'][$pname] = array(
          '#type' => 'item',
          '#markup' => $permission['title'],
          '#description' => theme('group_permission_description', array(
            'permission' => $permission,
            'hide' => $hide,
          )),
        );
        foreach ($group_roles as $rname => $group_role) {

          // Save which checkboxes should already be checked.
          if (in_array($pname, $role_permissions[$rname])) {
            $status[$rname][] = $pname;
          }
        }
      }
    }
  }

  // Keep track of every role's disabled status.
  $all_disabled = TRUE;
  foreach ($group_roles as $rname => $group_role) {
    $role_fixed = entity_has_status('group_role', $group_role, ENTITY_FIXED);

    // Check whether this role should be disabled. This is the case for either
    // fixed global roles, local roles that belong to a fixed group type or
    // global roles displayed on the group type permissions overview.
    $disabled = $group_role->global && ($type_page || $role_fixed);
    if (!empty($group_role->type) && ($group_type = group_type_load($group_role->type))) {
      $disabled = $disabled || entity_has_status('group_type', $group_type, ENTITY_FIXED);
    }

    // Add this role's disabled status to the tracker.
    $all_disabled = $all_disabled && $disabled;

    // Retrieve the correct key for the options array.
    $options_key = $rname == 'anonymous' || $rname == 'outsider' ? $rname : 'member';

    // Build the checkboxes for every role.
    $form['checkboxes'][$rname] = array(
      '#type' => 'checkboxes',
      '#options' => $options[$options_key],
      '#default_value' => isset($status[$rname]) ? $status[$rname] : array(),
      '#attributes' => array(
        'class' => array(
          'rid-' . $rname,
        ),
      ),
      '#disabled' => $disabled,
    );

    // Add the role names to the table.
    $form['roles'][$rname] = array(
      '#markup' => $group_role
        ->label(),
      '#tree' => TRUE,
    );
  }
  if (!$all_disabled) {
    $form['actions'] = array(
      '#type' => 'actions',
    );
    $form['actions']['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Save permissions'),
    );
  }
  $form['#attached']['js'][] = drupal_get_path('module', 'group') . '/misc/group.permission.js';
  return $form;
}