CirrusSearch\Parser\AST\KeywordFeatureNode Class Reference

Represents a keyword in the query. More...

Inheritance diagram for CirrusSearch\Parser\AST\KeywordFeatureNode:

Collaboration diagram for CirrusSearch\Parser\AST\KeywordFeatureNode:

Public Member Functions
	__construct ( $startOffset, $endOffset, KeywordFeature $keyword, $key, $value, $quotedValue, $delimiter, $suffix, ?array $parsedValue=null)
	getKeyword ()
	The feature.
	getKey ()
	The keyword prefix used.
	getValue ()
	The value (unescaped)
	getQuotedValue ()
	The quoted as-is.
	getDelimiter ()
	The delimiter used to wrap the value.
	getSuffix ()
	The optional value suffix used in the query.
	getParsedValue ()
	Return the value parsed by the KeywordFeature implementation.
	toArray ()
	accept (Visitor $visitor)
Public Member Functions inherited from CirrusSearch\Parser\AST\ParsedNode
	__construct ( $startOffset, $endOffset)
	getStartOffset ()
	getEndOffset ()

Additional Inherited Members
Protected Member Functions inherited from CirrusSearch\Parser\AST\ParsedNode
	baseParams ()

Detailed Description

Represents a keyword in the query.

Constructor & Destructor Documentation

__construct()

CirrusSearch\Parser\AST\KeywordFeatureNode::__construct	(		$startOffset,
			$endOffset,
		KeywordFeature	$keyword,
			$key,
			$value,
			$quotedValue,
			$delimiter,
			$suffix,
		?array	$parsedValue = null )

Parameters

int	$startOffset
int	$endOffset
KeywordFeature	$keyword
string	$key
string	$value
string	$quotedValue
string	$delimiter
string	$suffix
array | null	$parsedValue	value as parsed by KeywordFeature::parseValue()

See also

KeywordFeature::parseValue()

Member Function Documentation

accept()

CirrusSearch\Parser\AST\KeywordFeatureNode::accept

(

Visitor

$visitor

)

Parameters

Visitor

$visitor

Implements CirrusSearch\Parser\AST\Visitor\Visitable.

getDelimiter()

CirrusSearch\Parser\AST\KeywordFeatureNode::getDelimiter

(

)

The delimiter used to wrap the value.

Returns

string

getKey()

CirrusSearch\Parser\AST\KeywordFeatureNode::getKey

(

)

The keyword prefix used.

Returns

string

getKeyword()

CirrusSearch\Parser\AST\KeywordFeatureNode::getKeyword

(

)

The feature.

Returns

KeywordFeature

getParsedValue()

CirrusSearch\Parser\AST\KeywordFeatureNode::getParsedValue

(

)

Return the value parsed by the KeywordFeature implementation.

NOTE: Only the keyword implementation knows what to do with this data

Returns

array|null

See also

KeywordFeature::parseValue()

getQuotedValue()

CirrusSearch\Parser\AST\KeywordFeatureNode::getQuotedValue

(

)

The quoted as-is.

Returns

string

getSuffix()

CirrusSearch\Parser\AST\KeywordFeatureNode::getSuffix

(

)

The optional value suffix used in the query.

Returns

string

getValue()

CirrusSearch\Parser\AST\KeywordFeatureNode::getValue

(

)

The value (unescaped)

Returns

string

toArray()

CirrusSearch\Parser\AST\KeywordFeatureNode::toArray

(

)

Returns

array

Reimplemented from CirrusSearch\Parser\AST\ParsedNode.

---

The documentation for this class was generated from the following file:

• includes/Parser/AST/KeywordFeatureNode.php