TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler Class Reference

Inheritance diagram for TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler:

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

Protected Member Functions
	getTitle ()
	renderItem (ResourceInterface $fileOrFolderObject)
Protected Member Functions inherited from TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler
	setTemporaryDbMounts ()
	getBackendUser ()
	getLanguageService ()

Protected Attributes
	$linkParts = []
	$expectedClass = File::class
	$mode = 'file'
	$expandFolder
	$additionalFolderClass = ''
Protected Attributes inherited from TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler
	$linkAttributes = [ 'target', 'title', 'class', 'params', 'rel' ]
	$updateSupported = true
	$linkBrowser
	$iconFactory

Detailed Description

Link handler for files

Definition at line 36 of file FileLinkHandler.php.

Member Function Documentation

canHandleLink()

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 74 of file FileLinkHandler.php.

References TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\$linkParts, TYPO3\CMS\Core\Utility\StringUtility\beginsWith(), and TYPO3\CMS\Core\Resource\ResourceFactory\getInstance().

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

Returns

string HTML output

Definition at line 210 of file FileLinkHandler.php.

References TYPO3\CMS\Core\Resource\Folder\checkActionPermission(), TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs(), TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler\getBackendUser(), TYPO3\CMS\Core\Resource\Folder\getCombinedIdentifier(), TYPO3\CMS\Core\Resource\Folder\getIdentifier(), TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\getTitle(), TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\renderItem(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

formatCurrentUrl()

TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::formatCurrentUrl

(

)

Format the current link for HTML output

Returns

string

Implements TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface.

Definition at line 104 of file FileLinkHandler.php.

References TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\expandFolder(), TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler\getBackendUser(), TYPO3\CMS\Core\Resource\ResourceFactory\getInstance(), TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler\getLanguageService(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface\render().

getBodyTagAttributes()

TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::getBodyTagAttributes

(

)

Returns

string[] Array of body-tag attributes

Implements TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface.

Definition at line 301 of file FileLinkHandler.php.

getScriptUrl()

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 336 of file FileLinkHandler.php.

getTitle()

TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::getTitle ( )

protected

Returns

string

Definition at line 254 of file FileLinkHandler.php.

References TYPO3\CMS\Core\Resource\Folder\getFiles(), TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler\getLanguageService(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Resource\Folder\setFileAndFolderNameFilters().

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

getUrlParameters()

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 313 of file FileLinkHandler.php.

References TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\expandFolder().

isCurrentlySelectedItem()

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 326 of file FileLinkHandler.php.

renderItem()

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

protected

Renders a single item displayed in the current folder

Parameters

ResourceInterface

$fileOrFolderObject

Returns

array

Exceptions

Definition at line 284 of file FileLinkHandler.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\formatSize(), TYPO3\CMS\Core\Resource\ResourceInterface\getName(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

Member Data Documentation

$additionalFolderClass

TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::$additionalFolderClass = ''

protected

Definition at line 63 of file FileLinkHandler.php.

$expandFolder

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

protected

Definition at line 58 of file FileLinkHandler.php.

$expectedClass

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

protected

Definition at line 48 of file FileLinkHandler.php.

$linkParts

TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler::$linkParts = []

protected

Definition at line 43 of file FileLinkHandler.php.

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

$mode

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

protected

Definition at line 53 of file FileLinkHandler.php.