mods/merlot/module_install.php

   1 <?php\r
   2 /****************************************************************/\r
   3 /* ATutor                                                                                                               */\r
   4 /****************************************************************/\r
   5 /* Copyright (c) 2002-2006 by Greg Gay & Joel Kronenberg        */\r
   6 /* Adaptive Technology Resource Centre / University of Toronto  */\r
   7 /* http://atutor.ca                                                                                             */\r
   8 /*                                                              */\r
   9 /* This program is free software. You can redistribute it and/or*/\r
  10 /* modify it under the terms of the GNU General Public License  */\r
  11 /* as published by the Free Software Foundation.                                */\r
  12 /****************************************************************/\r
  13 // $Id: merlot.php 6614 2006-09-27 19:32:29Z greg $\r
  14 \r
  15 \r
  16 /*******\r
  17  * the line below safe-guards this file from being accessed directly from\r
  18  * a web browser. It will only execute if required from within an ATutor script,\r
  19  * in our case the Module::install() method.\r
  20  */\r
  21 if (!defined('AT_INCLUDE_PATH')) { exit; }\r
  22 \r
  23 /*******\r
  24  * Note: the many options for these variables are used to decrease confusion.\r
  25  *       TRUE | FALSE | 1 will be the convention.\r
  26  *\r
  27  * $_course_privilege\r
  28  *     specifies the type of instructor privilege this module uses.\r
  29  *     set to empty | FALSE | 0   to disable any privileges.\r
  30  *     set to 1 | AT_PRIV_ADMIN   to use the instructor only privilege.\r
  31  *     set to TRUE | 'new'        to create a privilege specifically for this module:\r
  32  *                                will make this module available as a student privilege.\r
  33  *\r
  34  * $_admin_privilege\r
  35  *    specifies the type of ATutor administrator privilege this module uses.\r
  36  *    set to FALSE | AT_ADMIN_PRIV_ADMIN   to use the super administrator only privilege.\r
  37  *    set to TRUE | 'new'                  to create a privilege specifically for this module:\r
  38  *                                         will make this module available as an administrator privilege.\r
  39  *\r
  40  *\r
  41  * $_cron_interval\r
  42  *    if non-zero specifies in minutes how often the module's cron job should be run.\r
  43  *    set to 0 or not set to disable.\r
  44  */\r
  45 $_course_privilege = TRUE; // possible values: FALSE | AT_PRIV_ADMIN | TRUE\r
  46 $_admin_privilege  = TRUE; // possible values: FALSE | TRUE\r
  47 \r
  48 \r
  49 /******\r
  50  * the following code checks if there are any errors (generated previously)\r
  51  * then uses the SqlUtility to run any database queries it needs, ie. to create\r
  52  * its own tables.\r
  53  */\r
  54 if (!$msg->containsErrors() && file_exists(dirname(__FILE__) . '/module.sql')) {\r
  55         // deal with the SQL file:\r
  56         require(AT_INCLUDE_PATH . 'classes/sqlutility.class.php');\r
  57         $sqlUtility =& new SqlUtility();\r
  58 \r
  59         /*\r
  60          * the SQL file could be stored anywhere, and named anything, "module.sql" is simply\r
  61          * a convention we're using.\r
  62          */\r
  63         $sqlUtility->queryFromFile(dirname(__FILE__) . '/module.sql', TABLE_PREFIX);\r
  64 }\r
  65 \r
  66 ?>