/program/modules/newsletter/newsletter_install.php - installer of the newsletter module
This file contains the newsletter module installer. The interface consists of these functions:
These functions can be called from the main installer and/or admin.php.
Note You cannot be sure about the environment from which these routines are called. If the caller is the Install Wizard, you do not have all subroutines available. However, it IS possible to manipulate the database via the db_*() routines and/or the global $DB object. Therefore you have to keep the install routine extremly simple. You also have no option to interact with the user; the install has to be a silent install; you can only indicate success (TRUE) or failure (FALSE) and maybe an error message in $messages[] but that's it. Good luck.
add demonstration data to the system
this routine adds demodata for this module to the database.
Note that a routine by this name should exist (even if it does nothing).
Note If the module is installed via the Install Wizard, this routine is called. However, if a module is installed as an additional module after installation, the {$module}_demodata() routine is never called. This is because the only time you know that demodata is installed is when the Install Wizard runs. If we're called from admin.php, the webmaster may have already deleted existing (core) demodata so you never can be sure what to expect. To put it another way: it is hard to re-construct $config when we're NOT the Instal Wizard.
The array $config contains the following information.
With this information, we can add a demonstration configuration for the public area, which shows off the possibilities. Note that we add our own additions to the array $config so other modules and themes can determine the correct status quo w.r.t. the demodata nodes etc.
install the module
this routine installs the module. For this module there is nothing to install, so we simply return success.
Note that the record for this module is already created in the modules table; the pkey is $module_id.
uninstall the module
this is a hook for future extensions of Website@School. For now we simply return success.
upgrade the module
this routine performs an upgrade to the installed module. Note that the newsletter module does not need any upgrade at all because there never was an earlier version.
For now this routine is a nop.
Documentation generated on Tue, 28 Jun 2016 19:11:00 +0200 by phpDocumentor 1.4.0