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 CApiContactsmainLdapStorage

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

Methods summary

public
# __construct( CApiGlobalManager & $oManager )

Parameters

$oManager

Overrides

CApiContactsmainStorage::__construct
public CContact|boolean
# GetContactByTypeId( mixed $mTypeId, integer $mContactId )

Parameters

$mTypeId
$mContactId

Returns

CContact|boolean

Overrides

CApiContactsmainStorage::GetContactByTypeId
public CContact|boolean
# getContactById( integer $iUserId, mixed $mContactId )

Parameters

$iUserId
$mContactId

Returns

CContact|boolean

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, integer $iSharedTenantId = null )

Parameters

$iUserId
$sContactStrId
$iSharedTenantId
= null

Returns

CContact|boolean

Overrides

CApiContactsmainStorage::getContactByStrId
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
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
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, mixed $mGroupId, integer $iTenantId = null, $bAll = false )

Parameters

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

Returns

boolean|array

Overrides

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

Parameters

$iUserId
$sSearch
$sFirstCharacter
$mGroupId
$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, mixed $mContactId )

Parameters

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

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, boolean $bPhoneOnly = false )

Parameters

$iUserId
$sSearch
$iRequestLimit
$bPhoneOnly
= false

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
# 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, string $aEmails )

Parameters

$iUserId
$aEmails
$sEmail

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|false
# GetGlobalContactById( integer $iUserId, mixed $mContactId )

Parameters

$iUserId
$mContactId

Returns

CContact|false

Overrides

CApiContactsmainStorage::GetGlobalContactById

Methods inherited from CApiContactsmainStorage

GetAllContactsNamesWithPhones(), GetSuggestGroupItems(), getSharedContactIds(), updateContactUserId()

AfterLogic API Documentation API documentation generated by ApiGen