pnModGetInfo

get module info

Synopsis

array pnModGetInfo(modid);

Description

pnModGetInfo() obtains information on a module in this PostNuke system.

Parameters

modid

The id of this module in the PostNuke system.

Return Values

This function returns an array of module information if the module is found. 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 ID_NOT_EXIST if the modid is unknown.

Notes

The module array contains the following items:

name

The well-known name of the module

directory

The Filesystem directory in which this modules files exist

displayname

The display-friendly name for this module

description

A short description of this module's functionality

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

Examples

// Get information on News module
$modid = pnModGetIDFromName('News');
$modinfo = pnModGetInfo($modid);
       

See Also

pnModGetIDFromName(), pnModGetUserMods(), pnModGetAdminMods(), pnModGetVar()