1. class
  2. phpbb
  3. \
  4. db
  5. \
  6. extractor
  7. \
  8. mysql_extractor

mysql_extractor

class mysql_extractor extends base_extractor

Properties

protected string $phpbb_root_path from  base_extractor
protected request_interface $request from  base_extractor
protected driver_interface $db from  base_extractor
protected bool $download from  base_extractor
protected bool $store from  base_extractor
protected int $time from  base_extractor
protected string $format from  base_extractor
protected resource $fp from  base_extractor
protected string $write from  base_extractor
protected string $close from  base_extractor
protected bool $run_comp from  base_extractor
protected bool $is_initialized from  base_extractor

Methods

__construct(string $phpbb_root_path, request_interface $request, driver_interface $db)

Constructor

from  base_extractor
null
init_extractor(string $format, string $filename, int $time, bool $download = false, bool $store = false)

Start the extraction of the database

from  base_extractor
null
write_end()

Closes file and/or dumps download data

from  base_extractor
null
flush(string $data)

Writes data to file/download content

from  base_extractor
null
write_start(string $table_prefix)

Writes header comments to the database backup

null
write_table(string $table_name)

Extracts database table structure

null
write_data(string $table_name)

Extracts data from database table

null
write_data_mysqli(string $table_name)

Extracts data from database table (for MySQLi driver)

null
new_write_table(string $table_name)

Extracts database table structure (for MySQLi or MySQL 3.23.20+)

null
old_write_table(string $table_name)

Extracts database table structure (for MySQL versions older than 3.23.20)

Details

in base_extractor at line 91
__construct(string $phpbb_root_path, request_interface $request, driver_interface $db)

Constructor

Parameters

string $phpbb_root_path
request_interface $request
driver_interface $db

in base_extractor at line 104
null init_extractor(string $format, string $filename, int $time, bool $download = false, bool $store = false)

Start the extraction of the database

This function initialize the database extraction. It is required to call this function before calling any other extractor functions.

Parameters

string $format
string $filename
int $time
bool $download
bool $store

Return Value

null

Exceptions

invalid_format_exception

in base_extractor at line 183
null write_end()

Closes file and/or dumps download data

Return Value

null

Exceptions

extractor_not_initialized_exception

in base_extractor at line 212
null flush(string $data)

Writes data to file/download content

Parameters

string $data

Return Value

null

Exceptions

extractor_not_initialized_exception

at line 23
null write_start(string $table_prefix)

Writes header comments to the database backup

Parameters

string $table_prefix

prefix of phpBB database tables

Return Value

null

Exceptions

extractor_not_initialized_exception

at line 41
null write_table(string $table_name)

Extracts database table structure

Parameters

string $table_name

name of the database table

Return Value

null

Exceptions

extractor_not_initialized_exception

at line 75
null write_data(string $table_name)

Extracts data from database table

Parameters

string $table_name

name of the database table

Return Value

null

Exceptions

extractor_not_initialized_exception

at line 92
protected null write_data_mysqli(string $table_name)

Extracts data from database table (for MySQLi driver)

Parameters

string $table_name

name of the database table

Return Value

null

Exceptions

extractor_not_initialized_exception

at line 182
protected null new_write_table(string $table_name)

Extracts database table structure (for MySQLi or MySQL 3.23.20+)

Parameters

string $table_name

name of the database table

Return Value

null

Exceptions

extractor_not_initialized_exception

at line 207
protected null old_write_table(string $table_name)

Extracts database table structure (for MySQL versions older than 3.23.20)

Parameters

string $table_name

name of the database table

Return Value

null

Exceptions

extractor_not_initialized_exception