\midcom_services_indexer_filter_string

This class provides a string query filter

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

$value

N/A

File: lib/midcom/services/indexer/filter/string.php
Package: midcom.services
Class hierarchy: \midcom_services_indexer_filter

\midcom_services_indexer_filter_string
See also: \midcom_services_indexer

Properties

$_field

$_field : string

The name of the field that should be restricted.

Type

string

$value

$value : string

The string we're working with

Type

string

Methods

__construct()

__construct(string  $field, string  $value)

Create a new date filter.

Only one of the filter bounds may be 0, indicating a no limit in that direction.

Parameters

string	$field	The name of the field that should be filtered.
string	$value	The string we're looking for

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