[System] element index

Package indexes

All elements
b c d e f g h i l m o p r s u v _
_
top
Method __construct
Constructor, loads all plugins
Method __destruct
Destructor, closes Database connections
b
top
Variable $Body
CMS3_System_SysOutputHandler::$Body in CMS3_System_SysOutputHandler.php
Body of the processing page
Variable $BodyList
CMS3_System_SysOutputHandler::$BodyList in CMS3_System_SysOutputHandler.php
BodyList of the processing page
c
top
Method CallImplementations
Call a method on all plugins that implements an interface
Class CMS3_MainClass
CMS3_MainClass in default.php
The CMS3 main class, this class hostes all plugins and initiate everything.
Class CMS3_PackageManager
CMS3_PackageManager in CMS3_PackageManager.php
PackageManager provides the logic for installation and removal of packages.
Class CMS3_System
CMS3_System in CMS3_System.php
CMS_System is a system plugin that hosts IProvidesEditor, IConfigure and ISystemCallback
Class CMS3_System_Plugin
CMS3_System_Plugin in CMS3_System_Plugin.php
An abstract implementation of the Register method from IPlugin
Class CMS3_System_SysOutputHandler
CMS3_System_SysOutputHandler in CMS3_System_SysOutputHandler.php
An IEmbedmentOutputHandler implementation for CMS3_System, internal use only
Constant CMS3_System_SystemDatabasePassword
Password for the system database
Constant CMS3_System_SystemDatabasePrefix
Userspace system prefix
Constant CMS3_System_SystemDatabaseServer
Address of the system database host
Constant CMS3_System_SystemDatabaseUser
Username for system database
Constant CMS3_System_UserSpaceDatabasePassword
Password for the userspace database
Constant CMS3_System_UserSpaceDatabasePrefix
Userspace database prefix
Constant CMS3_System_UserSpaceDatabaseServer
Address of the userspace database host
Constant CMS3_System_UserSpaceDatabaseUser
Username for userspace database
Method Configure
IConfigure::Configure() in IConfigure.php
Gets a dojo based ajax guide for configuration of the plugin.
Method Configure
CMS3_System::Configure() in CMS3_System.php
Gets a dojo based ajax guide for configuration of the plugin.
Page CMS3_PackageManager.php
CMS3_PackageManager.php in CMS3_PackageManager.php
Page CMS3_System.php
CMS3_System.php in CMS3_System.php
Page CMS3_System_SysOutputHandler.php
CMS3_System_SysOutputHandler.php in CMS3_System_SysOutputHandler.php
Page CMS3_System_Plugin.php
CMS3_System_Plugin.php in CMS3_System_Plugin.php
d
top
Page default.php
default.php in default.php
Method Disable
IOutputHandler::Disable() in IOutputHandler.php
Diable the OutputHandler, do this if you wish to print binary data.
e
top
Method ExtentHeader
IEmbedmentOutputHandler::ExtentHeader() in IEmbedmentOutputHandler.php
Data provided by use of this method may be left out if the OutputHandler wishes to print something else the HTML, therefor don't add important information here.
Method ExtentHeader
CMS3_System_SysOutputHandler::ExtentHeader() in CMS3_System_SysOutputHandler.php
Data provided by use of this method may be left out if the OutputHandler wishes to print something else the HTML, therefor don't add important information here.
f
top
Method FatalError
Closes the application, with an FatalError log, and print the log messsage to user.
g
top
Method GetCMS3Path
Gets the server path of the CMS3 installation.
Method GetCMS3URL
Gets the URL of the CMS3 toplevel namespace.
Method GetContent
IEmbedmentOutputHandler::GetContent() in IEmbedmentOutputHandler.php
Gets content ready to be printed
Method GetContent
CMS3_System_SysOutputHandler::GetContent() in CMS3_System_SysOutputHandler.php
Gets content ready to be printed
Method GetControlCenterIcon
Gets an absolute address of an icon for this plugin
Method GetControlCenterIcon
Gets an absolute address of an icon for this plugin
Method GetControlCenterMenuEntry
Gets menu entry string
Method GetControlCenterMenuEntry
Gets menu entry string
Method GetDatabaseHandle
Gets a handle for the userspace database
Method GetEmbedment
Gets an embedment from it unique identifier, returns embedable HTML.
Method GetHeader
IEmbedmentOutputHandler::GetHeader() in IEmbedmentOutputHandler.php
Gets the header extension
Method GetHeader
CMS3_System_SysOutputHandler::GetHeader() in CMS3_System_SysOutputHandler.php
Gets the header extension
Method GetIdentifier
IOutputHandler::GetIdentifier() in IOutputHandler.php
Gets to original identifier specified as <Namespace>/<PluginID>.<ext> Do this if you wish to extraxt the extention and parse manually.
Method GetImplementations
Gets all plugins that implements an interface
Method GetLinks
ILinkable::GetLinks() in ILinkable.php
Gets a of links that the plugins exposes
Method GetNamespace
Get namespace from owner
Method GetPage
IProvidesContent::GetPage() in IProvidesContent.php
Print the page of a given identifier.
Method GetPage
CMS3_System::GetPage() in CMS3_System.php
Print the page of a given identifier.
Method GetPlugin
Gets an instance of a plugin, this returns the one loaded at initialization
Method GetPluginID
CMS3_System::GetPluginID() in CMS3_System.php
Gets the pluginID of the plugin.
Method GetPluginID
IPlugin::GetPluginID() in IPlugin.php
Gets the pluginID of the plugin.
Method GetPluginID
CMS3_System_SysOutputHandler::GetPluginID() in CMS3_System_SysOutputHandler.php
Gets the pluginID of the plugin.
Method GetPluginID
CMS3_PackageManager::GetPluginID() in CMS3_PackageManager.php
Gets the pluginID of the plugin.
Method GetSystemDatabaseHandle
Gets a handle for the system database
Method GetSystemIcon
IProvidesEditor::GetSystemIcon() in IProvidesEditor.php
Gets an absolute address of an icon for this plugin
Method GetSystemIcon
CMS3_System::GetSystemIcon() in CMS3_System.php
Gets an absolute address of an icon for this plugin
Method GetSystemMenuEntry
Gets menu entry string
Method GetSystemMenuEntry
Gets menu entry string
Method GetSystemOutputHandler
Gets an instance of SystemOutputHandler
Method GetUserName
Gets the username of the current user, resturns null if user not loggedin.
h
top
Variable $Header
CMS3_System_SysOutputHandler::$Header in CMS3_System_SysOutputHandler.php
Header of the processing page
i
top
Class IConfigure
IConfigure in IConfigure.php
class IConfigure, implement this is your plugin should expose a configuration page.
Class IEmbedmentOutputHandler
IEmbedmentOutputHandler in IEmbedmentOutputHandler.php
Interface IEmbedmentOutputHandler, used for processing embedments
Class IInstall
IInstall in IInstall.php
Implement this interface to run an installation script once package has been installed.
Class ILinkable
ILinkable in ILinkable.php
class ILinkable, implement this if your plugin exposes links
Method Install
IInstall::Install() in IInstall.php
Runs a script to complet installation
Method InstallPackage
CMS3_PackageManager::InstallPackage() in CMS3_PackageManager.php
Verifies and installs a package
Class IOutputHandler
IOutputHandler in IOutputHandler.php
class IOutputHandler, implement this if your plugin is and OutputHandler
Class IPlugin
IPlugin in IPlugin.php
class IPlugin, this minimum requirement for a plugin
Class IProvidesContent
IProvidesContent in IProvidesContent.php
class IProvidesContent, Implement this if you plugin exposes viewable content
Class IProvidesEditor
IProvidesEditor in IProvidesEditor.php
class IProvidesEditor, implement this if your plugin should expose an editor in the backend.
Class IRemove
IRemove in IRemove.php
Defines a function to be execute upon removal
Method IsAdmin
Returns true if current user is administrator.
Class ISystemCallback
ISystemCallback in ISystemCallback.php
class ICallback
Page IConfigure.php
IConfigure.php in IConfigure.php
Page IEmbedmentOutputHandler.php
IEmbedmentOutputHandler.php in IEmbedmentOutputHandler.php
Page IInstall.php
IInstall.php in IInstall.php
Page ILinkable.php
ILinkable.php in ILinkable.php
Page IOutputHandler.php
IOutputHandler.php in IOutputHandler.php
Page IPlugin.php
IPlugin.php in IPlugin.php
Page IProvidesContent.php
IProvidesContent.php in IProvidesContent.php
Page IProvidesEditor.php
IProvidesEditor.php in IProvidesEditor.php
Page IRemove.php
IRemove.php in IRemove.php
Page ISystemCallback.php
ISystemCallback.php in ISystemCallback.php
l
top
Variable $LogFileHandle
Handle for the logfile, not always loaded
Method ListPackages
CMS3_PackageManager::ListPackages() in CMS3_PackageManager.php
List all the packages that are available for installation in local package repository
Method ListPlugins
CMS3_PackageManager::ListPlugins() in CMS3_PackageManager.php
List all the installed plugins that can be deleted or verified
Method LoadPlugin
Load a plugin
Method LoadSettings
CMS3_System::LoadSettings() in CMS3_System.php
Opens the settings file for writting
Method Log
CMS3_MainClass::Log() in default.php
Print a message to the logfile, useful for debuggin information.
Method Login
Log the user in
Method LogMySQL
Print a message of an mysql error to the logfile, useful for debuggin information.
m
top
Page mysql.conf.php
mysql.conf.php in mysql.conf.php
Method Main
CMS3_MainClass::Main() in default.php
Main functions start the application
Method ModifyContent
CMS3_System::ModifyContent() in CMS3_System.php
Gets an Ajax guide for modification of the content.
Method ModifyContent
IProvidesEditor::ModifyContent() in IProvidesEditor.php
Gets an Ajax guide for modification of the content.
o
top
Variable $Owner
CMS3_System_SysOutputHandler::$Owner in CMS3_System_SysOutputHandler.php
Referance to the MainClass owning this instance
Variable $Owner
CMS3_System_Plugin::$Owner in CMS3_System_Plugin.php
Referance to the MainClass owning this instance
p
top
Variable $PluginID
CMS3_System_SysOutputHandler::$PluginID in CMS3_System_SysOutputHandler.php
Const defining the PluginID
Variable $Plugins
Method Parse
IOutputHandler::Parse() in IOutputHandler.php
Print the content, should also be called from GetPage().
Method ParseSystemOutputHandler
Parse SysOutputHandler to HTML
Method PrintError
IOutputHandler::PrintError() in IOutputHandler.php
Print an error code, if you use this method no other methods will be available.
r
top
Method Register
CMS3_System_Plugin::Register() in CMS3_System_Plugin.php
Register the owner of this plugin.
Method Register
IPlugin::Register() in IPlugin.php
Method Register
CMS3_System_SysOutputHandler::Register() in CMS3_System_SysOutputHandler.php
Method RegisterNamespace
Registers a namespace, the plugin that owns this MUST implement IProvidesContent
Method Remove
IRemove::Remove() in IRemove.php
Removes files and databases created after fysical installation, this method will only be called at complete removal of plugin, not if plugin is being updated or upgraded.
Method RemovePlugin
CMS3_PackageManager::RemovePlugin() in CMS3_PackageManager.php
Remove an installed plugin
Method ResolveIdentifier
Resoles an print the content of an identifier.
s
top
Variable $SystemDatabaseHandle
Referance to a system database handle
Variable $SystemDatabaseHandle
Handle for the system database, not always initialized
Method SaveSettings
CMS3_System::SaveSettings() in CMS3_System.php
Save settings to files...
Method SetBody
IEmbedmentOutputHandler::SetBody() in IEmbedmentOutputHandler.php
Set the body if the page, read parameter documentation.
Method SetBody
CMS3_System_SysOutputHandler::SetBody() in CMS3_System_SysOutputHandler.php
Set the body if the page, read parameter documentation.
Method SetIdentifier
IOutputHandler::SetIdentifier() in IOutputHandler.php
Sets the complete unique identifier.
Method SetSystemDatabaseHandle
Set the system database handle of this object
Method SetTitle
IOutputHandler::SetTitle() in IOutputHandler.php
Set the title of the page
Method SystemCallback
ISystemCallback::SystemCallback() in ISystemCallback.php
Handles a callback from ajax application.
Method SystemCallback
Handles a callback from ajax application.
u
top
Variable $UserSpaceDatabaseHandle
Handle for the userspace database, not always initialized
Method UnregisterNamespace
Unregisters a namespace
Method UploadPackage
CMS3_PackageManager::UploadPackage() in CMS3_PackageManager.php
Upload a third party package to local repository
v
top
Method VerifyPackage
CMS3_PackageManager::VerifyPackage() in CMS3_PackageManager.php
Verifies the integrity of a (.c3p) package, not installed plugin
Method VerifyPlugin
CMS3_PackageManager::VerifyPlugin() in CMS3_PackageManager.php
Verify the integrity of an installed plugin
b c d e f g h i l m o p r s u v _