The component of this Theme.

• access: private

This array will store the pre-HTML strings for the different component types. The first dimension is the component type. The second dimension is the index.

• var: _componentPreHTML
• access: private

The description of this Theme.

• var: _description
• access: private

An array storing global style collections. It is one-dimensional. The key is the selector of the style collection. The element is the style collection itself.

• var: _globalStyles
• access: private

• var: the id of the theme
• since: 5/1/06
• access: private

This array stores the names of the methods that will be run after importing of registered

StyleProperties

.

• var: _postImportMethods
• access: private

StyleProperties

This array combines

_componentStyles

and

_globalStyles

into one. The purpose is to avoid duplication of style collection and to provide an easy way to implement the

getCSS()

method.

• var: _styles
• access: private

Attaches to the Theme a style collection that will have a global effect on the page look and feel. For example, this could be a style collection affecting the

body

HTML element.

• access: public

• ref $styleCollection: object styleCollection The style collection to attach.

---

ThemeInterface::addGlobalStyle()

Attaches to the Theme a style collection that will have a global effect on the page look and feel. For example, this could be a style collection affecting the

body

HTML element.

This method is like

exportRegisteredSP

but exports all registered stlye properties at the same time. The output is an array whose elements are the inividual export data as returned by

exportRegisteredSP

.

• return: An array containing the export data for each registered

  StylePorperty
  

  . The indexes of the array are the ids of the style properties.
• access: public

---

ThemeInterface::exportAllRegisteredSPs()

This method is like

exportRegisteredSP

but exports all registered stlye properties at the same time. The output is an array whose elements are the inividual export data as returned by

exportRegisteredSP

.

importRegisteredSP()

StyleProperty

Returns all registered mutable style properties in an array whose indexes are the ids of the style properties (as returned by

registerSP()

).

• return: array An array containing all registered mutable

  StyleProperty
  

  objects.
• access: public

---

ThemeInterface::getAllRegisteredSPs()

Returns all registered mutable style properties in an array whose indexes are the ids of the style properties (as returned by

registerSP()

).

Returns the component of this

Theme

.

• return: object The component of this

  Theme
  

  .
• access: public

---

ThemeInterface::getComponent()

Returns the component of this

Theme

.

Answers the customization level for the theme

• since: 4/26/06
• access: public

Returns the display name of this Theme.

• return: The display name of this Theme.
• access: public

---

ThemeInterface::getDisplayName()

Returns the display name of this Theme.

Answers the id

• since: 4/26/06
• access: public

addStyleForComponentType()

getStylesForComponentType()

Returns the HTML string that needs to be printed before an attempt is made to render components of the given type and index. Note: use of the PreHTML and PostHTML get/set methods is discouraged - use styles instead: see

addStyleForComponentType()

and

getStylesForComponentType()

.

• return: The HTML string.
• access: public

• integer $type: type The type of the component. One of BLANK, HEADING, HEADER, FOOTER, BLOCK, MENU, MENU_ITEM_LINK_UNSELECTED, MENU_ITEM_LINK_SELECTED, MENU_ITEM_HEADING, OTHER.
• integer $index: index The index that will determine which HTML string to return If the given index is greater than the maximal registered index for the given component type, then the highest index availible will be used.

---

ThemeInterface::getPreHTMLForComponentType()

Returns the HTML string that needs to be printed before an attempt is made to render components of the given type and index. Note: use of the PreHTML and PostHTML get/set methods is discouraged - use styles instead: see

addStyleForComponentType()

and

getStylesForComponentType()

.

registerSP()

Returns the StyleCollection with the given selector

• return: object StyleCollection
• access: public

• string $selector: the selector of the StyleCollection

This method returns all style collections for the given component type and the given numeric index.

Each

Theme

has a set of style collections that correspond to a combination of a component type and a numeric index. For example, the user can define two style collections for components of type BLOCK and index 1 and a totally different set of three style collections for componets of type MENU and index 2.

The index has no semantic meaning: you can think of the index as 'level' of the component. Alternatively, the index could serve as means of distinguishing between components with the same type. For example, a BLOCK component with index 2 will normally have a different set of style collections than a BLOCK component with index 1.

Another way of interpreting the index is drawing a parallel to the HTML headings <h1>, <h2>, <h3>, ..., where the lower the index, the more "prominent" the look of the component.

The style collections would be normally set by the

setStyleForComponentType()

method in the Theme constructor.

• return: array An array of Style Collections.
• access: public

• integer $type: type The type of the component. One of BLANK, HEADING, HEADER, FOOTER, BLOCK, MENU, MENU_ITEM_LINK_UNSELECTED, MENU_ITEM_LINK_SELECTED, MENU_ITEM_HEADING, OTHER.
• integer $index: index The index that will determine which style collections to return. If the given index is greater than the maximum registered index for the given component type, then the highest index availible will be used.

---

ThemeInterface::getStylesForComponentType()

This method returns all style collections for the given component type and the given numeric index.

Imports the contents of a registered mutable

StyleProperty

.

The input to this method should be an output obtained from calling

exportRegisteredSP

on the same

StyleProperty

.

• return: object The updated

  StyleProperty
  

  object.
• access: public

• integer $id: id The id of the

  StyleProperty
  

  as returned by

  registerSP()
  

  .
• mixed $importData: importData The contens of the

  StyleProperty
  

  as exported by

  exportRegisteredSP()
  

  .

---

ThemeInterface::importRegisteredSP()

Imports the contents of a registered mutable

StyleProperty

.

Adds the given StyleProperty to the internally maintained list of mutable

(updateable) style properties and assigns it an id. This method and the

getRegisteredSP

method enable the user to quickly change the values of key Theme settings. For example, let us assume that Bob has created his own theme and he has added a global style collection for the main content block. Bob would like to allow the user to change the width property of that collection. In order to do so, Bob needs to call

registerSP()

and pass the WidthSP object accordingly. This WidthSP object must be the same object that had been added to the aforementioned global style collection. The user now can call

getRegisteredSP

with the id that was returned by

registerSP

and access/modify the

WidthSP

object.

• return: An integer id assigned to the given style property. The id only meaningful within the context of this Theme (i.e. this is not a system wide unique id).
• access: public

• ref $sp: object sp The StyleProperty object that will be registered as mutable within this Theme.
• optional $postImportMethod: string postImportMethod This is the name of the method that will be called after this SP is imported (an optional argument). This can be useful in case other properties depend on the content of this property, but the user does not to export all of them.

---

ThemeInterface::registerSP()

Adds the given StyleProperty to the internally maintained list of mutable

Sets the component of this

Theme

.

• access: public

• ref $component: object A component.

---

ThemeInterface::setComponent()

Sets the component of this

Theme

.

---

• DobomodeTheme::setComponent() : Overloads the normal

  setComponent
  

  method - sets the Theme component to the wrapper component and adds the argument to the latter.

Sets the description of this Theme.

• access: public

• string $description: description The new description of this Theme.

---

ThemeInterface::setDescription()

Sets the description of this Theme.

Sets the id

• since: 4/26/06
• access: public

• string $id

addStyleForComponentType()

getStylesForComponentType()

Sets the HTML string that needs to be printed before an attempt is made to render components of the given type and index. Note: use of the PreHTML and PostHTML get/set methods is discouraged - use styles instead: see

addStyleForComponentType()

and

getStylesForComponentType()

.

• access: public

• string $html: html The HTML code to use.
• integer $type: type The type of the component. One of BLANK, HEADING, HEADER, FOOTER, BLOCK, MENU, MENU_ITEM_LINK_UNSELECTED, MENU_ITEM_LINK_SELECTED, MENU_ITEM_HEADING, OTHER.
• integer $index: index The index with which to register the HTML string. For a description of the role of indices, see the documentation of

  getStylesForComponentType()
  

  .

---

ThemeInterface::setPreHTMLForComponentType()

Sets the HTML string that needs to be printed before an attempt is made to render components of the given type and index. Note: use of the PreHTML and PostHTML get/set methods is discouraged - use styles instead: see

addStyleForComponentType()

and

getStylesForComponentType()

.

A private function that returns all style collections for the given component and any subcomponents it might have.

• return: The CSS code.
• access: public

• ref $component: object component The component to start at.
• array $result: result This array will be recursively filled with all the style collections.