1	<?php
2	/**
3	*
4	* This file is part of the phpBB Forum Software package.
5	*
6	* @copyright (c) phpBB Limited <https://www.phpbb.com>
7	* @license GNU General Public License, version 2 (GPL-2.0)
8	*
9	* For full copyright and license information, please see
10	* the docs/CREDITS.txt file.
11	*
12	*/
13
14	namespace phpbb\db\extractor;
15
16	/**
17	* Database extractor interface
18	*/
19	interface extractor_interface
20	{
21	/**
22	* Start the extraction of the database
23	*
24	* This function initialize the database extraction. It is required to call this
25	* function before calling any other extractor functions.
26	*
27	* @param string    $format
28	* @param string    $filename
29	* @param int    $time
30	* @param bool    $download
31	* @param bool    $store
32	* @return null
33	* @throws \phpbb\db\extractor\exception\invalid_format_exception when $format is invalid
34	*/
35	public function init_extractor($format, $filename, $time, $download = false, $store = false);
36
37	/**
38	* Writes header comments to the database backup
39	*
40	* @param    string    $table_prefix    prefix of phpBB database tables
41	* @return null
42	* @throws \phpbb\db\extractor\exception\extractor_not_initialized_exception when calling this function before init_extractor()
43	*/
44	public function write_start($table_prefix);
45
46	/**
47	* Closes file and/or dumps download data
48	*
49	* @return null
50	* @throws \phpbb\db\extractor\exception\extractor_not_initialized_exception when calling this function before init_extractor()
51	*/
52	public function write_end();
53
54	/**
55	* Extracts database table structure
56	*
57	* @param    string    $table_name    name of the database table
58	* @return null
59	* @throws \phpbb\db\extractor\exception\extractor_not_initialized_exception when calling this function before init_extractor()
60	*/
61	public function write_table($table_name);
62
63	/**
64	* Extracts data from database table
65	*
66	* @param    string    $table_name    name of the database table
67	* @return null
68	* @throws \phpbb\db\extractor\exception\extractor_not_initialized_exception when calling this function before init_extractor()
69	*/
70	public function write_data($table_name);
71
72	/**
73	* Writes data to file/download content
74	*
75	* @param string    $data
76	* @return null
77	* @throws \phpbb\db\extractor\exception\extractor_not_initialized_exception when calling this function before init_extractor()
78	*/
79	public function flush($data);
80	}