ExportJson
class ExportJson extends ExportPlugin (View source)
Handles the export for the JSON 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
Outputs export header
Outputs export footer
Outputs database header
Outputs database footer
Outputs CREATE DATABASE statement
Outputs the content of a table in JSON format
Exports routines (procedures and functions)
Outputs result raw query in JSON format
Outputs table's structure
Exports metadata from Configuration Storage
Returns a stand-in CREATE definition to resolve view dependencies
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
Encodes the data into JSON
Export to JSON
Details
final
__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 $dbAlias = '')
Outputs CREATE DATABASE statement
bool
exportData(string $db, string $table, string $sqlQuery, array $aliases = [])
Outputs the content of a table in JSON format
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 result raw query in JSON format
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
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
void
setExportOptions(ServerRequest $request, array $exportConfig)
No description
StructureOrData
getStructureOrData()
No description
protected StructureOrData
setStructureOrData(mixed $valueFromRequest, mixed $valueFromConfig, StructureOrData $defaultValue)
No description
string
getName()
No description
string|false
encode(mixed $data)
Encodes the data into JSON
protected bool
doExportForQuery(DatabaseInterface $dbi, string $sqlQuery, string $buffer, array|null $aliases, string|null $db, string|null $table)
Export to JSON