| [ Index ] |
PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008] |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 1553 lines (56 kb) |
| Included or required: | 1 time |
| Referenced: | 12 times |
| Includes or requires: | 0 files |
graded_users_iterator:: (8 methods):
graded_users_iterator()
init()
next_user()
close()
_push()
_pop()
print_graded_users_selector()
print_grade_plugin_selector()
grade_plugin_return:: (7 methods):
grade_plugin_return()
get_options()
get_return_url()
get_form_fields()
add_mform_elements()
add_url_params()
grade_build_nav()
grade_structure:: (9 methods):
get_element_icon()
get_element_header()
get_grade_eid()
get_item_eid()
get_params_for_iconstr()
get_edit_icon()
get_hiding_icon()
get_locking_icon()
get_calculation_icon()
grade_seq:: (3 methods):
grade_seq()
flatten()
locate_element()
grade_tree:: (8 methods):
grade_tree()
category_collapse()
no_outcomes()
category_grade_last()
fill_levels()
inject_fillers()
inject_colspans()
locate_element()
Class: graded_users_iterator - X-Ref
This class iterates over all users that are graded in a course.| graded_users_iterator($course, $grade_items=null, $groupid=0, $sortfield1='lastname', $sortorder1='ASC', $sortfield2='firstname', $sortorder2='ASC') X-Ref |
| Constructor param: $course object param: array grade_items array of grade items, if not specified only user info returned param: int $groupid iterate only group users if present param: string $sortfield1 The first field of the users table by which the array of users will be sorted param: string $sortorder1 The order in which the first sorting field will be sorted (ASC or DESC) param: string $sortfield2 The second field of the users table by which the array of users will be sorted param: string $sortorder2 The order in which the second sorting field will be sorted (ASC or DESC) |
| init() X-Ref |
| Initialise the iterator return: boolean success |
| next_user() X-Ref |
| Returns information about the next user return: mixed array of user info, all grades and feedback or null when no more users found |
| close() X-Ref |
| Close the iterator, do not forget to call this function. return: void |
| _push($grade) X-Ref |
| Internal function |
| _pop() X-Ref |
| Internal function |
| print_graded_users_selector($course, $actionpage, $userid=null, $return=false) X-Ref |
| Print a selection popup form of the graded users in a course. param: int $courseid id of the course param: string $actionpage The page receiving the data from the popoup form param: int $userid id of the currently selected user (or 'all' if they are all selected) param: bool $return If true, will return the HTML, otherwise, will print directly return: null |
| print_grade_plugin_selector($courseid, $active_type, $active_plugin, $return=false) X-Ref |
| Print grading plugin selection popup form. param: int $courseid id of course param: string $active_type type of plugin on current page - import, export, report or edit param: string $active_plugin active plugin type - grader, user, cvs, ... param: boolean $return return as string return: nothing or string if $return true |
Class: grade_plugin_return - X-Ref
Utility class used for return tracking when using edit and other forms in grade plugins| grade_plugin_return($params=null) X-Ref |
| Constructor param: array $params - associative array with return parameters, if null parameter are taken from _GET or _POST |
| get_options() X-Ref |
| Returns return parameters as options array suitable for buttons. return: array options |
| get_return_url($default, $extras=null) X-Ref |
| Returns return url param: string $default default url when params not set return: string url |
| get_form_fields() X-Ref |
| Returns string with hidden return tracking form elements. return: string |
| add_mform_elements(&$mform) X-Ref |
| Add hidden elements into mform param: object $mform moodle form object return: void |
| add_url_params($url) X-Ref |
| Add return tracking params into url param: string $url return: string $url with erturn tracking params |
| grade_build_nav($path, $pagename=null, $id=null) X-Ref |
| Function central to gradebook for building and printing the navigation (breadcrumb trail). param: string $path The path of the calling script (using __FILE__?) param: string $pagename The language string to use as the last part of the navigation (non-link) param: mixed $id Either a plain integer (assuming the key is 'id') or an array of keys and values (e.g courseid => $courseid, itemid...) return: string |
Class: grade_structure - X-Ref
General structure representing grade items in course| get_element_icon(&$element, $spacerifnone=false) X-Ref |
| Returns icon of element param: object $element param: bool $spacerifnone return spacer if no icon found return: string icon or spacer |
| get_element_header(&$element, $withlink=false, $icon=true, $spacerifnone=false) X-Ref |
| Returns name of element optionally with icon and link param: object $element param: bool $withlinks param: bool $icons param: bool $spacerifnone return spacer if no icon found return: header string |
| get_grade_eid($grade_grade) X-Ref |
| Returns the grade eid - the grade may not exist yet. param: $grade_grade object return: string eid |
| get_item_eid($grade_item) X-Ref |
| Returns the grade_item eid param: $grade_item object return: string eid |
| get_params_for_iconstr($element) X-Ref |
| No description |
| get_edit_icon($element, $gpr) X-Ref |
| Return edit icon for give element param: object $element return: string |
| get_hiding_icon($element, $gpr) X-Ref |
| Return hiding icon for give element param: object $element return: string |
| get_locking_icon($element, $gpr) X-Ref |
| Return locking icon for given element param: object $element return: string |
| get_calculation_icon($element, $gpr) X-Ref |
| Return calculation icon for given element param: object $element return: string |
| grade_seq($courseid, $category_grade_last=false, $nooutcomes=false) X-Ref |
| Constructor, retrieves and stores array of all grade_category and grade_item objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed. param: int $courseid param: boolean $category_grade_last category grade item is the last child param: array $collapsed array of collapsed categories |
| flatten(&$element, $category_grade_last, $nooutcomes) X-Ref |
| Static recursive helper - makes the grade_item for category the last children param: array $element The seed of the recursion return: void |
| locate_element($eid) X-Ref |
| Parses the array in search of a given eid and returns a element object with information about the element it has found. param: int $eid return: object element |
Class: grade_tree - X-Ref
This class represents a complete tree of categories, grade_items and final grades,| grade_tree($courseid, $fillers=true, $category_grade_last=false, $collapsed=null, $nooutcomes=false) X-Ref |
| Constructor, retrieves and stores a hierarchical array of all grade_category and grade_item objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed. param: int $courseid param: boolean $fillers include fillers and colspans, make the levels var "rectangular" param: boolean $category_grade_last category grade item is the last child param: array $collapsed array of collapsed categories |
| category_collapse(&$element, $collapsed) X-Ref |
| Static recursive helper - removes items from collapsed categories param: array $element The seed of the recursion param: array $collapsed array of collapsed categories return: void |
| no_outcomes(&$element) X-Ref |
| Static recursive helper - removes all outcomes param: array $element The seed of the recursion return: void |
| category_grade_last(&$element) X-Ref |
| Static recursive helper - makes the grade_item for category the last children param: array $element The seed of the recursion return: void |
| fill_levels(&$levels, &$element, $depth) X-Ref |
| Static recursive helper - fills the levels array, useful when accessing tree elements of one level param: int $levels param: array $element The seed of the recursion param: int $depth return: void |
| inject_fillers(&$element, $depth) X-Ref |
| Static recursive helper - makes full tree (all leafes are at the same level) |
| inject_colspans(&$element) X-Ref |
| Static recursive helper - add colspan information into categories |
| locate_element($eid) X-Ref |
| Parses the array in search of a given eid and returns a element object with information about the element it has found. param: int $eid return: object element |
| Generated: Wed Jan 14 11:33:29 2009 | Cross-referenced by PHPXref 0.7 |