‪TYPO3CMS  10.4
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler Class Reference
Inheritance diagram for TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler:
TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface TYPO3\CMS\Recordlist\Tree\View\LinkParameterProviderInterface TYPO3\CMS\Recordlist\LinkHandler\FolderLinkHandler

Public Member Functions

bool canHandleLink (array $linkParts)
 
string formatCurrentUrl ()
 
string render (ServerRequestInterface $request)
 
 expandFolder (Folder $folder, $extensionList='')
 
string[] getBodyTagAttributes ()
 
string[] getUrlParameters (array $values)
 
bool isCurrentlySelectedItem (array $values)
 
string getScriptUrl ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler
 __construct ()
 
 initialize (AbstractLinkBrowserController $linkBrowser, $identifier, array $configuration)
 
array getLinkAttributes ()
 
string[] modifyLinkAttributes (array $fieldDefinitions)
 
bool isUpdateSupported ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface
array getLinkAttributes ()
 
string[] modifyLinkAttributes (array $fieldDefinitions)
 
 initialize (AbstractLinkBrowserController $linkBrowser, $identifier, array $configuration)
 
bool isUpdateSupported ()
 

Protected Member Functions

FileInterface[] Folder[] getFolderContent (Folder $folder, $extensionList)
 
array renderItem (ResourceInterface $fileOrFolderObject)
 
mixed getSelectedFolder ($folderIdentifier='')
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler
 setTemporaryDbMounts ()
 
BackendUserAuthentication getBackendUser ()
 
LanguageService getLanguageService ()
 

Protected Attributes

array $linkParts = array( )
 
string $expectedClass = File::class
 
string $mode = 'file'
 
string $expandFolder
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler
string[] $linkAttributes = array( 'target', 'title', 'class', 'params', 'rel' )
 
bool $updateSupported = true
 
AbstractLinkBrowserController $linkBrowser
 
IconFactory $iconFactory
 
TYPO3 CMS Fluid View StandaloneView $view
 

Detailed Description

Link handler for files

This class is a specific LinkHandler implementation and is not part of the TYPO3's Core API.

Definition at line 37 of file FileLinkHandler.php.

Member Function Documentation

◆ canHandleLink()

bool TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::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$linkParts‪Link parts as returned from TypoLinkCodecService
Returns
‪bool

Implements TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface.

Definition at line 66 of file FileLinkHandler.php.

References TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\$linkParts.

◆ expandFolder()

TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::expandFolder ( Folder  $folder,
  $extensionList = '' 
)

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

Parameters
Folder$folder‪The folder path to expand
string$extensionList‪List of file extensions to show

Definition at line 145 of file FileLinkHandler.php.

References TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\getFolderContent(), TYPO3\CMS\Core\Resource\Folder\getIdentifier(), TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\renderItem(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Core\LinkHandling\LinkService\TYPE_FOLDER.

Referenced by TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\render().

◆ formatCurrentUrl()

string TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::formatCurrentUrl ( )

Format the current link for HTML output

Returns
‪string

Implements TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface.

Definition at line 83 of file FileLinkHandler.php.

References TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\$mode.

◆ getBodyTagAttributes()

string [] TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::getBodyTagAttributes ( )
Returns
‪string[] Array of body-tag attributes

Implements TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface.

Reimplemented in TYPO3\CMS\Recordlist\LinkHandler\FolderLinkHandler.

Definition at line 218 of file FileLinkHandler.php.

References TYPO3\CMS\Core\LinkHandling\LinkService\TYPE_FILE.

◆ getFolderContent()

FileInterface [] Folder [] TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::getFolderContent ( Folder  $folder,
  $extensionList 
)
protected
Parameters
Folder$folder
string$extensionList
Returns
‪FileInterface[]|Folder[]

Reimplemented in TYPO3\CMS\Recordlist\LinkHandler\FolderLinkHandler.

Definition at line 175 of file FileLinkHandler.php.

References TYPO3\CMS\Core\Resource\Folder\getFiles(), and TYPO3\CMS\Core\Resource\Folder\setFileAndFolderNameFilters().

Referenced by TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\expandFolder().

◆ getScriptUrl()

string TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::getScriptUrl ( )

Returns the URL of the current script

Returns
‪string

Implements TYPO3\CMS\Recordlist\Tree\View\LinkParameterProviderInterface.

Definition at line 253 of file FileLinkHandler.php.

◆ getSelectedFolder()

mixed TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::getSelectedFolder (   $folderIdentifier = '')
protected

Returns the currently selected folder, or th default upload folder

Parameters
string$folderIdentifier
Returns
‪mixed the folder object or false if nothing was found

Definition at line 264 of file FileLinkHandler.php.

References TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler\getBackendUser(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getDefaultUploadFolder().

Referenced by TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\render().

◆ getUrlParameters()

string [] TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::getUrlParameters ( array  $values)
Parameters
array$values‪Array 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 TYPO3\CMS\Recordlist\Tree\View\LinkParameterProviderInterface.

Definition at line 230 of file FileLinkHandler.php.

References TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\$expandFolder.

◆ isCurrentlySelectedItem()

bool TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::isCurrentlySelectedItem ( array  $values)
Parameters
array$values‪Values to be checked
Returns
‪bool Returns TRUE if the given values match the currently selected item

Implements TYPO3\CMS\Recordlist\Tree\View\LinkParameterProviderInterface.

Definition at line 243 of file FileLinkHandler.php.

◆ render()

string TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::render ( ServerRequestInterface  $request)

Render the link handler

Parameters
ServerRequestInterface$request
Returns
‪string

Implements TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface.

Definition at line 95 of file FileLinkHandler.php.

References TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\$mode, TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\expandFolder(), and TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\getSelectedFolder().

◆ renderItem()

array TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::renderItem ( ResourceInterface  $fileOrFolderObject)
protected

Renders a single item displayed in the current folder

Parameters
ResourceInterface$fileOrFolderObject
Returns
‪array
Exceptions

Reimplemented in TYPO3\CMS\Recordlist\LinkHandler\FolderLinkHandler.

Definition at line 194 of file FileLinkHandler.php.

References TYPO3\CMS\Core\Resource\ResourceInterface\getName(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Core\LinkHandling\LinkService\TYPE_FILE.

Referenced by TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\expandFolder().

Member Data Documentation

◆ $expandFolder

string TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::$expandFolder
protected

Definition at line 55 of file FileLinkHandler.php.

Referenced by TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\getUrlParameters().

◆ $expectedClass

string TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::$expectedClass = File::class
protected

Definition at line 47 of file FileLinkHandler.php.

◆ $linkParts

array TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::$linkParts = array( )
protected

Parts of the current link

Definition at line 43 of file FileLinkHandler.php.

Referenced by TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\canHandleLink().

◆ $mode

string TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::$mode = 'file'
protected

Definition at line 51 of file FileLinkHandler.php.

Referenced by TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\formatCurrentUrl(), and TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\render().