CSFilter
in package
Tags
Table of Contents
- addFilterItem() : CSFilterItem
- Appends a new filter item to the filter items array
- create() : CSFilter
- Instantiate a new CSFilter
- createForContext() : CSFilter
- Instantiate a new CSFilter with a context
- delete() : bool
- Deletes the filter
- deleteFilterItems() : mixed
- Deletes the filter items for this filter
- getAllFilters() : array<string|int, mixed>
- Get the list of all the existing filters
- getContext() : string
- Get the filter context
- getFilterItems() : array<string|int, CSFilterItem>
- Get the filter items of the filter
- getFiltersForCurrentUser() : array<string|int, mixed>
- Get the list of all the existing filters created by the current user
- getFiltersForUserId() : array<string|int, mixed>
- Get the list of all the existing filters created by the supplied user id
- getFiltersForUserIdAndContext() : array<string|int, mixed>
- Get the list of all the filters created by the supplied user id and the supplied context
- getId() : int
- Get the filter id
- getLabel() : string
- Get the filter label
- getValue() : string|null
- Get a value from the filter record using the given property name
- load() : CSFilter
- Instantiate an existing CSFilter
- setContext() : mixed
- Set the filter context
- setLabel() : mixed
- Set the filter label
- setValue() : mixed
- Set a value on the filter record using the given property name and value
- store() : mixed
- API for the record store() method
Methods
addFilterItem()
Appends a new filter item to the filter items array
public
addFilterItem(int $iFilterType[, string|null $sFilterValue = null ]) : CSFilterItem
Parameters
- $iFilterType : int
- $sFilterValue : string|null = null
Tags
Return values
CSFilterItem —create()
Instantiate a new CSFilter
public
static create() : CSFilter
Tags
Return values
CSFilter —createForContext()
Instantiate a new CSFilter with a context
public
static createForContext(string $sContext) : CSFilter
Parameters
- $sContext : string
-
The name of the context where the filter was created.
Tags
Return values
CSFilter —delete()
Deletes the filter
public
delete() : bool
Tags
Return values
bool —deleteFilterItems()
Deletes the filter items for this filter
public
deleteFilterItems() : mixed
Tags
Return values
mixed —getAllFilters()
Get the list of all the existing filters
public
static getAllFilters() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getContext()
Get the filter context
public
getContext() : string
Tags
Return values
string —getFilterItems()
Get the filter items of the filter
public
getFilterItems() : array<string|int, CSFilterItem>
Tags
Return values
array<string|int, CSFilterItem> —getFiltersForCurrentUser()
Get the list of all the existing filters created by the current user
public
static getFiltersForCurrentUser() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getFiltersForUserId()
Get the list of all the existing filters created by the supplied user id
public
static getFiltersForUserId(int $iUserId) : array<string|int, mixed>
Parameters
- $iUserId : int
Tags
Return values
array<string|int, mixed> —getFiltersForUserIdAndContext()
Get the list of all the filters created by the supplied user id and the supplied context
public
static getFiltersForUserIdAndContext(int $iUserId, string $sContext) : array<string|int, mixed>
Parameters
- $iUserId : int
- $sContext : string
Tags
Return values
array<string|int, mixed> —getId()
Get the filter id
public
getId() : int
Tags
Return values
int —getLabel()
Get the filter label
public
getLabel() : string
Tags
Return values
string —getValue()
Get a value from the filter record using the given property name
public
getValue(string $sName) : string|null
Parameters
- $sName : string
Tags
Return values
string|null —load()
Instantiate an existing CSFilter
public
static load(int $iId) : CSFilter
Parameters
- $iId : int
Tags
Return values
CSFilter —setContext()
Set the filter context
public
setContext(string $sNewContext) : mixed
Parameters
- $sNewContext : string
Tags
Return values
mixed —setLabel()
Set the filter label
public
setLabel(string $sNewLabel) : mixed
Parameters
- $sNewLabel : string
Tags
Return values
mixed —setValue()
Set a value on the filter record using the given property name and value
public
setValue(string $sName, mixed $mValue) : mixed
Parameters
- $sName : string
- $mValue : mixed
Tags
Return values
mixed —store()
API for the record store() method
public
store() : mixed
It also calls the store() of the filter items associated with this filter