Foreign file accessible through api.php requests. More...

Inheritance diagram for ForeignAPIFile:

Collaboration diagram for ForeignAPIFile:

Public Member Functions
	__construct ($title, $repo, $info, $exists=false)
	exists ()
	getDescription ($audience=self::FOR_PUBLIC, User $user=null)
	getDescriptionUrl ()
	getHeight ($page=1)
	getMediaType ()
	getMetadata ()
	getMimeType ()
	getPath ()
	getSha1 ()
	getSize ()
	getThumbnails ()
	getThumbPath ($suffix= '')
	Only useful if we're locally caching thumbs anyway...
	getTimestamp ()
	getUrl ()
	getUser ($method= 'text')
	getWidth ($page=1)
	purgeCache ($options=array())
	purgeDescriptionPage ()
	purgeThumbnails ($options=array())
	transform ($params, $flags=0)
Static Public Member Functions
static	getProps ()
	Get the property string for iiprop and aiprop.
static	newFromTitle (Title $title, $repo)
static	parseMetadata ($metadata)
Protected Attributes
	$repoClass = 'ForeignApiRepo'
	Required Repository class type.
Private Attributes
	$mExists

Detailed Description

Foreign file accessible through api.php requests.

Very hacky and inefficient, do not use :D

Definition at line 30 of file ForeignAPIFile.php.

Constructor & Destructor Documentation

ForeignAPIFile::__construct	(	$	title,
		$	repo,
		$	info,
		$	exists = `false`
	)

Parameters:

	$title
	$repo	ForeignApiRepo
	$info
bool	$exists

Definition at line 41 of file ForeignAPIFile.php.

References File\$repo, File\$title, and File\assertRepoDefined().

Member Function Documentation

ForeignAPIFile::exists ( )

Returns:: bool

Reimplemented from File.

Definition at line 97 of file ForeignAPIFile.php.

ForeignAPIFile::getDescription	(	$	audience = `self::FOR_PUBLIC`,
		User $	user = `null`
	)

Returns:: null|string

Reimplemented from File.

Definition at line 199 of file ForeignAPIFile.php.

ForeignAPIFile::getDescriptionUrl ( )

Returns:: bool|string

Reimplemented from File.

Definition at line 246 of file ForeignAPIFile.php.

ForeignAPIFile::getHeight ( $ page = 1 )

Parameters:

$page int

Returns:: int

Reimplemented from File.

Definition at line 145 of file ForeignAPIFile.php.

ForeignAPIFile::getMediaType ( )

Todo:: FIXME: May guess wrong on file types that can be eg audio or video

Returns:: int|string

Reimplemented from File.

Definition at line 238 of file ForeignAPIFile.php.

References getMimeType(), and MimeMagic\singleton().

ForeignAPIFile::getMetadata ( )

Returns:: bool|null|string

Reimplemented from File.

Definition at line 152 of file ForeignAPIFile.php.

ForeignAPIFile::getMimeType ( )

Returns:: string

Reimplemented from File.

Definition at line 226 of file ForeignAPIFile.php.

References File\getExtension(), and MimeMagic\singleton().

Referenced by getMediaType().

ForeignAPIFile::getPath ( )

Returns:: bool

Reimplemented from File.

Definition at line 104 of file ForeignAPIFile.php.

static ForeignAPIFile::getProps ( ) [static]

Get the property string for iiprop and aiprop.

Returns:: string

Definition at line 88 of file ForeignAPIFile.php.

Referenced by ForeignAPIRepo\findBySha1(), and newFromTitle().

ForeignAPIFile::getSha1 ( )

Returns:: null|String

Reimplemented from File.

Definition at line 206 of file ForeignAPIFile.php.

References wfBaseConvert().

ForeignAPIFile::getSize ( )

Returns:: bool|int|null

Reimplemented from File.

Definition at line 177 of file ForeignAPIFile.php.

ForeignAPIFile::getThumbnails ( )

Returns:: array

Reimplemented from File.

Definition at line 272 of file ForeignAPIFile.php.

References $dir, $file, $files, array(), as, File\getName(), and getThumbPath().

Referenced by purgeThumbnails().

ForeignAPIFile::getThumbPath ( $ suffix = '' )

Only useful if we're locally caching thumbs anyway...

Parameters:

$suffix string

Returns:: null|string

Reimplemented from File.

Definition at line 257 of file ForeignAPIFile.php.

References File\$path, File\getHashPath(), and File\getName().

Referenced by getThumbnails(), and purgeThumbnails().

ForeignAPIFile::getTimestamp ( )

Returns:: bool|Mixed|string

Reimplemented from File.

Definition at line 215 of file ForeignAPIFile.php.

References wfTimestamp().

ForeignAPIFile::getUrl ( )

Returns:: null|string

Reimplemented from File.

Definition at line 184 of file ForeignAPIFile.php.

ForeignAPIFile::getUser ( $ method = 'text' )

Parameters:

string $method

Returns:: int|null|string

Reimplemented from File.

Definition at line 192 of file ForeignAPIFile.php.

ForeignAPIFile::getWidth ( $ page = 1 )

Parameters:

$page int

Returns:: int|number

Reimplemented from File.

Definition at line 137 of file ForeignAPIFile.php.

static ForeignAPIFile::newFromTitle	(	Title $	title,
		$	repo
	)		`[static]`

Parameters:

$title	Title
$repo	ForeignApiRepo

Returns:: ForeignAPIFile|null

Definition at line 55 of file ForeignAPIFile.php.

References File\$repo, File\$title, array(), Title\getDBkey(), MediaHandler\getMetadataVersion(), getProps(), Title\newFromText(), and true.

static ForeignAPIFile::parseMetadata ( $ metadata ) [static]

Parameters:

$metadata array

Returns:: array

Definition at line 163 of file ForeignAPIFile.php.

References $ret, array(), and as.

ForeignAPIFile::purgeCache ( $ options = array() )

See also:: File::purgeCache()

Reimplemented from File.

Definition at line 287 of file ForeignAPIFile.php.

References $options, purgeDescriptionPage(), and purgeThumbnails().

ForeignAPIFile::purgeDescriptionPage ( )

Definition at line 292 of file ForeignAPIFile.php.

References File\$url, $wgContLang, $wgMemc, File\getName(), and global.

Referenced by purgeCache().

ForeignAPIFile::purgeThumbnails ( $ options = array() )

Parameters:

$options array

Definition at line 304 of file ForeignAPIFile.php.

References $dir, $file, $files, File\$handler, $options, $wgMemc, array(), as, MediaHandler\filterThumbnailPurgeList(), File\getHandler(), File\getName(), getThumbnails(), getThumbPath(), and global.

Referenced by purgeCache().

ForeignAPIFile::transform	(	$	params,
		$	flags = `0`
	)

Parameters:

array	$params
int	$flags

Returns:: bool|MediaTransformOutput

Reimplemented from File.

Definition at line 113 of file ForeignAPIFile.php.

References $flags, $params, File\canRender(), and File\getName().

Member Data Documentation

ForeignAPIFile::$mExists [private]

Definition at line 31 of file ForeignAPIFile.php.

ForeignAPIFile::$repoClass = 'ForeignApiRepo' [protected]

Required Repository class type.

Reimplemented from File.

Definition at line 33 of file ForeignAPIFile.php.

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

includes/filerepo/file/ForeignAPIFile.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation