mod/lti/edit_form.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16 //
  17 // This file is part of BasicLTI4Moodle
  18 //
  19 // BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)
  20 // consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web
  21 // based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI
  22 // specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS
  23 // are already supporting or going to support BasicLTI. This project Implements the consumer
  24 // for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.
  25 // BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem
  26 // at the GESSI research group at UPC.
  27 // SimpleLTI consumer for Moodle is an implementation of the early specification of LTI
  28 // by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a
  29 // Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.
  30 //
  31 // BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis
  32 // of the Universitat Politecnica de Catalunya http://www.upc.edu
  33 // Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu.
  34
  35 /**
  36  * This file defines de main basiclti configuration form
  37  *
  38  * @package mod_lti
  39  * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
  40  *  marc.alier@upc.edu
  41  * @copyright  2009 Universitat Politecnica de Catalunya http://www.upc.edu
  42  * @author     Marc Alier
  43  * @author     Jordi Piguillem
  44  * @author     Nikolas Galanis
  45  * @author     Charles Severance
  46  * @author     Chris Scribner
  47  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  48  */
  49
  50 defined('MOODLE_INTERNAL') || die;
  51
  52 require_once($CFG->libdir.'/formslib.php');
  53 require_once($CFG->dirroot.'/mod/lti/locallib.php');
  54
  55 class mod_lti_edit_types_form extends moodleform{
  56     public function definition() {
  57         global $CFG;
  58
  59         $mform    =& $this->_form;
  60
  61         $istool = $this->_customdata && $this->_customdata->istool;
  62
  63         // Add basiclti elements.
  64         $mform->addElement('header', 'setup', get_string('tool_settings', 'lti'));
  65
  66         $mform->addElement('text', 'lti_typename', get_string('typename', 'lti'));
  67         $mform->setType('lti_typename', PARAM_TEXT);
  68         $mform->addHelpButton('lti_typename', 'typename', 'lti');
  69         $mform->addRule('lti_typename', null, 'required', null, 'client');
  70
  71         $mform->addElement('text', 'lti_toolurl', get_string('toolurl', 'lti'), array('size' => '64'));
  72         $mform->setType('lti_toolurl', PARAM_TEXT);
  73         $mform->addHelpButton('lti_toolurl', 'toolurl', 'lti');
  74         if (!$istool) {
  75             $mform->addRule('lti_toolurl', null, 'required', null, 'client');
  76         } else {
  77             $mform->disabledIf('lti_toolurl', null);
  78         }
  79
  80         if (!$istool) {
  81             $mform->addElement('text', 'lti_resourcekey', get_string('resourcekey_admin', 'lti'));
  82             $mform->setType('lti_resourcekey', PARAM_TEXT);
  83             $mform->addHelpButton('lti_resourcekey', 'resourcekey_admin', 'lti');
  84
  85             $mform->addElement('passwordunmask', 'lti_password', get_string('password_admin', 'lti'));
  86             $mform->setType('lti_password', PARAM_TEXT);
  87             $mform->addHelpButton('lti_password', 'password_admin', 'lti');
  88         }
  89
  90         if ($istool) {
  91             $mform->addElement('textarea', 'lti_parameters', get_string('parameter', 'lti'), array('rows' => 4, 'cols' => 60));
  92             $mform->setType('lti_parameters', PARAM_TEXT);
  93             $mform->addHelpButton('lti_parameters', 'parameter', 'lti');
  94             $mform->disabledIf('lti_parameters', null);
  95         }
  96
  97         $mform->addElement('textarea', 'lti_customparameters', get_string('custom', 'lti'), array('rows' => 4, 'cols' => 60));
  98         $mform->setType('lti_customparameters', PARAM_TEXT);
  99         $mform->addHelpButton('lti_customparameters', 'custom', 'lti');
 100
 101         if (!$istool && !empty($this->_customdata->isadmin)) {
 102             $mform->addElement('checkbox', 'lti_coursevisible', '&nbsp;', ' ' . get_string('show_in_course', 'lti'));
 103             $mform->addHelpButton('lti_coursevisible', 'show_in_course', 'lti');
 104         } else {
 105             $mform->addElement('hidden', 'lti_coursevisible', '1');
 106         }
 107         $mform->setType('lti_coursevisible', PARAM_BOOL);
 108
 109         $mform->addElement('hidden', 'typeid');
 110         $mform->setType('typeid', PARAM_INT);
 111
 112         $launchoptions = array();
 113         $launchoptions[LTI_LAUNCH_CONTAINER_EMBED] = get_string('embed', 'lti');
 114         $launchoptions[LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS] = get_string('embed_no_blocks', 'lti');
 115         $launchoptions[LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW] = get_string('existing_window', 'lti');
 116         $launchoptions[LTI_LAUNCH_CONTAINER_WINDOW] = get_string('new_window', 'lti');
 117
 118         $mform->addElement('select', 'lti_launchcontainer', get_string('default_launch_container', 'lti'), $launchoptions);
 119         $mform->setDefault('lti_launchcontainer', LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS);
 120         $mform->addHelpButton('lti_launchcontainer', 'default_launch_container', 'lti');
 121         $mform->setType('lti_launchcontainer', PARAM_INT);
 122
 123         $mform->addElement('hidden', 'oldicon');
 124         $mform->setType('oldicon', PARAM_URL);
 125
 126         $mform->addElement('text', 'lti_icon', get_string('icon_url', 'lti'), array('size' => '64'));
 127         $mform->setType('lti_icon', PARAM_URL);
 128         $mform->setAdvanced('lti_icon');
 129         $mform->addHelpButton('lti_icon', 'icon_url', 'lti');
 130
 131         $mform->addElement('text', 'lti_secureicon', get_string('secure_icon_url', 'lti'), array('size' => '64'));
 132         $mform->setType('lti_secureicon', PARAM_URL);
 133         $mform->setAdvanced('lti_secureicon');
 134         $mform->addHelpButton('lti_secureicon', 'secure_icon_url', 'lti');
 135
 136         if (!$istool) {
 137             // Add privacy preferences fieldset where users choose whether to send their data.
 138             $mform->addElement('header', 'privacy', get_string('privacy', 'lti'));
 139
 140             $options = array();
 141             $options[0] = get_string('never', 'lti');
 142             $options[1] = get_string('always', 'lti');
 143             $options[2] = get_string('delegate', 'lti');
 144
 145             $mform->addElement('select', 'lti_sendname', get_string('share_name_admin', 'lti'), $options);
 146             $mform->setType('lti_sendname', PARAM_INT);
 147             $mform->setDefault('lti_sendname', '2');
 148             $mform->addHelpButton('lti_sendname', 'share_name_admin', 'lti');
 149
 150             $mform->addElement('select', 'lti_sendemailaddr', get_string('share_email_admin', 'lti'), $options);
 151             $mform->setType('lti_sendemailaddr', PARAM_INT);
 152             $mform->setDefault('lti_sendemailaddr', '2');
 153             $mform->addHelpButton('lti_sendemailaddr', 'share_email_admin', 'lti');
 154
 155             // LTI Extensions.
 156
 157             // Add grading preferences fieldset where the tool is allowed to return grades.
 158             $mform->addElement('select', 'lti_acceptgrades', get_string('accept_grades_admin', 'lti'), $options);
 159             $mform->setType('lti_acceptgrades', PARAM_INT);
 160             $mform->setDefault('lti_acceptgrades', '2');
 161             $mform->addHelpButton('lti_acceptgrades', 'accept_grades_admin', 'lti');
 162
 163             $mform->addElement('checkbox', 'lti_forcessl', '&nbsp;', ' ' . get_string('force_ssl', 'lti'), $options);
 164             $mform->setType('lti_forcessl', PARAM_BOOL);
 165             if (!empty($CFG->mod_lti_forcessl)) {
 166                 $mform->setDefault('lti_forcessl', '1');
 167                 $mform->freeze('lti_forcessl');
 168             } else {
 169                 $mform->setDefault('lti_forcessl', '0');
 170             }
 171             $mform->addHelpButton('lti_forcessl', 'force_ssl', 'lti');
 172
 173             if (!empty($this->_customdata->isadmin)) {
 174                 // Add setup parameters fieldset.
 175                 $mform->addElement('header', 'setupoptions', get_string('miscellaneous', 'lti'));
 176
 177                 // Adding option to change id that is placed in context_id.
 178                 $idoptions = array();
 179                 $idoptions[0] = get_string('id', 'lti');
 180                 $idoptions[1] = get_string('courseid', 'lti');
 181
 182                 $mform->addElement('text', 'lti_organizationid', get_string('organizationid', 'lti'));
 183                 $mform->setType('lti_organizationid', PARAM_TEXT);
 184                 $mform->addHelpButton('lti_organizationid', 'organizationid', 'lti');
 185
 186                 $mform->addElement('text', 'lti_organizationurl', get_string('organizationurl', 'lti'));
 187                 $mform->setType('lti_organizationurl', PARAM_TEXT);
 188                 $mform->addHelpButton('lti_organizationurl', 'organizationurl', 'lti');
 189             }
 190         }
 191
 192         /* Suppress this for now - Chuck
 193          * mform->addElement('text', 'lti_organizationdescr', get_string('organizationdescr', 'lti'))
 194          * mform->setType('lti_organizationdescr', PARAM_TEXT)
 195          * mform->addHelpButton('lti_organizationdescr', 'organizationdescr', 'lti')
 196          */
 197
 198         /*
 199         // Add a hidden element to signal a tool fixing operation after a problematic backup - restore process
 200         //$mform->addElement('hidden', 'lti_fix');
 201         */
 202
 203         $tab = optional_param('tab', '', PARAM_ALPHAEXT);
 204         $mform->addElement('hidden', 'tab', $tab);
 205         $mform->setType('tab', PARAM_ALPHAEXT);
 206
 207         $courseid = optional_param('course', 1, PARAM_INT);
 208         $mform->addElement('hidden', 'course', $courseid);
 209         $mform->setType('course', PARAM_INT);
 210
 211         // Add standard buttons, common to all modules.
 212         $this->add_action_buttons();
 213
 214     }
 215 }