‪TYPO3CMS  ‪main
TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler Class Reference
Inheritance diagram for TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler:
TYPO3\CMS\Backend\LinkHandler\LinkHandlerInterface TYPO3\CMS\Backend\LinkHandler\LinkHandlerVariableProviderInterface TYPO3\CMS\Backend\LinkHandler\LinkHandlerViewProviderInterface TYPO3\CMS\Backend\Tree\View\LinkParameterProviderInterface TYPO3\CMS\Filelist\LinkHandler\FileLinkHandler TYPO3\CMS\Filelist\LinkHandler\FolderLinkHandler

Public Member Functions

 __construct (protected readonly IconFactory $iconFactory, protected readonly ResourceFactory $resourceFactory, protected readonly PageRenderer $pageRenderer, protected readonly UriBuilder $uriBuilder, protected readonly LanguageServiceFactory $languageServiceFactory)
 
 canHandleLink (array $linkParts)
 
 formatCurrentUrl ()
 
 createView (BackendViewFactory $backendViewFactory, ServerRequestInterface $request)
 
 setView (ViewInterface $view)
 
 getView ()
 
 getLinkAttributes ()
 
 initialize (AbstractLinkBrowserController $linkBrowser, $identifier, array $configuration)
 
 initializeVariables (ServerRequestInterface $request)
 
 modifyLinkAttributes (array $fieldDefinitions)
 
 isUpdateSupported ()
 
string[] getBodyTagAttributes ()
 
 getUrlParameters (array $values)
 

Protected Member Functions

 createUri (ServerRequestInterface $request, array $parameters=[])
 
 getViewModeButton (ServerRequestInterface $request)
 
 getLanguageService ()
 
 getBackendUser ()
 

Protected Attributes

string $expandFolder = null
 
int $currentPage = 1
 
string $moduleStorageIdentifier = 'file_list'
 
FileList $filelist = null
 
string $viewMode = null
 
bool $displayThumbs = true
 
Folder $selectedFolder = null
 
Matcher $resourceDisplayMatcher = null
 
Matcher $resourceSelectableMatcher = null
 
LinkType $type
 
array $linkParts = []
 
ViewInterface $view
 
LanguageService $languageService
 
AbstractLinkBrowserController $linkBrowser
 

Detailed Description

Definition at line 52 of file AbstractResourceLinkHandler.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::__construct ( protected readonly IconFactory  $iconFactory,
protected readonly ResourceFactory  $resourceFactory,
protected readonly PageRenderer  $pageRenderer,
protected readonly UriBuilder  $uriBuilder,
protected readonly LanguageServiceFactory  $languageServiceFactory 
)

Member Function Documentation

◆ canHandleLink()

TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::canHandleLink ( array  $linkParts)

Checks if this is the handler for the given link

The handler may store this information locally for later usage.

Parameters
array$linkParts‪Link parts as returned from TypoLinkCodecService
Returns
‪bool

Implements TYPO3\CMS\Backend\LinkHandler\LinkHandlerInterface.

Definition at line 83 of file AbstractResourceLinkHandler.php.

References TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler\$linkParts.

◆ createUri()

TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::createUri ( ServerRequestInterface  $request,
array  $parameters = [] 
)
protected

◆ createView()

TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::createView ( BackendViewFactory  $backendViewFactory,
ServerRequestInterface  $request 
)

◆ formatCurrentUrl()

TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::formatCurrentUrl ( )

Format the current link for HTML output

Returns
‪string

Implements TYPO3\CMS\Backend\LinkHandler\LinkHandlerInterface.

Definition at line 95 of file AbstractResourceLinkHandler.php.

◆ getBackendUser()

◆ getBodyTagAttributes()

string [] TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::getBodyTagAttributes ( )
Returns
‪string[] Array of body-tag attributes

Implements TYPO3\CMS\Backend\LinkHandler\LinkHandlerInterface.

Definition at line 223 of file AbstractResourceLinkHandler.php.

◆ getLanguageService()

TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::getLanguageService ( )
protected

◆ getLinkAttributes()

TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::getLinkAttributes ( )
Returns
‪array

Implements TYPO3\CMS\Backend\LinkHandler\LinkHandlerInterface.

Definition at line 123 of file AbstractResourceLinkHandler.php.

◆ getUrlParameters()

TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::getUrlParameters ( array  $values)

Provides an array or GET parameters for URL generation

Parameters
array$values‪Array of values to include into the parameters or which might influence the parameters
Returns
‪string[] Array of parameters which have to be added to URLs

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

Definition at line 280 of file AbstractResourceLinkHandler.php.

Referenced by TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler\createUri().

◆ getView()

TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::getView ( )

◆ getViewModeButton()

◆ initialize()

TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::initialize ( AbstractLinkBrowserController  $linkBrowser,
  $identifier,
array  $configuration 
)

Initialize the handler

Parameters
string$identifier
array$configuration‪Page TSconfig of this link handler: TCEMAIN.linkHandler.<identifier>.configuration

Implements TYPO3\CMS\Backend\LinkHandler\LinkHandlerInterface.

Definition at line 128 of file AbstractResourceLinkHandler.php.

References TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler\$linkBrowser.

◆ initializeVariables()

◆ isUpdateSupported()

TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::isUpdateSupported ( )

Return TRUE if the handler supports to update a link.

This is useful for file or page links, when only attributes are changed.

Returns
‪bool

Implements TYPO3\CMS\Backend\LinkHandler\LinkHandlerInterface.

Definition at line 208 of file AbstractResourceLinkHandler.php.

◆ modifyLinkAttributes()

TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::modifyLinkAttributes ( array  $fieldDefinitions)
Parameters
string[]$fieldDefinitions‪Array of link attribute field definitions
Returns
‪string[]

Implements TYPO3\CMS\Backend\LinkHandler\LinkHandlerInterface.

Definition at line 203 of file AbstractResourceLinkHandler.php.

◆ setView()

TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::setView ( ViewInterface  $view)

Member Data Documentation

◆ $currentPage

int TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::$currentPage = 1
protected

Definition at line 55 of file AbstractResourceLinkHandler.php.

◆ $displayThumbs

bool TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::$displayThumbs = true
protected

◆ $expandFolder

string TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::$expandFolder = null
protected

Definition at line 54 of file AbstractResourceLinkHandler.php.

◆ $filelist

FileList TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::$filelist = null
protected

Definition at line 58 of file AbstractResourceLinkHandler.php.

◆ $languageService

LanguageService TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::$languageService
protected

◆ $linkBrowser

AbstractLinkBrowserController TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::$linkBrowser
protected

◆ $linkParts

array TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::$linkParts = []
protected

◆ $moduleStorageIdentifier

string TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::$moduleStorageIdentifier = 'file_list'
protected

Definition at line 56 of file AbstractResourceLinkHandler.php.

◆ $resourceDisplayMatcher

Matcher TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::$resourceDisplayMatcher = null
protected

Definition at line 63 of file AbstractResourceLinkHandler.php.

◆ $resourceSelectableMatcher

Matcher TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::$resourceSelectableMatcher = null
protected

Definition at line 64 of file AbstractResourceLinkHandler.php.

◆ $selectedFolder

Folder TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::$selectedFolder = null
protected

Definition at line 62 of file AbstractResourceLinkHandler.php.

◆ $type

LinkType TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::$type
protected

Definition at line 66 of file AbstractResourceLinkHandler.php.

◆ $view

ViewInterface TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::$view
protected

◆ $viewMode

string TYPO3\CMS\Filelist\LinkHandler\AbstractResourceLinkHandler::$viewMode = null
protected

Definition at line 59 of file AbstractResourceLinkHandler.php.