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 ()
	getExtendedMetadata ()
	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 \| string \| bool	$title
ForeignApiRepo	$repo
array	$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 101 of file ForeignAPIFile.php.

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

Parameters:

int	$audience
User	$user

Returns:: null|string

Reimplemented from File.

Definition at line 234 of file ForeignAPIFile.php.

ForeignAPIFile::getDescriptionUrl ( )

Returns:: bool|string

Reimplemented from File.

Definition at line 285 of file ForeignAPIFile.php.

ForeignAPIFile::getExtendedMetadata ( )

Returns:: array|null Extended metadata (see imageinfo API for format) or null on error

Definition at line 183 of file ForeignAPIFile.php.

ForeignAPIFile::getHeight ( $ page = 1 )

Parameters:

int $page

Returns:: int

Reimplemented from File.

Definition at line 164 of file ForeignAPIFile.php.

ForeignAPIFile::getMediaType ( )

Returns:: int|string

Reimplemented from File.

Definition at line 273 of file ForeignAPIFile.php.

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

ForeignAPIFile::getMetadata ( )

Returns:: bool|null|string

Reimplemented from File.

Definition at line 171 of file ForeignAPIFile.php.

ForeignAPIFile::getMimeType ( )

Returns:: string

Reimplemented from File.

Definition at line 261 of file ForeignAPIFile.php.

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

Referenced by getMediaType().

ForeignAPIFile::getPath ( )

Returns:: bool

Reimplemented from File.

Definition at line 108 of file ForeignAPIFile.php.

static ForeignAPIFile::getProps ( ) [static]

Get the property string for iiprop and aiprop.

Returns:: string

Definition at line 92 of file ForeignAPIFile.php.

Referenced by newFromTitle().

ForeignAPIFile::getSha1 ( )

Returns:: null|string

Reimplemented from File.

Definition at line 241 of file ForeignAPIFile.php.

References wfBaseConvert().

ForeignAPIFile::getSize ( )

Returns:: bool|int|null

Reimplemented from File.

Definition at line 210 of file ForeignAPIFile.php.

ForeignAPIFile::getThumbnails ( )

Returns:: array

Reimplemented from File.

Definition at line 312 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:

string $suffix

Returns:: null|string

Reimplemented from File.

Definition at line 296 of file ForeignAPIFile.php.

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

Referenced by getThumbnails(), and purgeThumbnails().

ForeignAPIFile::getTimestamp ( )

Returns:: bool|string

Reimplemented from File.

Definition at line 250 of file ForeignAPIFile.php.

References wfTimestamp().

ForeignAPIFile::getUrl ( )

Returns:: null|string

Reimplemented from File.

Definition at line 217 of file ForeignAPIFile.php.

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

Parameters:

string $method

Returns:: int|null|string

Reimplemented from File.

Definition at line 225 of file ForeignAPIFile.php.

ForeignAPIFile::getWidth ( $ page = 1 )

Parameters:

int $page

Returns:: int|number

Reimplemented from File.

Definition at line 156 of file ForeignAPIFile.php.

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

Parameters:

Title	$title
ForeignApiRepo	$repo

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:

array $metadata

Returns:: array

Definition at line 195 of file ForeignAPIFile.php.

References $ret, array(), and as.

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

See also:: File::purgeCache()

Reimplemented from File.

Definition at line 327 of file ForeignAPIFile.php.

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

ForeignAPIFile::purgeDescriptionPage ( )

Definition at line 332 of file ForeignAPIFile.php.

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

Referenced by purgeCache().

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

Parameters:

array $options

Definition at line 344 of file ForeignAPIFile.php.

References $dir, $file, $files, File\$handler, $key, $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 117 of file ForeignAPIFile.php.

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

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