Class LocalInterface

Interface
  |
  +--LocalInterface

public class LocalInterface
extends Interface

API Interface The following template provides the basic level of functionality for all Dark Portal plugin interfaces. It serves as a common interface or API to perform all display functions for Dark Portal addons and current core functionality. For detailed developer instructions, refer to comments in this file, and the developer manual included with Dark Portal.


Fields inherited from class Interface
$command, $interface, $session, $theme
 
Constructor Summary
LocalInterface()
          API Interface Constructor The local interface contructor should usually only call the super class constructor.
 
Method Summary
 unknown initializeLocal()
          Initialize Local Interface If special initialzation is required by the local interface, it should be performed here.
 unknown main(var $template)
          Main Zone Callback Method Almost all interfaces should contain a main() method.
 
Methods inherited from class Interface
add, CoreErrorHandler, delete, display, edit, footer, header, Initialize, leftblock, resetTheme, rightblock, search, unknownError, validateForm
 

Constructor Detail

LocalInterface

public LocalInterface()
API Interface Constructor The local interface contructor should usually only call the super class constructor. In some cases, it may be useful to add some parameters such as static theme ID (admin interfaces) and so forth.
Method Detail

initializeLocal

public unknown initializeLocal()
Initialize Local Interface If special initialzation is required by the local interface, it should be performed here. It may be best to comment this out if no special initialization is required.
Returns:
VOID

main

public unknown main(var $template)
Main Zone Callback Method Almost all interfaces should contain a main() method. This will allow the system to override the parsing of main inside the template and perform the lookup of data which will later be needed to be placed inside the primary zone of the interface. It is also common to create helper and indexing content in other zones. These may be further aided by adding content methods with the same name as the zone. As an example: It is common to provide help features to new users in the rightblock zone of the default theme. If customized data is needed in these blocks, it could be done in a rightblock() method.
Overrides:
main in class Interface
Parameters:
ObjectRef - $template A reference to the template object to use for assigning template date, etc.
Returns:
VOID** @param $template is passed by reference