abstract class ImportPlugin implements Plugin (View source)

Provides a common interface that will have to be implemented by all of the import plugins.

Properties

protected ImportPluginProperties $properties

Object containing the import plugin properties.

protected Import $import

Methods

__construct()

No description

void
init()

Plugin specific initializations.

array
doImport(File|null $importHandle = null)

Handles the whole import logic

getProperties()

Gets the import specific format plugin properties

setProperties()

Sets the export plugins properties and is implemented by each import plugin.

array
getDbnameAndOptions(string $currentDb, string $defaultDb)

Define DB name and options

static bool
isAvailable()

No description

Details

final __construct()

No description

protected void init()

Plugin specific initializations.

Return Value

void

abstract array doImport(File|null $importHandle = null)

Handles the whole import logic

Parameters

File|null $importHandle

Return Value

array

PluginPropertyItem getProperties()

Gets the import specific format plugin properties

Return Value

PluginPropertyItem

abstract protected ImportPluginProperties setProperties()

Sets the export plugins properties and is implemented by each import plugin.

Return Value

ImportPluginProperties

protected array getDbnameAndOptions(string $currentDb, string $defaultDb)

Define DB name and options

Parameters

string $currentDb DB
string $defaultDb

Default DB name

Return Value

array

DB name and options (an associative array of options)

static bool isAvailable()

No description

Return Value

bool