classes_lib_controls_listing_wdflistingfilter.class

Classes in file lib/controls/listing/wdflistingfilter.class.php

class WdfListingFilter

Simple filters for WdfListing controls.

Extends: Template » Renderable

addEqualsInput

Adds a EQ filter.

Definition: public function addEqualsInput($control, $column)

Returns: mixed

Parameters:

• mixed $control Input control (like TextInput)

• mixed $column Column name

addEqualsSelect

Adds a EQ Select control.

Definition: public function addEqualsSelect($name, $title, $column)

Returns: mixed

Parameters:

• mixed $name Name-attribute for the control.

• mixed $title Title-attribute for the control.

• mixed $column Column name

addSearchInput

Adds a search TextInput control. Note: This performs a case-insensitive substring search.

Definition: public function addSearchInput($name, $title, $columns)

Returns: mixed

Parameters:

• mixed $name Name-attribute for the control.

• mixed $title Title-attribute for the control.

• mixed $columns Columns to search in

dataFromPost

INTERNAL

getInput

Returns an input control by name.

Definition: public function getInput($name)

Returns: mixed

Parameters:

• mixed $name The control name.

getSql

INTERNAL Returns prepare SQL fragment

getValue

Returns the value of a filter by name.

Definition: public function getValue($name, $default=false)

Returns: mixed

Parameters:

• mixed $name The filter name.

• mixed $default An optional default value.

resetValues

INTERNAL Resets all filter values.

setListing

Do not use! Use WdfListing::setFilter() instead.

Definition: public function setListing($listing)

Returns: static

Parameters:

• mixed $listing WdfListing instance

setValue

Sets the value of a filter by name.

Definition: public function setValue($name, $value)

Returns: mixed

Parameters:

• mixed $name Filter name

• mixed $value Filter value (in null is given, the value is removed)