Source for file object_config.php

Documentation is available at object_config.php

  1. <?php
  2.     /**
  3.     * Glossary 1.0 configuration form.
  4.     *
  5.     * This is a fragment of HTML which gives the form elements for configuration of a glossary object, v1.0.
  6.     * ONLY the basic form elements should be included.
  7.     * The "form" tags and submit button are already specified outside.
  8.     * The $auth_obj and $sloodleauthid variables will identify the object being configured.
  9.     *
  10.     * @package sloodleglossary
  11.     * @copyright Copyright (c) 2008 Sloodle (various contributors)
  12.     * @license http://www.gnu.org/licenses/gpl-3.0.html GNU GPL v3
  13.     *
  14.     * @contributor Peter R. Bloomfield
  15.     *
  16.     */
  17.     
  18.     // IMPORTANT: make sure this is called from within a Sloodle script
  19.     if (!defined('SLOODLE_VERSION')) {
  20.         error('Not called from within a Sloodle script.');
  21.         exit();
  22.     }
  23.     
  24.     // Execute everything within a function to ensure we don't mess up the data in the other file
  25.     sloodle_display_config_form($sloodleauthid, $auth_obj);
  26.     
  27.     
  28.     
  29.     function sloodle_display_config_form($sloodleauthid, $auth_obj)
  30.     {
  31.     //--------------------------------------------------------
  32.     // SETUP
  33.         
  34.         // Determine which course is being accessed
  35.         $courseid = $auth_obj->course->get_course_id();
  36.         
  37.         // We need to fetch a list of visible glossaries on the course
  38.         // Get the ID of the chat type
  39.         $rec = get_record('modules', 'name', 'glossary');
  40.         if (!$rec) {
  41.             sloodle_debug("Failed to get glossary module type.");
  42.             exit();
  43.         }
  44.         $glossarymoduleid = $rec->id;
  45.         
  46.         // Get all visible glossary in the current course
  47.         $recs = get_records_select('course_modules', "course = $courseid AND module = $glossarymoduleid AND visible = 1");
  48.         if (!$recs) {
  49.             error(get_string('noglossaries','sloodle'));
  50.             exit();
  51.         }
  52.         $glossaries = array();
  53.         foreach ($recs as $cm) {
  54.             // Fetch the chatroom instance
  55.             $inst = get_record('glossary', 'id', $cm->instance);
  56.             if (!$inst) continue;
  57.             // Store the glossary details
  58.             $glossaries[$cm->id] = $inst->name;
  59.         }
  60.         // Sort the list by name
  61.         natcasesort($glossaries);
  62.         
  63.     //--------------------------------------------------------
  64.     // FORM
  65.     
  66.         // Get the current object configuration
  67.         $settings = SloodleController::get_object_configuration($sloodleauthid);
  68.         
  69.         // Setup our default values
  70.         $sloodlemoduleid = (int)sloodle_get_value($settings, 'sloodlemoduleid', 0);
  71.         $sloodlepartialmatches = (int)sloodle_get_value($settings, 'sloodlepartialmatches', 1);
  72.         $sloodlesearchaliases = (int)sloodle_get_value($settings, 'sloodlesearchaliases', 0);
  73.         $sloodlesearchdefinitions = (int)sloodle_get_value($settings, 'sloodlesearchdefinitions', 0);
  74.         $sloodleidletimeout = (int)sloodle_get_value($settings, 'sloodleidletimeout', 120);
  75.         
  76.     
  77.     ///// GENERAL CONFIGURATION /////
  78.         print_box_start('generalbox boxaligncenter');
  79.         echo '<h3>'.get_string('generalconfiguration','sloodle').'</h3>';
  80.         
  81.         // Ask the user to select a chatroom
  82.         echo get_string('selectglossary','sloodle').': ';
  83.         choose_from_menu($glossaries, 'sloodlemoduleid', $sloodlemoduleid, '');
  84.         echo "<br><br>\n";
  85.     
  86.         // Show partial matches
  87.         echo get_string('showpartialmatches','sloodle').': ';
  88.         choose_from_menu_yesno('sloodlepartialmatches', $sloodlepartialmatches);
  89.         echo "<br><br>\n";
  90.         
  91.         // Search aliases
  92.         echo get_string('searchaliases','sloodle').': ';
  93.         choose_from_menu_yesno('sloodlesearchaliases', $sloodlesearchaliases);
  94.         echo "<br><br>\n";
  95.         
  96.         // Search definitions
  97.         echo get_string('searchdefinitions','sloodle').': ';
  98.         choose_from_menu_yesno('sloodlesearchdefinitions', $sloodlesearchdefinitions);
  99.         echo "<br><br>\n";
  100.         
  101.         // Ask the user for an idle timeout period (# seconds of no activity before automatic shutdown)
  102.         echo get_string('idletimeoutseconds','sloodle').': ';
  103.         echo '<input type="text" name="sloodleidletimeout" value="'.$sloodleidletimeout.'" size="8" maxlength="8" />';
  104.         echo "<br>\n";
  105.         
  106.         print_box_end();
  107.         
  108.         
  109.     ///// ACCESS LEVELS /////
  110.         sloodle_print_access_level_options($settings);
  111.         
  112.     }
  113.     
  114. ?>

Documentation generated on Fri, 17 Jul 2009 11:02:18 +0100 by phpDocumentor 1.4.0