MediaWiki\Import\ImportSource Interface Reference

Source interface for XML import. More...

Inherited by MediaWiki\Import\ImportStreamSource, and MediaWiki\Import\ImportStringSource.

Public Member Functions
	atEnd ()
	Indicates whether the end of the input has been reached.
	isSeekable ()
	Check if the source is seekable and a call to self::seek is valid.
	readChunk ()
	Return a chunk of the input, as a (possibly empty) string.
	seek (int $offset)
	Seek the input to the given offset.

Detailed Description

Source interface for XML import.

Definition at line 20 of file ImportSource.php.

Member Function Documentation

atEnd()

MediaWiki\Import\ImportSource::atEnd

(

)

Indicates whether the end of the input has been reached.

Will return true after a finite number of calls to readChunk.

Returns

bool true if there is no more input, false otherwise.

Implemented in MediaWiki\Import\ImportStreamSource, and MediaWiki\Import\ImportStringSource.

isSeekable()

MediaWiki\Import\ImportSource::isSeekable

(

)

Check if the source is seekable and a call to self::seek is valid.

Returns

bool

Implemented in MediaWiki\Import\ImportStreamSource, and MediaWiki\Import\ImportStringSource.

readChunk()

MediaWiki\Import\ImportSource::readChunk

(

)

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.

Returns

bool|string

Implemented in MediaWiki\Import\ImportStreamSource, and MediaWiki\Import\ImportStringSource.

seek()

MediaWiki\Import\ImportSource::seek

(

int

$offset

)

Seek the input to the given offset.

Parameters

int

$offset

Returns

int

Implemented in MediaWiki\Import\ImportStreamSource, and MediaWiki\Import\ImportStringSource.

---

The documentation for this interface was generated from the following file:

• includes/Import/ImportSource.php