Filter
in package
Provides API to work with vtiger CRM Custom View (Filter).
Table of Contents
- $description : mixed
- $entitytype : mixed
- $featured : mixed
- $id : mixed
- ID of this filter instance
- $inmetrics : mixed
- $isdefault : mixed
- $module : mixed
- $name : mixed
- $presence : mixed
- $privileges : mixed
- $sort : mixed
- $status : mixed
- __create() : mixed
- Create this instance.
- __delete() : mixed
- Delete this instance.
- __getColumnValue() : string
- Get the column value to use in custom view tables.
- __update() : mixed
- addField() : $this
- Add the field to this filer instance.
- addRule() : $this
- Add rule to this filter instance.
- delete() : mixed
- Delete this instance.
- deleteForModule() : mixed
- Delete filter associated for module.
- getAllForModule() : self
- Get all instances of filter for the module.
- getInstance() : mixed
- Get instance by filterid or filtername.
- initialize() : mixed
- Initialize this filter instance.
- save() : mixed
- Save this instance.
Properties
$description
public
mixed
$description
$entitytype
public
mixed
$entitytype
= false
$featured
public
mixed
$featured
= 0
$id
ID of this filter instance
public
mixed
$id
$inmetrics
public
mixed
$inmetrics
= false
$isdefault
public
mixed
$isdefault
$module
public
mixed
$module
$name
public
mixed
$name
$presence
public
mixed
$presence
= 1
$privileges
public
mixed
$privileges
= 1
$sort
public
mixed
$sort
$status
public
mixed
$status
= false
Methods
__create()
Create this instance.
public
__create(mixed $moduleInstance) : mixed
Parameters
- $moduleInstance : mixed
Return values
mixed —__delete()
Delete this instance.
public
__delete() : mixed
Return values
mixed —__getColumnValue()
Get the column value to use in custom view tables.
public
__getColumnValue(FieldBasic $fieldInstance) : string
Parameters
- $fieldInstance : FieldBasic
Return values
string —__update()
public
__update() : mixed
Return values
mixed —addField()
Add the field to this filer instance.
public
addField(FieldBasic $fieldInstance, int $index) : $this
Parameters
- $fieldInstance : FieldBasic
- $index : int
Return values
$this —addRule()
Add rule to this filter instance.
public
addRule(array<string|int, mixed> $conditions) : $this
Parameters
- $conditions : array<string|int, mixed>
Tags
Return values
$this —delete()
Delete this instance.
public
delete() : mixed
Return values
mixed —deleteForModule()
Delete filter associated for module.
public
static deleteForModule(ModuleBasic $moduleInstance) : mixed
Parameters
- $moduleInstance : ModuleBasic
Return values
mixed —getAllForModule()
Get all instances of filter for the module.
public
static getAllForModule(ModuleBasic $moduleInstance) : self
Parameters
- $moduleInstance : ModuleBasic
Return values
self —getInstance()
Get instance by filterid or filtername.
public
static getInstance(mixed $value[, mixed $module = false ]) : mixed
Parameters
- $value : mixed
- $module : mixed = false
-
Mixed id or name of the module
Return values
mixed —initialize()
Initialize this filter instance.
public
initialize(mixed $valuemap[, mixed $module = false ]) : mixed
Parameters
- $valuemap : mixed
- $module : mixed = false
-
Mixed id or name of the module
Return values
mixed —save()
Save this instance.
public
save([mixed $moduleInstance = false ]) : mixed
Parameters
- $moduleInstance : mixed = false