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

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

Public Member Functions
	__construct (array $demandProperties=[])
	getProperty (DemandPropertyName $demandPropertyName)
DemandProperty[]	getProperties ()
	getPageId ()
	getQuery ()
	getLimit ()
	getOffset ()
class string< SearchProviderInterface >[]	getSearchProviders ()

Static Public Member Functions
static	fromRequest (ServerRequestInterface $request)

Public Attributes
const	DEFAULT_LIMIT = 20

Protected Attributes
array	$demandProperties = []

Detailed Description

Holds necessary data to query data from a search provider

may change in further iterations, do not rely on it

Definition at line 28 of file SearchDemand.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand::__construct ( array  $demandProperties = [] )

final

Parameters

DemandProperty[]

$demandProperties

Definition at line 40 of file SearchDemand.php.

References TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\$demandProperties, and TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\DemandProperty\getName().

Member Function Documentation

fromRequest()

static TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand::fromRequest ( ServerRequestInterface  $request )

static

Definition at line 89 of file SearchDemand.php.

References TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\$demandProperties.

Referenced by TYPO3\CMS\Backend\Controller\LiveSearchController\formAction(), TYPO3\CMS\Backend\Tests\Unit\Search\LiveSearch\SearchDemand\SearchDemandTest\fromRequestCreatesExpectedDemand(), TYPO3\CMS\Backend\Tests\Unit\Search\LiveSearch\SearchDemand\MutableSearchDemandTest\fromRequestCreatesExpectedDemand(), and TYPO3\CMS\Backend\Controller\LiveSearchController\searchAction().

getLimit()

TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand::getLimit

(

)

Definition at line 71 of file SearchDemand.php.

References TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\DEFAULT_LIMIT, and TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getProperty().

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\SearchRepository\find(), TYPO3\CMS\Backend\Search\LiveSearch\PageRecordProvider\find(), and TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\find().

getOffset()

TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand::getOffset

(

)

Definition at line 76 of file SearchDemand.php.

References TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getProperty().

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\SearchRepository\find(), TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\find(), and TYPO3\CMS\Backend\Search\LiveSearch\PageRecordProvider\findByTable().

getPageId()

TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand::getPageId

(

)

Definition at line 61 of file SearchDemand.php.

References TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getProperty().

getProperties()

DemandProperty [] TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand::getProperties

(

)

Returns

‪DemandProperty[]

Definition at line 56 of file SearchDemand.php.

References TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\$demandProperties.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\MutableSearchDemand\fromSearchDemand(), TYPO3\CMS\Backend\Search\LiveSearch\PageRecordProvider\parseCommand(), and TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\parseCommand().

getProperty()

TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand::getProperty

(

DemandPropertyName

$demandPropertyName

)

Definition at line 48 of file SearchDemand.php.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getLimit(), TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getOffset(), TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getPageId(), TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getQuery(), and TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getSearchProviders().

getQuery()

TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand::getQuery

(

)

Definition at line 66 of file SearchDemand.php.

References TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getProperty().

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\PageRecordProvider\getQueryBuilderForTable(), TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getQueryBuilderForTable(), TYPO3\CMS\Backend\Search\LiveSearch\PageRecordProvider\parseCommand(), and TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\parseCommand().

getSearchProviders()

class string<SearchProviderInterface> [] TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand::getSearchProviders

(

)

Returns

‪class-string<SearchProviderInterface>[]

Definition at line 84 of file SearchDemand.php.

References TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getProperty(), and TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\searchProviders.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\SearchRepository\getViableSearchProviders().

Member Data Documentation

$demandProperties

DemandProperty[] TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand::$demandProperties = []

protected

Definition at line 35 of file SearchDemand.php.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\__construct(), TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\fromRequest(), and TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getProperties().

DEFAULT_LIMIT

const TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand::DEFAULT_LIMIT = 20

Definition at line 30 of file SearchDemand.php.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\SearchRepository\find(), TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getLimit(), and TYPO3\CMS\Backend\Controller\LiveSearchController\searchAction().