[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/filerepo/file/ -> ForeignAPIFile.php (summary)

Foreign file accessible through api.php requests. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 368 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ForeignAPIFile:: (25 methods):
  __construct()
  newFromTitle()
  getProps()
  exists()
  getPath()
  transform()
  getWidth()
  getHeight()
  getMetadata()
  getExtendedMetadata()
  parseMetadata()
  getSize()
  getUrl()
  getUser()
  getDescription()
  getSha1()
  getTimestamp()
  getMimeType()
  getMediaType()
  getDescriptionUrl()
  getThumbPath()
  getThumbnails()
  purgeCache()
  purgeDescriptionPage()
  purgeThumbnails()


Class: ForeignAPIFile  - X-Ref

Foreign file accessible through api.php requests.
Very hacky and inefficient, do not use :D

__construct( $title, $repo, $info, $exists = false )   X-Ref

param: Title|string|bool $title
param: ForeignApiRepo $repo
param: array $info
param: bool $exists

newFromTitle( Title $title, $repo )   X-Ref

param: Title $title
param: ForeignApiRepo $repo
return: ForeignAPIFile|null

getProps()   X-Ref
Get the property string for iiprop and aiprop

return: string

exists()   X-Ref

return: bool

getPath()   X-Ref

return: bool

transform( $params, $flags = 0 )   X-Ref

param: array $params
param: int $flags
return: bool|MediaTransformOutput

getWidth( $page = 1 )   X-Ref

param: int $page
return: int|number

getHeight( $page = 1 )   X-Ref

param: int $page
return: int

getMetadata()   X-Ref

return: bool|null|string

getExtendedMetadata()   X-Ref

return: array|null Extended metadata (see imageinfo API for format) or

parseMetadata( $metadata )   X-Ref

param: array $metadata
return: array

getSize()   X-Ref

return: bool|int|null

getUrl()   X-Ref

return: null|string

getUser( $method = 'text' )   X-Ref

param: string $method
return: int|null|string

getDescription( $audience = self::FOR_PUBLIC, User $user = null )   X-Ref

param: int $audience
param: User $user
return: null|string

getSha1()   X-Ref

return: null|string

getTimestamp()   X-Ref

return: bool|string

getMimeType()   X-Ref

return: string

getMediaType()   X-Ref

return: int|string

getDescriptionUrl()   X-Ref

return: bool|string

getThumbPath( $suffix = '' )   X-Ref
Only useful if we're locally caching thumbs anyway...

param: string $suffix
return: null|string

getThumbnails()   X-Ref

return: array

purgeCache( $options = array()   X-Ref


purgeDescriptionPage()   X-Ref
No description

purgeThumbnails( $options = array()   X-Ref

param: array $options



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1