TYPO3\CMS\Backend\Search\LiveSearch\ResultItem Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Search\LiveSearch\ResultItem:

Public Member Functions
	__construct (private readonly string $providerClassName)
	getProviderClassName ()
	setItemTitle (string $itemTitle)
	setTypeLabel (string $typeLabel)
	setIcon (Icon $icon)
	setActions (ResultItemAction ... $action)
	addAction (ResultItemAction $action)
	getExtraData ()
	setExtraData (array $extraData)
	getInternalData ()
	setInternalData (array $internalData)
	jsonSerialize ()

Private Attributes
string	$itemTitle = ''
string	$typeLabel = ''
Icon	$icon = null
array	$actions = []
array	$extraData = []
array	$internalData = []

Detailed Description

Class that represents a search result item

Class may change in further iterations, do not rely on it

Definition at line 27 of file ResultItem.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::__construct

(

private readonly string

$providerClassName

)

Parameters

class-string

$providerClassName

Definition at line 42 of file ResultItem.php.

Member Function Documentation

addAction()

TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::addAction

(

ResultItemAction

$action

)

Definition at line 77 of file ResultItem.php.

Referenced by TYPO3\CMS\Backend\Search\EventListener\AddLiveSearchResultActionsListener\addSwitchUserAction().

getExtraData()

TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::getExtraData

(

)

Definition at line 84 of file ResultItem.php.

References TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\$extraData.

Referenced by TYPO3\CMS\Backend\Search\EventListener\AddLiveSearchResultActionsListener\addSwitchUserAction().

getInternalData()

TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::getInternalData

(

)

Definition at line 95 of file ResultItem.php.

References TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\$internalData.

Referenced by TYPO3\CMS\Backend\Search\EventListener\AddLiveSearchResultActionsListener\addSwitchUserAction().

getProviderClassName()

TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::getProviderClassName

(

)

Definition at line 44 of file ResultItem.php.

jsonSerialize()

TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::jsonSerialize

(

)

Definition at line 107 of file ResultItem.php.

References TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\$actions, TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\$extraData, TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\$itemTitle, and TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\$typeLabel.

setActions()

TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::setActions

(

ResultItemAction ...

$action

)

Definition at line 70 of file ResultItem.php.

setExtraData()

TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::setExtraData

(

array

$extraData

)

Definition at line 89 of file ResultItem.php.

References TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\$extraData.

setIcon()

TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::setIcon

(

Icon

$icon

)

Definition at line 63 of file ResultItem.php.

References TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\$icon.

setInternalData()

TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::setInternalData

(

array

$internalData

)

Definition at line 100 of file ResultItem.php.

References TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\$internalData.

setItemTitle()

TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::setItemTitle

(

string

$itemTitle

)

Definition at line 49 of file ResultItem.php.

References TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\$itemTitle.

setTypeLabel()

TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::setTypeLabel

(

string

$typeLabel

)

Definition at line 56 of file ResultItem.php.

References TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\$typeLabel.

Member Data Documentation

$actions

array TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::$actions = []

private

Definition at line 35 of file ResultItem.php.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\jsonSerialize().

$extraData

array TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::$extraData = []

private

Definition at line 36 of file ResultItem.php.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\getExtraData(), TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\jsonSerialize(), and TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\setExtraData().

$icon

Icon TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::$icon = null

private

Definition at line 31 of file ResultItem.php.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\setIcon().

$internalData

array TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::$internalData = []

private

Definition at line 37 of file ResultItem.php.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\getInternalData(), and TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\setInternalData().

$itemTitle

string TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::$itemTitle = ''

private

Definition at line 29 of file ResultItem.php.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\jsonSerialize(), and TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\setItemTitle().

$typeLabel

string TYPO3\CMS\Backend\Search\LiveSearch\ResultItem::$typeLabel = ''

private

Definition at line 30 of file ResultItem.php.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\jsonSerialize(), and TYPO3\CMS\Backend\Search\LiveSearch\ResultItem\setTypeLabel().