ExternalSearch
Helper class to allow searches from external plugins.
Namespace
Ceres\Helper
Type | Name | Value | Description |
---|---|---|---|
|
'Ceres.Search.Query' |
Type | Name | Description |
---|---|---|
|
The search string |
|
|
Category id to search items for (Default: 0) |
|
|
What page to get (Default: 1) |
|
|
How many items per page (Default: 20) |
|
|
How should the result be sorted |
|
|
The result of the search, an array of variation ids |
|
|
Amount of results |
|
|
Is there a result? |
Methods
public static getExternalResults($container):mixed
Perform the external search
Type |
Name |
Description |
|
An ExternalSearch object |
public static hasExternalSearch():bool
Check if there is an external search plugin?
public setResults($variationIds, $countTotal = null)
Set the results of the external search
Type |
Name |
Description |
|
The variation ids found by the search |
|
|
Optional: The amount of found variation ids |
public hasResults():bool
Return true if the search has a result
public getResults():array
Return the results of the search
public getCountTotal():int
The amount of found variations