Class: CallbackModule

Source Location: /_includes/lib_admin_panel.php

Class Overview

AdminModule
   |
   --CallbackModule

Describes a module that uses callbacks to process events.

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 792]
Describes a module that uses callbacks to process events.

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$callbacks =

[line 797]

Contains all the callbacks, action value as key, the callback as value.

Tags:

access:

private

Type:

array

[ Top ]

$entryLink =

[line 807]

The entry link pattern to be returned by the module.

Tags:

access:

private

Type:

string

[ Top ]

$globalLink =

[line 802]

The global link pattern to be used by the module.

Tags:

access:

private

Type:

string

[ Top ]

Class Methods

constructor __construct [line 818]

CallbackModule __construct(
array
$callbacks, [string
$globalLink = ''], [string
$entryLink = ''])

Constructor for CallbackModule.

Tags:

access:

public

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

Parameters:

array	$callbacks	An array of the callbacks to be used, corresponding action value as key, callback as value.
string	$globalLink	The global link pattern (see AdminModule.getGlobalLinkPattern() that the module should use.
string	$entryLink	The entry link pattern (see AdminModule.getEntryLinkPattern() that the module should use.

[ Top ]

method getEntryLinkPattern [line 851]

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 getGlobalLinkPattern [line 844]

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

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:08 +0200 by phpDocumentor 1.3.0RC4