CirrusSearch
Elasticsearch-powered search for MediaWiki
Loading...
Searching...
No Matches
CirrusSearch\Parser\AST\BooleanClause Class Reference

A boolean clause. More...

+ Inheritance diagram for CirrusSearch\Parser\AST\BooleanClause:
+ Collaboration diagram for CirrusSearch\Parser\AST\BooleanClause:

Public Member Functions

 __construct (ParsedNode $node, $occur, $explicit, ?NegatedNode $negatedNode=null)
 
 getNode ()
 
 getOccur ()
 Specifies how this clause is to occur in matching documents.
 
 isExplicit ()
 
 accept (Visitor $visitor)
 
 getNegatedNode ()
 

Static Public Member Functions

static validateOccur ( $occur)
 Check if $occur is valid.
 

Public Attributes

const MUST = 'MUST'
 
const SHOULD = 'SHOULD'
 
const MUST_NOT = 'MUST_NOT'
 

Detailed Description

A boolean clause.

Constructor & Destructor Documentation

◆ __construct()

CirrusSearch\Parser\AST\BooleanClause::__construct ( ParsedNode $node,
$occur,
$explicit,
?NegatedNode $negatedNode = null )
Parameters
ParsedNode$node
string$occurSpecifies how this clause is to occur in matching documents.
bool$explicitwhether or not this node is explicitly connected
NegatedNode | null$negatedNodewhen in a MUST_NOT, remember how this clause was negated acceptable values are BooleanClause::MUST, BooleanClause::MUST_NOT and BooleanClause::SHOULD

Member Function Documentation

◆ accept()

CirrusSearch\Parser\AST\BooleanClause::accept ( Visitor $visitor)
Parameters
Visitor$visitor

Implements CirrusSearch\Parser\AST\Visitor\Visitable.

◆ getNegatedNode()

CirrusSearch\Parser\AST\BooleanClause::getNegatedNode ( )
Returns
NegatedNode|null

◆ getNode()

CirrusSearch\Parser\AST\BooleanClause::getNode ( )
Returns
ParsedNode

◆ getOccur()

CirrusSearch\Parser\AST\BooleanClause::getOccur ( )

Specifies how this clause is to occur in matching documents.

Returns
string

◆ isExplicit()

CirrusSearch\Parser\AST\BooleanClause::isExplicit ( )
Returns
bool

◆ validateOccur()

static CirrusSearch\Parser\AST\BooleanClause::validateOccur ( $occur)
static

Check if $occur is valid.

Parameters
string$occur

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