PHP Class PMA\libraries\plugins\export\ExportOdt

Inheritance: extends PMA\libraries\plugins\ExportPlugin

Show file Open project: phpmyadmin/phpmyadmin

Public Methods

Method	Description
__construct ( )	Constructor
exportDBCreate ( string $db, string $export_type, string $db_alias = '' ) : boolean	Outputs CREATE DATABASE statement
exportDBFooter ( string $db ) : boolean	Outputs database footer
exportDBHeader ( string $db, string $db_alias = '' ) : boolean	Outputs database header
exportData ( string $db, string $table, string $crlf, string $error_url, string $sql_query, array $aliases = [] ) : boolean	Outputs the content of a table in NHibernate format
exportFooter ( ) : boolean	Outputs export footer
exportHeader ( ) : boolean	Outputs export header
exportStructure ( string $db, string $table, string $crlf, string $error_url, string $export_mode, string $export_type, boolean $do_relation = false, boolean $do_comments = false, boolean $do_mime = false, boolean $dates = false, array $aliases = [] ) : boolean	Outputs table's structure
getTableDef ( string $db, string $table, string $crlf, string $error_url, boolean $do_relation, boolean $do_comments, boolean $do_mime, boolean $show_dates = false, boolean $add_semicolon = true, boolean $view = false, array $aliases = [] ) : boolean	Returns $table's CREATE definition
getTableDefStandIn ( string $db, string $view, string $crlf, array $aliases = [] ) : string	Returns a stand-in CREATE definition to resolve view dependencies

Method	Description
formatOneColumnDefinition ( array $column, string $col_as = '' ) : string	Formats the definition for one column
getTriggers ( string $db, string $table, array $aliases = [] ) : boolean	Outputs triggers
setProperties ( ) : void	Sets the export ODT properties

Constructor

public __construct ( )

Outputs CREATE DATABASE statement

public exportDBCreate ( string $db, string $export_type, string $db_alias = '' ) : boolean
$db	string	Database name
$export_type	string	'server', 'database', 'table'
$db_alias	string	Aliases of db
return	boolean	Whether it succeeded

Outputs database footer

public exportDBFooter ( string $db ) : boolean
$db	string	Database name
return	boolean	Whether it succeeded

Outputs database header

public exportDBHeader ( string $db, string $db_alias = '' ) : boolean
$db	string	Database name
$db_alias	string	Aliases of db
return	boolean	Whether it succeeded

Outputs the content of a table in NHibernate format

public exportData ( string $db, string $table, string $crlf, string $error_url, string $sql_query, array $aliases = [] ) : boolean
$db	string	database name
$table	string	table name
$crlf	string	the end of line sequence
$error_url	string	the url to go back in case of error
$sql_query	string	SQL query for obtaining data
$aliases	array	Aliases of db/table/columns
return	boolean	Whether it succeeded

Outputs export footer

public exportFooter ( ) : boolean
return	boolean	Whether it succeeded

Outputs export header

public exportHeader ( ) : boolean
return	boolean	Whether it succeeded

Outputs table's structure

public exportStructure ( string $db, string $table, string $crlf, string $error_url, string $export_mode, string $export_type, boolean $do_relation = false, boolean $do_comments = false, boolean $do_mime = false, boolean $dates = false, array $aliases = [] ) : boolean
$db	string	database name
$table	string	table name
$crlf	string	the end of line sequence
$error_url	string	the url to go back in case of error
$export_mode	string	'create_table', 'triggers', 'create_view', 'stand_in'
$export_type	string	'server', 'database', 'table'
$do_relation	boolean	whether to include relation comments
$do_comments	boolean	whether to include the pmadb-style column comments as comments in the structure; this is deprecated but the parameter is left here because export.php calls PMA_exportStructure() also for other
$do_mime	boolean	whether to include mime comments
$dates	boolean	whether to include creation/update/check dates
$aliases	array	Aliases of db/table/columns
return	boolean	Whether it succeeded

Formats the definition for one column

protected formatOneColumnDefinition ( array $column, string $col_as = '' ) : string
$column	array	info about this column
$col_as	string	column alias
return	string	Formatted column definition

Returns $table's CREATE definition

public getTableDef ( string $db, string $table, string $crlf, string $error_url, boolean $do_relation, boolean $do_comments, boolean $do_mime, boolean $show_dates = false, boolean $add_semicolon = true, boolean $view = false, array $aliases = [] ) : boolean
$db	string	the database name
$table	string	the table name
$crlf	string	the end of line sequence
$error_url	string	the url to go back in case of error
$do_relation	boolean	whether to include relation comments
$do_comments	boolean	whether to include the pmadb-style column comments as comments in the structure; this is deprecated but the parameter is left here because export.php calls PMA_exportStructure() also for other
$do_mime	boolean	whether to include mime comments
$show_dates	boolean	whether to include creation/update/check dates
$add_semicolon	boolean	whether to add semicolon and end-of-line at the end
$view	boolean	whether we're handling a view
$aliases	array	Aliases of db/table/columns
return	boolean	true

Returns a stand-in CREATE definition to resolve view dependencies

public getTableDefStandIn ( string $db, string $view, string $crlf, array $aliases = [] ) : string
$db	string	the database name
$view	string	the view name
$crlf	string	the end of line sequence
$aliases	array	Aliases of db/table/columns
return	string	resulting definition

Outputs triggers

protected getTriggers ( string $db, string $table, array $aliases = [] ) : boolean
$db	string	database name
$table	string	table name
$aliases	array	Aliases of db/table/columns
return	boolean	true

Sets the export ODT properties

protected setProperties ( ) : void
return	void