abstract class ExportPlugin implements Plugin (View source)

Provides a common interface that will have to be implemented by all of the 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 ExportPluginProperties $properties

Object containing the specific export plugin type properties.

Relation $relation
protected Export $export
protected Transformations $transformations

Methods

__construct()

No description

bool
exportHeader()

Outputs export header

bool
exportFooter()

Outputs export footer

bool
exportDBHeader(string $db, string $dbAlias = '')

Outputs database header

bool
exportDBFooter(string $db)

Outputs database footer

bool
exportDBCreate(string $db, string $exportType, string $dbAlias = '')

Outputs CREATE DATABASE statement

bool
exportData(string $db, string $table, string $crlf, string $errorUrl, string $sqlQuery, array $aliases = [])

Outputs the content of a table

bool
exportRoutines(string $db, array $aliases = [])

Exports routines (procedures and functions)

bool
exportEvents(string $db)

Exports events

bool
exportRawQuery(string $errorUrl, string $sqlQuery, string $crlf)

Outputs for raw query

bool
exportStructure(string $db, string $table, string $crlf, string $errorUrl, string $exportMode, string $exportType, bool $relation = false, bool $comments = false, bool $mime = false, bool $dates = false, array $aliases = [])

Outputs table's structure

bool
exportMetadata(string $db, string|array $tables, array $metadataTypes)

Exports metadata from Configuration Storage

string
getTableDefStandIn(string $db, string $view, string $crlf, array $aliases = [])

Returns a stand-in CREATE definition to resolve view dependencies

string
getTriggers(string $db, string $table)

Outputs triggers

void
init()

Plugin specific initializations.

getProperties()

Gets the export specific format plugin properties

setProperties()

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

void
initAlias(array $aliases, string $db, string $table = null)

Initialize aliases

string
getAlias(array $aliases, string $id, string $type = 'dbtblcol', string $db = '', string $tbl = '')

Search for alias of a identifier.

string
getRelationString(array $foreigners, string $fieldName, string $db, array $aliases = [])

Gives the relation string and also substitutes with alias if required in this format: [Foreign Table] ([Foreign Field])

bool
isAvailable()

No description

Details

final __construct()

No description

abstract bool exportHeader()

Outputs export header

Return Value

bool

abstract bool exportFooter()

Outputs export footer

Return Value

bool

abstract bool exportDBHeader(string $db, string $dbAlias = '')

Outputs database header

Parameters

string $db

Database name

string $dbAlias

Aliases of db

Return Value

bool

abstract bool exportDBFooter(string $db)

Outputs database footer

Parameters

string $db

Database name

Return Value

bool

abstract bool exportDBCreate(string $db, string $exportType, string $dbAlias = '')

Outputs CREATE DATABASE statement

Parameters

string $db

Database name

string $exportType

'server', 'database', 'table'

string $dbAlias

Aliases of db

Return Value

bool

abstract bool exportData(string $db, string $table, string $crlf, string $errorUrl, string $sqlQuery, array $aliases = [])

Outputs the content of a table

Parameters

string $db

database name

string $table

table name

string $crlf

the end of line sequence

string $errorUrl

the url to go back in case of error

string $sqlQuery

SQL query for obtaining data

array $aliases

Aliases of db/table/columns

Return Value

bool

bool exportRoutines(string $db, array $aliases = [])

Exports routines (procedures and functions)

Parameters

string $db

Database

array $aliases

Aliases of db/table/columns

Return Value

bool

bool exportEvents(string $db)

Exports events

Parameters

string $db

Database

Return Value

bool

bool exportRawQuery(string $errorUrl, string $sqlQuery, string $crlf)

Outputs for raw query

Parameters

string $errorUrl

the url to go back in case of error

string $sqlQuery

the rawquery to output

string $crlf

the seperator for a file

Return Value

bool

bool exportStructure(string $db, string $table, string $crlf, string $errorUrl, string $exportMode, string $exportType, bool $relation = false, bool $comments = false, bool $mime = false, bool $dates = false, array $aliases = [])

Outputs table's structure

Parameters

string $db

database name

string $table

table name

string $crlf

the end of line sequence

string $errorUrl

the url to go back in case of error

string $exportMode

'create_table','triggers','create_view', 'stand_in'

string $exportType

'server', 'database', 'table'

bool $relation

whether to include relation comments

bool $comments

whether to include the pmadb-style column comments as comments in the structure; this is deprecated but the parameter is left here because /export calls exportStructure() also for other export types which use this parameter

bool $mime

whether to include mime comments

bool $dates

whether to include creation/update/check dates

array $aliases

Aliases of db/table/columns

Return Value

bool

bool exportMetadata(string $db, string|array $tables, array $metadataTypes)

Exports metadata from Configuration Storage

Parameters

string $db

database being exported

string|array $tables

table(s) being exported

array $metadataTypes

types of metadata to export

Return Value

bool

string getTableDefStandIn(string $db, string $view, string $crlf, array $aliases = [])

Returns a stand-in CREATE definition to resolve view dependencies

Parameters

string $db

the database name

string $view

the view name

string $crlf

the end of line sequence

array $aliases

Aliases of db/table/columns

Return Value

string

resulting definition

protected string getTriggers(string $db, string $table)

Outputs triggers

Parameters

string $db

database name

string $table

table name

Return Value

string

Formatted triggers list

protected void init()

Plugin specific initializations.

Return Value

void

PluginPropertyItem getProperties()

Gets the export specific format plugin properties

Return Value

PluginPropertyItem

abstract protected ExportPluginProperties setProperties()

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

Return Value

ExportPluginProperties

void initAlias(array $aliases, string $db, string $table = null)

Initialize aliases

Parameters

array $aliases

Alias information for db/table/column

string $db

the database

string $table

the table

Return Value

void

string getAlias(array $aliases, string $id, string $type = 'dbtblcol', string $db = '', string $tbl = '')

Search for alias of a identifier.

Parameters

array $aliases

Alias information for db/table/column

string $id

the identifier to be searched

string $type

db/tbl/col or any combination of them representing what to be searched

string $db

the database in which search is to be done

string $tbl

the table in which search is to be done

Return Value

string

alias of the identifier if found or ''

string getRelationString(array $foreigners, string $fieldName, string $db, array $aliases = [])

Gives the relation string and also substitutes with alias if required in this format: [Foreign Table] ([Foreign Field])

Parameters

array $foreigners

the foreigners array

string $fieldName

the field name

string $db

the field name

array $aliases

Alias information for db/table/column

Return Value

string

the Relation string

bool isAvailable()

No description

Return Value

bool