| Methods |
public
|
__construct(AbstractModule $oModule = null)
|
#
|
public
|
getContact(string $sUUID): Contact
|
#
|
public
|
getContactByEmail($iUserId, string $sEmail): Contact
|
#
|
public
|
getGroup(string $sUUID): Group
Returns group item identified by its ID.
Returns group item identified by its ID.
Parameters
|
#
|
public
|
getGroupByName(string $sName, $iUserId): Group
Returns group item identified by its name.
Returns group item identified by its name.
Parameters
|
#
|
public
|
updateContact(Contact $oContact): bool
Updates contact information. Using this method is required to finalize changes made to the contact object.
Updates contact information. Using this method is required to finalize changes made to the contact object.
Parameters
| $oContact |
Contact object to be updated
|
|
#
|
public
|
updateGroup(Group $oGroup): bool
Updates group information. Using this method is required to finalize changes made to the group object.
Updates group information. Using this method is required to finalize changes made to the group object.
|
#
|
public
|
getContactsCount($Filters = null, string $sGroupUUID = ''): int
Returns list of contacts which match the specified criteria
Returns list of contacts which match the specified criteria
Parameters
| $sGroupUUID |
. Default value is ''.
|
|
#
|
public
|
getContacts(
int $iSortField = SortField::Name,
int $iSortOrder = SortOrder::ASC,
int $iOffset = 0,
int $iLimit = 20,
Builder $oFilters = null,
array $aViewAttrs = [],
): array|bool
Returns list of contacts within specified range, sorted according to specified requirements.
Returns list of contacts within specified range, sorted according to specified requirements.
Parameters
| $iSortField |
Sort field. Accepted values:
|
| $iSortOrder |
Sorting order. Accepted values:
|
| $iOffset |
Ordinal number of the contact item the list stars with. Default value is 0.
|
| $iLimit |
The upper limit for total number of contacts returned. Default value is 20.
|
|
#
|
public
|
getContactsAsArray(
int $iSortField = SortField::Name,
int $iSortOrder = SortOrder::ASC,
int $iOffset = 0,
int $iLimit = 20,
Builder $oFilters = null,
array $aViewAttrs = [],
): array|bool
Returns list of contacts within specified range, sorted according to specified requirements.
Returns list of contacts within specified range, sorted according to specified requirements.
Parameters
| $iSortField |
Sort field. Accepted values:
|
| $iSortOrder |
Sorting order. Accepted values:
|
| $iOffset |
Ordinal number of the contact item the list stars with. Default value is 0.
|
| $iLimit |
The upper limit for total number of contacts returned. Default value is 20.
|
|
#
|
public
|
getContactUids(Builder $oFilters): array|bool
Returns uid list of contacts.
Returns uid list of contacts.
|
#
|
public
|
getGroups(int $iUserId, $oFilters = null): array|bool
Returns list of user's groups.
Returns list of user's groups.
Parameters
|
#
|
public
|
createContact(Contact $oContact): bool
The method is used for saving created contact to the database.
The method is used for saving created contact to the database.
|
#
|
public
|
createGroup(Group $oGroup): bool
The method is used for saving created group to the database.
The method is used for saving created group to the database.
|
#
|
public
|
deleteContacts($iIdUser, $sStorage, array $aContactUUIDs): bool
Deletes one or multiple contacts from address book.
Deletes one or multiple contacts from address book.
Parameters
| $aContactUUIDs |
Array of strings
|
|
#
|
public
|
deleteGroups(array $aGroupUUIDs): bool
Deletes specific groups from address book.
Deletes specific groups from address book.
Parameters
| $aGroupUUIDs |
array of strings - groups identifiers.
|
|
#
|
public
|
deleteGroupsByUserId($iUserId)
|
#
|
public
|
addContactsToGroup(string $sGroupUUID, array $aContactUUIDs): bool
Adds one or multiple contacts to the specific group.
Adds one or multiple contacts to the specific group.
Parameters
| $sGroupUUID |
Group identifier to be used
|
| $aContactUUIDs |
Array of integers
|
|
#
|
public
|
removeContactsFromGroup(string $sGroupUUID, array $aContactUUIDs): bool
The method deletes one or multiple contacts from the group.
The method deletes one or multiple contacts from the group.
Parameters
| $sGroupUUID |
Group identifier
|
| $aContactUUIDs |
Array of integers
|
|
#
|
public
|
getCTags($iUserId, $Storage)
|
#
|
public
|
getCTag($iUserId, $Storage)
|
#
|
public
|
updateCTag($iUserId, $Storage)
|
#
|
public
|
deleteContactsByUserId($iUserId, $Storage = null)
|
#
|
public
|
deleteCTagsByUserId($iUserId, $Storage = null)
|
#
|