MediaWiki  REL1_24
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, $user=null)
 getDescriptionText ($lang=false)
 getDescriptionUrl ()
 move ($target)
 publish ($srcPath, $flags=0, array $options=array())
 recordUpload ($oldver, $desc, $license= '', $copyStatus= '', $source= '', $watch=false, $timestamp=false, User $user=null)
 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,
user = null 
)
Parameters:
string$reason
bool$suppress
User | null$user
Returns:
FileRepoStatus
Exceptions:
MWException

Reimplemented from LocalFile.

Definition at line 101 of file ForeignDBFile.php.

References File\readOnlyError().

Parameters:
bool | Language$langOptional language to fetch description in.
Returns:
string

Reimplemented from LocalFile.

Definition at line 126 of file ForeignDBFile.php.

Returns:
string

Reimplemented from LocalFile.

Definition at line 117 of file ForeignDBFile.php.

ForeignDBFile::move ( target)
Parameters:
Title$target
Returns:
FileRepoStatus
Exceptions:
MWException

Reimplemented from LocalFile.

Definition at line 110 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:
stdClass$row
FileRepo$repo
Returns:
ForeignDBFile

Reimplemented from LocalFile.

Definition at line 48 of file ForeignDBFile.php.

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

static ForeignDBFile::newFromTitle ( title,
repo,
unused = null 
) [static]
Parameters:
Title$title
FileRepo$repo
null$unused
Returns:
ForeignDBFile

Reimplemented from LocalFile.

Definition at line 36 of file ForeignDBFile.php.

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

ForeignDBFile::publish ( srcPath,
flags = 0,
array options = array() 
)
Parameters:
string$srcPath
int$flags
array$options
Returns:
FileRepoStatus
Exceptions:
MWException

Reimplemented from LocalFile.

Definition at line 63 of file ForeignDBFile.php.

References File\readOnlyError().

ForeignDBFile::recordUpload ( oldver,
desc,
license = '',
copyStatus = '',
source = '',
watch = false,
timestamp = false,
User user = null 
)
Parameters:
string$oldver
string$desc
string$license
string$copyStatus
string$source
bool$watch
bool | string$timestamp
User$userUser object or null to use $wgUser
Returns:
bool
Exceptions:
MWException

Reimplemented from LocalFile.

Definition at line 79 of file ForeignDBFile.php.

References File\readOnlyError().

ForeignDBFile::restore ( versions = array(),
unsuppress = false 
)
Parameters:
array$versions
bool$unsuppress
Returns:
FileRepoStatus
Exceptions:
MWException

Reimplemented from LocalFile.

Definition at line 90 of file ForeignDBFile.php.

References File\readOnlyError().


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