Class sloodle_base_view_module

Description

The base class for viewing a SLOODLE module.

Should be inherited and overridden. Child class MUST be named "sloodle_view_NAME", where NAME replaces the name of the feature or module. For example, "sloodle_view_controller" or "sloodle_view_course". For modules, the NAME must match the "type" specifier in the "sloodle" table, such as "controller", "distributor", or "presenter".

Located in /view/base/base_view_module.php (line 28)

sloodle_base_view
   |
   --sloodle_base_view_module
Direct descendents
Class Description
 class sloodle_view_controller The base class for viewing a SLOODLE Controller module.
 class sloodle_view_distributor Class for rendering a view of a Distributor module in Moodle.
 class sloodle_view_ibank Class for rendering a view of a Distributor module in Moodle.
 class sloodle_view_map Class for rendering a view of a Map module in Moodle.
 class sloodle_view_presenter Class for rendering a view of a Presenter module in Moodle.
Variable Summary
Method Summary
 sloodle_base_view_module sloodle_base_view_module ()
 void print_footer ()
 void print_header ()
 void process_form ()
 void process_request ()
 void render ()
Variables
bool $canedit = false (line 77)

Indicates whether or the user can edit (or 'manage') this module, according to the VLE permissions.

  • access: private
object $cm = null (line 35)

The course module instance, retrieved directly from the database (table: course_modules)

  • access: private

Redefined in descendants as:
  • sloodle_view_ibank::$cm : The course module instance, retrieved directly from the database (table: course_modules)
object $course = null (line 49)

The VLE course object, retrieved directly from the database (table: course)

  • access: private

Redefined in descendants as:
object $course_context = null (line 63)

Context object for permissions in the Moodle course.

  • access: private

Redefined in descendants as:
object $module_context = null (line 70)

Context object for permissions in the Moodle module.

  • access: private
object $sloodle = null (line 42)

The main SLOODLE module instance, retreived directly from the database (table: sloodle)

  • access: private

Redefined in descendants as:
SloodleCourse $sloodle_course = null (line 56)

The SLOODLE course object.

  • access: private

Redefined in descendants as:
Methods
Constructor sloodle_base_view_module (line 83)

Constructor.

sloodle_base_view_module sloodle_base_view_module ()

Redefined in descendants as:
check_permission (line 111)

Check that the user has permission to view this module, and check if they can edit it too.

void check_permission ()

Redefinition of:
sloodle_base_view::check_permission()
Check that the user has permission to access the current resources.

Redefined in descendants as:
print_footer (line 177)

Print the footer for this course.

void print_footer ()

Redefinition of:
sloodle_base_view::print_footer()
Output the page footer.
print_header (line 137)

Print module header info.

void print_header ()

Redefinition of:
sloodle_base_view::print_header()
Print the standard page header.

Redefined in descendants as:
process_form (line 130)

Process any form data which has been submitted.

void process_form ()

Redefinition of:
sloodle_base_view::process_form()
Process any form data which has been submitted.

Redefined in descendants as:
process_request (line 93)

Checks for incoming request data identifying a particular module (parameter 'id').

Loads the relevant course module and SLOODLE module instances. This should be overridden to add functionality to load any module-specific data. However, you can simply call the parent function (i.e. this one) first to load the basic data.

void process_request ()

Redefinition of:
sloodle_base_view::process_request()
Check for incoming request data identifying a particular course or module.

Redefined in descendants as:
render (line 170)

Render the view of the module or feature.

This MUST be overridden to provide functionality.

void render ()

Redefinition of:
sloodle_base_view::render()
Render the view of the module or feature.

Redefined in descendants as:

Inherited Methods

Inherited From sloodle_base_view

 sloodle_base_view::sloodle_base_view()
 sloodle_base_view::check_permission()
 sloodle_base_view::print_footer()
 sloodle_base_view::print_header()
 sloodle_base_view::process_form()
 sloodle_base_view::process_request()
 sloodle_base_view::render()
 sloodle_base_view::view()

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