Class CApiGcontactsLdapStorage

Class CApiGcontactsLdapStorage is used for work with global contacts in ldap storage.

AApiManagerStorage

Extended by

CApiGcontactsStorage

Extended by

CApiGcontactsLdapStorage

Package: GContacts\Storages
Located at gcontacts/storages/ldap/storage.php

Methods summary

`public`	# `__construct( CApiGlobalManager & $oManager )` Creates a new instance of the object. Creates a new instance of the object. Parameters `$oManager` $oManager Global manager object. Overrides `CApiGcontactsStorage::__construct`
`public integer`	# `getContactItemsCount( CAccount $oAccount, string $sSearch )` Obtains count of all global contacts found by search string for specified account. Obtains count of all global contacts found by search string for specified account. Parameters `$oAccount` Account object. `$sSearch` = '' Search string. Returns integer Overrides `CApiGcontactsStorage::getContactItemsCount`
`public boolean\|array`	# `getContactItems( CAccount $oAccount, integer $iSortField, integer $iSortOrder, integer $iOffset, integer $iRequestLimit, string $sSearch )` Obtains all global contacts by search string for specified account. Obtains all global contacts by search string for specified account. Parameters `$oAccount` Account object. `$iSortField` Sort field for sorting contact list. `$iSortOrder` Sort order for sorting contact list. `$iOffset` Offset value for obtaining a partial list. `$iRequestLimit` Limit value for obtaining a partial list. `$sSearch` Search string. Returns boolean\|array Overrides `CApiGcontactsStorage::getContactItems`
`public CContact\|boolean`	# `getContactById( CAccount $oAccount, mixed $mContactId, boolean $bIgnoreHideInGab = false )` Obtains contact by identifier for specified account. Obtains contact by identifier for specified account. Parameters `$oAccount` Account object. `$mContactId` Global contact identifier. `$bIgnoreHideInGab` = false. If true all global contacts will be checked including marked as "hide in global address book". Returns CContact\|boolean Overrides `CApiGcontactsStorage::getContactById`
`public CContact\|boolean`	# `getContactByEmail( CAccount $oAccount, string $sContactEmail )` Obtains contact by email for specified account. Obtains contact by email for specified account. Parameters `$oAccount` Account object. `$sContactEmail` Contact email. Returns CContact\|boolean Overrides `CApiGcontactsStorage::getContactByEmail`

Methods inherited from CApiGcontactsStorage

getContactByMailingListId()