Documentation

UkVatPayerStatusVerification extends Base
in package

VAT Payer Status Verification in United Kingdom record collector class.

Table of Contents

$allowedModules  : array<string|int, string>
$description  : string
$displayType  : string
$docUrl  : string
$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.

Properties

$allowedModules

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

Allowed modules.

$moduleName

public string $moduleName

Module name.

$settingsFields

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

Configuration field list.

$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 = ['vatNumber' => ['labelModule' => '_Base', 'label' => 'Vat ID', 'typeofdata' => 'V~M']]

$modulesFieldsMap

protected array<string|int, mixed> $modulesFieldsMap = ['Accounts' => ['vatNumber' => 'vat_id'], 'Leads' => ['vatNumber' => 'vat_id'], 'Vendors' => ['vatNumber' => 'vat_id'], 'Competition' => ['vatNumber' => 'vat_id'], 'Partners' => ['vatNumber' => 'vat_id']]

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.

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

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>

        

Search results