Setup_Frontend_Json
Setup json frontend
Implements:
Tinebase_Frontend_Interface
Extend:
Tinebase_Frontend_Abstract
Methods
| Name | Description |
|---|---|
| __construct | the constructor |
| checkConfig | check config and return status |
| deleteLicense | removes the current license |
| envCheck | do the environment check |
| getAllRegistryData | Returns registry data of all applications current user has access to |
| getEmailConfig | load email config data |
| getLicense | Get current license if available |
| getRegistryData | Returns registry data of setup |
| installApplications | install new applications |
| loadAuthenticationData | load auth config data |
| loadConfig | load config data from config file / default data |
| login | authenticate user by username and password |
| logout | destroy session |
| saveAuthentication | Update authentication data (needs Tinebase tables to store the data) |
| saveConfig | save config data in config file |
| saveEmailConfig | Update email config data |
| saveLicense | Saves license configuration |
| saveTerms | |
| searchApplications | search for installed and installable applications |
| uninstallApplications | uninstall applications |
| updateApplications | update existing applications |
| uploadLicense |
Setup_Frontend_Json::__construct
Description
public __construct (void)
the constructor
Parameters
This function has no parameters.
Return Values
void
Setup_Frontend_Json::checkConfig
Description
public checkConfig (void)
check config and return status
Parameters
This function has no parameters.
Return Values
array
Setup_Frontend_Json::deleteLicense
Description
public deleteLicense (void)
removes the current license
Parameters
This function has no parameters.
Return Values
void
Setup_Frontend_Json::envCheck
Description
public envCheck (void)
do the environment check
Parameters
This function has no parameters.
Return Values
array
Setup_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'
TODO DRY: most of this already is part of Tinebase_Frontend_Json::_getAnonymousRegistryData
Throws Exceptions
\Tinebase_Exception
Setup_Frontend_Json::getEmailConfig
Description
public getEmailConfig (void)
load email config data
Parameters
This function has no parameters.
Return Values
array
Setup_Frontend_Json::getLicense
Description
public getLicense (void)
Get current license if available
Parameters
This function has no parameters.
Return Values
mixed
Setup_Frontend_Json::getRegistryData
Description
public getRegistryData (void)
Returns registry data of setup
Parameters
This function has no parameters.
Return Values
array
Throws Exceptions
\Tinebase_Exception_InvalidArgument
Setup_Frontend_Json::installApplications
Description
public installApplications (array $applicationNames, array $)
install new applications
Parameters
(array) $applicationNames: application names to install(array) $: | optional $options
Return Values
void
Setup_Frontend_Json::loadAuthenticationData
Description
public loadAuthenticationData (void)
load auth config data
Parameters
This function has no parameters.
Return Values
array
Setup_Frontend_Json::loadConfig
Description
public loadConfig (void)
load config data from config file / default data
Parameters
This function has no parameters.
Return Values
array
Setup_Frontend_Json::login
Description
public login (string $username, string $password)
authenticate user by username and password
Parameters
(string) $username: the username(string) $password: the password
Return Values
array
Setup_Frontend_Json::logout
Description
public logout (void)
destroy session
Parameters
This function has no parameters.
Return Values
array
Setup_Frontend_Json::saveAuthentication
Description
public saveAuthentication (array $data)
Update authentication data (needs Tinebase tables to store the data)
Installs Tinebase if not already installed
Parameters
(array) $data
Return Values
array
[success status]
Setup_Frontend_Json::saveConfig
Description
public saveConfig (array $data)
save config data in config file
Parameters
(array) $data
Return Values
array
with config data
Setup_Frontend_Json::saveEmailConfig
Description
public saveEmailConfig (array $data)
Update email config data
Parameters
(array) $data
Return Values
array
[success status]
Setup_Frontend_Json::saveLicense
Description
public saveLicense (string $license)
Saves license configuration
Parameters
(string) $license
Return Values
array
Setup_Frontend_Json::saveTerms
Description
saveTerms (void)
Parameters
This function has no parameters.
Return Values
void
Setup_Frontend_Json::searchApplications
Description
public searchApplications (void)
search for installed and installable applications
Parameters
This function has no parameters.
Return Values
array
Setup_Frontend_Json::uninstallApplications
Description
public uninstallApplications (array $applicationNames)
uninstall applications
Parameters
(array) $applicationNames: application names to uninstall
Return Values
array
Setup_Frontend_Json::updateApplications
Description
public updateApplications (array $applicationNames)
update existing applications
Parameters
(array) $applicationNames: application names to update
Return Values
array
TODO remove $applicationNames param and adopt js client
Setup_Frontend_Json::uploadLicense
Description
uploadLicense (void)
Parameters
This function has no parameters.
Return Values
void