MediaWiki  master
ImportStreamSource Class Reference

Imports a XML dump from a file (either from file upload, files on disk, or HTTP) More...

Inheritance diagram for ImportStreamSource:
Collaboration diagram for ImportStreamSource:

Public Member Functions

 __construct ( $handle)
 
 atEnd ()
 
 readChunk ()
 

Static Public Member Functions

static newFromFile ( $filename)
 
static newFromInterwiki ( $interwiki, $page, $history=false, $templates=false, $pageLinkDepth=0)
 
static newFromUpload ( $fieldname="xmlimport")
 
static newFromURL ( $url, $method='GET')
 

Private Attributes

resource $mHandle
 

Detailed Description

Imports a XML dump from a file (either from file upload, files on disk, or HTTP)

Definition at line 32 of file ImportStreamSource.php.

Constructor & Destructor Documentation

◆ __construct()

ImportStreamSource::__construct (   $handle)
Parameters
resource$handle

Definition at line 39 of file ImportStreamSource.php.

Member Function Documentation

◆ atEnd()

ImportStreamSource::atEnd ( )
Returns
bool

Implements ImportSource.

Definition at line 46 of file ImportStreamSource.php.

◆ newFromFile()

static ImportStreamSource::newFromFile (   $filename)
static
Parameters
string$filename
Returns
Status

Definition at line 61 of file ImportStreamSource.php.

References $file, StatusValue\newFatal(), and StatusValue\newGood().

◆ newFromInterwiki()

static ImportStreamSource::newFromInterwiki (   $interwiki,
  $page,
  $history = false,
  $templates = false,
  $pageLinkDepth = 0 
)
static
Parameters
string$interwiki
string$page
bool$history
bool$templates
int$pageLinkDepth
Returns
Status

Definition at line 149 of file ImportStreamSource.php.

References StatusValue\newFatal(), and wfAppendQuery().

Referenced by SpecialImport\doImport(), and ApiImport\execute().

◆ newFromUpload()

static ImportStreamSource::newFromUpload (   $fieldname = "xmlimport")
static
Parameters
string$fieldname
Returns
Status

Definition at line 75 of file ImportStreamSource.php.

References StatusValue\newFatal().

Referenced by SpecialImport\doImport(), and ApiImport\execute().

◆ newFromURL()

static ImportStreamSource::newFromURL (   $url,
  $method = 'GET' 
)
static
Parameters
string$url
string$method
Returns
Status

Definition at line 114 of file ImportStreamSource.php.

References $file, $wgHTTPImportTimeout, StatusValue\newFatal(), StatusValue\newGood(), and wfDebug().

◆ readChunk()

ImportStreamSource::readChunk ( )
Returns
string

Implements ImportSource.

Definition at line 53 of file ImportStreamSource.php.

Member Data Documentation

◆ $mHandle

resource ImportStreamSource::$mHandle
private

Definition at line 34 of file ImportStreamSource.php.


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