File/program/modules/htmlpage/htmlpage_install.php

Description

/program/modules/htmlpage/htmlpage_install.php - installer of the htmlpage module

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

    htmlpage_install(&$messages,$module_id) htmlpage_upgrade(&$messages,$module_id) htmlpage_uninstall(&$messages,$module_id) htmlpage_demodata(&$messages,$module_id,$config,$manifest)

These functions can be called from the main installer and/or admin.php.

  • author: Peter Fokker <peter@berestijn.nl>
  • version: $Id: htmlpage_install.php,v 1.1.1.1 2011-02-01 13:01:35 pfokker Exp $
  • copyright: Copyright (C) 2008-2011 Ingenieursbureau PSD/Peter Fokker
  • license: GNU AGPLv3+Additional Terms
Functions
htmlpage_demodata (line 91)

add demonstration data to the system

this routine is a no-op because all htmlpage demodata is already created in the main demodata-routine in /program/install/demodata.php. This routine is retained here as an example alias placeholder.

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

install the module

this routine installs the module. For this module there is nothing to install, so we simply return success. (The appropriate table is already created based on the tabledefs).

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

uninstall the module

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

upgrade the module

  • return: TRUE on success + output via $messages, FALSE otherwise
bool htmlpage_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, 1 Feb 2011 16:55:18 +0100 by phpDocumentor 1.4.0