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

Public Member Functions
string	getSearchQueryValue ($query)
string	getTableNameFromCommand ($query)
int	getId ($query)
bool	isValidPageJump ($query)
bool	isValidCommand ($query)
string	getCommandForTable ($tableName)
string	getCommandForPageJump ($query)

Public Attributes
const	COMMAND_KEY_INDICATOR = '#'
const	COMMAND_SPLIT_INDICATOR = ':'

Protected Member Functions
	extractKeyFromQuery ($query)

Protected Attributes
string	$commandKey = ''
string	$tableName = ''

Detailed Description

Class for parsing query parameters in backend live search. Detects searches for #pages:23 or #content:mycontent

This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.

Definition at line 23 of file QueryParser.php.

Member Function Documentation

extractKeyFromQuery()

TYPO3\CMS\Backend\Search\LiveSearch\QueryParser::extractKeyFromQuery (   $query )

protected

Retrieve the validated command key

Parameters

string

$query

Definition at line 48 of file QueryParser.php.

References TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\$commandKey.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\getSearchQueryValue(), and TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\getTableNameFromCommand().

getCommandForPageJump()

string TYPO3\CMS\Backend\Search\LiveSearch\QueryParser::getCommandForPageJump

(

$query

)

Gets the page jump command for a given query.

Parameters

string

$query

Returns

‪string

Definition at line 145 of file QueryParser.php.

References TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\getCommandForTable(), TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\getId(), and TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\isValidPageJump().

getCommandForTable()

string TYPO3\CMS\Backend\Search\LiveSearch\QueryParser::getCommandForTable

(

$tableName

)

Gets the command for the given table.

Parameters

string

$tableName

‪The table to find a command for.

Returns

‪string

Definition at line 128 of file QueryParser.php.

References $GLOBALS, and TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\$tableName.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\getCommandForPageJump().

getId()

int TYPO3\CMS\Backend\Search\LiveSearch\QueryParser::getId

(

$query

)

Verify if a given query contains a page jump command.

Parameters

string

$query

‪A valid value looks like '#14'

Returns

‪int

Definition at line 87 of file QueryParser.php.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\getCommandForPageJump().

getSearchQueryValue()

string TYPO3\CMS\Backend\Search\LiveSearch\QueryParser::getSearchQueryValue

(

$query

)

Extract the search value from the full search query which contains also the command part.

Parameters

string

$query

‪For example #news:weather

Returns

‪string The extracted search value

Definition at line 59 of file QueryParser.php.

References TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\extractKeyFromQuery().

getTableNameFromCommand()

string TYPO3\CMS\Backend\Search\LiveSearch\QueryParser::getTableNameFromCommand

(

$query

)

Find the registered table command and retrieve the matching table name.

Parameters

string

$query

Returns

‪string Database Table name

Definition at line 71 of file QueryParser.php.

References TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\$commandKey, $GLOBALS, TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\$tableName, and TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\extractKeyFromQuery().

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\isValidCommand().

isValidCommand()

bool TYPO3\CMS\Backend\Search\LiveSearch\QueryParser::isValidCommand

(

$query

)

Verify if a given query contains a registered command key.

Parameters

string

$query

Returns

‪bool

Definition at line 113 of file QueryParser.php.

References TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\getTableNameFromCommand().

isValidPageJump()

bool TYPO3\CMS\Backend\Search\LiveSearch\QueryParser::isValidPageJump

(

$query

)

Verify if a given query contains a page jump command.

Parameters

string

$query

‪A valid value looks like '#14'

Returns

‪bool

Definition at line 98 of file QueryParser.php.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\getCommandForPageJump().

Member Data Documentation

$commandKey

string TYPO3\CMS\Backend\Search\LiveSearch\QueryParser::$commandKey = ''

protected

Definition at line 27 of file QueryParser.php.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\extractKeyFromQuery(), and TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\getTableNameFromCommand().

$tableName

string TYPO3\CMS\Backend\Search\LiveSearch\QueryParser::$tableName = ''

protected

Definition at line 31 of file QueryParser.php.

Referenced by TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\getCommandForTable(), and TYPO3\CMS\Backend\Search\LiveSearch\QueryParser\getTableNameFromCommand().

COMMAND_KEY_INDICATOR

const TYPO3\CMS\Backend\Search\LiveSearch\QueryParser::COMMAND_KEY_INDICATOR = '#'

Definition at line 36 of file QueryParser.php.

COMMAND_SPLIT_INDICATOR

const TYPO3\CMS\Backend\Search\LiveSearch\QueryParser::COMMAND_SPLIT_INDICATOR = ':'

Definition at line 41 of file QueryParser.php.