Inheritance diagram for TYPO3\CMS\IndexedSearch\Controller\SearchController:

Public Member Functions
	injectTypoScriptService (\TYPO3\CMS\Extbase\Service\TypoScriptService $typoScriptService)

	initialize ($searchData=[])

	searchAction ($search=[])

	formAction ($search=[])

	noTypoScriptAction ()

Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)

	injectCacheService (\TYPO3\CMS\Extbase\Service\CacheService $cacheService)

	injectMvcPropertyMappingConfigurationService (\TYPO3\CMS\Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)

	processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)

Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
	injectSignalSlotDispatcher (\TYPO3\CMS\Extbase\SignalSlot\Dispatcher $signalSlotDispatcher)

	injectValidatorResolver (\TYPO3\CMS\Extbase\Validation\ValidatorResolver $validatorResolver)

	getControllerContext ()

	__construct ()

	injectConfigurationManager (ConfigurationManagerInterface $configurationManager)

	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)

	addFlashMessage ($messageBody, $messageTitle='', $severity=\TYPO3\CMS\Core\Messaging\AbstractMessage::OK, $storeInSession=true)

	canProcessRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request)

	processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)

	forward ($actionName, $controllerName=null, $extensionName=null, array $arguments=null)

	throwStatus ($statusCode, $statusMessage=null, $content=null)

Protected Member Functions
	getDisplayResults ($searchWords, $resultData, $freeIndexUid=-1)

	compileResultRows ($resultRows, $freeIndexUid=-1)

	compileSingleResultRow ($row, $headerOnly=0)

	getSpecialConfigurationForResultRow ($row)

	makeRating ($row)

	makeDescription ($row, $noMarkup=false, $length=180)

	markupSWpartsOfString ($str)

	writeSearchStat ($searchParams, $searchWords, $count, $pt)

	getSearchWords ($defaultOperator)

	procSearchWordsByLexer ($searchWords)

	getAllAvailableSearchTypeOptions ()

	getAllAvailableOperandsOptions ()

	getAllAvailableMediaTypesOptions ()

	getAllAvailableLanguageOptions ()

	getAllAvailableSectionsOptions ()

	getAllAvailableIndexConfigurationsOptions ()

	getAllAvailableSortOrderOptions ()

	getAllAvailableGroupOptions ()

	getAllAvailableSortDescendingOptions ()

	getAllAvailableNumberOfResultsOptions ()

	removeOptionsFromOptionList ($allOptions, $blindOptions)

	linkPage ($pageUid, $linkText, $row=[], $markUpSwParams=[])

	getMenuOfPages ($pageUid)

	getPathFromPageId ($id, $pathMP='')

	getFirstSysDomainRecordForPage ($id)

	initializeExternalParsers ()

	hookRequest ($functionName)

	multiplePagesType ($item_type)

	getDatabaseConnection ()

	loadSettings ()

Protected Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	initializeActionMethodArguments ()

	resolveActionMethodName ()

	emitBeforeCallActionMethodSignal (array $preparedArguments)

	setViewConfiguration (ViewInterface $view)

	getViewProperty ($extbaseFrameworkConfiguration, $setting)

	resolveViewObjectName ()

	initializeView (ViewInterface $view)

	initializeAction ()

	errorAction ()

	clearCacheOnError ()

	addErrorFlashMessage ()

	getErrorFlashMessage ()

	forwardToReferringRequest ()

	getFlattenedValidationErrorMessage ()

Protected Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
	redirect ($actionName, $controllerName=null, $extensionName=null, array $arguments=null, $pageUid=null, $delay=0, $statusCode=303)

	redirectToUri ($uri, $delay=0, $statusCode=303)

	addBaseUriIfNecessary ($uri)

Protected Attributes
	$sword = null

	$searchWords = []

	$searchData

	$searchRootPageIdList = 0

	$defaultResultNumber = 10

	$searchRepository = null

	$lexerObj

	$externalParsers = []

	$firstRow = []

	$domainRecords = []

	$requiredFrontendUsergroups = []

	$resultSections = []

	$pathCache = []

	$iconFileNameCache = []

	$indexerConfig = []

	$enableMetaphoneSearch = false

	$typoScriptService

Protected Attributes inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	$reflectionService

	$cacheService

	$view = null

	$namespacesViewObjectNamePattern = '@vendor\@extension\View\@controller\@action@format'

	$viewFormatToObjectNameMap = []

	$defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class

	$actionMethodName = 'indexAction'

	$errorMethodName = 'errorAction'

	$mvcPropertyMappingConfigurationService

	$request

	$response

Protected Attributes inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
	$signalSlotDispatcher

	$objectManager

	$uriBuilder

	$extensionName

	$settings

	$request

	$response

	$validatorResolver

	$arguments

	$supportedRequestTypes = [\TYPO3\CMS\Extbase\Mvc\Request::class]

	$controllerContext

	$configurationManager

Additional Inherited Members
Static Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
static	getActionMethodParameters ($objectManager)

Detailed Description

Index search frontend

Creates a search form for indexed search. Indexing must be enabled for this to make sense.

Definition at line 29 of file SearchController.php.

Member Function Documentation

◆ compileResultRows()

TYPO3\CMS\IndexedSearch\Controller\SearchController::compileResultRows	(	$resultRows,
		$freeIndexUid = `-1`
	)

protected

Takes the array with resultrows as input and returns the result-HTML-code Takes the "group" var into account: Makes a "section" or "flat" display.

Parameters

array	$resultRows	Result rows
int	$freeIndexUid	Pointing to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content.

Returns: string HTML

Definition at line 323 of file SearchController.php.

References TYPO3\CMS\IndexedSearch\Controller\SearchController\compileSingleResultRow(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getPathFromPageId(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\getDisplayResults().

◆ compileSingleResultRow()

TYPO3\CMS\IndexedSearch\Controller\SearchController::compileSingleResultRow	(	$row,
		$headerOnly = `0`
	)

protected

This prints a single result row, including a recursive call for subrows.

Parameters

array	$row	Search result row
int	$headerOnly	1=Display only header (for sub-rows!), 2=nothing at all

Returns: string HTML code

Definition at line 408 of file SearchController.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\formatSize(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getPathFromPageId(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getSpecialConfigurationForResultRow(), TYPO3\CMS\IndexedSearch\Controller\SearchController\linkPage(), TYPO3\CMS\IndexedSearch\Controller\SearchController\makeDescription(), TYPO3\CMS\IndexedSearch\Controller\SearchController\makeRating(), TYPO3\CMS\IndexedSearch\Controller\SearchController\multiplePagesType(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\siteRelPath(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\compileResultRows().

◆ formAction()

TYPO3\CMS\IndexedSearch\Controller\SearchController::formAction ( $search = [] )

Sort options about the search form

Parameters

array $search The search data / params

Returns: void $search

Definition at line 897 of file SearchController.php.

◆ getAllAvailableGroupOptions()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getAllAvailableGroupOptions ( )

protected

get the values for the "group" selector

Returns: array Associative array with options

Definition at line 1176 of file SearchController.php.

References TYPO3\CMS\IndexedSearch\Controller\SearchController\removeOptionsFromOptionList(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\formAction().

◆ getAllAvailableIndexConfigurationsOptions()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getAllAvailableIndexConfigurationsOptions ( )

protected

get the values for the "freeIndexUid" selector

Returns: array Associative array with options

Definition at line 1120 of file SearchController.php.

References $GLOBALS, TYPO3\CMS\IndexedSearch\Controller\SearchController\getDatabaseConnection(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), TYPO3\CMS\IndexedSearch\Controller\SearchController\removeOptionsFromOptionList(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\formAction().

◆ getAllAvailableLanguageOptions()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getAllAvailableLanguageOptions ( )

protected

get the values for the "language" selector

Returns: array Associative array with options

Definition at line 1042 of file SearchController.php.

References $GLOBALS, TYPO3\CMS\IndexedSearch\Controller\SearchController\getDatabaseConnection(), TYPO3\CMS\IndexedSearch\Controller\SearchController\removeOptionsFromOptionList(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\formAction().

◆ getAllAvailableMediaTypesOptions()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getAllAvailableMediaTypesOptions ( )

protected

get the values for the "media type" selector

Returns: array Associative array with options

Definition at line 1005 of file SearchController.php.

References TYPO3\CMS\IndexedSearch\Controller\SearchController\removeOptionsFromOptionList(), TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\formAction().

◆ getAllAvailableNumberOfResultsOptions()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getAllAvailableNumberOfResultsOptions ( )

protected

get the values for the "results" selector

Returns: array Associative array with options

Definition at line 1216 of file SearchController.php.

References TYPO3\CMS\IndexedSearch\Controller\SearchController\removeOptionsFromOptionList().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\formAction().

◆ getAllAvailableOperandsOptions()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getAllAvailableOperandsOptions ( )

protected

get the values for the "defaultOperand" selector

Returns: array Associative array with options

Definition at line 985 of file SearchController.php.

References TYPO3\CMS\IndexedSearch\Controller\SearchController\removeOptionsFromOptionList(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\formAction().

◆ getAllAvailableSearchTypeOptions()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getAllAvailableSearchTypeOptions ( )

protected

get the values for the "type" selector

Returns: array Associative array with options

Definition at line 961 of file SearchController.php.

References TYPO3\CMS\IndexedSearch\Controller\SearchController\removeOptionsFromOptionList(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\formAction().

◆ getAllAvailableSectionsOptions()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getAllAvailableSectionsOptions ( )

protected

get the values for the "section" selector Here values like "rl1_" and "rl2_" + a rootlevel 1/2 id can be added to perform searches in rootlevel 1+2 specifically. The id-values can even be commaseparated. Eg. "rl1_1,2" would search for stuff inside pages on menu-level 1 which has the uid's 1 and 2.

Returns: array Associative array with options

Definition at line 1074 of file SearchController.php.

References TYPO3\CMS\IndexedSearch\Controller\SearchController\getMenuOfPages(), TYPO3\CMS\IndexedSearch\Controller\SearchController\removeOptionsFromOptionList(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\formAction().

◆ getAllAvailableSortDescendingOptions()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getAllAvailableSortDescendingOptions ( )

protected

get the values for the "sortDescending" selector

Returns: array Associative array with options

Definition at line 1196 of file SearchController.php.

References TYPO3\CMS\IndexedSearch\Controller\SearchController\removeOptionsFromOptionList(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\formAction().

◆ getAllAvailableSortOrderOptions()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getAllAvailableSortOrderOptions ( )

protected

get the values for the "section" selector Here values like "rl1_" and "rl2_" + a rootlevel 1/2 id can be added to perform searches in rootlevel 1+2 specifically. The id-values can even be commaseparated. Eg. "rl1_1,2" would search for stuff inside pages on menu-level 1 which has the uid's 1 and 2.

Returns: array Associative array with options

Definition at line 1156 of file SearchController.php.

References TYPO3\CMS\IndexedSearch\Controller\SearchController\removeOptionsFromOptionList(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\formAction().

◆ getDatabaseConnection()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getDatabaseConnection ( )

protected

Getter for database connection

Returns

Definition at line 1434 of file SearchController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableIndexConfigurationsOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableLanguageOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getFirstSysDomainRecordForPage(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getMenuOfPages(), TYPO3\CMS\IndexedSearch\Controller\SearchController\makeDescription(), TYPO3\CMS\IndexedSearch\Controller\SearchController\searchAction(), and TYPO3\CMS\IndexedSearch\Controller\SearchController\writeSearchStat().

◆ getDisplayResults()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getDisplayResults	(	$searchWords,
		$resultData,
		$freeIndexUid = `-1`
	)

protected

Compiles the HTML display of the incoming array of result rows.

Parameters

array	$searchWords	Search words array (for display of text describing what was searched for)
array	$resultData	Array with result rows, count, first row.
int	$freeIndexUid	Pointing to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content.

Returns: array

Definition at line 286 of file SearchController.php.

References TYPO3\CMS\IndexedSearch\Controller\SearchController\$resultSections, TYPO3\CMS\IndexedSearch\Controller\SearchController\$searchWords, TYPO3\CMS\IndexedSearch\Controller\SearchController\compileResultRows(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getPathFromPageId(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\searchAction().

◆ getFirstSysDomainRecordForPage()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getFirstSysDomainRecordForPage ( $id )

protected

Gets the first sys_domain record for the page, $id

Parameters

int $id Page id

Returns: string Domain name

Definition at line 1372 of file SearchController.php.

References $GLOBALS, and TYPO3\CMS\IndexedSearch\Controller\SearchController\getDatabaseConnection().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\getPathFromPageId().

◆ getMenuOfPages()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getMenuOfPages ( $pageUid )

protected

Return the menu of pages used for the selector.

Parameters

int $pageUid Page ID for which to return menu

Returns: array Menu items (for making the section selector box)

Definition at line 1304 of file SearchController.php.

References $GLOBALS, and TYPO3\CMS\IndexedSearch\Controller\SearchController\getDatabaseConnection().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableSectionsOptions().

◆ getPathFromPageId()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getPathFromPageId	(	$id,
		$pathMP = `''`
	)

protected

Returns the path to the page $id

Parameters

int	$id	Page ID
string	$pathMP	Content of the MP (mount point) variable

Returns: string Path (HTML-escaped)

Definition at line 1326 of file SearchController.php.

References $GLOBALS, and TYPO3\CMS\IndexedSearch\Controller\SearchController\getFirstSysDomainRecordForPage().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\compileResultRows(), TYPO3\CMS\IndexedSearch\Controller\SearchController\compileSingleResultRow(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getDisplayResults(), and TYPO3\CMS\IndexedSearch\Controller\SearchController\linkPage().

◆ getSearchWords()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getSearchWords ( $defaultOperator )

protected

Splits the search word input into an array where each word is represented by an array with key "sword" holding the search word and key "oper" holding the SQL operator (eg. AND, OR)

Only words with 2 or more characters are accepted Max 200 chars total Space is used to split words, "" can be used search for a whole string AND, OR and NOT are prefix words, overruling the default operator +/|/- equals AND, OR and NOT as operators. All search words are converted to lowercase.

$defOp is the default operator. 1=OR, 0=AND

Parameters

bool $defaultOperator If TRUE, the default operator will be OR, not AND

Returns: array Search words if any found

Definition at line 815 of file SearchController.php.

References $GLOBALS, TYPO3\CMS\IndexedSearch\Controller\SearchController\$searchWords, TYPO3\CMS\IndexedSearch\Utility\IndexedSearchUtility\getExplodedSearchString(), TYPO3\CMS\IndexedSearch\Controller\SearchController\hookRequest(), TYPO3\CMS\IndexedSearch\Controller\SearchController\procSearchWordsByLexer(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\initialize().

◆ getSpecialConfigurationForResultRow()

TYPO3\CMS\IndexedSearch\Controller\SearchController::getSpecialConfigurationForResultRow ( $row )

protected

Returns configuration from TypoScript for result row based on ID / location in page tree!

Parameters

array $row Result row

Returns: array Configuration array

Definition at line 515 of file SearchController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\compileSingleResultRow().

◆ hookRequest()

TYPO3\CMS\IndexedSearch\Controller\SearchController::hookRequest ( $functionName )

protected

Returns an object reference to the hook object if any

Parameters

string $functionName Name of the function you want to call / hook key

Returns: object|NULL Hook object, if any. Otherwise NULL.

Definition at line 1405 of file SearchController.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\getSearchWords(), TYPO3\CMS\IndexedSearch\Controller\SearchController\initialize(), and TYPO3\CMS\IndexedSearch\Controller\SearchController\searchAction().

◆ initialize()

TYPO3\CMS\IndexedSearch\Controller\SearchController::initialize ( $searchData = [] )

sets up all necessary object for searching

Parameters

array $searchData The incoming search parameters

Returns: array Search parameters

Definition at line 159 of file SearchController.php.

References $GLOBALS, TYPO3\CMS\IndexedSearch\Controller\SearchController\$searchData, TYPO3\CMS\IndexedSearch\Controller\SearchController\$sword, TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getSearchWords(), TYPO3\CMS\IndexedSearch\Controller\SearchController\hookRequest(), TYPO3\CMS\IndexedSearch\Controller\SearchController\initializeExternalParsers(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), TYPO3\CMS\IndexedSearch\Controller\SearchController\loadSettings(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\redirect().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\formAction(), and TYPO3\CMS\IndexedSearch\Controller\SearchController\searchAction().

◆ initializeExternalParsers()

TYPO3\CMS\IndexedSearch\Controller\SearchController::initializeExternalParsers ( )

protected

simple function to initialize possible external parsers feeds the $this->externalParsers array

Returns: void

Definition at line 1385 of file SearchController.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\initialize().

◆ injectTypoScriptService()

TYPO3\CMS\IndexedSearch\Controller\SearchController::injectTypoScriptService ( \TYPO3\CMS\Extbase\Service\TypoScriptService $typoScriptService )

Parameters

\TYPO3\CMS\Extbase\Service\TypoScriptService $typoScriptService

Definition at line 148 of file SearchController.php.

References TYPO3\CMS\IndexedSearch\Controller\SearchController\$typoScriptService.

◆ linkPage()

TYPO3\CMS\IndexedSearch\Controller\SearchController::linkPage	(	$pageUid,
		$linkText,
		$row = `[]`,
		$markUpSwParams = `[]`
	)

protected

Links the $linkText to page $pageUid

Parameters

int	$pageUid	Page id
string	$linkText	Title to link (must already be escaped for HTML output)
array	$row	Result row
array	$markUpSwParams	Additional parameters for marking up seach words

Returns: string tag wrapped title string.

Todo:: make use of the UriBuilder

Definition at line 1262 of file SearchController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$uriBuilder, TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getPathFromPageId(), and TYPO3\CMS\Core\Utility\GeneralUtility\implodeArrayForUrl().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\compileSingleResultRow().

◆ loadSettings()

TYPO3\CMS\IndexedSearch\Controller\SearchController::loadSettings ( )

protected

Load settings and apply stdWrap to them

Definition at line 1442 of file SearchController.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\initialize().

◆ makeDescription()

TYPO3\CMS\IndexedSearch\Controller\SearchController::makeDescription	(	$row,
		$noMarkup = `false`,
		$length = `180`
	)

protected

Returns the resume for the search-result.

Parameters

array	$row	Search result row
bool	$noMarkup	If noMarkup is FALSE, then the index_fulltext table is used to select the content of the page, split it with regex to display the search words in the text.
int	$length	String length

Returns: string HTML string

Todo:: overwork this

Definition at line 656 of file SearchController.php.

References $GLOBALS, TYPO3\CMS\IndexedSearch\Controller\SearchController\getDatabaseConnection(), TYPO3\CMS\IndexedSearch\Controller\SearchController\markupSWpartsOfString(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\compileSingleResultRow().

◆ makeRating()

TYPO3\CMS\IndexedSearch\Controller\SearchController::makeRating ( $row )

protected

Return the rating-HTML code for the result row. This makes use of the $this->firstRow

Parameters

array $row Result row array

Returns: string String showing ranking value

Todo:: can this be a ViewHelper?

Definition at line 540 of file SearchController.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\compileSingleResultRow().

◆ markupSWpartsOfString()

TYPO3\CMS\IndexedSearch\Controller\SearchController::markupSWpartsOfString ( $str )

protected

Marks up the search words from $this->searchWords in the $str with a color.

Parameters

string $str Text in which to find and mark up search words. This text is assumed to be UTF-8 like the search words internally is.

Returns: string Processed content

Definition at line 687 of file SearchController.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\makeDescription().

◆ multiplePagesType()

TYPO3\CMS\IndexedSearch\Controller\SearchController::multiplePagesType ( $item_type )

protected

Returns if an item type is a multipage item type

Parameters

string $item_type Item type

Returns: bool TRUE if multipage capable

Definition at line 1424 of file SearchController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\compileSingleResultRow().

◆ noTypoScriptAction()

TYPO3\CMS\IndexedSearch\Controller\SearchController::noTypoScriptAction ( )

TypoScript was not loaded

Definition at line 949 of file SearchController.php.

◆ procSearchWordsByLexer()

TYPO3\CMS\IndexedSearch\Controller\SearchController::procSearchWordsByLexer ( $searchWords )

protected

Post-process the search word array so it will match the words that was indexed (including case-folding if any) If any words are splitted into multiple words (eg. CJK will be!) the operator of the main word will remain.

Parameters

array $searchWords Search word array

Returns: array Search word array, processed through lexer

Definition at line 864 of file SearchController.php.

References $GLOBALS, TYPO3\CMS\IndexedSearch\Controller\SearchController\$searchWords, and TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\getSearchWords().

◆ removeOptionsFromOptionList()

TYPO3\CMS\IndexedSearch\Controller\SearchController::removeOptionsFromOptionList	(	$allOptions,
		$blindOptions
	)

protected

removes blinding entries from the option list of a selector

Parameters

array	$allOptions	associative array containing all options
array	$blindOptions	associative array containing the optionkey as they key and the value = 1 if it should be removed

Returns: array Options from $allOptions with some options removed

Definition at line 1240 of file SearchController.php.

◆ searchAction()

TYPO3\CMS\IndexedSearch\Controller\SearchController::searchAction ( $search = [] )

Performs the search, the display and writing stats

Parameters

array $search the search parameters, an associative array

Returns: void $search

Definition at line 227 of file SearchController.php.

References $GLOBALS, TYPO3\CMS\IndexedSearch\Controller\SearchController\$searchData, TYPO3\CMS\IndexedSearch\Controller\SearchController\getDatabaseConnection(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getDisplayResults(), TYPO3\CMS\IndexedSearch\Controller\SearchController\hookRequest(), TYPO3\CMS\IndexedSearch\Controller\SearchController\initialize(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), TYPO3\CMS\Core\Utility\GeneralUtility\milliseconds(), TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate(), and TYPO3\CMS\IndexedSearch\Controller\SearchController\writeSearchStat().

◆ writeSearchStat()

TYPO3\CMS\IndexedSearch\Controller\SearchController::writeSearchStat	(	$searchParams,
		$searchWords,
		$count,
		$pt
	)

protected

Write statistics information to database for the search operation

Parameters

array	$searchParams	search params
array	$searchWords	Search Word array
int	$count	Number of hits
int	$pt	Milliseconds the search took

Returns: void

Definition at line 760 of file SearchController.php.

References $GLOBALS, TYPO3\CMS\IndexedSearch\Controller\SearchController\$searchWords, TYPO3\CMS\IndexedSearch\Controller\SearchController\$sword, TYPO3\CMS\Core\Utility\IpAnonymizationUtility\anonymizeIp(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getDatabaseConnection(), and TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv().

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\searchAction().

Member Data Documentation

◆ $defaultResultNumber

TYPO3\CMS\IndexedSearch\Controller\SearchController::$defaultResultNumber = 10

protected

Definition at line 62 of file SearchController.php.

◆ $domainRecords

TYPO3\CMS\IndexedSearch\Controller\SearchController::$domainRecords = []

protected

Definition at line 96 of file SearchController.php.

◆ $enableMetaphoneSearch

TYPO3\CMS\IndexedSearch\Controller\SearchController::$enableMetaphoneSearch = false

protected

Definition at line 138 of file SearchController.php.

◆ $externalParsers

TYPO3\CMS\IndexedSearch\Controller\SearchController::$externalParsers = []

protected

Definition at line 82 of file SearchController.php.

◆ $firstRow

TYPO3\CMS\IndexedSearch\Controller\SearchController::$firstRow = []

protected

Definition at line 89 of file SearchController.php.

◆ $iconFileNameCache

TYPO3\CMS\IndexedSearch\Controller\SearchController::$iconFileNameCache = []

protected

Definition at line 124 of file SearchController.php.

◆ $indexerConfig

TYPO3\CMS\IndexedSearch\Controller\SearchController::$indexerConfig = []

protected

Definition at line 131 of file SearchController.php.

◆ $lexerObj

TYPO3\CMS\IndexedSearch\Controller\SearchController::$lexerObj

protected

Definition at line 76 of file SearchController.php.

◆ $pathCache

TYPO3\CMS\IndexedSearch\Controller\SearchController::$pathCache = []

protected

Definition at line 117 of file SearchController.php.

◆ $requiredFrontendUsergroups

TYPO3\CMS\IndexedSearch\Controller\SearchController::$requiredFrontendUsergroups = []

protected

Definition at line 103 of file SearchController.php.

◆ $resultSections

TYPO3\CMS\IndexedSearch\Controller\SearchController::$resultSections = []

protected

Definition at line 110 of file SearchController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\getDisplayResults().

◆ $searchData

TYPO3\CMS\IndexedSearch\Controller\SearchController::$searchData

protected

Definition at line 46 of file SearchController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\formAction(), TYPO3\CMS\IndexedSearch\Controller\SearchController\initialize(), and TYPO3\CMS\IndexedSearch\Controller\SearchController\searchAction().

◆ $searchRepository

TYPO3\CMS\IndexedSearch\Controller\SearchController::$searchRepository = null

protected

Definition at line 69 of file SearchController.php.

◆ $searchRootPageIdList

TYPO3\CMS\IndexedSearch\Controller\SearchController::$searchRootPageIdList = 0

protected

Definition at line 57 of file SearchController.php.

◆ $searchWords

TYPO3\CMS\IndexedSearch\Controller\SearchController::$searchWords = []

protected

Definition at line 41 of file SearchController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\getDisplayResults(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getSearchWords(), TYPO3\CMS\IndexedSearch\Controller\SearchController\procSearchWordsByLexer(), and TYPO3\CMS\IndexedSearch\Controller\SearchController\writeSearchStat().

◆ $sword

TYPO3\CMS\IndexedSearch\Controller\SearchController::$sword = null

protected

Definition at line 36 of file SearchController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\initialize(), and TYPO3\CMS\IndexedSearch\Controller\SearchController\writeSearchStat().

◆ $typoScriptService

TYPO3\CMS\IndexedSearch\Controller\SearchController::$typoScriptService

protected

Definition at line 143 of file SearchController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\injectTypoScriptService().

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ compileResultRows()

◆ compileSingleResultRow()

◆ formAction()

◆ getAllAvailableGroupOptions()

◆ getAllAvailableIndexConfigurationsOptions()

◆ getAllAvailableLanguageOptions()

◆ getAllAvailableMediaTypesOptions()

◆ getAllAvailableNumberOfResultsOptions()

◆ getAllAvailableOperandsOptions()

◆ getAllAvailableSearchTypeOptions()

◆ getAllAvailableSectionsOptions()

◆ getAllAvailableSortDescendingOptions()

◆ getAllAvailableSortOrderOptions()

◆ getDatabaseConnection()

◆ getDisplayResults()

◆ getFirstSysDomainRecordForPage()

◆ getMenuOfPages()

◆ getPathFromPageId()

◆ getSearchWords()

◆ getSpecialConfigurationForResultRow()

◆ hookRequest()

◆ initialize()

◆ initializeExternalParsers()

◆ injectTypoScriptService()

◆ linkPage()

◆ loadSettings()

◆ makeDescription()

◆ makeRating()

◆ markupSWpartsOfString()

◆ multiplePagesType()

◆ noTypoScriptAction()

◆ procSearchWordsByLexer()

◆ removeOptionsFromOptionList()

◆ searchAction()

◆ writeSearchStat()

Member Data Documentation

◆ $defaultResultNumber

◆ $domainRecords

◆ $enableMetaphoneSearch

◆ $externalParsers

◆ $firstRow

◆ $iconFileNameCache

◆ $indexerConfig

◆ $lexerObj

◆ $pathCache

◆ $requiredFrontendUsergroups

◆ $resultSections

◆ $searchData

◆ $searchRepository

◆ $searchRootPageIdList

◆ $searchWords

◆ $sword

◆ $typoScriptService