pnModAPILoad

load a module API

Synopsis

int pnModAPILoad(modname, type);

Description

pnModAPILoad() loads extra functions into the PostNuke system to extend its abilities.

Parameters

modname

The well-known name of a module to load

type

The type of module functions to load; currently one of 'user' or 'admin'.

Return Values

This function returns true if the module loaded successfully. This function returns void if an exception was raised.

Exceptions

This function raises BAD_PARAM if you pass an invalid parameter. This function raises DATABASE_ERROR if an error occurs while querying data. This function raises MODULE_FILE_NOT_EXIST if a module file doesn't exist. This function raises MODULE_NOT_EXIST if the module doesn't exist.

Notes

The PostNuke API keeps track of what modules have been loaded, so multiple calls to pnModAPILoad() with the same parameters will return true each time.

This function does not load in the relevant display functionality for this module automatically, this must be carried out by a separate call to pnModLoad().

For more information on well-known names of modules please refer to the documentation for pnModGetVar()

Examples

// See if News module is available
if (pnModAvailable('News')) {
  // Load the user API for the News module
  if (!pnModAPILoad('News', 'user')) {
    die('Could not load News module API');
  }
}
       

pnModLoad(), pnModGetVar()