Documentation

Base
in package

Base record collector class.

Table of Contents

$displayType  : string
Search results display type.
$icon  : string
Icon.
$label  : string
Label.
$moduleName  : string
Module name.
$allowedModules  : array<string|int, string>
Allowed modules.
$fields  : array<string|int, mixed>
List of fields for the modal search window.
$modulesFieldsMap  : array<string|int, mixed>
Fields mapping for loading record data.
$request  : Request
Request instance.
__construct()  : mixed
Constructor.
getFields()  : Vtiger_Field_Model
Get fields for the modal search window.
isActive()  : bool
Check whether it is active.
search()  : array<string|int, mixed>
Search data function.
setRequest()  : void
Undocumented function.

Properties

$displayType

Search results display type.

public string $displayType

$icon

Icon.

public string $icon

$label

Label.

public string $label

$moduleName

Module name.

public string $moduleName

$allowedModules

Allowed modules.

protected static array<string|int, string> $allowedModules = []

$fields

List of fields for the modal search window.

protected array<string|int, mixed> $fields = []

$modulesFieldsMap

Fields mapping for loading record data.

protected array<string|int, mixed> $modulesFieldsMap = []

Methods

__construct()

Constructor.

public __construct() : mixed
Return values
mixed

getFields()

Get fields for the modal search window.

public getFields() : Vtiger_Field_Model
Return values
Vtiger_Field_Model

isActive()

Check whether it is active.

public isActive() : bool
Return values
bool

Search data function.

public search() : array<string|int, mixed>
Return values
array<string|int, mixed>

setRequest()

Undocumented function.

public setRequest(Request $request) : void
Parameters
$request : Request
Return values
void

        

Search results