PHP Class tl_files

Provide miscellaneous methods that are used by the data configuration array.
Inheritance: extends Backend
Show file Open project: contao/core-bundle Class Usage Examples

Public Methods

Method Description
__construct ( ) Import the back end user object
addBreadcrumb ( ) Add the breadcrumb menu
addFileLocation ( DataContainer $dc ) : string Add the file location instead of the help text (see #6503)
checkFilename ( string $varValue, DataContainer $dc ) : mixed Check a file name and romanize it
checkImportantPart ( DataContainer $dc ) Only show the important part fields for images
checkPermission ( ) Check permissions to edit the file system
copyFile ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string Return the copy file button
cutFile ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string Return the cut file button
deleteFile ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string Return the delete file button
editFile ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string Return the edit file button
editSource ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string Return the edit file source button
protectFolder ( DataContainer $dc ) : string Return a checkbox to delete session data
showFile ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string Return the show file button
syncFiles ( string $href, string $label, string $title, string $class, string $attributes ) : string Return the sync files button

Method Details

__construct() public method

Import the back end user object
public __construct ( )

addBreadcrumb() public method

Add the breadcrumb menu
public addBreadcrumb ( )

addFileLocation() public method

Add the file location instead of the help text (see #6503)
public addFileLocation ( DataContainer $dc ) : string
$dc DataContainer
return string

checkFilename() public method

Check a file name and romanize it
public checkFilename ( string $varValue, DataContainer $dc ) : mixed
$varValue string
$dc DataContainer
return mixed

checkImportantPart() public method

Only show the important part fields for images
public checkImportantPart ( DataContainer $dc )
$dc DataContainer

checkPermission() public method

Check permissions to edit the file system
public checkPermission ( )

copyFile() public method

Return the copy file button
public copyFile ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
return string

cutFile() public method

Return the cut file button
public cutFile ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
return string

deleteFile() public method

Return the delete file button
public deleteFile ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
return string

editFile() public method

Return the edit file button
public editFile ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
return string

editSource() public method

Return the edit file source button
public editSource ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
return string

protectFolder() public method

Return a checkbox to delete session data
public protectFolder ( DataContainer $dc ) : string
$dc DataContainer
return string

showFile() public method

Return the show file button
public showFile ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
return string

syncFiles() public method

Return the sync files button
public syncFiles ( string $href, string $label, string $title, string $class, string $attributes ) : string
$href string
$label string
$title string
$class string
$attributes string
return string