☰ Browse the reference

Model·Files module

FileRevision

A model in the Files module, with 14 members for templates, 11 API properties and 14 members for admin templates.

Files\Models\Frontend\FileRevisionCopy Files\Models\Api\FileRevisionCopy Files\Models\Backend\FileRevisionCopy Also in Files: FavoriteFilename FavoriteFolder File Filename FilenameComment Folder FolderComment Image ImageRevision SharedFilename VirtualFile

View

Templates14 API & Jobs11 Admin14

What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Filter

Templates view

Properties 14

Take no arguments.

# isActiveRevision()

bool

Check if the revision is the active revision

# getPreviewImage()

?Image

Get a preview image for the file revision. Returns null if no preview image exists.

# getId()

?int

# getName()

?string

# getText()

?string

# getCreated()

?DateTime

Get the date the record was created.

# getCreatedBy()

?User

# getModifiedBy()

?User

# getModified()

?DateTime

Get the last modification date for the record.

# getFile()

?File

# getVirtualFile()

?VirtualFile

# isNewRecord() Not in API & Jobs

bool

Check if the record is a new record

# isHierarchicalModel() Not in API & Jobs

bool

Check whether a model is a hierarchical model, i.e. can have children

# isVersionedModel() Not in API & Jobs

bool

Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 11

Read-only values on the record.

# activeRevision

bool

Check if the revision is the active revision

# previewImage

?Image

Get a preview image for the file revision. Returns null if no preview image exists.

# id

?int

# name

?string

# text

?string

# created

?DateTime

Get the date the record was created.

# createdBy

?User

# modifiedBy

?User

# modified

?DateTime

Get the last modification date for the record.

# file

?File

# virtualFile

?VirtualFile

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 14

Take no arguments.

# isActiveRevision()

bool

Check if the revision is the active revision

# getPreviewImage()

?Image

Get a preview image for the file revision. Returns null if no preview image exists.

# getId()

?int

# getName()

?string

# getText()

?string

# getCreated()

?DateTime

Get the date the record was created.

# getCreatedBy()

?User

# getModifiedBy()

?User

# getModified()

?DateTime

Get the last modification date for the record.

# getFile()

?File

# getVirtualFile()

?VirtualFile

# isNewRecord() Not in API & Jobs

bool

Check if the record is a new record

# isHierarchicalModel() Not in API & Jobs

bool

Check whether a model is a hierarchical model, i.e. can have children

# isVersionedModel() Not in API & Jobs

bool

Check whether a model is versioned