ImportSource Interface Reference

Source interface for XML import. More...

Inheritance diagram for ImportSource:

Public Member Functions
	atEnd ()
	Indicates whether the end of the input has been reached.
	readChunk ()
	Return a chunk of the input, as a (possibly empty) string.

Detailed Description

Source interface for XML import.

Definition at line 32 of file ImportSource.php.

Member Function Documentation

atEnd()

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 ImportStreamSource, and ImportStringSource.

readChunk()

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 ImportStreamSource, and ImportStringSource.

---

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

• includes/import/ImportSource.php