TYPO3\CMS\IndexedSearch\Controller\SearchController Class Reference

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

Public Member Functions
	initialize ($searchData=array())
	searchAction ($search=array())
	formAction ($search=array())
Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	canProcessRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request)
	processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
	getControllerContext ()
	__construct ()
	injectConfigurationManager (\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager)
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
	injectFlashMessageContainer (\TYPO3\CMS\Extbase\Mvc\Controller\FlashMessageContainer $flashMessageContainer)
	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)
	initializeControllerArgumentsBaseValidators ()

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=array(), $markUpSwParams=array())
	getMenuOfPages ($pageUid)
	getPathFromPageId ($id, $pathMP='')
	getFirstSysDomainRecordForPage ($id)
	initializeExternalParsers ()
	hookRequest ($functionName)
	multiplePagesType ($item_type)
Protected Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	initializeActionMethodArguments ()
	initializeActionMethodValidators ()
	resolveActionMethodName ()
	callActionMethod ()
	emitBeforeCallActionMethodSignal (array $preparedArguments)
	setViewConfiguration (ViewInterface $view)
	getViewProperty ($extbaseFrameworkConfiguration, $setting, $deprecatedSetting='')
	resolveViewObjectName ()
	initializeView (ViewInterface $view)
	initializeAction ()
	errorAction ()
	getErrorFlashMessage ()
	checkRequestHash ()
	clearCacheOnError ()
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 = array()
	$searchData
	$searchRootPageIdList = 0
	$defaultResultNumber = 10
	$searchRepository = NULL
	$lexerObj
	$externalParsers = array()
	$firstRow = array()
	$domainRecords = array()
	$requiredFrontendUsergroups = array()
	$resultSections = array()
	$pathCache = array()
	$iconFileNameCache = array()
	$indexerConfig = array()
	$enableMetaphoneSearch = FALSE
	$typoScriptService
Protected Attributes inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	$reflectionService
	$cacheService
	$view = NULL
	$viewObjectNamePattern = 'Tx_@extension_View_@controller_@action@format'
	$namespacesViewObjectNamePattern = '@vendor\@extension\View\@controller\@action@format'
	$viewFormatToObjectNameMap = array()
	$defaultViewObjectName = 'TYPO3\\CMS\\Fluid\\View\\TemplateView'
	$actionMethodName = 'indexAction'
	$errorMethodName = 'errorAction'
	$mvcPropertyMappingConfigurationService
Protected Attributes inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
	$signalSlotDispatcher
	$objectManager
	$uriBuilder
	$extensionName
	$settings
	$request
	$response
	$deprecatedPropertyMapper
	$validatorResolver
	$arguments
	$argumentsMappingResults
	$supportedRequestTypes = array('TYPO3\\CMS\\Extbase\\Mvc\\Request')
	$controllerContext
	$flashMessageContainer
	$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 searchform for indexed search. Indexing must be enabled for this to make sense.

Author

Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om

Christian Jul Jensen chris.nosp@m.tian.nosp@m.@typo.nosp@m.3.co.nosp@m.m

Benjamin Mack benni.nosp@m.@typ.nosp@m.o3.or.nosp@m.g

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
integer	$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 291 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
integer	$headerOnly	1=Display only header (for sub-rows!), 2=nothing at all

Returns

string HTML code

Definition at line 374 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 = array()

)

Sort options about the search form

Parameters

array

$search

The search data / params

Returns

void $search

Definition at line 855 of file SearchController.php.

References TYPO3\CMS\IndexedSearch\Controller\SearchController\$searchData, TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableGroupOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableIndexConfigurationsOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableLanguageOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableMediaTypesOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableNumberOfResultsOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableOperandsOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableSearchTypeOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableSectionsOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableSortDescendingOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableSortOrderOptions(), and TYPO3\CMS\IndexedSearch\Controller\SearchController\initialize().

getAllAvailableGroupOptions()

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

protected

get the values for the "group" selector

Returns

array Associative array with options

Definition at line 1119 of file SearchController.php.

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

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 1065 of file SearchController.php.

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

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 989 of file SearchController.php.

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

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 953 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 1157 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 934 of file SearchController.php.

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

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 911 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 1020 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 1138 of file SearchController.php.

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

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 1100 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().

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.
integer	$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 256 of file SearchController.php.

References $result, 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

integer

$id

Page id

Returns

string Domain name

Definition at line 1308 of file SearchController.php.

References $GLOBALS.

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

integer

$pageUid

Page ID for which to return menu

Returns

array Menu items (for making the section selector box)

Definition at line 1246 of file SearchController.php.

References $GLOBALS.

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	MP variable content

Returns

string Path

Definition at line 1267 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

boolean

$defaultOperator

If TRUE, the default operator will be OR, not AND

Returns

array Search words if any found

Definition at line 771 of file SearchController.php.

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

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 471 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 Hook object, if any. Otherwise NULL.

Definition at line 1339 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 = array()

)

sets up all necessary object for searching

Parameters

array

$searchData

The incoming search parameters

Returns

array Search parameters

Definition at line 139 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(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

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 1320 of file SearchController.php.

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

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

linkPage()

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

protected

Links the $linkText to page $pageUid

Parameters

integer	$pageUid	Page id
string	$linkText	Title String to link
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 1201 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().

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
boolean	$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.
integer	$length	String length

Returns

string HTML string

Todo:

overwork this

Definition at line 623 of file SearchController.php.

References $GLOBALS, 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 495 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 653 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

boolean TRUE if multipage capable

Definition at line 1357 of file SearchController.php.

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

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 823 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 1180 of file SearchController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableGroupOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableIndexConfigurationsOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableLanguageOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableMediaTypesOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableNumberOfResultsOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableOperandsOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableSearchTypeOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableSectionsOptions(), TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableSortDescendingOptions(), and TYPO3\CMS\IndexedSearch\Controller\SearchController\getAllAvailableSortOrderOptions().

searchAction()

TYPO3\CMS\IndexedSearch\Controller\SearchController::searchAction

(

$search = array()

)

Performs the search, the display and writing stats

Parameters

array

$search

the search parameters, an associative array

Returns

void $search

Definition at line 198 of file SearchController.php.

References $GLOBALS, TYPO3\CMS\IndexedSearch\Controller\SearchController\$searchData, 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	search params
array	Search Word array
integer	Number of hits
integer	Milliseconds the search took

Returns

void

Definition at line 725 of file SearchController.php.

References $GLOBALS, TYPO3\CMS\IndexedSearch\Controller\SearchController\$searchWords, 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 49 of file SearchController.php.

$domainRecords

TYPO3\CMS\IndexedSearch\Controller\SearchController::$domainRecords = array()

protected

Definition at line 83 of file SearchController.php.

$enableMetaphoneSearch

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

protected

Definition at line 125 of file SearchController.php.

$externalParsers

TYPO3\CMS\IndexedSearch\Controller\SearchController::$externalParsers = array()

protected

Definition at line 69 of file SearchController.php.

$firstRow

TYPO3\CMS\IndexedSearch\Controller\SearchController::$firstRow = array()

protected

Definition at line 76 of file SearchController.php.

$iconFileNameCache

TYPO3\CMS\IndexedSearch\Controller\SearchController::$iconFileNameCache = array()

protected

Definition at line 111 of file SearchController.php.

$indexerConfig

TYPO3\CMS\IndexedSearch\Controller\SearchController::$indexerConfig = array()

protected

Definition at line 118 of file SearchController.php.

$lexerObj

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

protected

Definition at line 63 of file SearchController.php.

$pathCache

TYPO3\CMS\IndexedSearch\Controller\SearchController::$pathCache = array()

protected

Definition at line 104 of file SearchController.php.

$requiredFrontendUsergroups

TYPO3\CMS\IndexedSearch\Controller\SearchController::$requiredFrontendUsergroups = array()

protected

Definition at line 90 of file SearchController.php.

$resultSections

TYPO3\CMS\IndexedSearch\Controller\SearchController::$resultSections = array()

protected

Definition at line 97 of file SearchController.php.

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

$searchData

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

protected

Definition at line 36 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 56 of file SearchController.php.

$searchRootPageIdList

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

protected

Definition at line 47 of file SearchController.php.

$searchWords

TYPO3\CMS\IndexedSearch\Controller\SearchController::$searchWords = array()

protected

Definition at line 34 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 32 of file SearchController.php.

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

$typoScriptService

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

protected

Definition at line 131 of file SearchController.php.