ForeignDBFile Class Reference

Foreign file with an accessible MediaWiki database. More...

Inheritance diagram for ForeignDBFile:

Collaboration diagram for ForeignDBFile:

List of all members.

Public Member Functions
	delete ($reason, $suppress=false)
	getDescriptionText ()
	getDescriptionUrl ()
	move ($target)
	publish ($srcPath, $flags=0)
	recordUpload ($oldver, $desc, $license= '', $copyStatus= '', $source= '', $watch=false, $timestamp=false)
	restore ($versions=array(), $unsuppress=false)
Static Public Member Functions
static	newFromRow ($row, $repo)
	Create a ForeignDBFile from a title Do not call this except from inside a repo class.
static	newFromTitle ($title, $repo, $unused=null)

---

Detailed Description

Foreign file with an accessible MediaWiki database.

Definition at line 29 of file ForeignDBFile.php.

---

Member Function Documentation

ForeignDBFile::delete	(	$	reason,
		$	suppress = false
	)

Parameters:

$reason	string
$suppress	bool

Exceptions:

MWException

Reimplemented from LocalFile.

Definition at line 95 of file ForeignDBFile.php.

References File\readOnlyError().

ForeignDBFile::getDescriptionText

(

)

Returns:

string

Reimplemented from LocalFile.

Definition at line 118 of file ForeignDBFile.php.

ForeignDBFile::getDescriptionUrl

(

)

Returns:

string

Reimplemented from LocalFile.

Definition at line 110 of file ForeignDBFile.php.

ForeignDBFile::move

(

$

target

)

Parameters:

$target

Title

Exceptions:

MWException

Reimplemented from LocalFile.

Definition at line 103 of file ForeignDBFile.php.

References File\readOnlyError().

static ForeignDBFile::newFromRow	(	$	row,
		$	repo
	)		[static]

Create a ForeignDBFile from a title Do not call this except from inside a repo class.

Parameters:

$row
$repo

Returns:

ForeignDBFile

Reimplemented from LocalFile.

Definition at line 50 of file ForeignDBFile.php.

References $file, LocalFile\$repo, File\$title, and Title\makeTitle().

static ForeignDBFile::newFromTitle	(	$	title,
		$	repo,
		$	unused = null
	)		[static]

Parameters:

$title
$repo
$unused

Returns:

ForeignDBFile

Reimplemented from LocalFile.

Definition at line 37 of file ForeignDBFile.php.

References LocalFile\$repo, and File\$title.

ForeignDBFile::publish	(	$	srcPath,
		$	flags = 0
	)

Parameters:

$srcPath	String
$flags	int

Exceptions:

MWException

Reimplemented from LocalFile.

Definition at line 62 of file ForeignDBFile.php.

References File\readOnlyError().

ForeignDBFile::recordUpload	(	$	oldver,
		$	desc,
		$	license = '',
		$	copyStatus = '',
		$	source = '',
		$	watch = false,
		$	timestamp = false
	)

Parameters:

$oldver
$desc	string
$license	string
$copyStatus	string
$source	string
$watch	bool
$timestamp	bool|string

Exceptions:

MWException

Reimplemented from LocalFile.

Definition at line 76 of file ForeignDBFile.php.

References File\readOnlyError().

ForeignDBFile::restore	(	$	versions = array(),
		$	unsuppress = false
	)

Parameters:

$versions	array
$unsuppress	bool

Exceptions:

MWException

Reimplemented from LocalFile.

Definition at line 86 of file ForeignDBFile.php.

References File\readOnlyError().

---

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

• includes/filerepo/file/ForeignDBFile.php