Tinebase_Frontend_Json

Json interface to Tinebase

Implements:

Tinebase_Frontend_Json_Interface, Tinebase_Frontend_Interface

Extend:

Tinebase_Frontend_Json_Abstract

Methods

Name	Description
__construct
_getLoginFailedResponse
aggregatePopulation	seriously?.... please get rid of this
attachMultipleTagsToMultipleRecords	attach multiple tags to multiple records identified by a filter
attachTagToMultipleRecords	attach tag to multiple records identified by a filter
authenticate	authenticate user by username and password
autoComplete	return autocomplete suggestions for a given recordclass, the property and value
changePassword	change password of user
changeUserAccount	switch to another user's account
checkAuthToken
clearState	clears state
copyNodes
createTempFile
deleteTags	deletes tags identified by an array of identifiers
detachTagsFromMultipleRecords	detach tags to multiple records identified by a filter
getAllRegistryData	Returns registry data of all applications current user has access to
getAuthToken
getAvailableTranslations	returns list of all available translations
getConfig	get config settings for application
getCountryList	get list of translated country names
getCurrencyList	get list of translated currency names *
getPreviewsFromTempFile
getRelations	get all relations of a given record
getReplicationModificationLogs	returns the replication modification logs
getTerminationDeadline
getUserProfile	get profile of current user
getUserProfileConfig	gets the userProfile config
getUsers	get users
getWebAuthnAuthenticateOptionsForLogin
getWebAuthnAuthenticateOptionsForMFA
getWebAuthnRegisterPublicKeyOptionsForMFA
joinTempFiles	joins all given tempfiles in given order to a single new tempFile
loadState	retuns all states
login	login user with given username and password
logout	destroy session
ping	ping
purifyHTML
reportPresence
restoreRevision
saveConfig	save application config
savePreferences	save preferences for application
saveTag	adds a new personal tag
searchCustomFieldValues	search / get custom field values
searchDepartments	search / get departments
searchNotes	search / get notes - used by activities grid
searchPaths
searchPreferencesForApplication	search preferences
searchRoles	Search for roles
searchTags	search tags
searchTagsByForeignFilter	search tags by foreign filter
setLocale	sets locale
setState	set state
setTimezone	sets timezone
setUserProfileConfig	saves userProfile config
toogleAdvancedSearch	Toggles advanced search preference
updateCredentialCache	update user credential cache
updateMultipleRecords	Used for updating multiple records
updateUserProfile	update user profile
void	dummy function to measure speed of framework initialization

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

Tinebase_Frontend_Json::__construct

Description

 __construct (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::_getLoginFailedResponse

Description

 _getLoginFailedResponse (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::aggregatePopulation

Description

public aggregatePopulation (array $_communityNumber)

seriously?.... please get rid of this

Parameters

• (array) $_communityNumber

Return Values

mixed

---

Tinebase_Frontend_Json::attachMultipleTagsToMultipleRecords

Description

public attachMultipleTagsToMultipleRecords (array $filterData, string $filterName, mixed $tags)

attach multiple tags to multiple records identified by a filter

Parameters

• (array) $filterData
• (string) $filterName
• (mixed) $tags : array of existing and non-existing tags

Return Values

void

---

Tinebase_Frontend_Json::attachTagToMultipleRecords

Description

public attachTagToMultipleRecords (array $filterData, string $filterName, mixed $tag)

attach tag to multiple records identified by a filter

Parameters

• (array) $filterData
• (string) $filterName
• (mixed) $tag : string|array existing and non-existing tag

Return Values

array

---

Tinebase_Frontend_Json::authenticate

Description

public authenticate (string $username, string $password)

authenticate user by username and password

Parameters

• (string) $username : the username
• (string) $password : the password

Return Values

array

---

Tinebase_Frontend_Json::autoComplete

Description

public autoComplete (string $appName, string $modelName, string $property, string $startswith)

return autocomplete suggestions for a given recordclass, the property and value

Parameters

• (string) $appName
• (string) $modelName
• (string) $property
• (string) $startswith

Return Values

array

Throws Exceptions

\Tinebase_Exception_InvalidArgument

---

Tinebase_Frontend_Json::changePassword

Description

public changePassword (string $oldPassword, string $newPassword)

change password of user

Parameters

• (string) $oldPassword : the old password
• (string) $newPassword : the new password

Return Values

array

---

Tinebase_Frontend_Json::changeUserAccount

Description

public changeUserAccount (string $loginName)

switch to another user's account

Parameters

• (string) $loginName

Return Values

array

---

Tinebase_Frontend_Json::checkAuthToken

Description

 checkAuthToken (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::clearState

Description

public clearState (string $name)

clears state

Parameters

• (string) $name

Return Values

array

---

Tinebase_Frontend_Json::copyNodes

Description

 copyNodes (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::createTempFile

Description

 createTempFile (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::deleteTags

Description

public deleteTags (array $ids)

deletes tags identified by an array of identifiers

Parameters

• (array) $ids

Return Values

array

---

Tinebase_Frontend_Json::detachTagsFromMultipleRecords

Description

public detachTagsFromMultipleRecords (array $filterData, string $filterName, mixed $tag)

detach tags to multiple records identified by a filter

Parameters

• (array) $filterData
• (string) $filterName
• (mixed) $tag : string|array existing and non-existing tag

Return Values

array

---

Tinebase_Frontend_Json::getAllRegistryData

Description

public getAllRegistryData (void)

Returns registry data of all applications current user has access to

Parameters

This function has no parameters.

Return Values

mixed

array 'variable name' => 'data'

Throws Exceptions

\Tinebase_Exception_AccessDenied

---

Tinebase_Frontend_Json::getAuthToken

Description

 getAuthToken (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::getAvailableTranslations

Description

public getAvailableTranslations (void)

returns list of all available translations

Parameters

This function has no parameters.

Return Values

array

list of all available translations

---

Tinebase_Frontend_Json::getConfig

Description

public getConfig (string $id)

get config settings for application

Parameters

• (string) $id : application name

Return Values

array

---

Tinebase_Frontend_Json::getCountryList

Description

public getCountryList (void)

get list of translated country names

Wrapper for {@see \Tinebase_Core::getCountrylist}

Parameters

This function has no parameters.

Return Values

array

list of countrys

---

Tinebase_Frontend_Json::getCurrencyList

Description

public getCurrencyList (void)

get list of translated currency names *

Parameters

This function has no parameters.

Return Values

array

list of currencies

---

Tinebase_Frontend_Json::getPreviewsFromTempFile

Description

 getPreviewsFromTempFile (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::getRelations

Description

public getRelations (string $model, string $id, string $degree, array $type, string $relatedModel)

get all relations of a given record

Parameters

• (string) $model : own model to get relations for
• (string) $id : own id to get relations for
• (string) $degree : only return relations of given degree
• (array) $type : only return relations of given type
• (string) $relatedModel : only return relations having this related model

Return Values

array

---

Tinebase_Frontend_Json::getReplicationModificationLogs

Description

public getReplicationModificationLogs (int $sequence, int $limit)

returns the replication modification logs

Parameters

• (int) $sequence
• (int) $limit

Return Values

array

Throws Exceptions

\Tinebase_Exception_AccessDenied

---

Tinebase_Frontend_Json::getTerminationDeadline

Description

 getTerminationDeadline (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::getUserProfile

Description

public getUserProfile (string $userId)

get profile of current user

Parameters

• (string) $userId

Return Values

array

---

Tinebase_Frontend_Json::getUserProfileConfig

Description

public getUserProfileConfig (void)

gets the userProfile config

Parameters

This function has no parameters.

Return Values

array

---

Tinebase_Frontend_Json::getUsers

Description

public getUsers (string $filter, string $sort, string $dir, int $start, int $limit)

get users

Parameters

• (string) $filter
• (string) $sort
• (string) $dir
• (int) $start
• (int) $limit

Return Values

array

with results array & totalcount (int)

---

Tinebase_Frontend_Json::getWebAuthnAuthenticateOptionsForLogin

Description

 getWebAuthnAuthenticateOptionsForLogin (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::getWebAuthnAuthenticateOptionsForMFA

Description

 getWebAuthnAuthenticateOptionsForMFA (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::getWebAuthnRegisterPublicKeyOptionsForMFA

Description

 getWebAuthnRegisterPublicKeyOptionsForMFA (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::joinTempFiles

Description

public joinTempFiles (array $tempFilesData)

joins all given tempfiles in given order to a single new tempFile

Parameters

• (array) $tempFilesData : of tempfiles arrays $tempFiles

Return Values

array

new tempFile

---

Tinebase_Frontend_Json::loadState

Description

public loadState (void)

retuns all states

Parameters

This function has no parameters.

Return Values

array

of name => value

---

Tinebase_Frontend_Json::login

Description

public login (?string $username, ?string $password, ?string $MFAUserConfigId, ?string $MFAPassword)

login user with given username and password

Parameters

• (?string) $username : the username
• (?string) $password : the password
• (?string) $MFAUserConfigId : config for mfa device to use
• (?string) $MFAPassword : otp from mfa device

Return Values

array

---

Tinebase_Frontend_Json::logout

Description

public logout (void)

destroy session

Parameters

This function has no parameters.

Return Values

array

---

Tinebase_Frontend_Json::ping

Description

public ping (void)

ping

NOTE: auth & outdated client gets checked in server

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::purifyHTML

Description

 purifyHTML (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::reportPresence

Description

 reportPresence (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::restoreRevision

Description

 restoreRevision (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::saveConfig

Description

public saveConfig (array $recordData)

save application config

Parameters

• (array) $recordData

Return Values

array

---

Tinebase_Frontend_Json::savePreferences

Description

public savePreferences (void)

save preferences for application

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::saveTag

Description

public saveTag (array $tag)

adds a new personal tag

Parameters

• (array) $tag

Return Values

array

---

Tinebase_Frontend_Json::searchCustomFieldValues

Description

public searchCustomFieldValues (array $filter, array $paging)

search / get custom field values

Parameters

• (array) $filter : filter array
• (array) $paging : pagination info

Return Values

array

---

Tinebase_Frontend_Json::searchDepartments

Description

public searchDepartments (array $filter, array $paging)

search / get departments

Parameters

• (array) $filter : filter array
• (array) $paging : pagination info

Return Values

array

---

Tinebase_Frontend_Json::searchNotes

Description

public searchNotes (array $filter, array $paging)

search / get notes - used by activities grid

Parameters

• (array) $filter : filter array
• (array) $paging : pagination info

Return Values

array

---

Tinebase_Frontend_Json::searchPaths

Description

 searchPaths (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Json::searchPreferencesForApplication

Description

public searchPreferencesForApplication (string $applicationName, array $filter)

search preferences

Parameters

• (string) $applicationName
• (array) $filter : json encoded

Return Values

array

---

Tinebase_Frontend_Json::searchRoles

Description

public searchRoles (array $filter, array $paging)

Search for roles

Parameters

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

Return Values

array

---

Tinebase_Frontend_Json::searchTags

Description

public searchTags (array $filter, array $paging)

search tags

Parameters

• (array) $filter : filter array
• (array) $paging : pagination info

Return Values

array

---

Tinebase_Frontend_Json::searchTagsByForeignFilter

Description

public searchTagsByForeignFilter (array $filterData, string $filterName)

search tags by foreign filter

Parameters

• (array) $filterData
• (string) $filterName

Return Values

array

---

Tinebase_Frontend_Json::setLocale

Description

public setLocale (string $localeString, bool $saveaspreference, bool $setcookie)

sets locale

Parameters

• (string) $localeString
• (bool) $saveaspreference
• (bool) $setcookie

Return Values

array

---

Tinebase_Frontend_Json::setState

Description

public setState (string $name, string|array $value)

set state

Parameters

• (string) $name
• (string|array) $value

Return Values

bool[]

Throws Exceptions

\Exception

---

Tinebase_Frontend_Json::setTimezone

Description

public setTimezone (string $timezoneString, bool $saveaspreference)

sets timezone

Parameters

• (string) $timezoneString
• (bool) $saveaspreference

Return Values

string

---

Tinebase_Frontend_Json::setUserProfileConfig

Description

public setUserProfileConfig (array $configData)

saves userProfile config

Parameters

• (array) $configData

Return Values

void

---

Tinebase_Frontend_Json::toogleAdvancedSearch

Description

public toogleAdvancedSearch (string|int $state)

Toggles advanced search preference

Parameters

• (string|int) $state

Return Values

true

---

Tinebase_Frontend_Json::updateCredentialCache

Description

public updateCredentialCache (string $password)

update user credential cache

• fires Tinebase_Event_User_ChangeCredentialCache

Parameters

• (string) $password

Return Values

array

---

Tinebase_Frontend_Json::updateMultipleRecords

Description

public updateMultipleRecords (string $appName, string $modelName, array $changes, array $filter)

Used for updating multiple records

Parameters

• (string) $appName
• (string) $modelName
• (array) $changes
• (array) $filter

Return Values

void

---

Tinebase_Frontend_Json::updateUserProfile

Description

public updateUserProfile (array $profileData)

update user profile

Parameters

• (array) $profileData

Return Values

array

---

Tinebase_Frontend_Json::void

Description

public void (void)

dummy function to measure speed of framework initialization

Parameters

This function has no parameters.

Return Values

void

---