Class CMS3_PlainHTML

Description

Implements interfaces:

The PlainHTML plugin provides ability to create plain HTML pages.

Located in /lib/PlainHTML/CMS3_PlainHTML.php (line 32)

CMS3_System_Plugin
   |
   --CMS3_PlainHTML
Method Summary
 IEmbedmentOutputHandler &Configure ([IEmbedmentOutputHandler $Identifier = null],  &$EmbedmentOutputHandler)
 bool DeletePage (string $Identifier)
 void GetHelp ()
 array GetLinks ()
 void &GetPage (string $identifier, IOutputHandler &$OutputHandler)
 string GetPluginID ()
 void GetSystemIcon ()
 bool Install ()
 void &LoadSettings ()
 IEmbedmentOutputHandler &ModifyContent ([IEmbedmentOutputHandler $Identifier = null],  &$EmbedmentOutputHandler)
 bool Remove ()
 void SaveSettings ( &$Settings)
 void SystemCallback (string $data)
Variables

Inherited Variables

Inherited from CMS3_System_Plugin

CMS3_System_Plugin::$Owner
Methods
Configure (line 386)

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

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

Deletes a page

  • return: True/false, depending on success
  • access: protected
bool DeletePage (string $Identifier)
  • string $Identifier: Identifier Title of the page to delete
GetControlCenterIcon (line 367)

Gets an absolute address of an icon for this plugin

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

Gets menu entry string

  • access: public
void GetControlCenterMenuEntry ()
GetHelp (line 486)

Gets a list of the help available for this plugin

This method returns a list of toplevel subjects, only one or two toplevel subjects, each toplevel subject is an array with 3 fields number zero a title, number one the body text of the help page (in HTML) and number 2 is an array of subsubjects. Each subsubject consists of the same as the toplevel subjects.

Return array List of help subjects and subsubjects

  • access: public
void GetHelp ()
GetLinks (line 322)

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 189)

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 357)

Gets the pluginID of the plugin.

  • access: public
string GetPluginID ()
GetSystemIcon (line 301)

Gets an absolute address of an icon for this plugin

  • access: public
void GetSystemIcon ()
GetSystemMenuEntry (line 308)

Gets menu entry string

  • access: public
void GetSystemMenuEntry ()
Install (line 547)

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 ()
LoadSettings (line 422)

Opens the settings file for writting

  • access: protected
void &LoadSettings ()
ModifyContent (line 237)

Gets an Ajax guide for modification of the content.

  • access: public
IEmbedmentOutputHandler &ModifyContent ([IEmbedmentOutputHandler $Identifier = null],  &$EmbedmentOutputHandler)
  • IEmbedmentOutputHandler $Identifier: EmbedmentOutputHandler Outputhandler the content MUST be parse to.
  • &$EmbedmentOutputHandler
Remove (line 583)

Removes files and databases created after fysical installation

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

Save settings to files...

  • access: protected
void SaveSettings ( &$Settings)
  • &$Settings
SystemCallback (line 46)

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