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]

(no description)

File Size: 374 lines (13 kb)
Included or required:0 times
Referenced: 6 times
Includes or requires: 0 files

Defines 2 classes

feedback_item_base:: (13 methods):
  __construct()
  show_editform()
  is_cancelled()
  get_data()
  set_data()
  create_value()
  compare_value()
  get_hasvalue()
  can_switch_require()
  get_display_name()
  get_display_name_postfix()
  edit_actions()
  get_data_for_external()

feedback_item_pagebreak:: (14 methods):
  show_editform()
  is_cancelled()
  get_data()
  build_editform()
  save_item()
  create_value()
  get_hasvalue()
  excelprint_item()
  print_analysed()
  get_printval()
  can_switch_require()
  complete_form_element()
  edit_actions()
  get_analysed_for_external()


Class: feedback_item_base  - X-Ref

__construct()   X-Ref
constructor


show_editform()   X-Ref
Displays the form for editing an item

this function only can used after the call of build_editform()

is_cancelled()   X-Ref
Checks if the editing form was cancelled

return: bool

get_data()   X-Ref
Gets submitted data from the edit form and saves it in $this->item

return: bool

set_data($itemdata)   X-Ref
Set the item data (to be used by data generators).

param: stdClass $itemdata the item data to set

create_value($value)   X-Ref
Converts the value from complete_form data to the string value that is stored in the db.

param: mixed $value element from mod_feedback_complete_form::get_data() with the name $item->typ.'_'.$item->id
return: string

compare_value($item, $dbvalue, $dependvalue)   X-Ref
Compares the dbvalue with the dependvalue

param: stdClass $item
param: string $dbvalue is the value input by user in the format as it is stored in the db
param: string $dependvalue is the value that it needs to be compared against

get_hasvalue()   X-Ref
Wether this item type has a value that is expected from the user and saved in the stored values.

return: int

can_switch_require()   X-Ref
Wether this item can be set as both required and not

return: bool

get_display_name($item, $withpostfix = true)   X-Ref
Returns the formatted name of the item for the complete form or response view

param: stdClass $item
param: bool $withpostfix
return: string

get_display_name_postfix($item)   X-Ref
Returns the postfix to be appended to the display name that is based on other settings

param: stdClass $item
return: string

edit_actions($item, $feedback, $cm)   X-Ref
Returns the list of actions allowed on this item in the edit mode

param: stdClass $item
param: stdClass $feedback
param: cm_info $cm
return: action_menu_link[]

get_data_for_external($item)   X-Ref
Return extra data for external functions.

Some items may have additional configuration data or default values that should be returned for external functions:
- Info elements: The default value information (course or category name)
- Captcha: The recaptcha challenge hash key

param: stdClass $item the item object
return: str the data, may be json_encoded for large structures

Class: feedback_item_pagebreak  - X-Ref

show_editform()   X-Ref
No description

is_cancelled()   X-Ref
Checks if the editing form was cancelled

return: bool

get_data()   X-Ref
No description

build_editform($item, $feedback, $cm)   X-Ref
No description

save_item()   X-Ref
No description

create_value($data)   X-Ref
No description

get_hasvalue()   X-Ref
No description

excelprint_item(&$worksheet, $row_offset,$xls_formats, $item,$groupid, $courseid = false)   X-Ref
No description

print_analysed($item, $itemnr = '', $groupid = false, $courseid = false)   X-Ref
No description

get_printval($item, $value)   X-Ref
No description

can_switch_require()   X-Ref
No description

complete_form_element($item, $form)   X-Ref
Adds an input element to the complete form

param: stdClass $item
param: mod_feedback_complete_form $form

edit_actions($item, $feedback, $cm)   X-Ref
Returns the list of actions allowed on this item in the edit mode

param: stdClass $item
param: stdClass $feedback
param: cm_info $cm
return: action_menu_link[]

get_analysed_for_external($item, $groupid = false, $courseid = false)   X-Ref
Return the analysis data ready for external functions.

param: stdClass $item     the item (question) information
param: int      $groupid  the group id to filter data (optional)
param: int      $courseid the course id (optional)
return: array an array of data with non scalar types json encoded