[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/classes/ -> grades_external.php (summary)

Core grades external functions

Copyright: 2012 Andrew Davis
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 573 lines (29 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

core_grades_external:: (8 methods):
  get_grades_parameters()
  get_grades()
  get_grade_item()
  get_grades_returns()
  get_grades_is_deprecated()
  update_grades_parameters()
  update_grades()
  update_grades_returns()


Class: core_grades_external  - X-Ref

core grades functions

get_grades_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

get_grades($courseid, $component = null, $activityid = null, $userids = array()   X-Ref
Returns student course total grade and grades for activities.
This function does not return category or manual items.
This function is suitable for managers or teachers not students.

param: int $courseid        Course id
param: string $component    Component name
param: int $activityid      Activity id
param: array  $userids      Array of user ids
return: array                Array of grades

get_grade_item($courseid, $itemtype, $itemmodule = null, $iteminstance = null, $itemnumber = null)   X-Ref
Get a grade item

param: int $courseid        Course id
param: string $itemtype     Item type
param: string $itemmodule   Item module
param: int $iteminstance    Item instance
param: int $itemnumber      Item number
return: grade_item           A grade_item instance

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

return: external_description

get_grades_is_deprecated()   X-Ref
Marking the method as deprecated.

return: bool

update_grades_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

update_grades($source, $courseid, $component, $activityid,$itemnumber, $grades = array()   X-Ref
Update a grade item and, optionally, student grades

param: string $source       The source of the grade update
param: int $courseid        The course id
param: string $component    Component name
param: int $activityid      The activity id
param: int $itemnumber      The item number
param: array  $grades      Array of grades
param: array  $itemdetails Array of item details
return: int                  A status flag

update_grades_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