Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-29421

Form elements editor and filepicker do not support freezing

    XMLWordPrintable

    Details

    • Testing Instructions:
      Hide

      Download the attached test_editor_form.php and copy it to the root of your moodle test site.

      • navigate to yourmoodle/test_editor_form.php.
      • write a text (and add an image, if you like) in the editor area and submit the form.
      • reload the page. You can see your just written text in the editor window. You are in "read/write" mode so you can change or delete it.

      Modify the line 30 of the test_editor_form.php from:
      $editable = true;
      to
      $editable = false;

      • navigate again to yourmoodle/test_editor_form.php.
      • you are in "read only" mode. The just written text is no longer visible. This is the bug.

      Now apply the last patch provided here [MDL-29421-editor.patch] to head/lib/form/editor.php

      • navigate again to yourmoodle/test_editor_form.php.
      • you are still in "read only" mode but now you can see the written text and, as expected, you are no longer allowed to edit it.
      Show
      Download the attached test_editor_form.php and copy it to the root of your moodle test site. navigate to yourmoodle/test_editor_form.php. write a text (and add an image, if you like) in the editor area and submit the form. reload the page. You can see your just written text in the editor window. You are in "read/write" mode so you can change or delete it. Modify the line 30 of the test_editor_form.php from: $editable = true; to $editable = false; navigate again to yourmoodle/test_editor_form.php. you are in "read only" mode. The just written text is no longer visible. This is the bug. Now apply the last patch provided here [MDL-29421-editor.patch] to head/lib/form/editor.php navigate again to yourmoodle/test_editor_form.php. you are still in "read only" mode but now you can see the written text and, as expected, you are no longer allowed to edit it.
    • Affected Branches:
      MOODLE_21_STABLE, MOODLE_36_STABLE, MOODLE_37_STABLE, MOODLE_38_STABLE
    • Epic Link:
    • Pull from Repository:
    • Pull Master Branch:
      MDL-29421-master
    • Pull Master Diff URL:

      Description

      HTML_QuickForm_element has a nice feature called freezing. One can call $element->freeze() and element will be displayed as a static label+value pair plus a hidden field with a value.
      There is also an attribute _persistantFreeze (see method setPersistantFreeze), true by default. If set to false, no hidden field is generated.

      This feature is forgotten in the elements of type 'editor' and 'filepicker' (lib/form/editor.php and lib/form/filepicker.php)

      method toHtml() in both classes call getFrozenHtml() if element is frozen, but the classes do not redeclare the function getFrozenHtml()

      in case of filepicker, the draftitemid is displayed (could be list of files)
      in case of editor, warning is thrown because parent function assumes value to be a scalar. Also editor needs to redeclare hidden field generation in _getPersistantData() (or not use this function)

      the select field (lib/pear/HTML/QuickForm/select.php) can be used as an example of an element with an array stored in _value.

        Attachments

          Issue Links

          has been marked as being related by

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-56105 mform->disabledIf not working properly for filepicker

          • Minor - Minor loss of function where workaround is possible
          • Open

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-29701 mform disableif doesn't work on 'editor' element when wysiwig enabled

          • Minor - Minor loss of function where workaround is possible
          • Closed

          Task - A task that needs to be completed. Tasks usually refer to work that must be done outside the product. MDL-57195 Check Boost theme handling of the soft and hard frozen form elements

          • Minor - Minor loss of function where workaround is possible
          • Open

          Task - A task that needs to be completed. Tasks usually refer to work that must be done outside the product. MDL-30974 forms API, phpdocs and devdocs

          • Minor - Minor loss of function where workaround is possible
          • Closed
          is duplicated by

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-45815 Filemanager mform elements are completely discarded in readonly forms

          • Major - Major loss of function, incorrect output
          • Open

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-58739 Custom profile fields - text area content not shown when disabled.

          • Minor - Minor loss of function where workaround is possible
          • Closed

          Improvement - An enhancement to an existing Moodle feature. MDL-25067 mform editor element can not be disabled with mform->disabledIf method

          • Major - Major loss of function, incorrect output
          • Closed
          will be (partly) resolved by

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-45815 Filemanager mform elements are completely discarded in readonly forms

          • Major - Major loss of function, incorrect output
          • Open

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-58519 MoodleQuickForm_editor::getValue() is not compatible with MoodleQuickForm::exportValues() logic

          • Minor - Minor loss of function where workaround is possible
          • Closed

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              marina Marina Glancy
              Peer reviewer:
              Tobias Reischmann
              Participants:
              Component watchers:
              Adrian Greeve, Jake Dallimore, Mathew May, Mihail Geshoski, Peter Dias, Sujith Haridasan
              Votes:
              8 Vote for this issue
              Watchers:
              10 Start watching this issue

                Dates

                Created:
                Updated: