TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider Class Reference

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

Public Member Functions
	__construct ()
	setContext (string $table, string $identifier, string $context='')
	getPriority ()
	canHandle ()
	addItems (array $items)

Protected Member Functions
	initialize ()
	initClipboard ()
	initDisabledItems ()
	prepareItems (array $itemsConfiguration)
	getAdditionalAttributes (string $itemName)
	canRender (string $itemName, string $type)
	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

(

)

Definition at line 74 of file AbstractProvider.php.

References $GLOBALS.

Member Function Documentation

addItems()

TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::addItems

(

array

$items

)

Adds new items to the given array or modifies existing items

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

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

Definition at line 146 of file AbstractProvider.php.

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

canHandle()

TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::canHandle

(

)

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

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, and TYPO3\CMS\Form\Hooks\FormFileProvider.

Definition at line 108 of file AbstractProvider.php.

canRender()

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)

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

Definition at line 190 of file AbstractProvider.php.

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

getAdditionalAttributes()

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

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

Definition at line 182 of file AbstractProvider.php.

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

getIdentifier()

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

protected

Returns a clicked record identifier

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

Definition at line 198 of file AbstractProvider.php.

getPriority()

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.

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

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

Definition at line 100 of file AbstractProvider.php.

initClipboard()

TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::initClipboard ( )

protected

Initialize clipboard object - necessary for all copy/cut/paste operations

Definition at line 116 of file AbstractProvider.php.

References TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\$clipboard, TYPO3\CMS\Backend\Clipboard\Clipboard\cleanCurrent(), TYPO3\CMS\Backend\Clipboard\Clipboard\endClipboard(), TYPO3\CMS\Backend\Clipboard\Clipboard\initializeClipboard(), and TYPO3\CMS\Backend\Clipboard\Clipboard\lockToNormal().

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

initDisabledItems()

TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::initDisabledItems ( )

protected

Fills $this->disabledItems with the values from TSConfig. Disabled items can be set separately for each context.

Definition at line 133 of file AbstractProvider.php.

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

Referenced by TYPO3\CMS\Impexp\ContextMenu\ItemProvider\addItems(), and TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\initialize().

initialize()

TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::initialize ( )

protected

Provider initialization, heavy stuff

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

Definition at line 90 of file AbstractProvider.php.

References TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\initClipboard(), and TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\initDisabledItems().

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

prepareItems()

TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::prepareItems ( array  $itemsConfiguration )

protected

Converts item configuration (from $this->itemsConfiguration) into an array ready for returning by controller

Definition at line 156 of file AbstractProvider.php.

References TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\$itemsConfiguration, TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\canRender(), and TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\getAdditionalAttributes().

Referenced by TYPO3\CMS\Impexp\ContextMenu\ItemProvider\addItems(), TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\addItems(), and TYPO3\CMS\Backend\ContextMenu\ItemProviders\RecordProvider\addItems().

setContext()

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

Initialize the current context. This method is called directly after fetching the provider from the container.

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

Definition at line 80 of file AbstractProvider.php.

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

Member Data Documentation

$backendUser

BackendUserAuthentication TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::$backendUser

protected

Definition at line 40 of file AbstractProvider.php.

$clipboard

TYPO3 CMS Backend Clipboard Clipboard TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::$clipboard

protected

Definition at line 44 of file AbstractProvider.php.

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

$context

string TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::$context = ''

protected

Context - from where the click menu was triggered (e.g. 'tree')

Definition at line 72 of file AbstractProvider.php.

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

$disabledItems

array TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::$disabledItems = array( )

protected

Click menu items disabled by TSConfig

Definition at line 56 of file AbstractProvider.php.

$identifier

string TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::$identifier = ''

protected

clicked record identifier (usually uid or file combined identifier)

Definition at line 66 of file AbstractProvider.php.

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

$itemsConfiguration

array TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::$itemsConfiguration = array( )

protected

Array of items the class is providing

Definition at line 50 of file AbstractProvider.php.

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

$languageService

LanguageService TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::$languageService

protected

Language Service property. Used to access localized labels

Definition at line 36 of file AbstractProvider.php.

$table

string TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider::$table = ''

protected

Current table name

Definition at line 62 of file AbstractProvider.php.

Referenced by TYPO3\CMS\Backend\ContextMenu\ItemProviders\RecordProvider\getEnableDisableAdditionalAttributes(), TYPO3\CMS\Backend\ContextMenu\ItemProviders\RecordProvider\getLanguageField(), TYPO3\CMS\Backend\ContextMenu\ItemProviders\RecordProvider\hasDisableColumnWithValue(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isRecordInClipboard(), and TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\setContext().