NAME

WeBWorK::Utils::Routes - webwork2 route parameters and route utility methods.

ROUTES

PLEASE FOR THE LOVE OF GOD UPDATE THIS IF YOU CHANGE THE ROUTES BELOW!!!

root                                /

course_admin                        /$ce->{admin_course_id} -> logout, options, instructor_tools

render_rpc                          /render_rpc
instructor_rpc                      /instructor_rpc
html2xml                            /html2xml

ltiadvanced_content_selection       /ltiadvanced/content_selection

ltiadvantage_login                  /ltiadvantage/login
ltiadvantage_launch                 /ltiadvantage/launch
ltiadvantage_keys                   /ltiadvantage/keys
ltiadvantage_content_selection      /ltiadvantage/content_selection

pod_index                           /pod
pod_viewer                          /pod/$filePath

sample_problem_index                /sampleproblems
sample_problem_viewer               /sampleproblems/$filePath

set_list                            /$courseID

logout                              /$courseID/logout
options                             /$courseID/options
grades                              /$courseID/grades
achievements                        /$courseID/achievements
equation_display                    /$courseID/equation
feedback                            /$courseID/feedback
gateway_quiz                        /$courseID/test_mode/$setID

proctored_gateway_quiz              /$courseID/proctored_test_mode/$setID
proctored_gateway_proctor_login     /$courseID/proctored_test_mode/$setID/proctor_login

hardcopy                            /$courseID/hardcopy
hardcopy_preselect_set              /$courseID/hardcopy/$setID

answer_log                          /$courseID/show_answers

instructor_tools                    /$courseID/instructor

instructor_user_list                /$courseID/instructor/users
instructor_user_detail              /$courseID/instructor/users/$userID

instructor_set_list                 /$courseID/instructor/sets

instructor_set_detail               /$courseID/instructor/sets/$setID
instructor_users_assigned_to_set    /$courseID/instructor/sets/$setID/users

instructor_problem_grader           /$courseID/instructor/grader/$setID/$problemID

instructor_add_users                /$courseID/instructor/add_users
instructor_set_assigner             /$courseID/instructor/assigner

instructor_set_maker                /$courseID/instructor/setmaker
instructor_file_manager             /$courseID/instructor/file_manager
instructor_config                   /$courseID/instructor/config

instructor_problem_editor           /$courseID/instructor/pgProblemEditor
instructor_problem_editor_withset   /$courseID/instructor/pgProblemEditor/$setID
instructor_problem_editor_withset_withproblem
                                    /$courseID/instructor/pgProblemEditor/$setID/$problemID

instructor_scoring                  /$courseID/instructor/scoring
instructor_scoring_download         /$courseID/instructor/scoringDownload
instructor_mail_merge               /$courseID/instructor/send_mail

instructor_statistics               /$courseID/instructor/stats
instructor_set_statistics           /$courseID/instructor/stats/set/$setID
instructor_problem_statistics       /$courseID/instructor/stats/set/$setID/$problemID
instructor_user_statistics          /$courseID/instructor/stats/student/$userID

instructor_progress                 /$courseID/instructor/progress
instructor_set_progress             /$courseID/instructor/progress/set/$setID
instructor_user_progress            /$courseID/instructor/progress/student/$userID

instructor_achievement_list         /$courseID/instructor/achievement_list
instructor_achievement_editor       /$courseID/instructor/achievement_list/$achievementID/editor
instructor_achievement_user_editor  /$courseID/instructor/achievement_list/$achievementID/users
instructor_achievement_notification /$courseID/instructor/achievement_list/$achievementID/email

instructor_lti_update               /$courseID/instructor/lti_update

instructor_job_manager              /$courseID/instructor/job_manager

problem_list                        /$courseID/$setID
problem_detail                      /$courseID/$setID/$problemID
show_me_another                     /$courseID/$setID/$problemID/show_me_another

METHODS

Route setup methods

These methods initialize the webwork2 app Mojolicious router for content generator routes.

setup_content_generator_routes

This is the actual method called by Mojolicious::WeBWorK.

setup_content_generator_routes_recursive

This is an internal utility method called by the above method. It is not exported. It recursively sets up all routes.

Methods that return information about a route.

route_title

Returns the human-readable name of the route given by name. This displays set ids and course ids with spaces instead of underscores, and if $displayHTML is true, it places the set id into an ltr span so that it is displayed ltr even for rtl languages. Note that the return value of this method should never be used to determine what type of path this is or for any sort of further processing. It is a translated string.

route_navigation_is_restricted

Returns 1 if the route is restricted from being viewed by a user that does not have the navigation_allowed permission, and 0 otherwise. The allowed paths for restricted users are marked with the unrestricted flag.