Class: EditModule

Source Location: /_includes/lib_admin_panel.php

Class Overview

AdminModule
   |
   --EditModule

Describes a module that edits a specified row in a table.

Author(s):

Andreas Launila

Inherited Variables

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 528]
Describes a module that edits a specified row in a table.

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$fields =

[line 539]

Contains the fields, represented by TableField instances, that should be edited.

Tags:

access:

private

Type:

array

[ Top ]

$formFields =

[line 545]

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 ]

$idFields =

[line 552]

Contains the fields that identify the rows that should be edited. The key is the name of the table field and the corresponding value is the corresponding form field that should be used for the table field.

Tags:

access:

private

Type:

array

[ Top ]

$table =

[line 533]

The name of table that contains the row that should be edited.

Tags:

access:

private

Type:

string

[ Top ]

Class Methods

constructor __construct [line 564]

EditModule __construct(
string
$table, array
$fieldsToEdit, array
$idFields, [array
$formFields = array()])

Constructor for EditModule.

Tags:

access:

public

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

Parameters:

string	$table	The table that should be edited.
array	$fieldsToEdit	An array of TableField with the fields that should be edited.
array	$idFields	An array of Tablefield that identifies which entry that should be edited.
array	$formFields	An array of Field (from lib_form_generator.php) with the connected request name as field name.

[ Top ]

method getEditDialog [line 603]

string getEditDialog(
)

Gets the corresponding edit dialog.

Tags:

return:	An edit dialog.
access:	private

[ Top ]

method getEntryLinkPattern [line 667]

void getEntryLinkPattern(
)

Tags:

access:	public
see:	AdminModule.getEntryLinkPattern()

Overrides 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).)

[ Top ]

method getOutput [line 591]

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 processEdit [line 641]

An processEdit(
)

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

Tags:

return:	confirmation message or an error.
access:	private

[ Top ]

Documentation generated on Sun, 16 Apr 2006 21:03:09 +0200 by phpDocumentor 1.3.0RC4