Class FileVersion

Description
Description | Methods (details) Constants (details)

Located in /models/file_version.php (line 3) 

Object
   |
   --FileVersion
Class Constant Summary
Description | Constants (details) | Methods (details)
UT_DESCRIPTION = 3
UT_EXTENDED_ATTRIBUTE = 5
UT_NEW = 0
UT_REPLACE_FILE = 1
UT_TAGS = 4
UT_TITLE = 2
Method Summary
Description | Constants (details) Methods (details)
static void cleanTags ( $tagsStr)
void approve ()
void canEdit ()
void canView ()
void clearAttribute ( $ak)
void createThumbnailDirectories ()
void delete ()
void deny ()
void duplicate ()
void getAttribute ( $ak, [ $mode = false])
void getAttributeList ()
void getAttributeValueObject ( $ak, [ $createIfNotFound = false])
void getAuthorName ()
void getAuthorUserID ()
string getDateAdded ([string $type = 'system'])
void getDescription ()
void getDownloadURL ()
void getExtension ()
File getFile ()
void getFileID ()
void getFileName ()
void getFileVersionID ()
void getFullSize ()
void getGenericTypeText ()
void getMimeType ()
void getPath ()
void getPrefix ()
void getRelativePath ([ $fullurl = false])
void getSize ()
void getTags ()
void getTagsList ()
void getThumbnail ( $level, [ $fullImageTag = true])
void getThumbnailPath ( $level)
void getThumbnailSRC ( $level)
void getTitle ()
void getType ()
void getTypeObject ()
void getURL ()
void getVersionLogComments ()
void hasThumbnail ( $level)
void isApproved ()
void logVersionUpdate ( $updateTypeID, [ $updateTypeAttributeID = 0])
void populateAttributes ()
void refreshAttributes ([ $firstRun = false])
void refreshThumbnails ([ $refreshCache = true])
void setAttribute ( $ak,  $value)
void updateDescription ( $descr)
void updateFile ( $filename,  $prefix)
void updateTags ( $tags)
void updateTitle ( $title)
Methods
Description | Methods (details)
static cleanTags (line 558)
  • access: public
void cleanTags ( $tagsStr)
  • $tagsStr
approve (line 288)
  • access: public
void approve ()
canEdit (line 509)
  • access: public
void canEdit ()
canView (line 501)

Checks current viewers for this type and returns true if there is a viewer for this type, false if not

  • access: public
void canView ()
clearAttribute (line 517)
  • access: public
void clearAttribute ( $ak)
  • $ak
createThumbnailDirectories (line 490)
  • access: public
void createThumbnailDirectories ()
delete (line 322)

Removes a version of a file. Note, does NOT remove the file because we don't know where the file might elsewhere be used/referenced.

  • access: public
void delete ()
deny (line 299)
  • access: public
void deny ()
duplicate (line 130)

Takes the current value of the file version and makes a new one with the same values

  • access: public
void duplicate ()
getAttribute (line 65)

Gets an attribute for the file. If "nice mode" is set, we display it nicely

for use in the file attributes table

  • access: public
void getAttribute ( $ak, [ $mode = false])
  • $ak
  • $mode
getAttributeList (line 52)

Gets an associative array of all attributes for a file version

  • access: public
void getAttributeList ()
getAttributeValueObject (line 528)
  • access: public
void getAttributeValueObject ( $ak, [ $createIfNotFound = false])
  • $ak
  • $createIfNotFound
getAuthorName (line 90)
  • access: public
void getAuthorName ()
getAuthorUserID (line 94)
  • access: public
void getAuthorUserID ()
getDateAdded (line 104)

Gets the date a file version was added

if user is specified, returns in the current user's timezone

  • return: date formated like: 2009-01-01 00:00:00
string getDateAdded ([string $type = 'system'])
  • string $type: (system || user)
getDescription (line 21)
  • access: public
void getDescription ()
getDownloadURL (line 360)

Returns a URL that can be used to download the file. This passes through the download_file single page.

  • access: public
void getDownloadURL ()
getExtension (line 113)
  • access: public
void getExtension ()
getFile (line 33)

returns the File object associated with this FileVersion object

  • access: public
File getFile ()
getFileID (line 15)
  • access: public
void getFileID ()
getFileName (line 18)
  • access: public
void getFileName ()
getFileVersionID (line 16)
  • access: public
void getFileVersionID ()
getFullSize (line 87)
  • access: public
void getFullSize ()
getGenericTypeText (line 24)
  • access: public
void getGenericTypeText ()
getMimeType (line 71)
  • access: public
void getMimeType ()
getPath (line 338)

Returns a full filesystem path to the file on disk.

  • access: public
void getPath ()
getPrefix (line 17)
  • access: public
void getPrefix ()
getRelativePath (line 370)
  • access: public
void getRelativePath ([ $fullurl = false])
  • $fullurl
getSize (line 84)
  • access: public
void getSize ()
getTags (line 20)
  • access: public
void getTags ()
getTagsList (line 39)
  • access: public
void getTagsList ()
getThumbnail (line 410)
  • access: public
void getThumbnail ( $level, [ $fullImageTag = true])
  • $level
  • $fullImageTag
getThumbnailPath (line 390)
  • access: public
void getThumbnailPath ( $level)
  • $level
getThumbnailSRC (line 396)
  • access: public
void getThumbnailSRC ( $level)
  • $level
getTitle (line 19)
  • access: public
void getTitle ()
getType (line 194)
  • access: public
void getType ()
getTypeObject (line 201)
  • access: public
void getTypeObject ()
getURL (line 353)

Returns a full URL to the file on disk

  • access: public
void getURL ()
getVersionLogComments (line 212)

Returns an array containing human-readable descriptions of everything that happened in this version

  • access: public
void getVersionLogComments ()
hasThumbnail (line 405)
  • access: public
void hasThumbnail ( $level)
  • $level
isApproved (line 22)
  • access: public
void isApproved ()
logVersionUpdate (line 117)
  • access: public
void logVersionUpdate ( $updateTypeID, [ $updateTypeAttributeID = 0])
  • $updateTypeID
  • $updateTypeAttributeID
populateAttributes (line 78)
  • access: public
void populateAttributes ()
refreshAttributes (line 453)

Responsible for taking a particular version of a file and rescanning all its attributes This will run any type-based import routines, and store those attributes, generate thumbnails, etc...

  • access: public
void refreshAttributes ([ $firstRun = false])
  • $firstRun
refreshThumbnails (line 426)
  • access: public
void refreshThumbnails ([ $refreshCache = true])
  • $refreshCache
setAttribute (line 307)
  • access: public
void setAttribute ( $ak,  $value)
  • $ak
  • $value
updateDescription (line 267)
  • access: public
void updateDescription ( $descr)
  • $descr
updateFile (line 276)
  • access: public
void updateFile ( $filename,  $prefix)
  • $filename
  • $prefix
updateTags (line 256)
  • access: public
void updateTags ( $tags)
  • $tags
updateTitle (line 247)
  • access: public
void updateTitle ( $title)
  • $title
Class Constants
Description | Constants (details) | Methods (details)
UT_DESCRIPTION = 3 (line 11)
UT_EXTENDED_ATTRIBUTE = 5 (line 13)
UT_NEW = 0 (line 445)
UT_REPLACE_FILE = 1 (line 9)
UT_TAGS = 4 (line 12)
UT_TITLE = 2 (line 10)

Documentation generated on Thu, 15 Sep 2011 16:36:26 -0700 by phpDocumentor 1.4.1