1. class
  2. PhpMyAdmin
  3. \
  4. Plugins
  5. \
  6. ExportPlugin

ExportPlugin

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(Relation $relation, Export $export, Transformations $transformations)

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 $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|null $db, string $sqlQuery)

Outputs for raw query

bool
exportStructure(string $db, string $table, 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|string[] $tables, array $metadataTypes)

Exports metadata from Configuration Storage

string
getTableDefStandIn(string $db, string $view, 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.

PluginPropertyItem
getProperties()

Gets the export specific format plugin properties

ExportPluginProperties
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])

static bool
isAvailable()

No description

Details

at line 42
final __construct(Relation $relation, Export $export, Transformations $transformations)

No description

Parameters

Relation $relation
Export $export
Transformations $transformations

at line 54
abstract bool exportHeader()

Outputs export header

Return Value

bool

at line 59
abstract bool exportFooter()

Outputs export footer

Return Value

bool

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

Outputs database header

Parameters

string $db

Database name
string $dbAlias

Aliases of db

Return Value

bool

at line 74
abstract bool exportDBFooter(string $db)

Outputs database footer

Parameters

string $db

Database name

Return Value

bool

at line 83
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

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

Outputs the content of a table

Parameters

string $db

database name
string $table

table name
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

at line 113
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

at line 123
bool exportEvents(string $db)

Exports events

Parameters

string $db Database

Return Value

bool

at line 135
bool exportRawQuery(string $errorUrl, string|null $db, string $sqlQuery)

Outputs for raw query

Parameters

string $errorUrl

the url to go back in case of error
string|null $db

the database where the query is executed
string $sqlQuery

the rawquery to output

Return Value

bool

at line 159
bool exportStructure(string $db, string $table, 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 $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

at line 181
bool exportMetadata(string $db, string|string[] $tables, array $metadataTypes)

Exports metadata from Configuration Storage

Parameters

string $db

database being exported
string|string[] $tables

table(s) being exported
array $metadataTypes

types of metadata to export

Return Value

bool

at line 198
string getTableDefStandIn(string $db, string $view, array $aliases = [])

Returns a stand-in CREATE definition to resolve view dependencies

Parameters

string $db

the database name
string $view

the view name
array $aliases

Aliases of db/table/columns

Return Value

string

resulting definition

at line 211
protected string getTriggers(string $db, string $table)

Outputs triggers

Parameters

string $db

database name
string $table

table name

Return Value

string

Formatted triggers list

at line 219
protected void init()

Plugin specific initializations.

Return Value

void

at line 228
PluginPropertyItem getProperties()

Gets the export specific format plugin properties

Return Value

PluginPropertyItem

at line 236
abstract protected ExportPluginProperties setProperties()

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

Return Value

ExportPluginProperties

at line 252
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

at line 277
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 ''

at line 339
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

at line 363
static bool isAvailable()

No description

Return Value

bool