Documentation

Filter extends Base
in package

Table of Contents

Properties

$fd  : mixed

Methods

__construct()  : mixed
custom()  : mixed
Allow caller to pass in html codes to be added into the filter bar
dateRange()  : mixed
Renders a date range filter
getTemplate()  : mixed
Central method to generate a new theme object so that we can centralize and inject variables into the library
limit()  : mixed
Renders a dropdown to filter number of items per page
lists()  : mixed
Renders a generic dropdown for filters
published()  : mixed
Renders the published dropdown list on the filter bar
search()  : mixed
Renders a search box in the filter
spacer()  : mixed
Renders a space on the filters bar

Properties

$fd

protected mixed $fd = null

Methods

__construct()

public __construct(mixed $fd) : mixed
Parameters
$fd : mixed

custom()

Allow caller to pass in html codes to be added into the filter bar

public custom(mixed $html) : mixed
Parameters
$html : mixed
Tags
since
1.0.0
access

public

dateRange()

Renders a date range filter

public dateRange([mixed $selected = '' ][, mixed $name = 'dateRange' ][, mixed $placeholder = '' ][, mixed $options = [] ]) : mixed
Parameters
$selected : mixed = ''
$name : mixed = 'dateRange'
$placeholder : mixed = ''
$options : mixed = []
Tags
since
1.0.0
access

public

getTemplate()

Central method to generate a new theme object so that we can centralize and inject variables into the library

public getTemplate() : mixed
Tags
since
1.0.0
access

public

limit()

Renders a dropdown to filter number of items per page

public limit([mixed $selected = 5 ][, mixed $name = 'limit' ][, mixed $stepping = 5 ][, mixed $min = 5 ][, mixed $max = 100 ][, mixed $showAll = true ][, mixed $options = [] ]) : mixed
Parameters
$selected : mixed = 5
$name : mixed = 'limit'
$stepping : mixed = 5
$min : mixed = 5
$max : mixed = 100
$showAll : mixed = true
$options : mixed = []
Tags
since
1.0.0
access

public

lists()

Renders a generic dropdown for filters

public lists(mixed $name[, mixed $items = [] ][, mixed $selected = 'all' ][, mixed $options = [] ]) : mixed
Parameters
$name : mixed
$items : mixed = []
$selected : mixed = 'all'
$options : mixed = []
Tags
since
1.0.0
access

public

published()

Renders the published dropdown list on the filter bar

public published([mixed $name = 'state' ][, mixed $selected = 'all' ][, mixed $options = [] ]) : mixed
Parameters
$name : mixed = 'state'
$selected : mixed = 'all'
$options : mixed = []
Tags
since
1.0.0
access

public

Renders a search box in the filter

public search([mixed $value = '' ][, mixed $name = 'search' ][, mixed $options = [] ]) : mixed
Parameters
$value : mixed = ''
$name : mixed = 'search'
$options : mixed = []
Tags
since
1.0.0
access

public

spacer()

Renders a space on the filters bar

public spacer() : mixed
Tags
since
1.0.0
access

public


        
On this page

Search results