Docs For Class CMS_module

Description

Class CMS_module_import

Import datas to module

author: Sébastien Pauchet <sebastien.pauchet@ws-interactive.fr>

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

CMS_grandFather
   |
   --CMS_module_import

Class Constant Summary

MESSAGE_PARAM_CREATE = 1661

MESSAGE_PARAM_FILES = 1663

MESSAGE_PARAM_UPDATE = 1662

MESSAGE_PARAM_UPDATE_CSS = 1666

MESSAGE_PARAM_UPDATE_JS = 1665

MESSAGE_PARAM_UPDATE_ROWS = 1664

Method Summary

void __construct ()

array getAvailableParameters ( $cms_language, CMS_language $cms_language,)

array getDefaultParameters ()

mixed getParameter ( $parameter, string $parameter,)

array getParameters ()

boolean import ( $datas, [ $format = 'php'], &$cms_language, &$infos, mixed $datas,, string $format,, CMS_language $cms_language,, string $infos)

void setParameter ( $parameter, $value, string $parameter,, mixed $value,)

void setParameters ( $parameters, array $parameters,)

Methods

Constructor __construct (line 62)

Constructor

void __construct ()

getAvailableParameters (line 133)

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 123)

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

return: : the default parameters names

array getDefaultParameters ()

getParameter (line 92)

Get import parameter

return: : the current parameter value

mixed getParameter ( $parameter, string $parameter,)

string $parameter,: the parameter name to get
$parameter

getParameters (line 114)

Get all import parameter

return: : the current parameters values

array getParameters ()

import (line 150)

Import module datas

return: : the import status

boolean import ( $datas, [ $format = 'php'], &$cms_language, &$infos, mixed $datas,, string $format,, CMS_language $cms_language,, string $infos)

mixed $datas,: the import datas
string $format,: the import format in : php (default), xml
CMS_language $cms_language,: the current cms_language to use. Passed by reference to temporary overwrite it with import language
string $infos: (reference), the returned import infos
$datas
$format
&$cms_language
&$infos

setParameter (line 82)

Set import 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 105)

Set all import 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

MESSAGE_PARAM_CREATE = 1661 (line 29)

Messages

MESSAGE_PARAM_FILES = 1663 (line 31)

MESSAGE_PARAM_UPDATE = 1662 (line 30)

MESSAGE_PARAM_UPDATE_CSS = 1666 (line 34)

MESSAGE_PARAM_UPDATE_JS = 1665 (line 33)

MESSAGE_PARAM_UPDATE_ROWS = 1664 (line 32)

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL