Documentation

Gus extends Base
in package

Gus record collector class.

Table of Contents

$allowedModules  : array<string|int, string>
Allowed modules.
$displayType  : string
Search results display type.
$formFieldsToRecordMap  : mixed
{@inheritdoc}
$icon  : string
Icon.
$label  : string
Label.
$moduleName  : string
Module name.
$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.
getParams()  : array<string|int, string>
Get params.
isActive()  : bool
Check whether it is active.
search()  : array<string|int, mixed>
Search data function.
setRequest()  : void
Undocumented function.

Properties

$allowedModules

Allowed modules.

public static array<string|int, string> $allowedModules = ['Accounts', 'Leads', 'Vendors', 'Competition']

$displayType

Search results display type.

public string $displayType = 'FillFields'

$formFieldsToRecordMap

{@inheritdoc}

public mixed $formFieldsToRecordMap = ['Accounts' => ['Nazwa' => 'accountname', 'SzczegolnaFormaPrawnaNazwa' => 'legal_form', 'Regon' => 'registration_number_2', 'Krs' => 'registration_number_1', 'Nip' => 'vat_id', 'Wojewodztwo' => 'addresslevel2a', 'Powiat' => 'addresslevel3a', 'Gmina' => 'addresslevel4a', 'Miejscowosc' => 'addresslevel5a', 'KodPocztowy' => 'addresslevel7a', 'Ulica' => 'addresslevel8a', 'NumerBudynku' => 'buildingnumbera', 'NumerLokalu' => 'localnumbera', 'Kraj' => 'addresslevel1a', 'NumerTelefonu' => 'phone', 'NumerFaksu' => 'fax', 'AdresEmail' => 'email1', 'AdresStronyInternetowej' => 'website'], 'Leads' => ['Nazwa' => 'company', 'SzczegolnaFormaPrawnaNazwa' => 'legal_form', 'Regon' => 'registration_number_2', 'Wojewodztwo' => 'addresslevel2a', 'Powiat' => 'addresslevel3a', 'Gmina' => 'addresslevel4a', 'Miejscowosc' => 'addresslevel5a', 'KodPocztowy' => 'addresslevel7a', 'Ulica' => 'addresslevel8a', 'NumerBudynku' => 'buildingnumbera', 'NumerTelefonu' => 'phone', 'NumerFaksu' => 'fax', 'AdresEmail' => 'email', 'AdresStronyInternetowej' => 'website'], 'Partners' => ['Nazwa' => 'subject', 'Wojewodztwo' => 'addresslevel2a', 'Powiat' => 'addresslevel3a', 'Gmina' => 'addresslevel4a', 'Miejscowosc' => 'addresslevel5a', 'KodPocztowy' => 'addresslevel7a', 'Ulica' => 'addresslevel8a', 'NumerBudynku' => 'buildingnumbera'], 'Vendors' => ['Nazwa' => 'vendorname', 'Regon' => 'registration_number_2', 'Wojewodztwo' => 'addresslevel2a', 'Powiat' => 'addresslevel3a', 'Gmina' => 'addresslevel4a', 'Miejscowosc' => 'addresslevel5a', 'KodPocztowy' => 'addresslevel7a', 'Ulica' => 'addresslevel8a', 'NumerBudynku' => 'buildingnumbera'], 'Competition' => ['Nazwa' => 'subject', 'Wojewodztwo' => 'addresslevel2a', 'Powiat' => 'addresslevel3a', 'Gmina' => 'addresslevel4a', 'Miejscowosc' => 'addresslevel5a', 'KodPocztowy' => 'addresslevel7a', 'Ulica' => 'addresslevel8a', 'NumerBudynku' => 'buildingnumbera']]

$icon

Icon.

public string $icon = 'yfi yfi-gus'

$label

Label.

public string $label = 'GUS'

$moduleName

Module name.

public string $moduleName

$fields

List of fields for the modal search window.

protected array<string|int, mixed> $fields = ['vatId' => ['labelModule' => '_Base', 'label' => 'Vat ID'], 'ncr' => ['labelModule' => '_Base', 'label' => 'Registration number 1'], 'taxNumber' => ['labelModule' => '_Base', 'label' => 'Registration number 2']]

$modulesFieldsMap

Fields mapping for loading record data.

protected array<string|int, mixed> $modulesFieldsMap = ['Accounts' => ['vatId' => 'vat_id', 'taxNumber' => 'registration_number_2', 'ncr' => 'registration_number_1'], 'Leads' => ['vatId' => 'vat_id', 'taxNumber' => 'registration_number_2', 'ncr' => 'registration_number_1'], 'Vendors' => ['vatId' => 'vat_id', 'taxNumber' => 'registration_number_2', 'ncr' => 'registration_number_1'], 'Competition' => ['vatId' => 'vat_id', 'taxNumber' => 'registration_number_2', 'ncr' => 'registration_number_1']]

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

getParams()

Get params.

public getParams(string $moduleName) : array<string|int, string>
Parameters
$moduleName : string
Return values
array<string|int, string>

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