Filter Class Reference

Inheritance diagram for Filter:

Public Member Functions
	__construct ($name, $boost, $referenceType, $reference)
	getType ()
	getName ()
	getBoost ()
	getReference ()
	getReferenceType ()

Data Fields
const	REFERENCE_QUERY = 'query'
const	REFERENCE_FILTER = 'filter'
Data Fields inherited from QueryInterface
const	TYPE_MATCH = 'matchQuery'
const	TYPE_BOOL = 'boolQuery'
const	TYPE_FILTER = 'filteredQuery'

Protected Attributes
	$name
	$boost
	$referenceType
	$reference

Detailed Description

Term Query @api

Since

100.0.2

Definition at line 15 of file Filter.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$name,
			$boost,
			$referenceType,
			$reference
	)

Parameters

string	$name
int | null	$boost
string	$referenceType
string	$reference

Definition at line 56 of file Filter.php.

    {
        $this->name = $name;
        $this->boost = $boost;
        $this->referenceType = $referenceType;
        $this->reference = $reference;
    }

Member Function Documentation

getBoost()

getBoost

(

)

{Get Boost

Returns

int|null

}

Implements QueryInterface.

Definition at line 85 of file Filter.php.

    {
        return $this->boost;
    }

getName()

getName

(

)

{Get Name

Returns

string

} @codeCoverageIgnore

Implements QueryInterface.

Definition at line 77 of file Filter.php.

    {
        return $this->name;
    }

getReference()

getReference

(

)

Get Reference

Returns

mixed @codeCoverageIgnore

Definition at line 96 of file Filter.php.

    {
        return $this->reference;
    }

getReferenceType()

getReferenceType

(

)

Get Reference Type

Returns

string @codeCoverageIgnore

Definition at line 107 of file Filter.php.

    {
        return $this->referenceType;
    }

getType()

getType

(

)

{#- Get Type

Returns

string

} @codeCoverageIgnore

Implements QueryInterface.

Definition at line 68 of file Filter.php.

    {
        return QueryInterface::TYPE_FILTER;
    }

Field Documentation

$boost

$boost

protected

Definition at line 34 of file Filter.php.

$name

$name

protected

#- #-

Definition at line 27 of file Filter.php.

$reference

$reference

protected

Definition at line 48 of file Filter.php.

$referenceType

$referenceType

protected

Definition at line 41 of file Filter.php.

REFERENCE_FILTER

const REFERENCE_FILTER = 'filter'

Definition at line 22 of file Filter.php.

REFERENCE_QUERY

const REFERENCE_QUERY = 'query'

#+ Reference Types

Definition at line 20 of file Filter.php.

---

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

• vendor/magento/framework/Search/Request/Query/Filter.php