CSFilterService
This file defines the service for the filterbar.
Tags
Table of Contents
- executeDeleteFilter() : bool
- Delete a filter with the given ID
- executeGetFilterListForUserIdAndContext() : array<string|int, mixed>
- Get an array with all the saved filters for a specific user and a specific app
- executeSaveFilter() : array<string|int, mixed>
- Save a new filter or an existing filter
Methods
executeDeleteFilter()
Delete a filter with the given ID
public
executeDeleteFilter(mixed $mId) : bool
Parameters
- $mId : mixed
-
Filter id to delete
Tags
Return values
bool —executeGetFilterListForUserIdAndContext()
Get an array with all the saved filters for a specific user and a specific app
public
executeGetFilterListForUserIdAndContext(mixed $mId, string|null $sContext) : array<string|int, mixed>
Parameters
- $mId : mixed
-
The user ID
- $sContext : string|null
-
If null, returns all the filters created by supplied user id
Tags
Return values
array<string|int, mixed> —executeSaveFilter()
Save a new filter or an existing filter
public
executeSaveFilter(mixed $mId[, string|null $sContext = null ]) : array<string|int, mixed>
Parameters
- $mId : mixed
-
Filter id, 0 if new filter
- $sContext : string|null = null
-
The name of the application where the filter is used, if null the filter will be available in all apps