| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
This file contains a class definition for the Memberships service
| Author: | Stephen Vickers |
| Copyright: | 2015 Vital Source Technologies http://vitalsource.com |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 215 lines (8 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
memberships:: (4 methods):
__construct()
get_resources()
get_users_json()
users_to_json()
Class: memberships - X-Ref
A service implementing Memberships.| __construct() X-Ref |
| Class constructor. |
| get_resources() X-Ref |
| Get the resources for this service. return: array |
| get_users_json($resource, $context, $id, $tool, $role, $limitfrom, $limitnum, $lti, $info) X-Ref |
| Get the JSON for members. param: \mod_lti\local\ltiservice\resource_base $resource Resource handling the request param: \context_course $context Course context param: string $id Course ID param: object $tool Tool instance object param: string $role User role requested (empty if none) param: int $limitfrom Position of first record to be returned param: int $limitnum Maximum number of records to be returned param: object $lti LTI instance record param: info_module $info Conditional availability information for LTI instance (null if context-level request) return: array |
| users_to_json($resource, $users, $id, $tool, $exclude, $limitfrom, $limitnum,$lti, $info) X-Ref |
| Get the JSON representation of the users. Note that when a limit is set and the exclude array is not empty, then the number of memberships returned may be less than the limit. param: \mod_lti\local\ltiservice\resource_base $resource Resource handling the request param: array $users Array of user records param: string $id Course ID param: object $tool Tool instance object param: array $exclude Array of user records to be excluded from the response param: int $limitfrom Position of first record to be returned param: int $limitnum Maximum number of records to be returned param: object $lti LTI instance record param: \core_availability\info_module $info Conditional availability information for LTI instance return: string |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |