File/administrator/components/com_modules/admin.modules.php

Description
Includes
 require_once ($mainframe->getPath('admin_html')) (line 18)

ensure this file is being included by a parent file

Functions
cancelModule (line 519)

Cancels an edit operation

void cancelModule ( $option,  $client)
  • $option
  • $client
copyModule (line 173)

Compiles information to add or edit a module

void copyModule (string $option, integer $uid,  $client)
  • string $option: The current GET/POST option
  • integer $uid: The unique id of the record to edit
  • $client
editModule (line 291)

Compiles information to add or edit a module

void editModule (string $option, integer $uid,  $client)
  • string $option: The current GET/POST option
  • integer $uid: The unique id of the record to edit
  • $client
orderModule (line 537)

Moves the order of a record

void orderModule (integer $uid, integer $inc,  $option)
  • integer $uid: The unique id of record
  • integer $inc: The increment to reorder by
  • $option
publishModule (line 487)

Publishes or Unpublishes one or more modules

void publishModule ([array $cid = null], [integer $publish = 1],  $option,  $client)
  • array $cid: An array of unique record id numbers
  • integer $publish: 0 if unpublishing, 1 if publishing
  • $option
  • $client
removeModule (line 423)

Deletes one or more modules

Also deletes associated entries in the #__module_menu table.

void removeModule (array &$cid,  $option,  $client)
  • array &$cid: An array of unique category id numbers
  • $option
  • $client
saveModule (line 217)

Saves the module after an edit form submit

void saveModule ( $option,  $client,  $task)
  • $option
  • $client
  • $task
viewModules (line 87)

Compiles a list of installed or defined modules

void viewModules ( $option,  $client)
  • $option
  • $client

Documentation generated on Mon, 05 May 2008 16:15:42 +0400 by phpDocumentor 1.4.0