This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation

Class Concrete5_Model_FileVersion

Concrete5_Library_Object
Extended by Object
Extended by Concrete5_Model_FileVersion

Direct known subclasses

FileVersion

Methods summary

public
public
public
public
public
# getTitle( )
public
# getTags( )
public
public
public
public File
# getFile( )

returns the File object associated with this FileVersion object

public
public
# getAttributeList( )

Gets an associative array of all attributes for a file version

public
# getAttribute( $ak, $mode = false )

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

public
public
# getSize( )
public
public
public
public string
# getDateAdded( string $type = 'system' )

Gets the date a file version was added if user is specified, returns in the current user's timezone

public
public
# logVersionUpdate( $updateTypeID, $updateTypeAttributeID = 0 )
public
# duplicate( )

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

public
# getType( )
public
public
# getVersionLogComments( )

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

public
# updateTitle( $title )
public
# updateTags( $tags )
public
# updateDescription( $descr )
public
# updateFile( $filename, $prefix )
public
# approve( )
public
# deny( )
public
# setAttribute( $ak, $value )
public
# delete( )

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.

public
# getPath( )

Returns a full filesystem path to the file on disk.

public
# getURL( )

Returns a full URL to the file on disk

public
# getDownloadURL( )

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

public
# getForceDownloadURL( )

Returns a url that can be used to download a file, will force the download of all file types, even if your browser can display them.

public
# getRelativePath( $fullurl = false )
public
# getThumbnailPath( $level )
public
# getThumbnailSRC( $level )
public
# hasThumbnail( $level )
public
# getThumbnail( $level, $fullImageTag = true )
public
# refreshThumbnails( $refreshCache = true )
public
# refreshAttributes( $firstRun = false )

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...

public
public
# canView( )

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

public
# canEdit( )
public
# clearAttribute( $ak )
public
# getAttributeValueObject( $ak, $createIfNotFound = false )
public static
# cleanTags( $tagsStr )

Constants summary

integer UT_REPLACE_FILE
# 1
integer UT_TITLE
# 2
integer UT_DESCRIPTION
# 3
integer UT_TAGS
# 4
integer UT_EXTENDED_ATTRIBUTE
# 5
integer UT_NEW
# 0

Properties summary

protected integer $numThumbnailLevels
# 3
protected array $attributes
# array()

Properties inherited from Concrete5_Library_Object

$error