Documentation

API_CardDAV_Model
in package

Api CardDAV Model Class.

Tags
copyright

YetiForce S.A.

license

YetiForce Public License 6.5 (licenses/LicenseEN.txt or yetiforce.com)

author

Mariusz Krzaczkowski m.krzaczkowski@yetiforce.com

Table of Contents

ADDRESSBOOK_NAME  = 'YFAddressBook'
PRODID  = 'YetiForceCRM'
$addressBookId  : mixed
$davUsers  : array<string|int, Users_Record_Model>
$mailFields  : mixed
$pdo  : mixed
$telFields  : mixed
$user  : bool|Users_Record_Model
$cache  : mixed
$crmRecords  : mixed
__construct()  : mixed
cleanForUpdate()  : Component
Clean for update.
createCard()  : mixed
createRecord()  : void
Create record.
crm2Dav()  : string
Sync from CRM to DAV.
dav2Crm()  : int
Sync from DAV to CRM.
deletedCard()  : mixed
getCardDetail()  : mixed
getCrmRecordsToSync()  : mixed
getDavCardsToSync()  : mixed
setCardAddres()  : Component
Set card addres.
syncAddressBooks()  : int
Sync from DAV to CRM for one user.
syncCrmRecord()  : string
Sync from CRM to DAV for one module.
updateCard()  : mixed
updateRecord()  : mixed
Update record.
markComplete()  : mixed
updateIdAndModifiedTime()  : void
Update ID and modified time.

Constants

ADDRESSBOOK_NAME

public mixed ADDRESSBOOK_NAME = 'YFAddressBook'

PRODID

public mixed PRODID = 'YetiForceCRM'

Properties

$addressBookId

public mixed $addressBookId = \false

$davUsers

public array<string|int, Users_Record_Model> $davUsers = []

$mailFields

public mixed $mailFields = ['Contacts' => ['email' => 'WORK', 'secondary_email' => 'HOME'], 'OSSEmployees' => ['business_mail' => 'WORK', 'private_mail' => 'HOME']]

$telFields

public mixed $telFields = ['Contacts' => ['phone' => 'WORK', 'mobile' => 'CELL'], 'OSSEmployees' => ['business_phone' => 'WORK', 'private_phone' => 'CELL']]

$user

public bool|Users_Record_Model $user = \false

$cache

protected static mixed $cache = []

$crmRecords

protected mixed $crmRecords = []

Methods

__construct()

public __construct() : mixed
Return values
mixed

cleanForUpdate()

Clean for update.

public cleanForUpdate(Component $vcard) : Component
Parameters
$vcard : Component
Return values
Component

createCard()

public createCard(mixed $moduleName, mixed $record) : mixed
Parameters
$moduleName : mixed
$record : mixed
Return values
mixed

createRecord()

Create record.

public createRecord(string $moduleName, array<string|int, mixed> $card) : void
Parameters
$moduleName : string
$card : array<string|int, mixed>
Return values
void

crm2Dav()

Sync from CRM to DAV.

public crm2Dav() : string
Return values
string

dav2Crm()

Sync from DAV to CRM.

public dav2Crm() : int
Return values
int

deletedCard()

public deletedCard(mixed $card) : mixed
Parameters
$card : mixed
Return values
mixed

getCardDetail()

public getCardDetail(mixed $crmid) : mixed
Parameters
$crmid : mixed
Return values
mixed

getCrmRecordsToSync()

public getCrmRecordsToSync(mixed $moduleName) : mixed
Parameters
$moduleName : mixed
Return values
mixed

getDavCardsToSync()

public getDavCardsToSync() : mixed
Return values
mixed

setCardAddres()

Set card addres.

public setCardAddres(Component $vcard, string $moduleName, array<string|int, mixed> $record) : Component
Parameters
$vcard : Component
$moduleName : string
$record : array<string|int, mixed>
Return values
Component

syncAddressBooks()

Sync from DAV to CRM for one user.

public syncAddressBooks() : int
Return values
int

syncCrmRecord()

Sync from CRM to DAV for one module.

public syncCrmRecord(mixed $moduleName) : string
Parameters
$moduleName : mixed
Return values
string

updateCard()

public updateCard(mixed $moduleName, mixed $record, mixed $card) : mixed
Parameters
$moduleName : mixed
$record : mixed
$card : mixed
Return values
mixed

markComplete()

protected markComplete(mixed $moduleName, mixed $crmid) : mixed
Parameters
$moduleName : mixed
$crmid : mixed
Return values
mixed

updateIdAndModifiedTime()

Update ID and modified time.

protected updateIdAndModifiedTime(Vtiger_Record_Model $record, array<string|int, mixed> $card) : void
Parameters
$record : Vtiger_Record_Model
$card : array<string|int, mixed>
Return values
void

        

Search results