AfterLogic API Documentation
  • Package
  • Class

Packages

  • Calendar
    • Classes
    • Storages
  • Capability
  • Channels
    • Classes
    • Storages
  • Collaboration
  • Contacts
    • Helpers
    • Storages
  • Dav
  • Db
    • Classes
    • Enum
    • Storages
  • Domains
    • Classes
    • Storages
  • Fetchers
    • Classes
    • Storages
  • Filecache
    • Storages
  • Filestorage
    • Classes
    • Storages
  • GContacts
    • Storages
  • Helpdesk
    • Classes
    • Enum
    • Storages
  • Integrator
  • IOS
  • Logger
  • Mail
    • Classes
    • Enum
    • Storages
  • Mailsuite
    • Classes
    • Storages
  • Min
    • Storages
  • Sieve
    • Classes
    • Enum
  • Social
    • Classes
    • Storages
  • Subscription
    • Classes
  • Subscriptions
    • Storages
  • Tenants
    • Classes
    • Storages
  • Twofactorauth
    • Classes
    • Storages
  • Users
    • Classes
    • Enum
    • Storages
  • Voice
  • WebMail
    • Storages

Classes

  • CApiContactsmainCarddavStorage
  • CApiContactsmainCommandCreatorMySQL
  • CApiContactsmainCommandCreatorPostgreSQL
  • CApiContactsmainDbStorage
  • CApiContactsmainLdapStorage
  • CApiContactsmainNodbStorage
  • CApiContactsmainSabredavStorage

Class CApiContactsmainCarddavStorage

AApiManagerStorage
Extended by CApiContactsmainStorage
Extended by CApiContactsmainCarddavStorage
Package: Contacts\Storages
Located at contactsmain/storages/carddav/storage.php

Methods summary

public
# __construct( CApiGlobalManager & $oManager )

Parameters

$oManager
$oManager

Overrides

CApiContactsmainStorage::__construct
public
# InitByAccount( CAccount $oAccount )

Parameters

$oAccount
public
# init( integer $iUserId )

}

}

Parameters

$iUserId
protected boolean|array
# getItems( integer $iUserId, string $sAddressBook, string $sSearch = '', string $sFirstCharacter = '', integer $sGroupId = null )

Parameters

$iUserId
$sAddressBook
$sSearch
$sFirstCharacter
= ''
$sGroupId

Returns

boolean|array
protected boolean
# getItem( integer $iUserId, string $sAddressBook, string $sId )

Parameters

$iUserId
$sAddressBook
$sId

Returns

boolean
| \Sabre\DAV\Card
public
# ___qSortCallback( $a, $b )
protected
# sortItems( array & $aItems, integer $iSortField, integer $iSortOrder )

Parameters

$aItems
$iSortField
$iSortOrder
protected boolean|array
# getGroupItemsWithoutOrder( integer $iUserId, string $sSearch = '', string $sFirstCharacter = '', string $sContactId = '' )

Parameters

$iUserId
$sSearch
$sFirstCharacter
$sContactId

Returns

boolean|array
protected boolean
# deleteContactsByAddressBook( integer $iUserId, array $aContactsIds, string $sAddressBook )

Parameters

$iUserId
$aContactsIds
$sAddressBook

Returns

boolean
protected
# searchContactItemsByEmail( $sUserId, $sEmail, $sAddressBook )
public CContact
# getContactById( integer $iUserId, mixed $mContactId )

Parameters

$iUserId
$mContactId

Returns

CContact
| false

Overrides

CApiContactsmainStorage::getContactById
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 )

Parameters

$iUserId
$sContactStrId

Returns

CContact|boolean

Overrides

CApiContactsmainStorage::getContactByStrId
public array|boolean
# getContactGroupsIds( CContact $oContact )

Parameters

$oContact

Returns

array|boolean

Overrides

CApiContactsmainStorage::getContactGroupsIds
public array|boolean
# GetGroupContactsIds( integer $iUserId, mixed $mGroupId )

Parameters

$iUserId
$mGroupId

Returns

array|boolean
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 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 $iTenantId = null, $bAll = false )

Parameters

$iUserId
$iSortField
$iSortOrder
$iOffset
$iRequestLimit
$sSearch
$sFirstCharacter
$iGroupId
$iTenantId
$bAll

Returns

boolean|array

Overrides

CApiContactsmainStorage::getContactItems
public integer
# getContactItemsCount( integer $iUserId, string $sSearch, string $sFirstCharacter, integer $iGroupId, integer $iTenantId = null, $bAll = false )

Parameters

$iUserId
$sSearch
$sFirstCharacter
$iGroupId
$iTenantId
$bAll

Returns

integer

Overrides

CApiContactsmainStorage::getContactItemsCount
public boolean|array
# getGroupItems( integer $iUserId, integer $iSortField, integer $iSortOrder, integer $iOffset, integer $iRequestLimit, string $sSearch, string $sFirstCharacter, string $sContactId )

Parameters

$iUserId
$iSortField
$iSortOrder
$iOffset
$iRequestLimit
$sSearch
$sFirstCharacter
$sContactId

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
# GetSuggestContactItems( integer $iUserId, string $sSearch, integer $iRequestLimit )

Parameters

$iUserId
$sSearch
$iRequestLimit

Returns

boolean|array

Overrides

CApiContactsmainStorage::GetSuggestContactItems
public boolean
# updateContact( CContact $oContact )

Parameters

$oContact

Returns

boolean

Overrides

CApiContactsmainStorage::updateContact
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 )

Parameters

$iUserId
$aContactsIds

Returns

boolean

Overrides

CApiContactsmainStorage::deleteContacts
public boolean
# deleteGroups( integer $iUserId, array $aGroupsIds )

Parameters

$iUserId
$aGroupsIds

Returns

boolean

Overrides

CApiContactsmainStorage::deleteGroups
public boolean
# updateSuggestTable( integer $iUserId, string $aEmails )

Parameters

$iUserId
$aEmails
$sEmail

Returns

boolean

Overrides

CApiContactsmainStorage::updateSuggestTable
public boolean
# DeleteContactsExceptIds( integer $iUserId, array $aContactIds )

Parameters

$iUserId
$aContactIds

Returns

boolean
public boolean
# DeleteGroupsExceptIds( integer $iUserId, array $aGroupIds )

Parameters

$iUserId
$aGroupIds

Returns

boolean
public boolean
# flushContacts( )

Returns

boolean

Overrides

CApiContactsmainStorage::flushContacts

Methods inherited from CApiContactsmainStorage

GetAllContactsNamesWithPhones(), GetContactByTypeId(), GetGlobalContactById(), GetMyGlobalContact(), GetSuggestGroupItems(), addContactsToGroup(), clearAllContactsAndGroups(), deleteSuggestContacts(), getGroupByName(), getSharedContactIds(), updateContactUserId()

Properties summary

protected CDAVClient $Dav
#
protected api_Settings $Settings
#
protected boolean $Connected
#
protected string $User
#
protected string $AddressBookHomeSet
#
protected string $TimeZone
#
protected string $DbPrefix
#
protected PDO $Pdo
#
protected CAccount $Account
#
protected $ApiUsersManager

CApiUsersManager

CApiUsersManager

#
protected CApiDavManager $ApiDavManager
#
protected array $aAddressBooksCache
#
protected array $aGroupItemsCache
#
protected array $ContactsCache
#
protected array $GroupsCache
#
AfterLogic API Documentation API documentation generated by ApiGen