phpBB API Documentation
Interface

phpbb\db\extractor\extractor_interface

interface extractor_interface

Database extractor interface

Methods

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

Start the extraction of the database

null write_start($table_prefix)

Writes header comments to the database backup

null write_end()

Closes file and/or dumps download data

null write_table($table_name)

Extracts database table structure

null write_data($table_name)

Extracts data from database table

null flush(string $data)

Writes data to file/download content

Details

at line 35
public 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 when $format is invalid

at line 44
public null write_start($table_prefix)

Writes header comments to the database backup

Parameters

$table_prefix

Return Value

null

Exceptions

extractor_not_initialized_exception when calling this function before init_extractor()

at line 52
public null write_end()

Closes file and/or dumps download data

Return Value

null

Exceptions

extractor_not_initialized_exception when calling this function before init_extractor()

at line 61
public null write_table($table_name)

Extracts database table structure

Parameters

$table_name

Return Value

null

Exceptions

extractor_not_initialized_exception when calling this function before init_extractor()

at line 70
public null write_data($table_name)

Extracts data from database table

Parameters

$table_name

Return Value

null

Exceptions

extractor_not_initialized_exception when calling this function before init_extractor()

at line 79
public null flush(string $data)

Writes data to file/download content

Parameters

string $data

Return Value

null

Exceptions

extractor_not_initialized_exception when calling this function before init_extractor()