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. |
|
| static ExportType | $exportType | ||
| static bool | $singleTable | ||
| protected StructureOrData | $structureOrData |
Methods
Outputs export header
Outputs export footer
Outputs database header
Outputs database footer
Outputs CREATE DATABASE statement
Outputs the content of a table
Exports routines (procedures and functions)
Exports events
Outputs for raw query
Outputs table's structure
Exports metadata from Configuration Storage
Returns a stand-in CREATE definition to resolve view dependencies
Plugin specific initializations.
Gets the export specific format plugin properties
Sets the export plugins properties and is implemented by each export plugin.
Initialize aliases
Search for alias of a identifier.
Gives the relation string and also substitutes with alias if required in this format: [Foreign Table] ([Foreign Field])
No description
No description
No description
Returns locale string for $text or $text if no locale is found
Details
final
__construct(Relation $relation, Export $export, Transformations $transformations)
No description
abstract bool
exportHeader()
Outputs export header
abstract bool
exportFooter()
Outputs export footer
abstract bool
exportDBHeader(string $db, string $dbAlias = '')
Outputs database header
abstract bool
exportDBFooter(string $db)
Outputs database footer
abstract bool
exportDBCreate(string $db, string $dbAlias = '')
Outputs CREATE DATABASE statement
abstract bool
exportData(string $db, string $table, 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|null $db, string $sqlQuery)
Outputs for raw query
bool
exportStructure(string $db, string $table, string $exportMode, 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, array $aliases = [])
Returns a stand-in CREATE definition to resolve view dependencies
protected void
init()
Plugin specific initializations.
PluginPropertyItem
getProperties()
Gets the export specific format plugin properties
abstract protected ExportPluginProperties
setProperties()
Sets the export plugins properties and is implemented by each export plugin.
void
initAlias(array $aliases, string $db, string|null $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
abstract void
setExportOptions(ServerRequest $request, array $exportConfig)
No description
StructureOrData
getStructureOrData()
No description
protected StructureOrData
setStructureOrData(mixed $valueFromRequest, mixed $valueFromConfig, StructureOrData $defaultValue)
No description
string
getTranslatedText(string $text)
Returns locale string for $text or $text if no locale is found