Docs For Class Module

Class Module_quiz

Description

Module page class.

Located in /site/pages/modules/quiz.php (line 24)

Method Summary

tempcode archive ()

tempcode do_quiz ()

void enforcement_checks (array $quiz)

?array get_entry_points ()

?array get_page_links ([?integer $max_depth = NULL], [boolean $require_permission_support = false], [?string $start_at = NULL], [boolean $dont_care_about_categories = false])

void get_sitemap_pagelinks (string $callback, MEMBER $member_id, integer $depth, string $pagelink_stub)

?array info ()

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])

tempcode run ()

void uninstall ()

tempcode _do_quiz ()

Methods

archive (line 277)

The UI to browse quizzes/surveys/tests.

return: The UI

tempcode archive ()

do_quiz (line 350)

The UI for doing a quiz.

return: The result of execution.

tempcode do_quiz ()

enforcement_checks (line 327)

Make sure the entry rules of a quiz are not being broken. Exits when they may not enter.

void enforcement_checks (array $quiz)

array $quiz: The db row of the quiz

get_entry_points (line 189)

Standard modular entry-point finder function.

return: A map of entry points (type-code=>language-code) (NULL: disabled).

?array get_entry_points ()

get_page_links (line 203)

Standard modular page-link finder function (does not return the main entry-points that are not inside the tree).

return: A tuple: 1) full tree structure [made up of (pagelink, permission-module, permissions-id, title, children, ?entry point for the children, ?children permission module, ?whether there are children) OR a list of maps from a get_* function] 2) permissions-page 3) optional base entry-point for the tree 4) optional permission-module 5) optional permissions-id (NULL: disabled).

?array get_page_links ([?integer $max_depth = NULL], [boolean $require_permission_support = false], [?string $start_at = NULL], [boolean $dont_care_about_categories = false])

?integer $max_depth: The number of tree levels to computer (NULL: no limit)
boolean $require_permission_support: Whether to not return stuff that does not support permissions (unless it is underneath something that does).
?string $start_at: Position to start at in the tree. Does not need to be respected. (NULL: from root)
boolean $dont_care_about_categories: Whether to avoid returning categories.

get_sitemap_pagelinks (line 227)

Standard modular new-style deep page-link finder function (does not return the main entry-points).

void get_sitemap_pagelinks (string $callback, MEMBER $member_id, integer $depth, string $pagelink_stub)

string $callback: Callback function to send discovered page-links to.
MEMBER $member_id: The member we are finding stuff for (we only find what the member can view).
integer $depth: Code for how deep we are tunnelling down, in terms of whether we are getting entries as well as categories.
string $pagelink_stub: Stub used to create page-links. This is passed in because we don't want to assume a zone or page name within this function.

info (line 32)

Standard modular info function.

return: Map of module info (NULL: module is disabled).

?array info ()

install (line 68)

Standard modular install function.

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])

?integer $upgrade_from: What version we're upgrading from (NULL: new install)
?integer $upgrade_from_hack: What hack version we're upgrading from (NULL: new-install/not-upgrading-from-a-hacked-version)

run (line 259)

Standard modular run function.

return: The result of execution.

tempcode run ()

uninstall (line 48)

Standard modular uninstall function.

void uninstall ()

_do_quiz (line 475)

Actualiser: process quiz results.

return: The result of execution.

tempcode _do_quiz ()

Documentation generated on Sun, 02 Jan 2011 23:23:18 +0000 by phpDocumentor 1.4.3