Documentation

ChZefix extends Base
in package

Zefix Swiss Central Business Name Index API class.

Table of Contents

$allowedModules  : array<string|int, string>
$description  : string
$displayType  : string
$docUrl  : string
$formFieldsToRecordMap  : mixed
{@inheritdoc}
$icon  : string
$label  : string
$moduleName  : string
$settingsFields  : array<string|int, mixed>
$addOnName  : string
$data  : array<string|int, mixed>
$fields  : mixed
var array List of fields for the modal search window.
$modulesFieldsMap  : array<string|int, mixed>
$name  : string
$paid  : bool
$request  : Request
$response  : array<string|int, mixed>
$password  : string
$url  : mixed
{@inheritdoc}
$username  : string
__construct()  : mixed
Constructor.
getFields()  : array<string|int, Vtiger_Field_Model>
Get fields for the modal search window.
getFieldsLabelsByModule()  : array<string|int, string>
Get fields labels for the module name.
getFieldsModule()  : array<string|int, string>
Get fields for the module name.
getName()  : string
Get record collector name.
isActive()  : bool
Check whether it is active.
isAvailable()  : bool
Check if product is available.
loadData()  : void
Load data.
search()  : array<string|int, mixed>
Search data function.
setRequest()  : void
Set request.
getParams()  : array<string|int, mixed>
Get params of collector.
getCompaniesByName()  : void
Function fetching companies data by company name.
getCompanyById()  : void
Function fetching company data by Company ID.
loadCredentials()  : void
Function setup Credentials.
parseData()  : array<string|int, mixed>
Function parsing data to fields from API.

Properties

$allowedModules

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

Allowed modules.

$description

public string $description = 'LBL_CH_ZEFIX_DESC'

Additional description, visible in the modal window.

$displayType

public string $displayType = 'FillFields'

Search results display type.

$docUrl

public string $docUrl = 'https://www.zefix.admin.ch/'

Url to Documentation API

$formFieldsToRecordMap

{@inheritdoc}

public mixed $formFieldsToRecordMap = ['Accounts' => ['name' => 'accountname', 'translation1' => 'accountname', 'uid' => 'registration_number_1', 'capitalNominal' => 'annual_revenue', 'addressHouseNumber' => 'buildingnumbera', 'addressAddon' => 'localnumbera', 'addressStreet' => 'addresslevel8a', 'addressPoBox' => 'poboxa', 'addressSwissZipCode' => 'addresslevel7a', 'addressCity' => 'addresslevel5a', 'canton' => 'addresslevel2a', 'country' => 'addresslevel1a', 'purpose' => 'description'], 'Leads' => ['name' => 'company', 'translation1' => 'company', 'uid' => 'registration_number_1', 'addressHouseNumber' => 'buildingnumbera', 'addressAddon' => 'localnumbera', 'addressStreet' => 'addresslevel8a', 'addressPoBox' => 'poboxa', 'addressSwissZipCode' => 'addresslevel7a', 'addressCity' => 'addresslevel5a', 'canton' => 'addresslevel2a', 'country' => 'addresslevel1a', 'purpose' => 'description'], 'Partners' => ['name' => 'subject', 'translation1' => 'subject', 'addressHouseNumber' => 'buildingnumbera', 'addressAddon' => 'localnumbera', 'addressStreet' => 'addresslevel8a', 'addressPoBox' => 'poboxa', 'addressSwissZipCode' => 'addresslevel7a', 'addressCity' => 'addresslevel5a', 'canton' => 'addresslevel2a', 'country' => 'addresslevel1a', 'purpose' => 'description'], 'Vendors' => ['name' => 'vendorname', 'translation1' => 'vendorname', 'uid' => 'registration_number_1', 'addressHouseNumber' => 'buildingnumbera', 'addressAddon' => 'localnumbera', 'addressStreet' => 'addresslevel8a', 'addressPoBox' => 'poboxa', 'addressSwissZipCode' => 'addresslevel7a', 'addressCity' => 'addresslevel5a', 'canton' => 'addresslevel2a', 'country' => 'addresslevel1a', 'purpose' => 'description'], 'Competition' => ['name' => 'subject', 'translation1' => 'subject', 'addressHouseNumber' => 'buildingnumbera', 'addressAddon' => 'localnumbera', 'addressStreet' => 'addresslevel8a', 'addressPoBox' => 'poboxa', 'addressSwissZipCode' => 'addresslevel7a', 'addressCity' => 'addresslevel5a', 'canton' => 'addresslevel2a', 'country' => 'addresslevel1a', 'purpose' => 'description']]

$icon

public string $icon = 'yfi-zefix-ch'

Icon.

$label

public string $label = 'LBL_CH_ZEFIX'

Label.

$moduleName

public string $moduleName

Module name.

$settingsFields

public array<string|int, mixed> $settingsFields = ['username' => ['required' => 1, 'purifyType' => 'Text', 'label' => 'Username'], 'password' => ['required' => 1, 'purifyType' => 'Text', 'label' => 'Password']]

Configuration field list.

$addOnName

protected string $addOnName = 'YetiForceRcChZefix'

The name of Add-on.

$data

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

Data from record collector source.

$fields

var array List of fields for the modal search window.

protected mixed $fields = ['companyName' => ['labelModule' => '_Base', 'label' => 'Account name'], 'companyId' => ['labelModule' => '_Base', 'label' => 'Registration number 1']]

$modulesFieldsMap

protected array<string|int, mixed> $modulesFieldsMap = ['Accounts' => ['companyId' => 'registration_number_1', 'companyName' => 'accountname'], 'Leads' => ['companyId' => 'registration_number_1', 'companyName' => 'company'], 'Vendors' => ['companyId' => 'registration_number_1', 'companyName' => 'vendorname'], 'Competition' => ['companyId' => 'registration_number_1', 'companyName' => 'subject']]

Fields mapping for loading record data.

$name

protected string $name

Record collector name.

$paid

protected bool $paid = true

Requires subscription.

$response

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

Response data.

$password

private string $password

Password.

$url

{@inheritdoc}

private mixed $url = 'https://www.zefix.admin.ch/ZefixPublicREST/api/v1/company/'

$username

private string $username

Username.

Methods

__construct()

Constructor.

public __construct() : mixed
Return values
mixed —

getFields()

Get fields for the modal search window.

public getFields() : array<string|int, Vtiger_Field_Model>
Return values
array<string|int, Vtiger_Field_Model> —

getFieldsLabelsByModule()

Get fields labels for the module name.

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

getFieldsModule()

Get fields for the module name.

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

getName()

Get record collector name.

public getName() : string
Return values
string —

isActive()

Check whether it is active.

public isActive() : bool
Return values
bool —

isAvailable()

Check if product is available.

public isAvailable() : bool
Return values
bool —

loadData()

Load data.

public loadData() : void
Return values
void —

search()

Search data function.

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

setRequest()

Set request.

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

getParams()

Get params of collector.

protected getParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getCompaniesByName()

Function fetching companies data by company name.

private getCompaniesByName(string $companyName) : void
Parameters
$companyName : string
Return values
void —

getCompanyById()

Function fetching company data by Company ID.

private getCompanyById(string $companyId) : void
Parameters
$companyId : string
Return values
void —

loadCredentials()

Function setup Credentials.

private loadCredentials() : void
Return values
void —

parseData()

Function parsing data to fields from API.

private parseData(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
Return values
array<string|int, mixed> — 

        

        
    




    

    

                

    

        

            
Search results