Admin_Frontend_Json

Tine 2.0

This class handles all Json requests for the admin application

Implements:

Tinebase_Frontend_Json_Interface, Tinebase_Frontend_Interface

Extend:

Tinebase_Frontend_Json_Abstract

Methods

Name	Description
__construct	constructs Admin_Frontend_Json
deleteAccessLogs	delete access log entries
deleteConfigs	deletes existing records
deleteContainers	deletes existing records
deleteCustomfields	deletes existing records
deleteEmailAccounts	deletes existing records
deleteGroups	delete multiple groups
deleteImportExportDefinitions	deletes existing records
deleteLogEntrys	deletes existing records
deleteRoles	delete multiple roles
deleteSambaMachines	deletes existing records
deleteTags	delete multiple tags
deleteUsers	delete users
getAllRoleRights	get list of all role rights for all applications
getApplication	get application
getApplications	get list of applications
getConfig	Return a single record
getContainer	Return a single record
getCustomfield	Return a single record
getEmailAccount	Return a single record
getGroup	gets a single group
getGroupMembers	get list of group members
getGroups	get list of groups
getImportExportDefinition	Return a single record
getLogEntry	Return a single record
getPossibleMFAs	returns possible mfa adapter for given user
getRole	get a single role with all related data
getRoleMembers	get list of role members
getRoleRights	get list of role rights
getRoles	get list of roles
getSambaMachine	Return a single record
getServerInfo	returns phpinfo() output
getSieveCustomScript	get sieve custom script for account
getSieveRules	get sieve rules for account
getSieveScript	get sieve script for account
getSieveVacation	get sieve vacation for account
getTag	gets a single tag
getTags	get list of tags
getUser	returns a fullUser
getUsers	get list of accounts
resetPassword	reset password for given account
resolveAccountName	adds the name of the account to each item in the name property
revealEmailAccountPassword	reveal email account password
saveConfig	creates/updates a record
saveContainer	creates/updates a record
saveCustomfield	creates/updates a record
saveEmailAccount	creates/updates a record
saveGroup	save group data from edit form
saveImportExportDefinition	creates/updates a record
saveLogEntry	creates/updates a record
savePreferences	save preferences for application
saveQuota	save quotas
saveRole	save role data from edit form
saveRules	set sieve rules for account
saveSambaMachine	creates/updates a record
saveSieveCustomScript	set sieve custom script for account
saveSieveVacation	set sieve vacation for account
saveTag	save tag data from edit form
saveUser	save user
searchAccessLogs	Search for records matching given arguments
searchConfigs	Search for records matching given arguments
searchContainers	Search for records matching given arguments
searchCustomfields	Search for records matching given arguments
searchEmailAccounts	Search for records matching given arguments
searchGroups	Search for groups matching given arguments
searchImportExportDefinitions	Search for records matching given arguments
searchLogEntrys	Search for records matching given arguments
searchQuotaNodes
searchSambaMachines	Search for records matching given arguments
searchSharedAddressbooks	search for shared addressbook containers
searchUsers	search for users/accounts
setAccountState	set account state
setApplicationState	set application state

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
getTwigInUserContext	-
resolveContainersAndTags	resolve containers and tags

Admin_Frontend_Json::__construct

Description

public __construct (void)

constructs Admin_Frontend_Json

Parameters

This function has no parameters.

Return Values

void

---

Admin_Frontend_Json::deleteAccessLogs

Description

public deleteAccessLogs (array $ids)

delete access log entries

Parameters

• (array) $ids : list of logIds to delete

Return Values

array

with success flag

---

Admin_Frontend_Json::deleteConfigs

Description

public deleteConfigs (array $ids)

deletes existing records

Parameters

• (array) $ids

Return Values

array

---

Admin_Frontend_Json::deleteContainers

Description

public deleteContainers (array $ids)

deletes existing records

Parameters

• (array) $ids

Return Values

array

---

Admin_Frontend_Json::deleteCustomfields

Description

public deleteCustomfields (array $ids, array $context)

deletes existing records

Parameters

• (array) $ids
• (array) $context

Return Values

array

---

Admin_Frontend_Json::deleteEmailAccounts

Description

public deleteEmailAccounts (array $ids)

deletes existing records

Parameters

• (array) $ids

Return Values

string

---

Admin_Frontend_Json::deleteGroups

Description

public deleteGroups (array $groupIds)

delete multiple groups

Parameters

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

Return Values

array

with success flag

---

Admin_Frontend_Json::deleteImportExportDefinitions

Description

public deleteImportExportDefinitions (array $ids)

deletes existing records

Parameters

• (array) $ids

Return Values

string

---

Admin_Frontend_Json::deleteLogEntrys

Description

public deleteLogEntrys (array $ids)

deletes existing records

Parameters

• (array) $ids

Return Values

string

---

Admin_Frontend_Json::deleteRoles

Description

public deleteRoles (array $roleIds)

delete multiple roles

Parameters

• (array) $roleIds : list of roleId's to delete

Return Values

array

with success flag

---

Admin_Frontend_Json::deleteSambaMachines

Description

public deleteSambaMachines (array $ids)

deletes existing records

Parameters

• (array) $ids

Return Values

string

---

Admin_Frontend_Json::deleteTags

Description

public deleteTags (array $tagIds)

delete multiple tags

Parameters

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

Return Values

array

with success flag

---

Admin_Frontend_Json::deleteUsers

Description

public deleteUsers (array $ids)

delete users

Parameters

• (array) $ids : array of account ids

Return Values

array

with success flag

---

Admin_Frontend_Json::getAllRoleRights

Description

public getAllRoleRights (void)

get list of all role rights for all applications

Parameters

This function has no parameters.

Return Values

array

with all rights for applications

---

Admin_Frontend_Json::getApplication

Description

public getApplication (int $applicationId)

get application

Parameters

• (int) $applicationId : application id to get

Return Values

array

with application data

---

Admin_Frontend_Json::getApplications

Description

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

get list of applications

Parameters

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

Return Values

array

with results array & totalcount (int)

---

Admin_Frontend_Json::getConfig

Description

public getConfig (string $id)

Return a single record

Parameters

• (string) $id

Return Values

array

record data

---

Admin_Frontend_Json::getContainer

Description

public getContainer (string $id)

Return a single record

Parameters

• (string) $id

Return Values

array

record data

---

Admin_Frontend_Json::getCustomfield

Description

public getCustomfield (string $id)

Return a single record

Parameters

• (string) $id

Return Values

array

record data

---

Admin_Frontend_Json::getEmailAccount

Description

public getEmailAccount (string $id)

Return a single record

Parameters

• (string) $id

Return Values

array

Throws Exceptions

\Tinebase_Exception_NotFound

---

Admin_Frontend_Json::getGroup

Description

public getGroup (string $id)

gets a single group

Parameters

• (string) $id

Return Values

array

---

Admin_Frontend_Json::getGroupMembers

Description

public getGroupMembers (int $groupId)

get list of group members

Parameters

• (int) $groupId

Return Values

array

with results / total count

---

Admin_Frontend_Json::getGroups

Description

public getGroups (string $_filter, string $_sort, string $_dir, int $_start, int $_limit)

get list of groups

Parameters

• (string) $_filter
• (string) $_sort
• (string) $_dir
• (int) $_start
• (int) $_limit

Return Values

array

with results array & totalcount (int)

---

Admin_Frontend_Json::getImportExportDefinition

Description

public getImportExportDefinition (string $id)

Return a single record

Parameters

• (string) $id

Return Values

array

record data

---

Admin_Frontend_Json::getLogEntry

Description

public getLogEntry (string $id)

Return a single record

Parameters

• (string) $id

Return Values

array

record data

---

Admin_Frontend_Json::getPossibleMFAs

Description

public getPossibleMFAs (array|string $account)

returns possible mfa adapter for given user

Parameters

• (array|string) $account : Tinebase_Model_FullUser data or account id

Return Values

void

---

Admin_Frontend_Json::getRole

Description

public getRole (int $roleId)

get a single role with all related data

Parameters

• (int) $roleId

Return Values

array

---

Admin_Frontend_Json::getRoleMembers

Description

public getRoleMembers (int $roleId)

get list of role members

Parameters

• (int) $roleId

Return Values

array

with results / totalcount

---

Admin_Frontend_Json::getRoleRights

Description

public getRoleRights (int $roleId)

get list of role rights

Parameters

• (int) $roleId

Return Values

array

with results / totalcount

---

Admin_Frontend_Json::getRoles

Description

public getRoles (string $query, string $sort, string $dir, int $start, int $limit)

get list of roles

Parameters

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

Return Values

array

with results array & totalcount (int)

---

Admin_Frontend_Json::getSambaMachine

Description

public getSambaMachine (string $id)

Return a single record

Parameters

• (string) $id

Return Values

array

record data

---

Admin_Frontend_Json::getServerInfo

Description

public getServerInfo (void)

returns phpinfo() output

Parameters

This function has no parameters.

Return Values

array

---

Admin_Frontend_Json::getSieveCustomScript

Description

public getSieveCustomScript (string $accountId)

get sieve custom script for account

Parameters

• (string) $accountId

Return Values

array

---

Admin_Frontend_Json::getSieveRules

Description

public getSieveRules (string $accountId)

get sieve rules for account

Parameters

• (string) $accountId

Return Values

array

---

Admin_Frontend_Json::getSieveScript

Description

public getSieveScript (string $accountId)

get sieve script for account

Parameters

• (string) $accountId

Return Values

string

---

Admin_Frontend_Json::getSieveVacation

Description

public getSieveVacation (string $id)

get sieve vacation for account

Parameters

• (string) $id : account id

Return Values

array

---

Admin_Frontend_Json::getTag

Description

public getTag (int $tagId)

gets a single tag

Parameters

• (int) $tagId

Return Values

array

---

Admin_Frontend_Json::getTags

Description

public getTags (string $_filter, string $_sort, string $_dir, int $_start, int $_limit)

get list of tags

Parameters

• (string) $_filter
• (string) $_sort
• (string) $_dir
• (int) $_start
• (int) $_limit

Return Values

array

with results array & totalcount (int)

---

Admin_Frontend_Json::getUser

Description

public getUser (string $id)

returns a fullUser

Parameters

• (string) $id

Return Values

array

---

Admin_Frontend_Json::getUsers

Description

public getUsers (string $_filter, string $_sort, string $_dir, int $_start, int $_limit)

get list of accounts

Parameters

• (string) $_filter
• (string) $_sort
• (string) $_dir
• (int) $_start
• (int) $_limit

Return Values

array

with results array & totalcount (int)

---

Admin_Frontend_Json::resetPassword

Description

public resetPassword (array|string $account, string $password, bool $mustChange)

reset password for given account

Parameters

• (array|string) $account : Tinebase_Model_FullUser data or account id
• (string) $password : the new password
• (bool) $mustChange

Return Values

array

Throws Exceptions

\Admin_Exception

\Tinebase_Exception_InvalidArgument

\Tinebase_Exception_Record_DefinitionFailure

\Tinebase_Exception_Record_Validation

---

Admin_Frontend_Json::resolveAccountName

Description

public static resolveAccountName (array $_items, bool $_hasAccountPrefix, bool $_removePrefix)

adds the name of the account to each item in the name property

Parameters

• (array) $_items : array of arrays which contain a type and id property
• (bool) $_hasAccountPrefix
• (bool) $_removePrefix

Return Values

array

items with appended name

Throws Exceptions

\UnexpectedValueException

---

Admin_Frontend_Json::revealEmailAccountPassword

Description

public revealEmailAccountPassword (string $accountId)

reveal email account password

Parameters

• (string) $accountId

Return Values

array

Throws Exceptions

\Felamimail_Exception

\Tinebase_Exception

\Tinebase_Exception_AccessDenied

\Tinebase_Exception_NotFound

---

Admin_Frontend_Json::saveConfig

Description

public saveConfig (array $recordData)

creates/updates a record

Parameters

• (array) $recordData

Return Values

array

created/updated record

---

Admin_Frontend_Json::saveContainer

Description

public saveContainer (array $recordData)

creates/updates a record

Parameters

• (array) $recordData

Return Values

array

created/updated record

---

Admin_Frontend_Json::saveCustomfield

Description

public saveCustomfield (array $recordData)

creates/updates a record

Parameters

• (array) $recordData

Return Values

array

created/updated record

---

Admin_Frontend_Json::saveEmailAccount

Description

public saveEmailAccount (array $recordData)

creates/updates a record

Parameters

• (array) $recordData

Return Values

array

created/updated record

---

Admin_Frontend_Json::saveGroup

Description

public saveGroup (array $recordData)

save group data from edit form

Parameters

• (array) $recordData : group data

Return Values

array

---

Admin_Frontend_Json::saveImportExportDefinition

Description

public saveImportExportDefinition (array $recordData)

creates/updates a record

Parameters

• (array) $recordData

Return Values

array

created/updated record

---

Admin_Frontend_Json::saveLogEntry

Description

public saveLogEntry (array $recordData)

creates/updates a record

Parameters

• (array) $recordData

Return Values

array

created/updated record

---

Admin_Frontend_Json::savePreferences

Description

public savePreferences (array $data)

save preferences for application

Parameters

• (array) $data : json encoded preferences data

Return Values

array

with the changed prefs

Throws Exceptions

\Tinebase_Exception_AccessDenied

---

Admin_Frontend_Json::saveQuota

Description

public saveQuota (string $application, array $additionalData)

save quotas

Parameters

• (string) $application
• (array) $additionalData

Return Values

false[]|mixed|\Tinebase_Config_Struct|\Tinebase_Model_Tree_Node

Throws Exceptions

\Tinebase_Exception

\Tinebase_Exception_AccessDenied

\Tinebase_Exception_Backend_Database_LockTimeout

\Tinebase_Exception_NotFound

---

Admin_Frontend_Json::saveRole

Description

public saveRole (array $roleData, array $roleMembers, array $roleRights)

save role data from edit form

Parameters

• (array) $roleData : role data
• (array) $roleMembers : role members
• (array) $roleRights : role rights

Return Values

array

---

Admin_Frontend_Json::saveRules

Description

public saveRules (array $accountId, array $rulesData)

set sieve rules for account

Parameters

• (array) $accountId
• (array) $rulesData

Return Values

array

---

Admin_Frontend_Json::saveSambaMachine

Description

public saveSambaMachine (array $recordData)

creates/updates a record

Parameters

• (array) $recordData

Return Values

array

created/updated record

---

Admin_Frontend_Json::saveSieveCustomScript

Description

public saveSieveCustomScript ( $scriptData)

set sieve custom script for account

Parameters

• () $scriptData

Return Values

string

---

Admin_Frontend_Json::saveSieveVacation

Description

public saveSieveVacation (array $recordData)

set sieve vacation for account

Parameters

• (array) $recordData

Return Values

array

---

Admin_Frontend_Json::saveTag

Description

public saveTag (array $tagData)

save tag data from edit form

Parameters

• (array) $tagData

Return Values

array

with success, message, tag data and tag members

---

Admin_Frontend_Json::saveUser

Description

public saveUser (array $recordData)

save user

Parameters

• (array) $recordData : data of Tinebase_Model_FullUser

Return Values

array

---

Admin_Frontend_Json::searchAccessLogs

Description

public searchAccessLogs (array $filter, array $paging)

Search for records matching given arguments

Parameters

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

Return Values

array

---

Admin_Frontend_Json::searchConfigs

Description

public searchConfigs (array $filter, array $paging)

Search for records matching given arguments

Parameters

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

Return Values

array

---

Admin_Frontend_Json::searchContainers

Description

public searchContainers (array $filter, array $paging)

Search for records matching given arguments

Parameters

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

Return Values

array

---

Admin_Frontend_Json::searchCustomfields

Description

public searchCustomfields (array $filter, array $paging)

Search for records matching given arguments

Parameters

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

Return Values

array

---

Admin_Frontend_Json::searchEmailAccounts

Description

public searchEmailAccounts (array $filter, array $paging)

Search for records matching given arguments

Parameters

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

Return Values

array

---

Admin_Frontend_Json::searchGroups

Description

public searchGroups (array $_filter, array $_paging)

Search for groups matching given arguments

Parameters

• (array) $_filter
• (array) $_paging

Return Values

array

---

Admin_Frontend_Json::searchImportExportDefinitions

Description

public searchImportExportDefinitions (array $filter, array $paging)

Search for records matching given arguments

Parameters

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

Return Values

array

---

Admin_Frontend_Json::searchLogEntrys

Description

public searchLogEntrys (array $filter, array $paging)

Search for records matching given arguments

Parameters

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

Return Values

array

---

Admin_Frontend_Json::searchQuotaNodes

Description

 searchQuotaNodes (void)

Parameters

This function has no parameters.

Return Values

void

---

Admin_Frontend_Json::searchSambaMachines

Description

public searchSambaMachines (array $filter, array $paging)

Search for records matching given arguments

Parameters

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

Return Values

array

---

Admin_Frontend_Json::searchSharedAddressbooks

Description

public searchSharedAddressbooks (array $filter, array $paging)

search for shared addressbook containers

Parameters

• (array) $filter : unused atm
• (array) $paging : unused atm

Return Values

array

---

Admin_Frontend_Json::searchUsers

Description

public searchUsers (array $filter, array $paging)

search for users/accounts

Parameters

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

Return Values

array

with results array & totalcount (int)

---

Admin_Frontend_Json::setAccountState

Description

public setAccountState (array $accountIds, string $state)

set account state

Parameters

• (array) $accountIds : array of account ids
• (string) $state : state to set

Return Values

array

with success flag

---

Admin_Frontend_Json::setApplicationState

Description

public setApplicationState (array $applicationIds, string $state)

set application state

Parameters

• (array) $applicationIds : array of application ids
• (string) $state : state to set

Return Values

array

with success flag

---