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.

static bool
isAvailable()

No description

void
setImportOptions(ServerRequest $request)

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

static bool isAvailable()

No description

Return Value

bool

abstract void setImportOptions(ServerRequest $request)

No description

Parameters

ServerRequest $request

Return Value

void