phpBB API Documentation
Class

phpbb\db\extractor\base_extractor

abstract class base_extractor implements extractor_interface

Abstract base class for database extraction

Methods

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

Constructor

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

Start the extraction of the database

null write_end()

Closes file and/or dumps download data

null flush(string $data)

Writes data to file/download content

Details

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

Constructor

Parameters

string $phpbb_root_path
request_interface $request
driver_interface $db

at line 104
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 183
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 212
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()