TYPO3\CMS\Recordlist\Browser\FolderBrowser Class Reference

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

Public Member Functions
array[]	processSessionData ($data)
string	render ()
string[]	getUrlParameters (array $values)
bool	isCurrentlySelectedItem (array $values)
string	getScriptUrl ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser
	__construct ()

Protected Member Functions
	initialize ()
	initVariables ()
string	renderFolders (Folder $parentFolder)
string[]	getBodyTagAttributes ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser
	determineScriptUrl ()
	initDocumentTemplate ()
string[]	getBParamDataAttributes ()
LanguageService	getLanguageService ()
BackendUserAuthentication	getBackendUser ()

Protected Attributes
string null	$expandFolder
‪Protected Attributes inherited from ‪TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser
DocumentTemplate	$doc
PageRenderer	$pageRenderer
string	$thisScript = ''
IconFactory	$iconFactory
string	$bparams

Detailed Description

Browser for folders

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

Definition at line 29 of file FolderBrowser.php.

Member Function Documentation

getBodyTagAttributes()

string [] TYPO3\CMS\Recordlist\Browser\FolderBrowser::getBodyTagAttributes ( )

protected

Returns

‪string[] Array of body-tag attributes

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

Definition at line 202 of file FolderBrowser.php.

getScriptUrl()

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

(

)

Returns the URL of the current script

Returns

‪string

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

Definition at line 236 of file FolderBrowser.php.

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

getUrlParameters()

string [] TYPO3\CMS\Recordlist\Browser\FolderBrowser::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 213 of file FolderBrowser.php.

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

initialize()

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

protected

Adds additional JavaScript modules

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

Definition at line 43 of file FolderBrowser.php.

initVariables()

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

protected

Checks for an additional request parameter

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

Definition at line 56 of file FolderBrowser.php.

isCurrentlySelectedItem()

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

processSessionData()

array [] TYPO3\CMS\Recordlist\Browser\FolderBrowser::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 68 of file FolderBrowser.php.

References TYPO3\CMS\Recordlist\Browser\FolderBrowser\$expandFolder.

render()

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

(

)

Returns

‪string HTML content

Implements TYPO3\CMS\Recordlist\Browser\ElementBrowserInterface.

Definition at line 83 of file FolderBrowser.php.

References TYPO3\CMS\Core\Resource\ResourceFactory\getFolderObjectFromCombinedIdentifier(), TYPO3\CMS\Core\Resource\ResourceFactory\getInstance(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getLanguageService(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\initDocumentTemplate(), and TYPO3\CMS\Recordlist\Browser\FolderBrowser\renderFolders().

renderFolders()

string TYPO3\CMS\Recordlist\Browser\FolderBrowser::renderFolders ( Folder  $parentFolder )

protected

Parameters

Folder

$parentFolder

Returns

‪string HTML code

Definition at line 136 of file FolderBrowser.php.

References TYPO3\CMS\Core\Resource\Folder\checkActionPermission(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getBackendUser(), TYPO3\CMS\Core\Resource\Folder\getCombinedIdentifier(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getLanguageService(), TYPO3\CMS\Core\Resource\Folder\getName(), TYPO3\CMS\Core\Resource\Folder\getSubfolders(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

Member Data Documentation

$expandFolder

string null TYPO3\CMS\Recordlist\Browser\FolderBrowser::$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 38 of file FolderBrowser.php.

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