Loading [MathJax]/jax/output/HTML-CSS/fonts/TeX/fontdata.js

ExternalSearchOptions

Exposes the search options of external search plugins

Namespace

Ceres\Helper

Constants
Type Name Value Description

string

EVENT_NAME

'Ceres.Search.Options'

Properties
Type Name Description

array

$itemsPerPage

All itemsPerPage options

int

$defaultItemsPerPage

The default items per page

bool

$hasItemsPerPage

Does the external search have an items per page option?

array

$sortingOptions

All sorting options

string

$defaultSorting

The default sorting

bool

$hasSortingOptions

Does the external search have sorting options?

Methods
public static getExternalSearchOptions():ExternalSearchOptions

Get itemsPerPage and sortingOptions from external search plugins

public setItemsPerPage($itemsPerPage, $default)

Set the itemsPerPage and it's default setting

Parameters

Type

Name

Description

array

$itemsPerPage

All available itemsPerPage settings

int

$default

The default itemsPerPage setting

public getItemsPerPage():array

Get all itemsPerPage settings

public getDefaultItemsPerPage():int

Get the default itemsPerPage setting

public setSortingOptions($sorting, $default)

Set the sortingOptions and the default sortingOption

Parameters

Type

Name

Description

array

$sorting

All available sorting options

string

$default

The default sorting option

public getSortingOptions():array

Get the sorting options

public getDefaultSortingOption():string

Return the default sorting option

public hasOptions():bool

Does the external search expose any options at all?