Documentation

PlKrs extends Base
in package

Polish National Court Register record collector 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>
$url  : 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.
convertPkd()  : void
Convert PKD value.
getDataFromApi()  : void
Function fetching from Polish National Court Register API.
parseData()  : void
Function parsing data to fields from Polish National Court Register API.

Properties

$allowedModules

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

Allowed modules.

$description

public string $description = 'LBL_PL_KRS_DESC'

Additional description, visible in the modal window.

$displayType

public string $displayType = 'FillFields'

Search results display type.

$docUrl

public string $docUrl = 'https://prs.ms.gov.pl/krs/openApi'

Url to Documentation API

$formFieldsToRecordMap

{@inheritdoc}

public mixed $formFieldsToRecordMap = ['Accounts' => ['daneDzial1DanePodmiotuNazwa' => 'accountname', 'daneDzial1DanePodmiotuIdentyfikatoryRegon' => 'registration_number_2', 'naglowekANumerKRS' => 'registration_number_1', 'daneDzial1DanePodmiotuIdentyfikatoryNip' => 'vat_id', 'daneDzial1SiedzibaIAdresAdresStronyInternetowej' => 'website', 'Annual revenue' => 'annual_revenue', 'daneDzial3PrzedmiotDzialalnosciPrzedmiotPrzewazajacejDzialalnosci0' => 'siccode', 'daneDzial3PrzedmiotDzialalnosciPrzedmiotPozostalejDzialalnosci0' => 'siccode', 'daneDzial1SiedzibaIAdresAdresNrDomu' => 'buildingnumbera', 'daneDzial1SiedzibaIAdresAdresUlica' => 'addresslevel8a', 'daneDzial1SiedzibaIAdresAdresKodPocztowy' => 'addresslevel7a', 'dane_dzial1_siedzibaIAdres_siedziba_miejscowosc' => 'addresslevel5a', 'dane_dzial1_siedzibaIAdres_adres_miejscowosc' => 'addresslevel5a', 'daneDzial1SiedzibaIAdresSiedzibaGmina' => 'addresslevel4a', 'daneDzial1SiedzibaIAdresSiedzibaPowiat' => 'addresslevel3a', 'daneDzial1SiedzibaIAdresSiedzibaWojewodztwo' => 'addresslevel2a', 'daneDzial1SiedzibaIAdresSiedzibaKraj' => 'addresslevel1a', 'daneDzial1SiedzibaIAdresAdresKraj' => 'addresslevel1a'], 'Leads' => ['daneDzial1DanePodmiotuNazwa' => 'company', 'daneDzial1DanePodmiotuIdentyfikatoryRegon' => 'registration_number_2', 'naglowekANumerKRS' => 'registration_number_1', 'daneDzial1DanePodmiotuIdentyfikatoryNip' => 'vat_id', 'Annual revenue' => 'annualrevenue', 'daneDzial1SiedzibaIAdresAdresStronyInternetowej' => 'website', 'daneDzial1SiedzibaIAdresAdresUlica' => 'addresslevel8a', 'daneDzial1SiedzibaIAdresAdresKodPocztowy' => 'addresslevel7a', 'dane_dzial1_siedzibaIAdres_siedziba_miejscowosc' => 'addresslevel5a', 'dane_dzial1_siedzibaIAdres_adres_miejscowosc' => 'addresslevel5a', 'daneDzial1SiedzibaIAdresSiedzibaGmina' => 'addresslevel4a', 'daneDzial1SiedzibaIAdresSiedzibaPowiat' => 'addresslevel3a', 'daneDzial1SiedzibaIAdresSiedzibaWojewodztwo' => 'addresslevel2a', 'daneDzial1SiedzibaIAdresSiedzibaKraj' => 'addresslevel1a', 'daneDzial1SiedzibaIAdresAdresKraj' => 'addresslevel1a'], 'Vendors' => ['daneDzial1DanePodmiotuNazwa' => 'vendorname', 'daneDzial1DanePodmiotuIdentyfikatoryRegon' => 'registration_number_2', 'naglowekANumerKRS' => 'registration_number_1', 'daneDzial1DanePodmiotuIdentyfikatoryNip' => 'vat_id', 'daneDzial1SiedzibaIAdresAdresStronyInternetowej' => 'website', 'daneDzial1SiedzibaIAdresAdresUlica' => 'addresslevel8a', 'daneDzial1SiedzibaIAdresAdresKodPocztowy' => 'addresslevel7a', 'dane_dzial1_siedzibaIAdres_siedziba_miejscowosc' => 'addresslevel5a', 'dane_dzial1_siedzibaIAdres_adres_miejscowosc' => 'addresslevel5a', 'daneDzial1SiedzibaIAdresSiedzibaGmina' => 'addresslevel4a', 'daneDzial1SiedzibaIAdresSiedzibaPowiat' => 'addresslevel3a', 'daneDzial1SiedzibaIAdresSiedzibaWojewodztwo' => 'addresslevel2a', 'daneDzial1SiedzibaIAdresSiedzibaKraj' => 'addresslevel1a', 'daneDzial1SiedzibaIAdresAdresKraj' => 'addresslevel1a']]

$icon

public string $icon = 'yfi-krs-pl'

Icon.

$label

public string $label = 'LBL_PL_KRS'

Label.

$moduleName

public string $moduleName

Module name.

$settingsFields

public array<string|int, mixed> $settingsFields = []

Configuration field list.

$addOnName

protected string $addOnName = 'YetiForceRcPlKrs'

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 = ['ncr' => ['labelModule' => '_Base', 'label' => 'Registration number 1', 'typeofdata' => 'V~M']]

$modulesFieldsMap

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

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.

$url

protected string $url = 'https://api-krs.ms.gov.pl/api/krs/OdpisAktualny/'

KRS sever address

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> —

convertPkd()

Convert PKD value.

private convertPkd(array<string|int, mixed> &$pkd) : void
Parameters
$pkd : array<string|int, mixed>
Return values
void —

getDataFromApi()

Function fetching from Polish National Court Register API.

private getDataFromApi(mixed $ncr) : void
Parameters
$ncr : mixed
Return values
void —

parseData()

Function parsing data to fields from Polish National Court Register API.

private parseData() : void
Return values
void — 

        

        
    




    

    

                

    

        

            
Search results