[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/filebackend/ -> FSFileBackend.php (summary)

File system based backend. 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.

Author: Aaron Schulz
File Size: 969 lines (29 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 4 classes

FSFileBackend:: (32 methods):
  __construct()
  getFeatures()
  resolveContainerPath()
  isLegalRelPath()
  containerFSRoot()
  resolveToFSPath()
  isPathUsableInternal()
  doCreateInternal()
  doStoreInternal()
  doCopyInternal()
  doMoveInternal()
  doDeleteInternal()
  doPrepareInternal()
  doSecureInternal()
  doPublishInternal()
  doCleanInternal()
  doGetFileStat()
  doClearCache()
  doDirectoryExists()
  getDirectoryListInternal()
  getFileListInternal()
  doGetLocalReferenceMulti()
  doGetLocalCopyMulti()
  directoriesAreVirtual()
  doExecuteOpHandlesInternal()
  chmod()
  indexHtmlPrivate()
  htaccessPrivate()
  cleanPathSlashes()
  trapWarnings()
  untrapWarnings()
  handleWarning()

FSFileOpHandle:: (10 methods):
  __construct()
  __construct()
  initIterator()
  key()
  current()
  next()
  rewind()
  valid()
  filterViaNext()
  getRelPath()

FSFileBackendDirList:: (1 method):
  filterViaNext()

FSFileBackendFileList:: (1 method):
  filterViaNext()


Class: FSFileBackend  - X-Ref


__construct( array $config )   X-Ref


getFeatures()   X-Ref
No description

resolveContainerPath( $container, $relStoragePath )   X-Ref
No description

isLegalRelPath( $path )   X-Ref
Sanity check a relative file system path for validity

param: string $path Normalized relative path
return: bool

containerFSRoot( $shortCont, $fullCont )   X-Ref
Given the short (unresolved) and full (resolved) name of
a container, return the file system path of the container.

param: string $shortCont
param: string $fullCont
return: string|null

resolveToFSPath( $storagePath )   X-Ref
Get the absolute file system path for a storage path

param: string $storagePath Storage path
return: string|null

isPathUsableInternal( $storagePath )   X-Ref
No description

doCreateInternal( array $params )   X-Ref
No description

doStoreInternal( array $params )   X-Ref
No description

doCopyInternal( array $params )   X-Ref
No description

doMoveInternal( array $params )   X-Ref
No description

doDeleteInternal( array $params )   X-Ref
No description

doPrepareInternal( $fullCont, $dirRel, array $params )   X-Ref

param: string $fullCont
param: string $dirRel
param: array $params
return: Status

doSecureInternal( $fullCont, $dirRel, array $params )   X-Ref
No description

doPublishInternal( $fullCont, $dirRel, array $params )   X-Ref
No description

doCleanInternal( $fullCont, $dirRel, array $params )   X-Ref
No description

doGetFileStat( array $params )   X-Ref
No description

doClearCache( array $paths = null )   X-Ref


doDirectoryExists( $fullCont, $dirRel, array $params )   X-Ref
No description

getDirectoryListInternal( $fullCont, $dirRel, array $params )   X-Ref

param: string $fullCont
param: string $dirRel
param: array $params
return: array|null

getFileListInternal( $fullCont, $dirRel, array $params )   X-Ref

param: string $fullCont
param: string $dirRel
param: array $params
return: array|FSFileBackendFileList|null

doGetLocalReferenceMulti( array $params )   X-Ref
No description

doGetLocalCopyMulti( array $params )   X-Ref
No description

directoriesAreVirtual()   X-Ref
No description

doExecuteOpHandlesInternal( array $fileOpHandles )   X-Ref
No description

chmod( $path )   X-Ref
Chmod a file, suppressing the warnings

param: string $path Absolute file system path
return: bool Success

indexHtmlPrivate()   X-Ref
Return the text of an index.html file to hide directory listings

return: string

htaccessPrivate()   X-Ref
Return the text of a .htaccess file to make a directory private

return: string

cleanPathSlashes( $path )   X-Ref
Clean up directory separators for the given OS

param: string $path FS path
return: string

trapWarnings()   X-Ref
Listen for E_WARNING errors and track whether any happen


untrapWarnings()   X-Ref
Stop listening for E_WARNING errors and return true if any happened

return: bool

handleWarning( $errno, $errstr )   X-Ref

param: int $errno
param: string $errstr
return: bool

Class: FSFileOpHandle  - X-Ref


__construct(FSFileBackend $backend, array $params, $call, $cmd, $chmodPath = null)   X-Ref

param: FSFileBackend $backend
param: array $params
param: callable $call
param: string $cmd
param: int|null $chmodPath

__construct( $dir, array $params )   X-Ref

param: string $dir File system directory
param: array $params

initIterator( $dir )   X-Ref
Return an appropriate iterator object to wrap

param: string $dir File system directory
return: Iterator

key()   X-Ref

return: int

current()   X-Ref

return: string|bool String or false

next()   X-Ref


rewind()   X-Ref


valid()   X-Ref

return: bool

filterViaNext()   X-Ref
Filter out items by advancing to the next ones


getRelPath( $dir )   X-Ref
Return only the relative path and normalize slashes to FileBackend-style.
Uses the "real path" since the suffix is based upon that.

param: string $dir
return: string

Class: FSFileBackendDirList  - X-Ref

filterViaNext()   X-Ref
No description

Class: FSFileBackendFileList  - X-Ref

filterViaNext()   X-Ref
No description



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