TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FileLinkHandler Class Reference
Inheritance diagram for FileLinkHandler:
AbstractLinkHandler LinkHandlerInterface LinkParameterProviderInterface FolderLinkHandler

Public Member Functions

 canHandleLink (array $linkParts)
 
 formatCurrentUrl ()
 
 expandFolder (Folder $folder, $extensionList= '')
 
 getBodyTagAttributes ()
 
 getUrlParameters (array $values)
 
 isCurrentlySelectedItem (array $values)
 
 getScriptUrl ()
 

Protected Member Functions

 getTitle ()
 
 renderItem (ResourceInterface $fileOrFolderObject)
 

Protected Attributes

 $linkParts = []
 
 $expectedClass = File::class
 
 $mode = 'file'
 
 $expandFolder
 
 $additionalFolderClass = ''
 

Detailed Description

Link handler for files

Definition at line 36 of file FileLinkHandler.php.

Member Function Documentation

canHandleLink ( array  $linkParts)

Checks if this is the handler for the given link

The handler may store this information locally for later usage.

Parameters
array$linkPartsLink parts as returned from TypoLinkCodecService
Returns
bool

Implements LinkHandlerInterface.

Definition at line 74 of file FileLinkHandler.php.

References FileLinkHandler\$linkParts, $url, StringUtility\beginsWith(), and ResourceFactory\getInstance().

expandFolder ( Folder  $folder,
  $extensionList = '' 
)

For RTE: This displays all files from folder. No thumbnails shown

Parameters
Folder$folderThe folder path to expand
string$extensionListList of file extensions to show
Returns
string HTML output

Definition at line 209 of file FileLinkHandler.php.

References Folder\checkActionPermission(), GeneralUtility\fixed_lgd_cs(), AbstractLinkHandler\getBackendUser(), Folder\getCombinedIdentifier(), Folder\getIdentifier(), FileLinkHandler\getTitle(), FileLinkHandler\renderItem(), and Icon\SIZE_SMALL.

Referenced by FileLinkHandler\getUrlParameters().

formatCurrentUrl ( )

Format the current link for HTML output

Returns
string

Implements LinkHandlerInterface.

Definition at line 103 of file FileLinkHandler.php.

getBodyTagAttributes ( )
Returns
string[] Array of body-tag attributes

Implements LinkHandlerInterface.

Definition at line 298 of file FileLinkHandler.php.

getScriptUrl ( )

Returns the URL of the current script

Returns
string

Implements LinkParameterProviderInterface.

Definition at line 333 of file FileLinkHandler.php.

getTitle ( )
protected
Returns
string

Definition at line 251 of file FileLinkHandler.php.

References AbstractLinkHandler\getLanguageService().

Referenced by FileLinkHandler\expandFolder().

getUrlParameters ( array  $values)
Parameters
array$valuesArray of values to include into the parameters or which might influence the parameters
Returns
string[] Array of parameters which have to be added to URLs

Implements LinkParameterProviderInterface.

Definition at line 310 of file FileLinkHandler.php.

References FileLinkHandler\expandFolder().

isCurrentlySelectedItem ( array  $values)
Parameters
array$valuesValues to be checked
Returns
bool Returns TRUE if the given values match the currently selected item

Implements LinkParameterProviderInterface.

Definition at line 323 of file FileLinkHandler.php.

renderItem ( ResourceInterface  $fileOrFolderObject)
protected

Renders a single item displayed in the current folder

Parameters
ResourceInterface$fileOrFolderObject
Returns
array
Exceptions
\InvalidArgumentException

Definition at line 281 of file FileLinkHandler.php.

References GeneralUtility\formatSize(), ResourceInterface\getName(), and Icon\SIZE_SMALL.

Referenced by FileLinkHandler\expandFolder().

Member Data Documentation

$additionalFolderClass = ''
protected

Definition at line 63 of file FileLinkHandler.php.

$expandFolder
protected

Definition at line 58 of file FileLinkHandler.php.

$expectedClass = File::class
protected

Definition at line 48 of file FileLinkHandler.php.

$linkParts = []
protected

Definition at line 43 of file FileLinkHandler.php.

Referenced by FileLinkHandler\canHandleLink().

$mode = 'file'
protected

Definition at line 53 of file FileLinkHandler.php.