Class CApiContactsmainDbStorage

AApiManagerStorage

CApiContactsmainStorage

CApiContactsmainDbStorage

Package: Contacts\Storages
Located at contactsmain/storages/db/storage.php

Methods summary

`public`	# `__construct( CApiGlobalManager & $oManager )` Parameters `$oManager` $oManager Overrides `CApiContactsmainStorage::__construct`
`public CContact\|boolean`	# `getContactById( integer $iUserId, mixed $mContactId, boolean $bIgnoreHideInGab = false, integer $iSharedTenantId = null, boolean $bIgnoreAutoCreate = false )` Parameters `$iUserId` `$mContactId` `$bIgnoreHideInGab` = false `$iSharedTenantId` = null `$bIgnoreAutoCreate` = false Returns CContact\|boolean Overrides `CApiContactsmainStorage::getContactById`
`public CContact\|boolean`	# `GetContactByTypeId( mixed $mTypeId, mixed $mContactId, boolean $bIgnoreHideInGab = false )` Parameters `$mTypeId` `$mContactId` `$bIgnoreHideInGab` = false Returns CContact\|boolean Overrides `CApiContactsmainStorage::GetContactByTypeId`
`public CContact\|boolean`	# `getContactByEmail( integer $iUserId, string $sEmail )` Parameters `$iUserId` `$sEmail` Returns CContact\|boolean Overrides `CApiContactsmainStorage::getContactByEmail`
`public CContact\|boolean`	# `getContactByStrId( integer $iUserId, string $sContactStrId, integer $iSharedTenantId = null )` Parameters `$iUserId` `$sContactStrId` `$iSharedTenantId` = null Returns CContact\|boolean Overrides `CApiContactsmainStorage::getContactByStrId`
`public array\|boolean`	# `getSharedContactIds( integer $iUserId, $iSharedTenantId )` Parameters `$iUserId` `$iSharedTenantId` Returns array\|boolean Overrides `CApiContactsmainStorage::getSharedContactIds`
`public array\|boolean`	# `getContactGroupsIds( CContact $oContact )` Parameters `$oContact` Returns array\|boolean Overrides `CApiContactsmainStorage::getContactGroupsIds`
`public CContact\|null`	# `GetMyGlobalContact( integer $iUserId )` Parameters `$iUserId` Returns CContact\|null Overrides `CApiContactsmainStorage::GetMyGlobalContact`
`protected CContact`	# `getContactBySql( string $sSql, integer $iUserId = null, integer $iSharedTenantId = null )` Parameters `$sSql` `$iUserId` = null `$iSharedTenantId` = null Returns CContact
`public CGroup`	# `getGroupById( integer $iUserId, mixed $mGroupId )` Parameters `$iUserId` `$mGroupId` Returns CGroup Overrides `CApiContactsmainStorage::getGroupById`
`public CGroup`	# `getGroupByStrId( integer $iUserId, string $sGroupStrId )` Parameters `$iUserId` `$sGroupStrId` Returns CGroup Overrides `CApiContactsmainStorage::getGroupByStrId`
`public CGroup`	# `getGroupByName( integer $iUserId, string $sName )` Parameters `$iUserId` `$sName` Returns CGroup Overrides `CApiContactsmainStorage::getGroupByName`
`protected CGroup`	# `getGroupBySql( string $sSql )` Parameters `$sSql` Returns CGroup
`protected`	# `updateContactGroupIds( CContact & $oContact )` Parameters `$oContact`
`public boolean\|array`	# `getContactItemsWithoutOrder( integer $iUserId, integer $iOffset, integer $iRequestLimit )` Parameters `$iUserId` `$iOffset` `$iRequestLimit` Returns boolean\|array Overrides `CApiContactsmainStorage::getContactItemsWithoutOrder`
`public boolean\|array`	# `getContactItems( integer $iUserId, integer $iSortField, integer $iSortOrder, integer $iOffset, integer $iRequestLimit, string $sSearch, string $sFirstCharacter, integer $iGroupId, integer $iSharedTenantId = null, boolean $bAll = false )` Parameters `$iUserId` `$iSortField` `$iSortOrder` `$iOffset` `$iRequestLimit` `$sSearch` `$sFirstCharacter` `$iGroupId` `$iSharedTenantId` = null `$bAll` = false Returns boolean\|array Overrides `CApiContactsmainStorage::getContactItems`
`public integer`	# `getContactItemsCount( integer $iUserId, string $sSearch, string $sFirstCharacter, integer $iGroupId, integer $iSharedTenantId = null, boolean $bAll = false )` Parameters `$iUserId` `$sSearch` `$sFirstCharacter` `$iGroupId` `$iSharedTenantId` = null `$bAll` = false Returns integer Overrides `CApiContactsmainStorage::getContactItemsCount`
`public boolean\|array`	# `getGroupItems( integer $iUserId, integer $iSortField, integer $iSortOrder, integer $iOffset, integer $iRequestLimit, string $sSearch, string $sFirstCharacter, integer $iContactId )` Parameters `$iUserId` `$iSortField` `$iSortOrder` `$iOffset` `$iRequestLimit` `$sSearch` `$sFirstCharacter` `$iContactId` Returns boolean\|array Overrides `CApiContactsmainStorage::getGroupItems`
`public integer`	# `getGroupItemsCount( integer $iUserId, string $sSearch, string $sFirstCharacter )` Parameters `$iUserId` `$sSearch` `$sFirstCharacter` Returns integer Overrides `CApiContactsmainStorage::getGroupItemsCount`
`public boolean\|array`	# `GetAllContactsNamesWithPhones( integer $iUserId, integer $iTenantId = 0, boolean $bAddGlobal = true )` Parameters `$iUserId` `$iTenantId` = 0 `$bAddGlobal` = true Returns boolean\|array Overrides `CApiContactsmainStorage::GetAllContactsNamesWithPhones`
`public boolean\|array`	# `GetSuggestContactItems( integer $iUserId, string $sSearch, integer $iRequestLimit, boolean $bPhoneOnly = false, integer $iSharedTenantId = null, boolean $bAll = false )` Parameters `$iUserId` `$sSearch` `$iRequestLimit` `$bPhoneOnly` = false `$iSharedTenantId` = null `$bAll` = false Returns boolean\|array Overrides `CApiContactsmainStorage::GetSuggestContactItems`
`public boolean\|array`	# `GetSuggestGroupItems( integer $iUserId, string $sSearch, integer $iRequestLimit, integer $iSharedTenantId = null )` Parameters `$iUserId` `$sSearch` `$iRequestLimit` `$iSharedTenantId` = null Returns boolean\|array Overrides `CApiContactsmainStorage::GetSuggestGroupItems`
`public boolean`	# `updateContact( CContact $oContact )` Parameters `$oContact` Returns boolean Overrides `CApiContactsmainStorage::updateContact`
`public string`	# `updateContactUserId( CContact $oContact, integer $iUserId )` Parameters `$oContact` `$iUserId` Returns string Overrides `CApiContactsmainStorage::updateContactUserId`
`public boolean`	# `updateGroup( CGroup $oGroup )` Parameters `$oGroup` Returns boolean Overrides `CApiContactsmainStorage::updateGroup`
`public boolean`	# `createContact( CContact $oContact )` Parameters `$oContact` Returns boolean Overrides `CApiContactsmainStorage::createContact`
`public boolean`	# `createGroup( CGroup $oGroup )` Parameters `$oGroup` Returns boolean Overrides `CApiContactsmainStorage::createGroup`
`public boolean`	# `deleteContacts( integer $iUserId, array $aContactsIds, integer $iSharedTenantId = null )` Parameters `$iUserId` `$aContactsIds` `$iSharedTenantId` = null Returns boolean Overrides `CApiContactsmainStorage::deleteContacts`
`public boolean`	# `resetContactFrequency( integer $iUserId, string $sContactId )` Parameters `$iUserId` `$sContactId` Returns boolean
`public boolean`	# `deleteSuggestContacts( integer $iUserId, array $aContactsIds )` Parameters `$iUserId` `$aContactsIds` Returns boolean Overrides `CApiContactsmainStorage::deleteSuggestContacts`
`public boolean`	# `deleteGroups( integer $iUserId, array $aGroupsIds )` Parameters `$iUserId` `$aGroupsIds` Returns boolean Overrides `CApiContactsmainStorage::deleteGroups`
`public boolean`	# `deleteGroup( integer $iUserId, mixed $mGroupsId )` Parameters `$iUserId` `$mGroupsId` Returns boolean
`public boolean`	# `updateSuggestTable( integer $iUserId, array $aEmails )` Parameters `$iUserId` `$aEmails` Returns boolean Overrides `CApiContactsmainStorage::updateSuggestTable`
`public boolean`	# `clearAllContactsAndGroups( CAccount $oAccount )` Parameters `$oAccount` Returns boolean Overrides `CApiContactsmainStorage::clearAllContactsAndGroups`
`public boolean`	# `flushContacts( )` Returns boolean Overrides `CApiContactsmainStorage::flushContacts`
`public boolean`	# `addContactsToGroup( CGroup $oGroup, array $aContactIds )` Parameters `$oGroup` `$aContactIds` Returns boolean Overrides `CApiContactsmainStorage::addContactsToGroup`
`public boolean`	# `removeContactsFromGroup( CGroup $oGroup, array $aContactIds )` Parameters `$oGroup` `$aContactIds` Returns boolean
`public integer\|null`	# `ConvertedContactLocalId( CAccount $oAccount, mixed $mContactId, integer $iContactType )` Parameters `$oAccount` `$mContactId` `$iContactType` = EContactType::Global_ Returns integer\|null
`public array`	# `ConvertedContactLocalIdCollection( CAccount $oAccount, integer $iContactType = EContactType::Global_ )` Parameters `$oAccount` `$iContactType` = EContactType::Global_ Returns array
`public array`	# `ContactIdsLinkedToGroups( array $aIds )` Parameters `$aIds` Returns array
`public CContact`	# `GetGlobalContactById( integer $iUserId, mixed $mContactId )` Parameters `$iUserId` `$mContactId` Returns CContact \| false Overrides `CApiContactsmainStorage::GetGlobalContactById`
`public boolean`	# `getGroupEvents( integer $iGroupId )` Parameters `$iGroupId` Returns boolean
`public boolean`	# `getGroupEvent( string $sCalendarId, string $sEventId )` Parameters `$sCalendarId` `$sEventId` Returns boolean
`public boolean`	# `addEventToGroup( integer $iGroupId, string $sCalendarId, string $sEventId )` Parameters `$iGroupId` `$sCalendarId` `$sEventId` Returns boolean
`public boolean`	# `removeEventFromGroup( integer $iGroupId, string $sCalendarId, string $sEventId )` Parameters `$iGroupId` `$sCalendarId` `$sEventId` Returns boolean
`public boolean`	# `removeEventFromAllGroups( string $sCalendarId, string $sEventId )` Parameters `$sCalendarId` `$sEventId` Returns boolean

Properties summary

`protected CDbStorage`	`$oConnection` $oConnection $oConnection	#
`protected CApiContactsmainCommandCreator`	`$oCommandCreator`	#

Packages

Classes

Class CApiContactsmainDbStorage

Methods summary

Parameters

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides