diff options
| author | Tristan Darricau <tristan.darricau@sensiolabs.com> | 2015-04-05 20:13:38 +0200 |
|---|---|---|
| committer | Tristan Darricau <tristan.darricau@sensiolabs.com> | 2015-04-05 20:13:38 +0200 |
| commit | 30cf75a0115c11a61d59f811ce9f6b5fece87bbf (patch) | |
| tree | c7485c2882bd1069d418fa31df1286a0c825667d /phpBB/phpbb/db/extractor/extractor_interface.php | |
| parent | c900dcdc2aadded93ae15d2def82a3738e24d342 (diff) | |
| parent | 193c5b86b4b6049a9bf5abc5251d5479493a10df (diff) | |
| download | forums-30cf75a0115c11a61d59f811ce9f6b5fece87bbf.tar forums-30cf75a0115c11a61d59f811ce9f6b5fece87bbf.tar.gz forums-30cf75a0115c11a61d59f811ce9f6b5fece87bbf.tar.bz2 forums-30cf75a0115c11a61d59f811ce9f6b5fece87bbf.tar.xz forums-30cf75a0115c11a61d59f811ce9f6b5fece87bbf.zip | |
Merge pull request #3430 from MateBartus/ticket/12466
[ticket/12466] Move classes from acp_database.php to their own files
Diffstat (limited to 'phpBB/phpbb/db/extractor/extractor_interface.php')
| -rw-r--r-- | phpBB/phpbb/db/extractor/extractor_interface.php | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/phpBB/phpbb/db/extractor/extractor_interface.php b/phpBB/phpbb/db/extractor/extractor_interface.php new file mode 100644 index 0000000000..ff45df9bb7 --- /dev/null +++ b/phpBB/phpbb/db/extractor/extractor_interface.php @@ -0,0 +1,80 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\db\extractor; + +/** +* Database extractor interface +*/ +interface extractor_interface +{ + /** + * 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. + * + * @param string $format + * @param string $filename + * @param int $time + * @param bool $download + * @param bool $store + * @return null + * @throws \phpbb\db\extractor\exception\invalid_format_exception when $format is invalid + */ + public function init_extractor($format, $filename, $time, $download = false, $store = false); + + /** + * Writes header comments to the database backup + * + * @param string $table_prefix prefix of phpBB database tables + * @return null + * @throws \phpbb\db\extractor\exception\extractor_not_initialized_exception when calling this function before init_extractor() + */ + public function write_start($table_prefix); + + /** + * Closes file and/or dumps download data + * + * @return null + * @throws \phpbb\db\extractor\exception\extractor_not_initialized_exception when calling this function before init_extractor() + */ + public function write_end(); + + /** + * Extracts database table structure + * + * @param string $table_name name of the database table + * @return null + * @throws \phpbb\db\extractor\exception\extractor_not_initialized_exception when calling this function before init_extractor() + */ + public function write_table($table_name); + + /** + * Extracts data from database table + * + * @param string $table_name name of the database table + * @return null + * @throws \phpbb\db\extractor\exception\extractor_not_initialized_exception when calling this function before init_extractor() + */ + public function write_data($table_name); + + /** + * Writes data to file/download content + * + * @param string $data + * @return null + * @throws \phpbb\db\extractor\exception\extractor_not_initialized_exception when calling this function before init_extractor() + */ + public function flush($data); +} |