‪TYPO3CMS  11.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Filelist\Controller\FileListController Class Reference
Inheritance diagram for TYPO3\CMS\Filelist\Controller\FileListController:

Public Member Functions

 __construct (UriBuilder $uriBuilder, PageRenderer $pageRenderer, IconFactory $iconFactory, ResourceFactory $resourceFactory, ModuleTemplateFactory $moduleTemplateFactory, ResponseFactoryInterface $responseFactory)
 
 handleRequest (ServerRequestInterface $request)
 

Protected Member Functions

 processRequest (ServerRequestInterface $request)
 
 initializeView ()
 
 initializeModule (ServerRequestInterface $request)
 
 initializeFileList (ServerRequestInterface $request)
 
 generateFileList ()
 
 registerDrapUploader ()
 
 registerFileListCheckboxes ()
 
 registerAdditionalDocHeaderButtons (ServerRequestInterface $request)
 
string getModuleHeadline ()
 
string getDefaultDuplicationBehaviourAction ()
 
ResponseInterface htmlResponse (string $html)
 
 addFlashMessage (string $message, string $title='', int $severity=FlashMessage::INFO)
 
string getFileUploadUrl ()
 
LanguageService getLanguageService ()
 
BackendUserAuthentication getBackendUser ()
 

Protected Attributes

array $MOD_MENU = []
 
array $MOD_SETTINGS = []
 
string $id = ''
 
string $cmd = ''
 
string $searchTerm = ''
 
int $pointer = 0
 
Folder $folderObject = null
 
DuplicationBehavior $overwriteExistingFiles = null
 
UriBuilder $uriBuilder
 
PageRenderer $pageRenderer
 
IconFactory $iconFactory
 
ResourceFactory $resourceFactory
 
ModuleTemplateFactory $moduleTemplateFactory
 
ResponseFactoryInterface $responseFactory
 
ModuleTemplate $moduleTemplate = null
 
ViewInterface $view = null
 
FileList $filelist = null
 

Detailed Description

Script Class for creating the list of files in the File > Filelist module

this is a concrete TYPO3 controller implementation and solely used for EXT:filelist and not part of TYPO3's Core API.

Definition at line 59 of file FileListController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Filelist\Controller\FileListController::__construct ( UriBuilder  $uriBuilder,
PageRenderer  $pageRenderer,
IconFactory  $iconFactory,
ResourceFactory  $resourceFactory,
ModuleTemplateFactory  $moduleTemplateFactory,
ResponseFactoryInterface  $responseFactory 
)

Definition at line 83 of file FileListController.php.

References TYPO3\CMS\Filelist\Controller\FileListController\$iconFactory, TYPO3\CMS\Filelist\Controller\FileListController\$moduleTemplateFactory, TYPO3\CMS\Filelist\Controller\FileListController\$pageRenderer, TYPO3\CMS\Filelist\Controller\FileListController\$resourceFactory, TYPO3\CMS\Filelist\Controller\FileListController\$responseFactory, and TYPO3\CMS\Filelist\Controller\FileListController\$uriBuilder.

Member Function Documentation

◆ addFlashMessage()

TYPO3\CMS\Filelist\Controller\FileListController::addFlashMessage ( string  $message,
string  $title = '',
int  $severity = FlashMessage::INFO 
)
protected

Adds a flash message to the default flash message queue

Parameters
string$message
string$title
int$severity

Definition at line 716 of file FileListController.php.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\generateFileList(), and TYPO3\CMS\Filelist\Controller\FileListController\handleRequest().

◆ generateFileList()

TYPO3\CMS\Filelist\Controller\FileListController::generateFileList ( )
protected

Definition at line 388 of file FileListController.php.

References $GLOBALS, TYPO3\CMS\Filelist\Controller\FileListController\addFlashMessage(), TYPO3\CMS\Core\Resource\Search\FileSearchDemand\createForSearchTerm(), TYPO3\CMS\Filelist\Controller\FileListController\getBackendUser(), and TYPO3\CMS\Filelist\Controller\FileListController\getLanguageService().

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\processRequest().

◆ getBackendUser()

BackendUserAuthentication TYPO3\CMS\Filelist\Controller\FileListController::getBackendUser ( )
protected

Returns the current BE user.

Returns
‪BackendUserAuthentication

Definition at line 755 of file FileListController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\generateFileList(), TYPO3\CMS\Filelist\Controller\FileListController\getDefaultDuplicationBehaviourAction(), TYPO3\CMS\Filelist\Controller\FileListController\handleRequest(), TYPO3\CMS\Filelist\Controller\FileListController\initializeFileList(), TYPO3\CMS\Filelist\Controller\FileListController\initializeModule(), and TYPO3\CMS\Filelist\Controller\FileListController\registerFileListCheckboxes().

◆ getDefaultDuplicationBehaviourAction()

string TYPO3\CMS\Filelist\Controller\FileListController::getDefaultDuplicationBehaviourAction ( )
protected

Return the default duplication behaviour action, set in TSconfig

Returns
‪string

Definition at line 670 of file FileListController.php.

References TYPO3\CMS\Core\Resource\DuplicationBehavior\CANCEL, TYPO3\CMS\Filelist\Controller\FileListController\getBackendUser(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getTSConfig(), TYPO3\CMS\Core\Resource\DuplicationBehavior\RENAME, and TYPO3\CMS\Core\Resource\DuplicationBehavior\REPLACE.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\registerDrapUploader().

◆ getFileUploadUrl()

string TYPO3\CMS\Filelist\Controller\FileListController::getFileUploadUrl ( )
protected

Returns the URL for uploading files

Returns
‪string

Definition at line 729 of file FileListController.php.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\registerAdditionalDocHeaderButtons().

◆ getLanguageService()

LanguageService TYPO3\CMS\Filelist\Controller\FileListController::getLanguageService ( )
protected

Returns an instance of LanguageService

Returns
‪LanguageService

Definition at line 745 of file FileListController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\generateFileList(), TYPO3\CMS\Filelist\Controller\FileListController\handleRequest(), TYPO3\CMS\Filelist\Controller\FileListController\processRequest(), TYPO3\CMS\Filelist\Controller\FileListController\registerAdditionalDocHeaderButtons(), TYPO3\CMS\Filelist\Controller\FileListController\registerDrapUploader(), and TYPO3\CMS\Filelist\Controller\FileListController\registerFileListCheckboxes().

◆ getModuleHeadline()

string TYPO3\CMS\Filelist\Controller\FileListController::getModuleHeadline ( )
protected

Get main headline based on active folder or storage for backend module Folder names are resolved to their special names like done in the tree view.

Returns
‪string

Definition at line 649 of file FileListController.php.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\processRequest().

◆ handleRequest()

TYPO3\CMS\Filelist\Controller\FileListController::handleRequest ( ServerRequestInterface  $request)

Definition at line 99 of file FileListController.php.

References TYPO3\CMS\Filelist\Controller\FileListController\addFlashMessage(), TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Filelist\Controller\FileListController\getBackendUser(), TYPO3\CMS\Filelist\Controller\FileListController\getLanguageService(), TYPO3\CMS\Filelist\Controller\FileListController\htmlResponse(), TYPO3\CMS\Filelist\Controller\FileListController\initializeModule(), TYPO3\CMS\Filelist\Controller\FileListController\initializeView(), and TYPO3\CMS\Filelist\Controller\FileListController\processRequest().

◆ htmlResponse()

ResponseInterface TYPO3\CMS\Filelist\Controller\FileListController::htmlResponse ( string  $html)
protected

Generate a response by either the given $html or by rendering the module content.

Parameters
string$html
Returns
‪ResponseInterface

Definition at line 699 of file FileListController.php.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\handleRequest(), and TYPO3\CMS\Filelist\Controller\FileListController\processRequest().

◆ initializeFileList()

TYPO3\CMS\Filelist\Controller\FileListController::initializeFileList ( ServerRequestInterface  $request)
protected

Definition at line 330 of file FileListController.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), and TYPO3\CMS\Filelist\Controller\FileListController\getBackendUser().

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\processRequest().

◆ initializeModule()

TYPO3\CMS\Filelist\Controller\FileListController::initializeModule ( ServerRequestInterface  $request)
protected

Definition at line 291 of file FileListController.php.

References TYPO3\CMS\Filelist\Controller\FileListController\getBackendUser(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getTSConfig().

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\handleRequest().

◆ initializeView()

TYPO3\CMS\Filelist\Controller\FileListController::initializeView ( )
protected

Definition at line 267 of file FileListController.php.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\handleRequest().

◆ processRequest()

TYPO3\CMS\Filelist\Controller\FileListController::processRequest ( ServerRequestInterface  $request)
protected

Definition at line 220 of file FileListController.php.

References TYPO3\CMS\Filelist\Controller\FileListController\generateFileList(), TYPO3\CMS\Filelist\Controller\FileListController\getLanguageService(), TYPO3\CMS\Filelist\Controller\FileListController\getModuleHeadline(), TYPO3\CMS\Filelist\Controller\FileListController\htmlResponse(), TYPO3\CMS\Filelist\Controller\FileListController\initializeFileList(), TYPO3\CMS\Filelist\Controller\FileListController\registerAdditionalDocHeaderButtons(), TYPO3\CMS\Filelist\Controller\FileListController\registerDrapUploader(), and TYPO3\CMS\Filelist\Controller\FileListController\registerFileListCheckboxes().

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\handleRequest().

◆ registerAdditionalDocHeaderButtons()

TYPO3\CMS\Filelist\Controller\FileListController::registerAdditionalDocHeaderButtons ( ServerRequestInterface  $request)
protected

Create the panel of buttons for submitting the form or otherwise perform operations.

Definition at line 518 of file FileListController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_LEFT, TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_RIGHT, TYPO3\CMS\Filelist\Controller\FileListController\getFileUploadUrl(), TYPO3\CMS\Filelist\Controller\FileListController\getLanguageService(), TYPO3\CMS\Core\Resource\Folder\getStorage(), TYPO3\CMS\Core\Resource\ResourceStorage\isWithinFolder(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\processRequest().

◆ registerDrapUploader()

TYPO3\CMS\Filelist\Controller\FileListController::registerDrapUploader ( )
protected

Definition at line 452 of file FileListController.php.

References $GLOBALS, TYPO3\CMS\Filelist\Controller\FileListController\getDefaultDuplicationBehaviourAction(), and TYPO3\CMS\Filelist\Controller\FileListController\getLanguageService().

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\processRequest().

◆ registerFileListCheckboxes()

TYPO3\CMS\Filelist\Controller\FileListController::registerFileListCheckboxes ( )
protected

Definition at line 475 of file FileListController.php.

References $GLOBALS, TYPO3\CMS\Filelist\Controller\FileListController\$pointer, TYPO3\CMS\Filelist\Controller\FileListController\getBackendUser(), TYPO3\CMS\Filelist\Controller\FileListController\getLanguageService(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getTSConfig().

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\processRequest().

Member Data Documentation

◆ $cmd

string TYPO3\CMS\Filelist\Controller\FileListController::$cmd = ''
protected

Definition at line 66 of file FileListController.php.

◆ $filelist

FileList TYPO3\CMS\Filelist\Controller\FileListController::$filelist = null
protected

Definition at line 81 of file FileListController.php.

◆ $folderObject

Folder TYPO3\CMS\Filelist\Controller\FileListController::$folderObject = null
protected

Definition at line 69 of file FileListController.php.

◆ $iconFactory

IconFactory TYPO3\CMS\Filelist\Controller\FileListController::$iconFactory
protected

Definition at line 74 of file FileListController.php.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\__construct().

◆ $id

string TYPO3\CMS\Filelist\Controller\FileListController::$id = ''
protected

Definition at line 65 of file FileListController.php.

◆ $MOD_MENU

array TYPO3\CMS\Filelist\Controller\FileListController::$MOD_MENU = []
protected

Definition at line 63 of file FileListController.php.

◆ $MOD_SETTINGS

array TYPO3\CMS\Filelist\Controller\FileListController::$MOD_SETTINGS = []
protected

Definition at line 64 of file FileListController.php.

◆ $moduleTemplate

ModuleTemplate TYPO3\CMS\Filelist\Controller\FileListController::$moduleTemplate = null
protected

Definition at line 79 of file FileListController.php.

◆ $moduleTemplateFactory

ModuleTemplateFactory TYPO3\CMS\Filelist\Controller\FileListController::$moduleTemplateFactory
protected

Definition at line 76 of file FileListController.php.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\__construct().

◆ $overwriteExistingFiles

DuplicationBehavior TYPO3\CMS\Filelist\Controller\FileListController::$overwriteExistingFiles = null
protected

Definition at line 70 of file FileListController.php.

◆ $pageRenderer

PageRenderer TYPO3\CMS\Filelist\Controller\FileListController::$pageRenderer
protected

Definition at line 73 of file FileListController.php.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\__construct().

◆ $pointer

int TYPO3\CMS\Filelist\Controller\FileListController::$pointer = 0
protected

Definition at line 68 of file FileListController.php.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\registerFileListCheckboxes().

◆ $resourceFactory

ResourceFactory TYPO3\CMS\Filelist\Controller\FileListController::$resourceFactory
protected

Definition at line 75 of file FileListController.php.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\__construct().

◆ $responseFactory

ResponseFactoryInterface TYPO3\CMS\Filelist\Controller\FileListController::$responseFactory
protected

Definition at line 77 of file FileListController.php.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\__construct().

◆ $searchTerm

string TYPO3\CMS\Filelist\Controller\FileListController::$searchTerm = ''
protected

Definition at line 67 of file FileListController.php.

◆ $uriBuilder

UriBuilder TYPO3\CMS\Filelist\Controller\FileListController::$uriBuilder
protected

Definition at line 72 of file FileListController.php.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\__construct().

◆ $view

ViewInterface TYPO3\CMS\Filelist\Controller\FileListController::$view = null
protected

Definition at line 80 of file FileListController.php.