Docs For Class GUIManagerAbstract

Class GUIManagerAbstract

Description

This abstract provides methods for theme management: saving/loading of theme state, obtaining information about supported GUI components, etc.

version: $Id: GUIManager.abstract.php,v 1.7 2007/09/04 20:25:21 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/GUIManager/GUIManager.abstract.php (line 21)

OsidManager
   |
   --OutputHandler
      |
      --GUIManagerAbstract

Direct descendents

Class	Description
GUIManager	An implmentation of the GUIManagerInterface. This implementation

Method Summary

void deleteTheme (ref $id)

string getComponentPath ()

string getLayoutPath ()

string getSCPath ()

string getSPPath ()

array getSupportedComponents ()

array getSupportedLayouts ()

array getSupportedSCs ()

array getSupportedSPs ()

array getSupportedThemes ()

ref getTheme ()

string getThemePath ()

void loadTheme (ref $stateId, ref $theme)

void output (mixed $returnedContent, string $printedContent)

ref saveTheme (ref $theme)

void setTheme (ref $themeObject)

Variables

Inherited Variables

Inherited from OutputHandler

OutputHandler::$_head

Methods

deleteTheme (line 250)

Deletes the theme state with the given id from the database. Notice that

this does not affect the Theme whose state is being deleted in any way!

access: public

void deleteTheme (ref $id)

ref $id: object $id A HarmoniId identifying the theme state that needs to be deleted.

Redefined in descendants as:

GUIManager::deleteTheme() : Deletes the theme from the database

getComponentPath (line 190)

Returns the path that contains all the supported components.

return: The relative path to the Component directory.
access: public

string getComponentPath ()

Redefined in descendants as:

GUIManager::getComponentPath() : Returns the path that contains all the supported components.

getLayoutPath (line 208)

Returns the path that contains all the supported layouts.

return: The relative path to the Layout directory.
access: public

string getLayoutPath ()

Redefined in descendants as:

GUIManager::getLayoutPath() : Returns the path that contains all the supported layouts.

getSCPath (line 172)

Returns the path that contains all the supported style component.

return: The relative path to the style component directory.
access: public

string getSCPath ()

Redefined in descendants as:

GUIManager::getSCPath() : Returns the path that contains all the supported style component.

getSPPath (line 154)

Returns the path that contains all the supported style properties.

return: The relative path to the style property directory.
access: public

string getSPPath ()

Redefined in descendants as:

GUIManager::getSPPath() : Returns the path that contains all the supported style properties.

getSupportedComponents (line 181)

Returns a list of components supported by the GUIManager.

return: An array of strings; each element is the class name of a component.
access: public

array getSupportedComponents ()

Redefined in descendants as:

GUIManager::getSupportedComponents() : Returns a list of components supported by the GUIManager.

getSupportedLayouts (line 199)

Returns a list of layouts supported by the GUIManager.

return: An array of strings; each element is the class name of a layout.
access: public

array getSupportedLayouts ()

Redefined in descendants as:

GUIManager::getSupportedLayouts() : Returns a list of layouts supported by the GUIManager.

getSupportedSCs (line 163)

Returns a list of style components supported by the GUIManager.

return: An array of strings; each element is the class name of a style components.
access: public

array getSupportedSCs ()

Redefined in descendants as:

GUIManager::getSupportedSCs() : Returns a list of style components supported by the GUIManager.

getSupportedSPs (line 145)

Returns a list of style properties supported by the GUIManager.

return: An array of strings; each element is the class name of a style property.
access: public

array getSupportedSPs ()

Redefined in descendants as:

GUIManager::getSupportedSPs() : Returns a list of style properties supported by the GUIManager.

getSupportedThemes (line 127)

Returns a list of themes supported by the GUIManager.

return: An array of strings; each element is the class name of a theme.
access: public

array getSupportedThemes ()

getTheme (line 115)

Returns the current theme object.

return: object A Theme object.
access: public

ref getTheme ()

getThemePath (line 136)

Returns the path that contains all the supported themes.

return: The relative path to the Theme directory.
access: public

string getThemePath ()

loadTheme (line 239)

Loads the theme state stored priorly with

saveThemeState()

. This method reverses the steps of

saveThemeState()

. It first obtains the database-stored theme state, unserializes it, and finally imports it into the theme.

access: public

void loadTheme (ref $stateId, ref $theme)

ref $stateId: object stateId The id of the theme state that will be loaded.
ref $theme: object theme The theme whose state needs to be loaded.

Redefined in descendants as:

GUIManager::loadTheme() : Load theme

output (line 39)

Output the content that was returned from an action. This content should have been created such that it is a type that this OutputHandler can deal with.

since: 4/4/05
access: public

void output (mixed $returnedContent, string $printedContent)

mixed $returnedContent: Content returned by the action
string $printedContent: Additional content printed, but not returned.

Redefinition of:

OutputHandler::output(): Output the content that was returned from an action. This content should have been created such that it is a type that this OutputHandler can deal with.

saveTheme (line 224)

Saves the theme state to the database. The theme state is saved by exporting the theme's style properties, and then serializing the output and storing it into the database. If the Theme already exists, it is merely replaced.

return: object A HarmoniId objecting identifying the saved state uniquely.
access: public

ref saveTheme (ref $theme)

ref $theme: object theme The theme whose state needs to be saved.

Redefined in descendants as:

GUIManager::saveTheme() : Saves the current theme by updating the theme settings in the database

setTheme (line 103)

Sets the Theme to use for output to the browser. $themeObject can be any Theme object that follows the ThemeInterface.

access: public

void setTheme (ref $themeObject)

ref $themeObject: object A Theme object.

Inherited Methods

Inherited From OutputHandler

OutputHandler::assignConfiguration()
OutputHandler::assignOsidContext()
OutputHandler::attachToHarmoni()
OutputHandler::getHead()
OutputHandler::getOsidContext()
OutputHandler::output()
OutputHandler::setHead()

Inherited From OsidManager

OsidManager::assignConfiguration()
OsidManager::assignOsidContext()
OsidManager::getOsidContext()
OsidManager::osidVersion_2_0()

Documentation generated on Wed, 19 Sep 2007 10:23:30 -0400 by phpDocumentor 1.3.0RC3