abstract class SchemaPlugin

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 PhpMyAdmin\Properties\Plugins\SchemaPluginProperties object containing the specific schema export plugin type properties

Methods

getProperties()

Gets the export specific format plugin properties

void
setProperties()

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

bool
exportSchema(string $db)

Exports the schema into the specified format.

void
addCommonOptions(OptionsPropertyMainGroup $propertyGroup)

Adds export options common to all plugins.

array
getPaperSizeArray()

Returns the array of paper sizes

Details

at line 38
SchemaPluginProperties getProperties()

Gets the export specific format plugin properties

Return Value

SchemaPluginProperties

at line 49
abstract protected void setProperties()

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

Return Value

void

at line 58
abstract bool exportSchema(string $db)

Exports the schema into the specified format.

Parameters

string $db database name

Return Value

bool Whether it succeeded

at line 67
protected void addCommonOptions(OptionsPropertyMainGroup $propertyGroup)

Adds export options common to all plugins.

Parameters

OptionsPropertyMainGroup $propertyGroup property group

Return Value

void

at line 80
protected array getPaperSizeArray()

Returns the array of paper sizes

Return Value

array array of paper sizes