Class CMS_moduleClientspace_standard

Description
Description | Methods (details) Constants

Class CMS_moduleClientspace_standard

represent a standard client space which are data containers.

Located in /automne/classes/modules/standard/clientspace.php (line 30) 

CMS_grandFather
   |
   --CMS_moduleClientspace
      |
      --CMS_moduleClientspace_standard
Method Summary
Description | Constants Methods (details)
void __construct (integer $templateID, integer $tagID, [boolean $editionMode = false], [integer $location = RESOURCE_LOCATION_USERSPACE], [boolean $public = false])
boolean addRow (integer $rowID, integer $rowTagID, integer $index)
boolean delRow (integer $rowID, integer $rowTagID)
void destroy ()
string getData (CMS_language &$language, CMS_page &$page, integer $visualizationMode, [boolean $templateHasPages = false])
string, getRawData (CMS_language &$language, CMS_page &$page, integer $visualizationMode, [boolean $templateHasPages = false])
CMS_rows getRow ( $rowID,  $rowTagID)
array(CMS_rows) getRows ()
integer getTagID ()
integer getTemplateID ()
boolean moveRow (integer $rowID, integer $rowTagID, integer $index)
boolean writeToPersistence ()
string _checkRows ([integer $location = RESOURCE_LOCATION_USERSPACE], [boolean $public = false])
string _getDataTableName (integer $location, boolean $public)
Methods
Description | Constants Methods (details)
Constructor __construct (line 72)

Constructor.

initializes the rows.

  • access: public
void __construct (integer $templateID, integer $tagID, [boolean $editionMode = false], [integer $location = RESOURCE_LOCATION_USERSPACE], [boolean $public = false])
  • integer $templateID: the DB ID of the template
  • integer $tagID: the tag ID of the client space tag
  • boolean $editionMode: true if we are in edition mode (data should be fetched from _edition table)
  • integer $location: The location we want to get the block from
  • boolean $public: The needed precision for USERSPACE location
Redefinition of:
CMS_moduleClientspace::__construct()
Constructor.
addRow (line 288)

Add a row to the client space.

  • return: true on success, false on failure.
  • access: public
boolean addRow (integer $rowID, integer $rowTagID, integer $index)
  • integer $rowID: the DB ID of the row to add
  • integer $rowTagID: the ID attribute of the row tag to add
  • integer $index: the index position of the row in the CS
delRow (line 322)

Deletes a row.

  • access: public
boolean delRow (integer $rowID, integer $rowTagID)
  • integer $rowID: the DB ID of the row to remove from the stack
  • integer $rowTagID: the ID attribute of the row tag to del
destroy (line 382)

Totally destroys the clientSpace from persistence, but not its rows.

  • access: public
void destroy ()
getData (line 212)

Gets the data from the rows, using the specified visualization mode.

  • return: the data from the rows.
  • access: public
string getData (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
Redefinition of:
CMS_moduleClientspace::getData()
Gets the data from the module
getRawData (line 249)

Gets the data from all rows after initialized

  • 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
Redefinition of:
CMS_moduleClientspace::getRawData()
Gets the data from all rows
getRow (line 191)

Gets a row in CS

  • return: the queried row
  • access: public
CMS_rows getRow ( $rowID,  $rowTagID)
  • $rowID
  • $rowTagID
getRows (line 180)

Gets the rows field

  • return: the rows
  • access: public
array(CMS_rows) getRows ()
getTagID (line 169)

Gets the tag ID.

  • return: the tag ID attribute
  • access: public
integer getTagID ()
Redefinition of:
CMS_moduleClientspace::getTagID()
Gets the tag ID.
getTemplateID (line 158)

Gets the template DB ID.

  • return: the template DB id
  • access: public
integer getTemplateID ()
moveRow (line 343)

Move a row to a given index in clientspace

  • return: true if the move is successful, false otherwise
  • access: public
boolean moveRow (integer $rowID, integer $rowTagID, integer $index)
  • integer $rowID: the ID of the row to move
  • integer $rowTagID: the ID attribute of the row tag to move
  • integer $index: the index to put row at
writeToPersistence (line 392)

Writes the clientSpace into persistence (MySQL for now).

  • return: true on success, false on failure
  • access: public
boolean writeToPersistence ()
_checkRows (line 122)

Initialize rows depending on location user space

  • return: The table name
  • access: public
string _checkRows ([integer $location = RESOURCE_LOCATION_USERSPACE], [boolean $public = false])
  • integer $location: The location we want tag definition from
  • boolean $public: The precision needed for USERSPACE location
_getDataTableName (line 94)

Gets the table name which depends of the page location

  • return: The table name
  • access: public
string _getDataTableName (integer $location, boolean $public)
  • integer $location: The location we want tag definition from
  • boolean $public: The precision needed for USERSPACE location

Inherited Methods

Inherited From CMS_moduleClientspace

CMS_moduleClientspace::__construct()
CMS_moduleClientspace::getClientspaceData()
CMS_moduleClientspace::getData()
CMS_moduleClientspace::getRawData()
CMS_moduleClientspace::getTagID()
CMS_moduleClientspace::_parseTemplateForParameters()

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
Description | Constants (details) | Methods (details)

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
 CMS_grandFather::SYSTEM_LABEL

Documentation generated on Wed, 15 Feb 2012 15:29:17 +0100 by phpDocumentor 1.4.3