Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
MoodleQuickForm_float Class Reference

Float type form element. More...

Inheritance diagram for MoodleQuickForm_float:
MoodleQuickForm_text templatable

Public Member Functions

 __construct ($elementName=null, $elementLabel=null, $attributes=null)
 MoodleQuickForm_float constructor.
 
 _getPersistantData ()
 Used by getFrozenHtml() to pass the element's value if _persistantFreeze is on.
 
 export_for_template (renderer_base $output)
 Function to export the renderer data in a format that is suitable for a mustache template.
 
 exportValue (&$submitValues, $assoc=false)
 Returns a 'safe' element's value.
 
 freeze ()
 Freeze the element so that only its value is returned and set persistantfreeze to false.
 
 get_force_ltr ()
 Get force LTR option.
 
 getFrozenHtml ()
 Returns the html to be used when the element is frozen.
 
 getHelpButton ()
 get html for help button
 
 getValue ()
 Returns the value of the form element.
 
 MoodleQuickForm_text ($elementName=null, $elementLabel=null, $attributes=null)
 Old syntax of class constructor.
 
 onQuickFormEvent ($event, $arg, &$caller)
 Called by HTML_QuickForm whenever form event is made on this element.
 
 set_force_ltr ($value)
 Force the field to flow left-to-right.
 
 setHiddenLabel ($hiddenLabel)
 Sets label to be hidden.
 
 setValue ($value)
 Sets the value of the form element.
 
 toHtml ()
 Returns HTML for this form element.
 
 validateSubmitValue ($value)
 Checks that the submitted value is a valid float number.
 

Public Attributes

string $_helpbutton =''
 html for help button, if empty then no help
 
bool $_hiddenLabel =false
 if true label will be hidden
 

Protected Attributes

bool $forceltr = false
 Whether to force the display of this element to flow LTR.
 

Detailed Description

Float type form element.

This is preferred over the text element when working with float numbers, and takes care of the fact that different languages may use different symbols as the decimal separator. Using this element, submitted float numbers will be automatically translated from the localised format into the computer format, and vice versa when they are being displayed.

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

Constructor & Destructor Documentation

◆ __construct()

MoodleQuickForm_float::__construct ( $elementName = null,
$elementLabel = null,
$attributes = null )

MoodleQuickForm_float constructor.

Parameters
string$elementName(optional) name of the float field
string$elementLabel(optional) float field label
string$attributes(optional) Either a typical HTML attribute string or an associative array

Reimplemented from MoodleQuickForm_text.

Member Function Documentation

◆ _getPersistantData()

MoodleQuickForm_float::_getPersistantData ( )

Used by getFrozenHtml() to pass the element's value if _persistantFreeze is on.

Return values
string

◆ export_for_template()

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.

◆ exportValue()

MoodleQuickForm_float::exportValue ( & $submitValues,
$assoc = false )

Returns a 'safe' element's value.

Parameters
array$submitValuesarray of submitted values to search
bool$assocwhether to return the value as associative array
Return values
mixed

◆ freeze()

MoodleQuickForm_text::freeze ( )
inherited

Freeze the element so that only its value is returned and set persistantfreeze to false.

Since
Moodle 2.4
Return values
void

◆ get_force_ltr()

MoodleQuickForm_text::get_force_ltr ( )
inherited

Get force LTR option.

Return values
bool

◆ getFrozenHtml()

MoodleQuickForm_text::getFrozenHtml ( )
inherited

Returns the html to be used when the element is frozen.

Since
Moodle 2.4
Return values
stringFrozen html

◆ getHelpButton()

MoodleQuickForm_text::getHelpButton ( )
inherited

get html for help button

Return values
stringhtml for help button

◆ getValue()

MoodleQuickForm_float::getValue ( )

Returns the value of the form element.

Return values
false|float

◆ MoodleQuickForm_text()

MoodleQuickForm_text::MoodleQuickForm_text ( $elementName = null,
$elementLabel = null,
$attributes = null )
inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated
since Moodle 3.1

◆ onQuickFormEvent()

MoodleQuickForm_float::onQuickFormEvent ( $event,
$arg,
& $caller )

Called by HTML_QuickForm whenever form event is made on this element.

Parameters
string$eventName of event
mixed$argevent arguments
object$callercalling object
Return values
bool

◆ set_force_ltr()

MoodleQuickForm_text::set_force_ltr ( $value)
inherited

Force the field to flow left-to-right.

This is useful for fields such as URLs, passwords, settings, etc...

Parameters
bool$valueThe value to set the option to.

◆ setHiddenLabel()

MoodleQuickForm_text::setHiddenLabel ( $hiddenLabel)
inherited

Sets label to be hidden.

Parameters
bool$hiddenLabelsets if label should be hidden

◆ setValue()

MoodleQuickForm_float::setValue ( $value)

Sets the value of the form element.

Parameters
string$valueDefault value of the form element

◆ toHtml()

MoodleQuickForm_text::toHtml ( )
inherited

Returns HTML for this form element.

Return values
string

Reimplemented in tool_mfa\local\form\verification_field.

◆ validateSubmitValue()

MoodleQuickForm_float::validateSubmitValue ( $value)

Checks that the submitted value is a valid float number.

Parameters
string$valueThe localised float number that is submitted.
Return values
string|nullValidation error message or null.

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