FileList

Class for rendering of File>Filelist (basically used in FileListController)

Tags

see

FileListController

Table of Contents

Properties

$addElement_tdCssClass  : array

Keys are fieldnames and values are td-css-classes to add in addElement();

$CBnames  : array

$clipObj  : Clipboard

$counter  : int

Counter increased for each element. Used to index elements for the JavaScript-code that transfers to the clipboard

$fieldArray  : array

Decides the columns shown. Filled with values that refers to the keys of the data-array. $this->fieldArray[0] is the title column.

$firstElementNumber  : int

$fixedL  : int

Max length of strings

$iLimit  : int

Default Max items shown

$sort  : string

The field to sort by

$sortRev  : bool

Reverse sorting flag

$spaceIcon  : string

Space icon used for alignment when no button is available

$thumbs  : bool

Thumbnails on records containing files (pictures)

$totalbytes  : int

$totalItems  : int

This could be set to the total number of items. Used by the fwd_rew_navigation.

$translateTools  : TranslationConfigurationProvider

$backendUserCache  : array

A runtime first-level cache to avoid unneeded calls to BackendUtility::getRecord()

$eventDispatcher  : EventDispatcherInterface

$fileExtensionFilter  : FileExtensionFilter|null

$folderObject  : Folder

$iconFactory  : IconFactory

$id  : int

$resourceFactory  : ResourceFactory

$searchDemand  : FileSearchDemand|null

$uriBuilder  : UriBuilder

Methods

__construct()  : mixed

addElement()  : string

Returns a table-row with the content from the fields in the input data array.

formatDirList()  : string

This returns tablerows for the directories in the array $items['sorting'].

formatFileList()  : string

This returns tablerows for the files in the array $items['sorting'].

fwd_rwd_nav()  : string

Creates a forward/reverse button based on the status of ->eCounter, ->firstElementNumber, ->iLimit

getFolderInfo()  : string

Gets the number of files and total size of a folder

getTable()  : string

Returns a table with directories and files listed.

linkWrapDir()  : string

Wraps the directory-titles

linkWrapFile()  : string

Wraps filenames in links which opens the metadata editor.

linkWrapSort()  : string

Wraps a field label for the header row into a link to the filelist with sorting commands

listURL()  : string

Returns list URL; This is the URL of the current script with id and imagemode parameters, that's all.

makeClip()  : array

Creates the clipboard actions

makeEdit()  : string

Creates the edit control section

makeRef()  : string

Make reference count. Wraps the count into a button to open the element information in case references exists.

setColumnsToRender()  : void

start()  : mixed

Initialization of class

fileDownloadEnabled()  : bool

Whether file download is enabled for the user

getBackendUser()  : BackendUserAuthentication

Returns the current BE user.

getBackendUserInformation()  : string

Helper method around fetching a "cruser_id" information for a record, with a cache, so the same information does not have to be processed for the same user over and over again.

getConcreteTableName()  : string

Determine the concrete table name by checking if the field exists, while sys_file takes precedence.

getFileOrFolderIcon()  : string

Get the icon for a file or folder object

getFileReferenceCount()  : int

Counts how often the given file is referenced. This is done by looking up the file in the "sys_refindex" table, while excluding sys_file_metadata relations as these are no such references.

getLanguageService()  : LanguageService

Returns an instance of LanguageService

getTranslationsForMetaData()  : array<int, array<string, mixed>>

Fetch the translations for a sys_file_metadata record

isEditMetadataAllowed()  : bool

makeCheckbox()  : string

Adds the checkbox to select a file/folder in the listing

makePath()  : string

Generate readable path

makeTranslations()  : string

Creates the file metadata translation dropdown. Each item links to the corresponding metadata translation, while depending on the current state, either a new translation can be created or an existing translation can be edited.

renderCheckboxActions()  : string

Render convenience actions, such as "check all"

sortFiles()  : File[]

sortFolders()  : Folder[]