Class CMS3_System

Description

Implements interfaces:

CMS_System is a system plugin that hosts IProvidesEditor, IConfigure and ISystemCallback

Located in /lib/System/CMS3_System.php (line 32)

CMS3_System_Plugin
   |
   --CMS3_System
Variable Summary
Method Summary
 IEmbedmentOutputHandler &Configure ([IEmbedmentOutputHandler $Identifier = null],  &$EmbedmentOutputHandler)
 void &GetPage (string $identifier, IOutputHandler &$OutputHandler)
 string GetPluginID ()
 void GetSystemIcon ()
 void &LoadSettings ()
 IEmbedmentOutputHandler &ModifyContent ([IEmbedmentOutputHandler $Identifier = null],  &$EmbedmentOutputHandler)
 void ParseSystemOutputHandler ( &$OutputHandler)
 void SaveSettings ( &$Settings)
 void SetSystemDatabaseHandle (resource &$Handle)
 void SystemCallback (string $data)
Variables
mixed $SystemDatabaseHandle = null (line 292)

Referance to a system database handle

  • access: protected

Inherited Variables

Inherited from CMS3_System_Plugin

CMS3_System_Plugin::$Owner
Methods
Configure (line 149)

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

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

Implementation of:
IConfigure::Configure()
Gets a dojo based ajax guide for configuration of the plugin.
GetControlCenterIcon (line 130)

Gets an absolute address of an icon for this plugin

  • access: public
void GetControlCenterIcon ()

Implementation of:
IConfigure::GetControlCenterIcon()
Gets an absolute address of an icon for this plugin
GetControlCenterMenuEntry (line 137)

Gets menu entry string

  • access: public
void GetControlCenterMenuEntry ()

Implementation of:
IConfigure::GetControlCenterMenuEntry()
Gets menu entry string
GetPage (line 209)

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.

Implementation of:
IProvidesContent::GetPage()
Print the page of a given identifier.
GetPluginID (line 300)

Gets the pluginID of the plugin.

  • access: public
string GetPluginID ()

Implementation of:
IPlugin::GetPluginID()
Gets the pluginID of the plugin.
GetSystemIcon (line 113)

Gets an absolute address of an icon for this plugin

  • access: public
void GetSystemIcon ()

Implementation of:
IProvidesEditor::GetSystemIcon()
Gets an absolute address of an icon for this plugin
GetSystemMenuEntry (line 120)

Gets menu entry string

  • access: public
void GetSystemMenuEntry ()

Implementation of:
IProvidesEditor::GetSystemMenuEntry()
Gets menu entry string
GetSystemOutputHandler (line 271)

Gets an instance of SystemOutputHandler

  • access: protected
void &GetSystemOutputHandler ()
LoadSettings (line 319)

Opens the settings file for writting

NOTE: this method is public because it's linked to CMS3_MainClass

  • access: public
void &LoadSettings ()
ModifyContent (line 94)

Gets an Ajax guide for modification of the content.

This implementation of the interface is used to list implemnetations of IConfigure

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

Implementation of:
IProvidesEditor::ModifyContent()
Gets an Ajax guide for modification of the content.
ParseSystemOutputHandler (line 281)

Parse SysOutputHandler to HTML

  • access: protected
void ParseSystemOutputHandler ( &$OutputHandler)
  • &$OutputHandler
SaveSettings (line 338)

Save settings to files...

  • access: protected
void SaveSettings ( &$Settings)
  • &$Settings
SetSystemDatabaseHandle (line 309)

Set the system database handle of this object

  • access: public
void SetSystemDatabaseHandle (resource &$Handle)
  • resource &$Handle: Handle System database handle
SystemCallback (line 47)

Handles a callback from ajax application.

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

Implementation of:
ISystemCallback::SystemCallback()
Handles a callback from ajax application.

Inherited Methods

Inherited From CMS3_System_Plugin

 CMS3_System_Plugin::Register()

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