TYPO3\CMS\Recordlist\Browser\FileBrowser Class Reference

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

Public Member Functions
	processSessionData ($data)
	renderFilesInFolder (Folder $folder, array $extensionList=[], $noThumbs=false)
	getUrlParameters (array $values)
	isCurrentlySelectedItem (array $values)
	getScriptUrl ()
Public Member Functions inherited from TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser
	__construct ()
Public Member Functions inherited from TYPO3\CMS\Recordlist\Browser\ElementBrowserInterface
	render ()

Protected Member Functions
	initialize ()
	initVariables ()
	getBulkSelector ($filesCount)
	fileIsSelectableInFileList (FileInterface $file, array $imgInfo)
	getBodyTagAttributes ()
Protected Member Functions inherited from TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser
	initialize ()
	determineScriptUrl ()
	initVariables ()
	initDocumentTemplate ()
	getBodyTagAttributes ()
	getBParamDataAttributes ()
	getLanguageService ()
	getBackendUser ()

Protected Attributes
	$expandFolder
	$selectedFolder
	$elements = []
	$searchWord
	$fileRepository
Protected Attributes inherited from TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser
	$doc
	$pageRenderer = null
	$thisScript = ''
	$iconFactory
	$bparams

Detailed Description

Browser for files

Definition at line 35 of file FileBrowser.php.

Member Function Documentation

fileIsSelectableInFileList()

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 ::getImageDimensions()

Returns

bool TRUE if file is selectable.

Definition at line 434 of file FileBrowser.php.

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

getBodyTagAttributes()

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

protected

Returns

string[] Array of body-tag attributes

Definition at line 442 of file FileBrowser.php.

getBulkSelector()

TYPO3\CMS\Recordlist\Browser\FileBrowser::getBulkSelector (   $filesCount )

protected

Get the HTML data required for a bulk selection of files of the TYPO3 Element Browser.

Parameters

int

$filesCount

Number of files currently displayed

Returns

string HTML data required for a bulk selection of files - if $filesCount is 0, nothing is returned

Definition at line 391 of file FileBrowser.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getBackendUser(), TYPO3\CMS\Backend\Utility\BackendUtility\getFuncCheck(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getModuleData(), TYPO3\CMS\Recordlist\Browser\FileBrowser\getUrlParameters(), and TYPO3\CMS\Core\Utility\GeneralUtility\implodeArrayForUrl().

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

getScriptUrl()

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 477 of file FileBrowser.php.

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

getUrlParameters()

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 454 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\getBulkSelector().

initialize()

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

protected

Returns

void

Definition at line 72 of file FileBrowser.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

initVariables()

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

protected

Returns

void

Definition at line 82 of file FileBrowser.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\_GP().

isCurrentlySelectedItem()

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 467 of file FileBrowser.php.

processSessionData()

TYPO3\CMS\Recordlist\Browser\FileBrowser::processSessionData

(

$data

)

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

Parameters

mixed[]

$data Session data array

Returns

array[] Session data and boolean which indicates that data needs to be stored in session because it's changed

Implements TYPO3\CMS\Recordlist\Browser\ElementBrowserInterface.

Definition at line 95 of file FileBrowser.php.

References TYPO3\CMS\Recordlist\Browser\FileBrowser\$expandFolder, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getBackendUser(), TYPO3\CMS\Core\Resource\ResourceFactory\getInstance(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getModuleData(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\initDocumentTemplate(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Recordlist\Browser\ElementBrowserInterface\render(), TYPO3\CMS\Recordlist\Browser\FileBrowser\renderFilesInFolder(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

renderFilesInFolder()

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

For TYPO3 Element Browser: Expand folder of files.

Parameters

Folder	$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 231 of file FileBrowser.php.

References $GLOBALS, TYPO3\CMS\Core\Resource\Folder\checkActionPermission(), TYPO3\CMS\Core\Resource\ProcessedFile\CONTEXT_IMAGEPREVIEW, TYPO3\CMS\Recordlist\Browser\FileBrowser\fileIsSelectableInFileList(), TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs(), TYPO3\CMS\Core\Utility\GeneralUtility\formatSize(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getBackendUser(), TYPO3\CMS\Recordlist\Browser\FileBrowser\getBulkSelector(), TYPO3\CMS\Core\Resource\Folder\getFiles(), TYPO3\CMS\Core\Resource\Folder\getIdentifier(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getLanguageService(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Resource\Folder\setFileAndFolderNameFilters(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

Member Data Documentation

$elements

TYPO3\CMS\Recordlist\Browser\FileBrowser::$elements = []

protected

Definition at line 57 of file FileBrowser.php.

$expandFolder

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

protected

Definition at line 45 of file FileBrowser.php.

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

$fileRepository

TYPO3\CMS\Recordlist\Browser\FileBrowser::$fileRepository

protected

Definition at line 67 of file FileBrowser.php.

$searchWord

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

protected

Definition at line 62 of file FileBrowser.php.

$selectedFolder

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

protected

Definition at line 50 of file FileBrowser.php.