Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402] [Versions 402 and 403]

The user screen.

Copyright: 2014 Moodle Pty Ltd (http://moodle.com)
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 429 lines (14 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

user:: (15 methods):
  select_label()
  description()
  options()
  item_type()
  init()
  original_headers()
  format_line()
  format_icon()
  get_item_action_menu()
  category()
  heading()
  summary()
  pager()
  supports_paging()
  process()


Class: user  - X-Ref

The user screen.

select_label()   X-Ref
Get the label for the select box that chooses items for this page.

return: string

description()   X-Ref
Get the description for the screen.

return: string

options()   X-Ref
Convert the list of items to a list of options.

return: array

item_type()   X-Ref
Get the type of items on this screen.

return: string

init($selfitemisempty = false)   X-Ref
Init the screen

param: bool $selfitemisempty Have we selected an item yet?

original_headers()   X-Ref
Get the list of headers for the table.

return: array List of headers

format_line($item)   X-Ref
Format each row of the table.

param: grade_item $item
return: array

format_icon($item)   X-Ref
Helper to get the icon for an item.

param: grade_item $item
return: string

get_item_action_menu(grade_item $item)   X-Ref
Return the action menu HTML for the grade item.

param: grade_item $item
return: mixed

category(grade_item $item)   X-Ref
Helper to get the category for an item.

param: grade_item $item
return: string

heading()   X-Ref
Get the heading for the page.

return: string

summary()   X-Ref
Get the summary for this table.

return: string

pager()   X-Ref
Default pager

return: string

supports_paging()   X-Ref
Does this page require paging?

return: bool

process($data)   X-Ref
Process the data from the form.

param: array $data
return: stdClass of warnings