Crm_Frontend_Json
This class handles all Json requests for the Crm application
Implements:
Tinebase_Frontend_Json_Interface, Tinebase_Frontend_Interface
Extend:
Tinebase_Frontend_Json_Abstract
Methods
| Name | Description |
|---|---|
| __construct | the constructor |
| deleteLeads | deletes existing records |
| getDefaultContainer | get default container for leads |
| getLead | Return a single record |
| saveLead | creates/updates a record |
| saveSettings | creates/updates settings |
| searchLeads | Search for records matching given arguments |
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 |
Crm_Frontend_Json::__construct
Description
public __construct (void)
the constructor
Parameters
This function has no parameters.
Return Values
void
Crm_Frontend_Json::deleteLeads
Description
public deleteLeads (array $ids)
deletes existing records
Parameters
(array) $ids
Return Values
string
Crm_Frontend_Json::getDefaultContainer
Description
public getDefaultContainer (void)
get default container for leads
Parameters
This function has no parameters.
Return Values
array
Crm_Frontend_Json::getLead
Description
public getLead (string $id)
Return a single record
Parameters
(string) $id
Return Values
array
record data
Crm_Frontend_Json::saveLead
Description
public saveLead (array $recordData, bool $duplicateCheck)
creates/updates a record
Parameters
(array) $recordData(bool) $duplicateCheck
Return Values
array
created/updated record
Crm_Frontend_Json::saveSettings
Description
public saveSettings (void)
creates/updates settings
Parameters
This function has no parameters.
Return Values
array
created/updated settings
Crm_Frontend_Json::searchLeads
Description
public searchLeads (array $filter, array $paging)
Search for records matching given arguments
Parameters
(array) $filter(array) $paging
Return Values
array