1. Documentation
  2. API
  3. Backend
  4. FilterWidgets
  5. Group

Backend\FilterWidgets\Group

Overview

Group filter

Extends

Public Properties

There are no public properties in the class.

Show inherited public properties

Inherited Public Properties

Protected Properties

There are no protected properties in the class.

Show inherited protected properties

Inherited Protected Properties

Public Methods

public applyScopeToQuery()

public applyScopeToQuery($query): void

public getActiveValue()

public getActiveValue(): void

public onGetGroupOptions()

public onGetGroupOptions(): void

public prepareVars()

public prepareVars(): void

prepareVars for display

public render()

public render(): void

render the widget's primary contents.

public renderForm()

public renderForm(): void

renderForm the form to use for filtering

Show inherited public methods

Inherited Public Methods

Protected Methods

protected filterActiveOptions()

protected filterActiveOptions($activeKeys, $availableOptions): array

filterActiveOptions removes any already selected options from the available options, returns a newly built array

protected filterOptionsBySearch()

protected filterOptionsBySearch(array $options, string $query): array

filterOptionsBySearch filters an array of options by a search term.

protected getAvailableOptions()

protected getAvailableOptions($searchQuery = null): array

getAvailableOptions returns the available options a scope can use, either from the model relation or from a supplied array. Optionally apply a search constraint to the options

protected getOptionsFromArray()

protected getOptionsFromArray($searchQuery = null): array

getOptionsFromArray looks at the defined set of options for scope items, or the model method.

protected getOptionsFromModel()

protected getOptionsFromModel($searchQuery = null): Collection

getOptionsFromModel looks at the model for defined scope items.

protected loadAssets()

protected loadAssets(): void

loadAssets adds widget specific asset files. Use $this->addJs() and $this->addCss() to register new assets to include on the page.

protected optionsToAjax()

protected optionsToAjax($options): array

optionsToAjax converts a key/pair array to a named array {id: 1, name: 'Foobar'}

Show inherited protected methods

Inherited Protected Methods