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