TYPO3\CMS\Recordlist\Browser\FileBrowser Class Reference

Inheritance diagram for TYPO3\CMS\Recordlist\Browser\FileBrowser:

Public Member Functions
string	render ()
string	renderFilesInFolder (FolderInterface $folder, array $extensionList=[], $noThumbs=false)
string[]	getUrlParameters (array $values)
bool	isCurrentlySelectedItem (array $values)
string	getScriptUrl ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser
	__construct (IconFactory $iconFactory, PageRenderer $pageRenderer, UriBuilder $uriBuilder, ModuleTemplateFactory $moduleTemplateFactory)
array< string, getBodyTagAttributes() { return[];} protected array< string, function getBParamDataAttributes() { $params=explode('|', $this->bparams);$fieldRef=$params[0];$rteParams=$params[1];$rteConfig=$params[2];$irreObjectId=$params[4] ?? null;return['data-form-field-name'=> 'data[' . $fieldRef . '][' . $rteParams . '][' . $rteConfig . ']', 'data-field-reference'=> function	setRequest (ServerRequestInterface $request)
‪Public Member Functions inherited from ‪TYPO3\CMS\Recordlist\Browser\ElementBrowserInterface
array[]	processSessionData ($data)

Public Attributes
array< int, function processSessionData( $data) { if( $this->expandFolder !==null) { $data[ 'expandFolder']=$this->	expandFolder
	$store = true
	else
	return [$data, $store]

Protected Member Functions
	initialize ()
	initVariables ()
File[]	getFilesInFolder (FolderInterface $folder, array $extensionList)
string	getThumbnailSelector ()
bool	fileIsSelectableInFileList (FileInterface $file, array $imgInfo)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser
	determineScriptUrl ()
	setBodyTagParameters ()
	getRequest ()
LanguageService	getLanguageService ()
BackendUserAuthentication	getBackendUser ()

Protected Attributes
string null	$expandFolder
FolderInterface	$selectedFolder
string	$searchWord
array	$thumbnailConfiguration = array( )
‪Protected Attributes inherited from ‪TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser
ModuleTemplate	$moduleTemplate
string	$thisScript = ''
string	$bparams = ''
ServerRequestInterface	$request = null
IconFactory	$iconFactory
PageRenderer	$pageRenderer
UriBuilder	$uriBuilder
ModuleTemplateFactory	$moduleTemplateFactory
array< string, function getBodyTagAttributes() { return[];} protected array< string, function getBParamDataAttributes() { $params=explode('|', $this->bparams);$fieldRef=$params[0];$rteParams=$params[1];$rteConfig=$params[2];$irreObjectId=$params[4] ?? null;return['data-form-field-name'=> 'data[' . $fieldRef . '][' . $rteParams . '][' . $rteConfig . ']', 'data-field-reference'=>	$fieldRef

Detailed Description

Browser for files

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

Definition at line 40 of file FileBrowser.php.

Member Function Documentation

fileIsSelectableInFileList()

bool TYPO3\CMS\Recordlist\Browser\FileBrowser::fileIsSelectableInFileList ( FileInterface  $file, array  $imgInfo  )

protected

Checks if the given file is selectable in the filelist.

By default all files are selectable. This method may be overwritten in child classes.

Parameters

FileInterface	$file
mixed[]	$imgInfo	‪Image dimensions from \TYPO3\CMS\Core\Imaging\GraphicalFunctions::getImageDimensions()

Returns

‪bool TRUE if file is selectable.

Definition at line 439 of file FileBrowser.php.

Referenced by TYPO3\CMS\Recordlist\Browser\FileBrowser\renderFilesInFolder().

getFilesInFolder()

File [] TYPO3\CMS\Recordlist\Browser\FileBrowser::getFilesInFolder ( FolderInterface  $folder, array  $extensionList  )

protected

Get a list of Files in a folder filtered by extension

Parameters

FolderInterface	$folder
array	$extensionList

Returns

‪File[]

Definition at line 390 of file FileBrowser.php.

Referenced by TYPO3\CMS\Recordlist\Browser\FileBrowser\renderFilesInFolder().

getScriptUrl()

string TYPO3\CMS\Recordlist\Browser\FileBrowser::getScriptUrl

(

)

Returns the URL of the current script

Returns

‪string

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

Definition at line 471 of file FileBrowser.php.

References TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\$thisScript.

Referenced by TYPO3\CMS\Recordlist\Browser\FileBrowser\renderFilesInFolder().

getThumbnailSelector()

string TYPO3\CMS\Recordlist\Browser\FileBrowser::getThumbnailSelector ( )

protected

Get the HTML for the thumbnail selector, if enabled

Returns

‪string HTML data required for the thumbnail selector

Definition at line 405 of file FileBrowser.php.

References TYPO3\CMS\Core\Utility\HttpUtility\buildQueryString(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getBackendUser(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getLanguageService(), and TYPO3\CMS\Recordlist\Browser\FileBrowser\getUrlParameters().

Referenced by TYPO3\CMS\Recordlist\Browser\FileBrowser\renderFilesInFolder().

getUrlParameters()

string [] TYPO3\CMS\Recordlist\Browser\FileBrowser::getUrlParameters

(

array

$values

)

Parameters

array

$values

‪Array of values to include into the parameters

Returns

‪string[] Array of parameters which have to be added to URLs

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

Definition at line 448 of file FileBrowser.php.

References TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\$bparams, and TYPO3\CMS\Recordlist\Browser\FileBrowser\$expandFolder.

Referenced by TYPO3\CMS\Recordlist\Browser\FileBrowser\getThumbnailSelector(), and TYPO3\CMS\Recordlist\Browser\FileBrowser\renderFilesInFolder().

initialize()

TYPO3\CMS\Recordlist\Browser\FileBrowser::initialize ( )

protected

Loads additional JavaScript

Reimplemented from TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser.

Definition at line 66 of file FileBrowser.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getBackendUser(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getTSConfig().

initVariables()

TYPO3\CMS\Recordlist\Browser\FileBrowser::initVariables ( )

protected

Checks additional GET/POST requests

Reimplemented from TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser.

Definition at line 85 of file FileBrowser.php.

References TYPO3\CMS\Recordlist\Browser\FileBrowser\expandFolder, and TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getRequest().

isCurrentlySelectedItem()

bool TYPO3\CMS\Recordlist\Browser\FileBrowser::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 461 of file FileBrowser.php.

render()

string TYPO3\CMS\Recordlist\Browser\FileBrowser::render

(

)

Returns

‪string HTML content

Implements TYPO3\CMS\Recordlist\Browser\ElementBrowserInterface.

Definition at line 113 of file FileBrowser.php.

References TYPO3\CMS\Recordlist\Browser\FileBrowser\expandFolder, TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getBackendUser(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getLanguageService(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getRequest(), TYPO3\CMS\Recordlist\Browser\FileBrowser\renderFilesInFolder(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\setBodyTagParameters(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

renderFilesInFolder()

string TYPO3\CMS\Recordlist\Browser\FileBrowser::renderFilesInFolder	(	FolderInterface	$folder,
		array	$extensionList = [],
			$noThumbs = false
	)

For TYPO3 Element Browser: Expand folder of files.

Parameters

FolderInterface	$folder	‪The folder path to expand
array	$extensionList	‪List of fileextensions to show
bool	$noThumbs	‪Whether to show thumbnails or not. If set, no thumbnails are shown.

Returns

‪string HTML output

Definition at line 213 of file FileBrowser.php.

References TYPO3\CMS\Core\Utility\HttpUtility\buildQueryString(), TYPO3\CMS\Core\Resource\ProcessedFile\CONTEXT_IMAGEPREVIEW, TYPO3\CMS\Core\Resource\Search\FileSearchDemand\createForSearchTerm(), TYPO3\CMS\Recordlist\Browser\FileBrowser\fileIsSelectableInFileList(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getBackendUser(), TYPO3\CMS\Recordlist\Browser\FileBrowser\getFilesInFolder(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getLanguageService(), TYPO3\CMS\Core\Resource\ResourceStorage\getName(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getRequest(), TYPO3\CMS\Recordlist\Browser\FileBrowser\getScriptUrl(), TYPO3\CMS\Core\Resource\ResourceInterface\getStorage(), TYPO3\CMS\Recordlist\Browser\FileBrowser\getThumbnailSelector(), TYPO3\CMS\Recordlist\Browser\FileBrowser\getUrlParameters(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Recordlist\Browser\FileBrowser\render().

Member Data Documentation

$expandFolder

string null TYPO3\CMS\Recordlist\Browser\FileBrowser::$expandFolder

protected

When you click a folder name/expand icon to see the content of a certain file folder, this value will contain the path of the expanded file folder. If the value is NOT set, then it will be restored from the module session data. Example value: "/www/htdocs/typo3/32/3dsplm/fileadmin/css/"

Definition at line 49 of file FileBrowser.php.

Referenced by TYPO3\CMS\Recordlist\Browser\FileBrowser\getUrlParameters().

$searchWord

string TYPO3\CMS\Recordlist\Browser\FileBrowser::$searchWord

protected

Definition at line 57 of file FileBrowser.php.

$selectedFolder

FolderInterface TYPO3\CMS\Recordlist\Browser\FileBrowser::$selectedFolder

protected

Definition at line 53 of file FileBrowser.php.

$store

TYPO3\CMS\Recordlist\Browser\FileBrowser::$store = true

Definition at line 102 of file FileBrowser.php.

$thumbnailConfiguration

array TYPO3\CMS\Recordlist\Browser\FileBrowser::$thumbnailConfiguration = array( )

protected

Definition at line 61 of file FileBrowser.php.

else

TYPO3\CMS\Recordlist\Browser\FileBrowser::else

Initial value:

{
            $this->‪expandFolder = $data['expandFolder'] ?? null

Definition at line 103 of file FileBrowser.php.

expandFolder

array<int, function processSessionData($data) { if ($this->expandFolder !== null) { $data['expandFolder'] = $this-> TYPO3\CMS\Recordlist\Browser\FileBrowser::expandFolder

Session data for this class can be set from outside with this method.

Parameters

mixed[]

$data

‪Session data array

Returns

‪array<int, array|bool> Session data and boolean which indicates that data needs to be stored in session because it's changed

Definition at line 101 of file FileBrowser.php.

Referenced by TYPO3\CMS\Recordlist\Browser\FileBrowser\initVariables(), and TYPO3\CMS\Recordlist\Browser\FileBrowser\render().

return

TYPO3\CMS\Recordlist\Browser\FileBrowser::return[ $data, $store]

Definition at line 107 of file FileBrowser.php.