Class: AddModule

Source Location: /_includes/lib_admin_panel.php

Class Overview

AdminModule
   |
   --AddModule

Describes a module for adding new rows to a table.

Author(s):

Andreas Launila

Variables

Methods

Inherited Variables

Class: AdminModule

AdminModule::$actions

Inherited Methods

Class: AdminModule

AdminModule::__construct(): Constructor for AdminModule.
AdminModule::getAdminActions(): Gets all admin actions handled by the module.
AdminModule::getEntryLinkPattern(): Override this function if the module should be linked to once for every entry displayed in the panel's overview. The pattern can use fieldnames as $row['foo'] (where foo is the fieldname).
AdminModule::getGlobalLinkPattern(): Override this function if the module should be linked to once in the panel.
AdminModule::getOutput(): Gets the output that the module wants to diaply.
AdminModule::handlesAction(): Checks if an action can be handled by the module.
AdminModule::logActivity(): Notifies everything that should be notified of admin activity. This function should be called whenever a module alters a table.

Class Details

[line 677]
Describes a module for adding new rows to a table.

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$fields =

[line 688]

Contains the fields (represented by TableFiled instances) that should be set when adding a new module.

Tags:

access:

private

Type:

array

[ Top ]

$formFields =

[line 694]

Contains the form fields, represented by Field instances, that should be used to override the request name contained in the key.

Tags:

access:

private

Type:

array

[ Top ]

$table =

[line 682]

The name of the table that the module should add rows to.

Tags:

access:

private

Type:

string

[ Top ]

Class Methods

constructor __construct [line 704]

AddModule __construct(
string
$table, array
$fieldsToAdd, [array
$formFields = array()])

Constructor for AddModule.

Tags:

access:

public

Overrides AdminModule::__construct() (Constructor for AdminModule.)

Parameters:

string	$table	The table that entries should be added to.
array	$fieldsToAdd	An array of TableField with the fields that should be added.
array	$formFields	An array of Field (from lib_form_generator.php) with the connected request name as field name.

[ Top ]

method getAddDialog [line 734]

string getAddDialog(
)

Gets the corresponding add dialog.

Tags:

return:	An add dialog.
access:	private

[ Top ]

method getGlobalLinkPattern [line 777]

void getGlobalLinkPattern(
)

Tags:

access:	public
see:	AdminModule.getGlobalLinkPattern()

Overrides AdminModule::getGlobalLinkPattern() (Override this function if the module should be linked to once in the panel.)

[ Top ]

method getOutput [line 722]

void getOutput(
mixed
$action)

Tags:

access:	public
see:	AdminModule.getOutput($action)

Overrides AdminModule::getOutput() (Gets the output that the module wants to diaply.)

[ Top ]

method processAdd [line 755]

An processAdd(
)

Processes an add request and returns the result or an error message.

Tags:

return:	confirmation message or an error.
access:	private

[ Top ]

Documentation generated on Tue, 10 Jan 2006 17:06:22 +0100 by phpDocumentor 1.3.0RC4