Source for file base_view.php

Documentation is available at base_view.php

  1. <?php
  2. /**
  3. * Defines a base class for views of SLOODLE modules and features.
  4. * Module-/feature-specific functionality should be specified by inheriting and overidding specific functions.
  5. * When this file is included, it expects the Moodle library and config info to already be included too.
  6. *
  7. * @package sloodle
  8. * @copyright Copyright (c) 2008 Sloodle (various contributors)
  9. * @license http://www.gnu.org/licenses/gpl-3.0.html GNU GPL v3
  10. *
  11. * @contributor Peter R. Bloomfield
  12. */
  13.  
  14.  
  15. /**
  16. * The base class for viewing a SLOODLE module or feature.
  17. * Should be inherited and overridden.
  18. * Child class MUST be named "sloodle_view_NAME", where NAME replaces the name of the feature or module.
  19. * For example, "sloodle_view_controller" or "sloodle_view_course".
  20. * For modules, the NAME must match the "type" specifier in the "sloodle" table, such as "controller", "distributor", or "presenter".
  21. * Modules should be automatically found, although special features (such as courses or users) will need to coded manually into the main view.php script.
  22. * @package sloodle
  23. */
  24. class sloodle_base_view
  25. {
  26.     /**
  27.     * Constructor.
  28.     */
  29.     function sloodle_base_view()
  30.     {
  31.     }
  32.  
  33.     /**
  34.     * The main viewing function.
  35.     * This gets called by the system to render the view of the module.
  36.     */
  37.     function view()
  38.     {
  39.         // Process basic incoming data
  40.         // (this fetches all necessary course and module data)
  41.         $this->process_request();
  42.  
  43.         // Check user permissions to access this resource.
  44.         // This first requires that the user is logged-in (for best results, DO NOT output anything before this).
  45.         // It then checks that the user has permission to view the course and module.
  46.         // It finally also checks to see if the user has edit permission.
  47.         $this->check_permission();
  48.  
  49.         // Process any form submission.
  50.         // It is useful to do this before any data is outputted, so that the user can be issued a header direct after form submission.
  51.         // This can be used to get rid of any form-related request parameters which break forward/back navigation and manual refreshes.
  52.         $this->process_form();
  53.  
  54.         // Output the page header.
  55.         // This normally includes standard SLOODLE stuff, such as a note of whether or not the course allows auto-registration.
  56.         $this->print_header();
  57.  
  58.         // Render the view of the module or feature itself
  59.         $this->render();
  60.  
  61.         // Output the page footer.
  62.         // This is normally very simple, but can include other data too.
  63.         $this->print_footer();
  64.     }
  65.  
  66.     /**
  67.     * Check for incoming request data identifying a particular course or module.
  68.     * This must be overridden to add functionality.
  69.     */
  70.     function process_request()
  71.     {
  72.     }
  73.  
  74.     /**
  75.     * Check that the user has permission to access the current resources.
  76.     * This must be overridden to add functionality.
  77.     */
  78.     function check_permission()
  79.     {
  80.     }
  81.  
  82.     /**
  83.     * Process any form data which has been submitted.
  84.     * This must be overridden to add functionality.
  85.     */
  86.     function process_form()
  87.     {
  88.     }
  89.  
  90.     /**
  91.     * Print the standard page header.
  92.     * This should usually be overridden to add additional information, such as page title, header, and navigation links.
  93.     */
  94.     function print_header()
  95.     {
  96.         print_header_simple();
  97.     }
  98.  
  99.     /**
  100.     * Render the view of the module or feature.
  101.     * This MUST be overridden to provide functionality.
  102.     */
  103.     function render()
  104.     {
  105.     }
  106.  
  107.     /**
  108.     * Output the page footer.
  109.     * This does not usually have to be overridden, unless there is something to be added or a block element to be closed.
  110.     */
  111.     function print_footer()
  112.     {
  113.         print_footer();
  114.     }
  115.  
  116. }
  117.  
  118.  
  119. ?>

Documentation generated on Fri, 17 Jul 2009 11:01:01 +0100 by phpDocumentor 1.4.0