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

block_myoverview: Add admin setting to control the available layouts

    XMLWordPrintable

    Details

    • Testing Instructions:
      Hide

      Test Instructions:

      1. Log in as Admin
      2. Navigate to Site administration > Plugins > Blocks > Manage Blocks
      3. Scroll down to block name `Course Overview` and click Settings
      4. You should see the setting 'Available Layouts', check the List and Summary boxes only and Save changes
      5. Log in separately as a user enrolled in at least one course
      6. Navigate to Dashboard and view the 'Course overview' section
      7. Click on the top right dropdown of this section (should say 'List' but may be 'Summary' depending on current user account preferences)
      8. You should only see two options in the dropdown, 'List' and 'Summary', cycle through these and ensure the correct layout is displayed
      9. Log back in as Admin and navigate to the 'Available Layouts' setting again.
      10.  Disable all checkboxes and Save changes
      11.  Log in as user again and navigate to Dashboard
      12. The layout dropdown should not be visible and the courses should be displayed in the Cards layout
      13.  Log back in as Admin and navigate to the 'Available Layouts' setting again.
      14.  Enable all checkboxes and Save changes
      15.  Log in as user again and navigate to Dashboard
      16.  The layout dropdown should be visible again and 'Cards', 'List' and 'Summary' layouts available for selection
      Show
      Test Instructions: Log in as Admin Navigate to Site administration > Plugins > Blocks > Manage Blocks Scroll down to block name `Course Overview` and click Settings You should see the setting 'Available Layouts', check the List and Summary boxes only and Save changes Log in separately as a user enrolled in at least one course Navigate to Dashboard and view the 'Course overview' section Click on the top right dropdown of this section (should say 'List' but may be 'Summary' depending on current user account preferences) You should only see two options in the dropdown, 'List' and 'Summary', cycle through these and ensure the correct layout is displayed Log back in as Admin and navigate to the 'Available Layouts' setting again.  Disable all checkboxes and Save changes  Log in as user again and navigate to Dashboard The layout dropdown should not be visible and the courses should be displayed in the Cards layout  Log back in as Admin and navigate to the 'Available Layouts' setting again.  Enable all checkboxes and Save changes  Log in as user again and navigate to Dashboard  The layout dropdown should be visible again and 'Cards', 'List' and 'Summary' layouts available for selection
    • Affected Branches:
      MOODLE_36_STABLE
    • Fixed Branches:
      MOODLE_38_STABLE
    • Pull from Repository:
    • Pull Master Branch:
      MDL-64901-37_block_myoverview_layout_settings

      Description

      In block_myoverview, there are three layouts available:

      • Card
      • List
      • Summary

      Depending on the local usage scenario, there might be the need to control these available layouts, e.g. disable the summary view if it might overwhelm users or only allow one view to lighten the interface as a whole.

      To support these usage scenarios, I propose to have the available layouts configurable as an admin setting.

      As this block doesn't have admin settings yet, this will mean:

      • Create a new settings page below /admin/category.php?category=blocksettings for the My Overview block
      • Add a setting "block_myoverview | layouts" as a multiselect setting.
      • This setting has three values:
        • Card
        • List
        • Summary
      • All three values are selected by default
      • If the admin disables one of these values, the layout isn't listed in the layout dropdown anymore.
      • If the admin disables two of these values, the layout selector isn't shown anymore at all and the single enabled layout is delivered.
      • If the admin disables all of these values (for whatever reason), the layout selector isn't shown anymore at all and the card layout is delivered as fallback.

        Attachments

          Issue Links

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                8 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Fix Release Date:
                  18/Nov/19

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 3 hours, 15 minutes
                  3h 15m