[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/cohort/ -> externallib.php (summary)

External cohort API

Copyright: MediaTouch 2000 srl
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 649 lines (26 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

core_cohort_external:: (21 methods):
  create_cohorts_parameters()
  create_cohorts()
  create_cohorts_returns()
  delete_cohorts_parameters()
  delete_cohorts()
  delete_cohorts_returns()
  get_cohorts_parameters()
  get_cohorts()
  get_cohorts_returns()
  update_cohorts_parameters()
  update_cohorts()
  update_cohorts_returns()
  add_cohort_members_parameters()
  add_cohort_members()
  add_cohort_members_returns()
  delete_cohort_members_parameters()
  delete_cohort_members()
  delete_cohort_members_returns()
  get_cohort_members_parameters()
  get_cohort_members()
  get_cohort_members_returns()


Class: core_cohort_external  - X-Ref

create_cohorts_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

create_cohorts($cohorts)   X-Ref
Create one or more cohorts

param: array $cohorts An array of cohorts to create.
return: array An array of arrays

create_cohorts_returns()   X-Ref
Returns description of method result value

return: external_description

delete_cohorts_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

delete_cohorts($cohortids)   X-Ref
Delete cohorts

param: array $cohortids
return: null

delete_cohorts_returns()   X-Ref
Returns description of method result value

return: null

get_cohorts_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

get_cohorts($cohortids = array()   X-Ref
Get cohorts definition specified by ids

param: array $cohortids array of cohort ids
return: array of cohort objects (id, courseid, name)

get_cohorts_returns()   X-Ref
Returns description of method result value

return: external_description

update_cohorts_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

update_cohorts($cohorts)   X-Ref
Update cohorts

param: array $cohorts
return: null

update_cohorts_returns()   X-Ref
Returns description of method result value

return: null

add_cohort_members_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

add_cohort_members($members)   X-Ref
Add cohort members

param: array $members of arrays with keys userid, cohortid

add_cohort_members_returns()   X-Ref
Returns description of method result value

return: null

delete_cohort_members_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

delete_cohort_members($members)   X-Ref
Delete cohort members

param: array $members of arrays with keys userid, cohortid

delete_cohort_members_returns()   X-Ref
Returns description of method result value

return: null

get_cohort_members_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

get_cohort_members($cohortids)   X-Ref
Return all members for a cohort

param: array $cohortids array of cohort ids
return: array with cohort id keys containing arrays of user ids

get_cohort_members_returns()   X-Ref
Returns description of method result value

return: external_description



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1