\midcom_services_indexer_filter_date

This class provides a date 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
$_start
$_end
N/A

Properties

$_field

$_field : string

The name of the field that should be restricted.

Type

string

$_start

$_start : integer

Start timestamp, may be 0

Type

integer

$_end

$_end : integer

End timestamp, may be 0

Type

integer

Methods

__construct()

__construct(string  $field, integer  $start, integer  $end) 

Create a new date filter.

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

Parameters

string $field

The name of the field that should be filtered.

integer $start

Start of filter range (or 0 for no start filter)

integer $end

End of filter range (or 0 for no end filter)

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