feedback_item_label Class Reference

Inheritance diagram for feedback_item_label:

Public Member Functions
	__construct ()
	constructor
	build_editform ($item, $feedback, $cm)
	Creates and returns an instance of the form for editing the item.
	can_switch_require ()
	Wether this item can be set as both required and not.
	compare_value ($item, $dbvalue, $dependvalue)
	Compares the dbvalue with the dependvalue.
	complete_form_element ($item, $form)
	Adds an input element to the complete form.
	create_value ($value)
	Converts the value from complete_form data to the string value that is stored in the db.
	edit_actions ($item, $feedback, $cm)
	Returns the list of actions allowed on this item in the edit mode.
	excelprint_item (&$worksheet, $row_offset, $xls_formats, $item, $groupid, $courseid=false)
	Adds summary information about an item to the Excel export file.
	get_analysed_for_external ($item, $groupid=false, $courseid=false)
	Return the analysis data ready for external functions.
	get_data ()
	Gets submitted data from the edit form and saves it in $this->item.
	get_data_for_external ($item)
	Return extra data for external functions.
	get_display_name ($item, $withpostfix=true)
	get_display_name_postfix ($item)
	Returns the postfix to be appended to the display name that is based on other settings.
	get_hasvalue ()
	Wether this item type has a value that is expected from the user and saved in the stored values.
	get_printval ($item, $value)
	Prepares the value for exporting to Excel.
	is_cancelled ()
	Checks if the editing form was cancelled.
	postupdate ($item)
	print_analysed ($item, $itemnr='', $groupid=false, $courseid=false)
	Prints analysis for the current item.
	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).
	show_editform ()
	Displays the form for editing an item.

Protected Attributes
stdClass	$item
feedback_item_form	$item_form
	$type = "label"

Constructor & Destructor Documentation

__construct()

feedback_item_label::__construct

(

)

constructor

Reimplemented from feedback_item_base.

Member Function Documentation

build_editform()

feedback_item_label::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_label::can_switch_require

(

)

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

Return values

bool

Reimplemented from feedback_item_base.

compare_value()

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

Compares the dbvalue with the dependvalue.

Parameters

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

Reimplemented from feedback_item_base.

complete_form_element()

feedback_item_label::complete_form_element	(		$item,
			$form )

Adds an input element to the complete form.

Parameters

stdClass	$item
mod_feedback_complete_form	$form

Reimplemented from feedback_item_base.

create_value()

feedback_item_base::create_value ( $value )

inherited

Converts the value from complete_form data to the string value that is stored in the db.

Parameters

mixed

$value

element from mod_feedback_complete_form\get_data() with the name $item->typ.'_'.$item->id

Return values

string

Reimplemented in feedback_item_captcha, feedback_item_info, feedback_item_multichoice, feedback_item_numeric, feedback_item_pagebreak, feedback_item_textarea, and feedback_item_textfield.

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_captcha, and feedback_item_pagebreak.

excelprint_item()

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

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

Parameters

object	$worksheet	a reference to the pear_spreadsheet-object
integer	$row_offset
stdClass	$xls_formats	see analysis_to_excel.php
object	$item	the db-object from feedback_item
integer	$groupid
integer	$courseid

Return values

integer

the new row_offset

Reimplemented from feedback_item_base.

get_analysed_for_external()

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

Return the analysis data ready for external functions.

Parameters

stdClass	$item	the item (question) information
int	$groupid	the group id to filter data (optional)
int	$courseid	the course id (optional)

Return values

array

an 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_captcha, and feedback_item_pagebreak.

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

$item

the item object

Return values

str	the data, may be json_encoded for large structures

Reimplemented in feedback_item_captcha, and feedback_item_info.

get_display_name()

feedback_item_label::get_display_name	(		$item,
			$withpostfix = true )

Parameters

stdClass	$item
bool | true	$withpostfix

Return values

string

Reimplemented from feedback_item_base.

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_label::get_hasvalue

(

)

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

Return values

int

Reimplemented from feedback_item_base.

get_printval()

feedback_item_label::get_printval	(		$item,
			$value )

Prepares the value for exporting to Excel.

Parameters

object	$item	the db-object from feedback_item
object	$value	object with item-related value from feedback_values in the 'value' property

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_captcha, and feedback_item_pagebreak.

print_analysed()

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

Prints analysis for the current item.

Parameters

	$item	the db-object from feedback_item
string	$itemnr
integer	$groupid
integer	$courseid

Return values

integer

the new itemnr

Reimplemented from feedback_item_base.

save_item()

feedback_item_label::save_item

(

)

Saves the item after it has been edited (or created)

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

$itemdata

the 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_captcha, and feedback_item_pagebreak.

---

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

• mod/feedback/item/label/lib.php