File/program/modules/confab/confab_install.php

Description

/program/modules/confab/confab_install.php - installer of the confab module

This file contains the confab module installer. The interface consists of these functions:

    confab_install(&$messages,$module_id) confab_upgrade(&$messages,$module_id) confab_uninstall(&$messages,$module_id) confab_demodata(&$messages,$module_id,&$config,$manifest)

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.

Functions
confab_demodata (line 147)

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.

    $config['language_key']   => install language code (eg. 'en') $config['dir']            => path to CMS Root Directory (eg. /home/httpd/htdocs) $config['www']            => URL of CMS Root Directory (eg. http://exemplum.eu) $config['progdir']        => path to program directory (eg. /home/httpd/htdocs/program) $config['progwww']        => URL of program directory (eg. http://exemplum.eu/program) $config['datadir']        => path to data directory (eg. /home/httpd/wasdata/a1b2c3d4e5f6) $config['user_username']  => userid of webmaster (eg. wblader) $config['user_full_name'] => full name of webmaster (eg. Wilhelmina Bladergroen) $config['user_email']     => email of webmaster (eg. w.bladergroen@exemplum.eu) $config['user_id']        => numerical user_id (usually 1) $config['demo_salt']      => password salt for all demodata accounts $config['demo_password']  => password for all demodata accounts $config['demo_areas']     => array with demo area data $config['demo_groups']    => array with demo group data $config['demo_users']     => array with demo user data $config['demo_nodes']     => array with demo node data $config['demo_string']    => array with demo strings from /program/install/languages/LL/demodata.php $config['demo_replace']   => array with search/replace pairs to 'jazz up' the demo strings

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.

  • return: TRUE on success + output via $messages, FALSE otherwise
bool confab_demodata (array &$messages, int $module_id, array &$config, array $manifest)
  • array &$messages: collects the (error) messages
  • int $module_id: the key for this module in the modules table
  • array &$config: pertinent data for the new website + demodata foundation
  • array $manifest: a copy from the manifest for this module
confab_install (line 61)

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.

  • return: TRUE on success + output via $messages, FALSE otherwise
bool confab_install (array &$messages, int $module_id)
  • array &$messages: collects the (error) messages
  • int $module_id: the key for this module in the modules table
confab_uninstall (line 92)

uninstall the module

this is a hook for future extensions of Website@School. For now we simply return success.

  • return: TRUE on success + output via $messages, FALSE otherwise
bool confab_uninstall (array &$messages, int $module_id)
  • array &$messages: collects the (error) messages
  • int $module_id: the key for this module in the modules table
confab_upgrade (line 78)

upgrade the module

this routine performs an upgrade to the installed module. Note that the confab module does not need any upgrade at all because there never was an earlier version.

For now this routine is a nop.

  • return: TRUE on success + output via $messages, FALSE otherwise
bool confab_upgrade (array &$messages, int $module_id)
  • array &$messages: collects the (error) messages
  • int $module_id: the key for this module in the modules table

Documentation generated on Tue, 28 Jun 2016 19:08:42 +0200 by phpDocumentor 1.4.0