OpenPSA API Documentation
\
midcom
datamanager
extension
transformer
type
helper
indexer
storage
container
template
validation
dba
events
grid
provider
routing
workflow

\org_openpsa_core_filter_timeframe

Helper class that encapsulates a timeframe filter

Summary

Methods
Properties
Constants
apply()
add_head_elements()
render()
set_label()
__construct()
$name
No constants found
_render_actions()
$_selection
$_label
N/A
No private methods found
$start
$end
N/A

Properties

$name

$name : string

The filter's unique name

Type

string

$_selection

$_selection : array

The filter selection, if any

Type

array

$_label

$_label : string

The filter label

Type

string

$start

$start : string

The object field containing the timeframe's start

Type

string

$end

$end : string

The object field containing the timeframe's end

Type

string

Methods

apply()

apply(array  $selection, \midcom_core_query  $query)

Apply filter to given query

Parameters

array $selection

The filter selection
\midcom_core_query $query

The query object

add_head_elements()

add_head_elements()

render()

render()

Renders the filter widget according to mode

set_label()

set_label(  $label)

Parameters

$label

__construct()

__construct(string  $name, string  $start = null, string  $end = null)

Constructor

Parameters

string $name

The filter's name
string $start

The field representing the timeframe's start
string $end

The field representing the timeframe's end

_render_actions()

_render_actions()