[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

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

File without associated database record. 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: 215 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

UnregisteredLocalFile:: (12 methods):
  newFromPath()
  newFromTitle()
  __construct()
  cachePageDimensions()
  getWidth()
  getHeight()
  getMimeType()
  getImageSize()
  getMetadata()
  getURL()
  getSize()
  setLocalReference()


Class: UnregisteredLocalFile  - X-Ref

A file object referring to either a standalone local file, or a file in a
local repository with no database, for example an FileRepo repository.

Read-only.

newFromPath( $path, $mime )   X-Ref

param: string $path Storage path
param: string $mime
return: UnregisteredLocalFile

newFromTitle( $title, $repo )   X-Ref

param: Title $title
param: FileRepo $repo
return: UnregisteredLocalFile

__construct( $title = false, $repo = false, $path = false, $mime = false )   X-Ref
Create an UnregisteredLocalFile based on a path or a (title,repo) pair.
A FileRepo object is not required here, unlike most other File classes.

param: Title|bool $title
param: FileRepo|bool $repo
param: string|bool $path
param: string|bool $mime

cachePageDimensions( $page = 1 )   X-Ref

param: int $page
return: bool

getWidth( $page = 1 )   X-Ref

param: int $page
return: int

getHeight( $page = 1 )   X-Ref

param: int $page
return: int

getMimeType()   X-Ref

return: bool|string

getImageSize( $filename )   X-Ref

param: string $filename
return: array|bool

getMetadata()   X-Ref

return: bool

getURL()   X-Ref

return: bool|string

getSize()   X-Ref

return: bool|int

setLocalReference( FSFile $fsFile )   X-Ref
Optimize getLocalRefPath() by using an existing local reference.
The file at the path of $fsFile should not be deleted (or at least
not until the end of the request). This is mostly a performance hack.

param: FSFile $fsFile
return: void



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