Courses_Frontend_Json
This class handles all Json requests for the Courses application
Implements:
Tinebase_Frontend_Json_Interface, Tinebase_Frontend_Interface
Extend:
Tinebase_Frontend_Json_Abstract
Methods
| Name | Description |
|---|---|
| __construct | the constructor |
| addNewMember | add new member to course |
| deleteCourses | deletes existing records |
| getCourse | Return a single record |
| importMembers | import course members |
| resetPassword | reset password for given account - call Admin_Frontend_Json::resetPassword() |
| saveCourse | creates/updates a record |
| searchCourseTypes | Search for records matching given arguments |
| searchCourses | 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 |
Courses_Frontend_Json::__construct
Description
public __construct (void)
the constructor
Parameters
This function has no parameters.
Return Values
void
Courses_Frontend_Json::addNewMember
Description
public addNewMember (array $userData, array $courseData)
add new member to course
Parameters
(array) $userData(array) $courseData
Return Values
array
Courses_Frontend_Json::deleteCourses
Description
public deleteCourses (array $ids)
deletes existing records
Parameters
(array) $ids
Return Values
array
Courses_Frontend_Json::getCourse
Description
public getCourse (string $id)
Return a single record
Parameters
(string) $id
Return Values
array
record data
Courses_Frontend_Json::importMembers
Description
public importMembers (string $tempFileId, string $groupId, string $courseName)
import course members
Parameters
(string) $tempFileId(string) $groupId(string) $courseName
Return Values
void
Courses_Frontend_Json::resetPassword
Description
public resetPassword (array $account, string $password, bool $mustChange)
reset password for given account - call Admin_Frontend_Json::resetPassword()
Parameters
(array) $account: data of Tinebase_Model_FullUser or account id(string) $password: the new password(bool) $mustChange
Return Values
array
Courses_Frontend_Json::saveCourse
Description
public saveCourse (array $recordData)
creates/updates a record
Parameters
(array) $recordData
Return Values
array
created/updated record
Courses_Frontend_Json::searchCourseTypes
Description
public searchCourseTypes (array $filter, array $paging)
Search for records matching given arguments
Parameters
(array) $filter(array) $paging
Return Values
array
Courses_Frontend_Json::searchCourses
Description
public searchCourses (array $filter, array $paging)
Search for records matching given arguments
Parameters
(array) $filter(array) $paging
Return Values
array