IFilter
in
Interface IFilter
Tags
Table of Contents
Methods
- allowedApps() : array<string|int, string>
- filterTypes() : array<string|int, string>
- getIcon() : string
- getIdentifier() : string
- getName() : string
- getPriority() : int
Methods
allowedApps()
public
allowedApps() : array<string|int, string>
Tags
Return values
array<string|int, string> —An array of allowed apps from which activities should be displayed
filterTypes()
public
filterTypes(array<string|int, string> $types) : array<string|int, string>
Parameters
- $types : array<string|int, string>
Tags
Return values
array<string|int, string> —An array of allowed apps from which activities should be displayed
getIcon()
public
getIcon() : string
Tags
Return values
string —Full URL to an icon, empty string when none is given
getIdentifier()
public
getIdentifier() : string
Tags
Return values
string —Lowercase a-z and underscore only identifier
getName()
public
getName() : string
Tags
Return values
string —A translated string
getPriority()
public
getPriority() : int
Tags
Return values
int —whether the filter should be rather on the top or bottom of the admin section. The filters are arranged in ascending order of the priority values. It is required to return a value between 0 and 100.