1. class
  2. PhpMyAdmin
  3. \
  4. Plugins
  5. \
  6. Export
  7. \
  8. ExportHtmlword

ExportHtmlword

class ExportHtmlword extends ExportPlugin (View source)

Handles the export for the HTML-Word format

Properties

protected ExportPluginProperties $properties

Object containing the specific export plugin type properties.

 from  ExportPlugin
static ExportType $exportType from  ExportPlugin
static bool $singleTable from  ExportPlugin
protected StructureOrData $structureOrData from  ExportPlugin

Methods

__construct(Relation $relation, Export $export, Transformations $transformations)

No description

from  ExportPlugin
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 $dbAlias = '')

Outputs CREATE DATABASE statement

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

Outputs the content of a table in HTML-Word format

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

Exports routines (procedures and functions)

from  ExportPlugin
bool
exportEvents(string $db)

Exports events

from  ExportPlugin
bool
exportRawQuery(string|null $db, string $sqlQuery)

Outputs for raw query

from  ExportPlugin
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

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

Returns a stand-in CREATE definition to resolve view dependencies

void
init()

Plugin specific initializations.

from  ExportPlugin
PluginPropertyItem
getProperties()

Gets the export specific format plugin properties

from  ExportPlugin
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

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

Search for alias of a identifier.

from  ExportPlugin
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])

from  ExportPlugin
static bool
isAvailable()

No description

from  ExportPlugin
void
setExportOptions(ServerRequest $request, array $exportConfig)

No description

StructureOrData
getStructureOrData()

No description

from  ExportPlugin
StructureOrData
setStructureOrData(mixed $valueFromRequest, mixed $valueFromConfig, StructureOrData $defaultValue)

No description

from  ExportPlugin
string
getName()

No description

string
getTableDef(string $db, string $table, array $aliases = [])

Returns $table's CREATE definition

string
getTriggers(array $triggers)

Outputs triggers

string
formatOneColumnDefinition(Column $column, array $uniqueKeys, string $colAlias = '')

Formats the definition for one column

Details

in ExportPlugin at line 39
final __construct(Relation $relation, Export $export, Transformations $transformations)

No description

Parameters

Relation $relation
Export $export
Transformations $transformations

at line 106
bool exportHeader()

Outputs export header

Return Value

bool

at line 129
bool exportFooter()

Outputs export footer

Return Value

bool

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

Outputs database header

Parameters

string $db

Database name
string $dbAlias

Aliases of db

Return Value

bool

at line 156
bool exportDBFooter(string $db)

Outputs database footer

Parameters

string $db

Database name

Return Value

bool

at line 167
bool exportDBCreate(string $db, string $dbAlias = '')

Outputs CREATE DATABASE statement

Parameters

string $db

Database name
string $dbAlias

Aliases of db

Return Value

bool

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

Outputs the content of a table in HTML-Word format

Parameters

string $db

database name
string $table

table name
string $sqlQuery

SQL query for obtaining data
array $aliases

Aliases of db/table/columns

Return Value

bool

in ExportPlugin at line 107
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

in ExportPlugin at line 117
bool exportEvents(string $db)

Exports events

Parameters

string $db Database

Return Value

bool

in ExportPlugin at line 128
bool exportRawQuery(string|null $db, string $sqlQuery)

Outputs for raw query

Parameters

string|null $db

the database where the query is executed
string $sqlQuery

the rawquery to output

Return Value

bool

at line 476
bool exportStructure(string $db, string $table, string $exportMode, array $aliases = [])

Outputs table's structure

Parameters

string $db

database name
string $table

table name
string $exportMode

'create_table', 'triggers', 'create_view', 'stand_in'
array $aliases

Aliases of db/table/columns

Return Value

bool

in ExportPlugin at line 153
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

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

in ExportPlugin at line 178
protected void init()

Plugin specific initializations.

Return Value

void

in ExportPlugin at line 187
PluginPropertyItem getProperties()

Gets the export specific format plugin properties

Return Value

PluginPropertyItem

at line 49
protected ExportPluginProperties setProperties()

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

Return Value

ExportPluginProperties

in ExportPlugin at line 211
void initAlias(array $aliases, string $db, string|null $table = null)

Initialize aliases

Parameters

array $aliases

Alias information for db/table/column
string $db

the database
string|null $table

the table

Return Value

void

in ExportPlugin at line 236
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 ''

in ExportPlugin at line 299
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

in ExportPlugin at line 323
static bool isAvailable()

No description

Return Value

bool

at line 573
void setExportOptions(ServerRequest $request, array $exportConfig)

No description

Parameters

ServerRequest $request
array $exportConfig

Return Value

void

in ExportPlugin at line 331
StructureOrData getStructureOrData()

No description

Return Value

StructureOrData

in ExportPlugin at line 336
protected StructureOrData setStructureOrData(mixed $valueFromRequest, mixed $valueFromConfig, StructureOrData $defaultValue)

No description

Parameters

mixed $valueFromRequest
mixed $valueFromConfig
StructureOrData $defaultValue

Return Value

StructureOrData

at line 44
string getName()

No description

Return Value

string

at line 313
string getTableDef(string $db, string $table, array $aliases = [])

Returns $table's CREATE definition

Parameters

string $db

the database name
string $table

the table name
array $aliases

Aliases of db/table/columns

Return Value

string

resulting schema

at line 436
protected string getTriggers(array $triggers)

Outputs triggers

Parameters

array $triggers

Return Value

string

Formatted triggers list

at line 529
protected string formatOneColumnDefinition(Column $column, array $uniqueKeys, string $colAlias = '')

Formats the definition for one column

Parameters

Column $column

info about this column
array $uniqueKeys

unique keys of the table
string $colAlias

Column Alias

Return Value

string

Formatted column definition