course.settings.inc in Course 6

Administrative settings for Course module.

File

includes/course.settings.inc

<?php

/**
 * @file
 * Administrative settings for Course module.
 */

/**
 * Menu callback: Define the Course settings form.
 *
 * @param array $settings
 *   (optional) The loaded settings handler.
 */
function course_settings_overview() {

  // Course settings handler forms. This allows Course to ensure consistent
  // placement of forms from modules that define settings handlers through
  // hook_course_handlers().
  $form['course_extensions'] = array(
    '#type' => 'fieldset',
    '#title' => t('Settings overview'),
  );
  $modules = course_get_handlers('settings');
  $handlers = array();
  foreach ($modules as $settings) {
    if (is_array($settings)) {
      $handlers += $settings;
    }
  }
  $header = array(
    t('Package'),
    t('Description'),
    t('Operations'),
  );
  $rows = array();
  foreach ($handlers as $handler_key => $handler_info) {

    // Generate a list of each handler category.
    $package_key = isset($handler_info['package']) ? $handler_info['package'] : $handler_key;
    $package_info = $handlers[$package_key] ? $handlers[$package_key] : $handler_info;
    if (!isset($package_set[$package_key])) {
      $rows[] = array(
        $package_info['name'],
        $package_info['description'],
        l(t('Edit'), "admin/settings/course/{$package_key}", array(
          'query' => drupal_get_destination(),
        )),
      );
      $package_set[$package_key] = TRUE;
    }
  }
  $form['course_extensions']['course_extensions_table'] = array(
    '#value' => theme('table', $header, $rows),
  );
  return $form;
}

/**
 * Course objects settings handler callback.
 */
function course_settings_objects_form() {
  $form = array();
  $form['course_object_custom_fields'] = array(
    '#title' => t('Custom course object fields'),
    '#type' => 'textarea',
    '#rows' => 5,
    '#description' => t('Enter a key|value format to enable custom fields on course objects.'),
    '#default_value' => variable_get('course_object_custom_fields', ''),
    '#element_validate' => array(
      'course_check_keyval',
    ),
  );
  return system_settings_form($form);
}

/**
 * Appearance settings form callback.
 */
function course_settings_appearance_form() {
  $form = array();
  $form['course_takecourse_tab_display'] = array(
    '#title' => t('Show a "take course" tab on course nodes'),
    '#type' => 'checkbox',
    '#default_value' => variable_get('course_takecourse_tab_display', 1),
  );
  $form['course_take_course_button_show'] = array(
    '#title' => t('Show "take course" button on'),
    '#type' => 'checkboxes',
    '#options' => array(
      'teaser' => t('Teaser'),
      'page' => t('Page'),
    ),
    '#default_value' => variable_get('course_take_course_button_show', array()),
    '#description' => t('Check to show a "take course" button on courses.'),
  );
  $form['course_disable_regions'] = array(
    '#title' => t('Disable theme regions when taking a course'),
    '#type' => 'checkboxes',
    '#default_value' => variable_get('course_disable_regions', array()),
    '#options' => system_region_list(variable_get('theme_default', '')),
  );
  return system_settings_form($form);
}

/**
 * Element validator to make sure all entries are in key|val format.
 */
function course_check_keyval($element, &$form_state) {
  $val = trim($element['#value']);
  if ($val) {
    if (substr_count($val, "\n") + 1 != substr_count($val, '|')) {
      form_error($element, t('Please ensure all custom object fields are in the format key|value.'));
    }
  }
}

/**
 * Get an array of custom course object fields.
 *
 * @return array
 *   An array of custom course object fields, in the format key => value.
 */
function course_object_custom_fields() {
  $fields = array();
  $list = explode("\n", variable_get('course_object_custom_fields', ''));
  $list = array_map('trim', $list);
  $list = array_filter($list, 'strlen');
  foreach ($list as $opt) {

    // Sanitize the user input with a permissive filter.
    $opt = content_filter_xss($opt);
    if (strpos($opt, '|') !== FALSE) {
      list($key, $value) = explode('|', $opt);
      $fields[$key] = isset($value) && $value !== '' ? $value : $key;
    }
    else {
      $fields[$key] = $opt;
    }
  }
  return $fields;
}

/**
 * Form for configuring user types.
 */
function course_user_type_settings_form() {
  $form = array();
  $form['header'] = array(
    '#value' => t('User types allow a user to select their type only for the enrollment duration of taking the course. For example, other modules may implement a mapping from the user type to course credit or a certificate while leaving a global profile field unchanged.'),
  );
  $form['course_user_types_enabled'] = array(
    '#title' => t('Use course enrollment user types'),
    '#type' => 'checkbox',
    '#validate' => 'course_user_type_settings_form_validate',
    '#default_value' => variable_get('course_user_types_enabled', ''),
  );
  $form['course_user_types_field'] = array(
    '#title' => t('Profile field to pull types from'),
    '#type' => 'select',
    '#default_value' => variable_get('course_user_types_field', ''),
    '#options' => course_cck_kv_fields(),
  );
  $form['course_user_types'] = array(
    '#title' => t('Additional user types'),
    '#type' => 'textarea',
    '#rows' => 5,
    '#validate' => 'course_user_type_settings_form_validate',
    '#default_value' => variable_get('course_user_types', ''),
    '#description' => t('Input course enrollment user types in the format "key|value", one per line.'),
  );
  return system_settings_form($form);
}

/**
 * Validate the user input for enrollment types.
 */
function course_user_type_settings_form_validate(&$form, &$form_state) {
  $lines = explode("\n", trim($form_state['values']['course_user_types']));
  foreach ($lines as $line) {
    if (empty($line)) {
      return;
    }
    $kv = explode('|', $line);
    if (count($kv) != 2) {
      form_set_error('course_user_types', t('Each user type must be in key|value format.'));
    }
  }
}

/**
 * Get an array of field options that can be used as course enrollment types.
 */
function course_cck_kv_fields() {
  $field_options = array();
  $field_options[] = '- none -';
  if (module_exists('content')) {
    foreach (content_fields() as $key => $field) {

      // If field isn't a profile field with allowed values, do not allow it to be selectable. It wouldn't work anyways.
      if (optionwidgets_options($field)) {
        $field_options[$key] = $field['widget']['label'];
      }
    }
  }
  return $field_options;
}

Functions

Name	Description
course_cck_kv_fields	Get an array of field options that can be used as course enrollment types.
course_check_keyval	Element validator to make sure all entries are in key|val format.
course_object_custom_fields	Get an array of custom course object fields.
course_settings_appearance_form	Appearance settings form callback.
course_settings_objects_form	Course objects settings handler callback.
course_settings_overview	Menu callback: Define the Course settings form.
course_user_type_settings_form	Form for configuring user types.
course_user_type_settings_form_validate	Validate the user input for enrollment types.