User Class Reference
Inheritance diagram for User:
Public Member Functions | |
| searchUsers () | |
| getUser ($user_id='') | |
| deleteUser ($user_id) | |
| getInstitutes ($user_id) | |
| getTopFolder ($user_id) | |
| patchCourseGroup ($user_id, $course_id) | |
 Public Member Functions inherited from RouteMap | |
| __construct () | |
| init ($router, $route) | |
| paginated ($data, $total, $uri_params=[], $query_params=[]) | |
| paginate ($uri_format, $total, $offset=null, $limit=null) | |
| collect ($data) | |
| status ($status) | |
| headers ($headers=[]) | |
| body ($body) | |
| contentType ($mime_type, $params=[]) | |
| error ($status, $body=null) | |
| etag ($value, $strong_etag=true, $new_resource=null) | |
| expires ($amount, $cache_control=[]) | |
| cacheControl ($values) | |
| halt () | |
| lastModified ($time) | |
| notFound ($body=null) | |
| redirect ($url, $args=null) | |
| sendFile ($_path, $opts=[]) | |
| url ($addr, $url_params=null) | |
| urlf ($addr_f, $format_params, $url_params=null) | |
| getRoutes ($http_method=null) | |
| getResponse () | |
Static Public Member Functions | |
| static | getMiniUser ($routemap, $user) |
| static | getNamesOfUser ($user) |
Additional Inherited Members | |
| Protected Member Functions inherited from RouteMap | |
| extractConditions ($docblock, $conditions=[]) | |
| Protected Attributes inherited from RouteMap | |
| $router | |
| $route | |
| $data = null | |
| $response | |
| $pagination = false | |
| $offset | |
| $limit | |
Detailed Description
user_id ^[0-9a-f]{1,32}$
Member Function Documentation
◆ deleteUser()
| deleteUser | ( | $user_id | ) |
deleteUser - deletes a user
/user/:user_id
◆ getInstitutes()
| getInstitutes | ( | $user_id | ) |
returns institutes for a given user
/user/:user_id/institutes
◆ getMiniUser()
|
static |
◆ getNamesOfUser()
|
static |
◆ getTopFolder()
| getTopFolder | ( | $user_id | ) |
Get the root file folder of a user's file area.
/user/:user_id/top_folder
◆ getUser()
| getUser | ( | $user_id = '' | ) |
getUser - retrieves data of a user
/user/:user_id /user
◆ patchCourseGroup()
| patchCourseGroup | ( | $user_id, | |
| $course_id | |||
| ) |
Patches the course member data of a user and course. Pass data to be patched via a valid json object in the body. Fields that my be patched:
- group - the associated group in the overview of the users's courses
- visibility - visible state of the course
/user/:user_id/courses/:course_id
◆ searchUsers()
| searchUsers | ( | ) |
Searches for users by a given keyword.
/users
The documentation for this class was generated from the following file:
- app/routes/User.php
