QueryParser Class Reference

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

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

Protected Member Functions
	extractKeyFromQuery ($query)

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

Detailed Description

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

Definition at line 21 of file QueryParser.php.

Member Function Documentation

extractKeyFromQuery (   $query )

protected

Retrieve the validated command key

Parameters

string

$query

Returns

string Command name

Definition at line 49 of file QueryParser.php.

Referenced by QueryParser\getSearchQueryValue(), and QueryParser\getTableNameFromCommand().

getCommandForPageJump

(

$query

)

Gets the page jump command for a given query.

Parameters

string

$query

Returns

string

Definition at line 146 of file QueryParser.php.

References QueryParser\getCommandForTable(), QueryParser\getId(), and QueryParser\isValidPageJump().

getCommandForTable

(

$tableName

)

Gets the command for the given table.

Parameters

string

$tableName

The table to find a command for.

Returns

string

Definition at line 129 of file QueryParser.php.

References $GLOBALS, and QueryParser\$tableName.

Referenced by QueryParser\getCommandForPageJump().

getId

(

$query

)

Verify if an given query contains a page jump command.

Parameters

string

$query

A valid value looks like '#14'

Returns

int

Definition at line 88 of file QueryParser.php.

Referenced by QueryParser\getCommandForPageJump().

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 60 of file QueryParser.php.

References QueryParser\extractKeyFromQuery().

getTableNameFromCommand

(

$query

)

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

Parameters

string

$query

Returns

string Database Table name

Definition at line 72 of file QueryParser.php.

References QueryParser\$commandKey, $GLOBALS, QueryParser\$tableName, and QueryParser\extractKeyFromQuery().

Referenced by QueryParser\isValidCommand().

isValidCommand

(

$query

)

Verify if an given query contains an registered command key.

Parameters

string

$query

Returns

bool

Definition at line 114 of file QueryParser.php.

References QueryParser\getTableNameFromCommand().

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 99 of file QueryParser.php.

Referenced by QueryParser\getCommandForPageJump().

Member Data Documentation

$commandKey = ''

protected

Definition at line 26 of file QueryParser.php.

Referenced by QueryParser\getTableNameFromCommand().

$tableName = ''

protected

Definition at line 31 of file QueryParser.php.

Referenced by QueryParser\getCommandForTable(), and QueryParser\getTableNameFromCommand().

const COMMAND_KEY_INDICATOR = '#'

Definition at line 36 of file QueryParser.php.

const COMMAND_SPLIT_INDICATOR = ':'

Definition at line 41 of file QueryParser.php.