[ Index ]

PHP Cross Reference of Phabricator

title

Body

[close]

/src/applications/files/storage/ -> PhabricatorFile.php (summary)

[Source view] [Print] [Project Stats]

Parameters ==========

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

Defines 74 functions

  initializeNewFile()
  getConfiguration()
  generatePHID()
  save()
  getMonogram()
  readUploadedFileData()
  newFromPHPUpload()
  newFromXHRUpload()
  validateFileSize()
  buildFromFileDataOrHash()
  newFileFromContentHash()
  buildFromFileData()
  newFromFileData()
  migrateToEngine()
  writeToEngine()
  newFromFileDownload()
  normalizeFileName()
  delete()
  deleteFileDataIfUnused()
  hashFileContent()
  loadFileData()
  getViewURI()
  getInfoURI()
  getBestURI()
  getDownloadURI()
  getProfileThumbURI()
  getThumb60x45URI()
  getThumb160x120URI()
  getPreview100URI()
  getPreview220URI()
  getThumb220x165URI()
  getThumb280x210URI()
  isViewableInBrowser()
  isViewableImage()
  isAudio()
  isTransformableImage()
  getTransformableImageFormats()
  instantiateStorageEngine()
  buildEngine()
  buildAllEngines()
  getViewableMimeType()
  getDisplayIconForMimeType()
  validateSecretKey()
  generateSecretKey()
  updateDimensions()
  copyDimensions()
  loadBuiltins()
  loadBuiltin()
  getObjects()
  attachObjects()
  getObjectPHIDs()
  attachObjectPHIDs()
  getOriginalFile()
  attachOriginalFile()
  getImageHeight()
  getImageWidth()
  getCanCDN()
  setCanCDN()
  generateOneTimeToken()
  validateOneTimeToken()
  getCDNURIWithToken()
  attachToObject()
  detachFromObject()
  readPropertiesFromParameters()
  getRedirectResponse()
  getCapabilities()
  getPolicy()
  hasAutomaticCapability()
  describeAutomaticCapability()
  isAutomaticallySubscribed()
  shouldShowSubscribersProperty()
  shouldAllowSubscription()
  getUsersToNotifyOfTokenGiven()
  destroyObjectPermanently()

Functions
Functions that are not part of a class:

initializeNewFile()   X-Ref
No description

getConfiguration()   X-Ref
No description

generatePHID()   X-Ref
No description

save()   X-Ref
No description

getMonogram()   X-Ref
No description

readUploadedFileData($spec)   X-Ref
No description

newFromPHPUpload($spec, array $params = array()   X-Ref
No description

newFromXHRUpload($data, array $params = array()   X-Ref
No description

validateFileSize($size)   X-Ref
No description

buildFromFileDataOrHash($data,array $params = array()   X-Ref
Given a block of data, try to load an existing file with the same content
if one exists. If it does not, build a new file.

This method is generally used when we have some piece of semi-trusted data
like a diff or a file from a repository that we want to show to the user.
We can't just dump it out because it may be dangerous for any number of
reasons; instead, we need to serve it through the File abstraction so it
ends up on the CDN domain if one is configured and so on. However, if we
simply wrote a new file every time we'd potentially end up with a lot
of redundant data in file storage.

To solve these problems, we use file storage as a cache and reuse the
same file again if we've previously written it.

NOTE: This method unguards writes.

param: string  Raw file data.
param: dict    Dictionary of file information.

newFileFromContentHash($hash, array $params)   X-Ref
No description

buildFromFileData($data, array $params = array()   X-Ref
No description

newFromFileData($data, array $params = array()   X-Ref
No description

migrateToEngine(PhabricatorFileStorageEngine $engine)   X-Ref
No description

writeToEngine(PhabricatorFileStorageEngine $engine,$data,array $params)   X-Ref
No description

newFromFileDownload($uri, array $params = array()   X-Ref
No description

normalizeFileName($file_name)   X-Ref
No description

delete()   X-Ref
No description

deleteFileDataIfUnused(PhabricatorFileStorageEngine $engine,$engine_identifier,$handle)   X-Ref
Destroy stored file data if there are no remaining files which reference
it.


hashFileContent($data)   X-Ref
No description

loadFileData()   X-Ref
No description

getViewURI()   X-Ref
No description

getInfoURI()   X-Ref
No description

getBestURI()   X-Ref
No description

getDownloadURI()   X-Ref
No description

getProfileThumbURI()   X-Ref
No description

getThumb60x45URI()   X-Ref
No description

getThumb160x120URI()   X-Ref
No description

getPreview100URI()   X-Ref
No description

getPreview220URI()   X-Ref
No description

getThumb220x165URI()   X-Ref
No description

getThumb280x210URI()   X-Ref
No description

isViewableInBrowser()   X-Ref
No description

isViewableImage()   X-Ref
No description

isAudio()   X-Ref
No description

isTransformableImage()   X-Ref
No description

getTransformableImageFormats()   X-Ref
No description

instantiateStorageEngine()   X-Ref
No description

buildEngine($engine_identifier)   X-Ref
No description

buildAllEngines()   X-Ref
No description

getViewableMimeType()   X-Ref
No description

getDisplayIconForMimeType()   X-Ref
No description

validateSecretKey($key)   X-Ref
No description

generateSecretKey()   X-Ref
No description

updateDimensions($save = true)   X-Ref
No description

copyDimensions(PhabricatorFile $file)   X-Ref
No description

loadBuiltins(PhabricatorUser $user, array $names)   X-Ref
Load (or build) the {@class:PhabricatorFile} objects for builtin file
resources. The builtin mechanism allows files shipped with Phabricator
to be treated like normal files so that APIs do not need to special case
things like default images or deleted files.

Builtins are located in `resources/builtin/` and identified by their
name.

param: PhabricatorUser                Viewing user.
param: list<string>                   List of builtin file names.
return: dict<string, PhabricatorFile>  Dictionary of named builtins.

loadBuiltin(PhabricatorUser $user, $name)   X-Ref
Convenience wrapper for @{method:loadBuiltins}.

param: PhabricatorUser   Viewing user.
param: string            Single builtin name to load.
return: PhabricatorFile  Corresponding builtin file.

getObjects()   X-Ref
No description

attachObjects(array $objects)   X-Ref
No description

getObjectPHIDs()   X-Ref
No description

attachObjectPHIDs(array $object_phids)   X-Ref
No description

getOriginalFile()   X-Ref
No description

attachOriginalFile(PhabricatorFile $file = null)   X-Ref
No description

getImageHeight()   X-Ref
No description

getImageWidth()   X-Ref
No description

getCanCDN()   X-Ref
No description

setCanCDN($can_cdn)   X-Ref
No description

generateOneTimeToken()   X-Ref
No description

validateOneTimeToken($token_code)   X-Ref
No description

getCDNURIWithToken()   X-Ref
No description

attachToObject($phid)   X-Ref
Write the policy edge between this file and some object.

param: phid Object PHID to attach to.
return: this

detachFromObject($phid)   X-Ref
Remove the policy edge between this file and some object.

param: phid Object PHID to detach from.
return: this

readPropertiesFromParameters(array $params)   X-Ref
Configure a newly created file object according to specified parameters.

This method is called both when creating a file from fresh data, and
when creating a new file which reuses existing storage.

param: map<string, wild>   Bag of parameters, see @{class:PhabricatorFile}
return: this

getRedirectResponse()   X-Ref
No description

getCapabilities()   X-Ref
No description

getPolicy($capability)   X-Ref
No description

hasAutomaticCapability($capability, PhabricatorUser $viewer)   X-Ref
No description

describeAutomaticCapability($capability)   X-Ref
No description

isAutomaticallySubscribed($phid)   X-Ref
No description

shouldShowSubscribersProperty()   X-Ref
No description

shouldAllowSubscription($phid)   X-Ref
No description

getUsersToNotifyOfTokenGiven()   X-Ref
No description

destroyObjectPermanently(PhabricatorDestructionEngine $engine)   X-Ref
No description


Generated: Sun Nov 30 09:20:46 2014 Cross-referenced by PHPXref 0.7.1