mod_bigbluebuttonbn\output\recording_name_editable Class Reference

Inheritance diagram for mod_bigbluebuttonbn\output\recording_name_editable:

Public Member Functions
	__construct (recording $rec, instance $instance)
	Specific constructor with the right label/hint for this editable.
	export_for_template (\renderer_base $output)
	Export this data so it can be used as the context for a mustache template (core/inplace_editable).
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template.
	get_recording_value (recording $recording)
	Get the value to display.
	render (\renderer_base $output)
	Renders this element.
	set_type_autocomplete ($options, $attributes)
	Sets the element type to be an autocomplete field.
	set_type_select ($options)
	Sets the element type to be a dropdown.
	set_type_toggle ($options=null)
	Sets the element type to be a toggle.

Static Public Member Functions
static	update ($itemid, $value)
	Update the recording with the new value.

Protected Member Functions
	check_capability ()
	Check user can access and or modify this item.
	get_linkeverything ()
	Whether the link should contain all of the content or not.
	row_editable ()
	Helper function evaluates if a row for the data used by the recording table is editable.

Static Protected Member Functions
static	get_type ()
	Get the type of editable.

Protected Attributes
string	$component = null
	component responsible for diplsying/updating
string	$displayvalue = null
	value of the editable element as it should be displayed, must be formatted and may contain links or other html tags
bool	$editable = false
	indicates if the current user is allowed to edit this element - set in constructor after permissions are checked
string	$edithint = null
	hint for the input element (for screenreaders)
pix_icon	$editicon = null
	icon to use to toggle editing
string	$editlabel = null
	label for the input element (for screenreaders)
instance	$instance
	The bbb instance.
int	$itemid = null
	identifier of the editable element (usually database id)
string	$itemtype = null
	itemtype inside the component
string	$options = ''
	options for the element, for example new value for the toggle or json-encoded list of options for select
string	$type = 'text'
	type of the element - text, toggle or select
string	$value = null
	value of the editable element as it is present in the database

Constructor & Destructor Documentation

__construct()

mod_bigbluebuttonbn\output\recording_name_editable::__construct	(	recording	$rec,
		instance	$instance )

Specific constructor with the right label/hint for this editable.

Parameters

recording	$rec
instance	$instance

Member Function Documentation

check_capability()

mod_bigbluebuttonbn\output\recording_editable::check_capability ( )

protectedinherited

Check user can access and or modify this item.

Return values

bool

Exceptions

moodle_exception

export_for_template() [1/2]

core\output\inplace_editable::export_for_template ( \renderer_base $output )

inherited

Export this data so it can be used as the context for a mustache template (core/inplace_editable).

Parameters

renderer_base

$output

typically, the renderer that's calling this function

Return values

array

data context for a mustache template

Reimplemented in core_courseformat\output\local\content\cm\title.

export_for_template() [2/2]

core\output\templatable::export_for_template ( renderer_base $output )

inherited

Function to export the renderer data in a format that is suitable for a mustache template.

This means:

1. No complex types - only stdClass, array, int, string, float, bool
2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).

Parameters

renderer_base

$output

Used to do a final render of any components that need to be rendered for export.

Return values

stdClass|array

Implemented in core\output\action_menu, core\output\actions\component_action, core\output\activity_header, core\output\checkbox_toggleall, core\output\choicelist, core\output\chooser, core\output\chooser_item, core\output\chooser_section, core\output\comboboxsearch, core\output\context_header, core\output\custom_menu_item, core\output\dynamic_tabs, core\output\help_icon, core\output\initials_bar, core\output\paging_bar, core\output\pix_icon, core\output\pix_icon_font, core\output\progress_bar, core\output\select_menu, core\output\single_select, core\output\tabobject, core\output\tabtree, core\output\task_indicator, core\output\url_select, core_calendar\output\humandate, core_calendar\output\humantimeperiod, core_course\output\actionbar\group_selector_button, core_course\output\actionbar\group_selector_dropdown_form, core_course\output\actionbar\initials_dropdown_form, core_course\output\actionbar\user_selector_button, core_course\output\activity_completion, core_course\output\activity_dates, core_course\output\activity_icon, core_course\output\activitychooserbutton, core_course\output\completion_action_bar, core_courseformat\output\local\content\basecontrolmenu, core_courseformat\output\local\content\cm\controlmenu, core_courseformat\output\local\content\cm, core_courseformat\output\local\content\section, core_courseformat\output\local\overview\activityname, core_courseformat\output\local\overview\overviewtable, core_grades\output\penalty_indicator, core_reportbuilder\output\custom_report, core_reportbuilder\output\dynamictabs\access, core_reportbuilder\output\dynamictabs\audience, core_reportbuilder\output\dynamictabs\editor, core_reportbuilder\output\dynamictabs\schedules, core_reportbuilder\output\report_action, and core_reportbuilder\output\system_report.

get_recording_value()

mod_bigbluebuttonbn\output\recording_name_editable::get_recording_value

(

recording

$recording

)

Get the value to display.

Parameters

recording

$recording

Return values

string

Reimplemented from mod_bigbluebuttonbn\output\recording_editable.

get_type()

static mod_bigbluebuttonbn\output\recording_name_editable::get_type ( )

staticprotected

Get the type of editable.

Reimplemented from mod_bigbluebuttonbn\output\recording_editable.

render()

core\output\inplace_editable::render ( \renderer_base $output )

inherited

Renders this element.

Parameters

renderer_base

$output

typically, the renderer that's calling this function

Return values

string

row_editable()

mod_bigbluebuttonbn\output\recording_editable::row_editable ( )

protectedinherited

Helper function evaluates if a row for the data used by the recording table is editable.

Return values

bool

set_type_autocomplete()

core\output\inplace_editable::set_type_autocomplete ( $options, $attributes )

inherited

Sets the element type to be an autocomplete field.

Parameters

array	$options	associative array with dropdown options
array	$attributes	associative array with attributes for autoselect field. See AMD module core/form-autocomplete.

Return values

self

set_type_select()

core\output\inplace_editable::set_type_select ( $options )

inherited

Sets the element type to be a dropdown.

For select element specifying $displayvalue is optional, if null it will be assumed that $displayvalue = $options[$value]. However displayvalue can still be specified if it needs icons and/or html links.

If only one option specified, the element will not be editable.

Parameters

array

$options

associative array with dropdown options

Return values

self

set_type_toggle()

core\output\inplace_editable::set_type_toggle ( $options = null )

inherited

Sets the element type to be a toggle.

For toggle element $editlabel is not used. $displayvalue must be specified, it can have text or icons but can not contain html links.

Toggle element can have two or more options.

Parameters

array

$options

toggle options as simple, non-associative array; defaults to array(0,1)

Return values

self

update()

static mod_bigbluebuttonbn\output\recording_editable::update ( $itemid, $value )

staticinherited

Update the recording with the new value.

Parameters

int	$itemid
mixed	$value

Return values

recording_editable

---

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

• mod/bigbluebuttonbn/classes/output/recording_name_editable.php