Addressbook_Frontend_Json

Addressbook_Frontend_Json

This class handles all Json requests for the addressbook application

Implements:

Tinebase_Frontend_Json_Interface, Tinebase_Frontend_Interface

Extend:

Tinebase_Frontend_Json_Abstract

Methods

Name	Description
autoCompleteContactProperty	return autocomplete suggestions for a given property and value
deleteContacts	delete multiple contacts
deleteIndustrys	delete multiple industries
deleteListRoles	delete multiple list roles
deleteLists	delete multiple lists
getContact	get one contact identified by $id
getDefaultAddressbook	get default addressbook
getIndustry	get one industry identified by $id
getList	get one list identified by $id
getListRole	get one list role identified by $id
parseAddressData	get contact information from string by parsing it using predefined rules
resolveImages	resolve images
saveContact	save one contact
saveIndustry	save industry
saveList	save one list
saveListRole	save list role
searchContacts	Search for contacts matching given arguments
searchEmailAddresss	Search for Email Addresses with the Email Model in Lists and Contacts
searchIndustrys	Search for industries matching given arguments
searchListMemberRoles	Search for lists member roles matching given arguments
searchListRoles	Search for lists roles matching given arguments
searchLists	Search for lists matching given arguments
searchRecipientTokensByEmailArrays	Search list and contact by recipient token data

Inherited methods

Name	Description
__call	magic method for json api
addFilterModelPlugin	Add a plugin for a former filter
getModelsConfiguration	returns model configurations for application starter
getRegistryData	Returns registry data of the application.
getRelatableModels	Returns all relatable models for this app
getTemplates	get available templates by containerId
resolveContainersAndTags	resolve containers and tags

Addressbook_Frontend_Json::autoCompleteContactProperty

Description

public autoCompleteContactProperty (string $property, string $startswith)

return autocomplete suggestions for a given property and value

Parameters

• (string) $property
• (string) $startswith

Return Values

array

Throws Exceptions

\Tasks_Exception_UnexpectedValue

---

Addressbook_Frontend_Json::deleteContacts

Description

public deleteContacts (array $ids)

delete multiple contacts

Parameters

• (array) $ids : list of contactId's to delete

Return Values

array

---

Addressbook_Frontend_Json::deleteIndustrys

Description

public deleteIndustrys (array $ids)

delete multiple industries

Parameters

• (array) $ids : list of listId's to delete

Return Values

array

---

Addressbook_Frontend_Json::deleteListRoles

Description

public deleteListRoles (array $ids)

delete multiple list roles

Parameters

• (array) $ids : list of listId's to delete

Return Values

array

---

Addressbook_Frontend_Json::deleteLists

Description

public deleteLists (array $ids)

delete multiple lists

Parameters

• (array) $ids : list of listId's to delete

Return Values

array

---

Addressbook_Frontend_Json::getContact

Description

public getContact (string $id)

get one contact identified by $id

Parameters

• (string) $id

Return Values

array

---

Addressbook_Frontend_Json::getDefaultAddressbook

Description

public getDefaultAddressbook (void)

get default addressbook

Parameters

This function has no parameters.

Return Values

array

---

Addressbook_Frontend_Json::getIndustry

Description

public getIndustry (string $id)

get one industry identified by $id

Parameters

• (string) $id

Return Values

array

---

Addressbook_Frontend_Json::getList

Description

public getList (string $id)

get one list identified by $id

Parameters

• (string) $id

Return Values

array

---

Addressbook_Frontend_Json::getListRole

Description

public getListRole (string $id)

get one list role identified by $id

Parameters

• (string) $id

Return Values

array

---

Addressbook_Frontend_Json::parseAddressData

Description

public parseAddressData (?string $address)

get contact information from string by parsing it using predefined rules

Parameters

• (?string) $address

Return Values

array

---

Addressbook_Frontend_Json::resolveImages

Description

public static resolveImages (\Tinebase_Record_RecordSet $_records)

resolve images

Parameters

• (\Tinebase_Record_RecordSet) $_records

Return Values

void

---

Addressbook_Frontend_Json::saveContact

Description

public saveContact (array $recordData, bool $duplicateCheck)

save one contact

if $recordData['id'] is empty the contact gets added, otherwise it gets updated

Parameters

• (array) $recordData : an array of contact properties
• (bool) $duplicateCheck

Return Values

array

---

Addressbook_Frontend_Json::saveIndustry

Description

public saveIndustry (array $recordData)

save industry

Parameters

• (array) $recordData

Return Values

array

---

Addressbook_Frontend_Json::saveList

Description

public saveList (array $recordData, bool $duplicateCheck)

save one list

if $recordData['id'] is empty the list gets added, otherwise it gets updated

Parameters

• (array) $recordData : an array of list properties
• (bool) $duplicateCheck

Return Values

array

---

Addressbook_Frontend_Json::saveListRole

Description

public saveListRole (array $recordData)

save list role

Parameters

• (array) $recordData

Return Values

array

---

Addressbook_Frontend_Json::searchContacts

Description

public searchContacts (array $filter, array $paging)

Search for contacts matching given arguments

Parameters

• (array) $filter
• (array) $paging

Return Values

array

---

Addressbook_Frontend_Json::searchEmailAddresss

Description

public searchEmailAddresss (array $filter, array $paging)

Search for Email Addresses with the Email Model in Lists and Contacts

Parameters

• (array) $filter
• (array) $paging

Return Values

array

---

Addressbook_Frontend_Json::searchIndustrys

Description

public searchIndustrys (array $filter, array $paging)

Search for industries matching given arguments

Parameters

• (array) $filter
• (array) $paging

Return Values

array

---

Addressbook_Frontend_Json::searchListMemberRoles

Description

public searchListMemberRoles (array $filter, array $paging)

Search for lists member roles matching given arguments

Parameters

• (array) $filter
• (array) $paging

Return Values

array

---

Addressbook_Frontend_Json::searchListRoles

Description

public searchListRoles (array $filter, array $paging)

Search for lists roles matching given arguments

Parameters

• (array) $filter
• (array) $paging

Return Values

array

---

Addressbook_Frontend_Json::searchLists

Description

public searchLists (array $filter, array $paging)

Search for lists matching given arguments

Parameters

• (array) $filter
• (array) $paging

Return Values

array

---

Addressbook_Frontend_Json::searchRecipientTokensByEmailArrays

Description

public searchRecipientTokensByEmailArrays (array $emails, array $names, array $types)

Search list and contact by recipient token data

Parameters

• (array) $emails
• (array) $names
• (array) $types

Return Values

array

Throws Exceptions

\Tinebase_Exception_InvalidArgument

\Tinebase_Exception_Record_DefinitionFailure

\Tinebase_Exception_Record_Validation

---