abstract class SchemaPlugin implements Plugin (View source)

Provides a common interface that will have to be implemented by all of the schema export plugins. Some of the plugins will also implement other public methods, but those are not declared here, because they are not implemented by all export plugins.

Properties

protected SchemaPluginProperties $properties

Object containing the specific schema export plugin type properties.

Methods

__construct()

No description

void
init()

Plugin specific initializations.

getProperties()

Gets the export specific format plugin properties

setProperties()

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

array
getExportInfo(DatabaseName $db)

No description

void
addCommonOptions(OptionsPropertyMainGroup $propertyGroup)

Adds export options common to all plugins.

array
getPaperSizeArray()

Returns the array of paper sizes

static bool
isAvailable()

No description

Details

final __construct()

No description

protected void init()

Plugin specific initializations.

Return Value

void

PluginPropertyItem getProperties()

Gets the export specific format plugin properties

Return Value

PluginPropertyItem

abstract protected SchemaPluginProperties setProperties()

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

Return Value

SchemaPluginProperties

abstract array getExportInfo(DatabaseName $db)

No description

Parameters

DatabaseName $db

Return Value

array

protected void addCommonOptions(OptionsPropertyMainGroup $propertyGroup)

Adds export options common to all plugins.

Parameters

OptionsPropertyMainGroup $propertyGroup

property group

Return Value

void

protected array getPaperSizeArray()

Returns the array of paper sizes

Return Value

array

array of paper sizes

static bool isAvailable()

No description

Return Value

bool