Docs For Class CMS_moduleClientspace

Description

Class CMS_moduleClientspace

represent a module client space Abstract class

author: Antoine Pouch <antoine.pouch@ws-interactive.fr>

Located in /automne/classes/modules/moduleclientspace.php (line 28)

CMS_grandFather
   |
   --CMS_moduleClientspace

Direct descendents

Class	Description
CMS_moduleClientspace_standard	Class CMS_moduleClientspace_standard

Method Summary

void __construct (integer $attributes)

string getClientspaceData (string $codename, CMS_language &$language, CMS_page &$page, integer $visualizationMode)

string getData (CMS_language &$language, CMS_page &$page, integer $visualizationMode)

string, getRawData (CMS_language &$language, CMS_page &$page, integer $visualizationMode, [boolean $templateHasPages = false])

integer getTagID ()

string _parseTemplateForParameters (string $filename)

Methods

Constructor __construct (line 51)

Constructor.

access: public

void __construct (integer $attributes)

integer $attributes: The attributes of the clientSpace Tag

Redefined in descendants as:

CMS_moduleClientspace_standard::__construct() : Constructor.

getClientspaceData (line 109)

Gets the data from the module

return: the data from the rows.
access: public

string getClientspaceData (string $codename, CMS_language &$language, CMS_page &$page, integer $visualizationMode)

string $codename: The module codename
CMS_language &$language: The language of the administration frontend
CMS_page &$page: the page parsed
integer $visualizationMode: the visualization mode

getData (line 81)

Gets the data from the module

return: the data from the rows.
access: public

string getData (CMS_language &$language, CMS_page &$page, integer $visualizationMode)

CMS_language &$language: The language of the administration frontend
CMS_page &$page: the page parsed
integer $visualizationMode: the visualization mode

Redefined in descendants as:

CMS_moduleClientspace_standard::getData() : Gets the data from the rows, using the specified visualization mode.

getRawData (line 95)

Gets the data from all rows

return: The data returned by all rows as a string
access: public

string, getRawData (CMS_language &$language, CMS_page &$page, integer $visualizationMode, [boolean $templateHasPages = false])

CMS_language &$language: The language of the administration frontend
CMS_page &$page: the page parsed
integer $visualizationMode: the visualization mode
boolean $templateHasPages: don't display forms if set to true

Redefined in descendants as:

CMS_moduleClientspace_standard::getRawData() : Gets the data from all rows after initialized

getTagID (line 67)

Gets the tag ID.

return: the tag ID attribute
access: public

integer getTagID ()

Redefined in descendants as:

CMS_moduleClientspace_standard::getTagID() : Gets the tag ID.

_parseTemplateForParameters (line 152)

Parse the content of a template for module parameters and returns the content.

Usually used by the getData() function to handle template files and feed them with module parameters

return: the data from the rows.
access: private

string _parseTemplateForParameters (string $filename)

string $filename: The filename of the template, located in the templates directory

Inherited Methods

Inherited From CMS_grandFather

CMS_grandFather::autoload()
CMS_grandFather::hasError()
CMS_grandFather::log()
CMS_grandFather::PHPErrorHandler()
CMS_grandFather::raiseError()
CMS_grandFather::setDebug()
CMS_grandFather::setLog()
CMS_grandFather::_raiseError()
CMS_grandFather::__call()

Class Constants

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL