Documentation

Wapro
in package

WAPRO ERP main integration class.

Table of Contents

LOG_TABLE_NAME  = 'l_#__wapro'
RECORDS_MAP_TABLE_NAME  = 'u_#__wapro_records_map'
TABLE_NAME  = 'i_#__wapro'
$config  : array<string|int, mixed>
$cron  : CronHandler
$customConfig  : array<string|int, mixed>
$db  : Db
__construct()  : mixed
Wapro instance constructor.
connectToDatabase()  : Db
Connect to WAPRO ERP SQL Server through PDO.
getAllSynchronizers()  : array<string|int, Synchronizer>
Get synchronizers.
getById()  : array<string|int, mixed>
Get WAPRO ERP configuration by id.
getDb()  : Db
Database connection instance.
getInfo()  : string
Get information about WAPRO ERP.
getSynchronizer()  : Synchronizer|null
Get synchronizer by name.
getSynchronizers()  : array<string|int, Synchronizer>
Get synchronizers.
verifyDatabaseAccess()  : array<string|int, mixed>
Verify access to the WAPRO ERP system database.

Constants

LOG_TABLE_NAME

public string LOG_TABLE_NAME = 'l_#__wapro'

Basic table name

RECORDS_MAP_TABLE_NAME

public string RECORDS_MAP_TABLE_NAME = 'u_#__wapro_records_map'

Map relation table name

TABLE_NAME

public string TABLE_NAME = 'i_#__wapro'

Basic table name

Properties

$config

public array<string|int, mixed> $config

Database config.

$cron

public CronHandler $cron

The cron task object available when the timing is called by CRON.

$customConfig

public array<string|int, mixed> $customConfig

Custom configuration, enables extension of mappings for synchronization.

Methods

__construct()

Wapro instance constructor.

public __construct(int $serverId[, CronHandler|null $cron = null ]) : mixed
Parameters
$serverId : int
$cron : CronHandler|null = null
Return values
mixed —

connectToDatabase()

Connect to WAPRO ERP SQL Server through PDO.

public static connectToDatabase(string $server, string $database, string $user, string $password, int $port) : Db
Parameters
$server : string
$database : string
$user : string
$password : string
$port : int
Return values
Db —

getAllSynchronizers()

Get synchronizers.

public getAllSynchronizers() : array<string|int, Synchronizer>
Return values
array<string|int, Synchronizer> —

getById()

Get WAPRO ERP configuration by id.

public static getById(int $id) : array<string|int, mixed>
Parameters
$id : int
Return values
array<string|int, mixed> —

getDb()

Database connection instance.

public getDb() : Db
Return values
Db —

getInfo()

Get information about WAPRO ERP.

public getInfo() : string
Return values
string —

getSynchronizer()

Get synchronizer by name.

public getSynchronizer(string $name) : Synchronizer|null
Parameters
$name : string
Return values
Synchronizer|null —

getSynchronizers()

Get synchronizers.

public getSynchronizers() : array<string|int, Synchronizer>
Return values
array<string|int, Synchronizer> —

verifyDatabaseAccess()

Verify access to the WAPRO ERP system database.

public static verifyDatabaseAccess(string $server, string $database, string $user, string $password, int $port) : array<string|int, mixed>
Parameters
$server : string
$database : string
$user : string
$password : string
$port : int
Return values
array<string|int, mixed> — 

        

        
    




    

    

                

    

        

            
Search results