Class: DeleteModule

Source Location: /_includes/lib_admin_panel.php

Class Overview

AdminModule
   |
   --DeleteModule

Describes a module that deletes rows from 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 399]
Describes a module that deletes rows from a table.

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$doConfirmation =

[line 416]

If a confirmation should be asked for or not. True if a confirmation should be asked for, false otherwise.

Tags:

access:

private

Type:

boolen

[ Top ]

$fields =

[line 410]

Contains the TableField instances that should be used to identify which row that should be deleted.

Tags:

access:

private

Type:

array

[ Top ]

$table =

[line 404]

The name of the table that the module should delete rows from.

Tags:

access:

private

Type:

string

[ Top ]

Class Methods

constructor __construct [line 426]

DeleteModule __construct(
string
$table, array
$identifierFields, [mixed
$requestConfirmation = true], boolean
$requestConfimation)

Constructor for DeleteModule.

Tags:

access:

public

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

Parameters:

string	$table	The table that should be worked against.
array	$identifierFields	The fields that identify which row that should be deleted.
boolean	$requestConfimation	If a confimation should be asked for or not.

[ Top ]

method getEntryLinkPattern [line 512]

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 439]

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 processConfirm [line 455]

string processConfirm(
)

Creates a confirmation dialog.

Tags:

return:	A confirmation dialog.
access:	private

[ Top ]

method processRemove [line 477]

string processRemove(
)

Removes an entry and creates a confirmation message.

Tags:

return:	An confirmation or error message.
access:	private

[ Top ]

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