dcIeModule Class Reference

Inheritance diagram for dcIeModule:

Public Member Functions
	__construct ()
	init ()
	getURL (bool $escape=false)
	process (string $do)
	gui ()

Data Fields
	$type
	$id
	$name
	$description

Protected Member Functions
	setInfo ()
	progressBar (float $percent)
	autoSubmit ()
	congratMessage ()

Protected Attributes
	$import_url
	$export_url
	$url

Constructor & Destructor Documentation

__construct()

__construct

(

)

Constructs a new instance.

Exceptions

Exception

References setInfo().

Member Function Documentation

init()

init

(

)

Initializes the module.

Reimplemented in dcImportDC1, and dcImportWP.

setInfo()

setInfo ( )

abstractprotected

Sets the module information.

Reimplemented in dcExportFlat, dcImportDC1, dcImportFeed, dcImportFlat, and dcImportWP.

Referenced by __construct().

getURL()

getURL ( bool  $escape = false )

final

Gets the module URL.

Parameters

bool

$escape

The escape

Returns

string The url.

References $url, and html\escapeHTML().

Referenced by dcExportFlat\gui(), dcImportFeed\gui(), dcImportFlat\gui(), dcImportDC1\guiprocess(), dcImportWP\guiprocess(), dcImportDC1\imForm(), dcImportWP\imForm(), dcExportFlat\process(), dcImportFeed\process(), and dcImportFlat\process().

process()

process ( string  $do )

abstract

Processes the import/export.

Parameters

string

$do

action

Reimplemented in dcExportFlat, dcImportDC1, dcImportFeed, dcImportFlat, and dcImportWP.

gui()

gui ( )

abstract

GUI for import/export module

Reimplemented in dcExportFlat, dcImportDC1, dcImportFeed, dcImportFlat, and dcImportWP.

progressBar()

progressBar ( float  $percent )

protected

Return a progress bar

Parameters

float

$percent

The percent

Returns

string

Referenced by dcImportDC1\guiprocess(), and dcImportWP\guiprocess().

autoSubmit()

autoSubmit ( )

protected

Return a hidden autosubmit input field

Returns

string

References form\hidden().

Referenced by dcImportDC1\gui(), and dcImportWP\gui().

congratMessage()

congratMessage ( )

protected

Return a congratulation message

Returns

string

References dcCore\app().

Referenced by dcImportDC1\gui(), and dcImportWP\gui().

Field Documentation

$type

$type

$id

$id

Referenced by maintenanceDcExportFlat\setURL().

$name

$name

$description

$description

$import_url

$import_url

protected

$export_url

$export_url

protected

$url

$url

protected

Referenced by getURL(), dcImportDC1\importPings(), and dcImportWP\importPings().

---

The documentation for this class was generated from the following file:

• plugins/importExport/inc/class.dc.ieModule.php