Class CMS3_Wiki

Description

Implements interfaces:

Very simple plugin that allows creation of an image gallery

Located in /lib/Wiki/CMS3_Wiki.php (line 32)

CMS3_System_Plugin
   |
   --CMS3_Wiki
Method Summary
 IEmbedmentOutputHandler &Configure ([IEmbedmentOutputHandler $Identifier = null],  &$EmbedmentOutputHandler)
 array GetLinks ()
 void &GetPage (string $identifier, IOutputHandler &$OutputHandler)
 string GetPluginID ()
 bool Install ()
 bool Remove ()
 void SystemCallback (string $data)
Variables

Inherited Variables

Inherited from CMS3_System_Plugin

CMS3_System_Plugin::$Owner
Methods
Configure (line 261)

Gets a dojo based ajax guide for configuration of the plugin.

  • access: public
IEmbedmentOutputHandler &Configure ([IEmbedmentOutputHandler $Identifier = null],  &$EmbedmentOutputHandler)
GetControlCenterIcon (line 242)

Gets an absolute address of an icon for this plugin

  • access: public
void GetControlCenterIcon ()
GetControlCenterMenuEntry (line 249)

Gets menu entry string

  • access: public
void GetControlCenterMenuEntry ()
GetLinks (line 208)

Gets a list of links that the plugins exposes

Each entry in the array is an array with 3 fields, one for the display name, one for the URL of the page, and one for an array of sub entries. Each sub entry consits of 3 fields, just like the toplevel entries.

  • access: public
array GetLinks ()
GetPage (line 47)

Print the page of a given identifier.

  • access: public
void &GetPage (string $identifier, IOutputHandler &$OutputHandler)
  • string $identifier: identifier Identifier of the requested page.
  • IOutputHandler &$OutputHandler: OutputHandler OutputHandler used the parse the output. You may disable this OutputHandler with OutputHandler->Disable() and print the content manually.
GetPluginID (line 193)

Gets the pluginID of the plugin.

  • access: public
string GetPluginID ()
Install (line 346)

Runs a script to complet installation

This creates database tables, and default data.

  • return: True if installations script went okay, otherwise return false.
  • access: public
bool Install ()
Remove (line 369)

Removes files and databases created after fysical installation

  • return: true/false depending on success
  • access: public
bool Remove ()
SystemCallback (line 284)

Handles a callback from ajax application.

  • access: public
void SystemCallback (string $data)
  • string $data: data Data attached to this callback

Inherited Methods

Inherited From CMS3_System_Plugin

 CMS3_System_Plugin::Register()

Documentation generated on Mon, 30 Apr 2007 01:59:11 +0200 by phpDocumentor 1.3.1