ResultItem

final class \TYPO3\CMS\Backend\Search\LiveSearch\ResultItem

Implements
JsonSerializable

Class that represents a search result item

Table of Contents

Interfaces

JsonSerializable

Methods

__construct()  : mixed
addAction()  : self
addProperty()  : self
getDefaultAction()  : ResultItemAction|null
getExtraData()  : array
getInternalData()  : array
getProviderClassName()  : string
jsonSerialize()  : array
setActions()  : self
setDefaultAction()  : ResultItem
setExtraData()  : ResultItem
setIcon()  : self
setInternalData()  : ResultItem
setItemTitle()  : self
setLanguage()  : self
setThumbnailUrl()  : self
setTypeLabel()  : self

Methods

__construct()

public __construct(class-string $providerClassName) : mixed

Parameters

$providerClassName : class-string

addProperty()

public addProperty(string $label, string $value) : self

Parameters

$label : string
$value : string

Return values

self

getExtraData()

public getExtraData() : array

Return values

array

getInternalData()

public getInternalData() : array

Return values

array

getProviderClassName()

public getProviderClassName() : string

Return values

string

jsonSerialize()

public jsonSerialize() : array

Return values

array

setIcon()

public setIcon(Icon $icon) : self

Parameters

$icon : Icon

Return values

self

setItemTitle()

public setItemTitle(string $itemTitle) : self

Parameters

$itemTitle : string

Return values

self

setLanguage()

public setLanguage(array|null $language) : self

Parameters

$language : array|null

Return values

self

setThumbnailUrl()

public setThumbnailUrl(string|null $thumbnailUrl) : self

Parameters

$thumbnailUrl : string|null

Return values

self

setTypeLabel()

public setTypeLabel(string $typeLabel) : self

Parameters

$typeLabel : string

Return values

self
On this page