documentation/developer/modules.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   2 <html lang="en">
   3 <head>
   4         <title>ATutor Module Documentation</title>
   5         <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   6         <meta name="author" content="Joel Kronenberg/Greg Gay" />
   7         <meta name="description" content="ATutor module developer documentation" />
   8 <style type="text/css">
   9
  10 h1 {
  11         background-color: #CCCCCC;
  12         padding-left: 20px;
  13         padding-right: 20px;
  14         margin-bottom: 10px;
  15         text-align: right;
  16 }
  17
  18 h2 {
  19         background-color: #DDDDDD;
  20         padding-left: 10px;
  21         margin-bottom: 0px;
  22 }
  23 h3 {
  24         background-color: #EFEFEF;
  25         padding-left: 20px;
  26         margin-bottom: 0px;
  27 }
  28 h4  { margin-bottom: 0px; }
  29 p   { margin-top: 0px;    }
  30 dl  { margin-top: 0px;    }
  31 kbd {
  32         padding: 0px 1px 0px 1px;
  33         border-width: 1px 2px 2px 1px;
  34         border-style: solid;
  35         border-color: #edd #baa #baa #eed;
  36         white-space: pre;
  37 }
  38 kbd em {
  39         font-weight: bold;
  40         background-color: #efefef;
  41 }
  42 blockquote { font-style: italic; }
  43 pre.code {
  44         background-color: #EEEEFF;
  45         padding: 5px;
  46         margin-left: 20px;
  47         color:#761596;
  48     margin-top: 0px;
  49 }
  50 .top {
  51         float: right;
  52         color: green;
  53         padding-top: 2px;
  54         padding-right: 5px;
  55 }
  56 pre {
  57         background-color: #EEEEFF;
  58         font-family: Courier, monospace;
  59         border-left: 1px solid #761596;
  60         padding: 0px 0px 0px 10px;
  61         color: #333;
  62         margin: 0px 0px 10px 20px;
  63         font-size: 88%;
  64         line-height: 1.2em;
  65 }
  66 @media print {
  67         h2 {
  68                 page-break-after: avoid;
  69                 border-bottom: solid 1px black;
  70         }
  71         h3 {
  72                 page-break-after: avoid;
  73                 border-bottom: solid 1px black;
  74                 width: 75%;
  75         }
  76         .top {
  77                 display: none;
  78         }
  79
  80         pre.code {
  81                 page-break-inside: avoid;
  82         }
  83 }
  84 }
  85 acronym {
  86         cursor: help;
  87 }
  88 </style>
  89
  90 </style>
  91 </head>
  92 <body><h1>Module Development Documentation</h1>
  93 <ul>
  94 <li><a href="#intro">Introduction</a></li>
  95 <li><a href="#structure">Structure</a></li>
  96         <ul>
  97         <li><a href="#dirname">Directory Name</a></li>
  98         <li><a href="#files">Files</a>
  99         <ul>
 100         <li><a href="#module.xml">module.xml</a></li>
 101         <li><a href="#module.php">module.php</a></li>
 102         <li><a href="#module.sql">module.sql</a></li>
 103         </ul></li>
 104         </ul>
 105 <li><a href="#installation">Installation</a></li>
 106         <ul>
 107         <li><a href="#module_install">module_install.php</a></li>
 108         <li><a href="#privs">Specifying Privileges</a></li>
 109         <li><a href="#data_dir">Creating a Data Directory</a></li>
 110         <li><a href="#execute">Executing an SQL FILE</a></li>
 111         <li><a href="#errors">Generating Error Messages</a></li>
 112
 113         </ul>
 114
 115 <li><a href="#auth">Authentication &amp; Privileges</a></li>
 116 <li><a href="#localisation">Localisation</a></li>
 117 <li><a href="#config">Configuration Options</a></li>
 118 <li><a href="#styles">Custom Style Sheets</a></li>
 119 <li><a href="#sidemenu">Side Menu Boxes</a></li>
 120 <li><a href="#tools">Student Tools</a></li>
 121 <li><a href="#navigation">Navigation &amp; Hierarchy</a></li>
 122 <li><a href="#delete">Course Deletion</a></li>
 123 <li><a href="#backup">Backing-Up and Restoring</a></li>
 124 <ul>
 125 <li><a href="#directories">Directories</a></li>
 126 <li><a href="#database">Database Tables</a></li>
 127 </ul>
 128 <li><a href="#cron">Running Cron/Scheduling</a></li>
 129 </ul>
 130
 131 <a name="intro"></a>
 132 <h2>Introduction</h2>
 133         <p>ATutor 1.5.2 introduced the concept of modules, providing developers with a framework to implement additional functionality in a coherent and loosely coupled way.</p>
 134
 135         <p>The framework defines methods for assigning privileges, backing-up and restoring content, deleting course specific content, and adding side menu blocks,  student tools, course management and administrative tools, as well as public tools and other types of added functionality . </p>
 136
 137         <p>The intent is to allow for the development and distribution of modules independent of the ongoing development and release of ATutor. The module structure does allow for the creation of modules that run software that is not distributed under the <acronym title="GNU Not Unix">GNU</acronym> General Public License, but distributed separately under their own, perhaps commercial licenses.</p>
 138
 139         <p>The <em>Hello World</em> example module is included with each ATutor distribution for developers who want to investigate how modules work. The module is found in the <kbd>mods/hello_world</kbd> directory. A copy of the Hello World module works well as a starting point for creating a new module, since it implements (in a simple way) just about all the features found in modules. Also see the files from <a href="http://www.atutor.ca/atutor/modules.php">other modules</a> that operate like you expect your module to operate.</p>
 140
 141 <a name="structure"></a>
 142 <h2>Structure</h2>
 143         <p>Modules are stored under ATutor's <kbd>mods</kbd> directory. <em>Core</em> modules are stored in the <kbd>mods/_core</kbd> subdirectory and are made available with every release of ATutor. These modules cannot be disabled by the administrator as they are vital to ATutor's functionality. <em>Standard</em> modules are stored in the <kbd>mods/_standard</kbd> subdirectory and are also made available with every release of ATutor. Standard modules can be disabled by the administrator. <em>Extra</em> modules are stored in the <kbd>mods</kbd> directory and are installed and distributed independently of ATutor. Although the process of developing modules is the same for each type of module, only <em>extra</em> modules can be distributed separately, while <em>core</em> and <em>standard</em> modules are added to the ATutor code repository (i.e. <acronym title="Subversion">SVN</acronym> trunk).</p>
 144
 145         <p>Whenever a module identifier is needed within code, it should appear in lowercase with spaces converted to underscores.</p>
 146
 147         <p>The module name, and hence the directory and function names (see below for additional details), must be unique across all possible modules. A module should not be made available if an existing module is already being distributed under that same name. It is up to the module developer to ensure that their module name is unique.</p>
 148         <a name="dirname"></a>
 149         <h3>Directory Name</h3>
 150                 <p>The name given to the directory must be chosen carefully. The name is used to namespace the module's function by prefixing required functions with that directory name. For example, a module named <em>Example Maker</em> should be placed in a directory named <kbd>example_maker</kbd> and the delete function would be named <kbd><em>example_maker</em>_delete()</kbd>.</p>
 151         <a name="files"></a>
 152         <h3>Files</h3>
 153                 <p>The following files should exist under the module's top level directory: <kbd>mods/<em>module_name</em></kbd>.</p>
 154
 155                 <dl>
 156                         <dt><kbd>module.php</kbd></dt>
 157                         <dd>This is the main module file which gets included whenever a page is loaded. <em>Required</em>.</dd>
 158
 159                         <dt><kbd>module.xml</kbd></dt>
 160                         <dd>This file is used only for identifying the module for distribution and is only used when viewing a module's details. <em>Required</em>.</dd>
 161
 162                         <dt><kbd>module_install.php</kbd></dt>
 163                         <dd>This file is used when installing the module. <em>Required</em>.</dd>
 164
 165                         <dt><kbd>module_backup.php</kbd></dt>
 166                         <dd>This file is used when backing-up and restoring course content. <em>Optional</em>.</dd>
 167
 168                         <dt><kbd>module_delete.php</kbd></dt>
 169                         <dd>This file is used when deleting course specific content. <em>Optional</em>.</dd>
 170
 171
 172                         <dt><kbd>module_cron.php</kbd></dt>
 173                         <dd>This file is used to run module related commands at specified intervals. <em>Optional</em>.</dd>
 174
 175                         <dt><kbd>module.sql</kbd></dt>
 176                         <dd>This file is used to add tables and/or modify data in the ATutor database. Also used to insert language into the <kbd>language_text</kbd> table. <em>Optional</em>.</dd>
 177                 </dl>
 178 <a name="module.xml"></a>
 179         <h3>The <kbd>module.xml</kbd> File</h3>
 180                 <p>The <kbd>module.xml</kbd> file is used for displaying information about the module before it is installed and is useful when distributing the module.</p>
 181 <pre>
 182 &lt;?xml version="1.0" encoding="ISO-8859-1"?>
 183 &lt;module version="0.1">
 184     &lt;name lang="en">Example Maker&lt;/name>
 185     &lt;description lang="en">This is an example module that makes examples.&lt;/description>
 186     &lt;maintainers>
 187         &lt;maintainer>
 188             &lt;name>ATutor Team&lt;/name>
 189             &lt;email>info@atutor.ca&lt;/email>
 190         &lt;/maintainer>
 191         &lt;maintainer>
 192             &lt;name>John Doe&lt;/name>
 193             &lt;email>jd@example.com&lt;/email>
 194         &lt;/maintainer>
 195     &lt;/maintainers>
 196     &lt;url>http://www.example.com&lt;/url>
 197     &lt;license>BSD&lt;/license>
 198     &lt;release>
 199         &lt;version>0.2&lt;/version>
 200         &lt;date>2005-08-22&lt;/date>
 201         &lt;state>stable&lt;/state>
 202         &lt;notes>Fixes several bugs in previous version.&lt;/notes>
 203     &lt;/release>
 204 &lt;/module>
 205 </pre>
 206
 207 <a name="module.php"></a>
 208         <h3>The <kbd>module.php</kbd> File</h3>
 209 <p>The <kbd>module.php</kbd> file is typically used to set permissions, and to link module components into the ATutor navigation elements, as tool icons, navigation tabs, sub navigation menus, or side menu blocks, as administrator, course management, and student tools. It is also used to link tools to  My Start Page, or to various public pages that appear where a user is browsing the system without being logged in. The <kbd>module.php</kbd> file can also be used to run module specific functionality. It runs everytime a module screen is viewed, loading whatever settings it may contain, or running any scripts that may be required by the module.</p>
 210 <pre>
 211 &lt;?php
 212 /*******
 213  * doesn't allow this file to be loaded with a browser.
 214  */
 215 if (!defined('AT_INCLUDE_PATH')) { exit; }
 216
 217 /******
 218  * this file must only be included within a Module obj
 219  */
 220 if (!isset($this) || (isset($this) && (strtolower(get_class($this)) != 'module'))) { exit(__FILE__ . ' is not a Module'); }
 221
 222 /*******
 223  * assign the instructor and admin privileges to the constants.
 224  */
 225 define('AT_PRIV_EXAMPLE_MAKER',       $this->getPrivilege());
 226 define('AT_ADMIN_PRIV_EXAMPLE_MAKER', $this->getAdminPrivilege());
 227
 228 /*******
 229  * create a side menu box/stack.
 230  */
 231 $this->_stacks['example_maker'] = array('title_var'=>'example_maker', 'file'=>'mods/example_maker/side_menu.inc.php');
 232 // ** possible alternative: **
 233 // $this->addStack('example_maker', array('title_var' => 'example_maker', 'file' => './side_menu.inc.php');
 234
 235 /*******
 236  * if this module is to be made available to students on the Home or Main Navigation.
 237  */
 238 $_student_tool = 'mods/example_maker/index.php';
 239 // ** possible alternative: **
 240 // $this->addTool('./index.php');
 241
 242 /*******
 243  * add the admin pages when needed.
 244  */
 245 if (admin_authenticate(AT_ADMIN_PRIV_EXAMPLE_MAKER, TRUE) || admin_authenticate(AT_ADMIN_PRIV_ADMIN, TRUE)) {
 246         $this->_pages[AT_NAV_ADMIN] = array('mods/example_maker/index_admin.php');
 247         $this->_pages['mods/example_maker/index_admin.php']['title_var'] = 'example_maker';
 248         $this->_pages['mods/example_maker/index_admin.php']['parent']    = AT_NAV_ADMIN;
 249 }
 250
 251 /*******
 252  * instructor Manage section:
 253  */
 254 $this->_pages['mods/example_maker/index_instructor.php']['title_var'] = 'example_maker';
 255 $this->_pages['mods/example_maker/index_instructor.php']['parent']   = 'tools/index.php';
 256 // ** possible alternative: **
 257 // $this->pages['./index_instructor.php']['title_var'] = 'example_maker';
 258 // $this->pages['./index_instructor.php']['parent']    = 'tools/index.php';
 259
 260 /*******
 261  * student page.
 262  */
 263 $this->_pages['mods/example_maker/index.php']['title_var'] = 'example_maker';
 264 $this->_pages['mods/example_maker/index.php']['img']       = 'mods/example_maker/example_maker.jpg';
 265
 266
 267 /* public pages */
 268 $this->_pages[AT_NAV_PUBLIC] = array('mods/example_maker/index_public.php');
 269 $this->_pages['mods/example_maker/index_public.php']['title_var'] = 'example_maker';
 270 $this->_pages['mods/example_maker/index_public.php']['parent'] = 'login.php';
 271 $this->_pages['login.php']['children'] = array('mods/example_maker/index_public.php');
 272
 273 /* my start page pages */
 274 $this->_pages[AT_NAV_START]  = array('mods/example_maker/index_mystart.php');
 275 $this->_pages['mods/example_maker/index_mystart.php']['title_var'] = 'example_maker';
 276 $this->_pages['mods/example_maker/index_mystart.php']['parent'] = 'users/index.php';
 277 $this->_pages['users/index.php']['children'] = array('mods/example_maker/index_mystart.php');
 278 ?>
 279 </pre>
 280 <a name="module.sql"></a>
 281         <h3>The <kbd>module.sql</kbd> File</h3>
 282 <p>A very simple <kbd>module.sql</kbd> file such as the following, creates a table for the module, and inserts it's language into the ATutor <kbd>language_text</kbd> table. Module language can then be managed from the ATutor Language Manager. The <kbd>module.sql</kbd> file can contain any number of SQL statements used to add tables or insert data into the ATutor database. </p>
 283
 284 <pre>
 285 # sql file for example maker module
 286
 287 CREATE TABLE example_maker (
 288    `course_id` mediumint(8) unsigned NOT NULL,
 289    `value` VARCHAR( 30 ) NOT NULL ,
 290    PRIMARY KEY ( `course_id` )
 291 );
 292
 293 INSERT INTO `language_text` VALUES ('en', '_module','example_maker','Example Maker',NOW(),'');
 294 INSERT INTO `language_text` VALUES ('en', '_module','AT_ERROR_GOES_HERE','Example Maker Error Message',NOW(),'');
 295
 296 </pre>
 297 <a name="installation"></a>
 298 <h2>Installation</h2>
 299         <p>The <kbd>module_install.php</kbd> script gets executed during the installation process, using the administrator's Install Module feature. If the script's execution results in <kbd>$msg->containsErrors()</kbd> evaluating to <kbd>TRUE</kbd>, then the errors are displayed and the user is prompted to correct them. The process is then repeated until errors are no longer being generated and the module is installed successfully. Ultimately, it is up to the module to determine the logical steps involved in its installation. For example, it might be better to create the data directories before trying to create any database tables since creating the directory may require several attempts. Typically the flow we describe here should be suitable in most cases.</p>
 300
 301         <p>Theoretically, the install script's execution is wide-open and does not have to adhere to the process outlined below or make use of any special privileges, provided it generates errors as appropriate.</p>
 302
 303 <pre># pseudo-code for installing a module:
 304 while (there are errors)
 305     print the error message
 306
 307     # inside module_install.php:
 308     define the privileges used
 309
 310     if (create database tables is unsuccessful) then
 311         generate an error message
 312
 313     if (there are no errors AND there is an SQL file) then
 314         execute the SQL file
 315 end while
 316
 317 add the module to the system using the defined privileges
 318 </pre>
 319
 320 <a name="module_install"></a>
 321         <h3>The <kbd>module_install.php</kbd> File</h3>
 322 <p>The <kbd>module_install.php</kbd> file is typically used to run any installation related files, such as an sql file that sets up a database table, or installs the language for the module. The following is an example module_install.php file</p>
 323 <pre>
 324 &lt;?php
 325 /*******
 326  * the line below safe-guards this file from being accessed directly from
 327  * a web browser. It will only execute if required from within an ATutor script,
 328  * in our case the Module::install() method.
 329  */
 330 if (!defined('AT_INCLUDE_PATH')) { exit; }
 331
 332 /*******
 333  * Note: the many options for these variables are used to decrease confusion.
 334  *       TRUE | FALSE | 1 will be the convention.
 335  *
 336  * $_course_privilege
 337  *     specifies the type of instructor privilege this module uses.
 338  *     set to empty | FALSE | 0   to disable any privileges.
 339  *     set to 1 | AT_PRIV_ADMIN   to use the instructor only privilege.
 340  *     set to TRUE | 'new'        to create a privilege specifically for this module:
 341  *                                will make this module available as a student privilege.
 342  *
 343  * $_admin_privilege
 344  *    specifies the type of ATutor administrator privilege this module uses.
 345  *    set to FALSE | AT_ADMIN_PRIV_ADMIN   to use the super administrator only privilege.
 346  *    set to TRUE | 'new'                  to create a privilege specifically for this module:
 347  *                                         will make this module available as an administrator privilege.
 348  *
 349  *
 350  * $_cron_interval
 351  *    if non-zero specifies in minutes how often the module's cron job should be run.
 352  *    set to 0 or not set to disable.
 353  */
 354 $_course_privilege = TRUE; // possible values: FALSE | AT_PRIV_ADMIN | TRUE
 355 $_admin_privilege  = TRUE; // possible values: FALSE | TRUE
 356 $_cron_interval    = 35; // run every 30 minutes
 357
 358
 359 /********
 360  * the following code is used for creating a module-specific directory.
 361  * it generates appropriate error messages to aid in its creation.
 362  */
 363 $directory = AT_CONTENT_DIR .'example_maker';
 364
 365 // check if the directory is writeable
 366 if (!is_dir($directory) && !@mkdir($directory)) {
 367         $msg->addError(array('MODULE_INSTALL', '&lt;li>'.$directory.' does not exist. Please create it.&lt;/li>'));
 368 } else if (!is_writable($directory) && @chmod($directory, 0666)) {
 369         $msg->addError(array('MODULE_INSTALL', '&lt;li>'.$directory.' is not writeable. On Unix issue the command &lt;kbd>chmod a+rw&lt;/kbd>.&lt;/li>'));
 370 }
 371
 372
 373 /******
 374  * the following code checks if there are any errors (generated previously)
 375  * then uses the SqlUtility to run any database queries it needs, ie. to create
 376  * its own tables.
 377  */
 378 if (!$msg->containsErrors() && file_exists(dirname(__FILE__) . '/module.sql')) {
 379         // deal with the SQL file:
 380         require(AT_INCLUDE_PATH . 'classes/sqlutility.class.php');
 381         $sqlUtility =& new SqlUtility();
 382
 383         /*
 384          * the SQL file could be stored anywhere, and named anything, "module.sql" is simply
 385          * a convention we're using.
 386          */
 387         $sqlUtility->queryFromFile(dirname(__FILE__) . '/module.sql', TABLE_PREFIX);
 388 }
 389
 390 ?>
 391 </pre>
 392
 393
 394 <a name="privs"></a>
 395         <h3>Specifying Privileges</h3>
 396                 <p>Privileges control who has access to the course management and administrative sections.</p>
 397
 398                 <p>See the Authentication &amp; Privileges section for additional details using the privileges.</p>
 399
 400                 <dl>
 401                         <dt><kbd>$_course_privilege</kbd></dt>
 402                         <dd><p>This variable controls access to a course's management section and can take one of the following values:</p>
 403                                 <ul>
 404                                         <li><kbd>TRUE</kbd>: To use a custom assignable privilege level. If a custom privilege is created, the module will appear as an option when assigning privileges to enrolled students.</li>
 405                                         <li><kbd>AT_PRIV_ADMIN</kbd>: To use the instructor privilege. Only the instructor will be given access to the module's management section.</li>
 406                                         <li><kbd>FALSE</kbd>: To disable the privilege if there is no management section for the module.</li>
 407                                 </ul>
 408                         </dd>
 409
 410                         <dt><kbd>$_admin_privilege</kbd></dt>
 411                         <dd><p>This variable can take one of the following values:</p>
 412                                 <ul>
 413                                         <li><kbd>TRUE</kbd>: To use a custom assignable privilege level. If a custom privilege is created then the module will appear as an option when assigning privileges to administrators</li>
 414                                         <li><kbd>AT_ADMIN_PRIV_ADMIN</kbd>: To use the super administrator privilege. Only the super administrator will be given access to the module's administration section.</li>
 415                                 </ul>
 416                         </dd>
 417                 </dl>
 418
 419                 <p>Note that creating a privilege is not in itself enough to make the module appear in the Manage section! The hierarchy and navigation path to the management page must be set correctly. See the Navigation &amp; Hierarchy section for additional details.</p>
 420 <a name="data_dir"></a>
 421         <h3>Creating a Data Directory</h3>
 422                 <p>It is best to keep the directory within the <kbd>AT_CONTENT_DIR</kbd> directory as it should already allow the creation of files and directories by the web server. It is then up to the module to create individual course directories as needed.</p>
 423 <pre>
 424 $directory = AT_CONTENT_DIR .'example_maker';
 425
 426 // check if the directory is writable
 427 if (!is_dir($directory) && !@mkdir($directory)) {
 428     $msg->addError(array('MODULE_INSTALL', '&lt;li>'
 429                          .$directory
 430                          .' does not exist. Please create it.&lt;/li>'));
 431 } else if (!is_writable($directory) && @chmod($directory, 0666)) {
 432     $msg->addError(array('MODULE_INSTALL', '&lt;li>'
 433                          . $directory
 434                          .' is not writable.&lt;/li>'));
 435 } // else: it was created successfully.
 436 </pre>
 437 <a name="execute"></a>
 438         <h3>Executing an <acronym title="Structured Query Language">SQL</acronym> File</h3>
 439                 <p>If the module requires its own database tables or custom language, then it will have to create them itself. The <acronym title="Structured Query Language">SQL</acronym> can either be executed inline using <acronym title="PHP Hypertext Processor">PHP</acronym> database execution directly, or using the <kbd>SQLUtility</kbd> class to execute an external <acronym title="Structured Query Language">SQL</acronym> file. Also see <a href="#module.sql">module.sql</a> for more about creating an SQL file.</p>
 440 <pre>
 441 if (!$msg->containsErrors() && file_exists(dirname(__FILE__) . '/module.sql')) {
 442     // deal with the SQL file:
 443     require(AT_INCLUDE_PATH . 'classes/sqlutility.class.php');
 444     $sqlUtility =& new SqlUtility();
 445     $sqlUtility->queryFromFile(dirname(__FILE__) . '/module.sql', TABLE_PREFIX);
 446 }
 447 </pre>
 448 <a name="errors"></a>
 449         <h3>Generating Errors Messages</h3>
 450                 <p>It is up to the module to generate and check for any errors that occur during the installation. An error message can be generated using <kbd>$msg->addError(array('MODULE_INSTALL', '&lt;li>your error msg goes here&lt;/li>'));</kbd>. Note that the text supplied to the error message is not translated in this case. If the language should be localised, then the appropriate language vairable should replace the text. Something like <kbd>$msg->addError(array('MODULE_INSTALL', 'AT_ERROR_GOES_HERE'));</kbd> . The corresponding SQL INSERT statement should then be found in the <a href="#module.sql">module.sql </a>file, so the language gets added to the <kbd>language_text</kbd> table in ATutor. </p>
 451
 452                 <p>To check if any errors have been generated, use <kbd>$msg->containsErrors()</kbd> which evaluates to <kbd>TRUE</kbd> if a previous error has been generated.</p>
 453
 454                 <p>See the <a href="guidelines.html#error-feedback-messages">Error and Feedback </a>section of the Developer Documentation for more details about displaying messages.</p>
 455 <a name="auth"></a>
 456 <h2>Authentication &amp; Privileges</h2>
 457         <p>See the <em>Installation: Specifying Privileges</em> section on creating privileges during the installation process.</p>
 458
 459         <p>Authentication uses constants for the privilege levels. The privileges should be declared in the <kbd>module.php</kbd> file using the <kbd>$this->getPrivilege()</kbd> and <kbd>$this->getAdminPrivilege()</kbd> methods, respectively.</p>
 460
 461 <pre>
 462 define('AT_PRIV_FORUMS',       $this->getPrivilege()      );
 463 define('AT_ADMIN_PRIV_FORUMS', $this->getAdminPrivilege() );
 464 </pre>
 465
 466         <p>Once declared, a page can then authenticate against those privileges using either the <kbd>authentication()</kbd> or the <kbd>admin_authenticate()</kbd> functions.</p>
 467
 468 <pre>
 469 define('AT_INCLUDE_PATH', '../include/');
 470 require(AT_INCLUDE_PATH.'vitals.inc.php');
 471 // authenticate the administrator forums section:
 472 admin_authenticate(AT_ADMIN_PRIV_FORUMS);
 473 </pre>
 474 <a name="localisation"></a>
 475 <h2>Localisation</h2>
 476         <p>Although a module can be created with all hard-coded language, we recommended you use ATutor's localisation functions. All of ATutor's language is stored in the database, which is then retrieved using the <kbd>_AT()</kbd> function for simple terms and the <kbd>$msg</kbd> object for feedback and error messages.</p>
 477
 478         <p>Additional details on localising ATutor can be found on the <a href="http://atutor.ca/atutor/docs/translate.php">Thing You Should Know Before Translating</a> and in the <a href="guidelines.html#fn-at">ATutor Developer Documentation</a>.</p>
 479
 480         <p>Module-specific language should be inserted into the <kbd>language_text</kbd> table during the installation process. The fields in the table are as follows:</p>
 481
 482         <dl>
 483                 <dt><kbd>language_code</kbd></dt>
 484                 <dd>The ISO-639-1 language code plus locale.</dd>
 485
 486                 <dt><kbd>variable</kbd></dt>
 487                 <dd>Set to <kbd>_module</kbd> for modules.</dd>
 488
 489                 <dt><kbd>term</kbd></dt>
 490                 <dd>The variable used for retrieving the language.</dd>
 491
 492                 <dt><kbd>text</kbd></dt>
 493                 <dd>The language text.</dd>
 494
 495                 <dt><kbd>revised_date</kbd></dt>
 496                 <dd>Set to <kbd>NOW()</kbd> for modules.</dd>
 497
 498                 <dt><kbd>context</kbd></dt>
 499                 <dd>Short description of the language text.</dd>
 500         </dl>
 501
 502 <p>Each language item should have a corresponding SQL INSERT line in the module.sql file, that gets inserted into the ATutor <kbd>language_text</kbd> table during installation. Do not include a prefix (e.g. "AT_") on the <kbd>language_text</kbd> table name. The installer will detect the right prefix, and automatically prepend it to tables names. Also see the section <a href="#module.sql">module.sql</a> for information about creating a file to install the module's language.</p>
 503 <pre>
 504 # Insert module specific language:
 505 INSERT INTO `language_text` VALUES ('en',
 506                                     '_module',
 507                                     'example_maker',
 508                                     'Example Maker',
 509                                      NOW(),
 510                                     'the module title');
 511 </pre>
 512 <a name="config"></a>
 513 <h2>Configuration Options</h2>
 514 <p>Module configuration options can be stored in the ATutor <kbd>config</kbd> table, and retrieved using a <kbd>$_config[]</kbd> array variable. All module configuration key/value pairs are automatically loaded from the table into global memory while ATutor is running, and can be accessed from any of the module scripts (or from anywhere is ATutor for that matter). The value for a particular configuration option is retrieved by entering its key into the array. To retrieve a URL for the Example Maker module for example,  you might use <kbd>$_config['example_maker']</kbd>. </p>
 515 <p>In the following example of an <kbd>index_admin.php</kbd> file, the form below accepts a URL to an external application used by the Example Maker module (though it could be any value). In this case imagine a third party application has been installed, and the URL to the application is being stored as a configuration option for the example_maker module. When the form is submitted, <kbd>$_POST['uri']</kbd> is inserted into the config table as the value for the <kbd>example_maker</kbd> key. The following is an example module administrator script used to add/edit a config option for the example_maker module.</p>
 516
 517 <h3>The <kbd>index_admin.php</kbd> File</h3>
 518 <pre>
 519
 520 &lt;?php
 521 // make sure user is allowed to see this page (admins only)
 522
 523 admin_authenticate(AT_ADMIN_PRIV_EXAMPLE_MAKER);
 524
 525 if (isset($_POST['submit'])) {
 526         // trim whitespace from the value submitted
 527         $_POST['uri'] = trim($_POST['uri']);
 528
 529         // display an error message if the value is empty
 530         if (!$_POST['uri']){
 531                 $msg->addError('EXAMPLE_MAKER_ADD_EMPTY');
 532         }
 533
 534         // if no errors, insert the key "example_maker" and value "$_POST['uri']" into the config table
 535         if (!$msg->containsErrors()) {
 536                 $_POST['uri'] = $addslashes($_POST['uri']);
 537                 $sql = "REPLACE INTO ".TABLE_PREFIX."config VALUES ('example_maker', '$_POST[uri]')";
 538                 mysql_query($sql, $db);
 539                 $msg->addFeedback('EXAMPLE_MAKER_URL_SAVED');
 540
 541                 header('Location: '.$_SERVER['PHP_SELF']);
 542                 exit;
 543         }
 544 }
 545
 546 require (AT_INCLUDE_PATH.'header.inc.php');
 547
 548 /*******
 549  *  First check to see if there is a value for the example_maker key $_config['example_maker']
 550  *  If there isn't a value then a missing value message is displayed
 551  *  The form below that has a single field for submitting a value, in this case a URL
 552  *  If the value exists in the config table, then display it in the text field using  $_config['example_maker']
 553  */
 554
 555 ?>
 556
 557 &lt;?php if ($_config['example_maker']): ?>
 558         &lt;div class="input-form">
 559                 &lt;div class="row">
 560                         &lt;p>&lt;?php echo _AT('example_maker_text'); ?>&lt;/p>
 561                 &lt;/div>
 562         &lt;/div>
 563 &lt;?php else: ?>
 564         &lt;div class="input-form">
 565                 &lt;div class="row">
 566                         &lt;p>&lt;?php echo _AT('example_maker_missing_url');  ?>&lt;/p>
 567                 &lt;/div>
 568         &lt;/div>
 569 &lt;?php endif; ?>
 570
 571 &lt;form action="&lt;?php  $_SERVER['PHP_SELF']; ?>" method="post">
 572         &lt;div class="input-form">
 573                 &lt;div class="row">
 574                         &lt;p>&lt;label for="uri">&lt;?php echo _AT('example_maker_url'); ?>&lt;/label>&lt;/p>
 575
 576                         &lt;input type="text" name="uri" value="&lt;?php echo $_config['example_maker']; ?>" id="uri" size="60" style="min-width: 65%;" />
 577                 &lt;/div>
 578                 &lt;div class="row buttons">
 579                         &lt;input type="submit" name="submit" value="&lt;?php echo _AT('save'); ?>"  />
 580                 &lt;/div>
 581         &lt;/div>
 582 &lt;/form>
 583 </pre>
 584
 585 <a name="styles"></a>
 586 <h2>Custom Style Sheets</h2>
 587         <p>A custom style sheet can be linked into pages by setting <kbd>$_custom_css</kbd> to be the absolute path to the style sheet. This variable must be set on every page that requires that style sheet.</p>
 588
 589 <pre>
 590 define('AT_INCLUDE_PATH', '../../include/');
 591 require(AT_INCLUDE_PATH.'vitals.inc.php');
 592 // using a custom style sheet:
 593 $_custom_css = $_base_path . 'mods/example_maker/module.css';
 594 </pre>
 595
 596 <a name="sidemenu"></a>
 597 <h2>Side Menu Boxes</h2>
 598         <p>Side menu boxes generally appear in a column at the side of a course (though this layout can be altered by a theme). A module may implement one or more side menu boxes.</p>
 599
 600         <p>Side menus are specified using the <kbd>$_module_stacks</kbd> array in <kbd>module.php</kbd>. <kbd>$_module_stacks</kbd> have the attributes <kbd>title_var</kbd> (or <kbd>title</kbd>) and <kbd>file</kbd>. The <kbd>title_var</kbd> value is the language key used for that box; the title will be generated by executing <kbd>_AT($title_var)</kbd>. If <kbd>title</kbd> is set instead, a hard-coded title will be used. The <kbd>file</kbd> attribute specifies the absolute path to the side menu's include file.</p>
 601
 602         <p>The key to the <kbd>$_module_stacks</kbd> should be the name of the module.</p>
 603
 604 <pre>
 605 $_module_stacks['example_maker'] = array('title_var' => 'example_maker',
 606                                          'file' => dirname(__FILE__).'\side_menu.inc.php');
 607 </pre>
 608
 609         <p>Creating a side menu box involves using the <kbd>$savant</kbd> template object and assigning the output of the box to the <kbd>dropdown_contents</kbd> variable.</p>
 610
 611 <pre>
 612 &lt;?php global $savant;
 613
 614 $box_content = 'This is my side menu box';
 615
 616 $savant->assign('dropdown_contents', $box_content);
 617
 618 $savant->assign('title', _AT('example_maker'));
 619 $savant->display('include/box.tmpl.php');
 620 ?>
 621 </pre>
 622
 623 <a name="tools"></a>
 624 <h2>Student Tools</h2>
 625         <p>Student tools are pages linked from the home page or the main navigation of courses. A module can only implement one student tool. An instructor controls which student tools are available to a course using the <em>Student Tools</em> section found under <em>Manage</em>.</p>
 626
 627         <p>The tool main page must be specified using the <kbd>$_student_tool</kbd> variable in the <kbd>module.php</kbd> file. The value of that variable must be the relative path to the file from the ATutor base directory (not the module directory). Example: <kbd>$_student_tool = 'mods/example_maker/index.php';</kbd>.</p>
 628
 629         <p>For the tool to correctly appear its Navigation &amp; Hierarchy must be defined correctly. If the tool is to have an instructor management section then the <em>parent</em> must be specified as being <kbd>tools/index.php</kbd> and the module must have a non-zero privilege level.</p>
 630 <a name="navigation"></a>
 631 <h2>Navigation &amp; Hierarchy</h2>
 632         <p><em>Every</em> page in ATutor must have an entry in the global <kbd>$_pages</kbd> array where the key to the array is the relative path to the file from ATutor's base directory. Module pages are specified using the <kbd>$_module_pages</kbd> array, which are then merged into the <kbd>$_pages</kbd> array when the <kbd>module.php</kbd> file is loaded. The array supports the following attributes:</p>
 633
 634         <dl>
 635                 <dt><kbd>title_var</kbd></dt>
 636                 <dd>The language variable to be used with <kbd>_AT()</kbd>.</dd>
 637
 638                 <dt><kbd>title</kbd></dt>
 639                 <dd>The hard-coded version of the language title. If set, overrides the usage of <kbd>_AT(title_var)</kbd>. This version is not language independent.</dd>
 640
 641                 <dt><kbd>parent</kbd></dt>
 642                 <dd>The relative ATutor path to the parent page. Omit for Student Tools.</dd>
 643
 644                 <dt><kbd>img</kbd></dt>
 645                 <dd>The relative ATutor path to the icon to use. Only for Student Tools.</dd>
 646
 647                 <dt><kbd>children</kbd></dt>
 648                 <dd>An array whose values are relative ATutor paths to sub pages.</dd>
 649
 650                 <dt><kbd>guide</kbd></dt>
 651                 <dd>The the section of the handbook that the module page should link to. Not used for modules at this time.</dd>
 652         </dl>
 653
 654         <p>For pages to appear in the instructor Manage section, their <kbd>parent</kbd> field must be set to <kbd>tools/index.php</kbd>.</p>
 655
 656 <pre>
 657 $path = 'mods/example_maker/';
 658
 659 // the student tool:
 660 $_module_pages[$path.'index.php']['title_var'] = 'example_maker';
 661 $_module_pages[$path.'index.php']['img']       = $path.'icon.gif';
 662 $_module_pages[$path.'index.php']['children']  = array($path.'sub.php', $path.'more.php');
 663
 664     $_module_pages[$path.'sub.php']['title_var'] = 'sub_page';
 665     $_module_pages[$path.'sub.php']['parent']    = $path.'index.php';
 666
 667     $_module_pages[$path.'more.php']['title_var'] = 'more_page';
 668     $_module_pages[$path.'more.php']['parent']    = $path.'index.php';
 669
 670 // the instructor page:
 671 $_module_pages[$path . 'inst_index.php']['title_var'] = 'example_maker';
 672 $_module_pages[$path . 'inst_index.php']['parent']    = 'tools/index.php';
 673 </pre>
 674 <a name="delete"></a>
 675 <h2>Course Deletion</h2>
 676         <p>When a course is being deleted, or when a back-up is being restored by overriding (i.e. deleting) existing content, a module has to ensure that the content for that course is also deleted. If the module maintains course data directories, then those directories have to either be emptied or deleted. If the module uses database tables for course content, then it has to delete the appropriate entries for that course.</p>
 677
 678         <p>The function used to delete the course content for that module must be stored in the <kbd>module_delete.php</kbd> file and named <kbd><em>module_name</em>_delete()</kbd>. The delete function takes a single argument which is the ID of the course to delete.</p>
 679
 680 <pre>
 681 &lt;?php
 682 function example_maker_delete($course) {
 683     global $db;
 684
 685     // delete directory
 686     $path = AT_CONTENT_DIR . 'example_maker/' . $course . '/';
 687     clr_dir($path);
 688
 689     // delete from database
 690     $sql = "DELETE
 691             FROM ".TABLE_PREFIX."example_content
 692             WHERE course_id=$course";
 693     mysql_query($sql, $db);
 694 }
 695 ?>
 696 </pre>
 697 <a name="backup"></a>
 698 <h2>Backing-Up and Restoring</h2>
 699         <p>It is possible for a module to include its content when a course backup is being created or restored. Backups support database tables with foreign-key constraints as well as course specific directories.</p>
 700 <a name="directories"></a>
 701         <h3>Directories</h3>
 702                 <p>A module can backup as many directories as it requires, all specified using the <kbd>$dirs</kbd> array variable.</p>
 703
 704                 <p>The example below uses the special <kbd>?</kbd> token as the place holder for the course ID. When the course is backed-up, the question mark will be replaced with the correct course ID. The key to the array is the unique name of the directory to be used inside the backup archive file. The same information to create the backup is also used to restore it, so no additional details are required.</p>
 705 <pre>
 706 $dirs = array();
 707 $dirs['example_maker/'] = AT_CONTENT_DIR . 'example_maker/?/';
 708 </pre>
 709
 710 <a name="database"></a>
 711         <h3>Database Tables</h3>
 712                 <p>There are two parts to backing-up and restoring a module's database tables. First, the <acronym title="Structured Query Language">SQL</acronym> queries must be specified using the <kbd>$sql</kbd> array variable and then the restore functions must convert the rows so that they can be inserted into the database tables.</p>
 713
 714                 <p>The example below uses the special <kbd>?</kbd> token as the place holder for the course ID. When the course is backed-up the question-mark will be replaced with the correct course ID. The key to the array is the unique name of the <acronym title="Comma Separated Values">CSV</acronym> file to save in the backup archive, without the extension. The <acronym title="Structured Query Language">SQL</acronym> query itself must only select the fields that will be backed up. If there are foreign key constraints to preserve then the key will have to be retrieved as well so that it can be used when restoring the tables.</p>
 715
 716 <pre>
 717 $sql = array();
 718 $sql['example']  = 'SELECT title FROM '.TABLE_PREFIX.'example WHERE course_id=?';
 719 </pre>
 720
 721                 <p>For each key in the <kbd>$sql</kbd> array there must be a function with the same name, but suffixed with <kbd>_convert</kbd>. The <kbd><em>tbl_name</em>_convert()</kbd> function must return the newly transformed row with respect to the version of ATutor that was used to generate the <acronym title="Comma Separated Values">CSV</acronym> file. The function accepts the following arguments:</p>
 722
 723                 <dl>
 724                         <dt><kbd>$row</kbd></dt>
 725                         <dd>An array which represents a single row in the <acronym title="Comma Separated Values">CSV</acronym> file.</dd>
 726
 727                         <dt><kbd>$course_id</kbd></dt>
 728                         <dd>The course ID which this content should be associated with.</dd>
 729
 730                         <dt><kbd>$table_id_map</kbd></dt>
 731                         <dd>An associative array representing previously restored tables and their new keys. Used to preserve foreign key constraints.</dd>
 732
 733                         <dt><kbd>$version</kbd></dt>
 734                         <dd>The version of ATutor that was used to generate this file.</dd>
 735                 </dl>
 736
 737 <pre>
 738 function example_convert($row, $course_id, $table_id_map, $version) {
 739     $new_row = array();
 740     $new_row[0]  = 0; // auto-increment field
 741     $new_row[1]  = $course_id;
 742     $new_row[2]  = $row[1]; // the title
 743     if (version_compare($version, '1.5.2', '&lt;')) {
 744         // this field did not exist prior to 1.5.2
 745         $new_row[3] = '';
 746     } else {
 747         $new_row[3] = $row[2];
 748     }
 749
 750     return $new_row;
 751 }
 752 </pre>
 753 <a name="cron"></a>
 754         <h2>Running Cron/Scheduling</h2>
 755 <p>The <kbd>module_cron.php</kbd> file can be used to run module related functions at specified intervals. The following example doesn't do much of anything..., but you get the idea.  If cron has been enabled in ATutor, all the module_cron.php files from each module are run at the interval specified when the Cron is setup. See the Cron Setup sections in the Administrator Handbook, and in ATutor in the Administrator's System Preferences.</p>
 756
 757 <pre>
 758 &lt;?php
 759 /*******
 760  * this function named [module_name]_cron is run by the global cron script at the module's specified
 761  * interval.
 762  */
 763
 764 function hello_world_cron() {
 765         global $db;
 766         debug('yay i am running!');
 767 }
 768
 769 ?>
 770 </pre>
 771 </body>
 772 </html>