Class CMS_moduleClientspace_standard_catalog

Description

Class CMS_moduleClientspace_standard_catalog

Represents a collection of standard client spaces

Located in /automne/classes/modules/standard/clientspacescatalog.php (line 27)

CMS_grandFather
   |
   --CMS_moduleClientspace_standard_catalog
Method Summary
 static boolean getByTemplateAndTagID (integer $templateID, integer $tagID, [boolean $editionMode = false])
 static boolean moveClientSpaces ( $templateID, string $locationFrom, string $locationTo, [boolean $copyOnly = false], [boolean $forceblank = false], integer $tagID)
Methods
static getByTemplateAndTagID (line 38)

Get a clientspace byt its template DB ID and tag ID

  • return: true on success, false on failure
  • access: public
static boolean getByTemplateAndTagID (integer $templateID, integer $tagID, [boolean $editionMode = false])
  • integer $templateID: the DB ID of the template
  • integer $tagID: the tag ID of the client space tag
  • boolean $editionMode: Is this a request made during editing client space ?
static moveClientSpaces (line 54)

Move the clientSpaces data from one location to another for a template

  • return: true on success, false on failure
  • access: public
static boolean moveClientSpaces ( $templateID, string $locationFrom, string $locationTo, [boolean $copyOnly = false], [boolean $forceblank = false], integer $tagID)
  • integer $tagID: the tag ID of the client space tag
  • string $locationFrom: The starting location, among the available RESOURCE_DATA_LOCATION
  • string $locationTo: The ending location, among the available RESOURCE_DATA_LOCATION
  • boolean $copyOnly: If set to true, the deletion from the originating tables and dirs won't occur
  • boolean $forceblank: If set to false, the page will be checked before removing all content of the clientspace to alert user and get confirmation. In this case, method return false until this parameter is set to true
  • $templateID

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

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