TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Recordlist\Browser\ElementBrowser Class Reference
Inheritance diagram for TYPO3\CMS\Recordlist\Browser\ElementBrowser:
browse_links TYPO3\CMS\Rtehtmlarea\BrowseLinks TYPO3\CMS\Rtehtmlarea\SelectImage tx_rtehtmlarea_browse_links tx_rtehtmlarea_select_image

Public Member Functions

 getThisScript ()
 
 init ()
 
 initVariables ()
 
 initConfiguration ()
 
 getJsCode ()
 
 processSessionData ($data)
 
 main_rte ($wiz=FALSE)
 
 main_folder ()
 
 expandPage ()
 
 TBE_expandSubFolders (Folder $folder)
 
 expandFolder (Folder $folder, $extensionList='')
 
 TBE_expandFolder (Folder $folder, $extensionList='', $noThumbs=FALSE)
 
 folderList (Folder $baseFolder)
 
 TBE_dragNDrop (Folder $folder, $extensionList='')
 
 isWebFolder ($folder)
 
 checkFolder ($folder)
 
 barheader ($str)
 
 getMsgBox ($in_msg, $icon='icon_note')
 
 printCurrentUrl ($str)
 
 parseCurUrl ($href, $siteUrl)
 
 setRecordList ($recordList)
 
 uploadForm (Folder $folderObject)
 
 createFolder (Folder $folderObject)
 
 getBulkSelector ($filesCount)
 

Public Attributes

 $siteURL
 
 $thisScript
 
 $thisConfig
 
 $setTarget
 
 $setClass
 
 $setTitle
 
 $setParams
 
 $doc
 
 $elements = array()
 
 $mode
 
 $act
 
 $expandPage
 
 $expandFolder
 
 $P
 
 $bparams
 
 $RTEtsConfigParams
 
 $PM
 
 $pointer
 
 $curUrlArray
 
 $curUrlInfo
 
 $fileProcessor
 

Protected Member Functions

 determineScriptUrl ()
 
 initDocumentTemplate ()
 
 initHookObjects ($hookKey)
 
 initCurrentUrl ()
 
 getRTEConfig ()
 
 fileIsSelectableInFileList (\TYPO3\CMS\Core\Resource\FileInterface $file, array $imgInfo)
 
 areFieldChangeFunctionsValid ($handleFlexformSections=FALSE)
 

Protected Attributes

 $recordList = NULL
 
 $selectedFolder
 
 $hookObjects = array()
 

Detailed Description

class for the Element Browser window.

Author
Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om

Definition at line 28 of file ElementBrowser.php.

Member Function Documentation

◆ areFieldChangeFunctionsValid()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::areFieldChangeFunctionsValid (   $handleFlexformSections = FALSE)
protected

Determines whether submitted field change functions are valid and are coming from the system and not from an external abuse.

Parameters
boolean$handleFlexformSectionsWhether to handle flexform sections differently
Returns
boolean Whether the submitted field change functions are valid

Definition at line 2607 of file ElementBrowser.php.

Referenced by TYPO3\CMS\Recordlist\Browser\ElementBrowser\getJsCode().

◆ barheader()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::barheader (   $str)

Prints a 'header' where string is in a tablecell

Parameters
string$strThe string to print in the header. The value is htmlspecialchars()'ed before output.
Returns
string The header HTML (wrapped in a table)
Todo:
Define visibility

Definition at line 2248 of file ElementBrowser.php.

Referenced by TYPO3\CMS\Recordlist\Browser\ElementBrowser\expandPage(), TYPO3\CMS\Recordlist\Browser\ElementBrowser\main_folder(), TYPO3\CMS\Rtehtmlarea\BrowseLinks\main_rte(), TYPO3\CMS\Rtehtmlarea\SelectImage\main_rte(), TYPO3\CMS\Recordlist\Browser\ElementBrowser\main_rte(), and TYPO3\CMS\Recordlist\Browser\ElementBrowser\TBE_dragNDrop().

◆ checkFolder()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::checkFolder (   $folder)

Checks, if a path is within the mountpoints of the backend user

Parameters
string$folderAbsolute filepath
Returns
boolean If the input path is found in the backend users filemounts, then return TRUE.
Deprecated:
since 6.2 - will be removed two versions later without replacement

Definition at line 2236 of file ElementBrowser.php.

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

◆ createFolder()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::createFolder ( Folder  $folderObject)

For TBE: Makes a form for creating new folders in the filemount the user is browsing. The folder creation request is sent to the tce_file.php script in the core which will handle the creation.

Parameters
Folder$folderObjectAbsolute filepath on server in which to create the new folder.
Returns
string HTML for the create folder form.
Todo:
Define visibility

Definition at line 2507 of file ElementBrowser.php.

Referenced by TYPO3\CMS\Recordlist\Browser\ElementBrowser\main_folder(), TYPO3\CMS\Rtehtmlarea\BrowseLinks\main_rte(), TYPO3\CMS\Rtehtmlarea\SelectImage\main_rte(), and TYPO3\CMS\Recordlist\Browser\ElementBrowser\main_rte().

◆ determineScriptUrl()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::determineScriptUrl ( )
protected

◆ expandFolder()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::expandFolder ( Folder  $folder,
  $extensionList = '' 
)

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

Parameters
Folder$folderThe folder path to expand
string$extensionListList of file extensions to show
Returns
string HTML output
Todo:
Define visibility

Definition at line 1767 of file ElementBrowser.php.

Referenced by TYPO3\CMS\Recordlist\Browser\ElementBrowser\initVariables(), TYPO3\CMS\Recordlist\Browser\ElementBrowser\main_folder(), TYPO3\CMS\Rtehtmlarea\BrowseLinks\main_rte(), TYPO3\CMS\Rtehtmlarea\SelectImage\main_rte(), TYPO3\CMS\Recordlist\Browser\ElementBrowser\main_rte(), TYPO3\CMS\Rtehtmlarea\SelectImage\processSessionData(), and TYPO3\CMS\Recordlist\Browser\ElementBrowser\processSessionData().

◆ expandPage()

◆ fileIsSelectableInFileList()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::fileIsSelectableInFileList ( \TYPO3\CMS\Core\Resource\FileInterface  $file,
array  $imgInfo 
)
protected

Checks if the given file is selectable in the file list.

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

Parameters
\TYPO3\CMS\Core\Resource\FileInterface$file
array$imgInfoImage dimensions from ::getImageDimensions()
Returns
bool TRUE if file is selectable.

Definition at line 2012 of file ElementBrowser.php.

◆ folderList()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::folderList ( Folder  $baseFolder)

Render list of folders.

Parameters
Folder$baseFolder
Returns
string HTML output
Todo:
Define visibility

Definition at line 2023 of file ElementBrowser.php.

◆ getBulkSelector()

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

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

Parameters
integer$filesCountNumber of files currently displayed
Returns
string HTML data required for a bulk selection of files - if $filesCount is 0, nothing is returned
Todo:
Define visibility

Definition at line 2565 of file ElementBrowser.php.

◆ getJsCode()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::getJsCode ( )

◆ getMsgBox()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::getMsgBox (   $in_msg,
  $icon = 'icon_note' 
)

Displays a message box with the input message

Parameters
string$in_msgInput message to show (will be htmlspecialchars()'ed inside of this function)
string$iconIcon filename body from gfx/ (default is "icon_note") - meant to allow change to warning type icons...
Returns
string HTML for the message (wrapped in a table).
Todo:
Define visibility

Definition at line 2263 of file ElementBrowser.php.

References $GLOBALS, and TYPO3\CMS\Backend\Utility\IconUtility\skinImg().

Referenced by TYPO3\CMS\Rtehtmlarea\SelectImage\main_rte(), and TYPO3\CMS\Recordlist\Browser\ElementBrowser\TBE_dragNDrop().

◆ getRTEConfig()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::getRTEConfig ( )
protected

◆ getThisScript()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::getThisScript ( )

Calculate path to this script. This method is public, to be used in hooks of this class only.

Returns
string

Definition at line 257 of file ElementBrowser.php.

Referenced by TYPO3\CMS\Rtehtmlarea\BrowseLinks\getJSCode(), TYPO3\CMS\Rtehtmlarea\SelectImage\getJSCode(), TYPO3\CMS\Recordlist\Browser\ElementBrowser\getJsCode(), and TYPO3\CMS\Rtehtmlarea\SelectImage\main_rte().

◆ init()

◆ initConfiguration()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::initConfiguration ( )

Initializes the configuration variables

Returns
void

Definition at line 339 of file ElementBrowser.php.

References TYPO3\CMS\Recordlist\Browser\ElementBrowser\getRTEConfig().

Referenced by TYPO3\CMS\Recordlist\Browser\ElementBrowser\init().

◆ initCurrentUrl()

◆ initDocumentTemplate()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::initDocumentTemplate ( )
protected

Initialize document template object

Returns
void

Definition at line 351 of file ElementBrowser.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Recordlist\Browser\ElementBrowser\init().

◆ initHookObjects()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::initHookObjects (   $hookKey)
protected

Initialize hook objects implementing the interface

Parameters
string$hookKeythe hook key
Exceptions

Definition at line 369 of file ElementBrowser.php.

References $GLOBALS, $parameters, and TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj().

Referenced by TYPO3\CMS\Rtehtmlarea\BrowseLinks\init(), TYPO3\CMS\Rtehtmlarea\SelectImage\init(), and TYPO3\CMS\Recordlist\Browser\ElementBrowser\init().

◆ initVariables()

◆ isWebFolder()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::isWebFolder (   $folder)

Verifies that a path is a web-folder:

Parameters
string$folderAbsolute filepath
Returns
boolean If the input path is found in PATH_site then it returns TRUE.
Deprecated:
since 6.2 - will be removed two versions later without replacement

Definition at line 2223 of file ElementBrowser.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr(), and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

◆ main_folder()

◆ main_rte()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::main_rte (   $wiz = FALSE)

◆ parseCurUrl()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::parseCurUrl (   $href,
  $siteUrl 
)

For RTE/link: Parses the incoming URL and determines if it's a page, file, external or mail address.

Parameters
string$hrefHREF value tp analyse
string$siteUrlThe URL of the current website (frontend)
Returns
array Array with URL information stored in assoc. keys: value, act (page, file, spec, mail), pageid, cElement, info
Todo:
Define visibility

Definition at line 2321 of file ElementBrowser.php.

References $GLOBALS, $parameters, TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs(), TYPO3\CMS\Core\Resource\ResourceFactory\getInstance(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordsByField(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordWSOL(), and TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr().

Referenced by TYPO3\CMS\Rtehtmlarea\BrowseLinks\initCurrentUrl(), and TYPO3\CMS\Recordlist\Browser\ElementBrowser\initCurrentUrl().

◆ printCurrentUrl()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::printCurrentUrl (   $str)

For RTE/link: This prints the 'currentUrl'

Parameters
string$strURL value. The value is htmlspecialchars()'ed before output.
Returns
string HTML content, wrapped in a table.
Todo:
Define visibility

Definition at line 2287 of file ElementBrowser.php.

References $GLOBALS, and TYPO3\CMS\Core\Resource\ResourceFactory\getInstance().

Referenced by TYPO3\CMS\Rtehtmlarea\BrowseLinks\main_rte(), and TYPO3\CMS\Recordlist\Browser\ElementBrowser\main_rte().

◆ processSessionData()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::processSessionData (   $data)

Session data for this class can be set from outside with this method. Call after init()

Parameters
array$dataSession data array
Returns
array Session data and boolean which indicates that data needs to be stored in session because it's changed
Todo:
Define visibility

Definition at line 812 of file ElementBrowser.php.

References TYPO3\CMS\Recordlist\Browser\ElementBrowser\$expandFolder, TYPO3\CMS\Recordlist\Browser\ElementBrowser\$expandPage, TYPO3\CMS\Recordlist\Browser\ElementBrowser\expandFolder(), and TYPO3\CMS\Recordlist\Browser\ElementBrowser\expandPage().

◆ setRecordList()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::setRecordList (   $recordList)

Setter for the class that should be used by TBE_expandPage() to generate the record list. This method is intended to be used by Extensions that implement their own browsing functionality.

Parameters
\TYPO3\CMS\Backend\RecordList\ElementBrowserRecordList$recordList
Exceptions

Definition at line 2423 of file ElementBrowser.php.

◆ TBE_dragNDrop()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::TBE_dragNDrop ( Folder  $folder,
  $extensionList = '' 
)

◆ TBE_expandFolder()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::TBE_expandFolder ( Folder  $folder,
  $extensionList = '',
  $noThumbs = FALSE 
)

For TYPO3 Element Browser: Expand folder of files.

Parameters
Folder$folderThe folder path to expand
string$extensionListList of fileextensions to show
boolean$noThumbsWhether to show thumbnails or not. If set, no thumbnails are shown.
Returns
string HTML output
Todo:
Define visibility

Definition at line 1859 of file ElementBrowser.php.

Referenced by TYPO3\CMS\Rtehtmlarea\SelectImage\main_rte(), and TYPO3\CMS\Recordlist\Browser\ElementBrowser\main_rte().

◆ TBE_expandSubFolders()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::TBE_expandSubFolders ( Folder  $folder)

Render list of folders inside a folder.

Parameters
Folder$folderFolder
Returns
string HTML output
Todo:
Define visibility

Definition at line 1745 of file ElementBrowser.php.

Referenced by TYPO3\CMS\Recordlist\Browser\ElementBrowser\main_folder().

◆ uploadForm()

TYPO3\CMS\Recordlist\Browser\ElementBrowser::uploadForm ( Folder  $folderObject)

For TBE: Makes an upload form for uploading files to the filemount the user is browsing. The files are uploaded to the tce_file.php script in the core which will handle the upload.

Parameters
Folder$folderObjectAbsolute filepath on server to which to upload.
Returns
string HTML for an upload form.
Todo:
Define visibility

Definition at line 2438 of file ElementBrowser.php.

Referenced by TYPO3\CMS\Rtehtmlarea\BrowseLinks\main_rte(), TYPO3\CMS\Rtehtmlarea\SelectImage\main_rte(), and TYPO3\CMS\Recordlist\Browser\ElementBrowser\main_rte().

Member Data Documentation

◆ $act

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$act

Link selector action. page,file,url,mail,spec are allowed values. These are only important with the link selector function and in that case they switch between the various menu options.

Todo:
Define visibility

Definition at line 123 of file ElementBrowser.php.

Referenced by TYPO3\CMS\Rtehtmlarea\BrowseLinks\addClassSelector(), TYPO3\CMS\Rtehtmlarea\BrowseLinks\addTitleSelector(), TYPO3\CMS\Rtehtmlarea\SelectImage\getHelpMessage(), TYPO3\CMS\Rtehtmlarea\SelectImage\getJSCode(), TYPO3\CMS\Rtehtmlarea\SelectImage\main_rte(), and TYPO3\CMS\Rtehtmlarea\SelectImage\processSessionData().

◆ $bparams

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$bparams

Definition at line 184 of file ElementBrowser.php.

◆ $curUrlArray

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$curUrlArray

Definition at line 217 of file ElementBrowser.php.

◆ $curUrlInfo

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$curUrlInfo

Definition at line 227 of file ElementBrowser.php.

◆ $doc

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$doc

Definition at line 92 of file ElementBrowser.php.

◆ $elements

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$elements = array()

Holds information about files

Todo:
Define visibility

Definition at line 99 of file ElementBrowser.php.

◆ $expandFolder

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

◆ $expandPage

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$expandPage

When you click a page title/expand icon to see the content of a certain page, this value will contain that value (the ID of the expanded page). If the value is NOT set, then it will be restored from the module session data (see main(), mode="db")

Todo:
Define visibility

Definition at line 132 of file ElementBrowser.php.

Referenced by TYPO3\CMS\Recordlist\Browser\ElementBrowser\expandPage(), and TYPO3\CMS\Recordlist\Browser\ElementBrowser\processSessionData().

◆ $fileProcessor

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$fileProcessor

Definition at line 238 of file ElementBrowser.php.

◆ $hookObjects

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$hookObjects = array()
protected

Definition at line 233 of file ElementBrowser.php.

◆ $mode

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$mode

Definition at line 113 of file ElementBrowser.php.

◆ $P

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$P

Definition at line 159 of file ElementBrowser.php.

◆ $PM

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$PM

Plus/Minus icon value. Used by the tree class to open/close notes on the trees.

Todo:
Define visibility

Definition at line 200 of file ElementBrowser.php.

◆ $pointer

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$pointer

Pointer, used when browsing a long list of records etc.

Todo:
Define visibility

Definition at line 207 of file ElementBrowser.php.

◆ $recordList

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$recordList = NULL
protected

Definition at line 36 of file ElementBrowser.php.

◆ $RTEtsConfigParams

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$RTEtsConfigParams

◆ $selectedFolder

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$selectedFolder
protected

◆ $setClass

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$setClass

CSS Class (RTE specific)

Todo:
Define visibility

Definition at line 72 of file ElementBrowser.php.

Referenced by TYPO3\CMS\Rtehtmlarea\BrowseLinks\addTitleSelector().

◆ $setParams

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$setParams
Todo:
Define visibility

Definition at line 84 of file ElementBrowser.php.

◆ $setTarget

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$setTarget

Target (RTE specific)

Todo:
Define visibility

Definition at line 65 of file ElementBrowser.php.

◆ $setTitle

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$setTitle

title (RTE specific)

Todo:
Define visibility

Definition at line 79 of file ElementBrowser.php.

◆ $siteURL

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$siteURL

Definition at line 44 of file ElementBrowser.php.

◆ $thisConfig

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$thisConfig

RTE specific TSconfig

Todo:
Define visibility

Definition at line 58 of file ElementBrowser.php.

◆ $thisScript

TYPO3\CMS\Recordlist\Browser\ElementBrowser::$thisScript