Class CMS_module_export

Description
Description | Methods (details) Constants (details)

Class CMS_module_export

Export datas from modules

Located in /automne/classes/modules/export.php (line 24) 

CMS_grandFather
   |
   --CMS_module_export
Class Constant Summary
Description | Constants (details) | Methods (details)
MESSAGE_PARAM_CATEGORIES = 1668
MESSAGE_PARAM_CSS = 1670
MESSAGE_PARAM_JS = 1671
MESSAGE_PARAM_OBJECTS = 1667
MESSAGE_PARAM_ROWS = 1669
Method Summary
Description | Constants (details) Methods (details)
void __construct ( $codename, string $codename,)
mixed export ([ $format = 'php'], string $format,)
array getAvailableParameters ( $cms_language, CMS_language $cms_language,)
array getDefaultParameters ()
mixed getParameter ( $parameter, string $parameter,)
array getParameters ()
boolean hasExport ()
void setParameter ( $parameter,  $value, string $parameter,, mixed $value,)
void setParameters ( $parameters, array $parameters,)
Methods
Description | Constants (details) Methods (details)
Constructor __construct (line 76)

Constructor

void __construct ( $codename, string $codename,)
  • string $codename,: the codename of the module to export datas
  • $codename
export (line 177)

Export module datas

  • return: : the exported datas
mixed export ([ $format = 'php'], string $format,)
  • string $format,: the export format in : php (default), xml, patch
  • $format
getAvailableParameters (line 163)

Get all available parameters names and labels

  • return: : the parameters names and labels
array getAvailableParameters ( $cms_language, CMS_language $cms_language,)
  • CMS_language $cms_language,: the label language
  • $cms_language
getDefaultParameters (line 153)

Get all default parameters (parameters which are set if no parameter exists for them)

  • return: : the default parameters names
array getDefaultParameters ()
getParameter (line 122)

Get export parameter

  • return: : the current parameter value
mixed getParameter ( $parameter, string $parameter,)
  • string $parameter,: the parameter name to get
  • $parameter
getParameters (line 144)

Get all export parameter

  • return: : the current parameters values
array getParameters ()
hasExport (line 101)

Does current element has datas to export

boolean hasExport ()
setParameter (line 112)

Set export parameter

void setParameter ( $parameter,  $value, string $parameter,, mixed $value,)
  • string $parameter,: the parameter name to set
  • mixed $value,: the parameter value to set
  • $parameter
  • $value
setParameters (line 135)

Set all export parameters

void setParameters ( $parameters, array $parameters,)
  • array $parameters,: the parameters to set
  • $parameters

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
Description | Constants (details) | Methods (details)
MESSAGE_PARAM_CATEGORIES = 1668 (line 30)
MESSAGE_PARAM_CSS = 1670 (line 32)
MESSAGE_PARAM_JS = 1671 (line 33)
MESSAGE_PARAM_OBJECTS = 1667 (line 29)

Messages

MESSAGE_PARAM_ROWS = 1669 (line 31)

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
 CMS_grandFather::SYSTEM_LABEL

Documentation generated on Wed, 15 Feb 2012 15:30:13 +0100 by phpDocumentor 1.4.3