Class: UpdateModule

Source Location: /_includes/lib_admin_panel.php

Class Overview

AdminModule
   |
   --UpdateModule

Describes a module that sets specified fields to specified values when requested.

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 960]
Describes a module that sets specified fields to specified values when requested.

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$fieldsToSet =

[line 971]

Contains the fields (represented by TableField instances) and the values that they should be set to.

Tags:

access:

private

Type:

array

[ Top ]

$idFields =

[line 977]

Contains the fields (represented by TableFiled instances) that identify which row that should be set.

Tags:

access:

private

Type:

array

[ Top ]

$linkName =

[line 982]

The name for the link that should represent the module.

Tags:

access:

private

Type:

string

[ Top ]

$table =

[line 965]

The name of the table which rows should be updated.

Tags:

access:

private

Type:

string

[ Top ]

Class Methods

constructor __construct [line 994]

UpdateModule __construct(
string
$table, array
$fieldsToSet, array
$idFields, [string
$linkName = 'Update'])

Constructor for UpdateModule.

Tags:

access:

public

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

Parameters:

string	$table	The table to read from.
array	$fieldsToSet	The TableField instances that should be set (along with the value that should be used).
array	$idFields	The Tablefield instances that identifies which row that should be set.
string	$linkName	An optional name for the link that will be representing the action e.g. 'Mark as investigated'.

[ Top ]

method getEntryLinkPattern [line 1033]

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

void getOutput(
mixed
$action)

Tags:

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

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

[ Top ]

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