Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
feedback_item_multichoice Class Reference
Inheritance diagram for feedback_item_multichoice:
feedback_item_base

Public Member Functions

 build_editform ($item, $feedback, $cm)
 Creates and returns an instance of the form for editing the item. More...
 
 can_switch_require ()
 Wether this item can be set as both required and not. More...
 
 compare_value ($item, $dbvalue, $dependvalue)
 Compares the dbvalue with the dependvalue. More...
 
 complete_form_element ($item, $form)
 Adds an input element to the complete form. More...
 
 create_value ($value)
 Prepares value that user put in the form for storing in DB. More...
 
 edit_actions ($item, $feedback, $cm)
 Returns the list of actions allowed on this item in the edit mode. More...
 
 excelprint_item (&$worksheet, $row_offset, $xls_formats, $item, $groupid, $courseid=false)
 Adds summary information about an item to the Excel export file. More...
 
 get_analysed_for_external ($item, $groupid=false, $courseid=false)
 Return the analysis data ready for external functions. More...
 
 get_data ()
 Gets submitted data from the edit form and saves it in $this->item. More...
 
 get_data_for_external ($item)
 Return extra data for external functions. More...
 
 get_display_name ($item, $withpostfix=true)
 Returns the formatted name of the item for the complete form or response view. More...
 
 get_display_name_postfix ($item)
 Returns the postfix to be appended to the display name that is based on other settings. More...
 
 get_hasvalue ()
 Wether this item type has a value that is expected from the user and saved in the stored values. More...
 
 get_info ($item)
 
 get_printval ($item, $value)
 Prepares the value for exporting to Excel. More...
 
 hidenoselect ($item)
 
 ignoreempty ($item)
 
 is_cancelled ()
 Checks if the editing form was cancelled. More...
 
 print_analysed ($item, $itemnr='', $groupid=false, $courseid=false)
 Prints analysis for the current item. More...
 
 save_item ()
 Saves the item after it has been edited (or created)
 
 set_data ($itemdata)
 Set the item data (to be used by data generators). More...
 
 set_hidenoselect ($item, $hidenoselect=true)
 
 set_ignoreempty ($item, $ignoreempty=true)
 
 show_editform ()
 Displays the form for editing an item. More...
 

Protected Member Functions

 get_analysed ($item, $groupid=false, $courseid=false)
 
 get_options ($item)
 Options for the multichoice element. More...
 

Protected Attributes

stdClass $item
 
feedback_item_form $item_form
 
 $type = "multichoice"
 

Member Function Documentation

◆ build_editform()

feedback_item_multichoice::build_editform (   $item,
  $feedback,
  $cm 
)

Creates and returns an instance of the form for editing the item.

Parameters
stdClass$item
stdClass$feedback
cm_info | stdClass$cm

Reimplemented from feedback_item_base.

◆ can_switch_require()

feedback_item_base::can_switch_require ( )
inherited

Wether this item can be set as both required and not.

Return values
bool

Reimplemented in feedback_item_label, feedback_item_info, feedback_item_pagebreak, and feedback_item_captcha.

◆ compare_value()

feedback_item_multichoice::compare_value (   $item,
  $dbvalue,
  $dependvalue 
)

Compares the dbvalue with the dependvalue.

Parameters
stdClass$item
string$dbvalueis the value input by user in the format as it is stored in the db
string$dependvalueis the value that it needs to be compared against

Reimplemented from feedback_item_base.

◆ complete_form_element()

feedback_item_multichoice::complete_form_element (   $item,
  $form 
)

Adds an input element to the complete form.

This element has many options - it can be displayed as group or radio elements, group of checkboxes or a dropdown list.

Parameters
stdClass$item
mod_feedback_complete_form$form

Reimplemented from feedback_item_base.

◆ create_value()

feedback_item_multichoice::create_value (   $value)

Prepares value that user put in the form for storing in DB.

Parameters
array$value
Return values
string

Reimplemented from feedback_item_base.

◆ edit_actions()

feedback_item_base::edit_actions (   $item,
  $feedback,
  $cm 
)
inherited

Returns the list of actions allowed on this item in the edit mode.

Parameters
stdClass$item
stdClass$feedback
cm_info$cm
Return values
action_menu_link[]

Reimplemented in feedback_item_pagebreak, and feedback_item_captcha.

◆ excelprint_item()

feedback_item_multichoice::excelprint_item ( $worksheet,
  $row_offset,
  $xls_formats,
  $item,
  $groupid,
  $courseid = false 
)

Adds summary information about an item to the Excel export file.

Parameters
object$worksheeta reference to the pear_spreadsheet-object
integer$row_offset
stdClass$xls_formatssee analysis_to_excel.php
object$itemthe db-object from feedback_item
integer$groupid
integer$courseid
Return values
integerthe new row_offset

Reimplemented from feedback_item_base.

◆ get_analysed_for_external()

feedback_item_multichoice::get_analysed_for_external (   $item,
  $groupid = false,
  $courseid = false 
)

Return the analysis data ready for external functions.

Parameters
stdClass$itemthe item (question) information
int$groupidthe group id to filter data (optional)
int$courseidthe course id (optional)
Return values
arrayan array of data with non scalar types json encoded
Since
Moodle 3.3

Reimplemented from feedback_item_base.

◆ get_data()

feedback_item_base::get_data ( )
inherited

Gets submitted data from the edit form and saves it in $this->item.

Return values
bool

Reimplemented in feedback_item_pagebreak, and feedback_item_captcha.

◆ get_data_for_external()

feedback_item_base::get_data_for_external (   $item)
inherited

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
Parameters
stdClass$itemthe item object
Return values
strthe data, may be json_encoded for large structures

Reimplemented in feedback_item_info, and feedback_item_captcha.

◆ get_display_name()

feedback_item_base::get_display_name (   $item,
  $withpostfix = true 
)
inherited

Returns the formatted name of the item for the complete form or response view.

Parameters
stdClass$item
bool$withpostfix
Return values
string

Reimplemented in feedback_item_label, and feedback_item_captcha.

◆ get_display_name_postfix()

feedback_item_base::get_display_name_postfix (   $item)
inherited

Returns the postfix to be appended to the display name that is based on other settings.

Parameters
stdClass$item
Return values
string

Reimplemented in feedback_item_numeric.

◆ get_hasvalue()

feedback_item_base::get_hasvalue ( )
inherited

Wether this item type has a value that is expected from the user and saved in the stored values.

Return values
int

Reimplemented in feedback_item_label, feedback_item_pagebreak, and feedback_item_captcha.

◆ get_options()

feedback_item_multichoice::get_options (   $item)
protected

Options for the multichoice element.

Parameters
stdClass$item
Return values
array

◆ get_printval()

feedback_item_multichoice::get_printval (   $item,
  $value 
)

Prepares the value for exporting to Excel.

Parameters
object$itemthe db-object from feedback_item
string$valuea item-related value from feedback_values
Return values
string

Reimplemented from feedback_item_base.

◆ is_cancelled()

feedback_item_base::is_cancelled ( )
inherited

Checks if the editing form was cancelled.

Return values
bool

Reimplemented in feedback_item_pagebreak, and feedback_item_captcha.

◆ print_analysed()

feedback_item_multichoice::print_analysed (   $item,
  $itemnr = '',
  $groupid = false,
  $courseid = false 
)

Prints analysis for the current item.

Parameters
$itemthe db-object from feedback_item
string$itemnr
integer$groupid
integer$courseid
Return values
integerthe new itemnr

Reimplemented from feedback_item_base.

◆ set_data()

feedback_item_base::set_data (   $itemdata)
inherited

Set the item data (to be used by data generators).

Parameters
stdClass$itemdatathe item data to set
Since
Moodle 3.3

◆ show_editform()

feedback_item_base::show_editform ( )
inherited

Displays the form for editing an item.

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

Reimplemented in feedback_item_pagebreak, and feedback_item_captcha.


The documentation for this class was generated from the following file: