ExternalSearchOptions
Exposes the search options of external search plugins
Namespace
Ceres\Helper
Type | Name | Value | Description |
---|---|---|---|
|
'Ceres.Search.Options' |
Type | Name | Description |
---|---|---|
|
All itemsPerPage options |
|
|
The default items per page |
|
|
Does the external search have an items per page option? |
|
|
All sorting options |
|
|
The default sorting |
|
|
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
Type |
Name |
Description |
|
All available itemsPerPage settings |
|
|
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
Type |
Name |
Description |
|
All available sorting options |
|
|
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?