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

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

Public Member Functions
	__construct (protected readonly EventDispatcherInterface $eventDispatcher, protected readonly IconFactory $iconFactory, protected readonly LanguageServiceFactory $languageServiceFactory, protected readonly UriBuilder $uriBuilder, protected readonly QueryParser $queryParser,)
	getFilterLabel ()
	count (SearchDemand $searchDemand)
ResultItem[]	find (SearchDemand $searchDemand)

Protected Member Functions
	parseCommand (SearchDemand $searchDemand)
	getQueryBuilderForTable (SearchDemand $searchDemand, string $tableName)
	countByTable (SearchDemand $searchDemand, string $tableName)
ResultItem[]	findByTable (SearchDemand $searchDemand, string $tableName, int $limit, int $offset)
	canAccessTable (string $tableName)
	getAccessibleTables (BeforeSearchInDatabaseRecordProviderEvent $event)
int[]	getPageIdList ()
string[]	extractSearchableFieldsFromTable (string $tableName)
CompositeExpression[]	buildConstraintsForTable (string $queryString, QueryBuilder $queryBuilder, string $tableName)
	fieldTypeIsSearchable (string $fieldType)
string	getShowLink (array $row)
string	getEditLink (string $tableName, array $row)
	getBackendUser ()

Protected Attributes
LanguageService	$languageService
string	$userPermissions
array	$pageIdList = []

Private Attributes
const	RECURSIVE_PAGE_LEVEL = 99

Detailed Description

Search provider to query records from database

Definition at line 52 of file DatabaseRecordProvider.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::__construct	(	protected readonly EventDispatcherInterface	$eventDispatcher,
		protected readonly IconFactory	$iconFactory,
		protected readonly LanguageServiceFactory	$languageServiceFactory,
		protected readonly UriBuilder	$uriBuilder,
		protected readonly QueryParser	$queryParser
	)

Definition at line 60 of file DatabaseRecordProvider.php.

References TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getBackendUser(), and TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW.

Member Function Documentation

buildConstraintsForTable()

CompositeExpression [] TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::buildConstraintsForTable ( string  $queryString, QueryBuilder  $queryBuilder, string  $tableName  )

protected

Returns

‪CompositeExpression[]

Definition at line 357 of file DatabaseRecordProvider.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\extractSearchableFieldsFromTable(), TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\fieldTypeIsSearchable(), TYPO3\CMS\Core\Database\Query\QueryHelper\getDateTimeTypes(), TYPO3\CMS\Core\Database\Connection\PARAM_INT, TYPO3\CMS\Core\Database\Query\QueryHelper\quoteDatabaseIdentifiers(), and TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix().

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getQueryBuilderForTable().

canAccessTable()

TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::canAccessTable ( string  $tableName )

protected

Definition at line 291 of file DatabaseRecordProvider.php.

References $GLOBALS, and TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getBackendUser().

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getAccessibleTables().

count()

TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::count

(

SearchDemand

$searchDemand

)

Implements TYPO3\CMS\Backend\Search\LiveSearch\SearchProviderInterface.

Definition at line 76 of file DatabaseRecordProvider.php.

References TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\countByTable(), TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getAccessibleTables(), TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getPageIdList(), and TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\parseCommand().

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\find().

countByTable()

TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::countByTable ( SearchDemand  $searchDemand, string  $tableName  )

protected

Definition at line 219 of file DatabaseRecordProvider.php.

References TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getQueryBuilderForTable().

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

extractSearchableFieldsFromTable()

string [] TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::extractSearchableFieldsFromTable ( string  $tableName )

protected

Get all fields from given table where we can search for.

Returns

‪string[]

Definition at line 338 of file DatabaseRecordProvider.php.

References $GLOBALS, TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getBackendUser(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\buildConstraintsForTable().

fieldTypeIsSearchable()

TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::fieldTypeIsSearchable ( string  $fieldType )

protected

Definition at line 443 of file DatabaseRecordProvider.php.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\buildConstraintsForTable().

find()

ResultItem [] TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::find

(

SearchDemand

$searchDemand

)

Returns

‪ResultItem[]

Implements TYPO3\CMS\Backend\Search\LiveSearch\SearchProviderInterface.

Definition at line 103 of file DatabaseRecordProvider.php.

References TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\count(), TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\countByTable(), TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\findByTable(), TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getAccessibleTables(), TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getLimit(), TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getOffset(), TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getPageIdList(), and TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\parseCommand().

findByTable()

ResultItem [] TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::findByTable ( SearchDemand  $searchDemand, string  $tableName, int  $limit, int  $offset  )

protected

Returns

‪ResultItem[]

Definition at line 228 of file DatabaseRecordProvider.php.

References $GLOBALS, TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getEditLink(), TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getQueryBuilderForTable(), and TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getShowLink().

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\find().

getAccessibleTables()

TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::getAccessibleTables ( BeforeSearchInDatabaseRecordProviderEvent  $event )

protected

Definition at line 305 of file DatabaseRecordProvider.php.

References $GLOBALS, TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\canAccessTable(), and TYPO3\CMS\Backend\Search\Event\BeforeSearchInDatabaseRecordProviderEvent\isTableIgnored().

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

getBackendUser()

TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::getBackendUser ( )

protected

Definition at line 518 of file DatabaseRecordProvider.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\__construct(), TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\canAccessTable(), TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\extractSearchableFieldsFromTable(), TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getEditLink(), TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getPageIdList(), and TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getShowLink().

getEditLink()

string TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::getEditLink ( string  $tableName, array  $row  )

protected

Build a backend edit link based on given record.

Parameters

string	$tableName	‪Record table name
array	$row	‪Current record row from database.

Returns

‪string Link to open an edit window for record.

See also

‪\TYPO3\CMS\Backend\Utility\BackendUtility::readPageAccess()

Definition at line 492 of file DatabaseRecordProvider.php.

References $GLOBALS, and TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getBackendUser().

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\findByTable().

getFilterLabel()

TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::getFilterLabel

(

)

Implements TYPO3\CMS\Backend\Search\LiveSearch\SearchProviderInterface.

Definition at line 71 of file DatabaseRecordProvider.php.

getPageIdList()

int [] TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::getPageIdList ( )

protected

List of available page uids for user, empty array for admin users.

Returns

‪int[]

Definition at line 317 of file DatabaseRecordProvider.php.

References TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getBackendUser().

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

getQueryBuilderForTable()

TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::getQueryBuilderForTable ( SearchDemand  $searchDemand, string  $tableName  )

protected

Definition at line 184 of file DatabaseRecordProvider.php.

References TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\buildConstraintsForTable(), and TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getQuery().

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\countByTable(), and TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\findByTable().

getShowLink()

string TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::getShowLink ( array  $row )

protected

Build a link to the record list based on given record.

Parameters

array

$row

‪Current record row from database.

Returns

‪string Link to open an edit window for record.

Definition at line 466 of file DatabaseRecordProvider.php.

References $GLOBALS, and TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\getBackendUser().

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider\findByTable().

parseCommand()

TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::parseCommand ( SearchDemand  $searchDemand )

protected

Definition at line 154 of file DatabaseRecordProvider.php.

References TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\DemandProperty\getName(), TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getProperties(), and TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand\getQuery().

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

Member Data Documentation

$languageService

LanguageService TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::$languageService

protected

Definition at line 56 of file DatabaseRecordProvider.php.

$pageIdList

array TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::$pageIdList = []

protected

Definition at line 58 of file DatabaseRecordProvider.php.

$userPermissions

string TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::$userPermissions

protected

Definition at line 57 of file DatabaseRecordProvider.php.

RECURSIVE_PAGE_LEVEL

const TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider::RECURSIVE_PAGE_LEVEL = 99

private

Definition at line 54 of file DatabaseRecordProvider.php.