Inheritance diagram for TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider:

Public Member Functions
	__construct (string $table, string $identifier, string $context='')

int	getPriority ()

bool	canHandle ()

array	addItems (array $items)

Protected Member Functions
	initialize ()

	initClipboard ()

	initDisabledItems ()

array	prepareItems (array $itemsConfiguration)

array	getAdditionalAttributes (string $itemName)

bool	canRender (string $itemName, string $type)

string	getIdentifier ()

Protected Attributes
LanguageService	$languageService

BackendUserAuthentication	$backendUser

TYPO3 CMS Backend Clipboard Clipboard	$clipboard

array	$itemsConfiguration = array( )

array	$disabledItems = array( )

string	$table = ''

string	$identifier = ''

string	$context = ''

Detailed Description

Abstract provider is a base class for context menu item providers

Definition at line 30 of file AbstractProvider.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::__construct	(	string	$table,
		string	$identifier,
		string	$context = `''`
	)

Lightweight constructor, just to be able to call ->canHandle(). Rest of the initialization is done in the initialize() method

Parameters

string	$table
string	$identifier
string	$context

Definition at line 83 of file AbstractProvider.php.

References TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\$context, $GLOBALS, TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\$identifier, and TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\$table.

Member Function Documentation

◆ addItems()

array TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::addItems ( array $items )

Adds new items to the given array or modifies existing items

Parameters

array $items

Returns: ‪array

Implements TYPO3\CMS\Backend\ContextMenu\ItemProviders\ProviderInterface.

Reimplemented in TYPO3\CMS\Backend\ContextMenu\ItemProviders\RecordProvider, TYPO3\CMS\Impexp\ContextMenu\ItemProvider, TYPO3\CMS\Form\Hooks\FormFileProvider, and TYPO3\CMS\Beuser\ContextMenu\ItemProvider.

Definition at line 158 of file AbstractProvider.php.

References TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\initialize(), and TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\prepareItems().

◆ canHandle()

bool TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::canHandle ( )

Whether this provider can handle given request (usually a check based on table, uid and context)

Returns: ‪bool

Implements TYPO3\CMS\Backend\ContextMenu\ItemProviders\ProviderInterface.

Reimplemented in TYPO3\CMS\Backend\ContextMenu\ItemProviders\PageProvider, TYPO3\CMS\Backend\ContextMenu\ItemProviders\RecordProvider, TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider, TYPO3\CMS\Impexp\ContextMenu\ItemProvider, TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileDragProvider, and TYPO3\CMS\Form\Hooks\FormFileProvider.

Definition at line 117 of file AbstractProvider.php.

◆ canRender()

bool TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::canRender	(	string	$itemName,
		string	$type
	)

protected

Checks whether certain item can be rendered (e.g. check for disabled items or permissions)

Parameters

string	$itemName
string	$type

Returns: ‪bool

Reimplemented in TYPO3\CMS\Backend\ContextMenu\ItemProviders\RecordProvider, TYPO3\CMS\Backend\ContextMenu\ItemProviders\PageProvider, TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider, TYPO3\CMS\Impexp\ContextMenu\ItemProvider, and TYPO3\CMS\Beuser\ContextMenu\ItemProvider.

Definition at line 212 of file AbstractProvider.php.

Referenced by TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\prepareItems().

◆ getAdditionalAttributes()

array TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::getAdditionalAttributes ( string $itemName )

protected

Returns an array of additional attributes for given item. Additional attributes are used to pass item specific data to the JS. E.g. message for the delete confirmation dialog

Parameters

string $itemName

Returns: ‪array

Reimplemented in TYPO3\CMS\Backend\ContextMenu\ItemProviders\PageProvider, TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider, TYPO3\CMS\Backend\ContextMenu\ItemProviders\RecordProvider, TYPO3\CMS\Impexp\ContextMenu\ItemProvider, TYPO3\CMS\Beuser\ContextMenu\ItemProvider, and TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileDragProvider.

Definition at line 200 of file AbstractProvider.php.

Referenced by TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\prepareItems().

◆ getIdentifier()

string TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::getIdentifier ( )

protected

Returns a clicked record identifier

Returns: ‪string

Reimplemented in TYPO3\CMS\Backend\ContextMenu\ItemProviders\RecordProvider, and TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider.

Definition at line 222 of file AbstractProvider.php.

◆ getPriority()

int TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::getPriority ( )

Returns the provider priority which is used for determining the order in which providers are adding items to the result array. Highest priority means provider is evaluated first.