og_context.admin.inc in Organic groups 7

Administration functions for Group context module.

File

og_context/og_context.admin.inc

<?php

/**
 * @file
 * Administration functions for Group context module.
 */

/**
 * @defgroup locale-languages-negotiation Language negotiation options
 * @{
 */

/**
 * Setting for language negotiation options
 */
function og_context_configure_form() {
  $form = array(
    '#submit' => array(
      'og_context_configure_form_submit',
    ),
    '#theme' => 'og_context_configure_form',
    '#group_context_providers' => og_context_negotiation_info(),
  );
  _group_context_configure_form_table($form);
  $form['actions'] = array(
    '#type' => 'actions',
  );
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save settings'),
  );
  return $form;
}

/**
 * Helper function to build a group context provider table.
 */
function _group_context_configure_form_table(&$form) {
  $type = 'group_context';
  $table_form = array(
    '#title' => t('Group context detection'),
    '#tree' => TRUE,
    '#description' => t('Order of Group context detection methods.'),
    '#group_context_providers' => array(),
    '#show_operations' => FALSE,
    'weight' => array(
      '#tree' => TRUE,
    ),
    'enabled' => array(
      '#tree' => TRUE,
    ),
  );
  $group_context_providers = $form['#group_context_providers'];

  // Enable url and node context handlers by default.
  $defaults = array(
    'url' => -5,
    'node' => -4,
  );
  $enabled_providers = variable_get("og_context_negotiation_{$type}", $defaults);
  $providers_weight = variable_get("og_context_providers_weight_{$type}", $defaults);

  // Add missing data to the providers lists.
  foreach ($group_context_providers as $id => $provider) {
    if (!isset($providers_weight[$id])) {
      $providers_weight[$id] = og_context_provider_weight($provider);
    }
  }

  // Order providers list by weight.
  asort($providers_weight);
  foreach ($providers_weight as $id => $weight) {
    $enabled = isset($enabled_providers[$id]);
    $provider = $group_context_providers[$id];
    $table_form['#group_context_providers'][$id] = $provider;
    $table_form['weight'][$id] = array(
      '#type' => 'weight',
      '#default_value' => $weight,
      '#attributes' => array(
        'class' => array(
          "group_context-provider-weight-{$type}",
        ),
      ),
    );
    $table_form['title'][$id] = array(
      '#markup' => check_plain($provider['name']),
    );
    $table_form['enabled'][$id] = array(
      '#type' => 'checkbox',
      '#default_value' => $enabled,
    );
    $table_form['description'][$id] = array(
      '#markup' => filter_xss_admin($provider['description']),
    );
    $config_op = array();
    if (isset($provider['config'])) {
      $config_op = array(
        '#type' => 'link',
        '#title' => t('Configure'),
        '#href' => $provider['config'],
      );

      // If there is at least one operation enabled show the operation column.
      $table_form['#show_operations'] = TRUE;
    }
    $table_form['operation'][$id] = $config_op;
  }
  $form['group_context'] = $table_form;
}

/**
 * Returns HTML for a group context configuration form.
 *
 * @param $variables
 *   An associative array containing:
 *   - form: A render element representing the form.
 *
 * @ingroup themeable
 */
function theme_og_context_configure_form($variables) {
  $form = $variables['form'];
  $output = '';
  $type = 'group_context';
  $rows = array();
  $title = '<label>' . $form[$type]['#title'] . '</label>';
  $description = '<div class="description">' . $form[$type]['#description'] . '</div>';
  foreach ($form[$type]['title'] as $id => $element) {

    // Do not take form control structures.
    if (is_array($element) && element_child($id)) {
      $row = array(
        'data' => array(
          '<strong>' . drupal_render($form[$type]['title'][$id]) . '</strong>',
          drupal_render($form[$type]['description'][$id]),
          drupal_render($form[$type]['enabled'][$id]),
          drupal_render($form[$type]['weight'][$id]),
        ),
        'class' => array(
          'draggable',
        ),
      );
      if ($form[$type]['#show_operations']) {
        $row['data'][] = drupal_render($form[$type]['operation'][$id]);
      }
      $rows[] = $row;
    }
  }
  $header = array(
    array(
      'data' => t('Detection method'),
    ),
    array(
      'data' => t('Description'),
    ),
    array(
      'data' => t('Enabled'),
    ),
    array(
      'data' => t('Weight'),
    ),
  );

  // If there is at least one operation enabled show the operation column.
  if ($form[$type]['#show_operations']) {
    $header[] = array(
      'data' => t('Operations'),
    );
  }
  $variables = array(
    'header' => $header,
    'rows' => $rows,
    'attributes' => array(
      'id' => "group_context-negotiation-providers-{$type}",
    ),
  );
  $table = theme('table', $variables);
  $table .= drupal_render_children($form[$type]);
  drupal_add_tabledrag("group_context-negotiation-providers-{$type}", 'order', 'sibling', "group_context-provider-weight-{$type}");
  $output .= '<div class="form-item">' . $title . $description . $table . '</div>';
  $output .= drupal_render_children($form);
  return $output;
}

/**
 * Submit handler for og_context negotiation settings.
 */
function og_context_configure_form_submit($form, &$form_state) {
  $type = 'group_context';
  $negotiation = array();
  $enabled_providers = $form_state['values'][$type]['enabled'];
  $providers_weight = $form_state['values'][$type]['weight'];
  foreach ($providers_weight as $id => $weight) {
    if ($enabled_providers[$id]) {
      $provider = $form[$type]['#group_context_providers'][$id];
      $provider['weight'] = $weight;
      $negotiation[$id] = $provider;
    }
  }
  og_context_negotiation_set($negotiation);
  variable_set("og_context_providers_weight_{$type}", $providers_weight);
  $form_state['redirect'] = 'admin/config/group/context';
  drupal_set_message(t('Group context negotiation configuration saved.'));
}

/**
 * @} End of "locale-group_contexts-negotiation"
 */

Functions

Name	Description
og_context_configure_form	Setting for language negotiation options
og_context_configure_form_submit	Submit handler for og_context negotiation settings.
theme_og_context_configure_form	Returns HTML for a group context configuration form.
_group_context_configure_form_table	Helper function to build a group context provider table.