Docs For Class sloodle_base

Description

The base class for viewing a SLOODLE module or feature.

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". Modules should be automatically found, although special features (such as courses or users) will need to coded manually into the main view.php script.

Located in /view/base/base_view.php (line 24)

Direct descendents

Class	Description
sloodle_base_view_module	The base class for viewing a SLOODLE module.
sloodle_view_course	Class for rendering a view of SLOODLE course information.
sloodle_view_user	Class for rendering a view of SLOODLE user information.
sloodle_view_users	Class for rendering a view of SLOODLE users.

Method Summary

sloodle_base_view sloodle_base_view ()

void check_permission ()

void print_footer ()

void print_header ()

void process_form ()

void process_request ()

void render ()

void view ()

Methods

Constructor sloodle_base_view (line 29)

Constructor.

sloodle_base_view sloodle_base_view ()

check_permission (line 78)

Check that the user has permission to access the current resources.

This must be overridden to add functionality.

void check_permission ()

Redefined in descendants as:

sloodle_base_view_module::check_permission() : Check that the user has permission to view this module, and check if they can edit it too.
sloodle_view_ibank::check_permission() : Check that the user has permission to view this module, and check if they can edit it too.
sloodle_view_course::check_permission() : Check that the user is logged-in and has permission to alter course settings.
sloodle_view_user::check_permission() : Check that the user is logged-in and has permission to alter course settings.
sloodle_view_users::check_permission() : Check that the user is logged-in and has permission to alter course settings.

print_footer (line 111)

Output the page footer.

This does not usually have to be overridden, unless there is something to be added or a block element to be closed.

void print_footer ()

Redefined in descendants as:

sloodle_base_view_module::print_footer() : Print the footer for this course.
sloodle_view_course::print_footer() : Print the footer for this course.
sloodle_view_user::print_footer() : Print the page footer.
sloodle_view_users::print_footer() : Print the page footer.

print_header (line 94)

Print the standard page header.

This should usually be overridden to add additional information, such as page title, header, and navigation links.

void print_header ()

Redefined in descendants as:

sloodle_base_view_module::print_header() : Print module header info.
sloodle_view_ibank::print_header() : Override the base_view_module print_header for formatting reasons
sloodle_view_map::print_header() : Print the page header (requires special scripts to be added into the header)
sloodle_view_course::print_header() : Print the course settings page header.
sloodle_view_user::print_header() : Print the course settings page header.
sloodle_view_users::print_header() : Print the course settings page header.

process_form (line 86)

Process any form data which has been submitted.

This must be overridden to add functionality.

void process_form ()

Redefined in descendants as:

sloodle_base_view_module::process_form() : Process any form data which has been submitted.
sloodle_view_controller::process_form() : Process any form data which has been submitted.
sloodle_view_distributor::process_form() : Process any form data which has been submitted.
sloodle_view_ibank::process_form() : Process any form data which has been submitted.
sloodle_view_map::process_form() : Process any form data which has been submitted.
sloodle_view_presenter::process_form() : Process any form data which has been submitted.

process_request (line 70)

Check for incoming request data identifying a particular course or module.

This must be overridden to add functionality.

void process_request ()

Redefined in descendants as:

sloodle_base_view_module::process_request() : Checks for incoming request data identifying a particular module (parameter 'id').
sloodle_view_controller::process_request() : Uses the parent class to process basic request information, then obtains additional Controller data.
sloodle_view_distributor::process_request() : Processes request data to determine which Distributor is being accessed.
sloodle_view_ibank::process_request() : Check and process the request parameters.
sloodle_view_map::process_request() : Processes request data to determine which Map is being accessed.
sloodle_view_presenter::process_request() : Processes request data to determine which Presenter is being accessed.
sloodle_view_course::process_request() : Check the request parameters to see which course was specified.
sloodle_view_user::process_request() : Check and process the request parameters.
sloodle_view_users::process_request() : Check and process the request parameters.

render (line 103)

Render the view of the module or feature.

This MUST be overridden to provide functionality.

void render ()

Redefined in descendants as:

sloodle_base_view_module::render() : Render the view of the module or feature.
sloodle_view_controller::render() : Render the view of the Controller.
sloodle_view_distributor::render() : Render the view of the Distributor.
sloodle_view_ibank::render() : Render the view of the Stipend Giver.
sloodle_view_map::render() : Render the view of the Map.
sloodle_view_presenter::render() : Render the view of the Presenter.
sloodle_view_course::render() : Render the view of the module or feature.
sloodle_view_user::render() : Render the view of the module or feature.
sloodle_view_users::render() : Render the view of the module or feature.

view (line 37)

The main viewing function.

This gets called by the system to render the view of the module.

void view ()