\midcom_services_indexer_filter

This class provides an abstract base class for all indexer query filters.

A filter will restrict any query for a given field, showing only results matching the filter. In essence, this is a limited version of the range query facility supported by Lucene.

Summary

Methods
Properties
Constants
__construct()
get_field()
get_query_string()
No public properties found
No constants found
No protected methods found
$_field
N/A
No private methods found
No private properties found
N/A

Properties

$_field

$_field : string

The name of the field that should be restricted.

Type

string

Methods

__construct()

__construct(string  $field) 

Initialize the class.

Parameters

string $field

The name of the field that should be filtered.

get_field()

get_field() : string

Returns the name of the field.

Returns

string

get_query_string()

get_query_string() : string

Returns the filter's string representation

Returns

string —

The string to append to the query