Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
core\output\local\dropdown\status Class Reference
Inheritance diagram for core\output\local\dropdown\status:
core\output\local\dropdown\dialog core\output\named_templatable renderable templatable

Public Member Functions

 __construct (string $buttoncontent, choicelist $choices, array $definition=[])
 Constructor.
 
 add_button_id (string $value)
 Set the button element id.
 
 add_extra (string $attribute, string $value)
 Add extra extras to the sticky footer element.
 
 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_template_name (\renderer_base $renderer)
 Get the name of the template to use for this templatable.
 
 set_button (string $buttoncontent, ?string $buttonclasses=null)
 Set the button contents.
 
 set_button_classes (string $buttonclasses)
 Add extra classes to trigger butotn.
 
 set_choice (choicelist $choices)
 Set the dialog contents.
 
 set_classes (string $classes)
 Add extra classes to the component.
 
 set_content (string $dialogcontent)
 Set the dialog contents.
 
 set_dialog_width (string $width)
 Set the dialog width.
 
 set_disabled (bool $disabled)
 Set the dropdown disabled attribute.
 
 set_position (string $position)
 Set the dropdown position.
 

Public Attributes

const POSITION
 Dropdown dialog positions.
 
const WIDTH
 Dropdown dialog positions.
 

Protected Attributes

string $buttonclasses = ''
 trigger button CSS classes.
 
bool $buttoncontent = true
 if the footer should auto enable or not.
 
choicelist $choices = null
 content of dialog.
 
string $classes = ''
 component CSS classes.
 
string $dialogcontent = ''
 content of dialog.
 
bool $disabled = false
 if the element is disabled.
 
string $dropdownposition = self::POSITION['start']
 the dropdown position.
 
string $dropdownwidth = self::WIDTH['default']
 dropdown preferred width.
 
array $extras = []
 extra HTML attributes (attribute => value).
 

Detailed Description

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

core\output\local\dropdown\status::__construct ( string $buttoncontent,
choicelist $choices,
array $definition = [] )

Constructor.

The definition object could contain the following keys:

  • classes: component CSS classes.
  • buttonclasses: the button CSS classes.
  • dialogwidth: the dropdown width.
  • extras: extra HTML attributes (attribute => value).
  • buttonsync: if the button should be synced with the selected value.
  • updatestatus: if component must update the status and trigger a change event when clicked.
Parameters
string$buttoncontentthe button content
choicelist$choicesthe choice object
array$definitionan optional array of the element definition

Member Function Documentation

◆ add_button_id()

core\output\local\dropdown\dialog::add_button_id ( string $value)
inherited

Set the button element id.

Parameters
string$valuethe value

◆ add_extra()

core\output\local\dropdown\dialog::add_extra ( string $attribute,
string $value )
inherited

Add extra extras to the sticky footer element.

Parameters
string$attributethe extra attribute
string$valuethe value

◆ export_for_template() [1/2]

core\output\local\dropdown\status::export_for_template ( \renderer_base $output)

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

Parameters
renderer_base$outputtypically, the renderer that's calling this function
Return values
arraydata context for a mustache template

Reimplemented from core\output\local\dropdown\dialog.

◆ export_for_template() [2/2]

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$outputUsed to do a final render of any components that need to be rendered for export.
Return values
stdClass|array

Implemented in action_menu, assign_attempt_history_chooser, block_lp\output\competencies_to_review_page, block_lp\output\plans_to_review_page, block_lp\output\summary, block_myoverview\output\main, block_myprofile\output\myprofile, block_recentlyaccessedcourses\output\main, block_recentlyaccesseditems\output\main, block_search_forums\output\search_form, block_starredcourses\output\main, block_timeline\output\main, booktool_print\output\print_book_chapter_page, booktool_print\output\print_book_page, component_action, context_header, core\navigation\output\more_menu, 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\dynamic_tabs, core\output\select_menu, core_admin\output\theme_selector, core_auth\output\digital_minor_page, core_auth\output\login, core_auth\output\verify_age_location_page, core_badges\output\manage_badge_action_bar, core_badges\output\recipients_action_bar, core_badges\output\standard_action_bar, core_contentbank\output\bankcontent, core_contentbank\output\viewcontent, core_course\output\activity_completion, core_course\output\activity_dates, core_course\output\activity_information, core_course\output\completion_action_bar, core_courseformat\output\activitybadge, core_courseformat\output\local\content\cm, core_courseformat\output\local\content\section, core_group\output\group_details, core_group\output\index_page, core_h5p\output\libraries, core_privacy\output\exported_html_page, core_privacy\output\exported_navigation_page, core_question\output\qbank_action_menu, core_question\output\question_bank_filter_ui, core_question\output\question_version_info, core_question\output\question_version_selection, 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\system_report, core_tag\output\tag, core_tag\output\tagcloud, core_tag\output\tagfeed, core_tag\output\tagindex, core_tag\output\taglist, core_user\output\participants_filter, core_user\output\status_field, custom_menu_item, enrol_lti\output\registration, format_topics\output\courseformat\content, forumreport_summary\output\filters, gradereport_singleview\output\action_bar, help_icon, initials_bar, login_signup_form, mod_assign\output\grading_app, mod_assign\output\timelimit_panel, mod_bigbluebuttonbn\output\import_view, mod_bigbluebuttonbn\output\instance_updated_message, mod_bigbluebuttonbn\output\recording_row_actionbar, mod_bigbluebuttonbn\output\recording_row_playback, mod_bigbluebuttonbn\output\recording_row_preview, mod_bigbluebuttonbn\output\recordings_session, mod_bigbluebuttonbn\output\view_page, mod_data\output\presets, mod_data\output\view_footer, mod_feedback\output\base_action_bar, mod_feedback\output\summary, mod_forum\output\big_search_form, mod_forum\output\forum_actionbar, mod_forum\output\quick_search_form, mod_forum\output\subscription_actionbar, mod_glossary\output\standard_action_bar, mod_h5pactivity\output\attempt, mod_h5pactivity\output\reportattempts, mod_h5pactivity\output\reportlink, mod_h5pactivity\output\reportresults, mod_h5pactivity\output\result, mod_h5pactivity\output\result\longfillin, mod_h5pactivity\output\result\other, mod_lti\output\course_tools_page_header, mod_lti\output\external_registration_return_page, mod_lti\output\registration_upgrade_choice_page, mod_lti\output\repost_crosssite_page, mod_lti\output\tool_configure_page, mod_quiz\output\attempt_summary_information, mod_quiz\output\edit_grading_page, mod_quiz\output\edit_nav_actions, mod_quiz\output\list_of_attempts, mod_quiz\output\overrides_actions, mod_scorm\output\actionbar, mod_scorm\output\userreportsactionbar, mod_survey\output\actionbar, mod_workshop\output\actionbar, MoodleQuickForm_advcheckbox, MoodleQuickForm_autocomplete, MoodleQuickForm_button, MoodleQuickForm_checkbox, MoodleQuickForm_choicedropdown, MoodleQuickForm_date_selector, MoodleQuickForm_date_time_selector, MoodleQuickForm_editor, MoodleQuickForm_filemanager, MoodleQuickForm_filepicker, MoodleQuickForm_grading, MoodleQuickForm_group, MoodleQuickForm_passwordunmask, MoodleQuickForm_recaptcha, MoodleQuickForm_select, MoodleQuickForm_selectgroups, MoodleQuickForm_selectwithlink, MoodleQuickForm_static, MoodleQuickForm_submit, MoodleQuickForm_tags, MoodleQuickForm_textarea, MoodleQuickForm_url, MoodleQuickForm_warning, MoodleQuickForm_wikieditor, paging_bar, pix_icon, pix_icon_font, progress_bar, qbank_columnsortorder\output\add_column, qbank_columnsortorder\output\reset_columns, qbank_editquestion\output\add_new_question, qbank_viewquestiontext\output\question_text_format, qtype_ordering\output\feedback, report_competency\output\report, report_competency\output\user_course_navigation, single_select, tabobject, tabtree, tool_admin_presets\output\export_import, tool_admin_presets\output\presets_list, tool_componentlibrary\local\examples\dynamictabs\tab1, tool_componentlibrary\local\examples\dynamictabs\tab2, tool_customlang\output\translator, tool_dataprivacy\output\categories, tool_dataprivacy\output\data_deletion_page, tool_dataprivacy\output\data_registry_compliance_page, tool_dataprivacy\output\data_registry_page, tool_dataprivacy\output\data_requests_page, tool_dataprivacy\output\defaults_page, tool_dataprivacy\output\my_data_requests_page, tool_dataprivacy\output\purposes, tool_dataprivacy\output\request_filter, tool_dataprivacy\output\summary_page, tool_generator\output\parsingresult, tool_langimport\output\langimport_page, tool_lp\output\competency_plan_navigation, tool_lp\output\competency_summary, tool_lp\output\course_competencies_page, tool_lp\output\manage_competencies_page, tool_lp\output\manage_competency_frameworks_page, tool_lp\output\manage_templates_page, tool_lp\output\module_navigation, tool_lp\output\plans_page, tool_lp\output\related_competencies, tool_lp\output\template_competencies_page, tool_lp\output\user_competency_course_navigation, tool_lp\output\user_competency_summary, tool_lp\output\user_competency_summary_in_course, tool_lp\output\user_evidence_list_page, tool_policy\output\acceptances, tool_policy\output\guestconsent, tool_policy\output\page_agreedocs, tool_policy\output\page_managedocs_list, tool_policy\output\page_nopermission, tool_policy\output\page_viewalldoc, tool_policy\output\page_viewdoc, tool_templatelibrary\output\list_templates_page, and url_select.

◆ get_template_name()

core\output\local\dropdown\status::get_template_name ( \renderer_base $renderer)

Get the name of the template to use for this templatable.

Parameters
renderer_base$rendererThe renderer requesting the template name
Return values
stringthe template name

Reimplemented from core\output\local\dropdown\dialog.

◆ set_button()

core\output\local\dropdown\dialog::set_button ( string $buttoncontent,
?string $buttonclasses = null )
inherited

Set the button contents.

Parameters
string$buttoncontent
string | null$buttonclassesthe button classes

◆ set_button_classes()

core\output\local\dropdown\dialog::set_button_classes ( string $buttonclasses)
inherited

Add extra classes to trigger butotn.

Parameters
string$buttonclassesthe extra classes

◆ set_choice()

core\output\local\dropdown\status::set_choice ( choicelist $choices)

Set the dialog contents.

Parameters
choicelist$choices

◆ set_classes()

core\output\local\dropdown\dialog::set_classes ( string $classes)
inherited

Add extra classes to the component.

Parameters
string$classesthe extra classes

◆ set_content()

core\output\local\dropdown\dialog::set_content ( string $dialogcontent)
inherited

Set the dialog contents.

Parameters
string$dialogcontent

◆ set_dialog_width()

core\output\local\dropdown\dialog::set_dialog_width ( string $width)
inherited

Set the dialog width.

Parameters
string$width

◆ set_disabled()

core\output\local\dropdown\dialog::set_disabled ( bool $disabled)
inherited

Set the dropdown disabled attribute.

Parameters
bool$disabledthe disabled value

◆ set_position()

core\output\local\dropdown\dialog::set_position ( string $position)
inherited

Set the dropdown position.

Parameters
string$positionthe position

Member Data Documentation

◆ POSITION

const core\output\local\dropdown\dialog::POSITION
inherited
Initial value:
= [
'start' => 'dropdown-menu-left',
'end' => 'dropdown-menu-right',
]

Dropdown dialog positions.

◆ WIDTH

const core\output\local\dropdown\dialog::WIDTH
inherited
Initial value:
= [
'default' => '',
'big' => 'dialog-big',
'small' => 'dialog-small',
]

Dropdown dialog positions.


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