1	<?php
2	/**
3	* Source interface for XML import.
4	*
5	* Copyright © 2003,2005 Brooke Vibber <bvibber@wikimedia.org>
6	* https://www.mediawiki.org/
7	*
8	* This program is free software; you can redistribute it and/or modify
9	* it under the terms of the GNU General Public License as published by
10	* the Free Software Foundation; either version 2 of the License, or
11	* (at your option) any later version.
12	*
13	* This program is distributed in the hope that it will be useful,
14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16	* GNU General Public License for more details.
17	*
18	* You should have received a copy of the GNU General Public License along
19	* with this program; if not, write to the Free Software Foundation, Inc.,
20	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21	* http://www.gnu.org/copyleft/gpl.html
22	*
23	* @file
24	* @ingroup SpecialPage
25	*/
26
27	/**
28	* Source interface for XML import.
29	*
30	* @ingroup SpecialPage
31	*/
32	interface ImportSource {
33
34	/**
35	* Indicates whether the end of the input has been reached.
36	* Will return true after a finite number of calls to readChunk.
37	*
38	* @return bool true if there is no more input, false otherwise.
39	*/
40	public function atEnd();
41
42	/**
43	* Return a chunk of the input, as a (possibly empty) string.
44	* When the end of input is reached, readChunk() returns false.
45	* If atEnd() returns false, readChunk() will return a string.
46	* If atEnd() returns true, readChunk() will return false.
47	*
48	* @return bool|string
49	*/
50	public function readChunk();
51
52	/**
53	* Check if the source is seekable and a call to self::seek is valid
54	*
55	* @return bool
56	*/
57	public function isSeekable();
58
59	/**
60	* Seek the input to the given offset.
61	*
62	* @param int $offset
63	* @return int
64	*/
65	public function seek( int $offset );
66	}